Configure the bindings for message protection for Kerberos

Configure the bindings for message protection for Kerberos

To set up bindings for message protection with JAX-WS applications, create a custom binding. Complete this task to set the bindings for a Kerberos token as defined in the OASIS Web Services Security Specification for Kerberos Token Profile Version 1.1.

Configure Kerberos for IBM WAS. See Kerberos (KRB5) authentication mechanism support for security. In addition, configure the Kerberos token policy set for JAX-WS applications. See Configuring the Kerberos token policy set for JAX-WS applications.

We can leverage existing frameworks including the policy set and bindings for JAX-WS applications.

We can configure a symmetric protection token or an authentication token. Both symmetric protection token and authentication token configurations use similar configuration data. However, we do not need to configure the authentication token if we intend to use a Kerberos symmetric protection token. For whichever token type we use, configure the token generator and the token consumer as indicated in the following list:

Symmetric protection token

Token generator
Token consumer

Authentication token

Token generator
Token consumer

Use the administrative console to configure the application-specific bindings to use a Kerberos token in web services message protection.

Tasks

Expand Applications > Application Types.
Click WebSphere enterprise applications > application name .
From the Web Services Properties heading, click Service provider policy sets and bindings to configure the service bindings or click Service client policy sets and bindings to configure the client bindings.
Select the resource to attach to the Kerberos token policy set and select Attach Policy Set > policy set name. To configure the Kerberos token policy set, see Configure the Kerberos token policy set for JAX-WS applications.
Click Assign bindings and select the application-specific binding or select New Application Specific Binding to create a new binding. To create a new binding.

Enter a name for the new binding in the Binding configuration name field and optionally enter a description for the binding in the Description field.
Click Add and select WS-Security to specify a new policy set.
Click Authentication and protection > New.
Optional: Define a symmetric protection token for the token generator.
If we configure a symmetric protection token for the token generator, define a complimentary symmetric protection token for the token consumer.

From the Protection tokens heading, click New and select Token Generator.
Specify the name of the protection token in the Name field.
Select Custom from the values in the Token type menu list.
Specify the local name value in the Local name field.
For interoperability with other web services technologies, specify the following local name: http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ. If we are not concerned with interoperability issues, we can specify one of the following local name values:

http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ4120
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ4120

These alternative values depend on the specification level for the Kerberos token generated by the Key Distribution Center (KDC). For more information about when to use these values, see Protection token settings (generator or consumer).

Do not specify a value for the Namespace URI field.
Select the wss.generate.KRB5BST Login module settings for JAASalue from the JAAS login menu list.
If we have previously defined our own JAAS login module, we can select your login module to handle the Kerberos custom token. To define a custom JAAS login module, click New Application Login > New, specify an alias for the new module, and click Apply. See Login module settings for Java Authentication and Authorization Service.
Although the information in the topic refers to security and not Web Services Security, the configuration for a login module for Web Services Security is identical to security.
Token generator custom properties for the target service name, host, and realm.
The combination of the target service name and host values forms the Service Principal Name (SPN), which represents the target Kerberos service principal name. The Kerberos client requests the initial Kerberos AP_REQ token for the SPN. Specify the following custom properties.

Name Value Type
com.ibm.wsspi.wssecurity.krbtoken.targetServiceName Specify the name of the target service. Required
com.ibm.wsspi.wssecurity.krbtoken.targetServiceHost Specify the host name associated with the target service in the following format: myhost.mycompany.com Required
com.ibm.wsspi.wssecurity.krbtoken.targetServiceRealm Specify the name of the realm associated with the target service. ¹
To use Kerberos token security in a cross or trusted realm environment, provide a value for the targetServiceRealm property.
To specify multiple custom property name and value pairs, click New.

Click Apply.
From the Additional bindings heading, click Callback handler.
From the Class Name heading, select the Use custom option and specify com.ibm.websphere.wssecurity.callbackhandler.KRBTokenGenerateCallbackHandler in the associated field.
From the Basic Authentication heading, specify the appropriate values for the User name, Password, and Confirm password fields.
The user name specifies the default user ID that is passed to the constructor of the callback handler; for example, kerberosuser.

Token generator custom properties for Kerberos client principal name and password to initiate the Kerberos login.
These custom properties control the prompt and establish the token based on the credential cache. Specify the following custom properties.

Name Value Type
com.ibm.wsspi.wssecurity.krbtoken.loginPrompt Enable the Kerberos login when the value is True. The default is False. Optional

