Class UidPwdDirAuthentication

java.lang.Object

org.dogtagpki.server.authentication.AuthManager

com.netscape.cms.authentication.DirBasedAuthentication

com.netscape.cms.authentication.UidPwdDirAuthentication

All Implemented Interfaces:

IExtendedPluginInfo

public class UidPwdDirAuthentication
extends DirBasedAuthentication

uid/pwd directory based authentication manager

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger
protected static String[]	mConfigParams
protected static String[]	mRequiredCreds

Fields inherited from class DirBasedAuthentication

CRED_PIN, CRED_PWD, CRED_ShrTok, CRED_UID, CRED_USER_PASSWORD, DEFAULT_DNPATTERN, mBaseDN, mBoundConnEnable, mConnFactory, mExtendedPluginInfo, mGroupObjectClass, mGroups, mGroupsBaseDN, mGroupsEnable, mGroupUserIDName, mLdapAttrs, mLdapByteAttrs, mLdapConfig, mLdapStringAttrs, mPattern, mSearchGroupUserByUserdn, mTag, mUserIDName, PROP_DNPATTERN, PROP_GROUP_OBJECT_CLASS, PROP_GROUP_USERID_NAME, PROP_GROUPS, PROP_GROUPS_BASEDN, PROP_GROUPS_ENABLE, PROP_LDAP_BOUND_CONN, PROP_LDAPBYTEATTRS, PROP_LDAPSTRINGATTRS, PROP_SEARCH_GROUP_USER_BY_USERDN, PROP_USERID_NAME, USER_DN

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, mImplName, mName

Fields inherited from interface IExtendedPluginInfo

HELP_TEXT, HELP_TOKEN

Constructor Summary

Constructors

Constructor	Description
UidPwdDirAuthentication()

Method Summary

Modifier and Type	Method	Description
protected String	authenticate(netscape.ldap.LDAPConnection conn, AuthCredentials authCreds, AuthToken token)	Authenticates a user based on uid, pwd in the directory.
String[]	getConfigParams()	Returns a list of configuration parameter names.
String	getName(Locale locale)	Retrieves the localizable name of this policy.
String[]	getRequiredCreds()	Returns array of required credentials for 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 parameter by name.
Enumeration<String>	getValueNames()	Retrieves a list of names of the value parameter.
void	init(ConfigStore config)	Initializes this default policy.
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.

Methods inherited from class DirBasedAuthentication

authenticate, formCertInfo, formSubjectName, getExtendedPluginInfo, getLdapAttrs, getLdapByteAttrs, init, init, setAuthTokenByteValue, setAuthTokenStringValue, setAuthTokenValues, shutdown

Methods inherited from class AuthManager

getAuthenticationConfig, getCMSEngine, getConfigStore, getImplName, 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

mRequiredCreds

protected static String[] mRequiredCreds

mConfigParams

protected static String[] mConfigParams

Constructor Details

UidPwdDirAuthentication

public UidPwdDirAuthentication()

Method Details

authenticate

protected String authenticate(netscape.ldap.LDAPConnection conn,
 AuthCredentials authCreds,
 AuthToken token)
                       throws EBaseException

Authenticates a user based on uid, pwd in the directory.

Specified by:

authenticate in class DirBasedAuthentication

Parameters:

authCreds - The authentication credentials.

Returns:

The user's ldap entry dn.

Throws:

EInvalidCredentials - If the uid and password are not valid

EBaseException - If an internal error occurs.

getConfigParams

public 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.

Overrides:

getConfigParams in class AuthManager

Returns:

String array of configuration parameter names.

getRequiredCreds

public String[] getRequiredCreds()

Returns array of required credentials for this authentication manager.

Specified by:

getRequiredCreds in class DirBasedAuthentication

Returns:

Array of required credentials.

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

getName

public String getName(Locale locale)

Retrieves the localizable name of this policy.

Overrides:

getName in class AuthManager

Parameters:

locale - end user locale

Returns:

localized authenticator name

getText

public String getText(Locale locale)

Retrieves the localizable description of this policy.

Overrides:

getText in class DirBasedAuthentication

Parameters:

locale - end user locale

Returns:

localized authenticator description

getValueNames

public Enumeration<String> getValueNames()

Retrieves a list of names of the value parameter.

Overrides:

getValueNames in class DirBasedAuthentication

Returns:

a list of property names

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.

Overrides:

isValueWriteable in class DirBasedAuthentication

Parameters:

name - property name

Returns:

true if the property is not security related

getValueDescriptor

public IDescriptor getValueDescriptor(Locale locale,
 String name)

Retrieves the descriptor of the given value parameter by name.

Overrides:

getValueDescriptor in class DirBasedAuthentication

Parameters:

locale - user locale

name - property name

Returns:

descriptor of the requested property

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.

Overrides:

populate in class DirBasedAuthentication

Parameters:

token - authentication token

request - request

Throws:

EProfileException - failed to populate

isSSLClientRequired

public boolean isSSLClientRequired()

Description copied from class: AuthManager

Checks if this authenticator requires SSL client authentication.

Overrides:

isSSLClientRequired in class DirBasedAuthentication

Returns:

client authentication required or not