Modifier and Type	Class and Description
pack-priv static interface	SSLParametersImpl.AliasChooser For abstracting the X509KeyManager calls between `X509KeyManager#chooseClientAlias(String[], java.security.Principal[], java.net.Socket)` and `X509ExtendedKeyManager#chooseEngineClientAlias(String[], java.security.Principal[], javax.net.ssl.SSLEngine)`
pack-priv static interface	SSLParametersImpl.PSKCallbacks For abstracting the `PSKKeyManager` calls between those taking an `SSLSocket` and those taking an `SSLEngine`.

Modifier and Type	Field and Description
private AlgorithmConstraints	algorithmConstraints
pack-priv byte[]	applicationProtocols
pack-priv ApplicationProtocolSelectorAdapter	applicationProtocolSelector
pack-priv boolean	channelIdEnabled Whether the TLS Channel ID extension is enabled.
private boolean	client_mode
private final ClientSessionContext	clientSessionContext
private boolean	ctVerificationEnabled
private static volatile SSLParametersImpl	defaultParameters
private static volatile X509KeyManager	defaultX509KeyManager
private static volatile X509TrustManager	defaultX509TrustManager
private static final String[]	EMPTY_STRING_ARRAY
private boolean	enable_session_creation
pack-priv String[]	enabledCipherSuites
pack-priv String[]	enabledProtocols
private String	endpointIdentificationAlgorithm
pack-priv boolean	isEnabledProtocolsFiltered
private boolean	need_client_auth
pack-priv byte[]	ocspResponse
private final PSKKeyManager	pskKeyManager Deprecated as a consequence of `PSKKeyManager` being deprecated.
pack-priv byte[]	sctExtension
private final ServerSessionContext	serverSessionContext
private Collection<SNIMatcher>	sniMatchers
private boolean	useCipherSuitesOrder
pack-priv boolean	useSessionTickets
private Boolean	useSni
private boolean	want_client_auth
private final X509KeyManager	x509KeyManager
private final X509TrustManager	x509TrustManager

Access	Constructor and Description
pack-priv	SSLParametersImpl(KeyManager[] kms, TrustManager[] tms, SecureRandom sr, ClientSessionContext clientSessionContext, ServerSessionContext serverSessionContext, String[] protocols) Initializes the parameters.
private	SSLParametersImpl(ClientSessionContext clientSessionContext, ServerSessionContext serverSessionContext, X509KeyManager x509KeyManager, PSKKeyManager pskKeyManager, X509TrustManager x509TrustManager, SSLParametersImpl sslParams) Deprecated as a consequence of `PSKKeyManager` being deprecated.

Method Summary

