Package com.netscape.cms.authentication
Class SessionAuthentication
- java.lang.Object
-
- com.netscape.cms.authentication.SessionAuthentication
-
- All Implemented Interfaces:
IProfileAuthenticator
,IAuthManager
public class SessionAuthentication extends java.lang.Object implements IProfileAuthenticator
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 interface org.dogtagpki.server.authentication.IAuthManager
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.cms.profile.IProfileAuthenticator
AUTHENTICATED_NAME
-
-
Constructor Summary
Constructors Constructor Description SessionAuthentication()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IAuthToken
authenticate(IAuthCredentials authCred)
Authenticate user.java.lang.String[]
getConfigParams()
Get configuration parameters for this implementation.AuthManagerConfig
getConfigStore()
gets the configuretion substore used by this authentication managerjava.lang.String
getImplName()
Gets the plugin name of authentication manager.java.lang.String
getName()
Gets the name of this authentication manager.java.lang.String
getName(java.util.Locale locale)
Retrieves the localizable name of this policy.java.lang.String[]
getRequiredCreds()
Gets a list of the 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 instName, java.lang.String implName, AuthManagerConfig config)
Initialize this authentication 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.void
shutdown()
prepare this authentication manager for shutdown.
-
-
-
Method Detail
-
init
public void init(java.lang.String instName, java.lang.String implName, AuthManagerConfig config) throws EBaseException
Description copied from interface:IAuthManager
Initialize this authentication manager.- Specified by:
init
in interfaceIAuthManager
- 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.
-
getName
public java.lang.String getName()
Gets the name of this authentication manager.- Specified by:
getName
in interfaceIAuthManager
- Returns:
- the name of this authentication manager.
-
getImplName
public java.lang.String getImplName()
Gets the plugin name of authentication manager.- Specified by:
getImplName
in interfaceIAuthManager
- Returns:
- the name of the authentication manager plugin.
-
isSSLClientRequired
public boolean isSSLClientRequired()
Description copied from interface:IProfileAuthenticator
Checks if this authenticator requires SSL client authentication.- Specified by:
isSSLClientRequired
in interfaceIProfileAuthenticator
- Returns:
- client authentication required or not
-
authenticate
public IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential
Authenticate user.- Specified by:
authenticate
in interfaceIAuthManager
- 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 java.lang.String[] getRequiredCreds()
Description copied from interface:IAuthManager
Gets a list of the required credentials for this authentication manager.- Specified by:
getRequiredCreds
in interfaceIAuthManager
- Returns:
- The required credential attributes.
-
getConfigParams
public java.lang.String[] getConfigParams()
Description copied from interface:IAuthManager
Get configuration parameters for this implementation. The configuration parameters returned is passed to the configuration console so configuration for instances of this implementation can be made through the console.- Specified by:
getConfigParams
in interfaceIAuthManager
- Returns:
- a list of configuration parameters.
-
shutdown
public void shutdown()
prepare this authentication manager for shutdown.- Specified by:
shutdown
in interfaceIAuthManager
-
getConfigStore
public AuthManagerConfig getConfigStore()
gets the configuretion substore used by this authentication manager- Specified by:
getConfigStore
in interfaceIAuthManager
- Specified by:
getConfigStore
in interfaceIProfileAuthenticator
- Returns:
- configuration store
-
init
public void init(Profile profile, IConfigStore config)
Description copied from interface:IProfileAuthenticator
Initializes this default policy.- Specified by:
init
in interfaceIProfileAuthenticator
- Parameters:
profile
- owner of this authenticatorconfig
- configuration store
-
getName
public java.lang.String getName(java.util.Locale locale)
Retrieves the localizable name of this policy.- Specified by:
getName
in interfaceIProfileAuthenticator
- 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 interfaceIProfileAuthenticator
- 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 interfaceIProfileAuthenticator
- Returns:
- a list of property names
-
isValueWriteable
public boolean isValueWriteable(java.lang.String name)
Description copied from interface:IProfileAuthenticator
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 interfaceIProfileAuthenticator
- 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 interfaceIProfileAuthenticator
- Parameters:
locale
- user localename
- property name- Returns:
- descriptor of the requested property
-
populate
public void populate(IAuthToken token, IRequest request)
Description copied from interface:IProfileAuthenticator
Populates authentication specific information into the request for auditing purposes.- Specified by:
populate
in interfaceIProfileAuthenticator
- Parameters:
token
- authentication tokenrequest
- request
-
-