ktor-network-tls

alltypes

object CIOCipherSuites

val ECDHE_ECDSA_AES128_SHA256: CipherSuite
val ECDHE_ECDSA_AES256_SHA384: CipherSuite
val ECDHE_RSA_AES128_SHA256: CipherSuite
val ECDHE_RSA_AES256_SHA384: CipherSuite
val SupportedSuites: List<CipherSuite>
val TLS_RSA_WITH_AES128_CBC_SHA: CipherSuite
val TLS_RSA_WITH_AES256_CBC_SHA: CipherSuite
val TLS_RSA_WITH_AES_128_GCM_SHA256: CipherSuite

class CertificateAndKey

CertificateAndKey(certificateChain: Array<X509Certificate>, key: PrivateKey)
val certificateChain: Array<X509Certificate>
val key: PrivateKey

data class CipherSuite

CipherSuite(code: Short, name: String, openSSLName: String, exchangeType: SecretExchangeType, jdkCipherName: String, keyStrength: Int, fixedIvLength: Int, ivLength: Int, cipherTagSizeInBytes: Int, macName: String, macStrength: Int, hash: HashAlgorithm, signatureAlgorithm: SignatureAlgorithm, cipherType: CipherType = CipherType.GCM)
val cipherTagSizeInBytes: Int
val cipherType: CipherType
val code: Short
val exchangeType: SecretExchangeType
val fixedIvLength: Int
val hash: HashAlgorithm
val ivLength: Int
val jdkCipherName: String
val keyStrength: Int
val keyStrengthInBytes: Int
val macName: String
val macStrength: Int
val macStrengthInBytes: Int
val name: String
val openSSLName: String
val signatureAlgorithm: SignatureAlgorithm

enum class CipherType

CBC
GCM

enum class HashAlgorithm

INTRINSIC
MD5
NONE
SHA1
SHA224
SHA256
SHA384
SHA512
fun byCode(code: Byte): HashAlgorithm
val code: Byte
val macName: String
val openSSLName: String

data class HashAndSign

HashAndSign(hash: HashAlgorithm, sign: SignatureAlgorithm, oid: OID? = null)
val hash: HashAlgorithm
val name: String
val oid: OID?
val sign: SignatureAlgorithm

enum class NamedCurve

val code: Short
val fieldSize: Int
fun fromCode(code: Short): NamedCurve?
secp160k1
secp160r1
secp160r2
secp192k1
secp192r1
secp224k1
secp224r1
secp256k1
secp256r1
secp384r1
secp521r1
sect163k1
sect163r1
sect163r2
sect193r1
sect193r2
sect233k1
sect233r1
sect239k1
sect283k1
sect283r1
sect409k1
sect409r1
sect571k1
sect571r1

class NoPrivateKeyException : IllegalStateException, CopyableThrowable<NoPrivateKeyException>

NoPrivateKeyException(alias: String, store: KeyStore)
fun createCopy(): NoPrivateKeyException?

data class OID

OID(identifier: String)
val CommonName: OID
val CountryName: OID
val ECDSAwithSHA256Encryption: OID
val ECDSAwithSHA384Encryption: OID
val ECEncryption: OID
val OrganizationName: OID
val OrganizationalUnitName: OID
val RSAEncryption: OID
val RSAwithSHA1Encryption: OID
val RSAwithSHA256Encryption: OID
val RSAwithSHA384Encryption: OID
val RSAwithSHA512Encryption: OID
val SubjectAltName: OID
val asArray: IntArray
fun fromAlgorithm(algorithm: String): OID
val identifier: String
val secp256r1: OID

enum class PointFormat

ANSIX962_COMPRESSED_CHAR2
ANSIX962_COMPRESSED_PRIME
UNCOMPRESSED
val code: Byte

enum class SecretExchangeType

ECDHE
RSA
val jvmName: String

enum class ServerKeyExchangeType

ExplicitChar
ExplicitPrime
NamedCurve
fun byCode(code: Int): ServerKeyExchangeType
val code: Int

