Configure an IBM DB2 Policy Store

Installation and Upgrade Guides › Policy Server Installation Guide › Configuring CA SiteMinder® Data Stores in a Relational Database › Configure an IBM DB2 Policy Store

Configure an IBM DB2 Policy Store

A single IBM DB2 database can function as a:

policy store
key store
logging database
Note: Store CA SiteMinder® session information in a separate database. Do not use the policy store to store session information.

Using a single database simplifies administrative tasks. The following sections provide instruction on how to configure a single database server to store CA SiteMinder® data.

Gather Database Information

Configuring a single IBM DB2 database to function as a policy store or any other type of CA SiteMinder® data store requires specific database information.

Consider the following items:

Information that is prefixed with a W represents a Windows requirement.
Information that is prefixed with a U represents a UNIX requirement.

Gather the following information before configuring the policy store or any other type of CA SiteMinder® data store. You can use the IBM DB2 Information Worksheet to record your values.

Note: Policy and data store worksheets are provided to help you gather and record information before configuring or upgrading a CA SiteMinder® data store. You can print the applicable worksheet and can use it to record required information before beginning.

Database instance name —Determine the name of the database instance that is to function as the policy store or data store.
Administrative account —Determine the user name of an account with privileges to create, read, modify, and delete objects in the database.
Administrative password —Determine the password for the Administrative account.
IP address—Determine the IP address of the database host system.
Tcp port—Determine the port on which the database is listening.
(W) Data source name —Determine the name that is to identify the data source.
(U) Policy Server root —Determine the explicit path to where the Policy Server is installed.
(U) Package —Determine the name of the package that is to process dynamic SQL.
(U) Package owner—Determine the AuthID assigned to the package. The AuthID must have the authority to execute all SQLs in the package.
(U) Grant AuthID—If you want to restrict execute privileges for the package, determine the AuthID that is granted execute permissions for the package.
Default wire protocol setting: Public

(U) Isolation level—Determine the method by which the system acquires and releases locks.

Default wire protocol setting: CURSOR_STABILTY

(U) Dynamic sections—Determine the number of sections that the wire protocol driver package can prepare for a single user.
Default wire protocol setting: 100

How to Configure the Policy Store

Complete the following procedures to configure a single IBM DB2 database as a policy store, key store, and logging database.

Note: Be sure that you have gathered the required database information before beginning. Some of the following procedures require this information.

Be sure that the IBM DB2 database instance that is to contain the CA SiteMinder® data is accessible from the Policy Server system.
Verify the following database instance settings:
- If you are configuring a policy store only, the tablespace page size (page_size) and the buffer pool page size settings must each be set to at least 16k.
  The default DB2 value for each setting is not sufficient for the CA SiteMinder® policy store schema.
- If you are configuring a policy store and an audit store, the table space page size (page_size) and the buffer pool page size settings must each be set to at least 32k.
  The default DB2 value for each setting is not sufficient for the CA SiteMinder® policy store and audit store schema.
Create the CA SiteMinder® schema.
Configure a DB2 data source for CA SiteMinder®.
Point the Policy Server to the database.
Set the CA SiteMinder® superuser password.
Import the policy store data definitions.
Import the default policy store objects.
Restart the Policy Server.
Prepare for the Administrative UI registration.

Create the CA SiteMinder® Schema

Follow these steps:

Navigate to siteminder_home\db\tier2\DB2.

siteminder_home

Specifies the Policy Server installation path.
Open the following file in a text editor and copy the contents of the entire file:

sm_db2_ps.sql

Specifies the schema for a policy or key store in a DB2 database.
Paste the file contents into a query and execute the query.
The policy and key store schema is created in the DB2 database.
(Optional) Repeat steps two and three to create the audit log or sample users schema in the DB2 database:

sm_db2_logs.sql

Specifies the schema for an audit log store in a DB2 database. For 12.52 edit this script before creating an audit store.

smsampleusers_db2.sql

Specifies the schema for sample users in a DB2 database and populates the database with the sample users.

The corresponding CA SiteMinder® schema is created in the DB2 database.

Note: Using the policy store to store key, audit, and sample users is optional. You can use separate databases to function as these types of CA SiteMinder® data stores individually.
Copy the following schema file to the DB2 host system:
siteminder_home\xps\db\DB2.sql

