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.StringCRED_CERTstatic java.lang.StringISSUERDNstatic org.slf4j.Loggerloggerprotected static java.lang.String[]mConfigParamsprotected static java.lang.String[]mRequiredCredsstatic java.lang.StringSERIALNUMBER-
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 IAuthTokenauthenticate(IAuthCredentials authCred)Authenticate the given credentials.AuthenticationConfiggetAuthenticationConfig()java.lang.String[]getConfigParams()Returns a list of configuration parameter names.AuthManagerConfiggetConfigStore()Gets the configuration substore used by this authentication managerjava.lang.StringgetImplName()gets the plugin name of this authentication manager.java.lang.StringgetName()gets the name of this authentication manager instancejava.lang.String[]getRequiredCreds()Returns array of required credentials for this authentication manager.voidinit(java.lang.String name, java.lang.String implName, AuthManagerConfig config)Initialize this authentication manager.voidsetAuthenticationConfig(AuthenticationConfig authenticationConfig)voidshutdown()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 EBaseExceptionDescription copied from interface:AuthManagerInitialize this authentication manager.- Specified by:
initin 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 IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException
Description copied from interface:AuthManagerAuthenticate the given credentials.- Specified by:
authenticatein interfaceAuthManager- 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:
shutdownin 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:
getConfigParamsin 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:
getRequiredCredsin interfaceAuthManager- Returns:
- Array of required credentials.
-
getConfigStore
public AuthManagerConfig getConfigStore()
Gets the configuration substore used by this authentication manager- Specified by:
getConfigStorein interfaceAuthManager- Returns:
- configuration store
-
getName
public java.lang.String getName()
gets the name of this authentication manager instance- Specified by:
getNamein interfaceAuthManager- Returns:
- the name of this authentication manager.
-
getImplName
public java.lang.String getImplName()
gets the plugin name of this authentication manager.- Specified by:
getImplNamein interfaceAuthManager- Returns:
- the name of the authentication manager plugin.
-
-