+

Search Tips   |   Advanced Search

Encryption information settings: Message parts


To configure the encryption and decryption parameters. Use these parameters to encrypt and decrypt various parts of the message, including the body and the token.

To view the admin console panel for the encryption information on the cell level...

  1. Click Security > JAX-WS and JAX-RPC security runtime.

  2. Under either JAX-RPC Default Generator Bindings or JAX-RPC Default Consumer Bindings, click Encryption information.

  3. Click New to create a new encryption configuration or click the name of an existing encryption configuration.

To view the admin console panel for the encryption information on the server level...

  1. Click Servers > Server Types > WebSphere appservers > server_name.

  2. Under Security, click JAX-WS and JAX-RPC security runtime.

    In a mixed node cell with a server using Websphere Application Server version 6.1 or earlier, click Web services: Default bindings for WS-Security

  3. Under either JAX-RPC Default Generator Bindings or JAX-RPC Default Consumer Bindings, click Encryption information.

  4. Click New to create a new encryption configuration or click the name of an existing encryption configuration.

To view this admin console page for the encryption information on the application level...

  1. Click Applications > Application Types > WebSphere enterprise apps > application_name.

  2. Under Modules, click Module update > module_name.

  3. Under WS-Security Properties, we can access encryption information for the following bindings:

    • For the Request generator, click Web services: Client security bindings. Under Request generator (sender) binding, click Edit custom. Under Required properties, click Encryption information.

    • For the Request consumer, click Web services: WAS security bindings. Under Request consumer (receiver) binding, click Edit custom. Under Required properties, click Encryption information.

    • For the Response generator, click Web services: WAS security bindings. Under Response generator (sender) binding, click Edit custom. Under Required properties, click Encryption information.

    • For the Response consumer, click Web services: Client security bindings. Under Response consumer (receiver) binding, click Edit custom. Under Required properties, click Encryption information.

  4. Click either New to create a new encryption configuration or click the name of an existing encryption configuration.

Encryption information name

Name for the encryption information.

Data type String

Data encryption algorithm

Algorithm URI of the data encryption method.

The following algorithms are supported:

By default, the JCE is shipped with restricted or limited strength ciphers. To use 192-bit and 256-bit Advanced Encryption Standard (AES) encryption algorithms, apply unlimited jurisdiction policy files. For more information, see the Key encryption algorithm field description.

Key locator reference

Name of the key locator configuration that retrieves the key for XML digital signature and XML encryption.

The Key locator reference field is displayed for the request receiver and response receiver bindings, which are used by V5.x applications.

Configure these key locator reference options on the server level, the cell level, and the application level. The configurations that are listed in the field are a combination of the configurations on these three levels.

We can specify an encryption key configuration for the following bindings on the following levels:


Table 1. Encryption key binding configurations

Binding name Server level, cell level, or application level Path
Default generator binding Cell level

  1. Click Security > JAX-WS and JAX-RPC security runtime.

  2. Under Additional properties, click Key locators.
Default consumer bindings Cell level

  1. Click Security > JAX-WS and JAX-RPC security runtime.

  2. Under Additional properties, click Key locators.
Default generator binding Server level

  1. Click Servers > Server Types > WebSphere appservers > server_name.

  2. Under Security, click JAX-WS and JAX-RPC security runtime.

    In a mixed node cell with a server using Websphere Application Server version 6.1 or earlier, click Web services: Default bindings for WS-Security

  3. Under Additional properties, click Key locators.
Default consumer binding Server level

  1. Click Servers > Server Types > WebSphere appservers > server_name.

  2. Under Security, click JAX-WS and JAX-RPC security runtime.

    In a mixed node cell with a server using Websphere Application Server version 6.1 or earlier, click Web services: Default bindings for WS-Security

  3. Under Additional properties, click Key locators.
Request sender Application level

  1. Click Applications > Application Types > WebSphere enterprise apps > application_name.

  2. Under Modules, click Manage modules > URI_name.

  3. Click Web services: Client security bindings. Under Request sender binding, click Edit.

  4. Under Additional properties, click Key locators.
Request receiver Application level

  1. Click Applications > Application Types > WebSphere enterprise apps > application_name.

  2. Under Modules, click Manage modules> URI_name.

  3. Click Web services: WAS security bindings. Under Request receiver binding, click Edit.

  4. Under Additional properties, click Key locators.
Response sender Application level

  1. Click Applications > Application Types > WebSphere enterprise apps > application_name.

  2. Under Modules, click Manage modules> URI_name.

  3. Click Web services: WAS security bindings. Under Response sender binding, click Edit.

  4. Under Additional properties, click Key locators.
