Callback handler settings

Use this page to configure callback handler settings, which determine how security tokens are acquired from message headers.

You can configure callback handler settings when you are editing a general cell-level or server-level binding. You can also configure application specific bindings for tokens and message parts that are required by the policy set.

To view this administrative console page when you are editing a general cell-level binding, complete the following actions:
  1. Click Services > Policy sets > Default policy set bindings. The bindings panel indicates which binding is set as the default binding, for example, the Provider sample binding.
  2. To edit this default binding, click Services > Policy sets > General provider policy set bindings.
  3. Click the name of the default binding as determined in the first step. For example, Provider sample.
  4. Click the WS-Security policy in the Policies table.
  5. Click the Authentication and protection link in the Main message security policy bindings section.
  6. Click the name_of_token link in the Protection tokens section or the Authentication tokens section.
  7. Click the Callback handler link.
To view this administrative console page when you are configuring application specific bindings for tokens and message parts that are required by the policy set, complete the following actions:
  1. Click Applications > Application Types > WebSphere enterprise applications.
  2. Select an application that contains Web services. The application must contain a service provider or a service client.
  3. Click the Service provider policy sets and bindings link or the Service client policy sets and bindings in the Web Services Properties section.
  4. Select a binding. You must have previously attached a policy set and assigned an application specific binding.
  5. Click the WS-Security policy in the Policies table.
  6. Click the Authentication and protection link in the Main message security policy bindings section.
  7. Click the name_of_token link in the Protection tokens section or the Authentication tokens section.
  8. Click the Callback handler link.

This administrative console panel applies only to Java™ API for XML Web Services (JAX-WS) applications.

The Callback Handler displays fields differently for different tokens being configured. Depending on whether you are configuring generator or consumer tokens for protection or you are configuring inbound or outbound tokens for authentication, the sections and fields on this panel display some or all of the fields explained in this topic, as noted in the description of each field.

Class name

The fields in the Class name section are available for all types of token configuration.

Select the class name to use for the callback handler. Select the Use built-in default option for normal operation. Use the Use custom option only if you are using a custom token type.

For the Kerberos custom token type, use the class name, com.ibm.websphere.wssecurity.callbackhandler.KRBTokenGenerateCallbackHandler, for token generator configuration. Use com.ibm.websphere.wssecurity.callbackhandler.KRBTokenConsumeCallbackHandler for token consumer configuration.

Use built-in default

Specifies that the default value is used for the class name. Use the default value (shown in the field) for the class name when you select this radio button. This name is based on the token type and whether the callback handler is for a token generator or a token consumer. This option is mutually exclusive to the Use custom option.

Use custom

Specifies that a custom value is used for the class name. Select this radio button and enter the name in the field to use a custom class name.

No default value is available for this entry field. Use the information in the following table to determine this value:

Table 1. Custom class names for the callback handler and associated token types. The callback handler determines how security tokens are acquired from message headers.
Token Type Consumer or Generator Callback Handler Class Name
UsernameToken consumer com.ibm.websphere.wssecurity.callbackhandler.UNTConsumeCallbackHandler
UsernameToken generator com.ibm.websphere.wssecurity.callbackhandler.UNTGenerateCallbackHandler
X509Token consumer com.ibm.websphere.wssecurity.callbackhandler.X509ConsumeCallbackHandler
X509Token generator com.ibm.websphere.wssecurity.callbackhandler.X509GenerateCallbackHandler
LTPAToken/LTPAPropagationToken consumer com.ibm.websphere.wssecurity.callbackhandler.LTPAConsumeCallbackHandler
LTPAToken/LTPAPropagationToken generator com.ibm.websphere.wssecurity.callbackhandler.LTPAGenerateCallbackHandler
SecureConversationToken consumer com.ibm.ws.wssecurity.impl.auth.callback.SCTConsumeCallbackHandler
SecureConversationToken generator com.ibm.ws.wssecurity.impl.auth.callback.WSTrustCallbackHandler

This button is mutually exclusive to the Use built-in default option.

Certificates (generator)

The fields in the Certificates section are available if you are configuring a protection token. For a generator token, you can click to select a certificate store from the listing, or click the New button to add a certificate store.

Certificates (consumer)

The fields in the Certificates section are available if you are configuring a protection token. For a consumer token, you can use the Trust any certificate option, or the Certificate store option, to configure the certificate store.

Certificates - Trust any certificate (consumer)

This option is applicable only to the token consumer. This option indicates that the system will trust all certificates, and does not define a specific certificate store. This option is mutually exclusive to the Certificate store option.

Certificates - Certificate store (consumer)

