Class SSLClientCertAuthentication
- java.lang.Object
-
- com.netscape.cmscore.authentication.SSLClientCertAuthentication
-
- All Implemented Interfaces:
AuthManager
public class SSLClientCertAuthentication extends java.lang.Object implements AuthManager
SSL client based authentication.- Version:
- $Revision$, $Date$
- Author:
- chrisho
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CRED_CERT
static java.lang.String
ISSUERDN
static org.slf4j.Logger
logger
protected static java.lang.String[]
mConfigParams
protected static java.lang.String[]
mRequiredCreds
static java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.netscape.certsrv.authentication.IAuthToken
authenticate(com.netscape.certsrv.authentication.IAuthCredentials authCred)
Authenticate the given credentials.AuthenticationConfig
getAuthenticationConfig()
java.lang.String[]
getConfigParams()
Returns a list of configuration parameter names.AuthManagerConfig
getConfigStore()
Gets the configuration substore used by this authentication managerjava.lang.String
getImplName()
gets the plugin name of this authentication manager.java.lang.String
getName()
gets the name of this authentication manager instancejava.lang.String[]
getRequiredCreds()
Returns array of required credentials for this authentication manager.void
init(java.lang.String name, java.lang.String implName, AuthManagerConfig config)
Initialize this authentication manager.void
setAuthenticationConfig(AuthenticationConfig authenticationConfig)
void
shutdown()
prepare this authentication manager for shutdown.
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
CRED_CERT
public static final java.lang.String CRED_CERT
- See Also:
- Constant Field Values
-
SERIALNUMBER
public static final java.lang.String SERIALNUMBER
- See Also:
- Constant Field Values
-
ISSUERDN
public static final java.lang.String ISSUERDN
- See Also:
- Constant Field Values
-
mRequiredCreds
protected static java.lang.String[] mRequiredCreds
-
mConfigParams
protected static java.lang.String[] mConfigParams
-
-
Method Detail
-
getAuthenticationConfig
public AuthenticationConfig getAuthenticationConfig()
-
setAuthenticationConfig
public void setAuthenticationConfig(AuthenticationConfig authenticationConfig)
-
init
public void init(java.lang.String name, java.lang.String implName, AuthManagerConfig config) throws EBaseException
Description copied from interface:AuthManager
Initialize this authentication manager.- Specified by:
init
in interfaceAuthManager
- 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 com.netscape.certsrv.authentication.IAuthToken authenticate(com.netscape.certsrv.authentication.IAuthCredentials authCred) throws com.netscape.certsrv.authentication.EMissingCredential, com.netscape.certsrv.authentication.EInvalidCredentials, EBaseException
Description copied from interface:AuthManager
Authenticate the given credentials.- Specified by:
authenticate
in interfaceAuthManager
- Parameters:
authCred
- The authentication credentials- Returns:
- authentication token
- Throws:
com.netscape.certsrv.authentication.EMissingCredential
- If a required credential for this authentication manager is missing.com.netscape.certsrv.authentication.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 interfaceAuthManager
-
getConfigParams
public java.lang.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 interfaceAuthManager
- Returns:
- String array of configuration parameter names.
-
getRequiredCreds
public java.lang.String[] getRequiredCreds()
Returns array of required credentials for this authentication manager.- Specified by:
getRequiredCreds
in interfaceAuthManager
- Returns:
- Array of required credentials.
-
getConfigStore
public AuthManagerConfig getConfigStore()
Gets the configuration substore used by this authentication manager- Specified by:
getConfigStore
in interfaceAuthManager
- Returns:
- configuration store
-
getName
public java.lang.String getName()
gets the name of this authentication manager instance- Specified by:
getName
in interfaceAuthManager
- Returns:
- the name of this authentication manager.
-
getImplName
public java.lang.String getImplName()
gets the plugin name of this authentication manager.- Specified by:
getImplName
in interfaceAuthManager
- Returns:
- the name of the authentication manager plugin.
-
-