Class SSLClientCertAuthentication

java.lang.Object

com.netscape.cmscore.authentication.SSLClientCertAuthentication

All Implemented Interfaces:

AuthManager

public class SSLClientCertAuthentication
extends Object
implements AuthManager

SSL client based authentication.

Version:

$Revision$, $Date$

Author:

chrisho

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRED_CERT
static final String	ISSUERDN
static org.slf4j.Logger	logger
protected static String[]	mConfigParams
protected static String[]	mRequiredCreds
static final String	SERIALNUMBER

Fields inherited from interface org.dogtagpki.server.authentication.AuthManager

CRED_CERT_SERIAL_TO_REVOKE, CRED_CMC_SELF_SIGNED, CRED_CMC_SIGNING_CERT, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT

Constructor Summary

Constructors

Constructor	Description
SSLClientCertAuthentication()	Default constructor, initialization must follow.

Method Summary

Modifier and Type	Method	Description
IAuthToken	authenticate(IAuthCredentials authCred)	Authenticate the given credentials.
AuthenticationConfig	getAuthenticationConfig()
String[]	getConfigParams()	Returns a list of configuration parameter names.
AuthManagerConfig	getConfigStore()	Gets the configuration substore used by this authentication manager
String	getImplName()	gets the plugin name of this authentication manager.
String	getName()	gets the name of this authentication manager instance
String[]	getRequiredCreds()	Returns array of required credentials for this authentication manager.
void	init(String name, String implName, AuthManagerConfig config)	Initialize this authentication manager.
void	setAuthenticationConfig(AuthenticationConfig authenticationConfig)
void	shutdown()	prepare this authentication manager for shutdown.

Methods inherited from class java.lang.Object

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

Field Details

logger

public static org.slf4j.Logger logger

CRED_CERT

public static final String CRED_CERT

See Also:

• Constant Field Values

SERIALNUMBER

public static final String SERIALNUMBER

See Also:

• Constant Field Values

ISSUERDN

public static final String ISSUERDN

See Also:

• Constant Field Values

mRequiredCreds

protected static String[] mRequiredCreds

mConfigParams

protected static String[] mConfigParams

Constructor Details

SSLClientCertAuthentication

public SSLClientCertAuthentication()

Default constructor, initialization must follow.

Method Details

getAuthenticationConfig

public AuthenticationConfig getAuthenticationConfig()

setAuthenticationConfig

public void setAuthenticationConfig(AuthenticationConfig authenticationConfig)

init

public void init(String name,
 String implName,
 AuthManagerConfig config)
          throws EBaseException

Description copied from interface: AuthManager

Initialize this authentication manager.

Specified by:

init in interface AuthManager

Parameters:

name - The name of this authentication manager instance.

implName - The name of the authentication manager plugin.

config - The configuration store for this authentication manager.

Throws:

EBaseException - If an initialization error occurred.

authenticate

public IAuthToken authenticate(IAuthCredentials authCred)
                        throws EMissingCredential,
EInvalidCredentials,
EBaseException

Description copied from interface: AuthManager

Authenticate the given credentials.

Specified by:

authenticate in interface AuthManager

Parameters:

authCred - The authentication credentials

Returns:

authentication token

Throws:

EMissingCredential - If a required credential for this authentication manager is missing.

EInvalidCredentials - If credentials cannot be authenticated.

EBaseException - If an internal error occurred.

shutdown

public void shutdown()

prepare this authentication manager for shutdown.

Specified by:

shutdown in interface AuthManager

getConfigParams

public String[] getConfigParams()

Returns a list of configuration parameter names. The list is passed to the configuration console so instances of this implementation can be configured through the console.

Specified by:

getConfigParams in interface AuthManager

Returns:

String array of configuration parameter names.

getRequiredCreds

public String[] getRequiredCreds()

Returns array of required credentials for this authentication manager.

Specified by:

getRequiredCreds in interface AuthManager

Returns:

Array of required credentials.

getConfigStore

public AuthManagerConfig getConfigStore()

Gets the configuration substore used by this authentication manager

Specified by:

getConfigStore in interface AuthManager

Returns:

configuration store

getName

public String getName()

gets the name of this authentication manager instance

Specified by:

getName in interface AuthManager

Returns:

the name of this authentication manager.

getImplName

public String getImplName()

gets the plugin name of this authentication manager.

Specified by:

getImplName in interface AuthManager

Returns:

the name of the authentication manager plugin.