Class PasswdUserDBAuthentication

java.lang.Object

org.dogtagpki.server.authentication.AuthManager

com.netscape.cmscore.authentication.PasswdUserDBAuthentication

public class PasswdUserDBAuthentication
extends AuthManager

Certificate Server admin authentication. Used to authenticate administrators in the Certificate Server Console. Authentications by checking the uid and password against the database.

Author:

lhsiao, cfu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRED_PWD
static final String	CRED_UID
static org.slf4j.Logger	logger
protected static String[]	mRequiredCred
static final String	TOKEN_USERDN
static final String	TOKEN_USERID

Fields inherited from class AuthManager

AUTHENTICATED_NAME, authenticationConfig, CRED_CERT_SERIAL_TO_REVOKE, CRED_CMC_SELF_SIGNED, CRED_CMC_SIGNING_CERT, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT, engine, mConfig, mConfigParams, mImplName, mName

Constructor Summary

Constructors

Constructor	Description
PasswdUserDBAuthentication()

Method Summary

Modifier and Type	Method	Description
AuthToken	authenticate(AuthCredentials authCred)	authenticates administratrators by LDAP uid/pwd
String[]	getRequiredCreds()	get the list of authentication credential attribute names required by this authentication manager.
String	getText(Locale locale)	Retrieves the localizable description of this policy.
IDescriptor	getValueDescriptor(Locale locale, String name)	Retrieves the descriptor of the given value property by name.
Enumeration<String>	getValueNames()	Retrieves a list of names of the property.
void	init(ConfigStore config)	Initializes this default policy.
void	init(AuthenticationConfig authenticationConfig, String name, String implName, AuthManagerConfig config)	initializes the PasswdUserDBAuthentication auth manager
boolean	isSSLClientRequired()	Checks if this authenticator requires SSL client authentication.
boolean	isValueWriteable(String name)	Checks if the value of the given property should be serializable into the request.
void	populate(AuthToken token, Request request)	Populates authentication specific information into the request for auditing purposes.
void	shutdown()	disconnects the member connection

Methods inherited from class AuthManager

getAuthenticationConfig, getCMSEngine, getConfigParams, getConfigStore, getImplName, getName, getName, setAuthenticationConfig, setCMSEngine

Methods inherited from class Object

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

Field Details

logger

public static org.slf4j.Logger logger

CRED_UID

public static final String CRED_UID

See Also:

• Constant Field Values

CRED_PWD

public static final String CRED_PWD

See Also:

• Constant Field Values

TOKEN_USERDN

public static final String TOKEN_USERDN

See Also:

• Constant Field Values

TOKEN_USERID

public static final String TOKEN_USERID

See Also:

• Constant Field Values

mRequiredCred

protected static String[] mRequiredCred

Constructor Details

PasswdUserDBAuthentication

public PasswdUserDBAuthentication()

Method Details

init

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

initializes the PasswdUserDBAuthentication auth manager

called by AuthSubsystem init() method, when initializing all available authentication managers.

Specified by:

init in class AuthManager

Parameters:

name - - Name assigned to this authentication manager instance.

implName - - Name of the authentication plugin.

config - - The configuration store used by the authentication subsystem.

Throws:

EBaseException - If an initialization error occurred.

init

public void init(ConfigStore config)
          throws EProfileException

Description copied from class: AuthManager

Initializes this default policy.

Specified by:

init in class AuthManager

Parameters:

config - configuration store

Throws:

EProfileException - failed to initialize

authenticate

public AuthToken authenticate(AuthCredentials authCred)
                       throws EMissingCredential,
EInvalidCredentials,
EBaseException

authenticates administratrators by LDAP uid/pwd

called by other subsystems or their servlets to authenticate administrators

Specified by:

authenticate in class AuthManager

Parameters:

authCred - Authentication credentials. "uid" and "pwd" are required.

Returns:

the authentication token (authToken) that contains the following userdn = [userdn, in case of success]
authMgrName = [authMgrName]

populate

public void populate(AuthToken token,
 Request request)
              throws EProfileException

Description copied from class: AuthManager

Populates authentication specific information into the request for auditing purposes.

Specified by:

populate in class AuthManager

Parameters:

token - authentication token

request - request

Throws:

EProfileException - failed to populate

getText

public String getText(Locale locale)

Description copied from class: AuthManager

Retrieves the localizable description of this policy.

Specified by:

getText in class AuthManager

Parameters:

locale - end user locale

Returns:

localized authenticator description

getValueNames

public Enumeration<String> getValueNames()

Description copied from class: AuthManager

Retrieves a list of names of the property.

Specified by:

getValueNames in class AuthManager

Returns:

a list of property names

getValueDescriptor

public IDescriptor getValueDescriptor(Locale locale,
 String name)

Description copied from class: AuthManager

Retrieves the descriptor of the given value property by name.

Specified by:

getValueDescriptor in class AuthManager

Parameters:

locale - user locale

name - property name

Returns:

descriptor of the requested property

isValueWriteable

public boolean isValueWriteable(String name)

Description copied from class: AuthManager

Checks if the value of the given property should be serializable into the request. Passsword or other security-related value may not be desirable for storage.

Specified by:

isValueWriteable in class AuthManager

Parameters:

name - property name

Returns:

true if the property is not security related

isSSLClientRequired

public boolean isSSLClientRequired()

Description copied from class: AuthManager

Checks if this authenticator requires SSL client authentication.

Specified by:

isSSLClientRequired in class AuthManager

Returns:

client authentication required or not

getRequiredCreds

public String[] getRequiredCreds()

get the list of authentication credential attribute names required by this authentication manager. Generally used by servlets that use this authentication manager, to retrieve required credentials from the user (e.g. Javascript form data)

Specified by:

getRequiredCreds in class AuthManager

Returns:

attribute names in Vector

shutdown

public void shutdown()

disconnects the member connection

Specified by:

shutdown in class AuthManager