Using IBM Certificate Management for HATS applications

Certificate Management allows you to create and manage certificates required for Secure Sockets Layer (SSL) connections.

For HATS, SSL is used between the following:

Certificate Management topics
  Creating a key database file
  Using a well-known, trusted Certificate Authority
    Creating the certificate request
    Sending the certificate request
    Storing the certificate
  Using an unknown Certificate Authority
    Creating the certificate request
    Sending the certificate request
    Storing the certificate
  Using a self-signed certificate
  Exchanging certificates


Creating a key database file

Before you begin configuring SSL for HATS applications, you must create a key database file. Some applications might use the terminology of keystore file or truststore file.

To create a new key database file:

  1. Click Start > Programs > IBM WebSphere HATS > Certificate Management.
  2. Click Key Database File > New.
  3. Select PKCS12, JKS, or JCEKS key database file for the key database type.

    Note: PKCS12 is required for secure connections between HATS applications and the Telnet server.

  4. Type a file name. HATS does not require a particular file name.
  5. Type a directory name for the Location. HATS does not require a particular directory for creation of the key database file, but the key database file will need to be copied into an Enterprise Archive file (.ear) in order to deploy an application that uses it.
  6. Click OK.
  7. Enter a new password.
  8. Enter the same password again to verify.
  9. To help ensure adequate security, the password should have an expiration date. To set expiration date for the password, click Set expire time and specify the number of days until the password expires.
  10. Click OK.

To open an existing key database file:

  1. Click Key Database File > Open.
  2. Change to the directory containing the key database file.
  3. Type the key database file name and click Open.
  4. Enter the current password and click OK.

After you have created or opened the key database file, you can:

Note: Whenever you change the key database file used by a running HATS application, you must stop and re-start the HATS application.


Well-known, trusted Certificate Authority

Complete the procedures in this section to set up SSL security using a certificate issued by a well-known Certificate Authority (CA). The following CA signer certificates are automatically stored in a newly created key database file and marked as trusted certificates:

Following is an overview of the steps used to set up SSL security using a well-known CA:

Creating the certificate request

To create the public/private keys and certificate request:

  1. On the Certificate Management window, choose Personal Certificate Requests from the drop-down list then click New.
  2. Enter the name (label) that is used to identify the key and certificate within the database.
  3. Enter the number corresponding to the key size you want to use. Choosing a larger key size results in stronger security, but requires more processing on the client and the server to establish a connection.
  4. Enter the TCP/IP host name of the server that owns the certificate as the common name, for example, canes10.raleigh.ibm.com.
  5. Enter an organization name.
  6. Optionally enter an organization unit, and other location information.
  7. Choose a country code.
  8. Enter a certificate request file name, or use the default file name.

When you click OK, your information is processed and several files will be produced or updated in the directory where you created the certificate request. If you backup your key database, backup these files also. Do not attempt to edit these files, as the key database file or the certificate request can be corrupted.

Sending the certificate request

Start a Web browser and access the certificate authority's (CA) Web page. Follow the instructions provided to submit the certificate request. The following list provides the URLs of some well-known CAs:

Depending on the CA you choose, you can either e-mail the certificate request generated by Certificate Management or incorporate the certificate request into the form or file provided by the CA.

While you are waiting for the CA to process your certificate request, you can enable SSL security for testing by creating and storing a self-signed certificate using the procedure described in Using a Self-Signed Certificate.

Storing the certificate

When you receive the certificate from the CA, use Certificate Management to put the certificate into the key database file. You should make a backup copy of the received certificate before starting this step.

  1. Choose Personal Certificates from the drop-down list then click Receive to receive the certificate request. The Receive Certificate from a File window appears.
  2. The data type must be BASE64 encoded ASCII data (armored 64 format).
  3. Enter the certificate file name.
  4. Enter the location (path name) of the certificate.
  5. Click OK. The certificate you just stored is displayed as the first item.
  6. Highlight the certificate you just stored and click View/Edit. The Key information window appears.
  7. If not already checked, click Set the certificate as the default to set the selected key as the default.
  8. The certificate name should appear under the Personal Certificate drop-down list and the certificate request should disappear from under the Personal Certificate Requests drop-down list.
  9. Copy the key database file to the Enterprise Archive for deployment. If the Enterprise Archive is running, stop and re-start it.


Unknown Certificate Authority

Complete the procedures in this section to set up SSL security using a certificate issued by a Certificate Authority (CA) that is not already defined in the database. Following is an overview of the steps used to set up SSL security using a certificate from a CA that is not predefined:

Creating the certificate request

