com.entrust.toolkit.x509.directory

Class LDAPSTrustManager

java.lang.Object

com.entrust.toolkit.x509.directory.LDAPSTrustManager

All Implemented Interfaces:

javax.net.ssl.TrustManager, javax.net.ssl.X509TrustManager

public class LDAPSTrustManager
extends java.lang.Object
implements javax.net.ssl.X509TrustManager

The LDAPSTrustManager class implements the javax.net.ssl.X509TrustManager interface.

The javax.net.ssl.X509TrustManager interface is used to initialize an SSLContext object to support X.509 authentication to remote socket peers through JSSE.

This class is used for TrustManagement for LDAP connections over SSL. For example, when the SSL Server's chain of certificates is presented to the client, the following steps will be used to determine whether the server should be trusted:

1. The certificates that were specified as trusted certificates when this trust manager was instantiated will be compared to the certificates which are presented by the server. If the end-entity certificate in the chain presented by the server matches one of the trusted certificates, then it will be considered a trusted server.
2. If none of the certificates contained in this TrustManager match the end-entity certificate presented by the server, then a full chain validation will be performed using the CertVerifier object. If a chain of trust can be established, then the server will be trusted. If no chain of trust can be established, the authentication will fail.

This class uses the toolkit's CertVerifier to validate certificates.

For more information, see the SUN Microsystems API user's guide for the Java Secure Socket Extension (JSSE) version 1.0.2

Since:

7.2 Patch

See Also:

EntrustSSLSocketFactory, SSLContext

Constructor Summary

Constructors

Constructor and Description
LDAPSTrustManager() Creates an anonymous LDAPSTrustManager instance.
LDAPSTrustManager(KeyAndCertContainer keyAndCertContainer) Creates a LDAPSTrustManager instance that uses an Entrust key/certificate container's certificate validation mechanism for trust decisions.
LDAPSTrustManager(java.security.cert.X509Certificate[] trustedRoots) Creates an instance of the LDAPSTrustManager class.

Method Summary

Modifier and Type	Method and Description
void	checkClientTrusted(java.security.cert.X509Certificate[] chain, java.lang.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.
void	checkServerTrusted(java.security.cert.X509Certificate[] chain, java.lang.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.
java.security.cert.X509Certificate[]	getAcceptedIssuers() Retrieves the trusted certificates.
void	setAnonymousSSL(boolean anon) If this setting is enabled, server authentication will not be checked.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPSTrustManager

public LDAPSTrustManager()

Creates an anonymous LDAPSTrustManager instance.

LDAPSTrustManager

public LDAPSTrustManager(KeyAndCertContainer keyAndCertContainer)
                  throws UserNotLoggedInException,
                         UserFatalException,
                         CertificationRootException,
                         java.security.cert.CertificateException

Creates a LDAPSTrustManager instance that uses an Entrust key/certificate container's certificate validation mechanism for trust decisions.

Parameters:

keyAndCertContainer - an Entrust key/certificate container

Throws:

UserNotLoggedInException - if the Entrust key/certificate container represents a user that is not logged in

UserFatalException

java.security.cert.CertificateException

CertificationRootException

java.lang.IllegalArgumentException - if the key/certificate container is not provided (null) or does not contain a certificate validation mechanism

Since:

7.2 Patch

LDAPSTrustManager

public LDAPSTrustManager(java.security.cert.X509Certificate[] trustedRoots)

Creates an instance of the LDAPSTrustManager class.

Parameters:

trustedRoots - the trusted certificates

Throws:

CertificationRootException

java.security.cert.CertificateException

Method Detail

getAcceptedIssuers

public java.security.cert.X509Certificate[] getAcceptedIssuers()

Retrieves the trusted certificates.

Specified by:

getAcceptedIssuers in interface javax.net.ssl.X509TrustManager

Returns:

The trusted certificates.

checkClientTrusted

public void checkClientTrusted(java.security.cert.X509Certificate[] chain,
                               java.lang.String authType)
                        throws java.security.cert.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 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.

Specified by:

checkClientTrusted in interface javax.net.ssl.X509TrustManager

Parameters:

chain - - the peer certificate chain

authType - - the authentication type based on the client certificate

Throws:

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.

Since:

JDK 1.4

See Also:

X509TrustManager.checkClientTrusted(X509Certificate[], String)

checkServerTrusted

public void checkServerTrusted(java.security.cert.X509Certificate[] chain,
                               java.lang.String authType)
                        throws java.security.cert.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.

Specified by:

checkServerTrusted in interface javax.net.ssl.X509TrustManager

Parameters:

chain - - the peer certificate chain

authType - - the key exchange algorithm used

Throws:

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.

Since:

JDK 1.4

See Also:

X509TrustManager.checkServerTrusted(X509Certificate[], String)

setAnonymousSSL

public void setAnonymousSSL(boolean anon)

If this setting is enabled, server authentication will not be checked.

Parameters:

anon - A value of true indicates that server authentication will not be checked. A value of false indicates that server authentication will proceed. The default setting is false.