Response receiver Application level

  1. Click Applications > Application Types > WebSphere enterprise apps > application_name.

  2. Under Modules, click Manage modules> URI_name.

  3. Click Web services: Client security bindings. Under Response receiver binding, click Edit.

  4. Under Additional properties, click Key locators.

Key encryption algorithm

Algorithm URI of the key encryption method.

The following algorithms are provided by the appserver:

  • http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p.

    When running with SDK V1.4, the list of supported key transport algorithms does not include this one. This algorithm appears in the list of supported key transport algorithms when running with SDK V1.5 or later. By default, the RSA-OAEP algorithm uses the SHA1 message digest algorithm to compute a message digest as part of the encryption operation. Optionally, we can use the SHA256 or SHA512 message digest algorithm by specifying a key encryption algorithm property. The property name is: com.ibm.wsspi.wssecurity.enc.rsaoaep.DigestMethod. The property value is one of the following URIs of the digest method:

    • http://www.w3.org/2001/04/xmlenc#sha256

    • http://www.w3.org/2001/04/xmlenc#sha512

    By default, the RSA-OAEP algorithm uses a null string for the optional encoding octet string for the OAEPParams. We can provide an explicit encoding octet string by specifying a key encryption algorithm property. For the property name, we can specify com.ibm.wsspi.wssecurity.enc.rsaoaep.OAEPparams. The property value is the base 64-encoded value of the octet string.

    We can set these digest method and OAEPParams properties on the generator side only. On the consumer side, these properties are read from the incoming SOAP message.

  • http://www.w3.org/2001/04/xmlenc#rsa-1_5
  • http://www.w3.org/2001/04/xmlenc#kw-tripledes
  • http://www.w3.org/2001/04/xmlenc#kw-aes128
  • http://www.w3.org/2001/04/xmlenc#kw-aes192 Restriction: Do not use the 192-bit data encryption algorithm if we want the configured application to be in compliance with the Basic Security Profile (BSP).
  • http://www.w3.org/2001/04/xmlenc#kw-aes256

 

Application server platforms and IBM Developer Kit, Java Technology Edition V1.4.2

By default, the JCE ships with restricted or limited strength ciphers. To use 192-bit and 256-bit Advanced Encryption Standard (AES) encryption algorithms, apply unlimited jurisdiction policy files. Before downloading these policy files, back up the existing policy files (local_policy.jar and US_export_policy.jar in the WAS_HOME/jre/lib/security/ directory) prior to overwriting them in case you want to restore the original files later.

Fix packs that include updates to the SDK might overwrite unrestricted policy files. Back up unrestricted policy files before you apply a fix pack and reapply these files after the fix pack is applied.

Your country of origin might have restrictions on the import, possession, use, or re-export to another country, of encryption software. Before downloading or using the unrestricted policy files, check the laws of the country, its regulations, and its policies concerning the import, possession, use, and re-export of encryption software, to determine if it is permitted. To download the policy files, complete one of the following sets of steps:

  • [AIX] [Linux]

    (Windows) For appserver platforms using IBM Developer Kit, Java Technology Edition V 1.4.2, including the AIX, Linux, and Windows platforms, complete the following steps to obtain unlimited jurisdiction policy files:

    1. Go to the following Web site: IBM developer works: Security Information

    2. Click Java 1.4.2

    3. Click IBM SDK Policy files.

      The Unrestricted JCE Policy files for SDK 1.4 Web site is displayed.

    4. Enter the user ID and password or register with IBM to download the policy files. The policy files are downloaded onto the machine.

  • For appserver platforms using the Sun-based Java SE Development Kit 6 (JDK 6) V1.4.2, including the Solaris environments and the HP-UX platform, complete the following steps to obtain unlimited jurisdiction policy files:

    1. Go to the following Web site: Download , v 1.4.2 (Java EE)

    2. Click Archive area.

    3. Locate the JCE Unlimited Strength Jurisdiction Policy Files 1.4.2 information and click Download. The policy file is downloaded onto the machine.

After following either of these sets of steps, two JAR files are placed in the JVM jre/lib/security/ directory.

 

Application server platform and IBM Developer Kit, Java Technology Edition V5

By default, the JCE ships with restricted or limited strength ciphers. To use 192-bit and 256-bit Advanced Encryption Standard (AES) encryption algorithms, apply unlimited jurisdiction policy files. Before downloading these policy files, back up the existing policy files (local_policy.jar and US_export_policy.jar in the WAS_HOME/jre/lib/security/ directory) prior to overwriting them in case you want to restore the original files later.