To specify multiple custom property name and value pairs, click New.

Click Apply and OK.
When we return to the Authentication and protection panel in the next step, a new protection token is defined for the token generator. To edit the configuration for this new token, click its name on the panel.
Optional: Return to the Authentication and protection panel to define a symmetric protection token for the token consumer. To return to the Authentication and protection panel, click the Authentication and protection link after the messages section of the panel.
If we configure a symmetric protection token for the token consumer, ensure that we have previously defined a complimentary symmetric protection token for the token generator.

From the Protection tokens heading, click New and select Token Consumer.
Specify the name of the protection token in the Name field.
Select Custom from the values in the Token type menu list.
Specify the local name value in the Local name field.
For interoperability with other web services technologies, specify the following local name: http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ. If we are not concerned with interoperability issues, we can specify one of the following local name values:

http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ4120
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ4120

These alternative values depend on the specification level for the Kerberos token generated by the Key Distribution Center (KDC). For more information about when to use these values, see Protection token settings (generator or consumer).

Do not specify a value for the Namespace URI field.
Select the wss.consume.KRB5BST value from the JAAS login drop-down menu.
If we have previously defined our own JAAS login module, we can select this login module to handle the Kerberos custom token. To define a custom JAAS login module, click New Application Login > New, specify an alias for the new module, and click Apply. See Login module settings for Java Authentication and Authorization Service.
Although the information in the Login module settings for Java Authentication and Authorization Service topic refers to security and not Web Services Security, the configuration for a login module for Web Services Security is identical to security.
Click Apply.
From the Additional bindings heading, click Callback handler.
From the Class Name heading, select the Use custom option and specify com.ibm.websphere.wssecurity.callbackhandler.KRBTokenConsumeCallbackHandler in the associated field.
Click Apply and OK.
When we return to the Authentication and protection panel in the next step, we will see a new protection token defined for the token consumer. To edit the configuration for this new token, click its name on the panel.
Optional: Return to the Authentication and protection panel to define an authentication token configuration for the token generator. To return to the Authentication and protection panel, click the Authentication and protection link after the messages section of the panel.
Authentication tokens are sent in messages to prove or assert an identity.

If we configure an authentication token for the token generator, define a complimentary authentication token for the token consumer.

From the Authentication tokens heading, click New and select Token Generator.
Specify the name of the authentication token in the Name field.
Select Custom from the values in the Token type menu list.
Specify the local name value in the Local name field.
For interoperability with other web services technologies, specify the following local name: http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ. If we are not concerned with interoperability issues, we can specify one of the following local name values:

http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ4120
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ4120

These alternative values depend on the specification level for the Kerberos token generated by the Key Distribution Center (KDC). For more information about when to use these values, see Authentication generator or consumer token settings.

Do not specify a value for the Namespace URI field.
Select the wss.generate.KRB5BST value from the JAAS login menu list.
If we have previously defined our own JAAS login module, we can select this login module to handle the Kerberos custom token. To define a custom JAAS login module, click New Application Login > New, specify an alias for the new module, and click Apply. See Login module settings for Java Authentication and Authorization Service.
Although the information in the Login module settings for Java Authentication and Authorization Service topic refers to security and not Web Services Security, the configuration for a login module for Web Services Security is identical to security.
Token generator custom properties for the target service name, host, and realm.
The combination of the target service name and host values forms the Service Principal Name (SPN), which represents the target Kerberos service principal name. The Kerberos client requests the initial Kerberos AP_REQ token for the SPN. Specify the following custom properties.

Name Value Type
com.ibm.wsspi.wssecurity.krbtoken.targetServiceName Specify the name of the target service. Required
com.ibm.wsspi.wssecurity.krbtoken.targetServiceHost Specify the host name associated with the target service in the following format: myhost.mycompany.com Required
com.ibm.wsspi.wssecurity.krbtoken.targetServiceRealm Specify the name of the realm associated with the target service. Optional

To specify multiple custom property name and value pairs, click New.

Click Apply.
From the Additional bindings heading, click Callback handler.
From the Class Name heading, select the Use custom option and specify com.ibm.websphere.wssecurity.callbackhandler.KRBTokenGenerateCallbackHandler in the associated field.
From the Basic Authentication heading, specify the appropriate values for the User name, Password, and Confirm password fields.
The user name specifies the default user ID that is passed to the constructor of the callback handler. For example: kerberosuser