enum class SignatureAlgorithm

ANON
DSA
ECDSA
ED25519
ED448
RSA
fun byCode(code: Byte): SignatureAlgorithm?
val code: Byte

enum class TLSAlertLevel

FATAL
WARNING
fun byCode(code: Int): TLSAlertLevel
val code: Int

enum class TLSAlertType

AccessDenied
BadCertificate
BadRecordMac
CertificateExpired
CertificateRevoked
CertificateUnknown
CloseNotify
DecodeError
DecompressionFailure
DecryptError
DecryptionFailed_RESERVED
ExportRestriction_RESERVED
HandshakeFailure
IllegalParameter
InsufficientSecurity
InternalError
NoCertificate_RESERVED
NoRenegotiation
ProtocolVersion
RecordOverflow
UnexpectedMessage
UnknownCa
UnsupportedCertificate
UnsupportedExtension
UserCanceled
fun byCode(code: Int): TLSAlertType
val code: Int

expect class TLSConfig

TLSConfig(random: SecureRandom, certificates: List<CertificateAndKey>, trustManager: X509TrustManager, cipherSuites: List<CipherSuite>, serverName: String?)
val certificates: List<CertificateAndKey>
val cipherSuites: List<CipherSuite>
val random: SecureRandom
val serverName: String?
val trustManager: X509TrustManager

expect class TLSConfigBuilder

TLSConfigBuilder()
fun build(): TLSConfig
val certificates: MutableList<CertificateAndKey>
var cipherSuites: List<CipherSuite>
var random: SecureRandom?
var serverName: String?
var trustManager: TrustManager?

enum class TLSExtensionType

CLIENT_CERTIFICATE_URL
EC_POINT_FORMAT
ELLIPTIC_CURVES
MAX_FRAGMENT_LENGTH
SERVER_NAME
SIGNATURE_ALGORITHMS
STATUS_REQUEST
TRUNCATED_HMAC
TRUSTED_CA_KEYS
fun byCode(code: Int): TLSExtensionType
val code: Short

enum class TLSHandshakeType

Certificate
CertificateRequest
CertificateVerify
ClientHello
ClientKeyExchange
Finished
HelloRequest
ServerDone
ServerHello
ServerKeyExchange
fun byCode(code: Int): TLSHandshakeType
val code: Int

enum class TLSRecordType

Alert
ApplicationData
ChangeCipherSpec
Handshake
fun byCode(code: Int): TLSRecordType
val code: Int

enum class TLSVersion

SSL3
TLS10
TLS11
TLS12
fun byCode(code: Int): TLSVersion
val code: Int

io.ktor.network.sockets.Connection

suspend fun Connection.tls(coroutineContext: <ERROR CLASS>, config: TLSConfig): Socket
suspend fun Connection.tls(coroutineContext: <ERROR CLASS>): Socket
suspend fun Connection.tls(coroutineContext: <ERROR CLASS>, block: TLSConfigBuilder.() -> Unit): Socket

io.ktor.network.sockets.Socket

suspend expect fun Socket.tls(coroutineContext: <ERROR CLASS>, config: TLSConfig): Socket
suspend fun Socket.tls(coroutineContext: <ERROR CLASS>): Socket
suspend expect fun Socket.tls(coroutineContext: <ERROR CLASS>, block: TLSConfigBuilder.() -> Unit): Socket
suspend fun Socket.tls(coroutineContext: <ERROR CLASS>, trustManager: X509TrustManager? = null, randomAlgorithm: String = "NativePRNGNonBlocking", cipherSuites: List<CipherSuite> = CIOCipherSuites.SupportedSuites, serverName: String? = null): Socket

package io.ktor.network.tls

object CIOCipherSuites

val ECDHE_ECDSA_AES128_SHA256: CipherSuite
val ECDHE_ECDSA_AES256_SHA384: CipherSuite
val ECDHE_RSA_AES128_SHA256: CipherSuite
val ECDHE_RSA_AES256_SHA384: CipherSuite
val SupportedSuites: List<CipherSuite>
val TLS_RSA_WITH_AES128_CBC_SHA: CipherSuite
val TLS_RSA_WITH_AES256_CBC_SHA: CipherSuite
val TLS_RSA_WITH_AES_128_GCM_SHA256: CipherSuite

