Class PortalEnroll

java.lang.Object

com.netscape.cms.authentication.DirBasedAuthentication

com.netscape.cms.authentication.PortalEnroll

All Implemented Interfaces:

IExtendedPluginInfo, AuthManager

public class PortalEnroll
extends DirBasedAuthentication

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
protected static String[]	mConfigParams
protected static String[]	mRequiredCreds
protected static final String	PROP_AUTHTYPE
protected static final String	PROP_BINDDN
protected static final String	PROP_BINDPW
protected static final String	PROP_HOST
protected static final String	PROP_OBJECTCLASS
protected static final String	PROP_PORT
protected static final String	PROP_SECURECONN
protected static final String	PROP_VERSION

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

DEFAULT_DNPATTERN, 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

Constructor Summary

Constructors

Constructor	Description
PortalEnroll()	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 uid, pwd in the directory.
String[]	getConfigParams()	Returns a list of configuration parameter names.
String[]	getExtendedPluginInfo(Locale locale)	This method returns an array of strings.
String[]	getRequiredCreds()	Returns array of required credentials for this authentication manager.
void	init(String name, String implName, AuthManagerConfig config)	Initializes the PortalEnrollment auth manager.
void	initLdapAttrs(netscape.ldap.LDAPSchema dirSchema, String oclass)
String	regist(AuthToken token, String uid)	adds a user to the directory.

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

authenticate, formCertInfo, formSubjectName, getConfigStore, 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

Field Details

logger

public static org.slf4j.Logger logger

PROP_AUTHTYPE

protected static final String PROP_AUTHTYPE

See Also:

• Constant Field Values

PROP_BINDDN

protected static final String PROP_BINDDN

See Also:

• Constant Field Values

PROP_BINDPW

protected static final String PROP_BINDPW

See Also:

• Constant Field Values

PROP_HOST

protected static final String PROP_HOST

See Also:

• Constant Field Values

PROP_PORT

protected static final String PROP_PORT

See Also:

• Constant Field Values

PROP_SECURECONN

protected static final String PROP_SECURECONN

See Also:

• Constant Field Values

PROP_VERSION

protected static final String PROP_VERSION

See Also:

• Constant Field Values

PROP_OBJECTCLASS

protected static final String PROP_OBJECTCLASS

See Also:

• Constant Field Values

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

mRequiredCreds

protected static String[] mRequiredCreds

mConfigParams

protected static String[] mConfigParams

Constructor Details

PortalEnroll

public PortalEnroll()
             throws EBaseException

Default constructor, initialization must follow.

Throws:

EBaseException

Method Details

init

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

Initializes the PortalEnrollment 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 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.

Specified by:

getConfigParams in interface AuthManager

Specified by:

getConfigParams in class DirBasedAuthentication

Returns:

String array of configuration parameter names.

getExtendedPluginInfo

public String[] getExtendedPluginInfo(Locale locale)

Description copied from interface: IExtendedPluginInfo

This method returns an array of strings. Each element of the array represents a configurable parameter, or some other meta-info (such as help-token) there is an entry indexed on that parameter name Where: type_info is either 'string', 'number', 'boolean', 'password' or 'choice(ch1,ch2,ch3,...)' If the marker 'required' is included after the type_info, the parameter will has some visually distinctive marking in the UI. 'description' is a short sentence describing the parameter 'choice' is rendered as a drop-down list. The first parameter in the list will be activated by default 'boolean' is rendered as a checkbox. The resulting parameter will be either 'true' or 'false' 'string' allows any characters 'number' allows only numbers 'password' is rendered as a password field (the characters are replaced with *'s when being types. This parameter is not passed through to the plugin. It is instead inserted directly into the password cache keyed on the instance name. The value of the parameter 'bindPWPrompt' (see example below) is set to the key. In addition to the configurable parameters, the following magic parameters may be defined: HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin HELP_TEXT;helptext - a general help string describing the plugin For example: "username;string;The username you wish to login as" "bindPWPrompt;password;Enter password to bind as above user with" "algorithm;choice(RSA,DSA);Which algorithm do you want to use" "enable;boolean;Do you want to run this plugin" "port;number;Which port number do you want to use"

Specified by:

getExtendedPluginInfo in interface IExtendedPluginInfo

Overrides:

getExtendedPluginInfo in class DirBasedAuthentication

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.

regist

public String regist(AuthToken token,
 String uid)

adds a user to the directory.

Parameters:

token - authentication token

uid - the user's id.

Returns:

dn upon success and null upon failure.

initLdapAttrs

public void initLdapAttrs(netscape.ldap.LDAPSchema dirSchema,
 String oclass)