Token generator custom properties for Kerberos client principal name and password to initiate the Kerberos login.
These custom properties control the prompt and establish the token based on the credential cache. Specify the following custom properties name and value pairs.

Name Value Type
com.ibm.wsspi.wssecurity.krbtoken.loginPrompt Enable the Kerberos login when the value is True. The default is False. Optional
com.ibm.wsspi.wssecurity.krbtoken.clientRealm Specify the name of the Kerberos realm associated with the client ²
When implementing Web Services Security in a cross or trusted Kerberos realm environment, provide a value for the clientRealm property.
If an application generates or consumes a Kerberos V5 AP_REQ token for each web services request message, set the com.ibm.wsspi.wssecurity.kerberos.attach.apreq custom property to true in the token generator and the token consumer bindings for the application

To specify multiple custom property name and value pairs, click New.

Click Apply and OK.
When we return to the Authentication and protection panel in the next step, we will see a new authentication token is defined for the token generator. To edit the configuration for this new token, click its name on the panel.
Optional: Return to the Authentication and protection panel to define an authentication token configuration for the token consumer. To return to the Authentication and protection panel, click the Authentication and protection link after the messages section of the panel.
If we configure an authentication token for the token consumer, ensure that we have previously defined an authentication token for the token generator.

From the Authentication tokens heading, click New and select Token Consumer.
Specify the name of the authentication token in the Name field.
Select Custom from the values in the Token type menu list.
Specify the local name value in the Local name field.
For interoperability with other web services technologies, specify the following local name: http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ. If we are not concerned with interoperability issues, we can specify one of the following local name values:

http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ1510
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#Kerberosv5_AP_REQ4120
http://docs.oasis-open.org/wss/oasis-wss-kerberos-token-profile-1.1#GSS_Kerberosv5_AP_REQ4120

These alternative values depend on the specification level for the Kerberos token generated by the Key Distribution Center (KDC). For more information conditions under which to use these values, see the related link for the Authentication generator or consumer token settings topic.

Do not specify a value for the Namespace URI field.
Select the wss.consume.KRB5BST value from the JAAS login drop-down menu.
If we have previously defined our own JAAS login module, we can select this login module to handle the Kerberos custom token. To define a custom JAAS login module, click New Application Login > New, specify an alias for the new module, and click Apply. See Login module settings for Java Authentication and Authorization Service.
Although the information in the Login module settings for Java Authentication and Authorization Service topic refers to security and not Web Services Security, the configuration for a login module for Web Services Security is identical to security.
Click Apply.
From the Additional bindings heading, click Callback handler.
From the Class Name heading, select the Use custom option and specify com.ibm.websphere.wssecurity.callbackhandler.KRBTokenConsumeCallbackHandler in the associated field.
Click Apply and OK.
When we return to the Authentication and protection panel in the next step, we will see a new authentication token is defined for the token consumer. To edit the configuration for this new token, click its name on the panel.

What to do next

We can optionally define key bindings for the request message protection and response message protection. If we choose to derive a key from the Kerberos token, configure the derived key information when we configure the key information for signature and encryption.

Return to the steps in the Configuring the Kerberos token for Web Services Security topic to ensure we have completed the steps for configuring the Kerberos token.

Related:

General JAX-WS default bindings for Web Services Security
Configure the Kerberos token policy set for JAX-WS applications
Configure Kerberos as the authentication mechanism
Protection token settings (generator or consumer)
Login module settings for JAAS
Authentication generator or consumer token settings
¹ Optional: If the targetServiceRealm property is not specified, the default realm name from the Kerberos configuration file is used as the realm name.
² Optional: The clientRealm property is optional for a single Kerberos realm environment.

Name	Value	Type
com.ibm.wsspi.wssecurity.krbtoken.targetServiceName	Specify the name of the target service.	Required
com.ibm.wsspi.wssecurity.krbtoken.targetServiceHost	Specify the host name associated with the target service in the following format: myhost.mycompany.com	Required
com.ibm.wsspi.wssecurity.krbtoken.targetServiceRealm	Specify the name of the realm associated with the target service.	¹

Name	Value	Type
com.ibm.wsspi.wssecurity.krbtoken.loginPrompt	Enable the Kerberos login when the value is True. The default is False.	Optional
com.ibm.wsspi.wssecurity.krbtoken.clientRealm	Specify the name of the Kerberos realm associated with the client	²