Modifier and Type	Method and Description
protected Object	Returns: the clone. clone() Overrides java.lang.Object.clone. Returns the clone of this object.
pack-priv SSLParametersImpl	cloneWithTrustManager(X509TrustManager newTrustManager)
private static X509KeyManager	createDefaultX509KeyManager()
private static X509TrustManager	createDefaultX509TrustManager()
private static String[]	filterFromCipherSuites(String[] cipherSuites, Set<String> toRemove)
private static String[]	filterFromProtocols(String[] protocols, String obsoleteProtocol) This filters `obsoleteProtocol` from the list of `protocols` down to help with app compatibility.
private static PSKKeyManager	Returns: the first `PSKKeyManager` or `null` if not found. findFirstPSKKeyManager(KeyManager[] kms) Deprecated as a consequence of `PSKKeyManager` being deprecated. Finds the first `PSKKeyManager` element in the provided array.
private static X509KeyManager	Returns: the first `X509KeyManager` or `null` if not found. findFirstX509KeyManager(KeyManager[] kms) Finds the first `X509KeyManager` element in the provided array.
private static X509TrustManager	Returns: the first `X509ExtendedTrustManager` or `X509TrustManager` or `null` if not found. findFirstX509TrustManager(TrustManager[] tms) Finds the first `X509TrustManager` element in the provided array.
pack-priv AlgorithmConstraints	getAlgorithmConstraints()
pack-priv String[]	getApplicationProtocols()
pack-priv ApplicationProtocolSelectorAdapter	getApplicationProtocolSelector() Returns the application protocol (ALPN) selector for this socket.
pack-priv ClientSessionContext	Returns: client session context getClientSessionContext()
pack-priv static SSLParametersImpl	getDefault()
private static String[]	getDefaultCipherSuites(boolean x509CipherSuitesNeeded, boolean pskCipherSuitesNeeded)
private static X509KeyManager	getDefaultX509KeyManager()
pack-priv static X509TrustManager	getDefaultX509TrustManager() Gets the default X.509 trust manager.
pack-priv String[]	Returns: the names of enabled cipher suites getEnabledCipherSuites()
pack-priv String[]	Returns: the set of enabled protocols getEnabledProtocols()
pack-priv boolean	getEnableSessionCreation() Returns the value indicating if the peer with this parameters allowed to cteate new SSL session
pack-priv String	getEndpointIdentificationAlgorithm()
pack-priv boolean	getNeedClientAuth() Returns the value indicating if the peer with this parameters tuned to require client authentication
pack-priv byte[]	getOCSPResponse()
pack-priv PSKKeyManager	Returns: Pre-Shared Key (PSK) key manager or `null` for none. getPSKKeyManager() Deprecated as a consequence of `PSKKeyManager` being deprecated.
pack-priv AbstractSessionContext	getSessionContext() Returns the appropriate session context.
pack-priv Collection<SNIMatcher>	getSNIMatchers()
pack-priv boolean	getUseCipherSuitesOrder()
pack-priv boolean	getUseClientMode() Returns the value indicating if the parameters configured to work in client mode.
pack-priv boolean	getUseSni() Returns whether connections using this SSL connection should use the TLS extension Server Name Indication (SNI).
pack-priv boolean	getWantClientAuth() Returns the value indicating if the peer with this parameters tuned to request client authentication
pack-priv X509KeyManager	Returns: X.509 key manager or `null` for none. getX509KeyManager()
pack-priv X509TrustManager	Returns: X.509 trust manager or `null` for none. getX509TrustManager()
pack-priv boolean	isCTVerificationEnabled(String hostname) Check if SCT verification is enforced for a given hostname.
private boolean	isSniEnabledByDefault() Returns whether Server Name Indication (SNI) is enabled by default for sockets.
pack-priv void	setAlgorithmConstraints(AlgorithmConstraints algorithmConstraints)
pack-priv void	setApplicationProtocols(String[] the list of ALPN protocols protocols) Sets the list of ALPN protocols.
pack-priv void	setApplicationProtocolSelector(ApplicationProtocolSelectorAdapter applicationProtocolSelector) Used for server-mode only.
pack-priv void	setCTVerificationEnabled(boolean enabled) For testing only.
pack-priv void	setEnabledCipherSuites(String[] cipherSuites) Sets the enabled cipher suites after filtering through OpenSSL.
pack-priv void	setEnabledProtocols(String[] protocols) Sets the list of available protocols for use in SSL connection.
pack-priv void	setEnableSessionCreation(boolean flag) Allows/disallows the peer holding this parameters to create new SSL session
pack-priv void	setEndpointIdentificationAlgorithm(String endpointIdentificationAlgorithm)
pack-priv void	setNeedClientAuth(boolean need) Tunes the peer holding this parameters to require client authentication
pack-priv void	setOCSPResponse(byte[] response) For testing only.
pack-priv void	setSCTExtension(byte[] extension) For testing only.
pack-priv void	setSNIMatchers(Collection<SNIMatcher> sniMatchers)
pack-priv void	setUseCipherSuitesOrder(boolean useCipherSuitesOrder)
pack-priv void	setUseClientMode(boolean if the peer is configured to work in client mode mode) Tunes the peer holding this parameters to work in client mode.
pack-priv void	setUseSessionTickets(boolean useSessionTickets)
pack-priv void	setUseSni(boolean flag) Whether connections using this SSL connection should use the TLS extension Server Name Indication (SNI).
pack-priv void	setWantClientAuth(boolean want) Tunes the peer holding this parameters to request client authentication

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithmConstraints	back to summary
private AlgorithmConstraints algorithmConstraints

