com.tagish.auth.win32
Class NTSystemLogin
java.lang.Object
|
+--com.tagish.auth.BasicLogin
|
+--com.tagish.auth.win32.NTSystemLogin
- All Implemented Interfaces:
- javax.security.auth.spi.LoginModule
- public class NTSystemLogin
- extends BasicLogin
LoginModule for Windows NT. This module's behaviour depends on the following
boolean options that may appear in the configuration file:
returnNames | Principals will use NT names |
returnSIDs | Principals will use NT SIDs |
defaultDomain | Supply the name of the domain that
will be used to authenticate logons. If this option is not present
a domain name will be requested using a TextInputCallback.
|
- Version:
- 1.0.3
- Author:
- Andy Armstrong, andy@tagish.com
Method Summary |
boolean |
abort()
This method is called if the LoginContext's
overall authentication failed. |
boolean |
commit()
This method is called if the LoginContext's overall authentication
succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL
LoginModules succeeded). |
void |
initialize(javax.security.auth.Subject subject,
javax.security.auth.callback.CallbackHandler callbackHandler,
Map sharedState,
Map options)
Initialize this LoginModule . |
boolean |
login()
Authenticate the user by prompting for a username and password. |
boolean |
logout()
Logout the user. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ntSystem
protected NTSystem ntSystem
returnNames
protected boolean returnNames
returnSIDs
protected boolean returnSIDs
defaultDomain
protected String defaultDomain
succeeded
protected boolean succeeded
commitSucceeded
protected boolean commitSucceeded
principals
protected Vector principals
NTSystemLogin
public NTSystemLogin()
initialize
public void initialize(javax.security.auth.Subject subject,
javax.security.auth.callback.CallbackHandler callbackHandler,
Map sharedState,
Map options)
- Initialize this
LoginModule
.
- Overrides:
initialize
in class BasicLogin
- 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 javax.security.auth.login.LoginException
- Authenticate the user by prompting for a username and password.
- Returns:
- true in all cases since this
LoginModule
should not be ignored. - Throws:
FailedLoginException
- if the authentication fails. javax.security.auth.login.LoginException
- if this LoginModule
is unable to perform the authentication.
commit
public boolean commit()
throws javax.security.auth.login.LoginException
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 (checked by retrieving the private state saved by the
login
method), then this method associates a
number of NTPrincipal
s
with the Subject
located in the
LoginModule
. If this LoginModule's own
authentication attempted failed, then this method removes
any state that was originally saved.
- Returns:
- true if this LoginModule's own login and commit
attempts succeeded, or false otherwise.
- Throws:
javax.security.auth.login.LoginException
- if the commit fails.
abort
public boolean abort()
throws javax.security.auth.login.LoginException
This method is called if the LoginContext's
overall authentication failed.
(the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules
did not succeed).
If this LoginModule's own authentication attempt
succeeded (checked by retrieving the private state saved by the
login
and commit
methods),
then this method cleans up any state that was originally saved.
- Returns:
- false if this LoginModule's own login and/or commit attempts
failed, and true otherwise.
- Throws:
javax.security.auth.login.LoginException
- if the abort fails.
logout
public boolean logout()
throws javax.security.auth.login.LoginException
- Logout the user.
This method removes the Principal
s
that were added by the commit
method.
- Returns:
- true in all cases since this
LoginModule
should not be ignored. - Throws:
javax.security.auth.login.LoginException
- if the logout fails.