Class HashAuthentication

java.lang.Object
com.netscape.cms.authentication.HashAuthentication
All Implemented Interfaces:
IExtendedPluginInfo, AuthManager

public class HashAuthentication extends Object implements AuthManager, IExtendedPluginInfo
Hash uid/pwd directory based authentication manager

Version:
$Revision$, $Date$
  • Field Details

  • Constructor Details

    • HashAuthentication

      public HashAuthentication()
      Default constructor, initialization must follow.
  • Method Details

    • init

      public void init(String name, String implName, AuthManagerConfig config) throws EBaseException
      Description copied from interface: AuthManager
      Initialize this authentication manager.
      Specified by:
      init in interface 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.
    • getAuthToken

      public IAuthToken getAuthToken(String key)
    • addAuthToken

      public void addAuthToken(String pageID, IAuthToken token)
    • deleteToken

      public void deleteToken(String pageID)
    • getData

      public HashAuthData getData()
    • createEntry

      public void createEntry(String host, String dn, long timeout, String secret, long lastLogin)
    • disable

      public void disable(String hostname)
    • getAgentName

      public String getAgentName(String hostname)
    • setAgentName

      public void setAgentName(String hostname, String agentName)
    • isEnable

      public boolean isEnable(String hostname)
    • getTimeout

      public long getTimeout(String hostname)
    • setTimeout

      public void setTimeout(String hostname, long timeout)
    • getSecret

      public String getSecret(String hostname)
    • setSecret

      public void setSecret(String hostname, String secret)
    • getLastLogin

      public long getLastLogin(String hostname)
    • setLastLogin

      public void setLastLogin(String hostname, long lastlogin)
    • getPageID

      public long getPageID()
    • validFingerprint

      public boolean validFingerprint(String host, String pageID, String uid, String fingerprint)
    • getHosts

      public Enumeration<String> getHosts()
    • hashFingerprint

      public String hashFingerprint(String host, String pageID, String uid)
    • shutdown

      public void shutdown()
      Description copied from interface: AuthManager
      Prepare this authentication manager for a shutdown. Called when the server is exiting for any cleanup needed.
      Specified by:
      shutdown in interface AuthManager
    • authenticate

      public IAuthToken authenticate(IAuthCredentials authCreds) throws EBaseException
      Authenticates a user based on uid, pwd in the directory.
      Specified by:
      authenticate in interface AuthManager
      Parameters:
      authCreds - The authentication credentials.
      Returns:
      The user's ldap entry dn.
      Throws:
      EInvalidCredentials - If the uid and password are not valid
      EBaseException - If an internal error occurs.
    • getRequiredCreds

      public String[] getRequiredCreds()
      Returns array of required credentials for this authentication manager.
      Specified by:
      getRequiredCreds in interface AuthManager
      Returns:
      Array of required credentials.
    • getConfigStore

      public AuthManagerConfig getConfigStore()
      Gets the configuration substore used by this authentication manager
      Specified by:
      getConfigStore in interface AuthManager
      Returns:
      configuration store
    • getName

      public String getName()
      gets the name of this authentication manager instance
      Specified by:
      getName in interface AuthManager
      Returns:
      the name of this authentication manager.
    • getImplName

      public String getImplName()
      gets the plugin name of this authentication manager.
      Specified by:
      getImplName in interface AuthManager
      Returns:
      the name of the authentication manager plugin.
    • getExtendedPluginInfo

      public String[] getExtendedPluginInfo()
      Description copied from interface: IExtendedPluginInfo
      This method returns an array of strings. Each element of the array represents a configurable parameter, or some other meta-info (such as help-token) there is an entry indexed on that parameter name Where: type_info is either 'string', 'number', 'boolean', 'password' or 'choice(ch1,ch2,ch3,...)' If the marker 'required' is included after the type_info, the parameter will has some visually distinctive marking in the UI. 'description' is a short sentence describing the parameter 'choice' is rendered as a drop-down list. The first parameter in the list will be activated by default 'boolean' is rendered as a checkbox. The resulting parameter will be either 'true' or 'false' 'string' allows any characters 'number' allows only numbers 'password' is rendered as a password field (the characters are replaced with *'s when being types. This parameter is not passed through to the plugin. It is instead inserted directly into the password cache keyed on the instance name. The value of the parameter 'bindPWPrompt' (see example below) is set to the key. In addition to the configurable parameters, the following magic parameters may be defined: HELP_TOKEN;helptoken - a pointer to the online manual section for this plugin HELP_TEXT;helptext - a general help string describing the plugin For example: "username;string;The username you wish to login as" "bindPWPrompt;password;Enter password to bind as above user with" "algorithm;choice(RSA,DSA);Which algorithm do you want to use" "enable;boolean;Do you want to run this plugin" "port;number;Which port number do you want to use"
      Specified by:
      getExtendedPluginInfo in interface IExtendedPluginInfo
    • getConfigParams

      public String[] getConfigParams()
      Returns a list of configuration parameter names. The list is passed to the configuration console so instances of this implementation can be configured through the console.
      Specified by:
      getConfigParams in interface AuthManager
      Returns:
      String array of configuration parameter names.