applicationProtocols	back to summary
pack-priv byte[] applicationProtocols

applicationProtocolSelector	back to summary
pack-priv ApplicationProtocolSelectorAdapter applicationProtocolSelector

channelIdEnabled	back to summary
pack-priv boolean channelIdEnabled Whether the TLS Channel ID extension is enabled. This field is server-side only.

client_mode	back to summary
private boolean client_mode

clientSessionContext	back to summary
private final ClientSessionContext clientSessionContext

ctVerificationEnabled	back to summary
private boolean ctVerificationEnabled

defaultParameters	back to summary
private static volatile SSLParametersImpl defaultParameters

defaultX509KeyManager	back to summary
private static volatile X509KeyManager defaultX509KeyManager

defaultX509TrustManager	back to summary
private static volatile X509TrustManager defaultX509TrustManager

EMPTY_STRING_ARRAY	back to summary
private static final String[] EMPTY_STRING_ARRAY

enable_session_creation	back to summary
private boolean enable_session_creation

enabledCipherSuites	back to summary
pack-priv String[] enabledCipherSuites

enabledProtocols	back to summary
pack-priv String[] enabledProtocols

endpointIdentificationAlgorithm	back to summary
private String endpointIdentificationAlgorithm

isEnabledProtocolsFiltered	back to summary
pack-priv boolean isEnabledProtocolsFiltered

need_client_auth	back to summary
private boolean need_client_auth

ocspResponse	back to summary
pack-priv byte[] ocspResponse

pskKeyManager	back to summary
private final PSKKeyManager pskKeyManager Deprecated as a consequence of `PSKKeyManager` being deprecated. See corresponding docs for further information. Annotations @SuppressWarnings:deprecation

sctExtension	back to summary
pack-priv byte[] sctExtension

serverSessionContext	back to summary
private final ServerSessionContext serverSessionContext

sniMatchers	back to summary
private Collection<SNIMatcher> sniMatchers

useCipherSuitesOrder	back to summary
private boolean useCipherSuitesOrder

useSessionTickets	back to summary
pack-priv boolean useSessionTickets

useSni	back to summary
private Boolean useSni

want_client_auth	back to summary
private boolean want_client_auth

x509KeyManager	back to summary
private final X509KeyManager x509KeyManager

x509TrustManager	back to summary
private final X509TrustManager x509TrustManager

Constructor Detail

SSLParametersImpl back to summary

SSLParametersImpl	back to summary
pack-priv SSLParametersImpl(KeyManager[] kms, TrustManager[] tms, SecureRandom sr, ClientSessionContext clientSessionContext, ServerSessionContext serverSessionContext, String[] protocols) throws KeyManagementException Initializes the parameters. Naturally this constructor is used in SSLContextImpl.engineInit method which directly passes its parameters. In other words this constructor holds all the functionality provided by SSLContext.init method. See `javax.net.ssl.SSLContext#init(KeyManager[], TrustManager[], SecureRandom)` for more information

pack-priv SSLParametersImpl(KeyManager[] kms, TrustManager[] tms, SecureRandom sr, ClientSessionContext clientSessionContext, ServerSessionContext serverSessionContext, String[] protocols) throws KeyManagementException

Initializes the parameters. Naturally this constructor is used in SSLContextImpl.engineInit method which directly passes its parameters. In other words this constructor holds all the functionality provided by SSLContext.init method. See javax.net.ssl.SSLContext#init(KeyManager[], TrustManager[], SecureRandom) for more information

SSLParametersImpl	back to summary
private SSLParametersImpl(ClientSessionContext clientSessionContext, ServerSessionContext serverSessionContext, X509KeyManager x509KeyManager, PSKKeyManager pskKeyManager, X509TrustManager x509TrustManager, SSLParametersImpl sslParams) Deprecated as a consequence of `PSKKeyManager` being deprecated. See corresponding docs for further information. Annotations @SuppressWarnings:deprecation