siteminder_home

Specifies the Policy Server installation path.
Open a command prompt and run the following command:
```
db2 -td@ [-v] -f path\DB2.sql
```
path

Specifies the path to the DB2 schema file.

The policy store schema is created.

Configure an IBM DB2 Data Source for CA SiteMinder®

If you are using ODBC, configure a data source to let CA SiteMinder® communicate with the CA SiteMinder® data store.

Create a DB2 Data Source on Windows Systems

When using ODBC, you can create a DB2 data source for the DB2 wire protocol driver.

Follow these steps:

Complete one of the following steps:
- If you are using a supported 32–bit Windows operating system, click Start and select Programs, Administrative Tools, ODBC Data Sources.
- If you are using a supported 64–bit Windows operating system:
  1. Navigate to the install_home\Windows\SysWOW64.
  2. Double–click odbcad32.exe
The ODBC Data Source Administrator appears.
Click the System DSN tab and click Add.
Scroll down and select CA SiteMinder® DB2 Wire Protocol and click Finish.
In the ODBC DB2 Wire Protocol Driver Setup dialog, under the General tab, complete the following steps:
1. In the Data Source Name field, enter any name.
  Example:
```
SiteMinder DB2 Wire Data Source
```
2. (Optional) In the Description field, enter a description of the DB2 wire protocol data source.
3. In the IP Address field, enter the IP Address where the DB2 database is installed.
4. In the Tcp Port field, enter the port number where DB2 is listening on the system.
5. Click Test Connect.
  The connection is tested.
Click OK.
The ODBC DB2 Wire Protocol Driver Setup dialog closes, the selections are saved, and the DB2 data source is created on a Windows System.

Note: You can now configure CA SiteMinder® to use the data source that you created.

Create a DB2 Data Source on UNIX Systems

The SiteMinder ODBC data sources are configured using a system_odbc.ini file, which you can create by renaming db2wire.ini, located in policy_server_home/db, to system_odbc.ini. This system_odbc.ini file contains all of the names of the available ODBC data sources as well as the attributes that are associated with these data sources. This file must be customized to work for each site. Also, you can add additional data sources to this file, such as defining additional ODBC user directories for SiteMinder.

The first section of the system_odbc.ini file, [ODBC Data Sources], contains a list of all of the currently available data sources. The name before the “=” refers to a subsequent section of the file describing each individual data source. After the “=” is a comment field.

Each data source has a section in the system_odbc.ini file describing its attributes. The first attribute is the ODBC driver to be loaded when this data source is used by SiteMinder. The remaining attributes are specific to the driver.

Adding a DB2 Data source involves adding a new data source name in the [ODBC Data Sources] section of the file, and adding a section that describes the data source using the same name as the data source. You need to change the system_odbc.ini file if you create a new service name or want to use a different driver. You should have entries for the DB2 driver under [SiteMinder Data Source].

Again, to configure a DB2 data source, you must first create a system_odbc.ini file in the policy_server_home/db directory. To do this, you need to rename db2wire.ini, located in policy_server_home/db, to system_odbc.ini.

Note: policy_server_home specifies the Policy Server installation path.

Configure the DB2 Wire Protocol Driver

The following table contains configuration parameters for DB2 data sources. You can edit these parameters to configure data sources for separate key, audit log, session, and sample users databases.

Parameter	Description	How to Edit
Data Source Name	Name of the data source.	Enter the data source name inside the square brackets.
Driver	Full path to the SiteMinder DB2 Wire Protocol driver.	Replace “nete_ps_root” with the SiteMinder installation directory.
Description	Description of the data source.	Enter any desired description.
Database	Name of the DB2 UDB database.	Replace “nete_database” with the name of the database configured on the DB2 UDB server.
LogonID	Username required for accessing the database.	Replace “uid” with the username of the DB2 UDB administrator.
Password	Password required for accessing the database.	Replace “pwd” with the password of the DB2 UDB administrator.
IPAddress	IP address or hostname of the DB2 UDB server.	Replace “nete_server_ip” with the IP address or the hostname of the DB2 UDB server.
TcpPort	TCP port number of the DB2 UDB server.	Replace the default value of 50000 with the actual TCP port number of the DB2 UDB server.
Package	The name of the package to process dynamic SQL.	Replace “nete_package” with the name of the package you want to create.
PackageOwner	(Optional) The AuthID assigned to the package.	Empty by default. This DB2 AuthID must have authority to execute all SQLs in the package.
GrantAuthid	The AuthID granted execute privileges for the package.	“PUBLIC” by default. Specify the desired AuthID if you wish to restrict the execute privileges for the package.
GrantExecute	Specifies whether to grant execute privileges to the AuthID listed in GrantAuthid.	Can be either 1 or 0. Set to 0 by default.
IsolationLevel	The method by which locks are acquired and released by the system.	CURSOR_STABILITY by default.
DynamicSections	The number of statements that the DB2 Wire Protocol driver package can prepare for a single user.	100 by default. Enter the desired number of statements.

