WAS v8.5 > Reference > SetsKey information configuration settings page
Use this page to specify the related configuration need to specify the key for XML digital signature or XML encryption.
To view this dmgr console page on the server level for the key information references...
- Click Servers > Server Types > WebSphere application servers > server_name.
- 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 Web Services Security.
- Under JAX-RPC Default Generator Bindings or the JAX-RPC Default Consumer Bindings, click Key information.
- Click New to create a new configuration or click the configuration name to modify its contents.
To view this dmgr console page on the application level for the key information references...
This option is available on the application level for v6.x applications.
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Under Additional properties, we can access the signing information for the following bindings:
- For the Request generator (sender) binding, click Web services: Client security bindings. Under Request generator (sender) binding, click Edit custom.
- For the Request consumer (receiver) binding, click Web services: Server security bindings. Under Request consumer (receiver) binding, click Edit custom.
- For the Response generator (sender) binding, click Web services: Server security bindings. Under Response generator (sender) binding, click Edit custom.
- For the Response consumer (receiver) binding, click Web services: Client security bindings. Under Response consumer (receiver) binding, click Edit custom.
- Under Required properties, click Key information.
- Click New to create a new configuration or click the configuration name to modify its contents.
Before clicking Properties under Additional properties, enter a value in the Key information name field and select an option for the Key information type and Key locator reference options.
Key information name
Specifies a name for the key information configuration.
Key information type
Type of key information. The key information type specifies how to reference security tokens.
WAS v8.5 supports the following types of key information. Each type of key information is described in Web Services Security: SOAP Message Security 1.0 (WS-Security 2004)
Key information types. These types of key information are supported by the product.
The X.509 issuer name and issuer serial is described in Web Services Security: X.509 Certificate Token Profile v1.0. The other types are described in Web Services Security: SOAP Message Security 1.0 (WS-Security 2004).
Type Description Key identifier The security token is referenced using an opaque value that uniquely identifies the token. Key name The security token is referenced using a name that matches an identity assertion within the token. Security token reference With this type, the security token is directly referenced. Embedded token With this type, the security token reference is embedded. X509 issuer name and issuer serial With this type, the security token is referenced by an issuer and serial number of an X.509 certificate If you select Key identifier for the key information type, we can specify values in the following fields on this panel:
- Encoding method
- Calculation method
- Value type namespace URI
- Value type local name
Key locator reference
Specifies the reference used to retrieve the key for digital signature and encryption.
Before specifying a key locator reference, configure a key locator. We can specify a signing key configuration for the following bindings:
Signing key binding configurations. The key is used during digital signature and encryption.
Binding name Server level or application level Path Default generator binding Server level
- Click Servers > Server Types > WebSphere application servers > server_name.
- 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 Web Services Security.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Default consumer binding Server level
- Click Servers > Server Types > WebSphere application servers > server_name.
- 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 Web Services Security.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Request sender binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Client security bindings. Under Request sender binding, click Edit.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Response receiver binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Client security bindings. Under Response receiver binding, click Edit.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Request receiver binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Server security bindings. Under Request receiver binding, click Edit.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Response sender binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Server security bindings. Under Response sender binding, click Edit.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Request generator (sender) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Client security bindings. Under Request generator (sender) binding, click Edit.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Response consumer (receiver) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Client security bindings. Under Response consumer (receiver) binding, click Edit custom.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Request consumer (receiver) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Server security bindings. Under Request consumer (receiver) binding, click Edit custom.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Response generator (sender) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Server security bindings. Under Response generator (sender) binding, click Edit custom.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Key name reference
Name of the key used for generating digital signature and encryption.
This field is displayed for the default generator and is also displayed for the request generator and response generator for v6.x applications.
This field is displayed for the default generator and is also displayed for the request generator and response generator.
Key name reference binding configurations. The key is used during digital signature and encryption.
Binding name Server level or application level Path Default generator binding Server level
- Click Servers > Server Types > WebSphere application servers > server_name.
- 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 Web Services Security.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Request generator (sender) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Client security bindings. Under Request generator (sender) binding, click Edit.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Response generator (sender) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Server security bindings. Under Response generator (sender) binding, click Edit custom.
- Under Additional properties, click Key locators.
- Click New to create a new key locator or click the name of a configured key locator to modify its configuration.
Token reference
Name of a token generator or token consumer used for processing a security token.
The application server requires this field only when we specify Security token reference or Embedded token in the Key information type field. The Token reference field is also required when we specify a key identifier type for the consumer. Before specifying a token reference, configure a token generator or token consumer. We can specify a token configuration for the following bindings on the following levels:
Token reference binding configurations. The reference information is used for a security token reference or an embedded token.
Binding name Server level or application level Path Default generator binding Server level
- Click Servers > Server Types > WebSphere application servers > server_name.
- 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 Web Services Security.
- Under JAX-RPC Default Generator Bindings, click Token generator.
- Click New to create a new token generator or click the name of a configured token generator to modify its configuration.
Default consumer binding Server level
- Click Servers > Server Types > WebSphere application servers > server_name.
- 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 Web Services Security.
- Under JAX-RPC Default Consumer Bindings, click Token consumer.
- Click New to create a new token consumer or click the name of a configured token consumer to modify its configuration.
Request generator (sender) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Client security bindings. Under Request generator (sender) binding, click Edit custom.
- Under Additional properties, click Token generators.
- Click New to create a new token generator or click the name of a configured token generator to modify its configuration.
Response consumer (receiver) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Client security bindings. Under Response consumer (receiver) binding, click Edit custom.
- Under Required properties, click Token consumers.
- Click New to create a new token consumer or click the name of a configured token consumer to modify its configuration.
Request consumer (receiver) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Server security bindings. Under Request consumer (receiver) binding, click Edit custom.
- Under Required properties, click Token consumers.
- Click New to create a new token consumer or click the name of a configured token consumer to modify its configuration.
Response generator (sender) binding Application level
- Click Applications > Application Types > WebSphere enterprise applications > application_name.
- Under Modules, click Manage modules > URI_name.
- Click Web services: Server security bindings. Under Response generator (sender) binding, click Edit custom.
- Under Additional properties, click Token generators.
- Click New to create a new token generator or click the name of a configured token generator to modify its configuration.
Encoding method
Encoding method that indicates the encoding format for the key identifier.
This field is valid when we specify Key identifier in the Key information type field. WAS v8.5 supports the following encoding methods:
- http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary
- http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#HexBinary
This field is available for the default generator binding only.
Calculation method
This field is valid when we specify Key identifier in the Key information type field. WAS v8.5 supports the following calculation methods:
- http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#ITSHA1
- http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#IT60SHA1
This field is available for the generator binding only.
Value type namespace URI
Namespace Uniform Resource Identifier (URI) of the value type for a security token referenced by the key identifier.
This field is valid when we specify Key identifier in the Key information type field. When we specify the X.509 certificate token, we do not need to specify this option. To specify another token, specify the URI of QName for value type.
WAS v8.5 provides the following predefined value type URIs for the LTPA token:
- http://www.ibm.com/websphere/appserver/tokentype
- http://www.ibm.com/websphere/appserver/tokentype/5.0.2
This field is available for the generator binding only.
Value type local name
Local name of the value type for a security token referenced by the key identifier.
When this local name is used with the corresponding namespace URI, the information is called the value type qualified name or QName.
This field is valid when we specify Key identifier in the Key information type field. When we specify the X.509 certificate token, IBM recommends that we use the predefined local names. When we specify the predefined local names, we do not need to specify the URI of the value type. WAS v8.5 provides the following predefined local names:
- X.509 certificate token
- http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3
- X.509 certificates in a PKIPath
- http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509PKIPathv1
- A list of X509 certificates and CRLs in a PKCS#7
- http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#PKCS7
- LTPA
- LTPA_PROPAGATION
For LTPA, the value type local name is LTPA. If you enter LTPA for the local name, specify the http://www.ibm.com/websphere/appserver/tokentype/5.0.2 URI value in the Value type URI field as well. For LTPA token propagation, the value type local name is LTPA_PROPAGATION. If you enter LTPA_PROPAGATION for the local name, specify the http://www.ibm.com/websphere/appserver/tokentype URI value in the Value type URI field as well. For the other predefined value types (User name token, X509 certificate token, X509 certificates in a PKIPath, and a list of X509 certificates and CRLs in a PKCS#7), the value for the Value type local name field begins with http://. For example, if you are specifying the user name token for the value type, enter http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#UsernameToken in the Value type local name field and then we do not need to enter a value in the value type URI field.
When we specify a custom value type for custom tokens, we can specify the local name and the URI of the quality name (QName) of the value type. For example, you might specify Custom for the local name and http://www.ibm.com/custom for the URI.
This field is also available for the generator binding only.
Related
Configure the key information using JAX-RPC for the generator binding on the application level
Reference:
Token generator page
Token consumer page
Key information page