Class CertUserDBAuthentication
- java.lang.Object
-
- com.netscape.cmscore.authentication.CertUserDBAuthentication
-
- All Implemented Interfaces:
AuthManager
public class CertUserDBAuthentication extends java.lang.Object implements 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
Fields Modifier and Type Field Description static java.lang.String
CRED_CERT
static org.slf4j.Logger
logger
protected static java.lang.String[]
mConfigParams
protected java.lang.String[]
mRequiredCreds
static java.lang.String
TOKEN_UID
static java.lang.String
TOKEN_USER_DN
static java.lang.String
TOKEN_USERDN
static java.lang.String
TOKEN_USERID
-
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 CertUserDBAuthentication()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IAuthToken
authenticate(IAuthCredentials authCred)
authenticates user(agent) by certificateAuthenticationConfig
getAuthenticationConfig()
java.lang.String[]
getConfigParams()
get the list of configuration parameter names required by this authentication manager.AuthManagerConfig
getConfigStore()
gets the configuretion substore used by this authentication managerjava.lang.String
getImplName()
Gets the plugin name of authentication manager.java.lang.String
getName()
Gets the name of this authentication manager.java.lang.String[]
getRequiredCreds()
get the list of authentication credential attribute names required by this authentication manager.void
init(java.lang.String name, java.lang.String implName, AuthManagerConfig config)
initializes the CertUserDBAuthentication auth managervoid
setAuthenticationConfig(AuthenticationConfig authenticationConfig)
void
shutdown()
prepare this authentication manager for shutdown.
-
-
-
Field Detail
-
logger
public static org.slf4j.Logger logger
-
TOKEN_USERDN
public static final java.lang.String TOKEN_USERDN
- See Also:
- Constant Field Values
-
TOKEN_USER_DN
public static final java.lang.String TOKEN_USER_DN
- See Also:
- Constant Field Values
-
TOKEN_USERID
public static final java.lang.String TOKEN_USERID
- See Also:
- Constant Field Values
-
TOKEN_UID
public static final java.lang.String TOKEN_UID
- See Also:
- Constant Field Values
-
CRED_CERT
public static final java.lang.String CRED_CERT
- See Also:
- Constant Field Values
-
mRequiredCreds
protected 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
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
public java.lang.String getName()
Gets the name of this authentication manager.- Specified by:
getName
in interfaceAuthManager
- Returns:
- the name of this authentication manager.
-
getImplName
public java.lang.String 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:
AuthToken
,Certificates
-
getRequiredCreds
public java.lang.String[] 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
public java.lang.String[] 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
public AuthManagerConfig getConfigStore()
gets the configuretion substore used by this authentication manager- Specified by:
getConfigStore
in interfaceAuthManager
- Returns:
- configuration store
-
-