com.ibm.wsspi.security.common.auth.module
Class IdentityAssertionLoginModule
- java.lang.Object
com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule
- public class IdentityAssertionLoginModule
- extends java.lang.Object
- implements javax.security.auth.spi.LoginModule
Identity Assertion login module
A principal will be logged in if a trust is established. This login module considers trust to be established if the shared state contains a Map called com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.state. The Map should contain the following variables:
- com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.trust set to true
- com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.principal containing a java.Security.Principal to hold the login identity.
- OR com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.certificates containing a java.security.cert.X509Certificate[] to hold the login identity.
If all the variables are provided in the shared state then the identity be logged in.
Constructor Summary
Constructor and Description |
---|
IdentityAssertionLoginModule()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
abort()
Abort the authentication (second phase).
|
|
commit()
Commit the authentication (phase 2).
|
|
initialize(javax.security.auth.Subject subject,javax.security.auth.callback.CallbackHandler callbackHandler,java.util.Map sharedState,java.util.Map options)
Initialize this login module.
|
|
login()
Method to authenticate a Subject (first phase).
|
|
logout()
Logout the user
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
IdentityAssertionLoginModule
- public IdentityAssertionLoginModule( )
Method Detail
initialize
- 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
- The subject to be authenticated. callbackHandler
- A CallbackHandler
for communicating with the end user to gather login information (e.g., username and password). sharedState
- The state shared with other configured login modules. options
- The options specified in the login configuration for this particular login module. login
- public boolean login()
- throws WSLoginFailedException
Method to authenticate a Subject (first phase).
This method authenticates a Subject. It uses the Map stored in the shared state property com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.state. The com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.trusted key in the Map is used to determine trust. If true then trusted if false then it not trusted. When trust is established then the principal stored in either the com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.principal or com.ibm.wsspi.security.common.auth.module.IdentityAssertionLoginModule.certificates key will contain the identity to login as.
login
in interface javax.security.auth.spi.LoginModule
true
if the authentication succeeded, or false
if this login module should be ignored. WSLoginFailedException
- If the authentication fails. commit
- public boolean commit()
- throws WSLoginFailedException
If the login module authentication attempted in phase 1 succeeded, then relevant principals and credentials are associated with the subject. If the authentication attempted in phase 1 failed, then this method removes/destroys any state that was originally saved.
commit
in interface javax.security.auth.spi.LoginModule
WSLoginFailedException
- if the commit fails abort
- public boolean abort()
- throws javax.security.auth.login.LoginException
This method is called if the
If this login module's authentication attempt succeeded, then this method cleans up the previous state
saved in phase 1.
LoginContext
's overall authentication failed.
abort
in interface javax.security.auth.spi.LoginModule
javax.security.auth.login.LoginException
- if the abort fails logout
- public boolean logout()
- throws javax.security.auth.login.LoginException
The principals and credentials are removed from the Shared state.
logout
in interface javax.security.auth.spi.LoginModule
LoginModule
should not be ignored). javax.security.auth.login.LoginException
- if the logout fails
Initialize this login module.
This is called by the
LoginContext
after this login module is instantiated. The relevant information is passed from theLoginContext
to this login module. If the login module does not understands any of the data stored in thesharedState
andoptions
parameters, they can be ignored.