This option is applicable only the to the token consumer. Use this option to specify a certificate store collection containing intermediate certificates, which can include certificate revocation lists (CRLs). Select this option to trust the certificate store or stores specified in the entry field. This option is mutually exclusive to the Trust any certificate option. When you select the Certificate store option, the New button is enabled so that you can configure a new certificate store and trusted anchor store.

You can set the value of the certificate store field to the default value, which is None. However, the trusted anchor store value must be set to a specific value. There is no default value. The trusted anchor is required if the Trust any certificate option is not selected.

Basic authentication

The fields in the Basic authentication section are available if you are configuring an authentication token that is not an LTPA propagation token.

For the Kerberos custom token type, you must complete the Basic Authentication section for the Kerberos login.

User name

Specifies the user name that you want to authenticate.

Password

Specifies the password to be authenticated. Enter a password to authenticate in this entry field.

Confirm password

Specifies the password that you want to confirm.

Keystore

The fields in the Keystore section are available if you are configuring a protection token.

In the Keystore name list, you can click Custom to define a custom keystore, click one of the externally defined keystore names, or click None if no keystore is required.

Keystore - Name

Specifies the name of the centrally managed keystore file that you want to use.

Click the name of a centrally managed keystore name from this menu or enter one of the following values:
NodeDefaultKeyStore
NodeDefaultTrustStore
NodeLTPAKeys
None
Specifies to not use a centrally managed keystore file.
Custom
Specifies to use the centrally managed keystore file. Click the Custom keystore configuration link to configure custom keystore and key settings.

Keystore - Custom keystore configuration

Specifies a link to create a custom keystore. Click this link to open a panel where you can configure a custom keystore.

Key

The fields in the Key section are available if you are configuring a protection token.

Name

Specifies the name of the key to use. Enter the name of the key to be used in this required field.

Alias

Specifies the alias name of the key that you want to use. Enter the alias of the name of the key to use in this required field.

Password

Specifies the password for the key that you want to use.

You cannot set a password for public keys for asymmetric encryption generator or asymmetric signature consumer.

Confirm password

Specifies the confirmation of the password for the key that you want to use. Enter the password that you entered in the Password field to confirm.

Do not provide a key confirm password for public keys for asymmetric outbound encryption or inbound signature.

Custom properties

The fields in the Custom properties section are available for all types of token configuration.

You can add custom properties needed by the callback handler using name-value pairs.

To implement signer certificate encryption when using the JAX-WS programming model, add the custom property com.ibm.wsspi.wssecurity.token.cert.useRequestorCert with the value true on the callback handler of the encryption token generator. This implementation uses the certificate of the signer of the SOAP request to encrypt the SOAP response. This custom property is used by the response generator.

For a Kerberos custom token based on OASIS Web Services Security Specification for Kerberos Token Profile V1.1, specify the following property for token generation: com.ibm.wsspi.wssecurity.krbtoken.clientRealm. This specifies the name of the Kerberos realm associated with the client and allows the Kerberos client realm to initiate the Kerberos login. If not specified, the default Kerberos realm name is used. This property is optional for a single Kerberos realm environment. When implementing Web services security in a cross or trusted Kerberos realm environment, you must provide a value for the clientRealm property.

The Kerberos custom property, com.ibm.wsspi.wssecurity.krbtoken.loginPrompt, enables the Kerberos login when the value is true. The default value is False. This property is optional.

When configuring a username token for the JAX-WS programming model, to protect against replay attacks it is strongly recommended that you add the following custom properties to the callback handler configuration. These custom properties enable and verify the nonce and timestamp for message authentication.
Property name (generator) Property value
com.ibm.wsspi.wssecurity.token.username.addNonce true
com.ibm.wsspi.wssecurity.token.username.addTimestamp true
Property name (consumer) Property value
com.ibm.wsspi.wssecurity.token.username.verifyNonce true
com.ibm.wsspi.wssecurity.token.username.verifyTimestamp true

Name

Specifies the name of the custom property to use.

Custom properties are not initially displayed in this column. Click one of the following actions for custom properties:

Button Resulting action
New Creates a new custom property entry. To add a custom property, enter the name and value.
Delete Removes the selected custom property.

Value

Specifies the value of the custom property to use. With the Value entry field, you can enter or delete the value for a custom property.




Subtopics
Related tasks
Defining and managing policy set bindings
Managing policy sets using the administrative console
Related reference
Protection token settings (generator or consumer)
Application policy sets collection
Application policy set settings
Search attached applications collection
Policy set bindings settings
WS-Security authentication and protection
Reference topic    

Terms of Use | Feedback

Last updated: Oct 22, 2010 12:21:29 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=compass&product=was-nd-zos&topic=uwbs_wsspsbch
File name: uwbs_wsspsbch.html