com.ibm.crypto.pkcs11impl.module
Class PKCS11LoginModule
- java.lang.Object
com.ibm.crypto.pkcs11impl.module.PKCS11LoginModule
Deprecated.
- public class PKCS11LoginModule
- extends java.lang.Object
- implements javax.security.auth.spi.LoginModule
This LoginModule interacts with a hardware cryptographic device
to login a user. Than the module creates a PKCS11 session and
associates it with a PKCS11Principal. Finally, the
PKCS11Principal is associated with a Subject.
This LoginModule requires CallbackHandlers.
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.
LoginModule,
TextInputCallback,
PasswordCallback,
LoginContextConstructor Summary
| Constructor and Description |
|---|
PKCS11LoginModule()
Deprecated.
|
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
abort()
Deprecated.
|
|
commit()
Deprecated.
|
|
initialize(javax.security.auth.Subject subject,javax.security.auth.callback.CallbackHandler callbackHandler,java.util.Map sharedState,java.util.Map options)
Deprecated.
|
|
login()
Deprecated.
|
|
logout()
Deprecated.
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
PKCS11LoginModule
- public PKCS11LoginModule()
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 (prompting for PKCS11 Library colon slot
(such as cryptoki.dll:0) and PIN. 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
cryptoki.dll:0, and PIN.
login in interface javax.security.auth.spi.LoginModule
LoginModule
should not be ignored. javax.security.auth.login.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 PKCS11Principal
with the Subject located in the
LoginModuleContext. If this LoginModule's own
authentication attempted failed, then this method removes
any state that was originally saved.
commit in interface javax.security.auth.spi.LoginModule
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.
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
This method removes the PKCS11Principal,
that may have been 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.
LoginModule.