WSSecurityMappingModule (IBM WebSphere Application Server, Release 9.0)

java.lang.Object
- com.ibm.wsspi.wssecurity.auth.module.WSSecurityMappingModule

All Implemented Interfaces:

Constants, javax.security.auth.spi.LoginModule

Direct Known Subclasses:

IDAssertionLoginModule, SignatureLoginModule

Deprecated.
```
public class WSSecurityMappingModule
extends java.lang.Object
implements javax.security.auth.spi.LoginModule, Constants
```
This Login Module will take a DN and check if it is present in the user registry in order to validate it.

This is not a standalone Login Module, it must be configured after the pluggable JAAS Login Module. The pluggable token JAAS Login Module must save the validated DN in the shared state hash map passed in the initialize method and the key used is com.ibm.wsspi.wssecurity.Constants.WSSECURITY_DN.

Version:

5.02

See Also:
LoginModule, Constants, WSCredential

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.ibm.websphere.security.cred.WSCredential`	`wscred` Deprecated. wscred is no longer used.
`protected com.ibm.websphere.security.auth.WSPrincipal`	`wsprin` Deprecated. wsprin is no longer used.

Fields inherited from interface com.ibm.wsspi.wssecurity.Constants
WSSECURITY_ADD_NONCE, WSSECURITY_ADD_TIMESTAMP, WSSECURITY_BASIC_AUTH_TOKEN, WSSECURITY_CALLER_TOKEN_LN, WSSECURITY_CALLER_TOKEN_NS, WSSECURITY_CBIND, WSSECURITY_CDD, WSSECURITY_CHECK_HMAC_OUTPUT_LENGTH, WSSECURITY_CRED, WSSECURITY_DATA_ENCRYPTION_ALGORITHM, WSSECURITY_DAYS_BEFORE_EXPIRE_WARNING_KEYS, WSSECURITY_DECOUPLE_TOKEN, WSSECURITY_DIGEST_ALGORITHM, WSSECURITY_DN, WSSECURITY_GET_MUSTUNDERSTAND, WSSECURITY_INCLUSIVE_NAMESPACES, WSSECURITY_INITIAL_SENDER_CERT, WSSECURITY_INITIAL_SENDER_ID, WSSECURITY_ISSUER_NAME, WSSECURITY_ISSUER_SERIAL, WSSECURITY_KEY_EMBID, WSSECURITY_KEY_EMIT_ENCODING_TYPE, WSSECURITY_KEY_ENCODING, WSSECURITY_KEY_ENCODING_LN, WSSECURITY_KEY_ENCODING_NS, WSSECURITY_KEY_ENCRYPTION_ALGORITHM, WSSECURITY_KEY_ID, WSSECURITY_KEY_IDTYPE, WSSECURITY_KEY_IDTYPE_LN, WSSECURITY_KEY_IDTYPE_NS, WSSECURITY_KEY_ISSUERNAME, WSSECURITY_KEY_ISSUERSERIAL, WSSECURITY_KEY_NAME, WSSECURITY_KEY_NAMEREF, WSSECURITY_KEY_REFERENCE, WSSECURITY_KEY_TYPE, WSSECURITY_KEY_VALUETYPE, WSSECURITY_KEY_VALUETYPE_LN, WSSECURITY_KEY_VALUETYPE_NS, WSSECURITY_KEYINFO_TOKEN_REFERENCE, WSSECURITY_KEYINFO_TYPE, WSSECURITY_MESSAGE_CONTEXT, WSSECURITY_NONCE_CACHE_TIMEOUT, WSSECURITY_NONCE_CLOCK_SKEW, WSSECURITY_NONCE_MAX_AGE, WSSECURITY_RSAOAEP_DIGEST_METHOD, WSSECURITY_RSAOAEP_PARAMS, WSSECURITY_SET_MUSTUNDERSTAND, WSSECURITY_SIGNATURE_ALGORITHM, WSSECURITY_SUBJECT, WSSECURITY_TIMESTAMP_CLOCK_SKEW, WSSECURITY_TIMESTAMP_DIALECT, WSSECURITY_TIMESTAMP_KEYWORD, WSSECURITY_TIMESTAMP_MAX_AGE, WSSECURITY_TIMESTAMP_SOAPHEADER, WSSECURITY_TIMESTAMP_TIMEOUT, WSSECURITY_TOKEN_LOGININFO, WSSECURITY_TOKEN_PROPERGATION, WSSECURITY_TOKEN_WSSSUBJECT, WSSECURITY_USE_IDASSERTION, WSSECURITY_USE_RUNASIDENTITY, WSSECURITY_VERIFY_NONCE, WSSECURITY_VERIFY_TIMESTAMP, WSSECURITY_WSSCONSUMER_CONFIG_KEY, WSSECURITY_WSSGENERATOR_CONFIG_KEY, WSSECURITY_XPATH_EXPRESSION, WSSECURITY_XPATH2_EXPRESSION, WSSECURITY_XPATH2_FILTER, WSSECURITY_XPATH2_ORDER

Constructor Summary

Constructors
Constructor and Description

WSSecurityMappingModule()
Deprecated.

Constructors
Constructor and Description
`WSSecurityMappingModule()` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`abort()` Deprecated. Aborts the login process by removing the WSPrincipal and WSCredential from the Subect.
`boolean`	`commit()` Deprecated. Commits the login process by adding the WSPrincipal and WSCredential into the Subject.
`void`	`initialize(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map sharedState, java.util.Map options)` Deprecated. Intializes this LoginModule.
`boolean`	`login()` Deprecated. Logs in to the login process.
`boolean`	`logout()` Deprecated. Logs out the login process.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - wscred
```
protected com.ibm.websphere.security.cred.WSCredential wscred
```
    Deprecated. wscred is no longer used.
  - wsprin
```
protected com.ibm.websphere.security.auth.WSPrincipal wsprin
```
    Deprecated. wsprin is no longer used.
- Constructor Detail
  - WSSecurityMappingModule
```
public WSSecurityMappingModule()
```
    Deprecated.
- 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)
```
    Deprecated.
    
    Intializes this LoginModule.
    
    Specified by:
    
    initialize in interface javax.security.auth.spi.LoginModule
    
    Parameters:
    subject - The Subject to be authenticated.
    callbackHandler - The CallbackHandler used to gather login data from the user.
    sharedState - State data shared between login modules.
    options - A Map of key-value pairs specifying configuration options for this login module.
    See Also:
    LoginModule.initialize(Subject, CallbackHandler, Map, Map)
  - login