class CertificateAndKey

CertificateAndKey(certificateChain: Array<X509Certificate>, key: PrivateKey)
val certificateChain: Array<X509Certificate>
val key: PrivateKey

data class CipherSuite

CipherSuite(code: Short, name: String, openSSLName: String, exchangeType: SecretExchangeType, jdkCipherName: String, keyStrength: Int, fixedIvLength: Int, ivLength: Int, cipherTagSizeInBytes: Int, macName: String, macStrength: Int, hash: HashAlgorithm, signatureAlgorithm: SignatureAlgorithm, cipherType: CipherType = CipherType.GCM)
val cipherTagSizeInBytes: Int
val cipherType: CipherType
val code: Short
val exchangeType: SecretExchangeType
val fixedIvLength: Int
val hash: HashAlgorithm
val ivLength: Int
val jdkCipherName: String
val keyStrength: Int
val keyStrengthInBytes: Int
val macName: String
val macStrength: Int
val macStrengthInBytes: Int
val name: String
val openSSLName: String
val signatureAlgorithm: SignatureAlgorithm

enum class CipherType

CBC
GCM

class NoPrivateKeyException : IllegalStateException, CopyableThrowable<NoPrivateKeyException>

NoPrivateKeyException(alias: String, store: KeyStore)
fun createCopy(): NoPrivateKeyException?

data class OID

OID(identifier: String)
val CommonName: OID
val CountryName: OID
val ECDSAwithSHA256Encryption: OID
val ECDSAwithSHA384Encryption: OID
val ECEncryption: OID
val OrganizationName: OID
val OrganizationalUnitName: OID
val RSAEncryption: OID
val RSAwithSHA1Encryption: OID
val RSAwithSHA256Encryption: OID
val RSAwithSHA384Encryption: OID
val RSAwithSHA512Encryption: OID
val SubjectAltName: OID
val asArray: IntArray
fun fromAlgorithm(algorithm: String): OID
val identifier: String
val secp256r1: OID

enum class SecretExchangeType

ECDHE
RSA
val jvmName: String

enum class ServerKeyExchangeType

ExplicitChar
ExplicitPrime
NamedCurve
fun byCode(code: Int): ServerKeyExchangeType
val code: Int

enum class TLSAlertLevel

FATAL
WARNING
fun byCode(code: Int): TLSAlertLevel
val code: Int

enum class TLSAlertType

AccessDenied
BadCertificate
BadRecordMac
CertificateExpired
CertificateRevoked
CertificateUnknown
CloseNotify
DecodeError
DecompressionFailure
DecryptError
DecryptionFailed_RESERVED
ExportRestriction_RESERVED
HandshakeFailure
IllegalParameter
InsufficientSecurity
InternalError
NoCertificate_RESERVED
NoRenegotiation
ProtocolVersion
RecordOverflow
UnexpectedMessage
UnknownCa
UnsupportedCertificate
UnsupportedExtension
UserCanceled
fun byCode(code: Int): TLSAlertType
val code: Int

expect class TLSConfig

TLSConfig(random: SecureRandom, certificates: List<CertificateAndKey>, trustManager: X509TrustManager, cipherSuites: List<CipherSuite>, serverName: String?)
val certificates: List<CertificateAndKey>
val cipherSuites: List<CipherSuite>
val random: SecureRandom
val serverName: String?
val trustManager: X509TrustManager

expect class TLSConfigBuilder

TLSConfigBuilder()
fun build(): TLSConfig
val certificates: MutableList<CertificateAndKey>
var cipherSuites: List<CipherSuite>
var random: SecureRandom?
var serverName: String?
var trustManager: TrustManager?

enum class TLSHandshakeType

