Added in API level 24

Summary: Ctors | Methods | Inherited Methods

X509ExtendedTrustManager

public abstract class X509ExtendedTrustManager
extends Object implements X509TrustManager

java.lang.Object
↳	javax.net.ssl.X509ExtendedTrustManager

---

Extensions to the X509TrustManager interface to support SSL/TLS connection sensitive trust management.

To prevent man-in-the-middle attacks, hostname checks can be done to verify that the hostname in an end-entity certificate matches the targeted hostname. TLS does not require such checks, but some protocols over TLS (such as HTTPS) do. In earlier versions of the JDK, the certificate chain checks were done at the SSL/TLS layer, and the hostname verification checks were done at the layer over TLS. This class allows for the checking to be done during a single call to this class.

RFC 2830 defines the server identification specification for the "LDAPS" algorithm. RFC 2818 defines both the server identification and the client identification specification for the "HTTPS" algorithm.

See also:

• X509TrustManager
• HostnameVerifier

Summary

Public constructors
X509ExtendedTrustManager()

Public methods
abstract void	checkClientTrusted(X509Certificate[] chain, String authType, Socket socket) Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.
abstract void	checkClientTrusted(X509Certificate[] chain, String authType, SSLEngine engine) Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.
abstract void	checkServerTrusted(X509Certificate[] chain, String authType, SSLEngine engine) Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.
abstract void	checkServerTrusted(X509Certificate[] chain, String authType, Socket socket) Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface javax.net.ssl.X509TrustManager abstract void checkClientTrusted(X509Certificate[] chain, String authType) Given the partial or complete certificate chain provided by the peer, build a certificate path to a trusted root and return if it can be validated and is trusted for client SSL authentication based on the authentication type. abstract void checkServerTrusted(X509Certificate[] chain, String authType) Given the partial or complete certificate chain provided by the peer, build a certificate path to a trusted root and return if it can be validated and is trusted for server SSL authentication based on the authentication type. abstract X509Certificate[] getAcceptedIssuers() Return an array of certificate authority certificates which are trusted for authenticating peers.

Public constructors

X509ExtendedTrustManager

Added in API level 24

public X509ExtendedTrustManager ()

Public methods

checkClientTrusted

Added in API level 24

public abstract void checkClientTrusted (X509Certificate[] chain, 
                String authType, 
                Socket socket)

Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.

The authentication type is determined by the actual certificate used. For instance, if RSAPublicKey is used, the authType should be "RSA". Checking is case-sensitive.

If the socket parameter is an instance of SSLSocket, and the endpoint identification algorithm of the SSLParameters is non-empty, to prevent man-in-the-middle attacks, the address that the socket connected to should be checked against the peer's identity presented in the end-entity X509 certificate, as specified in the endpoint identification algorithm.

If the socket parameter is an instance of SSLSocket, and the algorithm constraints of the SSLParameters is non-null, for every certificate in the certification path, fields such as subject public key, the signature algorithm, key usage, extended key usage, etc. need to conform to the algorithm constraints in place on this socket.

Parameters
chain	X509Certificate: the peer certificate chain
authType	String: the key exchange algorithm used
socket	Socket: the socket used for this connection. This parameter can be null, which indicates that implementations need not check the ssl parameters

Throws
IllegalArgumentException	if null or zero-length array is passed in for the chain parameter or if null or zero-length string is passed in for the authType parameter
CertificateException	if the certificate chain is not trusted by this TrustManager

See also:

• SSLParameters.getEndpointIdentificationAlgorithm()
• SSLParameters.setEndpointIdentificationAlgorithm(String)
• SSLParameters.getAlgorithmConstraints()
• SSLParameters.setAlgorithmConstraints(AlgorithmConstraints)

checkClientTrusted

Added in API level 24

public abstract void checkClientTrusted (X509Certificate[] chain, 
                String authType, 
                SSLEngine engine)

Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.

The authentication type is determined by the actual certificate used. For instance, if RSAPublicKey is used, the authType should be "RSA". Checking is case-sensitive.

If the engine parameter is available, and the endpoint identification algorithm of the SSLParameters is non-empty, to prevent man-in-the-middle attacks, the address that the engine connected to should be checked against the peer's identity presented in the end-entity X509 certificate, as specified in the endpoint identification algorithm.

If the engine parameter is available, and the algorithm constraints of the SSLParameters is non-null, for every certificate in the certification path, fields such as subject public key, the signature algorithm, key usage, extended key usage, etc. need to conform to the algorithm constraints in place on this engine.