Method Detail

clone	back to summary
protected Object clone() Overrides java.lang.Object.clone. Returns the clone of this object. Returns:Object the clone. Annotations @Override

clone

back to summary

protected Object clone()

Overrides java.lang.Object.clone.

Returns the clone of this object.

Returns:Object

the clone.

Annotations

@Override

cloneWithTrustManager	back to summary
pack-priv SSLParametersImpl cloneWithTrustManager(X509TrustManager newTrustManager)

createDefaultX509KeyManager	back to summary
private static X509KeyManager createDefaultX509KeyManager() throws KeyManagementException

createDefaultX509TrustManager	back to summary
private static X509TrustManager createDefaultX509TrustManager() throws KeyManagementException

filterFromCipherSuites	back to summary
private static String[] filterFromCipherSuites(String[] cipherSuites, Set<String> toRemove)

filterFromProtocols	back to summary
private static String[] filterFromProtocols(String[] protocols, String obsoleteProtocol) This filters `obsoleteProtocol` from the list of `protocols` down to help with app compatibility.

findFirstPSKKeyManager back to summary

findFirstPSKKeyManager	back to summary
private static PSKKeyManager findFirstPSKKeyManager(KeyManager[] kms) Deprecated as a consequence of `PSKKeyManager` being deprecated. See corresponding docs for further information. Finds the first `PSKKeyManager` element in the provided array. Returns:PSKKeyManager the first `PSKKeyManager` or `null` if not found. Annotations @SuppressWarnings:deprecation

private static PSKKeyManager findFirstPSKKeyManager(KeyManager[] kms)

Deprecated

as a consequence of PSKKeyManager being deprecated. See corresponding docs for further information.

Finds the first PSKKeyManager element in the provided array.

Returns:PSKKeyManager

the first PSKKeyManager or null if not found.

Annotations

@SuppressWarnings:deprecation

findFirstX509KeyManager back to summary

findFirstX509KeyManager	back to summary
private static X509KeyManager findFirstX509KeyManager(KeyManager[] kms) Finds the first `X509KeyManager` element in the provided array. Returns:X509KeyManager the first `X509KeyManager` or `null` if not found.

private static X509KeyManager findFirstX509KeyManager(KeyManager[] kms)

Finds the first X509KeyManager element in the provided array.

Returns:X509KeyManager: the first X509KeyManager or null if not found.

findFirstX509TrustManager back to summary

findFirstX509TrustManager	back to summary
private static X509TrustManager findFirstX509TrustManager(TrustManager[] tms) Finds the first `X509TrustManager` element in the provided array. Returns:X509TrustManager the first `X509ExtendedTrustManager` or `X509TrustManager` or `null` if not found.

private static X509TrustManager findFirstX509TrustManager(TrustManager[] tms)

Finds the first X509TrustManager element in the provided array.

Returns:X509TrustManager: the first X509ExtendedTrustManager or X509TrustManager or null if not found.

getAlgorithmConstraints	back to summary
pack-priv AlgorithmConstraints getAlgorithmConstraints()

getApplicationProtocols	back to summary
pack-priv String[] getApplicationProtocols()

getApplicationProtocolSelector	back to summary
pack-priv ApplicationProtocolSelectorAdapter getApplicationProtocolSelector() Returns the application protocol (ALPN) selector for this socket.

getClientSessionContext	back to summary
pack-priv ClientSessionContext getClientSessionContext() Returns:ClientSessionContext client session context

getDefault	back to summary
pack-priv static SSLParametersImpl getDefault() throws KeyManagementException

getDefaultCipherSuites	back to summary
private static String[] getDefaultCipherSuites(boolean x509CipherSuitesNeeded, boolean pskCipherSuitesNeeded)

getDefaultX509KeyManager	back to summary
private static X509KeyManager getDefaultX509KeyManager() throws KeyManagementException

getDefaultX509TrustManager	back to summary
pack-priv static X509TrustManager getDefaultX509TrustManager() throws KeyManagementException Gets the default X.509 trust manager.

