public class Krb5LoginModule
extends java.lang.Object
implements javax.security.auth.spi.LoginModule
A JAAS LoginModule
for acquiring Kerberos credentials.
Supported options (specified in a JAAS configuration file):
1) Kerberos options principal=principalName credsType=initiator|acceptor|both (default=initiator) forwardable=true|false (default=false) proxiable=true|false (default=false) renewable=true|false (default=false) useCcache=URL useKeytab=URL useDefaultCcache=true|false (default=false) useDefaultKeytab=true|false (default=false) 2) JAAS-suggested options: debug=true|false (default=unset, JGSS debug options used) tryFirstPass=true|false (default=false) useFirstPass=true|false (default=false) moduleBanner=true|false (default=false) NOTES: 1) Default realm (which is obtained from the Kerberos config file) is used if the principal specified does not include a realm component. 2) debug option: true is equivalent to com.ibm.jgss.debug=all false is equivalent to com.ibm.jgss.debug=off The debug option affects debug from the Login module only; other subcomponents of JGSS are not affected. 3) Boolean options can be set to "true" or "yes", "false" or "no" 4) The keytab and ccache options take precedence over tryFirstPass. If a keytab or ccache option is set in addition to tryFirstPass, the keytab or ccache is used and the principal saved in the shared state if login is succesful. There will be no prompting for password if the login fails. 5) The keytab and ccache options are incompatible with the useFirstPass option; specifying useFirstPass in conjunction with either a keytab or ccache option will cause an exception to be thrown. 6) From the Java 1.4 JAAS guide: try_first_pass - If true, the first LoginModule in the stack saves the password entered, and subsequent LoginModules also try to use it. If authentication fails, the LoginModules prompt for a new password and retry the authentication. use_first_pass - If true, the first LoginModule in the stack saves the password entered, and subsequent LoginModules also try to use it. LoginModules do not prompt for a new password if authentication fails (authentication simply fails). moduleBanner - If true, then when invoking the CallbackHandler, the LoginModule provides a TextOutputCallback as the first Callback, which describes the LoginModule performing the authentication. debug - If true, instructs a LoginModule to output debugging information.
Constructor and Description |
---|
Krb5LoginModule() |
Modifier and Type | Method and Description |
---|---|
boolean |
abort()
Abort the login
|
boolean |
commit()
commit the login for user
|
void |
initialize(javax.security.auth.Subject subject,
javax.security.auth.callback.CallbackHandler callbackHandler,
java.util.Map sharedState,
java.util.Map options) |
boolean |
login()
login
|
boolean |
logout()
Logout the user.
|
public void initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map sharedState, java.util.Map options)
initialize
in interface javax.security.auth.spi.LoginModule
subject
- callbackHandler
- sharedState
- options
- public boolean login() throws javax.security.auth.login.LoginException
login
in interface javax.security.auth.spi.LoginModule
LoginException!
javax.security.auth.login.LoginException
public boolean commit() throws javax.security.auth.login.LoginException
commit
in interface javax.security.auth.spi.LoginModule
javax.security.auth.login.LoginException
public boolean abort() throws javax.security.auth.login.LoginException
abort
in interface javax.security.auth.spi.LoginModule
LoginException.
javax.security.auth.login.LoginException
public boolean logout() throws javax.security.auth.login.LoginException
This method removes the Principal
that was added by the
commit
method.
logout
in interface javax.security.auth.spi.LoginModule
LoginModule
should not
be ignored.javax.security.auth.login.LoginException
- if the logout fails.© Portions Copyright 2003, 2015 IBM Corporation. All rights reserved.
© Portions Copyright 2003, 2015, Oracle and/or its affiliates. All rights reserved.