Parameters
chain	X509Certificate: the peer certificate chain
authType	String: the key exchange algorithm used
engine	SSLEngine: the engine used for this connection. This parameter can be null, which indicates that implementations need not check the ssl parameters

Throws
IllegalArgumentException	if null or zero-length array is passed in for the chain parameter or if null or zero-length string is passed in for the authType parameter
CertificateException	if the certificate chain is not trusted by this TrustManager

See also:

• SSLParameters.getEndpointIdentificationAlgorithm()
• SSLParameters.setEndpointIdentificationAlgorithm(String)
• SSLParameters.getAlgorithmConstraints()
• SSLParameters.setAlgorithmConstraints(AlgorithmConstraints)

checkServerTrusted

Added in API level 24

public abstract void checkServerTrusted (X509Certificate[] chain, 
                String authType, 
                SSLEngine engine)

Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.

The authentication type is the key exchange algorithm portion of the cipher suites represented as a String, such as "RSA", "DHE_DSS". Note: for some exportable cipher suites, the key exchange algorithm is determined at run time during the handshake. For instance, for TLS_RSA_EXPORT_WITH_RC4_40_MD5, the authType should be RSA_EXPORT when an ephemeral RSA key is used for the key exchange, and RSA when the key from the server certificate is used. Checking is case-sensitive.

If the engine parameter is available, and the endpoint identification algorithm of the SSLParameters is non-empty, to prevent man-in-the-middle attacks, the address that the engine connected to should be checked against the peer's identity presented in the end-entity X509 certificate, as specified in the endpoint identification algorithm.

If the engine parameter is available, and the algorithm constraints of the SSLParameters is non-null, for every certificate in the certification path, fields such as subject public key, the signature algorithm, key usage, extended key usage, etc. need to conform to the algorithm constraints in place on this engine.

Parameters
chain	X509Certificate: the peer certificate chain
authType	String: the key exchange algorithm used
engine	SSLEngine: the engine used for this connection. This parameter can be null, which indicates that implementations need not check the ssl parameters

Throws
IllegalArgumentException	if null or zero-length array is passed in for the chain parameter or if null or zero-length string is passed in for the authType parameter
CertificateException	if the certificate chain is not trusted by this TrustManager

See also:

• SSLParameters.getEndpointIdentificationAlgorithm()
• SSLParameters.setEndpointIdentificationAlgorithm(String)
• SSLParameters.getAlgorithmConstraints()
• SSLParameters.setAlgorithmConstraints(AlgorithmConstraints)

checkServerTrusted

Added in API level 24

public abstract void checkServerTrusted (X509Certificate[] chain, 
                String authType, 
                Socket socket)

Given the partial or complete certificate chain provided by the peer, build and validate the certificate path based on the authentication type and ssl parameters.

The authentication type is the key exchange algorithm portion of the cipher suites represented as a String, such as "RSA", "DHE_DSS". Note: for some exportable cipher suites, the key exchange algorithm is determined at run time during the handshake. For instance, for TLS_RSA_EXPORT_WITH_RC4_40_MD5, the authType should be RSA_EXPORT when an ephemeral RSA key is used for the key exchange, and RSA when the key from the server certificate is used. Checking is case-sensitive.

If the socket parameter is an instance of SSLSocket, and the endpoint identification algorithm of the SSLParameters is non-empty, to prevent man-in-the-middle attacks, the address that the socket connected to should be checked against the peer's identity presented in the end-entity X509 certificate, as specified in the endpoint identification algorithm.

If the socket parameter is an instance of SSLSocket, and the algorithm constraints of the SSLParameters is non-null, for every certificate in the certification path, fields such as subject public key, the signature algorithm, key usage, extended key usage, etc. need to conform to the algorithm constraints in place on this socket.

Parameters
chain	X509Certificate: the peer certificate chain
authType	String: the key exchange algorithm used
socket	Socket: the socket used for this connection. This parameter can be null, which indicates that implementations need not check the ssl parameters

Throws
IllegalArgumentException	if null or zero-length array is passed in for the chain parameter or if null or zero-length string is passed in for the authType parameter
CertificateException	if the certificate chain is not trusted by this TrustManager

See also:

• SSLParameters.getEndpointIdentificationAlgorithm()
• SSLParameters.setEndpointIdentificationAlgorithm(String)
• SSLParameters.getAlgorithmConstraints()
• SSLParameters.setAlgorithmConstraints(AlgorithmConstraints)