com.sssw.jbroker.api.security
Interface CertificateManager

All Superinterfaces:

Object

public interface CertificateManager

extends Object

The interface used to set the various data that is needed by SSL to operate.

The CertificateManager object is obtained from the ORB using the resolve_initial_references on the ORB object.

        CertificateManager certMgr = (CertificateManager) 
            ORB.resolve_initial_references("CertificateManager");
 

Since:

jBroker 3.0

Method Summary

void	addCACertificate(byte[] derCert) Adds a DER-encoded trusted CA certificate.
void	addClientCertificateEventHandler(CertificateEventHandler handler) Add handler for client Certificate events.
void	addServerCertificateEventHandler(CertificateEventHandler handler) Add handler for server Certificate events.
void	clientAuthRequired(boolean car) sets whether client authentication is required
void	enableSSLv2(boolean v2) sets whether to support SSL version 2
void	enableSSLv3(boolean v2) sets whether to support SSL version 3
void	enableTLS(boolean tls) sets whether to support TLS (SSL v 3.1)
boolean	isClientAuthRequired() queries whether client authentication is required
boolean	isSSLv2Enabled() queries whether SSL version 2 is enabled
boolean	isSSLv3Enabled() queries whether SSL version 2 is enabled
boolean	isTLSEnabled() queries whether TLS is enabled or not
void	setCertificateChain(byte[][] derCertChain, byte[] privateKeyBER) Add a certificate chain and private key.
void	setCertificateChain(byte[][] derCertChain, byte[] privateKey, String passPhrase) Add a certificate chain and private key.
void	setCipherSuites(CipherSuite[] cipherSuites) Sets the default CipherSuite list to use for SSL connections

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Method Detail

clientAuthRequired

public void clientAuthRequired(boolean car)

sets whether client authentication is required

Since:

jBroker ORB 4.1

isClientAuthRequired

public boolean isClientAuthRequired()

queries whether client authentication is required

Since:

jBroker ORB 4.1

enableTLS

public void enableTLS(boolean tls)

sets whether to support TLS (SSL v 3.1)

isTLSEnabled

public boolean isTLSEnabled()

queries whether TLS is enabled or not

enableSSLv2

public void enableSSLv2(boolean v2)

sets whether to support SSL version 2

isSSLv2Enabled

public boolean isSSLv2Enabled()

queries whether SSL version 2 is enabled

enableSSLv3

public void enableSSLv3(boolean v2)

sets whether to support SSL version 3

Since:

MP 5.1

isSSLv3Enabled

public boolean isSSLv3Enabled()

queries whether SSL version 2 is enabled

Since:

MP 5.1

addClientCertificateEventHandler

public void addClientCertificateEventHandler(CertificateEventHandler handler)

Add handler for client Certificate events. Multiple handlers can be registered, each is checked in turn until a false return is received. If no event handler returns false, the certificate is considered good.

addServerCertificateEventHandler

public void addServerCertificateEventHandler(CertificateEventHandler handler)

Add handler for server Certificate events. Multiple handlers can be registered, each is checked in turn until a false return is received. If no event handler returns false, the certificate is considered good.

setCertificateChain

public void setCertificateChain(byte[][] derCertChain,
                                byte[] privateKeyBER)
                         throws SecurityException

Add a certificate chain and private key. The privateKey must be in the format defined by PKCS #1 (PrivateKeyBER).

Parameters:

derCertChain - DER encoded certificate chain

privateKeyBER - private key in plaintext

Throws:

SecurityException

setCertificateChain

public void setCertificateChain(byte[][] derCertChain,
                                byte[] privateKey,
                                String passPhrase)
                         throws SecurityException

Add a certificate chain and private key. The privateKey must be in the format defined by PKCS #8.

Parameters:

derCertChain - DER encoded certificate chain

privateKey - private key bytes

passPhrase - the passphrase with which to decrypt the key

Throws:

SecurityException

addCACertificate

public void addCACertificate(byte[] derCert)
                      throws SecurityException

Adds a DER-encoded trusted CA certificate.

Throws:

SecurityException

setCipherSuites

public void setCipherSuites(CipherSuite[] cipherSuites)

Sets the default CipherSuite list to use for SSL connections

Parameters:

cipherSuites - the cipher suites to use for communication. The default value is CipherSuite.CIPHER_SUITES_CONFIDENTIALITY.

See Also:

CipherSuite.CIPHER_SUITES_CONFIDENTIALITY