Skip to content
Client Plugin

Ktor Client における SSL

コード例: client-ssl-config

Ktor クライアントで SSL を設定するには、クライアントで使用されるエンジンの設定をカスタマイズする必要があります。

このトピックでは、JVM および Android をターゲットとするエンジンに対して SSL 証明書を追加する方法について説明します。

Ktor で自己署名証明書を生成する方法については、自己署名証明書の生成を参照してください。

SSL 設定の読み込み ​

このトピックでは、Ktor クライアントはサーバー用に生成された既存の KeyStore ファイル(keystore.jks)から読み込まれた証明書を使用します。

エンジンごとに SSL を設定するために異なる JSSE API を使用しているため(例えば、Apache の場合は SSLContext、Jetty の場合は TrustManager など)、対応する SSL 設定を取得できる手段を用意する必要があります。

以下のコードスニペットでは、既存の KeyStore ファイル(keystore.jks)から証明書を読み込み、SSL 設定を取得するための関数を提供する SslSettings オブジェクトを作成します。

同じ KeyStore が、サーバー証明書を信頼するため、また、トラストストアが設定されたサーバーで必要とされるクライアント証明書を KeyManagerFactory 経由で提示するために使用されます。

kotlin
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 を設定します。

kotlin
val apacheClient = HttpClient(Apache5) {
    engine {
        sslContext = SslSettings.getSslContext()
    }
}

Java ​

Java クライアントの場合、config {} ブロック内の sslContext() 関数を使用して SSLContext を設定します。

kotlin
val javaClient = HttpClient(Java) {
    engine {
        config {
            sslContext(SslSettings.getSslContext())
        }
    }
}

Jetty ​

Jetty クライアントの場合、sslContextFactory パラメーターを使用して SslContextFactory のインスタンスを作成し、SSLContext を渡します。

kotlin
val jettyClient = HttpClient(Jetty) {
    engine {
        sslContextFactory = SslContextFactory.Client().apply {
            sslContext = SslSettings.getSslContext()
        }
    }
}

JVM および Android ​

Android をターゲットとするすべてのエンジンは、ネットワーク セキュリティ構成を使用します。

CIO ​

CIO エンジンでは、https {} ブロック内で HTTPS の設定を行うことができます。 このブロック内では、TLSConfigBuilder によって提供される TLS パラメーターにアクセスできます。

以下の例では、サーバー証明書を信頼するために TrustManager インスタンスが使用され、addKeyStore() 関数によってクライアント証明書が追加されます。

kotlin
val cioClient = HttpClient(CIO) {
    engine {
        https {
            trustManager = SslSettings.getTrustManager()
            addKeyStore(SslSettings.getKeyStore(), "foobar".toCharArray())
        }
    }
}

sockets-client-tls の例では、すべての証明書を信頼する方法を示しています。 このアプローチは開発目的でのみ使用してください。

Android ​

Android エンジンは、SSL 設定を行うために sslManager プロパティを使用します。 このプロパティはパラメーターとして HttpsURLConnection を受け取り、SSLSocketFactory を渡すことができます。

kotlin
val androidClient = HttpClient(Android) {
    engine {
        sslManager = { httpsURLConnection ->
            httpsURLConnection.sslSocketFactory = SslSettings.getSslContext()?.socketFactory
        }
    }
}

OkHttp ​

OkHttp クライアントエンジンで SSL を設定するには、config {} ブロック内の sslSocketFactory() 関数に SSLSocketFactory と X509TrustManager を渡します。

kotlin
val okHttpClient = HttpClient(OkHttp) {
    engine {
        config {
            sslSocketFactory(SslSettings.getSslContext()!!.socketFactory, SslSettings.getTrustManager())
        }
    }
}

Darwin ​

Darwin エンジンで信頼する証明書を設定するには、CertificatePinner を使用します。