Package com.netscape.cmscore.authentication

Class CertUserDBAuthentication

java.lang.Object

com.netscape.cmscore.authentication.CertUserDBAuthentication

All Implemented Interfaces:

IAuthManager, ICertUserDBAuthentication

public class CertUserDBAuthentication
extends java.lang.Object
implements IAuthManager, ICertUserDBAuthentication

Certificate server agent authentication. Maps a SSL client authenticate certificate to a user (agent) entry in the internal database.

Version:

$Revision$, $Date$

Author:

lhsiao, cfu

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	logger
protected static java.lang.String[]	mConfigParams
protected java.lang.String[]	mRequiredCreds

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 org.dogtagpki.server.authentication.ICertUserDBAuthentication

CRED_CERT, TOKEN_UID, TOKEN_USER_DN, TOKEN_USERDN, TOKEN_USERID

Constructor Summary

Constructors

Constructor	Description
CertUserDBAuthentication()

Method Summary

Modifier and Type	Method	Description
IAuthToken	authenticate(IAuthCredentials authCred)	authenticates user(agent) by certificate
AuthenticationConfig	getAuthenticationConfig()
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[]	getRequiredCreds()	get the list of authentication credential attribute names required by this authentication manager.
void	init(java.lang.String name, java.lang.String implName, AuthManagerConfig config)	initializes the CertUserDBAuthentication auth manager
void	setAuthenticationConfig(AuthenticationConfig authenticationConfig)
void	shutdown()	prepare this authentication manager for shutdown.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static org.slf4j.Logger logger

mRequiredCreds

protected java.lang.String[] mRequiredCreds

mConfigParams

protected static java.lang.String[] mConfigParams

Constructor Detail

CertUserDBAuthentication

public CertUserDBAuthentication()

Method Detail

getAuthenticationConfig

public AuthenticationConfig getAuthenticationConfig()

setAuthenticationConfig

public void setAuthenticationConfig(AuthenticationConfig authenticationConfig)

init

public void init(java.lang.String name,
                 java.lang.String implName,
                 AuthManagerConfig config)
          throws EBaseException

initializes the CertUserDBAuthentication auth manager

called by AuthSubsystem init() method, when initializing all available authentication managers.

Specified by:

init in interface IAuthManager

Parameters:

owner - - The authentication subsystem that hosts this auth manager

config - - The configuration store used by the authentication subsystem

Throws:

EBaseException - If an initialization error occurred.

getName

public java.lang.String getName()

Gets the name of this authentication manager.

Specified by:

getName in interface IAuthManager

Returns:

the name of this authentication manager.

getImplName

public java.lang.String getImplName()

Gets the plugin name of authentication manager.

Specified by:

getImplName in interface IAuthManager

Returns:

the name of the authentication manager plugin.

authenticate

public IAuthToken authenticate(IAuthCredentials authCred)
                        throws EMissingCredential,
                               EInvalidCredentials,
                               EBaseException

authenticates user(agent) by certificate

called by other subsystems or their servlets to authenticate users (agents)

Specified by:

authenticate in interface IAuthManager

Parameters:

authCred - - authentication credential that contains an usrgrp.Certificates of the user (agent)

Returns:

the authentication token that contains the following

Throws:

com.netscape.certsrv.base.EAuthsException - any authentication failure or insufficient credentials

EMissingCredential - If a required credential for this authentication manager is missing.

EInvalidCredentials - If credentials cannot be authenticated.

EBaseException - If an internal error occurred.

See Also:

AuthToken, Certificates

getRequiredCreds

public java.lang.String[] getRequiredCreds()

get the list of authentication credential attribute names required by this authentication manager. Generally used by the servlets that handle agent operations to authenticate its users. It calls this method to know which are the required credentials from the user (e.g. Javascript form data)

Specified by:

getRequiredCreds in interface IAuthManager

Returns:

attribute names in Vector

getConfigParams

public java.lang.String[] getConfigParams()

get the list of configuration parameter names required by this authentication manager. Generally used by the Certificate Server Console to display the table for configuration purposes. CertUserDBAuthentication is currently not exposed in this case, so this method is not to be used.

Specified by:

getConfigParams in interface IAuthManager

Returns:

configuration parameter names in Hashtable of Vectors where each hashtable entry's key is the substore name, value is a Vector of parameter names. If no substore, the parameter name is the Hashtable key itself, with value same as key.

shutdown

public void shutdown()

prepare this authentication manager for shutdown.

Specified by:

shutdown in interface IAuthManager

getConfigStore

public AuthManagerConfig getConfigStore()

gets the configuretion substore used by this authentication manager

Specified by:

getConfigStore in interface IAuthManager

Returns:

configuration store