getEnabledCipherSuites	back to summary
pack-priv String[] getEnabledCipherSuites() Returns:String[] the names of enabled cipher suites

getEnabledProtocols	back to summary
pack-priv String[] getEnabledProtocols() Returns:String[] the set of enabled protocols

getEnableSessionCreation	back to summary
pack-priv boolean getEnableSessionCreation() Returns the value indicating if the peer with this parameters allowed to cteate new SSL session

getEndpointIdentificationAlgorithm	back to summary
pack-priv String getEndpointIdentificationAlgorithm()

getNeedClientAuth	back to summary
pack-priv boolean getNeedClientAuth() Returns the value indicating if the peer with this parameters tuned to require client authentication

getOCSPResponse	back to summary
pack-priv byte[] getOCSPResponse()

getPSKKeyManager	back to summary
pack-priv PSKKeyManager getPSKKeyManager() Deprecated as a consequence of `PSKKeyManager` being deprecated. See corresponding docs for further information. Returns:PSKKeyManager Pre-Shared Key (PSK) key manager or `null` for none. Annotations @SuppressWarnings:deprecation

getSessionContext	back to summary
pack-priv AbstractSessionContext getSessionContext() Returns the appropriate session context.

getSNIMatchers	back to summary
pack-priv Collection<SNIMatcher> getSNIMatchers()

getUseCipherSuitesOrder	back to summary
pack-priv boolean getUseCipherSuitesOrder()

getUseClientMode	back to summary
pack-priv boolean getUseClientMode() Returns the value indicating if the parameters configured to work in client mode.

getUseSni	back to summary
pack-priv boolean getUseSni() Returns whether connections using this SSL connection should use the TLS extension Server Name Indication (SNI).

getWantClientAuth	back to summary
pack-priv boolean getWantClientAuth() Returns the value indicating if the peer with this parameters tuned to request client authentication

getX509KeyManager	back to summary
pack-priv X509KeyManager getX509KeyManager() Returns:X509KeyManager X.509 key manager or `null` for none.

getX509TrustManager	back to summary
pack-priv X509TrustManager getX509TrustManager() Returns:X509TrustManager X.509 trust manager or `null` for none.

isCTVerificationEnabled	back to summary
pack-priv boolean isCTVerificationEnabled(String hostname) Check if SCT verification is enforced for a given hostname.

isSniEnabledByDefault	back to summary
private boolean isSniEnabledByDefault() Returns whether Server Name Indication (SNI) is enabled by default for sockets. For more information on SNI, see RFC 6066 section 3.

setAlgorithmConstraints	back to summary
pack-priv void setAlgorithmConstraints(AlgorithmConstraints algorithmConstraints)

setApplicationProtocols

back to summary

pack-priv void setApplicationProtocols(String[] protocols)

Sets the list of ALPN protocols.

Parameters

protocols:String[]: the list of ALPN protocols

setApplicationProtocolSelector	back to summary
pack-priv void setApplicationProtocolSelector(ApplicationProtocolSelectorAdapter applicationProtocolSelector) Used for server-mode only. Sets or clears the application-provided ALPN protocol selector. If set, will override the protocol list provided by `setApplicationProtocols(String[])`.

setCTVerificationEnabled	back to summary
pack-priv void setCTVerificationEnabled(boolean enabled) For testing only.

setEnabledCipherSuites	back to summary
pack-priv void setEnabledCipherSuites(String[] cipherSuites) Sets the enabled cipher suites after filtering through OpenSSL.

setEnabledProtocols back to summary

pack-priv void setEnabledProtocols(String[] protocols)

Sets the list of available protocols for use in SSL connection.

Exceptions

IllegalArgumentException:: if protocols == null

setEnableSessionCreation	back to summary
pack-priv void setEnableSessionCreation(boolean flag) Allows/disallows the peer holding this parameters to create new SSL session

setEndpointIdentificationAlgorithm	back to summary
pack-priv void setEndpointIdentificationAlgorithm(String endpointIdentificationAlgorithm)