Your country of origin might have restrictions on the import, possession, use, or re-export to another country, of encryption software. Before downloading or using the unrestricted policy files, check the laws of the country, its regulations, and its policies concerning the import, possession, use, and re-export of encryption software, to determine if it is permitted. To download the policy files, complete one of the following sets of steps:

  • For appserver platforms using IBM Developer Kit, Java Technology Edition V5, we can obtain unlimited jurisdiction policy files by completing the following steps:

    1. Go to the following Web site: IBM developer works: Security Information

    2. Click Java 5

    3. Click IBM SDK Policy files.

      The Unrestricted JCE Policy files for SDK 5 Web site is displayed.

    4. Enter the user ID and password or register with IBM to download the policy files. The policy files are downloaded onto the machine.

After following these sets of steps, two JAR files are placed in the JVM jre/lib/security/ directory.

 

Custom algorithms on the cell level

To specify custom algorithms on the cell level...

  1. Click Security > JAX-WS and JAX-RPC security runtime.

  2. Under Additional properties, click Algorithm mappings.

  3. Click New to specify a new algorithm mapping or click the name of an existing configuration to modify its settings.

  4. Under Additional properties, click Algorithm URI.

  5. Click New to create a new algorithm URI. Specify Key encryption in the Algorithm type field to have the configuration display in the Key encryption algorithm field on the Encryption information settings panel.

 

Custom algorithms on the server level

To specify custom algorithms on the server level...

  1. Click Servers > Server Types > WebSphere appservers > server_name.

  2. Under Security, click JAX-WS and JAX-RPC security runtime.

    In a mixed node cell with a server using Websphere Application Server version 6.1 or earlier, click Web services: Default bindings for WS-Security

  3. Under Additional properties, click Algorithm mappings.

  4. Click New to specify a new algorithm mapping or click the name of an existing configuration to modify its settings.

  5. Under Additional properties, click Algorithm URI.

  6. Click New to create a new algorithm URI. Specify Key encryption in the Algorithm type field to have the configuration display in the Key encryption algorithm field on the Encryption information settings panel.

Encryption key information

Name of the key information reference used for encryption. This reference is resolved to the actual key by the specified key locator and defined in the key information.

Specify either one or no encryption key configurations for the request generator and response generator bindings.

For the response consumer and the request consumer bindings, we can configure multiple encryption key references. To create a new encryption key reference, under Additional properties, click Key information references.

We can specify an encryption key configuration for the following bindings on the following levels:


Table 2. Encryption key binding configurations

Binding name Server level, cell level, or application level Path
Default generator binding Cell level

  1. Click Security > JAX-WS and JAX-RPC security runtime.

  2. Under JAX-RPC Default generator binding, click Key information.
Default consumer binding Cell level

  1. Click Security > JAX-WS and JAX-RPC security runtime.

  2. Under JAX-RPC Default consumer binding, click Key information.
Default generator binding Server level

  1. Click Servers > Server Types > WebSphere appservers > server_name.

  2. Under Security, click JAX-WS and JAX-RPC security runtime.

    In a mixed node cell with a server using Websphere Application Server version 6.1 or earlier, click Web services: Default bindings for WS-Security

  3. Under JAX-RPC Default generator binding, click Key information.
Default consumer binding Server level

  1. Click Servers > Server Types > WebSphere appservers > server_name.

  2. Under Security, click JAX-WS and JAX-RPC security runtime.

    In a mixed node cell with a server using Websphere Application Server version 6.1 or earlier, click Web services: Default bindings for WS-Security

  3. Under JAX-RPC Default consumer binding, click Key information.
Request generator (sender) binding Application level

  1. Click Applications > Application Types > WebSphere enterprise appsapplication_name.

  2. Under Modules, click Manage modules > URI_name.

  3. Under WS-Security Properties, click Web services: Client security bindings.

  4. Under Request generator (sender) binding, click Edit custom.

  5. Under Required properties, click Key information.
Response generator (sender) binding Application level

  1. Click Applications > Application Types > WebSphere enterprise appsapplication_name.

  2. Under Modules, click Manage modules > URI_name.

  3. Under WS-Security Properties, click Web services: WAS security bindings.

  4. Under Response generator (sender) binding, click Edit custom.

  5. Under Required properties, click Key information.

Part Reference

Name of the <confidentiality> element for the generator binding or the <requiredConfidentiality> element for the consumer binding element in the deployment descriptor.

This field is available on the application level only.





Related concepts


Basic Security Profile compliance tips

 

Related tasks


Set encryption using JAX-RPC to protect message confidentiality at the application level

 

Related


Encryption information collection
Key locator collection
Encryption information settings: Methods