com.entrust.toolkit.x509

Interface LdapSSL

public interface LdapSSL

Interface for classes that require access to information stored in an X.509 directory structure using SSL

This interface is meant to be used with LdapDirectory when a class needs to protect access to the directory resource using SSL. This interface provides the ability for the client credentials to be set (for SSL client authentication), and for the setting a source of trusted roots.

Method Summary

Modifier and Type	Method and Description
java.security.cert.X509Certificate[]	getClientCredentials() Returns the client X509Certificate chain set by the object that implements this interface
java.security.cert.X509Certificate[]	getTrustRoots() Returns the roots of trust that were set in this object, or null if no roots of trust were set.
void	setClientCredentials(java.security.cert.X509Certificate[] chain, java.security.PrivateKey signingKey) Set credentials to use if communicating with a directory protocol that requires client authentication.
void	setTrustRoots(java.security.cert.X509Certificate[] roots, ClientSettings cs) Sets the TrustRoot for SSL Authentication.

Method Detail

setClientCredentials

void setClientCredentials(java.security.cert.X509Certificate[] chain,
                          java.security.PrivateKey signingKey)
                   throws CertificationRootException,
                          java.security.cert.CertificateException

Set credentials to use if communicating with a directory protocol that requires client authentication.

Parameters:

chain - the verification certificate chain

signingKey - the private signing key that signs messages verified by chain

Throws:

java.security.cert.CertificateException

CertificationRootException

setTrustRoots

void setTrustRoots(java.security.cert.X509Certificate[] roots,
                   ClientSettings cs)
            throws java.security.cert.CertificateException,
                   CertificationRootException

Sets the TrustRoot for SSL Authentication. The specified Trusted roots will be used to create a CertVerifier for use with the EntrustChainVerifier.

Parameters:

roots - array of X509 certificates

Throws:

java.security.cert.CertificateException

CertificationRootException

getClientCredentials

java.security.cert.X509Certificate[] getClientCredentials()

Returns the client X509Certificate chain set by the object that implements this interface

Returns:

the client X509Certificate chain set by the object that implements this interface

getTrustRoots

java.security.cert.X509Certificate[] getTrustRoots()

Returns the roots of trust that were set in this object, or null if no roots of trust were set.

Returns:

the roots of trust that were set in this object, or null if no roots of trust were set.