Class TokenAuthentication

java.lang.Object
org.dogtagpki.server.authentication.AuthManager
com.netscape.cms.authentication.TokenAuthentication
public class TokenAuthentication extends AuthManager
Token authentication. Checked if the given token is valid.

Version:
$Revision$, $Date$

  • Field Details

    • logger

      public static org.slf4j.Logger logger

    • CRED_SESSION_ID

      public static final String CRED_SESSION_ID
      See Also:

    • mRequiredCreds

      protected String[] mRequiredCreds

  • Constructor Details

    • TokenAuthentication

      public TokenAuthentication()

  • Method Details

    • init

      public void init(AuthenticationConfig authenticationConfig, String name, String implName, AuthManagerConfig config) throws EBaseException
      initializes the TokenAuthentication auth manager

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

      Specified by:
      init in class AuthManager
      Parameters:
      name - 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.

    • isSSLClientRequired

      public boolean isSSLClientRequired()
      Description copied from class: AuthManager
      Checks if this authenticator requires SSL client authentication.
      Specified by:
      isSSLClientRequired in class AuthManager
      Returns:
      client authentication required or not

    • authenticate

      public AuthToken authenticate(AuthCredentials 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 class AuthManager
      Parameters:
      authCred - - authentication credential that contains an usrgrp.Certificates of the user (agent)
      Returns:
      the authentication token that contains the following
      Throws:
      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:

    • getRequiredCreds

      public 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 class AuthManager
      Returns:
      attribute names in Vector

    • shutdown

      public void shutdown()
      prepare this authentication manager for shutdown.
      Specified by:
      shutdown in class AuthManager

    • init

      public void init(ConfigStore config) throws EProfileException
      Description copied from class: AuthManager
      Initializes this default policy.
      Specified by:
      init in class AuthManager
      Parameters:
      config - configuration store
      Throws:
      EProfileException - failed to initialize

    • getName

      public String getName(Locale locale)
      Retrieves the localizable name of this policy.
      Overrides:
      getName in class AuthManager
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator name

    • getText

      public String getText(Locale locale)
      Retrieves the localizable description of this policy.
      Specified by:
      getText in class AuthManager
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator description

    • getValueNames

      public Enumeration<String> getValueNames()
      Retrieves a list of names of the value parameter.
      Specified by:
      getValueNames in class AuthManager
      Returns:
      a list of property names

    • isValueWriteable

      public boolean isValueWriteable(String name)
      Description copied from class: AuthManager
      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 class AuthManager
      Parameters:
      name - property name
      Returns:
      true if the property is not security related

    • getValueDescriptor

      public IDescriptor getValueDescriptor(Locale locale, String name)
      Retrieves the descriptor of the given value parameter by name.
      Specified by:
      getValueDescriptor in class AuthManager
      Parameters:
      locale - user locale
      name - property name
      Returns:
      descriptor of the requested property

    • populate

      public void populate(AuthToken token, Request request) throws EProfileException
      Description copied from class: AuthManager
      Populates authentication specific information into the request for auditing purposes.
      Specified by:
      populate in class AuthManager
      Parameters:
      token - authentication token
      request - request
      Throws:
      EProfileException - failed to populate