Package com.netscape.cms.authentication
Class SessionAuthentication
java.lang.Object
com.netscape.cms.authentication.SessionAuthentication
- All Implemented Interfaces:
ProfileAuthenticator
,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 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.cms.profile.ProfileAuthenticator
AUTHENTICATED_NAME
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(IAuthCredentials authCred) Authenticate user.String[]
Get configuration parameters for this implementation.gets the configuretion substore used by this authentication managerGets the plugin name of authentication manager.getName()
Gets the name of this authentication manager.Retrieves the localizable name of this policy.String[]
Gets a list of the required credentials for this authentication manager.Retrieves the localizable description of this policy.getValueDescriptor
(Locale locale, String name) Retrieves the descriptor of the given value parameter by name.Retrieves a list of names of the value parameter.void
init
(Profile profile, ConfigStore config) Initializes this default policy.void
init
(String instName, String implName, AuthManagerConfig config) Initialize this authentication manager.boolean
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, Request request) Populates authentication specific information into the request for auditing purposes.void
shutdown()
prepare this authentication manager for shutdown.
-
Constructor Details
-
SessionAuthentication
public SessionAuthentication()
-
-
Method Details
-
init
Description copied from interface:AuthManager
Initialize this authentication manager.- Specified by:
init
in interfaceAuthManager
- 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
Gets the name of this authentication manager.- Specified by:
getName
in interfaceAuthManager
- Returns:
- the name of this authentication manager.
-
getImplName
Gets the plugin name of authentication manager.- Specified by:
getImplName
in interfaceAuthManager
- Returns:
- the name of the authentication manager plugin.
-
isSSLClientRequired
public boolean isSSLClientRequired()Description copied from interface:ProfileAuthenticator
Checks if this authenticator requires SSL client authentication.- Specified by:
isSSLClientRequired
in interfaceProfileAuthenticator
- Returns:
- client authentication required or not
-
authenticate
Authenticate user.- Specified by:
authenticate
in interfaceAuthManager
- 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
Description copied from interface:AuthManager
Gets a list of the required credentials for this authentication manager.- Specified by:
getRequiredCreds
in interfaceAuthManager
- Returns:
- The required credential attributes.
-
getConfigParams
Description copied from interface:AuthManager
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 interfaceAuthManager
- Returns:
- a list of configuration parameters.
-
shutdown
public void shutdown()prepare this authentication manager for shutdown.- Specified by:
shutdown
in interfaceAuthManager
-
getConfigStore
gets the configuretion substore used by this authentication manager- Specified by:
getConfigStore
in interfaceAuthManager
- Specified by:
getConfigStore
in interfaceProfileAuthenticator
- Returns:
- configuration store
-
init
Description copied from interface:ProfileAuthenticator
Initializes this default policy.- Specified by:
init
in interfaceProfileAuthenticator
- Parameters:
profile
- owner of this authenticatorconfig
- configuration store
-
getName
Retrieves the localizable name of this policy.- Specified by:
getName
in interfaceProfileAuthenticator
- Parameters:
locale
- end user locale- Returns:
- localized authenticator name
-
getText
Retrieves the localizable description of this policy.- Specified by:
getText
in interfaceProfileAuthenticator
- Parameters:
locale
- end user locale- Returns:
- localized authenticator description
-
getValueNames
Retrieves a list of names of the value parameter.- Specified by:
getValueNames
in interfaceProfileAuthenticator
- Returns:
- a list of property names
-
isValueWriteable
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 interfaceProfileAuthenticator
- Parameters:
name
- property name- Returns:
- true if the property is not security related
-
getValueDescriptor
Retrieves the descriptor of the given value parameter by name.- Specified by:
getValueDescriptor
in interfaceProfileAuthenticator
- Parameters:
locale
- user localename
- property name- Returns:
- descriptor of the requested property
-
populate
Description copied from interface:ProfileAuthenticator
Populates authentication specific information into the request for auditing purposes.- Specified by:
populate
in interfaceProfileAuthenticator
- Parameters:
token
- authentication tokenrequest
- request
-