LDAP
필수 의존성: io.ktor:ktor-server-auth, io.ktor:ktor-server-auth-ldap
코드 예제: auth-ldap
네이티브 서버(Native server)Ktor는 Kotlin/Native를 지원하므로 추가 런타임이나 가상 머신 없이도 서버를 실행할 수 있습니다. 지원: ✖️
LDAP은 사용자 정보를 저장할 수 있는 다양한 디렉터리 서비스와 상호작용하기 위한 프로토콜입니다. Ktor에서는 basic, digest 또는 form-based 인증 스키마를 사용하여 LDAP 사용자를 인증할 수 있습니다.
Ktor의 인증 및 인가에 대한 일반적인 정보는 Ktor Server의 인증 및 인가 섹션에서 확인할 수 있습니다.
의존성 추가하기
LDAP 인증을 활성화하려면 빌드 스크립트에 ktor-server-auth 및 ktor-server-auth-ldap 아티팩트를 포함해야 합니다:
implementation("io.ktor:ktor-server-auth:$ktor_version")
implementation("io.ktor:ktor-server-auth-ldap:$ktor_version")implementation "io.ktor:ktor-server-auth:$ktor_version"
implementation "io.ktor:ktor-server-auth-ldap:$ktor_version"<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 사용자를 인증하려면 먼저 사용자 이름과 비밀번호를 검증할 인증 제공자(authentication provider)를 선택해야 합니다. Ktor에서는 이를 위해 basic, digest 또는 form-based 제공자를 사용할 수 있습니다. 예를 들어 basic 인증 제공자를 사용하려면 install 블록 내부에서 basic 함수를 호출합니다.
import io.ktor.server.application.*
import io.ktor.server.auth.*
import io.ktor.server.auth.ldap.*
//...
install(Authentication) {
basic {
validate { credentials ->
// LDAP 사용자 인증
}
}
}validate 함수는 사용자 자격 증명(credentials)을 확인하는 데 사용됩니다.
2단계: LDAP 사용자 인증
LDAP 사용자를 인증하려면 ldapAuthenticate 함수를 호출해야 합니다. 이 함수는 UserPasswordCredential을 받아 지정된 LDAP 서버에 대해 유효성을 검사합니다.
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을 반환합니다.
선택 사항으로 인증된 사용자에 대한 추가 유효성 검사를 추가할 수 있습니다.
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
}
}
}
}
}타입 안전(type-safe) 인증 스키마 API는 실험적(experimental)입니다. 언제든지 제거되거나 변경될 수 있으며, 옵트인(opt-in)이 필요합니다. 자세한 내용은 타입 안전 인증 문서를 참조하세요.
LDAP 전용 타입 안전 인증 스키마는 없습니다. 타입 안전 basic, digest 또는 form 스키마의 validate 블록 내부에서 ldapAuthenticate를 호출하세요.
자체 principal 타입을 반환하려면 ldapAuthenticate에 블록을 전달합니다:
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)
}
}
}이 블록을 사용하여 인증된 사용자에 대한 유효성 검사를 추가할 수도 있습니다:
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는 Type-safe authentication을 참조하세요.
3단계: 특정 리소스 보호
LDAP을 구성한 후에는 authenticate 함수를 사용하여 애플리케이션의 특정 리소스를 보호할 수 있습니다. 인증에 성공한 경우, 라우트 핸들러 내부에서 call.principal 함수를 사용하여 인증된 UserIdPrincipal을 가져오고 인증된 사용자의 이름을 확인할 수 있습니다.
routing {
authenticate("auth-ldap") {
get("/") {
val user = call.principal<UserIdPrincipal>()
call.respondText("Hello, ${user?.name}!")
}
}
}authenticateWith()에 스키마를 전달합니다. 블록 내부에서 call.principal은 사용자가 정의한 principal 타입이며 절대 null이 되지 않으므로 타입 캐스팅이나 null 검사가 필요하지 않습니다:
routing {
authenticateWith(ldapAuth) {
get("/") {
call.respondText("Hello, ${call.principal.name}!")
}
}
}실행 가능한 전체 예제는 auth-ldap에서 확인할 수 있습니다.
현재 LDAP 구현은 동기식(synchronous)이라는 점에 유의하세요.
