Skip to content

LDAP ​

必要な依存関係: io.ktor:ktor-server-auth, io.ktor:ktor-server-auth-ldap

コード例: auth-ldap

Native サーバーKtorはKotlin/Nativeをサポートしており、追加のランタイムや仮想マシンなしでサーバーを実行できます。のサポート: ✖️

LDAP は、ユーザーに関する情報を保存できるさまざまなディレクトリサービスと連携するためのプロトコルです。Ktor では、basic、digest、またはフォームベース(form-based)の認証スキームを使用して LDAP ユーザーを認証できます。

Ktor における認証と認可の一般的な情報については、Ktor Server での認証と認可セクションを参照してください。

依存関係の追加 ​

LDAP 認証を有効にするには、ビルドスクリプトに ktor-server-auth および ktor-server-auth-ldap アーティファクトを含める必要があります。

kotlin
implementation("io.ktor:ktor-server-auth:$ktor_version")
implementation("io.ktor:ktor-server-auth-ldap:$ktor_version")
groovy
implementation "io.ktor:ktor-server-auth:$ktor_version"
implementation "io.ktor:ktor-server-auth-ldap:$ktor_version"
xml
<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-auth</artifactId>
<version>${ktor_version}</version>
</dependency>
<dependency>
<groupId>io.ktor</groupId>
<artifactId>ktor-server-auth-ldap</artifactId>
<version>${ktor_version}</version>
</dependency>

LDAP の設定 ​

ステップ 1: 認証プロバイダーを選択する ​

LDAP ユーザーを認証するには、まずユーザー名とパスワードの検証を行う認証プロバイダーを選択する必要があります。Ktor では、basic、digest、またはform-based プロバイダーをこの用途に使用できます。例えば、basic 認証プロバイダーを使用するには、install ブロック内で basic 関数を呼び出します。

kotlin
import io.ktor.server.application.*
import io.ktor.server.auth.*
import io.ktor.server.auth.ldap.*
//...
install(Authentication) {
    basic {
        validate { credentials ->
            // LDAP ユーザーを認証
        }
    }
}

validate 関数は、ユーザーの資格情報を検証するために使用されます。

ステップ 2: LDAP ユーザーを認証する ​

LDAP ユーザーを認証するには、ldapAuthenticate 関数を呼び出す必要があります。この関数は UserPasswordCredential を受け取り、指定された LDAP サーバーに対してそれを検証します。

kotlin
install(Authentication) {
    basic("auth-ldap") {
        validate { credentials ->
            val url = "ldap://0.0.0.0:389"
            val userDNFormat = "cn=%s,dc=ktor,dc=io"
            ldapAuthenticate(credentials, url, userDNFormat)
        }
    }
}

validate 関数は、認証に成功した場合は UserIdPrincipal を返し、失敗した場合は null を返します。

必要に応じて、認証されたユーザーに対して追加の検証を加えることもできます。

kotlin
install(Authentication) {
    basic("auth-ldap") {
        validate { credentials ->
            val url = "ldap://localhost:389"
            val userDNFormat = "cn=%s,dc=ktor,dc=io"
            ldapAuthenticate(credentials, url, userDNFormat) {
                if (it.name == it.password) {
                    UserIdPrincipal(it.name)
                } else {
                    null
                }
            }
        }
    }
}

型安全な認証スキームの API は実験的なものです。予告なく削除または変更される可能性があります。 利用にはオプトインが必要です。詳細については、 型安全な認証のドキュメントを参照してください。

LDAP 専用の型安全な認証スキームはありません。型安全な basic、digest、または form スキームの validate ブロック内で ldapAuthenticate を呼び出してください。

独自のプリンシパル型を返すには、ldapAuthenticate にブロックを渡します。

kotlin
data class User(val name: String)

val ldapAuth = basic<User>("auth-ldap") {
    validate { credentials ->
        val url = "ldap://0.0.0.0:389"
        val userDNFormat = "cn=%s,dc=ktor,dc=io"
        ldapAuthenticate(credentials, url, userDNFormat) {
            User(it.name)
        }
    }
}

このブロックでは、認証されたユーザーに対する検証を追加することもできます。

kotlin
val ldapAuth = basic<User>("auth-ldap") {
    validate { credentials ->
        val url = "ldap://localhost:389"
        val userDNFormat = "cn=%s,dc=ktor,dc=io"
        ldapAuthenticate(credentials, url, userDNFormat) {
            if (it.name == it.password) {
                User(it.name)
            } else {
                null
            }
        }
    }
}

完全な API については、型安全な認証を参照してください。

ステップ 3: 特定のリソースを保護する ​

LDAP の設定後、authenticate 関数を使用してアプリケーション内の特定のリソースを保護できます。認証に成功した場合、ルートハンドラー内で call.principal 関数を使用して認証済みの UserIdPrincipal を取得し、認証されたユーザーの名前を取得できます。

kotlin
routing {
    authenticate("auth-ldap") {
        get("/") {
            val user = call.principal<UserIdPrincipal>()
            call.respondText("Hello, ${user?.name}!")
        }
    }
}

スキームを authenticateWith() に渡します。ブロック内では、call.principal は指定したプリンシパル型になり、null になることはないため、キャストや null チェックは不要です。

kotlin
routing {
    authenticateWith(ldapAuth) {
        get("/") {
            call.respondText("Hello, ${call.principal.name}!")
        }
    }
}

完全に実行可能なサンプルはこちらで確認できます: auth-ldap

現在の LDAP 実装は同期的(synchronous)であることに注意してください。