ktor-network-tls/io.ktor.network.tls/TLSConfigBuilder

TLSConfigBuilder

expect class TLSConfigBuilder

TLSConfig builder.

actual class TLSConfigBuilder

TLSConfig builder.

actual class TLSConfigBuilder

TLSConfig builder.

Constructors

TLSConfigBuilder

fun TLSConfigBuilder()

TLSConfigBuilder

fun TLSConfigBuilder()

TLSConfigBuilder

expect fun TLSConfigBuilder()

Functions

build

expect fun build(): TLSConfig

Create TLSConfig.

actual fun build(): TLSConfig

Create TLSConfig.

actual fun build(): TLSConfig

Create TLSConfig.

Properties

certificates

val certificates: MutableList<CertificateAndKey>

List of client certificate chains with private keys.

cipherSuites

var cipherSuites: List<CipherSuite>

List of allowed CipherSuites.

random

var random: SecureRandom? = null

SecureRandom to use in encryption.

serverName

expect var serverName: String?

Custom server name for TLS server name extension. See also: https://en.wikipedia.org/wiki/Server_Name_Indication

actual var serverName: String?

Custom server name for TLS server name extension. See also: https://en.wikipedia.org/wiki/Server_Name_Indication

actual var serverName: String?

Custom server name for TLS server name extension. See also: https://en.wikipedia.org/wiki/Server_Name_Indication

trustManager

var trustManager: TrustManager? = null

Custom X509TrustManager to verify server authority.

Extensions

addCertificateChain

fun TLSConfigBuilder.addCertificateChain(chain: Array<X509Certificate>, key: PrivateKey)

Add client certificate chain to use.

addKeyStore

~~fun~~ TLSConfigBuilder.~~addKeyStore~~(~~store~~: KeyStore, ~~password~~: CharArray)

Add client certificates from store by using all certificates

~~fun~~ TLSConfigBuilder.~~addKeyStore~~(~~store~~: KeyStore, ~~password~~: CharArray, ~~alias~~: String? = ~~null~~)

@JvmName(name = "addKeyStoreNullablePassword")

fun TLSConfigBuilder.addKeyStore(store: KeyStore, password: CharArray?, alias: String? = null)

Add client certificates from store by using the certificate with specific alias or all certificates, if alias is null.

takeFrom

expect fun TLSConfigBuilder.takeFrom(other: TLSConfigBuilder)

Append config from other builder.

actual fun TLSConfigBuilder.takeFrom(other: TLSConfigBuilder)

Append config from other builder.

actual fun TLSConfigBuilder.takeFrom(other: TLSConfigBuilder)

Append config from other builder.