setNeedClientAuth	back to summary
pack-priv void setNeedClientAuth(boolean need) Tunes the peer holding this parameters to require client authentication

setOCSPResponse	back to summary
pack-priv void setOCSPResponse(byte[] response) For testing only.

setSCTExtension	back to summary
pack-priv void setSCTExtension(byte[] extension) For testing only.

setSNIMatchers	back to summary
pack-priv void setSNIMatchers(Collection<SNIMatcher> sniMatchers)

setUseCipherSuitesOrder	back to summary
pack-priv void setUseCipherSuitesOrder(boolean useCipherSuitesOrder)

setUseClientMode

back to summary

pack-priv void setUseClientMode(boolean mode)

Tunes the peer holding this parameters to work in client mode.

Parameters

mode:boolean: if the peer is configured to work in client mode

setUseSessionTickets	back to summary
pack-priv void setUseSessionTickets(boolean useSessionTickets)

setUseSni	back to summary
pack-priv void setUseSni(boolean flag) Whether connections using this SSL connection should use the TLS extension Server Name Indication (SNI).

setWantClientAuth	back to summary
pack-priv void setWantClientAuth(boolean want) Tunes the peer holding this parameters to request client authentication

org.conscrypt back to summary

pack-priv Interface SSLParametersImpl.AliasChooser

Known Direct Implementers: org.conscrypt.ConscryptEngine, org.conscrypt.ConscryptEngineSocket, org.conscrypt.ConscryptFileDescriptorSocket

For abstracting the X509KeyManager calls between X509KeyManager#chooseClientAlias(String[], java.security.Principal[], java.net.Socket) and X509ExtendedKeyManager#chooseEngineClientAlias(String[], java.security.Principal[], javax.net.ssl.SSLEngine)

Method Summary

Modifier and Type	Method and Description
public String	chooseClientAlias(X509KeyManager keyManager, X500Principal[] issuers, String[] keyTypes)
public String	chooseServerAlias(X509KeyManager keyManager, String keyType)

Method Detail

chooseClientAlias	back to summary
public String chooseClientAlias(X509KeyManager keyManager, X500Principal[] issuers, String[] keyTypes)

chooseServerAlias	back to summary
public String chooseServerAlias(X509KeyManager keyManager, String keyType)

org.conscrypt back to summary

pack-priv Interface SSLParametersImpl.PSKCallbacks

Known Direct Implementers

org.conscrypt.ConscryptEngine, org.conscrypt.ConscryptFileDescriptorSocket

Annotations

@SuppressWarnings:deprecation

For abstracting the PSKKeyManager calls between those taking an SSLSocket and those taking an SSLEngine.

Method Summary

Modifier and Type	Method and Description
public String	chooseClientPSKIdentity(PSKKeyManager keyManager, String identityHint) Deprecated as a consequence of `PSKKeyManager` being deprecated.
public String	chooseServerPSKIdentityHint(PSKKeyManager keyManager) Deprecated as a consequence of `PSKKeyManager` being deprecated.
public SecretKey	getPSKKey(PSKKeyManager keyManager, String identityHint, String identity) Deprecated as a consequence of `PSKKeyManager` being deprecated.

Method Detail

chooseClientPSKIdentity	back to summary
public String chooseClientPSKIdentity(PSKKeyManager keyManager, String identityHint) Deprecated as a consequence of `PSKKeyManager` being deprecated. See corresponding docs for further information.

chooseServerPSKIdentityHint	back to summary
public String chooseServerPSKIdentityHint(PSKKeyManager keyManager) Deprecated as a consequence of `PSKKeyManager` being deprecated. See corresponding docs for further information.

getPSKKey	back to summary
public SecretKey getPSKKey(PSKKeyManager keyManager, String identityHint, String identity) Deprecated as a consequence of `PSKKeyManager` being deprecated. See corresponding docs for further information.

pack-priv final Class SSLParametersImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface SSLParametersImpl.AliasChooser

Method Summary

Method Detail

pack-priv Interface SSLParametersImpl.PSKCallbacks

Method Summary

Method Detail