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 java.lang.String`	`CRED_PWD`
`static java.lang.String`	`CRED_UID`
`static org.slf4j.Logger`	`logger`
`java.lang.String`	`mAttr`
`protected java.lang.String`	`mAttrDesc`
`protected java.lang.String`	`mAttrName`
`protected static java.lang.String[]`	`mConfigParams`
`protected java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`authenticate(netscape.ldap.LDAPConnection conn, IAuthCredentials authCreds, AuthToken token)`	Authenticates a user based on attr, pwd in the directory.
`java.lang.String[]`	`getConfigParams()`	Returns a list of configuration parameter names.
`java.lang.String`	`getName(java.util.Locale locale)`	Retrieves the localizable name of this policy.
`java.lang.String[]`	`getRequiredCreds()`	Returns array of required credentials for this authentication manager.
`java.lang.String`	`getText(java.util.Locale locale)`	Retrieves the localizable description of this policy.
`IDescriptor`	`getValueDescriptor(java.util.Locale locale, java.lang.String name)`	Retrieves the descriptor of the given value parameter by name.
`java.util.Enumeration<java.lang.String>`	`getValueNames()`	Retrieves a list of names of the value parameter.
`void`	`init(Profile profile, IConfigStore config)`	Initializes this default policy.
`void`	`init(java.lang.String name, java.lang.String implName, AuthManagerConfig config)`	Initializes the UserPwdDirAuthentication auth manager.
`boolean`	`isSSLClientRequired()`	Checks if this authenticator requires SSL client authentication.
`boolean`	`isValueWriteable(java.lang.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 Detail
  - logger
```
public static org.slf4j.Logger logger
```
  - CRED_UID
```
public static final java.lang.String CRED_UID
```
    See Also:
    
    Constant Field Values
  - CRED_PWD
```
public static final java.lang.String CRED_PWD
```
    See Also:
    
    Constant Field Values
  - mAttr
```
public java.lang.String mAttr
```
  - mRequiredCreds
```
protected java.lang.String[] mRequiredCreds
```
  - mAttrName
```
protected java.lang.String mAttrName
```
  - mAttrDesc
```
protected java.lang.String mAttrDesc
```
  - mConfigParams
```
protected static java.lang.String[] mConfigParams
```
- Constructor Detail
  - UserPwdDirAuthentication
```
public UserPwdDirAuthentication()
```
    Default constructor, initialization must follow.
- Method Detail
  - init
```
public void init(java.lang.String name,
                 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String getName(java.util.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 java.lang.String getText(java.util.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 java.util.Enumeration<java.lang.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(java.lang.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(java.util.Locale locale,
                                      java.lang.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

Class UserPwdDirAuthentication

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Field Detail

logger

CRED_UID

CRED_PWD

mAttr

mRequiredCreds

mAttrName

mAttrDesc

mConfigParams

Constructor Detail

UserPwdDirAuthentication

Method Detail

init

authenticate

getConfigParams

getRequiredCreds

init

getName

getText

getValueNames

isValueWriteable

getValueDescriptor

populate

isSSLClientRequired