public class SSLclientCertAuthentication extends java.lang.Object implements AuthManager, ProfileAuthenticator
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CRED_CERT |
static org.slf4j.Logger |
logger |
protected static java.lang.String[] |
mConfigParams |
protected java.lang.String[] |
mRequiredCreds |
static java.lang.String |
TOKEN_UID |
static java.lang.String |
TOKEN_USER_DN |
static java.lang.String |
TOKEN_USERDN |
static java.lang.String |
TOKEN_USERID |
AUTHENTICATED_NAME
CRED_CERT_SERIAL_TO_REVOKE, CRED_CMC_SELF_SIGNED, CRED_CMC_SIGNING_CERT, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT
Constructor and Description |
---|
SSLclientCertAuthentication() |
Modifier and Type | Method and Description |
---|---|
IAuthToken |
authenticate(IAuthCredentials authCred)
authenticates user by certificate
|
java.lang.String[] |
getConfigParams()
get the list of configuration parameter names
required by this authentication manager.
|
AuthManagerConfig |
getConfigStore()
gets the configuretion substore used by this authentication
manager
|
java.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()
get the list of authentication credential attribute names
required by 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 SSLClientCertAuthentication 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.
|
void |
shutdown()
prepare this authentication manager for shutdown.
|
public static org.slf4j.Logger logger
public static final java.lang.String TOKEN_USERDN
public static final java.lang.String TOKEN_USER_DN
public static final java.lang.String TOKEN_USERID
public static final java.lang.String TOKEN_UID
public static final java.lang.String CRED_CERT
protected java.lang.String[] mRequiredCreds
protected static java.lang.String[] mConfigParams
public void init(java.lang.String name, java.lang.String implName, AuthManagerConfig config) throws EBaseException
called by AuthSubsystem init() method, when initializing all available authentication managers.
init
in interface AuthManager
name
- The name of this authentication manager instance.implName
- The name of the authentication manager plugin.config
- The configuration store for this authentication manager.EBaseException
- If an initialization error occurred.public java.lang.String getName()
getName
in interface AuthManager
public java.lang.String getImplName()
getImplName
in interface AuthManager
public boolean isSSLClientRequired()
ProfileAuthenticator
isSSLClientRequired
in interface ProfileAuthenticator
public IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException
called by other subsystems or their servlets to authenticate users
authenticate
in interface AuthManager
authCred
- - authentication credential that contains
an usrgrp.Certificates of the user (agent)EMissingCredential
- If a required credential for this
authentication manager is missing.EInvalidCredentials
- If credentials cannot be authenticated.EBaseException
- If an internal error occurred.AuthToken
,
Certificates
public java.lang.String[] getRequiredCreds()
getRequiredCreds
in interface AuthManager
public java.lang.String[] getConfigParams()
getConfigParams
in interface AuthManager
public void shutdown()
shutdown
in interface AuthManager
public AuthManagerConfig getConfigStore()
getConfigStore
in interface ProfileAuthenticator
getConfigStore
in interface AuthManager
public void init(Profile profile, IConfigStore config) throws EProfileException
ProfileAuthenticator
init
in interface ProfileAuthenticator
profile
- owner of this authenticatorconfig
- configuration storeEProfileException
- failed to initializepublic java.lang.String getName(java.util.Locale locale)
getName
in interface ProfileAuthenticator
locale
- end user localepublic java.lang.String getText(java.util.Locale locale)
getText
in interface ProfileAuthenticator
locale
- end user localepublic java.util.Enumeration<java.lang.String> getValueNames()
getValueNames
in interface ProfileAuthenticator
public boolean isValueWriteable(java.lang.String name)
ProfileAuthenticator
isValueWriteable
in interface ProfileAuthenticator
name
- property namepublic IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
getValueDescriptor
in interface ProfileAuthenticator
locale
- user localename
- property namepublic void populate(IAuthToken token, IRequest request) throws EProfileException
ProfileAuthenticator
populate
in interface ProfileAuthenticator
token
- authentication tokenrequest
- requestEProfileException
- failed to populate