javax.net.ssl.X509TrustManager Maven / Gradle / Ivy

This work corresponds to the API signatures of CDC Security (Java Secure Socket Extension - JSSE) Optional Package interfaces and modules. */ /* * @(#)X509TrustManager.java 1.8 05/03/12 */ /* * NOTE: * Because of various external restrictions (i.e. US export * regulations, etc.), the actual source code can not be provided * at this time. This file represents the skeleton of the source * file, so that javadocs of the API can be created. */ package javax.net.ssl; import java.security.cert.*; /** * 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. * * @since 1.4 * @version 1.10 */ public interface X509TrustManager extends TrustManager { /** * 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. * * @param chain the peer certificate chain * @param authType the authentication type based on the client certificate * @throws 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 * @throws CertificateException if the certificate chain is not trusted * by this TrustManager. */ public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException; /** * 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. * * @param chain the peer certificate chain * @param authType the key exchange algorithm used * @throws 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 * @throws CertificateException if the certificate chain is not trusted * by this TrustManager. */ public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException; /** * Return an array of certificate authority certificates * which are trusted for authenticating peers. * * @return a non-null (possibly empty) array of acceptable * CA issuer certificates. */ public X509Certificate[] getAcceptedIssuers(); }