Point the Policy Server to the Database

You point the Policy Server to the database so the Policy Server can access the CA SiteMinder® data in the policy store.

Follow these steps:

Open the Policy Server Management Console and click the Data tab.
Select the following value from the Storage list:
```
ODBC
```
Select the following value from the Database list:
```
Policy Store
```
Enter the name of the data source in the Data Source Information field.
- (Windows) The entry must match the name that you entered in the Data Source Name field when you created the data source.
- (UNIX) The entry must match the first line of the data source entry in the system_odbc.ini file. By default, the first line in the file is [CA SiteMinder® Data Sources]. If you modified the first entry, be sure to enter the correct value.
Enter and confirm the user name and password of the database account that has full access rights to the database instance in the respective fields.
Specify the maximum number of database connections that are allocated to CA SiteMinder®.
Note: We recommend retaining the 25 connection default for best performance.
Click Apply to save the settings.
Select the following value from the Database list:
```
Key Store
```
Select the following value from the Storage list:
```
ODBC
```
Select the following option:
```
Use the Policy Store database
```
Select the following value from the Database list:
```
Audit Logs
```
Select the following value from the Storage list:
```
ODBC
```
Select the following option:
```
Use the Policy Store database
```
Click Apply to save the settings.
Click Test Connection to verify that the Policy Server can access the policy store.
Click OK.
The Policy Server is configured to use the database as a policy store, key store, and logging database.

Set the CA SiteMinder® Super User Password

The default CA SiteMinder® administrator account is named:

siteminder

The account has maximum permissions.

We recommend that you do not use the default superuser for day–to–day operations. Use the default superuser to:

Access the Administrative UI for the first–time.
Manage CA SiteMinder® utilities for the first–time.
Create another administrator with superuser permissions.

Follow these steps:

Copy the smreg utility to siteminder_home\bin.

siteminder_home

Specifies the Policy Server installation path.

Note: The utility is at the top level of the Policy Server installation kit.
Run the following command:
```
smreg -su password
```
password

Specifies the password for the default CA SiteMinder® administrator.

Limits:
- The password must contain at least six (6) characters and cannot exceed 24 characters.
- The password cannot include an ampersand (&) or an asterisk (*).
- If the password contains a space, enclose the passphrase with quotation marks.
Note: If you are configuring an Oracle policy store, the password is case–sensitive. The password is not case–sensitive for all other policy stores.
Delete smreg from siteminder_home\bin. Deleting smreg prevents someone from changing the password without knowing the previous one.
The password for the default CA SiteMinder® administrator account is set.

More information:

Locate the Installation Media

Installation Media Names

Import the Policy Store Data Definitions

Importing the policy store data definitions defines the types of objects that can be created and stored in the policy store.

Follow these steps:

Open a command window and navigate to siteminder_home\xps\dd.

siteminder_home

Specifies the Policy Server installation path.
Run the following command:
```
XPSDDInstall SmMaster.xdd
```
XPSDDInstall

Imports the required data definitions.

Import the Default Policy Store Objects

Importing the default policy store objects configures the policy store for use with the Administrative UI and the Policy Server.

Consider the following items:

Be sure that you have write access to siteminer_home\bin. The import utility requires this permission to import the policy store objects.

siteminder_home

Specifies the Policy Server installation path.
Before running a CA SiteMinder® utility or executable on Windows Server 2008, open the command line window with administrator permissions. Open the command line window this way, even if your account has administrator privileges. For more information, see the release notes for your CA SiteMinder® component.

