okhttp / okhttp3 / Handshake

Handshake

data class Handshake

A record of a TLS handshake. For HTTPS clients, the client is local and the remote server is its peer.

This value object describes a completed handshake. Use ConnectionSpec to set policy for new handshakes.

Functions

cipherSuite

fun cipherSuite(): CipherSuite

Returns the cipher suite used for the connection.

localCertificates

fun localCertificates(): List<Certificate>

Returns a possibly-empty list of certificates that identify this peer.

localPrincipal

fun localPrincipal(): Principal?

Returns the local principle, or null if this peer is anonymous.

peerCertificates

fun peerCertificates(): List<Certificate>

Returns a possibly-empty list of certificates that identify the remote peer.

peerPrincipal

fun peerPrincipal(): Principal?

Returns the remote peer's principle, or null if that peer is anonymous.

tlsVersion

fun tlsVersion(): TlsVersion

Returns the TLS version used for this connection. This value wasn't tracked prior to OkHttp 3.0. For responses cached by preceding versions this returns TlsVersion.SSL_3_0.

toString

fun toString(): String

Companion Object Functions

get

fun get(session: SSLSession): Handshake
fun get(tlsVersion: TlsVersion, cipherSuite: CipherSuite, peerCertificates: List<Certificate>, localCertificates: List<Certificate>): Handshake