Class UnixLoginModule

java.lang.Object
com.sun.security.auth.module.UnixLoginModule
All Implemented Interfaces:
LoginModule
public class UnixLoginModule extends Object implements LoginModule
This LoginModule imports a user's Unix Principal information (UnixPrincipal, UnixNumericUserPrincipal, and UnixNumericGroupPrincipal) and associates them with the current Subject.

This LoginModule recognizes the debug option. If set to true in the login Configuration, debug messages will be output to the output stream, System.out.

Since:
1.4

  • Constructor Summary

    Constructors
    Constructor
    Description
    UnixLoginModule()
    Creates a UnixLoginModule.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    abort()
    Abort the authentication (second phase).
    boolean
    commit()
    Commit the authentication (second phase).
    void
    initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)
    Initialize this LoginModule.
    boolean
    login()
    Authenticate the user (first phase).
    boolean
    logout()
    Logout the user

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • UnixLoginModule

      public UnixLoginModule()
      Creates a UnixLoginModule.

  • Method Details

    • initialize

      public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)
      Initialize this LoginModule.
      Specified by:
      initialize in interface LoginModule
      Parameters:
      subject - the Subject to be authenticated.
      callbackHandler - a CallbackHandler for communicating with the end user (prompting for usernames and passwords, for example).
      sharedState - shared LoginModule state.
      options - options specified in the login Configuration for this particular LoginModule.

    • login

      public boolean login() throws LoginException
      Authenticate the user (first phase).

      The implementation of this method attempts to retrieve the user's Unix Subject information by making a native Unix system call.

      Specified by:
      login in interface LoginModule
      Returns:
      true in all cases (this LoginModule should not be ignored).
      Throws:
      FailedLoginException - if attempts to retrieve the underlying system information fail.
      LoginException - if the authentication fails

    • commit

      public boolean commit() throws LoginException
      Commit the authentication (second phase).

      This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).

      If this LoginModule's own authentication attempt succeeded (the importing of the Unix authentication information succeeded), then this method associates the Unix Principals with the Subject currently tied to the LoginModule. If this LoginModule's authentication attempted failed, then this method removes any state that was originally saved.

      Specified by:
      commit in interface LoginModule
      Returns:
      true if this LoginModule's own login and commit attempts succeeded, or false otherwise.
      Throws:
      LoginException - if the commit fails

    • abort

      public boolean abort() throws LoginException
      Abort the authentication (second phase).

      This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed).

      This method cleans up any state that was originally saved as part of the authentication attempt from the login and commit methods.

      Specified by:
      abort in interface LoginModule
      Returns:
      false if this LoginModule's own login and/or commit attempts failed, and true otherwise.
      Throws:
      LoginException - if the abort fails

    • logout

      public boolean logout() throws LoginException
      Logout the user

      This method removes the Principals associated with the Subject.

      Specified by:
      logout in interface LoginModule
      Returns:
      true in all cases (this LoginModule should not be ignored).
      Throws:
      LoginException - if the logout fails