Follow these steps:

Open a command window and navigate to siteminder_home\db.
Import one of the following files:
- To import smpolicy.xml, run the following command:
```
XPSImport smpolicy.xml -npass
```
- To import smpolicy–secure.xml, run the following command:
```
XPSImport smpolicy-secure.xml -npass
```
  npass
  
  Specifies that no passphrase is required. The default policy store objects do not contain encrypted data.
  
  Both files include the default policy store objects. These objects include the default security settings in the default Agent Configuration Object (ACO) templates. The smpolicy–secure file provides more restrictive security settings. For more information, see Default Policy Store Objects Consideration.

Note: Importing smpolicy.xml makes available legacy federation and Web Service Variables functionality that is separately licensed from CA SiteMinder®. If you intend on using the latter functionality, contact your CA account representative for licensing information.

Enable the Advanced Authentication Server

Enable the advanced authentication server as part of configuring your Policy Server.

Follow these steps:

Start the Policy Server configuration wizard.
Leave all the check boxes in the first screen of the wizard cleared.
Click Next.
The master key screen appears.
Create the master encryption key for the advanced authentication server.
Note: If you are installing another (nth) Policy Server, use the same encryption key for the Advanced Authentication server that you used previously.
Complete the rest of the Policy Server configuration wizard.
The advanced authentication server is enabled.

Prepare for the Administrative UI Registration

You use the default CA SiteMinder® super user account (siteminder) to log into the Administrative UI for the first–time. The initial login requires that you to register the Administrative UI with a Policy Server, which creates a trusted relationship between both components.

You prepare for the registration by using the XPSRegClient utility to supply the super user account name and password. The Policy Server uses these credentials to verify that the registration request is valid and that the trusted relationship can be established.

Consider the following:

The time from which you supply the credentials to when the initial Administrative UI login occurs is limited to 24 hours. If you do not plan on installing the Administrative UI within one day, complete the following before installing the Administrative UI.
(UNIX) Be sure that the CA SiteMinder® environment variables are set before you use XPSRegClient. If the environment variables are not set, set them manually.

To prepare for the Administrative UI registration

Log into the Policy Server host system.
Run the following command:
```
XPSRegClient siteminder[:passphrase] -adminui-setup -t timeout -r retries -c comment -cp -l log_path -e error_path -vT -vI -vW -vE -vF
```
passphrase

Specifies the password for the default CA SiteMinder® super user account (siteminder).

Note: If you do not specify the passphrase, XPSRegClient prompts you to enter and confirm one.

-adminui–setup

Specifies that the Administrative UI is being registered with a Policy Server for the first–time.

-t timeout

(Optional) Specifies the allotted time from when you to install the Administrative UI to the time you log in and create a trusted relationship with a Policy Server. The Policy Server denies the registration request when the timeout value is exceeded.

Unit of measurement: minutes

Default: 240 (4 hours)

Minimum Limit: 15

Maximum Limit: 1440 (24 hours)

-r retries

(Optional) Specifies how many failed attempts are allowed when you are registering the Administrative UI. A failed attempt can result from submitting incorrect CA SiteMinder® administrator credentials when logging into the Administrative UI for the first–time

Default: 1

Maximum Limit: 5

-c comment

(Optional) Inserts the specified comments into the registration log file for informational purposes.

Note: Surround comments with quotes.

-cp

(Optional) Specifies that registration log file can contain multiple lines of comments. The utility prompts for multiple lines of comments and inserts the specified comments into the registration log file for informational purposes.

Note: Surround comments with quotes.

-l log path

(Optional) Specifies where the registration log file must be exported.

Default: siteminder_home\log

siteminder_home

Specifies the Policy Server installation path.

-e error_path

(Optional) Sends exceptions to the specified path.

Default: stderr

-vT

(Optional) Sets the verbosity level to TRACE.

-vI

(Optional) Sets the verbosity level to INFO.

-vW

(Optional) Sets the verbosity level to WARNING.

-vE

(Optional) Sets the verbosity level to ERROR.

-vF

(Optional) Sets the verbosity level to FATAL.
Press Enter.
XPSRegClient supplies the Policy Server with the administrator credentials. The Policy Server uses these credentials to verify the registration request when you log into the Administrative UI for the first–time.