X509TrustManager
interface X509TrustManager : TrustManager
| javax.net.ssl.X509TrustManager |
Instance of this interface manage which X509 certificates may be used to authenticate the remote side of a secure socket. Decisions may be based on trusted certificate authorities, certificate revocation lists, online status checking or other means.
Summary
| Public methods | |
|---|---|
| abstract Unit |
checkClientTrusted(chain: Array<X509Certificate!>!, authType: String!)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 Unit |
checkServerTrusted(chain: Array<X509Certificate!>!, authType: String!)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 Array<X509Certificate!>! |
Return an array of certificate authority certificates which are trusted for authenticating peers. |
Public methods
checkClientTrusted
abstract fun checkClientTrusted(
chain: Array<X509Certificate!>!,
authType: String!
): Unit
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.
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.
| Parameters | |
|---|---|
chain |
Array<X509Certificate!>!: the peer certificate chain |
authType |
String!: the authentication type based on the client certificate |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if null or zero-length chain is passed in for the chain parameter or if null or zero-length string is passed in for the authType parameter |
java.security.cert.CertificateException |
if the certificate chain is not trusted by this TrustManager. |
checkServerTrusted
abstract fun checkServerTrusted(
chain: Array<X509Certificate!>!,
authType: String!
): Unit
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.
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.
| Parameters | |
|---|---|
chain |
Array<X509Certificate!>!: the peer certificate chain |
authType |
String!: the key exchange algorithm used |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if null or zero-length chain is passed in for the chain parameter or if null or zero-length string is passed in for the authType parameter |
java.security.cert.CertificateException |
if the certificate chain is not trusted by this TrustManager. |
getAcceptedIssuers
abstract fun getAcceptedIssuers(): Array<X509Certificate!>!
Return an array of certificate authority certificates which are trusted for authenticating peers.
| Return | |
|---|---|
Array<X509Certificate!>! |
a non-null (possibly empty) array of acceptable CA issuer certificates. |