Web Express Logon Tutorial

Back Home Next

 

Step Step 5 of 9: Configure the Credential Mapper Servlet: Part II

Now that you are familiar with the web.xml file, you are ready to edit it using WebSphere Application Server V5's Application Assembly Tool. In this step, you will edit two of the three default INIT CMS-related parameters that you became familiar with in the last step, and then add other required and optional debugging and Vault parameters.

Helpful hint: Use this example of a completed web.xml as you edit and add parameters.

  1. Edit the default CMS-related INIT parameters.
  2. Add optional CMS-related debugging parameters.
  3. Add the required Vault parameters.
  4. Add optional Vault parameters (if desired)
  5. Save the WAR file.


1. Edit the CMS-related INIT parameters.

In this step, you will edit two of the three INIT parameters in the web.xml file. You will not edit the CMPINetworkSecurity parameter name or value.

  1. Click Start > Programs > IBM WebSphere > Application Server v5.0 > Application Assembly Tool.

  2. On the Welcome to the Application Assembly Tool window, click the Existing tab and browse to the WAR file. Click OK.



  3. In the left panel of the window, expand Web Components > CredMapper and click Initialization Parameters. The three default INIT parameters that you became familiar with in the previous step appear in the top window.



  4. Highlight the CMPICredentialMappers parameter in the top panel of the window. In the Parameter value field below, change the name of its current value (echo) to the name of your HCM. In this scenario, the administrator specifies CMPIVaultPlugin as the parameter value because he is using a vault-style database as his HCM. Optionally provide a description and click Apply to replace the value in the top window.


  5. Code example:

    <init-param>
       <param-name>CMPICredentialMappers</param-name>
       <param-value>CMPIVaultPlugin</param-value>
    </init-param>

  6. Highlight the echo parameter in the top panel of the window. In the Parameter name field below, replace the current parameter name (echo) with the name of the parameter value that you specified for the HCM plug-in. In this scenario, the administrator changed the parameter name to CMPIVaultPlugin.

    Now, replace the parameter value with a compound value that contains the full class path name of the implementing class, the authentication type to be used by the HCM, and the host mask. Separate these values with commas. In this scenario, the administrator added com.ibm.eNetwork.security.sso.cms.CMPIVault for the full class path name, AuthType_ALL for the authentication type, and * for the host mask. For more a detailed description of full class path name, authentication type, and host mask, refer to the Glossary of terms.

    Optionally provide a description and click Apply to replace the value in the top window.



    Code example:

    <init-param>
       <param-name>CMPIVaultPlugin</param-name>
       <param-value>com.ibm.eNetwork.security.sso.cms.CMPIVault,AuthType_ALL,*</param-value>
    </init-param>

Back to top


2. Add optional CMS-related debugging parameters.

To add new parameters, right-click Initialization Parameters in the left pane of the Application Assembly Tool window and select New. This displays the New Initialization Parameter window.

Add the following two optional debugging parameters to help you troubleshoot:

CMPI_TRACE_LOG_FILE
This parameter specifies the name of the log file. The value should be the full path to the log file, for example C:\Program Files\IBM\HostOnDemand\HOD\HODWEL.log on a Windows platform.

Code example:

<init-param>
   <param-name>CMPI_TRACE_LOG_FILE</param-name>
   <param-value>C:\Program Files\IBM\HostOnDemand\HOD\HODWEL.log</param-value>
</init-param>
CMPI_CMS_TRACE_LEVEL
This parameter specifies the trace level for the CMS. The trace messages are logged to the log file specified by CMPI_TRACE_LOG_FILE parameter. Depending on your Web application server, they may or may not be logged to the console. Trace level values include the following:
0 = None: No tracing. This is the default.
1 = Minimum: Trace APIs and parameters, return values, and errors.
2 = Normal: Trace Minimum plus internal APIs and parameters and informational messages.
3 = Maximum: Trace Normal plus Java exceptions.


Code example:


<init-param>
   <param-name>CMPI_CMS_TRACE_LEVEL</param-name>
   <param-value>3</param-value>
</init-param>

Back to top


3. Add the required Vault parameters for the CMPIVaultPlugin.

Adding the required Vault parameters allows the HCM to map the user's network ID to his host ID and receive the needed password from the vault-style database. The following Vault parameters are required in order for Web Express Logon to function properly. This section is divided into two subsections, A and B.

A. The following parameters contain all the relevant information needed to connect to your HCM, which in this case is a JDBC database table created with IBM DB2. You can either configure access to an existing database or to a newly created one.

The level of security for the database depends on the database vendor. See the documentation for details.


