Class SessionAuthentication

java.lang.Object

org.dogtagpki.server.authentication.AuthManager

com.netscape.cms.authentication.SessionAuthentication

public class SessionAuthentication
extends AuthManager

Pull any existing auth token from the session context. Use with caution as a profile authenticator; if there is a session it will unconditionally approve the request (subject to constraints, etc).

Field Summary

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
SessionAuthentication()

Method Summary

Modifier and Type	Method	Description
AuthToken	authenticate(AuthCredentials authCred)	Authenticate user.
String	getName(Locale locale)	Retrieves the localizable name of this policy.
String[]	getRequiredCreds()	Gets a list of the 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.
void	init(AuthenticationConfig authenticationConfig, String instName, String implName, AuthManagerConfig config)	Initialize this authentication 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()	prepare this authentication manager for shutdown.

Methods inherited from class AuthManager

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

Methods inherited from class Object

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

Constructor Details

SessionAuthentication

public SessionAuthentication()

Method Details

init

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

Description copied from class: AuthManager

Initialize this authentication manager.

Specified by:

init in class AuthManager

Parameters:

instName - The name of this authentication manager instance.

implName - The name of the authentication manager plugin.

config - The configuration store for this authentication manager.

Throws:

EBaseException - If an initialization error occurred.

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

authenticate

public AuthToken authenticate(AuthCredentials authCred)
                       throws EMissingCredential

Authenticate user.

Specified by:

authenticate in class AuthManager

Parameters:

authCred - The authentication credentials

Returns:

the auth token from existing session context, if any.

Throws:

EMissingCredential - if no auth token or no session

getRequiredCreds

public String[] getRequiredCreds()

Description copied from class: AuthManager

Gets a list of the required credentials for this authentication manager.

Specified by:

getRequiredCreds in class AuthManager

Returns:

The required credential attributes.

shutdown

public void shutdown()

prepare this authentication manager for shutdown.

Specified by:

shutdown in class AuthManager

init

public void init(ConfigStore config)

Description copied from class: AuthManager

Initializes this default policy.

Specified by:

init in class AuthManager

Parameters:

config - configuration store

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.

Specified by:

getText in class AuthManager

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 class AuthManager

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.

Specified by:

isValueWriteable in class AuthManager

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 class AuthManager

Parameters:

locale - user locale

name - property name

Returns:

descriptor of the requested property

populate

public void populate(AuthToken token,
 Request request)

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