SSLParameters

SSLParameters

SSLParameters()

Constructs SSLParameters.

The values of cipherSuites, protocols, cryptographic algorithm constraints, endpoint identification algorithm, server names and server name matchers are set to null, useCipherSuitesOrder, wantClientAuth and needClientAuth are set to false.

SSLParameters

SSLParameters(cipherSuites: Array<String!>!)

Constructs SSLParameters from the specified array of ciphersuites.

Calling this constructor is equivalent to calling the no-args constructor followed by setCipherSuites(cipherSuites);.

SSLParameters

SSLParameters(
    cipherSuites: Array<String!>!, 
    protocols: Array<String!>!)

Constructs SSLParameters from the specified array of ciphersuites and protocols.

Calling this constructor is equivalent to calling the no-args constructor followed by setCipherSuites(cipherSuites); setProtocols(protocols);.

getAlgorithmConstraints

open fun getAlgorithmConstraints(): AlgorithmConstraints!

Returns the cryptographic algorithm constraints.

getApplicationProtocols

open fun getApplicationProtocols(): Array<String!>!

Returns a prioritized array of application-layer protocol names that can be negotiated over the SSL/TLS protocols.

The array could be empty (zero-length), in which case protocol indications will not be used.

This method will return a new array each time it is invoked.

getCipherSuites

open fun getCipherSuites(): Array<String!>!

Returns a copy of the array of ciphersuites or null if none have been set.

getEndpointIdentificationAlgorithm

open fun getEndpointIdentificationAlgorithm(): String!

Gets the endpoint identification algorithm.

getNeedClientAuth

open fun getNeedClientAuth(): Boolean

Returns whether client authentication should be required.

getProtocols

open fun getProtocols(): Array<String!>!

Returns a copy of the array of protocols or null if none have been set.

getSNIMatchers

fun getSNIMatchers(): MutableCollection<SNIMatcher!>!

Returns a Collection containing all SNIMatchers of the Server Name Indication (SNI) parameter, or null if none has been set.

This method is only useful to SSLSockets or SSLEngines operating in server mode.

For better interoperability, providers generally will not define default matchers so that by default servers will ignore the SNI extension and continue the handshake.

getServerNames

fun getServerNames(): MutableList<SNIServerName!>!

Returns a List containing all SNIServerNames of the Server Name Indication (SNI) parameter, or null if none has been set.

This method is only useful to SSLSockets or SSLEngines operating in client mode.

For SSL/TLS connections, the underlying SSL/TLS provider may specify a default value for a certain server name type. In client mode, it is recommended that, by default, providers should include the server name indication whenever the server can be located by a supported server name type.

It is recommended that providers initialize default Server Name Indications when creating SSLSocket/SSLEngines. In the following examples, the server name could be represented by an instance of SNIHostName which has been initialized with the hostname "www.example.com" and type StandardConstants#SNI_HOST_NAME.

Socket socket =
          sslSocketFactory.createSocket("www.example.com", 443);
  

SSLEngine engine =
          sslContext.createSSLEngine("www.example.com", 443);
  

getUseCipherSuitesOrder

fun getUseCipherSuitesOrder(): Boolean

Returns whether the local cipher suites preference should be honored.

getWantClientAuth

open fun getWantClientAuth(): Boolean

Returns whether client authentication should be requested.

setAlgorithmConstraints

open fun setAlgorithmConstraints(constraints: AlgorithmConstraints!): Unit

Sets the cryptographic algorithm constraints, which will be used in addition to any configured by the runtime environment.

If the constraints parameter is non-null, every cryptographic algorithm, key and algorithm parameters used in the SSL/TLS handshake must be permitted by the constraints.

setApplicationProtocols

open fun setApplicationProtocols(protocols: Array<String!>!): Unit

Sets the prioritized array of application-layer protocol names that can be negotiated over the SSL/TLS protocols.

If application-layer protocols are supported by the underlying SSL/TLS implementation, this method configures which values can be negotiated by protocols such as RFC 7301 , the Application Layer Protocol Negotiation (ALPN).

If this end of the connection is expected to offer application protocol values, all protocols configured by this method will be sent to the peer.

If this end of the connection is expected to select the application protocol value, the protocols configured by this method are compared with those sent by the peer. The first matched value becomes the negotiated value. If none of the protocols were actually requested by the peer, the underlying protocol will determine what action to take. (For example, ALPN will send a "no_application_protocol" alert and terminate the connection.)

setCipherSuites

open fun setCipherSuites(cipherSuites: Array<String!>!): Unit

Sets the array of ciphersuites.

setEndpointIdentificationAlgorithm

open fun setEndpointIdentificationAlgorithm(algorithm: String!): Unit

Sets the endpoint identification algorithm.

If the algorithm parameter is non-null or non-empty, the endpoint identification/verification procedures must be handled during SSL/TLS handshaking. This is to prevent on-path attacks.

setNeedClientAuth

open fun setNeedClientAuth(needClientAuth: Boolean): Unit

Sets whether client authentication should be required. Calling this method clears the wantClientAuth flag.

setProtocols

open fun setProtocols(protocols: Array<String!>!): Unit

Sets the array of protocols.

setSNIMatchers

fun setSNIMatchers(matchers: MutableCollection<SNIMatcher!>!): Unit

Sets the SNIMatchers of the Server Name Indication (SNI) parameter.

This method is only useful to SSLSockets or SSLEngines operating in server mode.

Note that the matchers collection is cloned to protect against subsequent modification.

setServerNames

fun setServerNames(serverNames: MutableList<SNIServerName!>!): Unit

Sets the desired SNIServerNames of the Server Name Indication (SNI) parameter.

This method is only useful to SSLSockets or SSLEngines operating in client mode.

Note that the serverNames list is cloned to protect against subsequent modification.

setUseCipherSuitesOrder

fun setUseCipherSuitesOrder(honorOrder: Boolean): Unit

Sets whether the local cipher suites preference should be honored.

setWantClientAuth

open fun setWantClientAuth(wantClientAuth: Boolean): Unit

Sets whether client authentication should be requested. Calling this method clears the needClientAuth flag.