```
public boolean login()
              throws javax.security.auth.login.LoginException
```
    Deprecated.
    
    Logs in to the login process.
    
    Specified by:
    
    login in interface javax.security.auth.spi.LoginModule
    
    Returns:
    true if the login is successful, false otherwise
    
    Throws:
    
    javax.security.auth.login.LoginException - if the login fails
    See Also:
    LoginModule.login()
  - commit
```
public boolean commit()
               throws javax.security.auth.login.LoginException
```
    Deprecated.
    
    Commits the login process by adding the WSPrincipal and WSCredential into the Subject.
    
    Specified by:
    
    commit in interface javax.security.auth.spi.LoginModule
    
    Returns:
    true if the commit is successful, false otherwise
    
    Throws:
    
    javax.security.auth.login.LoginException - if the commit fails
    See Also:
    LoginModule.commit()
  - abort
```
public boolean abort()
              throws javax.security.auth.login.LoginException
```
    Deprecated.
    
    Aborts the login process by removing the WSPrincipal and WSCredential from the Subect.
    
    Specified by:
    
    abort in interface javax.security.auth.spi.LoginModule
    
    Returns:
    true if the abort was successful, false otherwise
    
    Throws:
    
    javax.security.auth.login.LoginException - if the abort fails
    See Also:
    LoginModule.abort()
  - logout
```
public boolean logout()
               throws javax.security.auth.login.LoginException
```
    Deprecated.
    
    Logs out the login process.
    
    Specified by:
    
    logout in interface javax.security.auth.spi.LoginModule
    
    Returns:
    true if the logout is successful, false otherwise
    
    Throws:
    
    javax.security.auth.login.LoginException - if the abort fails
    See Also:
    LoginModule.logout()

Fields inherited from interface com.ibm.wsspi.wssecurity.Constants

Methods inherited from class java.lang.Object

wscred

wsprin

WSSecurityMappingModule

initialize

login

commit

abort

logout