CMPI_VAULT_DB_ADDRESS
This is a URL string that provides the address of the database. An example of this string is jdbc:db2://dtagw.raleigh.ibm.com:6789/HODSSO.

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_ADDRESS</param-name>
   <param-value>jdbc:db2://dtagw.raleigh.ibm.com:6789/HODSSO</param-value>
</init-param>

CMPI_VAULT_DB_NET_DRIVER
This string contains the name of the class that acts as the network database driver. An example of this string is COM.ibm.db2.jdbc.net.DB2Driver. The location of this class is assumed to be in the existing class path.

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_NET_DRIVER</param-name>
   <param-value>COM.ibm.db2.jdbc.net.DB2Driver
</param-value>
</init-param>

CMPI_VAULT_DB_USERID
This is the ID of the user account to use when accessing the database. In this case, the user ID is admin.

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_USERID</param-name>
   <param-value>admin
</param-value>
</init-param>

CMPI_VAULT_DB_PASSWORD
This is the password of the user account to use when accessing the database.

We strongly recommend that you encrypt this parameter using the password encryption tool provided with Host On-Demand. The tool encrypts the password and then decrypts it so the HCM can use it. To learn more about how to use this tool, refer to Using the Password Encryption Tool.


Example:

<init-param>
   <param-name>CMPI_VAULT_DB_PASSWORD</param-name>
   <param-value>*G5R%#**4T
</param-value>
</init-param>

CMPI_VAULT_DB_TABLE
This identifies the table to use for the needed query. In this case, the table is called HACP.

Example:


<init-param>
   <param-name>CMPI_VAULT_DB_TABLE</param-name>
   <param-value>HACP
</param-value>
</init-param>

C. The following parameters correspond directly to the column headings that you added to your HCM database table in Step 3: Establish your Host Credential Mapper. Recall that you added the following five column headings, all in uppercase: NETWORKID, HOSTADDRESS, APPLICATIONID, HOSTID, and PASSWORD.

Based on the information provided by the first three of these parameters (network ID, host address, and the host application ID), you can make a SQL query of the database to get the host ID. The result of the query is entered in the host ID (HOSTID) column. Assuming that the query is successful, a call is made to the vault-style database to request the password.
CMPI_VAULT_DB_NETID_COL_NAME
This entry identifies the name of the column that contains the network ID value (NETWORKID).

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_NETID_COL_NAME</param-name>
   <param-value>NETWORKID</param-value>
</init-param>

CMPI_VAULT_DB_HOSTADDR_COL_NAME
This entry identifies the name of the column that contains the host address value (HOSTADDRESS).

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_HOSTADDR_COL_NAME</param-name>
   <param-value>HOSTADDRESS</param-value>
</init-param>

CMPI_VAULT_DB_HOSTAPP_COL_NAME
This entry identifies the name of the column that contains the host application value (APPLICATIONID).

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_HOSTAPP_COL_NAME</param-name>
   <param-value>APPLICATIONID</param-value>
</init-param>

CMPI_VAULT_DB_HOSTID_COL_NAME
This entry identifies the name of the column that contains the host ID value (HOSTID).

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_HOSTID_COL_NAME</param-name>
   <param-value>HOSTID</param-value>
</init-param>

CMPI_VAULT_DB_HOSTPW_COL_NAME
This entry identifies the name of the column that contains the host password value (PASSWORD).

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_HOSTPW_COL_NAME</param-name>
   <param-value>PASSWORD</param-value>
</init-param>

Back to top


4. Add any optional Vault parameters.

Unlike the previous set of Vault parameters, the following two parameters are optional. Which of these parameters you add to the web.xml file depends on your environment and your objectives as an administrator:

CMPI_VAULT_TRACE_LEVEL
This parameter specifies the trace level for the Vault plug-in. The trace messages are logged to the log file specified by CMPI_TRACE_LOG_FILE parameter. Depending on your Web application server, they may or may not be logged to the console. Trace level values include the following:
0 = None: No tracing. This is the default.
1 = Minimum: Trace APIs and parameters, return values, and errors.
2 = Normal: Trace Minimum plus internal APIs and parameters and informational messages.
3 = Maximum: Trace Normal plus Java exceptions.

Code example:


<init-param>
   <param-name>CMPI_VAULT_TRACE_LEVEL</param-name>
   <param-value>3</param-value>
</init-param>

CMPI_VAULT_DB_PRESERVE_WHITESPACE
This parameter indicates whether to trim white spaces from the credential request parameters or not. If true, the white spaces are not trimmed. The default is false.

Code example:


<init-param>
   <param-name>CMPI_VAULT_DB_PRESERVE_WHITESPACE</param-name>
   <param-value>false</param-value>
</init-param>

Back to top


5. Save the WAR file.

On the Application Assembly Tool window, click File > Save to save your WAR file. If it saves successfully, this window will appear as a confirmation:

Back to top

BackHomeNext