Key information configuration settings

Use this page to specify the related configuration need to specify the key for XML digital signature or XML encryption.

To view this WebSphere® Application Server administrative console page on the server level for the key information references, complete the following steps:

1. Click Servers > Application Servers > server_name.

2. Under Security, click Web services: Default bindings for Web services security.

3. Under Default generator bindings or the Default consumer bindings, click Key information.

4. Click New to create a new configuration or click the configuration name to modify its contents.

To view this WAS administrative console page on the application level for the key information references, complete the following steps. This option is available on the application level for v6.x applications.

1. Click Applications > Enterprise applications > application_name.

2. Under Related items, click EJB modules or Web modules > URI_name.

3. Under Additional properties, you 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.

4. Under Required properties, click Key information.

5. 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.

 

Related reference

Token generator collection

Token consumer collection

Key information collection

 

Key information name

Specifies a name for the key information configuration.

 

Key information type

Specifies the type of key information. The key information type specifies how to reference security tokens.

WAS supports the following types of key information. Each type of key information is described in the Web Services Security: SOAP Message Security 1.0 (WS-Security 2004) OASIS standard, which is located at: http://www.oasis-open.org/home/index.php under Web services security.

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

The X.509 issuer name and issuer serial is described in Web Services Security: X509 Token Profile Version 1.0 located at: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0.pdf. The other types are described in Web Services Security: SOAP Message Security Version 1.0 located at: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf.

If you select Key identifier for the key information type, you 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 that is used to retrieve the key for digital signature and encryption.

Before specifying a key locator reference, configure a key locator. You can specify a signing key configuration for the following bindings:

Binding name	Cell level, server level, or application level	Path
Default generator binding	Server level	Click Servers > Application servers > server_name. Under Security, 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.
Default consumer binding	Server level	Click Servers > Application servers > server_name. Under Security, 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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

Specifies the name of the key that is 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 Version 6.x applications.

Binding name	Cell level, server level, or application level	Path
Default generator binding	Server level	Click Servers > Application servers > server_name. Under Security, 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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

Specifies the name of a token generator or token consumer that is used for processing a security token.

WAS requires this field only when you specify Security token reference or Embedded token in the Key information type field. The Token reference field is also required when you specify a key identifier type for the consumer. Before specifying a token reference, configure a token generator or token consumer. You can specify a token configuration for the following bindings on the following levels:

Binding name	Cell level, server level, or application level	Path
Default generator binding	Server level	Click Servers > Application servers > server_name. Under Security, click Web services: Default bindings for Web services security. Under 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 > Application servers > server_name. Under Security, click Web services: Default bindings for Web services security. Under 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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 consumer or click the name of a configured token consumer to modify its configuration.
Response consumer (receiver) binding	Application level	Click Applications > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web modules > URI_name. Click Web services: Sender 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 > Enterprise applications > application_name. Under Related items, click EJB modules or Web 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 consumer or click the name of a configured token consumer to modify its configuration.

 

Encoding method

Specifies the encoding method that indicates the encoding format for the key identifier.

This field is valid when you specify Key identifier in the Key information type field. WAS 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 you specify Key identifier in the Key information type field. WAS 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

Specifies the namespace Uniform Resource Identifier (URI) of the value type for a security token that is referenced by the key identifier.

This field is valid when you specify Key identifier in the Key information type field. When you specify the X.509 certificate token, you do not need to specify this option. If you want to specify another token, specify the URI of QName for value type.

WAS provides the following predefined value type URI for the Lightweight Third Party Authentication (LTPA) token: http://www.ibm.com/websphere/appserver/tokentype/5.0.2

This field is available for the generator binding only.

 

Value type local name

Specifies the local name of the value type for a security token that is 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 you specify Key identifier in the Key information type field. When you specify the X.509 certificate token, it is recommended that you use the predefined local names. When you specify the predefined local names, you do not need to specify the URI of the value type. WAS 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

Attention: 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 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 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 you do not need to enter a value in the value type URI field. When you specify a custom value type for custom tokens, you 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.

---