Ktor Client의 SSL
코드 예제: client-ssl-config
Ktor 클라이언트에서 SSL을 구성하려면 클라이언트에서 사용하는 엔진 구성을 사용자 정의해야 합니다.
이 문서에서는 JVM 및 Android를 대상으로 하는 엔진에 SSL 인증서를 추가하는 방법을 알아봅니다.
Ktor로 자체 서명 인증서(self-signed certificate)를 생성하는 방법은 자체 서명 인증서 생성을 참고하세요.
SSL 설정 로드
이 문서에서는 Ktor 클라이언트가 서버용으로 생성된 기존 KeyStore 파일(keystore.jks)에서 로드한 인증서를 사용합니다.
엔진마다 SSL을 구성하는 데 사용하는 JSSE API가 다르므로(예: Apache의 경우 SSLContext, Jetty의 경우 TrustManager), 해당 SSL 구성을 가져올 수 있어야 합니다.
아래 코드 스니펫은 기존 KeyStore 파일(keystore.jks)에서 인증서를 로드하고 SSL 구성을 로드하는 함수를 제공하는 SslSettings 객체를 생성합니다.
동일한 KeyStore가 서버 인증서를 신뢰하는 데 사용되며, KeyManagerFactory를 통해 트러스트 스토어가 구성된 서버에서 요구하는 클라이언트 인증서를 제시하는 데에도 사용됩니다.
object SslSettings {
fun getKeyStore(): KeyStore {
val keyStoreFile = FileInputStream("keystore.jks")
val keyStorePassword = "foobar".toCharArray()
val keyStore: KeyStore = KeyStore.getInstance(KeyStore.getDefaultType())
keyStore.load(keyStoreFile, keyStorePassword)
return keyStore
}
fun getTrustManagerFactory(): TrustManagerFactory? {
val trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm())
trustManagerFactory.init(getKeyStore())
return trustManagerFactory
}
fun getKeyManagerFactory(): KeyManagerFactory? {
val keyManagerFactory = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm())
keyManagerFactory.init(getKeyStore(), "foobar".toCharArray())
return keyManagerFactory
}
fun getSslContext(): SSLContext? {
val sslContext = SSLContext.getInstance("TLS")
sslContext.init(getKeyManagerFactory()?.keyManagers, getTrustManagerFactory()?.trustManagers, null)
return sslContext
}
fun getTrustManager(): X509TrustManager {
return getTrustManagerFactory()?.trustManagers?.first { it is X509TrustManager } as X509TrustManager
}
}Ktor에서 SSL 구성
SSL 구성은 엔진에 따라 다릅니다. 다음 섹션에서는 각 엔진별로 SSL을 구성하는 방법을 설명합니다.
JVM
Apache 및 Apache5
Apache 및 Apache 5 클라이언트에서 SSL을 활성화하려면 sslContext 파라미터를 사용하여 SSLContext를 구성하세요.
val apacheClient = HttpClient(Apache5) {
engine {
sslContext = SslSettings.getSslContext()
}
}Java
Java 클라이언트의 경우, config {} 블록 내부에서 sslContext() 함수를 사용하여 SSLContext를 구성합니다.
val javaClient = HttpClient(Java) {
engine {
config {
sslContext(SslSettings.getSslContext())
}
}
}Jetty
Jetty 클라이언트의 경우, sslContextFactory 파라미터를 사용하여 SslContextFactory 인스턴스를 생성하고 SSLContext를 전달합니다.
val jettyClient = HttpClient(Jetty) {
engine {
sslContextFactory = SslContextFactory.Client().apply {
sslContext = SslSettings.getSslContext()
}
}
}JVM 및 Android
Android를 대상으로 하는 모든 엔진은 네트워크 보안 구성을 사용합니다.
CIO
CIO 엔진에서는 https {} 블록 내부에서 HTTPS 설정을 구성할 수 있습니다. 이 블록 내에서 TLSConfigBuilder가 제공하는 TLS 파라미터에 접근할 수 있습니다.
다음 예제에서는 TrustManager 인스턴스를 사용하여 서버 인증서를 신뢰하고, addKeyStore() 함수로 클라이언트 인증서를 추가합니다.
val cioClient = HttpClient(CIO) {
engine {
https {
trustManager = SslSettings.getTrustManager()
addKeyStore(SslSettings.getKeyStore(), "foobar".toCharArray())
}
}
}sockets-client-tls 예제에서는 모든 인증서를 신뢰하는 방법을 보여줍니다. 이 방식은 개발 목적으로만 사용해야 합니다.
Android
Android 엔진은 SSL 설정을 구성하기 위해 sslManager 프로퍼티를 사용합니다. 이 프로퍼티는 SSLSocketFactory를 전달할 수 있는 HttpsURLConnection을 파라미터로 받습니다.
val androidClient = HttpClient(Android) {
engine {
sslManager = { httpsURLConnection ->
httpsURLConnection.sslSocketFactory = SslSettings.getSslContext()?.socketFactory
}
}
}OkHttp
OkHttp 클라이언트 엔진의 SSL을 구성하려면 config {} 블록 내의 sslSocketFactory() 함수에 SSLSocketFactory와 X509TrustManager를 전달하세요.
val okHttpClient = HttpClient(OkHttp) {
engine {
config {
sslSocketFactory(SslSettings.getSslContext()!!.socketFactory, SslSettings.getTrustManager())
}
}
}Darwin
Darwin 엔진에서 신뢰할 수 있는 인증서를 구성하려면 CertificatePinner를 사용하세요.
