OpenJDK 27 · com.sun.security.auth.module.UnixLoginModule

Modifier and Type	Field and Description
private CallbackHandler	callbackHandler
private boolean	commitSucceeded
private boolean	debug
private UnixNumericGroupPrincipal	GIDPrincipal
private Map<String, ?>	options
private Map<String, ?>	sharedState
private UnixSystem	ss
private Subject	subject
private boolean	succeeded
private LinkedList<UnixNumericGroupPrincipal>	supplementaryGroups
private UnixNumericUserPrincipal	UIDPrincipal
private UnixPrincipal	userPrincipal

Access	Constructor and Description
public	UnixLoginModule() Creates a `UnixLoginModule`.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: false if this LoginModule's own login and/or commit attempts failed, and true otherwise. abort() Implements javax.security.auth.spi.LoginModule.abort. Abort the authentication (second phase).
public boolean	Returns: true if this LoginModule's own login and commit attempts succeeded, or false otherwise. commit() Implements javax.security.auth.spi.LoginModule.commit. Commit the authentication (second phase).
public void	initialize(Subject the `Subject` to be authenticated. subject, CallbackHandler a `CallbackHandler` for communicating with the end user (prompting for usernames and passwords, for example). callbackHandler, Map<String, ?> shared `LoginModule` state. sharedState, Map<String, ?> options specified in the login `Configuration` for this particular `LoginModule`. options) Implements javax.security.auth.spi.LoginModule.initialize. Initialize this `LoginModule`.
public boolean	Returns: true in all cases (this `LoginModule` should not be ignored). login() Implements javax.security.auth.spi.LoginModule.login. Authenticate the user (first phase).
public boolean	Returns: true in all cases (this `LoginModule` should not be ignored). logout() Implements javax.security.auth.spi.LoginModule.logout. Logout the user This method removes the Principals associated with the `Subject`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

callbackHandler	back to summary
private CallbackHandler callbackHandler

commitSucceeded	back to summary
private boolean commitSucceeded

debug	back to summary
private boolean debug

GIDPrincipal	back to summary
private UnixNumericGroupPrincipal GIDPrincipal

options	back to summary
private Map<String, ?> options

sharedState	back to summary
private Map<String, ?> sharedState

ss	back to summary
private UnixSystem ss

subject	back to summary
private Subject subject

succeeded	back to summary
private boolean succeeded

supplementaryGroups	back to summary
private LinkedList<UnixNumericGroupPrincipal> supplementaryGroups

UIDPrincipal	back to summary
private UnixNumericUserPrincipal UIDPrincipal

userPrincipal	back to summary
private UnixPrincipal userPrincipal

UnixLoginModule	back to summary
public UnixLoginModule() Creates a `UnixLoginModule`.

Method Detail

abort back to summary

abort	back to summary
public boolean abort() throws LoginException Implements javax.security.auth.spi.LoginModule.abort. 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. Returns:boolean false if this LoginModule's own login and/or commit attempts failed, and true otherwise. Exceptions LoginException: if the abort fails

public boolean abort() throws LoginException

Implements javax.security.auth.spi.LoginModule.abort.

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.

Returns:boolean

false if this LoginModule's own login and/or commit attempts failed, and true otherwise.

Exceptions

LoginException:: if the abort fails

commit back to summary

commit	back to summary
public boolean commit() throws LoginException Implements javax.security.auth.spi.LoginModule.commit. 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. Returns:boolean true if this LoginModule's own login and commit attempts succeeded, or false otherwise. Exceptions LoginException: if the commit fails

public boolean commit() throws LoginException

Implements javax.security.auth.spi.LoginModule.commit.

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.

Returns:boolean

true if this LoginModule's own login and commit attempts succeeded, or false otherwise.

Exceptions

LoginException:: if the commit fails

initialize back to summary

initialize	back to summary
public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> options) Implements javax.security.auth.spi.LoginModule.initialize. Initialize this `LoginModule`. Parameters subject:Subject the `Subject` to be authenticated. callbackHandler:CallbackHandler a `CallbackHandler` for communicating with the end user (prompting for usernames and passwords, for example). sharedState:Map<String, ?> shared `LoginModule` state. options:Map<String, ?> options specified in the login `Configuration` for this particular `LoginModule`.

public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> options)

Implements javax.security.auth.spi.LoginModule.initialize.

Initialize this LoginModule.

Parameters

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

login	back to summary
public boolean login() throws LoginException Implements javax.security.auth.spi.LoginModule.login. 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. Returns:boolean true in all cases (this `LoginModule` should not be ignored). Exceptions LoginException: Doc from javax.security.auth.spi.LoginModule.login. if the authentication fails FailedLoginException: if attempts to retrieve the underlying system information fail.

public boolean login() throws LoginException

Implements javax.security.auth.spi.LoginModule.login.

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.

Returns:boolean

true in all cases (this LoginModule should not be ignored).

Exceptions

LoginException:

Doc from javax.security.auth.spi.LoginModule.login.

if the authentication fails

FailedLoginException:

if attempts to retrieve the underlying system information fail.

logout back to summary

logout	back to summary
public boolean logout() throws LoginException Implements javax.security.auth.spi.LoginModule.logout. Logout the user This method removes the Principals associated with the `Subject`. Returns:boolean true in all cases (this `LoginModule` should not be ignored). Exceptions LoginException: if the logout fails

public boolean logout() throws LoginException

Implements javax.security.auth.spi.LoginModule.logout.

Logout the user

This method removes the Principals associated with the Subject.

Returns:boolean

true in all cases (this LoginModule should not be ignored).

Exceptions

LoginException:: if the logout fails

public Class UnixLoginModule

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail