Class UserPwdDirAuthentication

java.lang.Object

com.netscape.cms.authentication.DirBasedAuthentication

com.netscape.cms.authentication.UserPwdDirAuthentication

All Implemented Interfaces:

IExtendedPluginInfo, ProfileAuthenticator, AuthManager

public class UserPwdDirAuthentication
extends DirBasedAuthentication
implements ProfileAuthenticator

uid/pwd directory based authentication manager

Version:

$Revision$, $Date$

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CRED_PWD
static final String	CRED_UID
static org.slf4j.Logger	logger
String	mAttr
protected String	mAttrDesc
protected String	mAttrName
protected static String[]	mConfigParams
protected String[]	mRequiredCreds

Fields inherited from class com.netscape.cms.authentication.DirBasedAuthentication

DEFAULT_DNPATTERN, mBaseDN, mBoundConnEnable, mConfig, mConnFactory, mExtendedPluginInfo, mGroupObjectClass, mGroups, mGroupsBaseDN, mGroupsEnable, mGroupUserIDName, mImplName, mLdapAttrs, mLdapByteAttrs, mLdapConfig, mLdapStringAttrs, mName, 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 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

Fields inherited from interface com.netscape.certsrv.base.IExtendedPluginInfo

HELP_TEXT, HELP_TOKEN

Fields inherited from interface com.netscape.cms.profile.ProfileAuthenticator

AUTHENTICATED_NAME

Constructor Summary

Constructors

Constructor	Description
UserPwdDirAuthentication()	Default constructor, initialization must follow.

Method Summary

Modifier and Type	Method	Description
protected String	authenticate(netscape.ldap.LDAPConnection conn, IAuthCredentials authCreds, AuthToken token)	Authenticates a user based on attr, 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(Profile profile, IConfigStore config)	Initializes this default policy.
void	init(String name, String implName, AuthManagerConfig config)	Initializes the UserPwdDirAuthentication 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(IAuthToken token, IRequest request)	Populates authentication specific information into the request for auditing purposes.

Methods inherited from class com.netscape.cms.authentication.DirBasedAuthentication

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dogtagpki.server.authentication.AuthManager

authenticate, getImplName, getName, shutdown

Methods inherited from interface com.netscape.cms.profile.ProfileAuthenticator

getConfigStore

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

mAttr

public String mAttr

mRequiredCreds

protected String[] mRequiredCreds

mAttrName

protected String mAttrName

mAttrDesc

protected String mAttrDesc

mConfigParams

protected static String[] mConfigParams

Constructor Details

UserPwdDirAuthentication

public UserPwdDirAuthentication()

Default constructor, initialization must follow.

Method Details

init

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

Initializes the UserPwdDirAuthentication auth manager.

Specified by:

init in interface AuthManager

Overrides:

init in class DirBasedAuthentication

Parameters:

name - - The name for this authentication manager instance.

implName - - The name of the authentication manager plugin.

config - - The configuration store for this instance.

Throws:

EBaseException - If an error occurs during initialization.

authenticate

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

Authenticates a user based on attr, 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 attr 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.

Specified by:

getConfigParams in interface AuthManager

Specified by:

getConfigParams in class DirBasedAuthentication

Returns:

String array of configuration parameter names.

getRequiredCreds

public String[] getRequiredCreds()

Returns array of required credentials for this authentication manager.

Specified by:

getRequiredCreds in interface AuthManager

Specified by:

getRequiredCreds in class DirBasedAuthentication

Returns:

Array of required credentials.

init

public void init(Profile profile,
 IConfigStore config)
          throws EProfileException

Description copied from interface: ProfileAuthenticator

Initializes this default policy.

Specified by:

init in interface ProfileAuthenticator

Parameters:

profile - owner of this authenticator

config - configuration store

Throws:

EProfileException - failed to initialize

getName

public String getName(Locale locale)

Retrieves the localizable name of this policy.

Specified by:

getName in interface ProfileAuthenticator

Parameters:

locale - end user locale

Returns:

localized authenticator name

getText

public String getText(Locale locale)

Retrieves the localizable description of this policy.

Specified by:

getText in interface ProfileAuthenticator

Parameters:

locale - end user locale

Returns:

localized authenticator description

getValueNames

public Enumeration<String> getValueNames()

Retrieves a list of names of the value parameter.

Specified by:

getValueNames in interface ProfileAuthenticator

Returns:

a list of property names

isValueWriteable

public boolean isValueWriteable(String name)

Description copied from interface: ProfileAuthenticator

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 interface ProfileAuthenticator

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.

Specified by:

getValueDescriptor in interface ProfileAuthenticator

Parameters:

locale - user locale

name - property name

Returns:

descriptor of the requested property

populate

public void populate(IAuthToken token,
 IRequest request)
              throws EProfileException

Description copied from interface: ProfileAuthenticator

Populates authentication specific information into the request for auditing purposes.

Specified by:

populate in interface ProfileAuthenticator

Parameters:

token - authentication token

request - request

Throws:

EProfileException - failed to populate

isSSLClientRequired

public boolean isSSLClientRequired()

Description copied from interface: ProfileAuthenticator

Checks if this authenticator requires SSL client authentication.

Specified by:

isSSLClientRequired in interface ProfileAuthenticator

Returns:

client authentication required or not