Class CertUserDBAuthentication
java.lang.Object
com.netscape.cmscore.authentication.CertUserDBAuthentication
- All Implemented Interfaces:
AuthManager
Certificate server agent authentication.
Maps a SSL client authenticate certificate to a user (agent) entry in the
internal database.
- Version:
- $Revision$, $Date$
- Author:
- lhsiao, cfu
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static org.slf4j.Logger
protected static String[]
protected String[]
static final String
static final String
static final String
static final String
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 -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(IAuthCredentials authCred) authenticates user(agent) by certificateString[]
get the list of configuration parameter names required by this authentication manager.gets the configuretion substore used by this authentication managerGets the plugin name of authentication manager.getName()
Gets the name of this authentication manager.String[]
get the list of authentication credential attribute names required by this authentication manager.void
init
(String name, String implName, AuthManagerConfig config) initializes the CertUserDBAuthentication auth managervoid
setAuthenticationConfig
(AuthenticationConfig authenticationConfig) void
shutdown()
prepare this authentication manager for shutdown.
-
Field Details
-
logger
public static org.slf4j.Logger logger -
TOKEN_USERDN
- See Also:
-
TOKEN_USER_DN
- See Also:
-
TOKEN_USERID
- See Also:
-
TOKEN_UID
- See Also:
-
CRED_CERT
- See Also:
-
mRequiredCreds
-
mConfigParams
-
-
Constructor Details
-
CertUserDBAuthentication
public CertUserDBAuthentication()
-
-
Method Details
-
getAuthenticationConfig
-
setAuthenticationConfig
-
init
initializes the CertUserDBAuthentication auth managercalled by AuthSubsystem init() method, when initializing all available authentication managers.
- Specified by:
init
in interfaceAuthManager
- Parameters:
implName
- - The authentication subsystem that hosts this auth managerconfig
- - The configuration store used by the authentication subsystemname
- The name of this authentication manager instance.- Throws:
EBaseException
- If an initialization error occurred.
-
getName
Gets the name of this authentication manager.- Specified by:
getName
in interfaceAuthManager
- Returns:
- the name of this authentication manager.
-
getImplName
Gets the plugin name of authentication manager.- Specified by:
getImplName
in interfaceAuthManager
- Returns:
- the name of the authentication manager plugin.
-
authenticate
public IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException authenticates user(agent) by certificatecalled by other subsystems or their servlets to authenticate users (agents)
- Specified by:
authenticate
in interfaceAuthManager
- Parameters:
authCred
- - authentication credential that contains an usrgrp.Certificates of the user (agent)- Returns:
- the authentication token that contains the following
- Throws:
com.netscape.certsrv.base.EAuthsException
- any authentication failure or insufficient credentialsEMissingCredential
- If a required credential for this authentication manager is missing.EInvalidCredentials
- If credentials cannot be authenticated.EBaseException
- If an internal error occurred.- See Also:
-
getRequiredCreds
get the list of authentication credential attribute names required by this authentication manager. Generally used by the servlets that handle agent operations to authenticate its users. It calls this method to know which are the required credentials from the user (e.g. Javascript form data)- Specified by:
getRequiredCreds
in interfaceAuthManager
- Returns:
- attribute names in Vector
-
getConfigParams
get the list of configuration parameter names required by this authentication manager. Generally used by the Certificate Server Console to display the table for configuration purposes. CertUserDBAuthentication is currently not exposed in this case, so this method is not to be used.- Specified by:
getConfigParams
in interfaceAuthManager
- Returns:
- configuration parameter names in Hashtable of Vectors where each hashtable entry's key is the substore name, value is a Vector of parameter names. If no substore, the parameter name is the Hashtable key itself, with value same as key.
-
shutdown
public void shutdown()prepare this authentication manager for shutdown.- Specified by:
shutdown
in interfaceAuthManager
-
getConfigStore
gets the configuretion substore used by this authentication manager- Specified by:
getConfigStore
in interfaceAuthManager
- Returns:
- configuration store
-