public class CMCAuth extends java.lang.Object implements IAuthManager, IExtendedPluginInfo, IProfileAuthenticator
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CRED_CMC |
protected static java.lang.String[] |
mConfigParams |
protected static java.util.Vector |
mExtendedPluginInfo |
protected static java.lang.String[] |
mRequiredCreds |
static java.lang.String |
REASON_CODE |
static java.lang.String |
TOKEN_CERT_SERIAL |
HELP_TEXT, HELP_TOKEN
AUTHENTICATED_NAME
CRED_CERT_SERIAL_TO_REVOKE, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT
Constructor and Description |
---|
CMCAuth()
Default constructor, initialization must follow.
|
Modifier and Type | Method and Description |
---|---|
IAuthToken |
authenticate(IAuthCredentials authCred)
Authenticates user by their CMC;
resulting AuthToken sets a TOKEN_SUBJECT for the subject name.
|
java.lang.String[] |
getConfigParams()
Returns a list of configuration parameter names.
|
IConfigStore |
getConfigStore()
gets the configuration substore used by this authentication
plug-in
|
java.lang.String[] |
getExtendedPluginInfo()
Activate the help system.
|
java.lang.String[] |
getExtendedPluginInfo(java.util.Locale locale)
This method returns an array of strings.
|
java.lang.String |
getImplName()
gets the plug-in name of this authentication plug-in.
|
java.lang.String |
getName()
gets the name of this authentication plug-in instance
|
java.lang.String |
getName(java.util.Locale locale)
Retrieves the localizable name of this policy.
|
java.lang.String[] |
getRequiredCreds()
get the list of required credentials.
|
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 |
getValueNames()
Retrieves a list of names of the value parameter.
|
void |
init(IProfile profile,
IConfigStore config)
Initializes this default policy.
|
void |
init(java.lang.String name,
java.lang.String implName,
IConfigStore config)
Initializes the CMCAuth authentication plug-in.
|
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.
|
protected void |
log(int level,
java.lang.String msg)
Logs a message for this class in the system log file.
|
void |
populate(IAuthToken token,
IRequest request)
Populates authentication specific information into the
request for auditing purposes.
|
void |
shutdown()
prepares for shutdown.
|
protected IAuthToken |
verifySignerInfo(AuthToken authToken,
org.mozilla.jss.pkix.cms.SignedData cmcFullReq) |
public static final java.lang.String TOKEN_CERT_SERIAL
public static final java.lang.String REASON_CODE
protected static java.lang.String[] mConfigParams
public static final java.lang.String CRED_CMC
protected static java.lang.String[] mRequiredCreds
protected static java.util.Vector mExtendedPluginInfo
public void init(java.lang.String name, java.lang.String implName, IConfigStore config) throws EBaseException
init
in interface IAuthManager
name
- The name for this authentication plug-in instance.implName
- The name of the authentication plug-in.config
- - The configuration store for this instance.EBaseException
- If an error occurs during initialization.public IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException
authenticate
in interface IAuthManager
authCred
- Authentication credentials, CRED_UID and CRED_CMC.EMissingCredential
- If a required authentication credential is missing.EInvalidCredentials
- If credentials failed authentication.EBaseException
- If an internal error occurred.AuthToken
public java.lang.String[] getConfigParams()
getConfigParams
in interface IAuthManager
public IConfigStore getConfigStore()
getConfigStore
in interface IAuthManager
getConfigStore
in interface IProfileAuthenticator
public java.lang.String getImplName()
getImplName
in interface IAuthManager
public java.lang.String getName()
getName
in interface IAuthManager
public java.lang.String[] getRequiredCreds()
getRequiredCreds
in interface IAuthManager
public void shutdown()
shutdown
in interface IAuthManager
public java.lang.String[] getExtendedPluginInfo()
protected void log(int level, java.lang.String msg)
level
- The log level.msg
- The message to log.ILogger
protected IAuthToken verifySignerInfo(AuthToken authToken, org.mozilla.jss.pkix.cms.SignedData cmcFullReq) throws EInvalidCredentials
EInvalidCredentials
public java.lang.String[] getExtendedPluginInfo(java.util.Locale locale)
IExtendedPluginInfo
getExtendedPluginInfo
in interface IExtendedPluginInfo
public void init(IProfile profile, IConfigStore config) throws EProfileException
IProfileAuthenticator
init
in interface IProfileAuthenticator
profile
- owner of this authenticatorconfig
- configuration storeEProfileException
- failed to initializepublic java.lang.String getName(java.util.Locale locale)
getName
in interface IProfileAuthenticator
locale
- end user localepublic java.lang.String getText(java.util.Locale locale)
getText
in interface IProfileAuthenticator
locale
- end user localepublic java.util.Enumeration getValueNames()
getValueNames
in interface IProfileAuthenticator
public boolean isValueWriteable(java.lang.String name)
IProfileAuthenticator
isValueWriteable
in interface IProfileAuthenticator
name
- property namepublic IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
getValueDescriptor
in interface IProfileAuthenticator
locale
- user localename
- property namepublic void populate(IAuthToken token, IRequest request) throws EProfileException
IProfileAuthenticator
populate
in interface IProfileAuthenticator
token
- authentication tokenrequest
- requestEProfileException
- failed to populatepublic boolean isSSLClientRequired()
IProfileAuthenticator
isSSLClientRequired
in interface IProfileAuthenticator