Certificate
CertificateRequest
CertificateVerify
ClientHello
ClientKeyExchange
Finished
HelloRequest
ServerDone
ServerHello
ServerKeyExchange
fun byCode(code: Int): TLSHandshakeType
val code: Int

enum class TLSRecordType

Alert
ApplicationData
ChangeCipherSpec
Handshake
fun byCode(code: Int): TLSRecordType
val code: Int

enum class TLSVersion

SSL3
TLS10
TLS11
TLS12
fun byCode(code: Int): TLSVersion
val code: Int

fun TLSConfigBuilder.addCertificateChain(chain: Array<X509Certificate>, key: PrivateKey): Unit
fun TLSConfigBuilder.addKeyStore(store: KeyStore, password: CharArray): Unit
fun TLSConfigBuilder.addKeyStore(store: KeyStore, password: CharArray, alias: String? = null): Unit
io.ktor.network.sockets.Connection

suspend fun Connection.tls(coroutineContext: <ERROR CLASS>, config: TLSConfig): Socket
suspend fun Connection.tls(coroutineContext: <ERROR CLASS>): Socket
suspend fun Connection.tls(coroutineContext: <ERROR CLASS>, block: TLSConfigBuilder.() -> Unit): Socket

io.ktor.network.sockets.Socket

suspend expect fun Socket.tls(coroutineContext: <ERROR CLASS>, config: TLSConfig): Socket
suspend fun Socket.tls(coroutineContext: <ERROR CLASS>): Socket
suspend expect fun Socket.tls(coroutineContext: <ERROR CLASS>, block: TLSConfigBuilder.() -> Unit): Socket
suspend fun Socket.tls(coroutineContext: <ERROR CLASS>, trustManager: X509TrustManager? = null, randomAlgorithm: String = "NativePRNGNonBlocking", cipherSuites: List<CipherSuite> = CIOCipherSuites.SupportedSuites, serverName: String? = null): Socket

fun keysGenerationAlgorithm(algorithm: String): String
expect fun TLSConfigBuilder.takeFrom(other: TLSConfigBuilder): Unit

package io.ktor.network.tls.extensions

enum class HashAlgorithm

INTRINSIC
MD5
NONE
SHA1
SHA224
SHA256
SHA384
SHA512
fun byCode(code: Byte): HashAlgorithm
val code: Byte
val macName: String
val openSSLName: String

data class HashAndSign

HashAndSign(hash: HashAlgorithm, sign: SignatureAlgorithm, oid: OID? = null)
val hash: HashAlgorithm
val name: String
val oid: OID?
val sign: SignatureAlgorithm

enum class NamedCurve

val code: Short
val fieldSize: Int
fun fromCode(code: Short): NamedCurve?
secp160k1
secp160r1
secp160r2
secp192k1
secp192r1
secp224k1
secp224r1
secp256k1
secp256r1
secp384r1
secp521r1
sect163k1
sect163r1
sect163r2
sect193r1
sect193r2
sect233k1
sect233r1
sect239k1
sect283k1
sect283r1
sect409k1
sect409r1
sect571k1
sect571r1

enum class PointFormat

ANSIX962_COMPRESSED_CHAR2
ANSIX962_COMPRESSED_PRIME
UNCOMPRESSED
val code: Byte

enum class SignatureAlgorithm

ANON
DSA
ECDSA
ED25519
ED448
RSA
fun byCode(code: Byte): SignatureAlgorithm?
val code: Byte

val SupportedNamedCurves: List<NamedCurve>
val SupportedPointFormats: List<PointFormat>
val SupportedSignatureAlgorithms: List<HashAndSign>
enum class TLSExtensionType

CLIENT_CERTIFICATE_URL
EC_POINT_FORMAT
ELLIPTIC_CURVES
MAX_FRAGMENT_LENGTH
SERVER_NAME
SIGNATURE_ALGORITHMS
STATUS_REQUEST
TRUNCATED_HMAC
TRUSTED_CA_KEYS
fun byCode(code: Int): TLSExtensionType
val code: Short

fun HashAndSign.Companion.byCode(hash: Byte, sign: Byte): HashAndSign?