To create the public/private keys and certificate request:

  1. On the Certificate Management window, choose Personal Certificate Requests from the drop-down list then click New.
  2. Enter the name (label) that is used to identify the key and certificate within the database.
  3. Enter the number corresponding to the key size you want to use. Choosing a larger key size results in stronger security, but requires more processing on the client and the server to establish a connection.
  4. Enter the TCP/IP host name of the server that owns the certificate as the common name, for example, canes10.raleigh.ibm.com.
  5. Enter an organization name.
  6. Optionally enter an organization unit, and other location information.
  7. Choose a country code.
  8. Enter a certificate request file name, or use the default file name.

When you click OK, your information is processed and several files will be produced or updated in the directory where you created the certificate request. If you backup your key database, backup these files also. Do not attempt to edit these files, as the key database file or the certificate request can be corrupted.

Sending the certificate request

Follow the unknown CA's procedures to submit the certificate request.

Depending on the CA you choose, you can either e-mail the certificate request generated by Cerficate Management or incorporate the certificate request into the form or file provided by the CA.

While you are waiting for the CA to process your certificate request, you can enable SSL security for testing by creating and storing a self-signed certificate using the procedure described in Using a Self-Signed Certificate.

Storing the certificate

When you receive the certificate from the CA, contact the CA to obtain the CA's root certificate. You must store the CA root certificate in the key database file before you store the applied-for certificate. The CA root certificate is used to validate the applied-for certificate. You should make a backup copy of both the CA's root certificate as well as the certificate issued to your server before starting this step.

To store the CA's root certificate:

  1. Choose Signer Certificates from the drop-down list then click Add to receive the CA root certificate.
  2. The data type must be BASE64 encoded ASCII data (armored 64 format).
  3. Enter the certificate file name.
  4. Enter the location, or path, of the certificate.
  5. Click OK. The file is marked as "trusted" and is stored.

To store the applied-for certificate:

  1. Choose Personal Certificates from the drop-down list then click Receive to receive the applied-for certificate.
  2. The data type must be BASE64 encoded ASCII data (armored 64 format).
  3. Enter the certificate file name.
  4. Enter the location, or path, of the certificate.
  5. Click OK. The certificate you just stored is displayed as the first item.
  6. Highlight the certificate you just stored and click View/Edit. The Key information window appears.
  7. If not already checked, click Set the certificate as the default to set the selected key as the default.
  8. The certificate name should appear under the Personal Certificate drop-down list and the certificate request should disappear from under the Personal Certificate Requests drop-down list.
  9. Copy the key database file to the Enterprise Archive (.ear) for deployment. If the Enterprise Archive is running, stop and re-start it.


Using a self-signed certificate

Use the following procedures to create and use a self-signed certificate:

  1. Choose Personal Certificates from the drop-down list.
  2. Click Create > New Self-signed Certificate.
  3. Enter the name (label) that is used to identify the key and certificate within the database.
  4. Select X509 V3 as the certificate version.
  5. Enter the number corresponding to the key size you want to use. Choosing a larger key size results in stronger security, but requires more processing to establish a connection.
  6. Enter the TCP/IP host name of the server that owns the certificate as the common name, for example, canes10.raleigh.ibm.com.
  7. Enter an organization name.
  8. Optionally enter an organization unit, and other location information.
  9. Choose a country code.
  10. Enter the number of days the self-signed certificate is to be valid.
  11. Highlight the certificate you just created and click View/Edit. The Key information window appears.
  12. If not already checked, click Set the certificate as the default to set the selected key as the default.
  13. Click OK.
  14. Copy the key database file to the Enterprise Archive (.ear) for deployment. If the Enterprise Archive is running, stop and re-start it.


Exchanging certificates

In some configurations, certificates must also be made available to SSL partners, for example the DCAS server. If your server uses a certificate from an unknown CA, the unknown CA's root certificate must be made available to SSL partners. If your server uses a self-signed certificate, a copy of the self-signed certificate must be made available to SSL partners.

To create a certificate file to exchange:

  1. Open the key database file using Certificate Management.
  2. If your server uses a self-signed certificate:
    1. Display the list of personal certificates.
    2. Highlight the certificate used by your server.
    3. Click Extract Certificate.

    If your server uses a certificate issued by an unknown CA:

    1. Display the list of Signer Certificates.
    2. Highlight the root certificate of the CA that issued the certificate for your server.
    3. Click Extract.
  3. On the Extract Certificate to a File window, choose either Base64 encoded ASCII data or Binary DER data. Base64 is usually used if the certificate will be securely transferred through e-mail. The certificate file name and location can be any you choose.
  4. Click OK and the certificate file will be created.
  5. Securely transfer the certificate file to the SSL partner, for example the DCAS server, and add the certificate to the its key database file.