ibm tivoli identity manager: sql server adapter...
TRANSCRIPT
Tivoli® Identity Manager
SQL Server adapter Installation and Configuration Guide
Version 4.6
SC32-1230-03
���
Tivoli® Identity Manager
SQL Server adapter Installation and Configuration Guide
Version 4.6
SC32-1230-03
���
Note:
Before using this information and the product it supports, read the information in Appendix C, “Notices,” on page 55.
Fourth Edition (August 2006)
This edition applies to version 4.6 of this adapter and to all subsequent releases and modifications until otherwise
indicated in new editions.
© Copyright International Business Machines Corporation 2002, 2006. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Preface . . . . . . . . . . . . . . . v
Who should read this book . . . . . . . . . v
Publications and related information . . . . . . v
Tivoli Identity Manager library . . . . . . . v
Prerequisite product publications . . . . . . vii
Related publications . . . . . . . . . . viii
Accessing publications online . . . . . . . viii
Accessibility . . . . . . . . . . . . . . viii
Support information . . . . . . . . . . . viii
Conventions used in this book . . . . . . . . ix
Typeface conventions . . . . . . . . . . ix
Operating system differences . . . . . . . . ix
Definitions for HOME and other directory
variables . . . . . . . . . . . . . . . x
Chapter 1. Overview of the SQL Server
adapter . . . . . . . . . . . . . . . 1
Features of the adapter . . . . . . . . . . . 1
Chapter 2. Installing and configuring the
SQL server adapter . . . . . . . . . . 3
Prerequisites . . . . . . . . . . . . . . 3
Installing the adapter . . . . . . . . . . . 3
Importing the adapter profile into the Tivoli Identity
Manager server . . . . . . . . . . . . . 4
Importing the adapter profile . . . . . . . . 4
Creating a SQL server service . . . . . . . . . 5
Configuring the adapter . . . . . . . . . . 6
Chapter 3. Configuring the SQL Server
adapter for IBM Tivoli Identity Manager . 7
Starting the adapter configuration tool . . . . . . 7
Viewing configuration settings . . . . . . . . 8
Changing protocol configuration settings . . . . . 8
Configuring event notification . . . . . . . . 12
Setting event notification triggers . . . . . . 15
Modifying an event notification context . . . . 15
Changing the configuration key . . . . . . . 18
Changing activity logging settings . . . . . . . 18
Changing registry settings . . . . . . . . . 20
Changing advanced settings . . . . . . . . . 20
Viewing statistics . . . . . . . . . . . . 22
Changing code page settings . . . . . . . . 22
Accessing help and additional options . . . . . 22
Chapter 4. Configuring SSL
authentication for the SQL Server
adapter . . . . . . . . . . . . . . 25
Overview of SSL and digital certificates . . . . . 25
Private keys, public keys, and digital certificates 26
Self-signed certificates . . . . . . . . . . 26
Certificate and key formats . . . . . . . . 27
The use of SSL authentication . . . . . . . . 27
Configuring certificates for SSL authentication . . . 28
Configuring certificates for one-way SSL
authentication . . . . . . . . . . . . 28
Configuring certificates for two-way SSL
authentication . . . . . . . . . . . . 29
Configuring certificates when the adapter
operates as an SSL client . . . . . . . . . 30
Managing SSL certificates using CertTool . . . . 31
Starting CertTool . . . . . . . . . . . 31
Generating a private key and certificate request 33
Installing the certificate . . . . . . . . . 34
Installing the certificate and key from a PKCS12
file . . . . . . . . . . . . . . . . 34
Viewing the installed certificate . . . . . . . 35
Installing a CA certificate . . . . . . . . . 35
Viewing CA certificates . . . . . . . . . 35
Deleting a CA certificate . . . . . . . . . 35
Viewing registered certificates . . . . . . . 36
Registering a certificate . . . . . . . . . 36
Unregistering a certificate . . . . . . . . 36
Exporting a certificate and key to PKCS12 file . . 37
Chapter 5. Customizing the SQL server
adapter . . . . . . . . . . . . . . 39
Copy the SQL2000Profile.jar file and extract the files 39
Create a new JAR file and install the new attributes
on the Tivoli Identity Manager server . . . . . 40
Managing passwords when restoring accounts . . . 40
Chapter 6. Upgrading the SQL Server
adapter or the ADK . . . . . . . . . 43
Upgrading the SQL Server 2000 Adapter to the SQL
Server adapter . . . . . . . . . . . . . 43
Upgrading the SQL Server adapter . . . . . . 43
Upgrading the ADK . . . . . . . . . . . 43
Log files . . . . . . . . . . . . . . 44
Chapter 7. Uninstalling the SQL server
adapter . . . . . . . . . . . . . . 45
Appendix A. Adapter attributes . . . . 47
Attribute descriptions . . . . . . . . . . . 47
Attributes by SQL Server adapter actions . . . . 48
Database Login Add . . . . . . . . . . 48
Database Login Change . . . . . . . . . 49
Database Login Delete . . . . . . . . . . 49
Database Login Suspend . . . . . . . . . 49
Database Login Restore . . . . . . . . . 50
Reconciliation . . . . . . . . . . . . 50
Appendix B. Support information . . . 51
Searching knowledge bases . . . . . . . . . 51
Search the information center on your local
system or network . . . . . . . . . . . 51
Search the Internet . . . . . . . . . . . 51
© Copyright IBM Corp. 2002, 2006 iii
Contacting IBM Software Support . . . . . . . 51
Determine the business impact of your problem 52
Describe your problem and gather background
information . . . . . . . . . . . . . 53
Submit your problem to IBM Software Support 53
Appendix C. Notices . . . . . . . . . 55
Trademarks . . . . . . . . . . . . . . 56
Index . . . . . . . . . . . . . . . 59
iv IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Preface
The IBM® Tivoli® Identity Manager SQL Server Adapter (SQL Server adapter)
enables connectivity between the IBM Tivoli Identity Manager server and a
network of systems running the MS SQL . After the adapter is installed and
configured, IBM Tivoli Identity Manager manages access to MS SQL with your
site’s security system. This book describes how to install and configure the SQL
Server adapter.
References to SQL server applies to both SQL server 2000 and SQL server 2005,
unless explicitly stated otherwise.
Note: The program that is used to connect the managed resource to the IBM Tivoli
Identity Manager server is now called an adapter. The term adapter replaces
the previously used term agent. The user interface used to configure the
adapter still uses the term agent.
Who should read this book
This book is intended for MS SQL security administrators responsible for installing
software on their site’s computer systems. Readers are expected to understand
Windows 2000 concepts. The person completing the SQL Server adapter
installation procedure must also be familiar with their site’s system standards and
needs to have appropriateWindows 2000 knowledge. Readers should be able to
perform routine Windows 2000 security administration tasks.
Publications and related information
Read the descriptions of the IBM Tivoli Identity Manager library. To determine
which additional publications you might find helpful, read the “Prerequisite
product publications” on page vii and the “Related publications” on page viii.
After you determine the publications you need, refer to the instructions in
“Accessing publications online” on page viii.
Tivoli Identity Manager library
The publications in the technical documentation library for your product are
organized into the following categories:
v Release information
v Online user assistance
v Server installation and configuration
v Problem determination
v Technical supplements
v Adapter installation and configuration
Release Information:
v Release Notes
Provides software and hardware requirements for the product, and additional
fix, patch, and other support information.
v Read This First card
Lists the publications for the product.
© Copyright IBM Corp. 2002, 2006 v
Online user assistance:
Provides online help topics and an information center for administrative tasks.
Server installation and configuration:
Provides installation and configuration information for the product server.
Problem determination:
Provides problem determination, logging, and message information for the
product.
Technical supplements:
The following technical supplements are provided by developers or by other
groups who are interested in this product:
v Performance and tuning information
Provides information needed to tune your production environment, available on
the Web at:
http://publib.boulder.ibm.com/tividd/td/tdprodlist.html
Click the I character in the A-Z product list to locate IBM Tivoli Identity
Manager products. Click the link for your product, and then browse the
information center for the Technical Supplements section.
v Redbooks and white papers are available on the Web at:
http://www.ibm.com/software/sysmgmt/products/support/IBMTivoliIdentityManager.html
Browse to the Self Help section, in the Learn category, and click the Redbooks
link.
v Technotes are available on the Web at:
http://www.redbooks.ibm.com/redbooks.nsf/tips/
v Field guides are available on the Web at:
http://www.ibm.com/software/sysmgmt/products/support/Field_Guides.html
v For an extended list of other Tivoli Identity Manager resources, search the
following IBM developerWorks Web address:
http://www.ibm.com/developerworks/
Adapter installation and configuration:
The technical documentation library also includes a set of platform-specific
installation documents for the adapter components of the product. Adapter
information is available on the Web at:
http://www.lotus.com/services/passport.nsf/WebDocs/Passport_Advantage_Home
Click Support & downloads. Browse to the Downloads and drivers. Click the link
for the adapter.
Skills and training:
The following additional skills and technical training information were available at
the time that this manual was published:
vi IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
v Virtual Skills Center for Tivoli Software on the Web at:
http://www.cgselearning.com/tivoliskills/
v Tivoli Education Software Training Roadmaps on the Web at:
http://www.ibm.com/software/tivoli/education/eduroad_prod.html
v Tivoli Technical Exchange on the Web at:
http://www.ibm.com/software/sysmgmt/products/support/supp_tech_exch.html
Prerequisite product publications
To use the information in this book effectively, you must have knowledge of the
products that are prerequisites for your product. Publications are available from
the following locations:
v MS SQL
– http://www.microsoft.com/sql/techinfo/books.mspxv Operating systems
– IBM AIX
http://publib16.boulder.ibm.com/pseries/Ja_JP/infocenter/base/index.htm
– Solaris Operating Environment
http://docs.sun.com/app/docs/prod/solaris
– Red Hat Linux
http://www.redhat.com/docs/
– Microsoft Windows Server 2003
http://www.microsoft.com/windowsserver2003/proddoc/default.mspxv Database servers
– IBM DB2 Universal Database
- Support: http://www.ibm.com/software/data/db2/udb/support.html
- Information center: http://publib.boulder.ibm.com/infocenter/db2help/index.jsp
- Documentation: http://www.ibm.com/cgi-bin/db2www/data/db2/udb/winos2unix/support/v8pubs.d2w/en_main
- DB2 product family: http://www.ibm.com/software/data/db2
- Fix packs: http://www.ibm.com/software/data/db2/udb/support/downloadv8.html
- System requirements: http://www.ibm.com/software/data/db2/udb/sysreqs.html
– Oracle
http://www.oracle.com/technology/documentation/index.html
http://otn.oracle.com/tech/index.html
http://otn.oracle.com/tech/linux/index.html
– Microsoft SQL Server
http://www.msdn.com/library/
http://www.microsoft.com/sql/v Directory server applications
– IBM Directory Server http://publib.boulder.ibm.com/tividd/td/IBMDS/IDSapinst52/en_US/HTML/ldapinst.htm http://www.ibm.com/software/network/directory
Preface vii
– Sun ONE Directory Server
http://docs.sun.com/app/docs/coll/S1_DirectoryServer_52v WebSphere Application Server
Additional information is available in the product directory or Web sites. http://publib.boulder.ibm.com/infocenter/ws51help/index.jsp http://www.redbooks.ibm.com/
v WebSphere embedded messaging
http://www.ibm.com/software/integration/wmq/
v IBM HTTP Server
http://www.ibm.com/software/webservers/httpservers/library.html
Related publications
Information that is related to your product is available in the following
publications:
v The Tivoli Software Library provides a variety of Tivoli publications such as
white papers, datasheets, demonstrations, redbooks, and announcement letters.
The Tivoli Software Library is available on the Web at:
http://www.ibm.com/software/tivoli/literature/
v The Tivoli Software Glossary includes definitions for many of the technical terms
related to Tivoli software. The Tivoli Software Glossary is available from the
Glossary link of the Tivoli Software Library Web page at:
http://publib.boulder.ibm.com/tividd/glossary/tivoliglossarymst.htm
Accessing publications online
IBM posts publications for this and all other Tivoli products, as they become
available and whenever they are updated, to the Tivoli software information center
Web site. Access the Tivoli software information center at the following Web
address:
http://publib.boulder.ibm.com/tividd/td/tdprodlist.html
Click the I character in the A-Z list, and then click the link for your product to
access the product library.
Note: If you print PDF documents on other than letter-sized paper, set the option
in the File → Print window that allows Adobe Reader to print letter-sized
pages on your paper.
Accessibility
The product documentation includes the following features to aid accessibility:
v Documentation is available in convertible PDF format to give the maximum
opportunity for users to apply screen-reader software.
v All images in the documentation are provided with alternative text so that users
with vision impairments can understand the contents of the images.
Support information
If you have a problem with your IBM software, you want to resolve it quickly. IBM
provides the following ways for you to obtain the support you need:
viii IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
v Searching knowledge bases: You can search across a large collection of known
problems and workarounds, Technotes, and other information.
v Contacting IBM Software Support: If you still cannot solve your problem, and
you need to work with someone from IBM, you can use a variety of ways to
contact IBM Software Support.
For more information about these ways to resolve problems, see Appendix B,
“Support information,” on page 51.
Conventions used in this book
This reference uses several conventions for special terms and actions and for
operating system-dependent commands and paths.
Typeface conventions
This guide uses the following typeface conventions:
Bold
v Lowercase commands and mixed case commands that are otherwise
difficult to distinguish from surrounding text
v Interface controls (check boxes, push buttons, radio buttons, spin
buttons, fields, folders, icons, list boxes, items inside list boxes,
multicolumn lists, containers, menu choices, menu names, tabs, property
sheets), labels (such as Tip:, and Operating system considerations:)
v Keywords and parameters in text
Italic
v Words defined in text
v Emphasis of words (words as words)
v New terms in text (except in a definition list)
v Variables and values you must provide
Monospace
v Examples and code examples
v File names, programming keywords, and other elements that are difficult
to distinguish from surrounding text
v Message text and prompts addressed to the user
v Text that the user must type
v Values for arguments or command options
Operating system differences
This guide uses the Windows convention for specifying environment variables and
for directory notation.
When using the UNIX® command line, replace %variable% with $variable for
environment variables and replace each backslash (\) with a forward slash (/) in
directory paths. The names of environment variables are not always the same in
Windows® and UNIX. For example, %TEMP% in the Windows operating system is
equivalent to $tmp in a UNIX operating system.
Note: If you are using the bash shell on a Windows system, you can use the UNIX
conventions.
Preface ix
Definitions for HOME and other directory variables
The following table contains the default definitions that are used in this guide to
represent the HOME directory level for various product installation paths. You can
customize the installation directory and HOME directory for your specific
implementation. If this is the case, you need to make the appropriate substitution
for the definition of each variable represented in this table.
The value of path varies for these operating systems:
v Windows: drive:\Program Files
v AIX: /usr
v Other UNIX: /opt
Path Variable Default Definition Description
DB_INSTANCE_HOME Windows:
path\IBM\SQLLIB
UNIX:
v AIX, Linux: /home/dbinstancename
v Solaris: /export/home/dbinstancename
The directory that
contains the
database for your
Tivoli Identity
Manager product.
LDAP_HOME v For IBM Directory Server Version 5.2
Windows:
path\IBM\LDAP
UNIX:
path/IBM/LDAP
– AIX, Linux: path/ldap
– Solaris: path/IBMldaps
v For IBM Directory Server Version 6.0
Windows:
path\IBM\LDAP
UNIX:
/opt/IBM/ldap/
– AIX, Solaris: /opt/IBM/ldap/
– Linux: /opt/ibm/ldap/
v For Sun ONE Directory Server
Windows:
path\Sun\MPS
UNIX:
/var/Sun/mps
The directory that
contains the
directory server
code.
x IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Path Variable Default Definition Description
IDS_instance_HOME For IBM Directory Server Version 6.0
Windows:
drive\
idsslapd-instance_owner_name
The value of drive might be C:\. An
example of instance_owner_name might be
ldapdb2. For example, the log file might
be C:\idsslapd-ldapdb2\logs\ibmslapd.log.
UNIX:
INSTANCE_HOME/idsslapd-instance_name
On Linux and AIX systems, the default
home directory is the
/home/instance_name/idsslapd-instance_name directory. On Solaris
systems, for example, the directory is the
/export/home/ldapdb2/idsslapd-ldapdb2. directory.
The directory that
contains the IBM
Directory Server
Version 6.0 instance.
HTTP_HOME Windows:
path\IBMHttpServer
UNIX:
path/IBMHttpServer
The directory that
contains the IBM
HTTP Server code.
ITIM_HOME Windows:
path\IBM\itim
UNIX:
path/IBM/itim
The base directory
that contains the
Tivoli Identity
Manager code,
configuration, and
documentation.
WAS_HOME Windows:
path\WebSphere\AppServer
UNIX:
path/WebSphere/AppServer
The WebSphere
Application Server
home directory
WAS_MQ_HOME Windows:
path\ibm\WebSphere MQ
UNIX:
path/mqm
The directory that
contains the
WebSphere MQ
code.
WAS_NDM_HOME Windows:
path\WebSphere\DeploymentManager
UNIX:
path/WebSphere/DeploymentManager
The home directory
on the Deployment
Manager
Tivoli_Common_Directory Windows:
path\ibm\tivoli\common\
UNIX:
path/ibm/tivoli/common/
The central location
for all
serviceability-related
files, such as logs
and first-failure data
capture
Preface xi
xii IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Chapter 1. Overview of the SQL Server adapter
An adapter is a program that provides an interface between a managed resource
and the IBM Tivoli Identity Manager server. Adapters might or might not reside on
the managed resource and the IBM Tivoli Identity Manager server manages access
to the resource by using your security system. Adapters function as trusted virtual
administrators on the target platform, performing such tasks as creating login IDs,
suspending IDs, and performing other functions administrators normally run
manually. The adapter runs as a service, independent of whether or not a user is
logged on to the IBM Tivoli Identity Manager server.
Features of the adapter
You can use the SQL Server adapter to automate the following administrative
tasks:
v Creating an account to authorize access to SQL server .
v Modifying an existing account to access SQL server.
v Removing access to a user account. This deletes the account from the SQL
server.
v Suspending a user account by temporarily denying access to SQL server.
v Changing a user account password on SQL server.
v Reconciling user account information of all current accounts on SQL server.
v Reconciling the account information of a particular user account on SQL server
by performing a lookup.
© Copyright IBM Corp. 2002, 2006 1
2 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Chapter 2. Installing and configuring the SQL server adapter
Installing and configuring the SQL Server adapter involves several steps that you
must complete in the appropriate sequence. Review the prerequisites before you
begin the installation process. You can also create an account on the managed
resource for the adapter to use.
Prerequisites
Table 1 identifies hardware, software, and authorization prerequisites to install the
SQL Server adapter. Verify that all of the prerequisites have been met before
installing the SQL Server adapter.
Table 1. Prerequisites for installing the SQL server adapter
System v A 32-bit x86-based microprocessor.
v A minimum of 256 MB of memory.
v A minimum of 300 MB of free disk space.
Operating System v Windows 2000
v Windows 2003
v Windows XP
MS SQL Server v MSSQL2000
v MSSQL2005
The system where the adapter is installed must have SQL
connectivity to the system where the SQL Server is
installed.
Multiple Sites and Servers A single SQL Server adapter installation can be used by
an organization with multiple MS SQL sites or multiple
servers at an SQL site.
Network Connectivity TCP/IP network.
System Administrator
Authority
The person completing the SQL Server adapter
installation procedure must have system administrator
authority to complete the steps in this chapter.
Tivoli Identity Manager server
or
Tivoli Identity Manager
Express
Version 4.6
Installing the adapter
The IBM Tivoli Identity Manager SQL Server adapter installation files are available
for download from the IBM Web site. Contact your IBM account representative for
the Web address and download instructions.
In order to install the adapter, complete the following steps:
1. Download the SQL Server adapter compressed file from the IBM Web site.
2. Extract the contents of the compressed file into a temporary directory and
navigate to that directory.
© Copyright IBM Corp. 2002, 2006 3
3. Start the installation program using the setup.exe file in the temporary
directory. For example, select Run... from the Start menu and type
C:\Temp\setupwin32.exe in the Open field.
4. On the Welcome window, click Next.
5. On the License Agreement window, review the license agreement and decide if
you accept the terms of the license. If you do, click Accept, and then click Next.
6. On the Select Destination Directory window, specify where you want to install
the adapter in the Directory Name field. You can accept the default location,
C:\Tivoli\Agents\SqlServerAdapter, or click Browse to specify a different
directory. Then, click Next.
7. On the Installation Summary window, review the installation settings. Click
Back to change any of these settings. Otherwise, click Next to begin the
installation.
8. On the Installation Completed window, click Finish to exit the program.
Importing the adapter profile into the Tivoli Identity Manager server
Before you can add an adapter as a service to the Tivoli Identity Manager server,
the server must have an adapter profile to recognize the adapter as a service. The
files that are packaged with the SQL Server adapter include the adapter JAR file,
SQL2000Profile.jar. Using the Import feature of the Tivoli Identity Manager Server,
you can import the adapter profile into the server as a service profile.
The SQL2000Profile.jar file includes all of the files that are needed to define the
adapter schema, account form, service form and profile properties. The
SQL2000Profile.jar file will be referenced in this document to make any changes to
the schema or the profile. You will be required to extract the files from the JAR file,
make changes to the necessary files, and repackage the JAR file with the updated
files. For more information on how to update the JAR files, see “Copy the
SQL2000Profile.jar file and extract the files” on page 39.
Importing the adapter profile
An adapter profile defines the types of resources that the Tivoli Identity Manager
server can manage. You must import the adapter profile into the Tivoli Identity
Manager server before using the SQL Server adapter. The profile is used to create a
SQL Server adapter service on the Tivoli Identity Manager server and to
communicate with the adapter.
Before you begin to import the adapter profile, verify that the following conditions
are met:
v The Tivoli Identity Manager server must be installed and running.
v You must have root or Administrator authority on the Tivoli Identity Manager
server.
The adapter profile is included in the JAR file for the adapter. To import the
adapter profile, complete these steps:
1. Log in to the IBM Tivoli Identity Manager server using an account that has the
authority to perform administrative tasks.
2. Import the adapter profile using the import feature for your IBM Tivoli Identity
Manager product. Refer to the information center or the online help for specific
instructions about importing the adapter profile.
4 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
When you import the adapter profile, if you receive an error related to the schema,
the trace.log file will contain information about that error. The trace.log file
location is specified by the handler.file.fileDir property that is defined in the
IBM Tivoli Identity Manager enRoleLogging.properties file, which is installed in
the IBM Tivoli Identity Manager \data directory.
Creating a SQL server service
After the adapter profile is imported into the Tivoli Identity Manager server, you
must create a provisioning service to enable the IBM Tivoli Identity Manager to
communicate with the adapter.
In order to create a provisioning service, complete the following steps:
1. Log in to the IBM Tivoli Identity Manager server using an account that has the
authority to perform administrative tasks.
2. Create the service using the information for your IBM Tivoli Identity Manager
product. Refer to the information center or the online help for specific
instructions about creating a service.
3. From the list of service types, select SQL Service profile, and then click
Continue. The SQL Server adapter service form is displayed. The service form
contains the following fields:
Service Name
Specify a name that defines this SQL server service on the Tivoli
Identity Manager server. Service Name is a required field.
Description
Specify an optional description for this service.
URL Specify the location and port number of the SQL Server adapter. The
port number is defined in the protocol configuration using the agentCfg
program. For additional information about protocol configuration
settings, see “Changing protocol configuration settings” on page 8. URL
is a required field.
If https is specified as part of the URL, the adapter must be configured
to use SSL authentication. If the adapter is not configured to use SSL
authentication, specify http for the URL. For additional information
about configuring the adapter to use SSL authentication, see Chapter 4,
“Configuring SSL authentication for the SQL Server adapter,” on page
25.
User ID
Specify a Directory Access Markup Language (DAML) protocol user
name. The user name is defined in the protocol configuration using the
agentCfg program. For additional information about the protocol
configuration settings, see “Changing protocol configuration settings”
on page 8. User ID is a required field.
Password
Specify the password for the DAML protocol user name. This password
is defined in the protocol configuration using the agentCfg program.
For additional information about the protocol configuration settings, see
“Changing protocol configuration settings” on page 8. Password is a
required field.
Owner
Specify the service owner, if any. Owner is an optional field.
Chapter 2. Installing and configuring the SQL server adapter 5
Service Prerequisite
Specify an existing IBM Tivoli Identity Manager service that is a
prerequisite for the SQL server service.
SQL Server Name
Specify the instance name of SQL Server to be managed by this SQL
Server Service.
SQL Admin Account
Specify the SQL Server instance administrator account name.
SQL Admin Password
Specify the SQL Server instance administrator account password.
Configuring the adapter
Once you have installed the IBM Tivoli Identity Manager SQL Server adapter,
configuration is required to ensure that it functions properly.
In order to configure the SQL Server adapter, complete the following steps:
1. Start the SQL Server adapter service using the Windows Services Tool.
2. Configure DAML to ensure communication with the Tivoli Identity Manager
Server. For more information on configuring DAML, see “Changing protocol
configuration settings” on page 8.
3. Configure the SQL Server adapter to communicate with the Tivoli Identity
Manager server by configuring the adapter for event notification. For more
information on configuring event notification, see “Configuring event
notification” on page 12.
4. For secure communication, install a certificate on the machine where the
adapter resides and on the Tivoli Identity Manager server. For more
information on installing certificates, see Chapter 4, “Configuring SSL
authentication for the SQL Server adapter,” on page 25.
5. Install the adapter profile on the Tivoli Identity Manager server. For more
information on installing the adapter profile, see “Importing the adapter profile
into the Tivoli Identity Manager server” on page 4.
6. Use the agentCfg utility to modify the adapter parameters. For more
information on parameter configuration, refer toChapter 3, “Configuring the
SQL Server adapter for IBM Tivoli Identity Manager,” on page 7.
7. Add and then configure the service form on the Tivoli Identity Manager server.
For additional information about adding and configuring a service form, see
“Creating a SQL server service” on page 5.
8. Configure the adapter account form. For more information on configuring the
adapter account form, see the IBM Tivoli Identity Manager Information Center.
6 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli
Identity Manager
Use the adapter configuration program, agentCfg, to view or modify the SQL
Server adapter parameters. All changes that you make to parameters with this tool
take effect immediately.
Starting the adapter configuration tool
In order to start the adapter configuration tool, agentCfg, for SQL Server adapter
parameters, complete these steps:
1. From the Start Menu, select Programs → Accessories → Command Prompt.
2. At the command prompt, change to the \bin directory for the adapter. For
example, type the following command, if the SQL Server adapter is in the
default location:
cd C:\Tivoli\Agents\SqlServerAdapter\bin
3. Type the following command:
agentCfg -agent SqlServerAdapter
You can also use agentCfg to view or change configuration settings from a
remote computer. See the table in “Accessing help and additional options” on
page 22 for procedures on using additional arguments.
4. At the Enter configuration key for Agent ’SqlServerAdapter’ prompt, type the
configuration key for the SQL Server adapter.
The default configuration key is agent. You must change the configuration key
once installation completes, to prevent unauthorized access to the configuration
of the adapter. See “Changing protocol configuration settings” on page 8 for
procedures to change the configuration key.
The Main Configuration Menu is displayed.
SqlServerAdapter 4.6.1003 Agent Main Configuration Menu
-------------------------------------------
A. Configuration Settings.
B. Protocol Configuration.
C. Event Notification.
D. Change Configuration Key.
E. Activity Logging.
F. Registry Settings.
G. Advanced Settings.
H. Statistics.
I. Codepage Support.
X. Done.
Select menu option:
From the Main Menu, you can configure the protocol, view statistics, and modify
settings, including configuration, registry, and advanced settings.
Table 2. Options for the main configuration menu
Option Configuration task For more information
A Viewing protocol configuration
settings
See page 8.
© Copyright IBM Corp. 2002, 2006 7
Table 2. Options for the main configuration menu (continued)
Option Configuration task For more information
B Changing protocol configuration
settings
See page 8.
C Configuring event notification See page 12.
D Changing the configuration key See page 18.
E Changing activity logging settings See page 18.
F Changing registry settings See page 20.
G Changing advanced settings See page 20.
H Viewing statistics See page 22.
I Changing code page settings See page 22.
Viewing configuration settings
The following procedure describes how to view the SQL Server adapter
configuration settings.
1. At the Agent Main Configuration Menu, type A. The configuration settings for
the SQL Server adapter are displayed. The following screen is an example of
the SQL Server adapter configuration settings.
Configuration Settings
-------------------------------------------
Name : SqlServerAdapter
Version : 4.6.1003
ADK Version : 4.68
ERM Version : 4.68
enRole Version : 4.0
License : NONE
Asynchronous ADD Requests : FALSE (Max.Threads:3)
Asynchronous MOD Requests : FALSE (Max.Threads:3)
Asynchronous DEL Requests : FALSE (Max.Threads:3)
Asynchronous SEA Requests : FALSE (Max.Threads:3)
Available Protocols : DAML
Configured Protocols : DAML
Logging Enabled : TRUE
Logging Directory : C:\Tivoli\Agents\SqlServerAdapter\log
Log File Name : SqlServerAdapter.log
Max. log files : 3
Max.log file size (Mbytes) : 1
Debug Logging Enabled : TRUE
Detail Logging Enabled : TRUE
Thread Logging Enabled : FALSE
Press any key to continue
2. Press any key to return to the Main Menu.
Changing protocol configuration settings
The SQL Server adapter uses the DAML protocol to communicate with the Tivoli
Identity Manager server. By default, when the adapter is installed, the DAML
protocol is configured to be used in nonsecure mode. In order to configure a secure
environment, you must configure the DAML protocol to use SSL and install a
certificate. Refer to “Installing the certificate” on page 34 for more information
about installing certificates.
8 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
In previous versions of this adapter, you could add and remove protocols.
However, in the latest version of this adapter, the DAML protocol is the only
supported protocol that you can use. Therefore, you will not need to add or
remove a protocol.
In order to configure the DAML protocol for the SQL Server adapter, complete the
following steps:
1. At the Agent Main Configuration Menu, type B. The DAML protocol is
configured and available by default for the SQL Server adapter.
Agent Protocol Configuration Menu
-----------------------------------
Available Protocols: DAML
Configured Protocols: DAML
A. Add Protocol.
B. Remove Protocol.
C. Configure Protocol.
X. Done
Select menu option
2. At the Agent Protocol Configuration Menu, type C. The DAML Protocol
Properties Menu is displayed.
3. At the DAML Protocol Properties Menu, type C. The protocol properties for the
configured protocol is displayed. The properties on your menu might be
different from the ones shown in the examples.
The following screen is an example of the DAML protocol properties:
DAML Protocol Properties
--------------------------------------------------------------------
A. USERNAME ****** ;Authorized user name.
B. PASSWORD ****** ;Authorized user password.
C. MAX_CONNECTIONS 100 ;Max Connections.
D. PORTNUMBER 45580 ;Protocol Server port number.
E. USE_SSL FALSE ;Use SSL secure connection.
F. SRV_NODENAME ––––– ;Event Notif. Server name.
G. SRV_PORTNUMBER 9443 ;Event Notif. Server port number.
H. HOSTADDR ANY ;Listen on address < or "ANY" >
I. VALIDATE_CLIENT_CE FALSE ;Require client certificate.
J. REQUIRE_CERT_REG FALSE ;Require registered certificate.
X. Done
Select menu option:
4. Type the letter of the menu option for the protocol property that you want to
configure.
See Table 3 below for additional information about the properties that you can
configure for the DAML protocol.
Table 3. Options for the DAML protocol menu
Option Configuration task
A The following prompt is displayed:
Modify Property ’USERNAME’:
Type a user ID.
This value is the user ID that the Tivoli Identity Manager server uses to
connect to the adapter.
The default user ID is agent.
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 9
Table 3. Options for the DAML protocol menu (continued)
Option Configuration task
B The following prompt is displayed:
Modify Property ’PASSWORD’:
Type a password.
This value is the password for the user ID that the Tivoli Identity
Manager server uses to connect to the adapter.
The default password is agent.
C The following prompt is displayed:
Modify Property ’MAX_CONNECTIONS’:
Enter the maximum number of concurrent open connections that the
adapter supports.
The default number is 100.
D The following prompt is displayed:
Modify Property ’PORTNUMBER’:
Type a different port number.
This value is the port number that the IBM Tivoli Identity Manager
server uses to connect to the adapter. The default port number is 45580.
E The following prompt is displayed:
Modify Property ’USE_SSL’:
Enter TRUE or FALSE to specify whether a secure SSL connection will
be used to connect to or from the adapter.
The default value is FALSE.
You must install a certificate when USE_SSL is set to TRUE. For more
information on certificate installation, see “Installing the certificate” on
page 34.
F The following prompt is displayed:
Modify Property ’SRV_NODENAME’:
Type a server name or an IP address, for example, 9.38.215.20.
This value is the DNS name or IP address of the Gautam
Burse/Irvine/Contr/IBM@IBMUS, Shashank Bhatt/Austin/Contr/IBM@IBMUS, Brian Matthiesen/Irvine/IBM@IBMUS, Bassam
Hassoun/Irvine/IBM@IBMUS, Amita Gaonkar/Irvine/Contr/IBM@IBMUS, that is used for event notification and asynchronous
request processing.
Note: If your platform supports Internet Protocol version 6 (IPv6)
connections, you can specify an IPv6 server.
10 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Table 3. Options for the DAML protocol menu (continued)
Option Configuration task
G The following prompt is displayed:
Modify Property ’SRV_PORTNUMBER’:
Type a different port number to access the Tivoli Identity Manager
server.
This value is the port number that the adapter uses to connect to the
Tivoli Identity Manager server. The default port number for WebLogic is
7002. The default port number for WebSphere® Application Server
(WAS) is 9443.
H The HOSTADDR option is useful when the system where the adapter is
running has more than one network adapter. The user can select which
IP Address the adapter will listen to.
The default value is ANY.
I The following prompt is displayed:
Modify Property ’VALIDATE_CLIENT_CE’:
Type TRUE to require the Tivoli Identity Manager server to send a
certificate when it communicates with the adapter.
Type FALSE to allow the Tivoli Identity Manager server to communicate
with the adapter without a certificate. The default value is FALSE.
Notes:
1. If you set this option to TRUE, you must configure options D
through I.
2. The property name is actually VALIDATE_CLIENT_CERT. It is
truncated by agentCfg to fit onto the screen.
3. You must use CertTool to install the appropriate CA certificates and
optionally register the IBM Tivoli Identity Manager server certificate.
For more information on using CertTool, see “Managing SSL
certificates using CertTool” on page 31.
J The following prompt is displayed:
Modify Property ’REQUIRE_CERT_REG’:
This value only applies when option I is set to TRUE.
Type TRUE to require the client certificate from the Tivoli Identity
Manager server to be registered with the adapter before it will accept an
SSL connection.
Type FALSE to require the client certificate only be verified against the
list of CA certificates. The default value is FALSE.
For more information on certificates, see Chapter 4, “Configuring SSL
authentication for the SQL Server adapter,” on page 25.
5. At the prompt, change the value, and press Enter.
The Protocol Properties Menu is displayed with your new settings.
If you do not want to change the value, just press Enter to return to the
Protocol Properties Menu.
6. Repeat steps 4 and 5 to configure as many protocol properties as you need to.
7. At the Protocol Properties Menu, type X to exit the menu.
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 11
Configuring event notification
Event notification is a feature of the SQL Server adapter that updates the Tivoli
Identity Manager server at set intervals. Event notification detects changes that are
made on the managed resource and updates the Tivoli Identity Manager server
with the changes. You can enable event notification if you want to have updated
information from the managed resource sent back to the Tivoli Identity Manager
server between full reconciliations. Event notification is not intended to replace
reconciliations on the Tivoli Identity Manager server.
When event notification is enabled, a database of the reconciliation data is kept on
the machine where the adapter is installed. The database is updated with the
changes that are requested by the Tivoli Identity Manager server and will remain
synchronized with the server. You can specify an interval for the event notification
process to compare the database to data that currently exists on the managed
resource. When the interval has elapsed, any differences between the managed
resource and the database are forwarded to the Tivoli Identity Manager server and
updated in the local snapshot database.
There are several steps to enabling event notification. These steps assume that the
adapter is communicating successfully with the managed resource and the Tivoli
Identity Manager server.
First, you must configure the host name, port number, and login information for
the Tivoli Identity Manager server. In order to identify the server for the DAML
protocol to use, complete the following steps:
1. At the Agent Protocol Configuration Menu, select Configure Protocol. For more
information on configuring a protocol, see “Changing protocol configuration
settings” on page 8.
2. Type the letter of the menu option for the SRV_NODENAME property.
3. Specify the IP address or server name that identifies the IBM Tivoli Identity
Manager server, and press Enter.
The Protocol Properties Menu is displayed with your new settings.
4. Type the letter of the menu option for the SRV_PORTNUMBER property.
5. Specify the port number that the adapter uses to connect to the Tivoli Identity
Manager Server for event notification and press Enter.
The Protocol Properties Menu is displayed with your new settings.
The example menu shows all of the options displayed when Event Notification is
enabled. If Event Notification is disabled, not all of the options are displayed. In
order to set Event Notification for the Tivoli Identity Manager server, complete the
following steps:
1. At the Agent Main Configuration Menu, type C. The Event Notification Menu is
displayed.
12 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Event Notification Menu
--------------------------------------
* User account object class : erSQL2000Account
* Password attributes : erPassword
* Reconciliation interval : 1 day(s)
* Next Reconciliation time : 23 hour(s) 11 min(s). 58 sec(s).
* Configured Contexts : context1
A. Enabled
B. Time interval between reconciliations.
C. Set processing cache size.(currently: 50 Mbytes)
D. Start event notification now.
E. Set attributes to be reconciled.
F. Reconciliation process priority (current: 1).
G. Add Event Notification Context.
H. Modify Event Notification Context.
I. Remove Event Notification Context.
J. List Event Notification Contexts.
K. Change user account object class.
L. Set password attribute names.
X. Done
Select menu option:
Note: This menu shows all of the options that are displayed when Event
Notification is enabled. If Event Notification is disabled, all of the
options will not be displayed.
2. Type the letter of the menu option that you want to change.
Option A must be enabled in order for the values of the other options to take
effect.
Press Enter to return to the Agent Event Notification Menu without changing
the value.
Table 4. Options for the event notification menu
Option Configuration task
A If this option is enabled, the adapter updates the Tivoli Identity Manager
server with changes to the adapter at regular intervals.
When the option is set to:
v Disabled, pressing the A key changes to enabled
v Enabled, pressing the A key changes to disabled
Type A to toggle between the options.
B The following prompt is displayed:
Enter new interval
([ww:dd:hh:mm:ss])
Type a different reconciliation interval. For example,
[00:01:00:00:00]
Note: This value is the interval to wait once event notification completes
before it is run again. The event notification process is resource
intensive, therefore this value must not be set to run too frequently.
C The following prompt is displayed:
Enter new cache size[50]:
Type a different value to change the processing cache size.
D If this option is selected, event notification is started.
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 13
Table 4. Options for the event notification menu (continued)
Option Configuration task
E The Event Notification Entry Types Menu is displayed. See “Setting
event notification triggers” on page 15 for more information.
F The following prompt is displayed:
Enter new thread priority [1-10]:
Type a different thread value to change the event notification process
priority.
Note: Setting the thread priority to a lower value reduces the impact
that the event notification process has on the performance of the adapter.
A lower value might also cause event notification to take longer.
G The following prompt is displayed:
Enter new context name:
Type the new context name, and press Enter. The new context is added.
H A menu listing the available contexts is displayed. See “Modifying an
event notification context” on page 15 for more information.
I The Remove Context Menu is displayed. Select the context to remove.
The following prompt is then displayed:
Delete context context1? [no]:
Press Enter to exit without deleting the context, or type Yes and press
Enter to delete the context.
J The Event Notification Contexts are displayed in the following format:
Context Name : Context1
Target DN :
erservicename=context1,o=IBM,
ou=IBM,dc=com
--- Attributes for search request ---
{search attributes listed}
-----------------------------------------------
K Name of the SQL account object class. This is applicable only for
adapters that do not use xforms.xml. This is set to “erSQL2000Account”
when the adapter is installed.
The following prompt is shown:
Enter class name for user account object:
Type an object class name to configure the adapter to use during event
notification.
Note: Do not change this. Changing the value results in the adapter not
functioning correctly during event notification.
K Names of password attributes can be supplied so that they are not
tracked in the event notification database.
The following prompt is shown.
Enter password attribute names (comma separated - no spaces):
Enter the names of all the password-type attributes separated by a
comma without any spaces in between. This value is currently set to
erPassword.
3. If you changed the value for options B, C, E, or F, press Enter. The other
options are automatically changed when you type the corresponding letter of
the menu option.
14 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
The Event Notification Menu is displayed with your new settings.
Setting event notification triggers
By default, all attributes are queried for value changes. Certain attributes that
change frequently (for example, password age or last successful logon) must be
omitted.
1. At the Event Notification Menu, type E. The Event Notification Entry Types
Menu is displayed.
Event Notification Entry Types
-------------------------------------------
A. erSQL2000Account
B. erSQL2000DatabaseGroupAccount
C. erSQL2000DatabaseRoleGroup
D. erSQL2000ServerRoleGroup
X. Done
Select menu option:
The USER and GROUP types do not appear in the above menu until the
following conditions have been met:
a. Event notification has been enabled
b. A context has been created and configured
c. A full reconciliation has been run2. Type A for a list of the attributes returned during a user reconciliation, or type B
for attributes returned during a group reconciliation.
The Event Notification Attribute Listing for the selected reconciliation type is
displayed. The default setting lists all attributes that the adapter supports. The
example below lists example attributes, and might differ from the list that is
displayed on your machine.
Event Notification Attribute Listing
-------------------------------------
(A) **erAccountStatus (B) **erSQLDefDatabase (C) **erSQL2000DefLanguage
(D) **erSQL2000ServerRole (E) **ersqldbrole (F) **ersqldbuser
(G) **erUid
(p)rev Page 1 of 1 (n)ext
-----------------------------
X. Done
3. Type the letter of the menu option for the attribute to exclude from an event
notification.
Attributes that are marked with two asterisks (**) are returned during the event
notification. Attributes that are not marked with asterisks are not returned
during the event notification.
Modifying an event notification context
An event notification context corresponds to a service on the Tivoli Identity
Manager server. Some adapters support multiple services. One SQL Server adapter
can have several IBM Tivoli Identity Manager services, by specifying a different
base point for each service.
The base point for the SQL Server adapter is the point in the directory server that
is used as the root for the adapter. This point can be an organizational unit (OU) or
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 15
domain container (DC) base point. Because the base point is an optional value, if a
value is not specified, the adapter uses the default domain of the machine on
which it is installed.
You can have multiple event notification contexts, but you must have at least one
adapter. In the example screen below, note that Context1, Context2, and Context3
are three different contexts, all having a different base point.
In order to modify an event notification context, complete the following steps:
1. At the Event Notification Menu, type H. The Modify Context Menu is
displayed.
Modify Context Menu
------------------------------
A. Context1
B. Context2
C. Context3
X. Done
Select menu option:
2. Type the letter of the menu option that you want to modify. The Modify
Context Menu for the selected context is displayed.
A. Set attributes for search
B. Target DN:
C. Delete Baseline Database
X. Done
Select menu option:
Table 5. Options for the modify context menu
Option Configuration task For more information
A Adding search attributes for event notification. See page 16.
B Configuring the target DN for event notification
contexts.
See page 17.
C Removing the baseline database for event
notification contexts.
See page 17.
Adding search attributes for event notification
For some adapters, you might need to specify an attribute-value pair for one or
more contexts. These attribute-value pairs, which are defined by completing the
steps below, serve multiple purposes:
v When multiple services are supported by a single adapter, each service needs to
specify one or more attributes to differentiate it from the other services.
v The search attributes are passed to the event notification process, once the event
notification interval has occurred or is started manually. For each context, a full
search request is sent to the adapter. Additionally, the attributes specified for
that context are passed to the adapter.
v When the Tivoli Identity Manager server initiates a reconciliation process, the
adapter replaces the local database that represents this service with the new
database.
In order to add search attributes, complete the following steps:
1. At the Modify Context Menu for the context, type A. The Reconciliation
Attribute Passed to Agent Menu is displayed.
16 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Reconciliation Attributes Passed to Agent for Context: Context1
----------------------------------------------------
----------------------------------------------------
A. Add new attribute
B. Modify attribute value
C. Remove attribute
X. Done
Select menu option:
The following attributes are required to be specified for each event notification
context along with the value specified for that attribute on the service form:
v erSQL2000ServerName : SQL Server Name value
v erSQL2000AdminAccount : SQL Admin Account value
v erSQL2000AdminPassword : SQL Admin Password value
2. Type the letter of the menu option that you want to change.
The supported attribute names will be displayed with two asterisks (**) in front
of each name. When you type the letter of an attribute, it will toggle the
asterisks on and off. Attributes without asterisks will not be updated during an
event notification.
The Reconciliation Attributes Passed to Agent Menu is displayed with the
changes displayed.
Configuring the target DN for event notification contexts
The target DN field holds the unique name of the service that receives event
notification updates.
In order to configure the target DN, complete the following steps:
1. At the Modify Context Menu for the context, type B.
2. At the Enter Target DN prompt, type the target DN for the context, and press
Enter. The target DN for the event notification context must be in the following
format:
erservicename=erservicename,o=organizationname,ou=tenantname,rootsuffix
Each element of the DN is defined as follows:
Table 6. DN elements and definitions
Element Definition
erservicename Specifies the name of the target service.
o Specifies the name of the organization.
ou Specifies the name of the tenant in which
the organization is in.
rootsuffix Specifies the root of the directory tree.
The Modify Context Menu is displayed with the new target DN listed.
Removing the baseline database for event notification contexts
This option is only available once a context is created and a reconciliation is run on
the context to create a Baseline Database file.
At the Modify Context Menu for the context, type C. The Modify Context Menu is
displayed with the Delete Baseline Database option removed.
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 17
Changing the configuration key
You use the configuration key as a password to access the configuration tool for
the adapter.
In order to change the SQL Server adapter configuration key, complete the
following steps:
1. At the Main Menu prompt, type D.
2. Change the value of the configuration key, and press Enter.
Press Enter to return to the Main Configuration Menu without changing the
configuration key. The default configuration key is agent. Make sure that you
choose passwords that cannot be easily guessed.
The following message is displayed:
Configuration key successfully changed.
The configuration program exits, and the Main Menu prompt is displayed.
Changing activity logging settings
When you enable logging, SQL Server adapter maintains a dated log file of all
transactions, SqlServerAdapter.log. By default, the log file is in the \log directory.
In order to change the SQL Server adapter activity logging settings, complete the
following steps:
1. At the Main Menu prompt, type E.
The Agent Activity Logging Menu is displayed. The following example shows
the default activity logging settings.
Agent Activity Logging Menu
-------------------------------------
A. Activity Logging (Enabled).
B. Logging Directory (current: C:\Tivoli\Agents\SqlServerAdapter\log).
C. Activity Log File Name (current: SqlServerAdapter.log).
D. Activity Logging Max. File Size ( 1 mbytes).
E. Activity Logging Max. Files ( 3 ).
F. Debug Logging (Enabled).
G. Detail Logging (Enabled).
H. Base Logging (Enabled).
I. Thread Logging (Disabled).
X. Done
Select menu option:
2. Type the letter of the Activity Logging Menu option that you want to change.
Option A must be enabled in order for the values of the other options to take
effect.
Press Enter to return to the Agent Activity Logging Menu without changing the
value.
18 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Table 7. Options for the activity logging menu
Option Configuration task
A Set this option to enabled to have the adapter maintain a dated log file
of all transactions.
When the option is set to:
v Disabled, pressing the A key changes to enabled.
v Enabled, pressing the A key changes to disabled.
Type A to toggle between the options.
B The following prompt is displayed:
Enter log file directory:
Type a different value for the logging directory, for example, C:\Log.
When the logging option is enabled, details about each access request
are stored in the logging file that is in this directory.
C The following prompt is displayed:
Enter log file name:
Type a different value for the log file name. When the logging option is
enabled, details about each access request are stored in the logging file.
D The following prompt is displayed:
Enter maximum size of log files (mbytes):
Type a new value, for example, 10. The oldest data is archived when the
log file reaches the maximum file size. File size is measured in
megabytes. It is possible for the activity log file size to exceed disk
capacity.
E The following prompt is displayed:
Enter maximum number of log files to retain:
Type a new value up to 100, for example, 5. The adapter automatically
deletes the oldest activity logs beyond the specified limit.
F If this option is set to enabled, the adapter includes the debug
statements in the log file of all transactions.
When the option is set to:
v Disabled, pressing the F key changes the value to enabled
v Enabled, pressing the F key changes the value to disabled
Type F to toggle between the options.
G If this option is set to enabled, the adapter maintains a detailed log file
of all transactions. The detail logging option must be used for diagnostic
purposes only. Detailed logging enables more messages from the adapter
and might increase the size of the logs.
When the option is set to:
v Disabled, pressing the G key changes the value to enabled
v Enabled, pressing the G key changes the value to disabled
Type G to toggle between the options.
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 19
Table 7. Options for the activity logging menu (continued)
Option Configuration task
H If this option is set to enabled, the adapter maintains a log file of all
transactions in the Adapter Development Kit (ADK) and library files.
Base logging will substantially increase the size of the logs.
When the option is set to:
v Disabled, pressing the H key changes the value to enabled
v Enabled, pressing the H key changes the value to disabled
Type H to toggle between the options.
I If this option is enabled, the log file will contain thread IDs, in addition
to a date and timestamp on every line of the file.
When the option is set to:
v Disabled, pressing the I key changes the value to enabled
v Enabled, pressing the I key changes the value to disabled
Type I to toggle between the options.
3. Press Enter if you changed the value for option B, C, D, or E. The other options
are changed automatically when you type the corresponding letter of the menu
option.
The Agent Activity Logging Menu is displayed with your new settings.
Changing registry settings
Note: Changing registry settings is not supported.
To view the SQL Server adapter registry settings panel:
1. At the Main Menu, type F. The Registry Menu is displayed.
SqlServerAdapter 4.6.1003 Agent Registry Menu
-------------------------------------------
A. Modify Non-encrypted registry settings.
B. Modify encrypted registry settings.
C. Multi-instance settings.
X. Done
Select menu option:
2. Type X to return to the Main Configuration Menu.
Changing advanced settings
You can change the SQL Server adapter thread count settings for the following
types of requests:
v System Login Add
v System Login Change
v System Login Delete
v Reconciliation
These settings determine the maximum number of requests that the SQL Server
adapter processes concurrently. In order to change these settings, complete the
following steps:
20 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
1. At the Main Menu prompt, type G.
The Advanced Settings Menu is displayed. The following example shows the
default thread count settings.
SqlServerAdapter 4.6.1003 Advanced Settings Menu
-------------------------------------------
A. Single Thread Agent (current:FALSE)
B. ADD max. thread count. (current:3)
C. MODIFY max. thread count. (current:3)
D. DELETE max. thread count. (current:3)
E. SEARCH max. thread count. (current:3)
F. Allow User EXEC procedures (current:FALSE)
G. Archive Request Packets (current:FALSE)
H. UTF8 Conversion support (current:TRUE)
I. Pass search filter to agent (current:FALSE)
J. Thread Priority Level (1-10) (current:4)
X. Done
Select menu option:
2. Type the letter of the menu option of the advanced setting that you want to
change. For a description of each option, see Table 8.
Table 8. Options for the advanced settings menu
Option Description
A Forces the adapter to allow only one request at a time.
The default value is TRUE.
B Controls how many simultaneous ADD requests can run at one time.
The default value is 3.
C Controls how many simultaneous MODIFY requests can run at one time.
The default value is 3.
D Controls how many simultaneous DELETE requests can run at one time.
The default value is 3.
E Controls how many simultaneous SEARCH requests can run at one time.
The default value is 3.
F Determines whether the adapter allows pre- and post-exec functions.
Enabling this option is a potential security risk.
The default value is FALSE.
G This option is no longer supported.
H This option is no longer supported.
I Currently, this adapter does not support processing filters directly. This
option must always be FALSE.
J Sets the thread priority level for the adapter.
The default value is 4.
3. Change the value, and press Enter.
The Advanced Settings Menu is displayed with your new settings.
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 21
Viewing statistics
In order to view an event log for the SQL Server adapter, complete the following
steps:
1. At the Main Menu prompt, type H.
The activity history for the adapter is displayed.
SqlServerAdapter 4.6.1003 Agent Request Statistics
--------------------------------------------------------------------
Date Add Mod Del Ssp Res Rec
-----------------------------------------------------------------
-----------------------------------------------------------------
X. Done
Select menu option:
2. Type X to return to the Main Configuration Menu.
Changing code page settings
In order to list the supported code page information for the SQL Server adapter,
the adapter must be running. Run the following command to view the code page
information:
agentCfg -agent [adapter_name] -codepages
In order to change the code page settings for the SQL Server adapter, complete the
following steps:
1. At the Main Menu prompt, type I.
The Code Page Support Menu for the adapter is displayed.
SqlServerAdapter 4.6.1003 Codepage Support Menu
-------------------------------------------
* Configured codepage: US-ASCII
-------------------------------------------
*
*******************************************
* Restart Agent After Configuring Codepages
*******************************************
A. Codepage Configure.
X. Done
Select menu option:
2. Type A to configure a code page.
Note: The SqlServerAdapter code page uses unicode, therefore this option is
not applicable.
3. Type X to return to the Main Configuration Menu.
Accessing help and additional options
In order to access the agentCfg help menu and use the help arguments, complete
the following steps:
22 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
1. At the Main Menu prompt, type X. The command prompt is displayed, and
you are in the \bin directory.
2. Type agentCfg -help at the prompt to view the help menu.
The following list of possible commands is displayed:
-version ; Show version
-hostname < value> ; Target nodename to connect to (Default:Local host IP address)
-findall ; Find all agents on target node
-list ; List available agents on target node
-agent <value> ; Name of agent
-tail ; Display agent’s activity log
-schema ; Display agent’s attribute schema
-portnumber <value>; Specified agent’s TCP/IP port number
-netsearch <value> ; Lookup agents hosted on specified subnet
-confidencetest ; Confidence test
-setup ; Confidence test setup
-help ; Display this help screen
Table 9 describes each argument.
Table 9. Arguments and descriptions for the agentCfg help command
Argument Description
-version Use this argument to display the version of the agentCfg tool.
-hostname value Use the -hostname argument with any of the following
arguments to specify a different host:
v -findall
v -list
v -tail
v -agent
Enter a host name or IP address as the value.
-findall Use this argument to search and display all port addresses
between 44970 and 44994 and their assigned adapter names.
This option will timeout on unused port numbers, so it might
take several minutes to complete.
Add the -hostname argument to search a remote host.
-list Use this argument to display the adapters that are installed
on the local host of the SQL Server adapter. By default, the
first time you install an adapter, it is either assigned to port
address 44970 or to the next available port number. All
subsequently installed adapters are then assigned to the next
available port address. Once an unused port is found, the
listing stops.
Use the -hostname argument to search a remote host.
-agent value Use this argument to specify the adapter that you want to
configure. Enter an adapter name as the value. Use this
argument with the -hostname argument to modify the
configuration setting from a remote host. You can also use
this argument with the -tail argument.
-tail Use this argument with the -agent argument to display the
activity log for an adapter. Add the -hostname argument to
display the log file for an adapter on a different host.
-schema This option is no longer supported.
Chapter 3. Configuring the SQL Server adapter for IBM Tivoli Identity Manager 23
Table 9. Arguments and descriptions for the agentCfg help command (continued)
Argument Description
-portnumber value Use this argument with the -agent argument to specify the
port number that is used for connections for the agentCfg
tool.
-netsearch value Use this argument with the -findall argument to display all
active adapters on the system. You must specify a subnet
address as the value.
-confidencetest Use this argument to run a test to add, modify, search, and
delete a request to the adapter. The confidence test allows
you to test the connection between the adapter and the MS
SQL . This allows you to verify that the adapter can connect
to MS SQL without the IBM Tivoli Identity Manager server.
-setup Use this argument, along with the −confidence argument, to
configure the confidence test.
-help Use this argument to display the Help information for the
agentCfg command.
-codepages Use this argument to display a list of available codepages.
3. Type agentCfg and one or more of the supported arguments at the prompt.
You must type agentCfg before every argument to run the adapter
configuration tool.
Type agentCfg -list to list all of the adapters on the local host IP address.
Note that the port address for the IBM Tivoli Identity Manager server is 44970.
The output is similar to the following output:
Agent(s) installed on node ’127.0.0.1’
-----------------------
SqlServerAdapter (44970)
Type agentCfg -agent SqlServerAdapter to display the Main Menu of the
agentCfg tool, which is used to view or modify the SQL Server adapter
parameters.
Type agentCfg -list -hostname 192.9.200.7 to list the adapters on a host
whose IP address is 192.9.200.7. The output is similar to the following output:
Agent(s) installed on node ’192.9.200.7’
------------------
SqlServerAdapter (44970)
Type agentCfg -agent SqlServerAdapter -hostname 192.9.200.7 to display the
Main Menu of the agentCfg tool for a host whose IP address is 192.9.200.7. Use
the menu options to view or modify the SQL Server adapter parameters.
24 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Chapter 4. Configuring SSL authentication for the SQL Server
adapter
In order to establish a secure connection between a IBM Tivoli Identity Manager
adapter and the Tivoli Identity Manager server, you must configure the adapter
and the server to use the Secure Sockets Layer (SSL) authentication with the
default communication protocol, DAML. By configuring the adapter for SSL, you
ensure that the Tivoli Identity Manager server verifies the identity of the adapter
before a secure connection is established.
You can configure SSL authentication for connections that originate from the Tivoli
Identity Manager server or from the adapter. Typically, the Tivoli Identity Manager
server initiates a connection to the adapter in order to set or retrieve the value of a
managed attribute on the adapter. However, depending on the security
requirements of your environment, you might need to configure SSL authentication
for connections that originate from the adapter. For example, if the adapter uses
events to notify the Tivoli Identity Manager server of changes to attributes on the
adapter, you can configure SSL authentication for Web connections that originate
from the adapter to the Web server used by the Tivoli Identity Manager server.
In a production environment, you need to enable SSL security; however, for testing
purposes you might want to disable SSL. If an external application that
communicates with the adapter (such as the Tivoli Identity Manager server) is set
to use server authentication, you must enable SSL on the adapter to verify the
certificate that the application presents.
This chapter presents an overview of SSL authentication, certificates, and how to
enable SSL authentication using the CertTool utility.
Overview of SSL and digital certificates
When you deploy IBM Tivoli Identity Manager in an enterprise network, you must
secure communication between the Tivoli Identity Manager server and the
software products and components with which the server communicates. The
industry-standard SSL protocol, which uses signed digital certificates from a
certificate authority (CA) for authentication, is used to secure communication in a
IBM Tivoli Identity Manager deployment. Additionally, SSL provides encryption of
the data exchanged between the applications. Encryption makes data transmitted
over the network intelligible only to the intended recipient.
Signed digital certificates enable two applications connecting in a network to
authenticate each other’s identity. An application acting as an SSL server presents
its credentials in a signed digital certificate to verify to an SSL client that it is the
entity it claims to be. An application acting as an SSL server can also be configured
to require the application acting as an SSL client to present its credentials in a
certificate, thereby completing a two-way exchange of certificates. Signed
certificates are issued by a third-party certificate authority for a fee. Some utilities,
such as those provided by OpenSSL, can also issue signed certificates.
A certificate-authority certificate (CA certificate) must be installed to verify the
origin of a signed digital certificate. When an application receives another
application’s signed certificate, it uses a CA certificate to verify the originator of
© Copyright IBM Corp. 2002, 2006 25
the certificate. A certificate authority can be well-known and widely used by other
organizations, or it can be local to a specific region or company. Many applications,
such as Web browsers, are configured with the CA certificates of well−known
certificate authorities to eliminate or reduce the task of distributing CA certificates
throughout the security zones in a network.
Private keys, public keys, and digital certificates
Keys, digital certificates, and trusted certificate authorities are used to establish and
verify the identities of applications.
SSL uses public key encryption technology for authentication. In public key
encryption, a public key and a private key are generated for an application. Data
encrypted with the public key can only be decrypted using the corresponding
private key. Similarly, the data encrypted with the private key can only be
decrypted using the corresponding public key. The private key is
password-protected in a key database file so that only the owner can access the
private key to decrypt messages that are encrypted using the corresponding public
key.
A signed digital certificate is an industry-standard method of verifying the
authenticity of an entity, such as a server, client, or application. In order to ensure
maximum security, a certificate is issued by a third-party certificate authority. A
certificate contains the following information to verify the identity of an entity:
Organizational information
This section of the certificate contains information that uniquely identifies
the owner of the certificate, such as organizational name and address. You
supply this information when you generate a certificate using a certificate
management utility.
Public key
The receiver of the certificate uses the public key to decipher encrypted
text sent by the certificate owner to verify its identity. A public key has a
corresponding private key that encrypts the text.
Certificate authority’s distinguished name
The issuer of the certificate identifies itself with this information.
Digital signature
The issuer of the certificate signs it with a digital signature to verify its
authenticity. This signature is compared to the signature on the
corresponding CA certificate to verify that the certificate originated from a
trusted certificate authority.
Web browsers, servers, and other SSL-enabled applications generally accept as
genuine any digital certificate that is signed by a trusted certificate authority and is
otherwise valid. For example, a digital certificate can be invalidated because it has
expired or the CA certificate used to verify it has expired, or because the
distinguished name in the digital certificate of the server does not match the
distinguished name specified by the client.
Self-signed certificates
You can use self-signed certificates to test an SSL configuration before you create
and install a signed certificate issued by a certificate authority. A self-signed
certificate contains a public key, information about the owner of the certificate, and
the owner’s signature. It has an associated private key, but it does not verify the
origin of the certificate through a third-party certificate authority. Once you
26 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
generate a self-signed certificate on an SSL server application, you must extract it
and add it to the certificate registry of the SSL client application.
This procedure is the equivalent of installing a CA certificate that corresponds to a
server certificate. However, you do not include the private key in the file when
you extract a self-signed certificate to use as the equivalent of a CA certificate.
Use a key management utility to generate a self-signed certificate and a private
key, to extract a self-signed certificate, and to add a self-signed certificate.
Where and how you choose to use self-signed certificates depends on your security
requirements. In order to achieve the highest level of authentication between
critical software components, do not use self-signed certificates, or use them
selectively. For example, you can choose to authenticate applications that protect
server data with signed digital certificates, and use self-signed certificates to
authenticate Web browsers or IBM Tivoli Identity Manager adapters.
If you are using self-signed certificates, in the following procedures you can
substitute a self-signed certificate for a certificate and CA certificate pair.
Certificate and key formats
Certificates and keys are stored in files with the following formats:
.pem format
A privacy-enhanced mail (.pem ) format file begins and ends with the
following lines:
-----BEGIN CERTIFICATE-----
-----END CERTIFICATE-----
A .pem file format supports multiple digital certificates, including a
certificate chain. If your organization uses certificate chaining, use this
format to create CA certificates.
.arm format
An .arm file contains a base-64 encoded ASCII representation of a
certificate, including its public key, but not its private key. An .arm file
format is generated and used by the IBM Key Management utility.
.der format
A .der file contains binary data. A .der file can only be used for a single
certificate, unlike a .pem file, which can contain multiple certificates.
.pfx format (PKCS12)
A PKCS12 file is a portable file that contains a certificate and a
corresponding private key. This format is useful for converting from one
type of SSL implementation to a different implementation. For example,
you can create and export a PKCS12 file using the IBM Key Management
utility, then import the file to another machine using the CertTool utility.
The use of SSL authentication
When you start the adapter, the available connection protocols are loaded. The
DAML protocol is the only available protocol that supports the use of SSL
authentication. You can specify to use the DAML SSL implementation.
The DAML SSL implementation uses a certificate registry to store private keys and
certificates. The location of the certificate registry is managed internally by the
Chapter 4. Configuring SSL authentication for the SQL Server adapter 27
CertTool key and certificate management tool; therefore, you do not specify the
location of the registry when you perform certificate management tasks.
For more information on the DAML protocol, see “Changing protocol
configuration settings” on page 8.
Configuring certificates for SSL authentication
Use the following procedures to configure the adapter for one-way or two-way SSL
authentication using signed certificates. In order to perform these procedures, use
the CertTool utility.
Configuring certificates for one-way SSL authentication
In this scenario, the IBM Tivoli Identity Manager Server and the Tivoli Identity
Manager adapter are set to use SSL. Client authentication is not set on either
application. The Tivoli Identity Manager Server operates as the SSL client and
initiates the connection. The adapter operates as the SSL server and responds by
sending its signed certificate to the Tivoli Identity Manager Server. The Tivoli
Identity Manager Server uses the CA certificate that is installed to validate the
certificate sent by the adapter.
In Figure 1, the first application operates as the Tivoli Identity Manager server, and
the second application operates as the IBM Tivoli Identity Manager adapter.
In order to configure one-way SSL, perform the following tasks for each
application:
1. On the adapter, complete these steps:
a. Start the CertTool utility.
b. In order to configure the SSL-server application with a signed certificate
issued by a certificate authority:
1) Create a certificate signing request (CSR) and private key. This step
creates the certificate with an embedded public key and a separate
private key and places the private key in the PENDING_KEY registry
value.
2) Submit the CSR to the certificate authority using the instructions
supplied by the CA. When you submit the CSR, specify that you want
the root CA certificate returned with the server certificate.2. On the Tivoli Identity Manager Server, complete one of these steps:
Hello
Tivoli Identity ManagerServer (SSL client)
KeystoreCA
CertificateA
1
Send Certificate B
Tivoli Identity Manageradapter (SSL server)C
CertificateA
Verify
Figure 1. One-way SSL authentication (server authentication)
28 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
v If you are configuring the use of a signed certificate issued by a well-known
CA, ensure that the Tivoli Identity Manager Server has stored the root
certificate of the CA (CA certificate) in its keystore. If the keystore does not
contain the CA certificate, extract the CA certificate from the adapter and add
it to the keystore of the server.
v If you are configuring the use of self-signed certificates:
– If you generated the self-signed certificate on the Tivoli Identity Manager
Server, the certificate is already installed in its keystore.
– If you generated the self-signed certificate using the key management
utility of another application, extract the certificate from that application’s
keystore and add it to the keystore of the Tivoli Identity Manager Server.
Configuring certificates for two-way SSL authentication
In this scenario, the IBM Tivoli Identity Manager Server and the Tivoli Identity
Manager adapter are set to use SSL and the adapter is set to use client
authentication. Once sending its certificate to the Tivoli Identity Manager Server,
the adapter requests identity verification from the server, which sends its signed
certificate to the adapter. Both applications are configured with signed certificates
and corresponding CA certificates.
In Figure 2, the Tivoli Identity Manager server operates as the first application, and
the IBM Tivoli Identity Manager adapter operates as the second application.
The following procedure assumes that you have already configured the adapter
and Tivoli Identity Manager Server for one-way SSL authentication using the
procedure described in “Configuring certificates for one-way SSL authentication”
on page 28. Therefore, if you are using signed certificates from a CA:
v The adapter is configured with a private key and a signed certificate that was
issued by a CA.
v The Tivoli Identity Manager Server is configured with the CA certificate of the
CA that issued the signed certificate of the adapter.
In order to complete the certificate configuration for two-way SSL, perform the
following tasks:
CHello
KeystoreCA
CertificateA
CertificateB
CertificateA
CACertificate
B
Send Certificate A
Tivoli Identity Manageradapter (SSL server) C
Tivoli Identity ManagerServer (SSL client)
Send Certificate AVerify
Verify
Send Certificate B
Figure 2. Two-way SSL authentication (client authentication)
Chapter 4. Configuring SSL authentication for the SQL Server adapter 29
1. On the Tivoli Identity Manager Server, create a CSR and private key, obtain a
certificate from a CA, install the CA certificate, install the newly signed
certificate, and extract the CA certificate to a temporary file.
2. On the adapter, add the CA certificate that was extracted from the keystore of
the Tivoli Identity Manager Server to the adapter.
When you have finished the two-way certificate configuration, each application has
its own certificate and private key and the CA certificate of the CA that issued the
certificates for each application.
Configuring certificates when the adapter operates as an SSL
client
In this scenario, the adapter operates as an SSL client in addition to operating as
an SSL server. This scenario applies if the adapter initiates a connection to the Web
server (used by the Tivoli Identity Manager server) to send an event notification.
For example, the adapter initiates the connection and the Web server responds by
presenting its certificate to the adapter.
Figure 3 illustrates how a IBM Tivoli Identity Manager adapter operates as an SSL
sever and an SSL client. When communicating with the Tivoli Identity Manager
server, the adapter sends its certificate for authentication. When communicating
with the Web server, the adapter receives the certificate of the Web server.
If the Web Server is configured for two-way SSL authentication, it verifies the
identity of the adapter, which sends its signed certificate to the Web server (not
shown in the illustration). In order to enable two-way SSL authentication between
the adapter and Web server, use the following procedure:
1. Configure the Web server to use client authentication.
2. Follow the procedure for creating and installing a signed certificate on the Web
server.
3. Install the CA certificate on the adapter using the CertTool utility.
4. Add the CA certificate corresponding to the signed certificate of the adapter to
the Web server.
TivoliIdentityManagerAdapter
TivoliIdentityManagerServer
CA Certificate ACertificate ACA Certificate C
Certificate C
Web server
A B
C
Hello
Certificate A
Hello
Certificate C
Figure 3. IBM Tivoli Identity Manager adapter operating as an SSL server and an SSL client
30 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
For more information on configuring certificates when the adapter initiates a
connection to the Web server (used by the Tivoli Identity Manager Server) to send
an event notification, see the Tivoli Identity Manager Information Center.
Managing SSL certificates using CertTool
The procedures in this section describe how to use the CertTool utility to manage
private keys and certificates.
This section includes instructions for performing the following tasks:
v “Starting CertTool.”
v “Generating a private key and certificate request” on page 33.
v “Installing the certificate” on page 34.
v “Installing the certificate and key from a PKCS12 file” on page 34.
v “Viewing the installed certificate” on page 35.
v “Viewing CA certificates” on page 35.
v “Installing a CA certificate” on page 35.
v “Deleting a CA certificate” on page 35.
v “Viewing registered certificates” on page 36.
v “Registering a certificate” on page 36.
v “Unregistering a certificate” on page 36.
Starting CertTool
In order to start the certificate configuration tool, CertTool, for the SQL Server
adapter, complete these steps:
1. Select Programs from the Start menu, select Accessories, and then select
Command Prompt.
2. In the Microsoft Windows DOS Command Prompt window, change to the bin
directory for the adapter. For example, if the SQL Server adapter directory is in
the default location, type the following command:
cd C:\Tivoli\Agents\SqlServerAdapter\bin
3. Type CertTool -agent SqlServerAdapter at the prompt. The Main Menu is
displayed:
Main menu - Configuring agent: SqlServerAdapter
------------------------------
A. Generate private key and certificate request
B. Install certificate from file
C. Install certificate and key from PKCS12 file
D. View current installed certificate
E. List CA certificates
F. Install a CA certificate
G. Delete a CA certificate
H. List registered certificates
I. Register certificate
J. Unregister a certificate
K. Export certificate and key to PKCS12 file
X. Quit
Choice:
Chapter 4. Configuring SSL authentication for the SQL Server adapter 31
From the Main Menu, you can generate a private key and certificate request, install
and delete certificates, register and unregister certificates, and list certificates. The
following sections summarize the purpose of each group of options.
The first set of options (A through D) allows you to generate a CSR and install the
returned signed certificate on the adapter.
A. Generate private key and certificate request
Generate a CSR and the associated private key that is sent to the certificate
authority. For more information on option A, see “Generating a private key
and certificate request” on page 33.
B. Install certificate from file
Install a certificate from a file. This file must be the signed certificate
returned by the CA in response to the CSR that is generated by option A.
For more information on option B, see “Installing the certificate” on page
34.
C. Install certificate and key from a PKCS12 file
Install a certificate from a PKCS12 format file that includes both the public
certificate and a private key. If options A and B are not used to obtain a
certificate, the certificate that you use must be in PKCS12 format. For more
information on option C, see “Installing the certificate and key from a
PKCS12 file” on page 34.
D. View current installed certificate
View the certificate that is installed on the system. For more information
on option D, see “Viewing the installed certificate” on page 35.
The second set of options enable you to install root CA certificates on the adapter.
A CA certificate is used by the IBM Tivoli Identity Manager adapter to validate the
corresponding certificate presented by a client, such as the IBM Tivoli Identity
Manager server.
E. List CA certificates
Show the installed CA certificates. The adapter only communicates with
IBM Tivoli Identity Manager servers whose certificates are validated by
one of the installed CA certificates.
F. Install a CA certificate
Install a new CA certificate so that certificates generated by this CA can be
validated. The CA certificate file can either be in X.509 or PEM encoded
formats. For more information on how to install a CA certificate, see
“Installing a CA certificate” on page 35.
G. Delete a CA certificate
Remove one of the installed CA certificates. For more information on how
to delete a CA certificate, see “Deleting a CA certificate” on page 35.
The remaining options (H through K) apply to adapters that must authenticate the
application (for example, the Tivoli Identity Manager server or the Web server) to
which the adapter is sending information. These options enable you to register
certificates on the adapter. For IBM Tivoli Identity Manager Version 4.5 or earlier,
the signed certificate of the Tivoli Identity Manager server must be registered with
an adapter to enable client authentication on the adapter. If you do not intend to
upgrade an existing adapter to use CA certificates for client authentication, the
signed certificate presented by the Tivoli Identity Manager server must be
registered with the adapter.
32 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
If you configure the adapter to use event notification, or client authentication is
enabled in DAML, then you must install the CA certificate corresponding to the
signed certificate of the Tivoli Identity Manager server using the Install a CA
certificate option, option F.
H. List registered certificates
List all registered certificates that will be accepted for communications. For
more information on listing registered certificates, see “Viewing registered
certificates” on page 36.
I. Register a certificate
Register a new certificate. The certificate to be registered be in Base 64
encoded X.509 format or PEM. For more information on registering
certificates, see “Registering a certificate” on page 36.
J. Unregister a certificate
Unregister (remove) a certificate from the registered list. For more
information on unregistering certificates, see “Unregistering a certificate”
on page 36.
K. Export certificate and key to PKCS12 file
Export a previously installed certificate and private key. You will be
prompted for the filename and a password for encryption. For more
information on exporting a certificate and key to a PKCS12 file, see
“Exporting a certificate and key to PKCS12 file” on page 37.
Generating a private key and certificate request
A certificate signing request is an unsigned certificate that is a text file. When you
submit an unsigned certificate to a certificate authority, the CA signs the certificate
with the private digital signature that is included in their corresponding CA
certificate. When the CSR is signed, it becomes a valid certificate. A CSR contains
information about your organization, such as the organization name, country, and
the public key for your Web server.
In order to generate a CSR file, complete these steps:
1. At the Main Menu of the CertTool, type A. The following message and prompt
are displayed:
Enter values for certificate request (press enter to skip value)
-------------------------------------------------------------------------
2. At the Organization prompt, type your organization name, and press Enter.
3. At the Organizational Unit prompt, type the organizational unit, and press
Enter.
4. At the Agent Name prompt, type the name of the adapter you are requesting
a certificate for, and press Enter.
5. At the Email prompt, type the e-mail address for the contact person for this
request, and press Enter.
6. At the State prompt, type the state in which the adapter resides (if the adapter
is in the United States), and press Enter. Some certificate authorities do not
accept two letter abbreviations for states, so you must type the full name of
the state.
7. At the Country prompt, type the country in which the adapter resides, and
press Enter.
8. At the Locality prompt, type the name of the city in which the adapter
resides, and press Enter.
Chapter 4. Configuring SSL authentication for the SQL Server adapter 33
9. At the Accept these values prompt, type Y to accept the values displayed, or
type N to re-enter the values, and press Enter.
The private key and certificate request are generated once the values are
accepted.
10. At the Enter name of file to store PEM cert request prompt, type the name of
the file that you want to use to store the values you specified during the
previous steps, and press Enter.
11. Press Enter to continue. The certificate request and input values are written to
the file you specified, and the Main Menu is displayed again.
You can now request a certificate from a trusted CA by sending the .pem file that
you just generated to a certificate authority vendor.
Example of certificate signing request
Your CSR file will look similar to the following example:
-----BEGIN CERTIFICATE REQUEST-----
MIIB1jCCAT8CAQAwgZUxEjAQBgNVBAoTCWFjY2VzczM2MDEUMBIGA1UECxMLZW5n
aW5lZXJpbmcxEDAOBgNVBAMTB250YWdlbnQxJDAiBgkqhkiG9w0BCQEWFW50YWdl
bnRAYWNjZXNzMzYwLmNvbTELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3Ju
aWExDzANBgNVBAcTBklydmluZTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA
mR6AcPnwf6hLLc72BmUkAwaXcebtxCoCnnTH9uc8VuMHPbIMAgjuC4s91hPrilG7
UtlbOfy6X3R3kbeR8apRR9uLYrPIvQ1b4NK0whsytij6syCySaFQIB6V7RPBatFr
6XQ9hpsARdkGytZmGTgGTJ1hSS/jA6mbxpgmttz9HPECAwEAAaAAMA0GCSqGSIb3
DQEBAgUAA4GBADxA1cDkvXhgZntHkwT9tCTqUNV9sim8N/U15HgMRh177jVaHJqb
N1Er46vQSsOOOk4z2i/XwOmFkNNTXRVl9TLZZ/D+9mGZcDobcO+lbAKlePwyufxK
Xqdpu3d433H7xfJJSNYLYBFkrQJesITqKft0Q45gIjywIrbctVUCepL2
-----END CERTIFICATE REQUEST-----
Installing the certificate
Once you receive your certificate from your trusted CA, you install it in the
registry of the adapter. In order to install the certificate, complete these steps:
1. If you received the certificate as part of an e-mail message, copy the text of the
certificate to a text file, and copy that file to the bin directory for the adapter.
For example,
C:\Tivoli\Agents\SqlServerAdapter\bin
2. At the Main Menu of the CertTool, type B. The following prompt is displayed:
Enter name of certificate file:
-------------------------------------------------------------------------
3. At the Enter name of certificate file prompt, type the full path to the
certificate file, and press Enter.
The certificate is installed in the registry for the adapter, and the Main Menu is
displayed again.
Installing the certificate and key from a PKCS12 file
If you do not use the CertTool utility to generate a CSR to obtain a certificate, you
must install both the certificate and private key, which must be stored in a PKCS12
file. The CA might send a password−protected file, or PKCS12 file (a file with the
.pfx extension), which includes both the certificate and private key. In order to
install the certificate from this PKCS12 file, complete these steps:
1. Copy the PKCS12 file to the bin directory for the adapter. For example,
C:\Tivoli\Agents\SqlServerAdapter\bin
2. At the Main Menu for the CertTool, type C. The following prompt is displayed:
Enter name of PKCS12 file:
-------------------------------------------------------------------------
34 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
3. At the Enter name of PKCS12 file prompt, type the name of the PKCS12 file
that has the certificate and private key information, and press Enter. For
example, DamlSrvr.pfx.
4. At the Enter password prompt, type the password to access the file, and press
Enter.
The certificate and private key are installed in the adapter registry, and the Main
Menu is displayed.
Viewing the installed certificate
In order to list the certificate that is installed on your system, at the Main Menu of
CertTool, type D.
The installed certificate is listed, and the Main Menu is displayed. The following
example lists an installed certificate:
The following certificate is currently installed.
Subject: c=US,st=California,l=Irvine,o=DAML,cn=DAML Server
Installing a CA certificate
If you are using client authentication, you need to install a CA certificate. The CA
certificate you install is issued by a certificate authority vendor.
In order to install a CA certificate that was extracted into a temporary file,
complete the following steps:
1. At the Main Menu prompt, type F (Install a CA certificate).
The following prompt is displayed:
Enter name of certificate file:
2. At the Enter name of certificate file prompt, type the name of the certificate
file, such as DamlCACerts.pem, and press Enter.
The certificate file is opened, and the following prompt is displayed:
[email protected],c=US,st=California,l=Irvine,o=IBM,ou=Engineering,cn=Eng
Install the CA? (Y/N)
3. At the Install the CA prompt, type Y to install the certificate, and press Enter.
The certificate file is installed in the CACerts.pem file.
Viewing CA certificates
CertTool only installs one certificate and one private key. In order to list the CA
certificate that is installed on the adapter, type E at the Main Menu prompt.
The installed CA certificates are displayed and the Main Menu is displayed. The
following example lists an installed CA certificate:
Subject: o=IBM,ou=SampleCACert,cn=TestCA
Valid To: Wed Jul 26 23:59:59 2006
Deleting a CA certificate
In order to delete a CA certificate from the adapter directories, complete the
following steps:
1. At the Main Menu prompt, type G.
A list of all CA certificates installed on the adapter is displayed.
0 - [email protected],c=US,st=California,l=Irvine,o=IBM,ou=Engineering,cn=Eng
1 - [email protected],c=US,st=California,l=Irvine,o=IBM,ou=Support,cn=Support
Enter number of CA certificate to remove:
Chapter 4. Configuring SSL authentication for the SQL Server adapter 35
2. At the Enter number of CA certificate to remove prompt, type the number of
the CA certificate that you want to remove, and press Enter.
The CA certificate is deleted from the CACerts.pem file, and the Main Menu is
displayed.
Viewing registered certificates
Only requests that present a registered certificate will be accepted by the adapter
when client validation is enabled.
In order to view a list of all registered certificates available to the adapter, at the
Main Menu prompt, type H.
The registered certificates are displayed and the Main Menu is displayed. The
following example lists registered certificates:
0 - [email protected],c=US,st=California,l=Irvine,o=IBM,ou=Engineering,cn=Eng
1 - [email protected],c=US,st=California,l=Irvine,o=IBM,ou=Support,cn=Support
Registering a certificate
In order to register a certificate for the adapter, complete the following steps:
1. At the Main Menu prompt, type I.
The following prompt is displayed:
Enter name of certificate file:
2. At the Enter name of certificate file prompt, type the name of the certificate
file that you want to register, and press Enter.
The subject of the certificate is displayed, and a prompt is displayed, for
example:
[email protected],c=US,st=California,l=Irvine,o=IBM,ou=Engineering,cn=Eng
Register this CA? (Y/N)
3. At the Register this CA prompt, type Y to register the certificate, and press
Enter.
The certificate is registered to the adapter, and the Main Menu is displayed.
Unregistering a certificate
In order to unregister a certificate for the adapter, complete the following steps:
1. At the Main Menu prompt, type J.
The registered certificates are displayed. The following example lists registered
certificates:
0 - [email protected],c=US,st=California,l=Irvine,o=IBM,ou=Engineering,cn=Eng
1 - [email protected],c=US,st=California,l=Irvine,o=IBM,ou=Support,cn=Support
2. Type the number of the certificate file that you want to unregister, and press
Enter.
The subject of the selected certificate is displayed, and a prompt is displayed,
for example:
[email protected],c=US,st=California,l=Irvine,o=IBM,ou=Engineering,cn=Eng
Unregister this CA? (Y/N)
3. At the Unregister this CA prompt, type Y to unregister the certificate, and
press Enter.
The certificate is removed from the registered certificate list for the adapter, and
the Main Menu is displayed.
36 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Exporting a certificate and key to PKCS12 file
In order to export a certificate and key to a PKCS12 file for the adapter, complete
the following steps:
1. At the Main Menu prompt, type K.
The following prompt is displayed:
Enter name of PKCS12 file:
2. At the Enter name of PKCS12 file prompt, type the name of the PKCS12 file
for the installed certificate or private key, and press Enter.
3. At the Enter Password prompt, type the password for the PKCS12 file, and
press Enter.
4. At the Confirm Password prompt, type the password again, and press Enter.
The certificate or private key is exported to the PKCS12 file, and the Main
Menu is displayed.
Chapter 4. Configuring SSL authentication for the SQL Server adapter 37
38 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Chapter 5. Customizing the SQL server adapter
You can update the SQL Server adapter JAR file, SQL2000Profile.jar, to make
changes to the adapter account form, service form, and profile properties. In order
to make such updates, you must extract the files from the JAR file, make changes
to the necessary files, and repackage the JAR file with the updated files.
Complete these steps to customize the SQL Server adapter profile:
1. Copy the JAR file to a temporary directory and extract the files. For more
information on extracting the files, see “Copy the SQL2000Profile.jar file and
extract the files.”
2. Make the appropriate file changes.
3. Install the new attributes on the IBM Tivoli Identity Manager server. For more
information on updating this file, see “Create a new JAR file and install the
new attributes on the Tivoli Identity Manager server” on page 40.
Copy the SQL2000Profile.jar file and extract the files
The profile JAR file, SQL2000Profile.jar, is included in the SQL Server adapter
compressed file that you downloaded from the IBM Web site. The
SQL2000Profile.jar file contains the following files:
v CustomLabels.properties
v erSQL2000Account.xml
v erSQL2000DAMLService.xml
v resource.def
v schema.dsml
v xforms.xml
You can modify these files to customize your environment.
When you finish updating the profile JAR file, install it on the Tivoli Identity
Manager server. For more information on the profile installation, see “Importing
the adapter profile into the Tivoli Identity Manager server” on page 4.
In order to modify the SQL2000Profile.jar file, complete the following steps:
1. Log on to the system where the SQL Server adapter is installed.
2. On the Start menu, click Programs → Accessories → Command Prompt.
3. Copy the SQL2000Profile.jar file into a temporary directory.
4. Extract the contents of` the SQL2000Profile.jar file into the temporary directory
by running the following command:
cd c:\temp
jar -xvf SQL2000Profile.jar
The jar command will create the c:\temp\SQL2000Profile directory.
5. Edit the appropriate file.
© Copyright IBM Corp. 2002, 2006 39
Create a new JAR file and install the new attributes on the Tivoli
Identity Manager server
Once you modify the schema.dsml and CustomLabels.properties files, you must
import these files, and any other files that were modified for the adapter, into the
Tivoli Identity Manager server for the changes to take effect.
In order to install the new attributes, complete the following steps:
1. Create a new JAR file using the files in the \temp directory by running the
following commands:
cd c:\temp
jar -cvf SQL2000Profile.jar SQL2000Profile
2. Import the SQL2000Profile.jar file into the IBM Tivoli Identity Manager
Application Server. For more information on importing the file, see “Importing
the adapter profile” on page 4.
3. Stop and start the directory server.
4. Stop and start the SQL Server adapter service for the changes to take effect.
Managing passwords when restoring accounts
When a person’s accounts are restored from being previously suspended, you are
prompted to supply a new password for the reinstated accounts. However, there
are circumstances when you might want to circumvent this behavior.
The password requirement to restore an account on MS SQL falls into two
categories: allowed and required. How each restore action interacts with its
corresponding managed resource depends on either the managed resource, or the
business processes that you implement. Certain resources will reject a password
when a request is made to restore an account. In this case, you can configure IBM
Tivoli Identity Manager to forego the new password requirement. You can set the
SQL Server adapter to require a new password when the account is restored, if
your company has a business process in place that dictates that the account
restoration process must be accompanied by resetting the password.
In the resource.def file, you can define whether or not a password is required as a
new protocol option. When you import the adapter profile, if an option is not
specified, the adapter profile importer determines the correct restoration password
behavior from the schema.dsml and xforms.xml files. Adapter profile components
also enable remote services to find out if you discard a password that is entered by
the user in a situation where multiple accounts on disparate resources are being
restored. In this scenario, only some of the accounts being restored might require a
password. Remote services will discard the password from the restore action for
those managed resources that do not require them.
In order to configure the SQL Server adapter to not prompt for a new password
when restoring accounts:
1. Stop the Tivoli Identity Manager server.
2. Extract the files from the SQL2000Profile.jar file. For more information on
customizing the adapter profile file, see “Copy the SQL2000Profile.jar file and
extract the files” on page 39.
3. Change to the \SQL2000Profile directory, where the resource.def file has been
created.
4. Edit the resource.def file to add the new protocol options, for example:
40 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
<Property Name = "com.ibm.itim.remoteservices.ResourceProperties.
PASSWORD_NOT_REQUIRED_ON_RESTORE" Value = "TRUE"/>
<Property Name = "com.ibm.itim.remoteservices.ResourceProperties.
PASSWORD_NOT_ALLOWED_ON_RESTORE" Value = "FALSE"/>
By adding the two options in the example above, you are ensuring that you
will not be prompted for a password when an account is restored.
5. Create a new SQL2000Profile.jar file using the resource.def file and import the
adapter profile file into the Tivoli Identity Manager server. For more
information, refer to “Create a new JAR file and install the new attributes on
the Tivoli Identity Manager server” on page 40.
6. Start the Tivoli Identity Manager server again.
Note: If you are upgrading an existing adapter profile, the new adapter profile
schema will not be reflected immediately. You need to stop and start the
Tivoli Identity Manager server in order to refresh the cache and therefore
the adapter schema. For more information on upgrading an existing adapter,
see “Upgrading the SQL Server adapter” on page 43.
Chapter 5. Customizing the SQL server adapter 41
42 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Chapter 6. Upgrading the SQL Server adapter or the ADK
You can either upgrade the SQL Server adapter or the Adapter Development Kit
(ADK). The ADK is the base component of the adapter. While all adapters have the
same ADK, the remaining adapter functionality is specific to the managed
resource.
You can perform an adapter upgrade to migrate your current adapter installation
to a newer version, for example version 4.4 to version 4.6. Upgrading the adapter,
as opposed to reinstalling it, will allow you to keep your configuration settings.
Additionally, you will not have to uninstall the current adapter and install the
newer version.
However, if a code fix has been made to the ADK, instead of upgrading the entire
adapter, you can upgrade just the ADK to the newer version.
Upgrading the SQL Server 2000 Adapter to the SQL Server adapter
In order to upgrade an existing SQL 2000 Adapter, complete the following steps:
1. Stop the SQL Server 2000 Adapter Service.
2. Uninstall the SQL Server 2000 Adapter from installed location.
3. Install new SQL Server Adapter.
4. Import the new SQL2000Profile.jar file into IBM Tivoli Identity Manager and do
full reconciliation.
Upgrading the SQL Server adapter
During an upgrade, in order to maintain all of your current configuration settings,
as well as the certificate and private key, do not uninstall the old version of the
adapter before installing the new version. During the install, specify the same
installation directory where the previous adapter was installed. For more
information on how to install the adapter, see Chapter 2, “Installing and
configuring the SQL server adapter,” on page 3.
Upgrading the adapter involves several steps that you must complete in the
appropriate sequence.
In order to upgrade an existing adapter, complete the following steps:
1. Stop the SQL Server adapter service.
2. Install the new version of the adapter.
When the upgraded adapter starts for the first time, new log files are created,
replacing the old files.
Upgrading the ADK
The ADK consists of the runtime library, filtering and event notification
functionality, protocol settings, and logging information. The remainder of the
adapter is comprised of the Add, Modify, Delete, and Search functions. While all
adapters have the same ADK, the remaining functionality is specific to the
managed resource.
© Copyright IBM Corp. 2002, 2006 43
You can use the ADK upgrade program to update the ADK portion of the adapters
that are currently installed on a machine. This allows you to install just the ADK,
and not the entire adapter. As part of the ADK upgrade, the ADK library and the
DAML protocol library are updated. In addition, the agentCfg and CertTool
binaries are updated.
Prior to upgrading the ADK files, the upgrade program checks the current version
of the ADK. If the current level is higher than what you are attempting to install, a
warning message is displayed.
In order to upgrade the SQL Server adapter ADK, complete the following steps:
1. Download the ADK upgrade program compressed file from the IBM Web site.
2. Extract the contents of the compressed file into a temporary directory.
3. Stop the SQL Server adapter service.
4. Start the upgrade program using the adkinst_win32.exe file in the temporary
directory. For example, select Run from the Start menu, and type
C:\TEMP\adkinst_win32.exe in the Open field.
If no adapter is installed, you will receive the following error message, and the
program exits:
No Agent Installed - Cannot Install ADK.
5. On the Welcome window, click Next.
6. On the Software License Agreement window, review the license agreement and
decide if you accept the terms of the license. If you do, click Accept.
7. On the Installation Information window, click Next to begin the installation.
8. On the Install Completed window, click Finish to exit the program.
Log files
Logging entries are stored in the ADKVersioninstaller.log and
ADKVersionInstalleropt.log files, where ADKVersion is the version of the ADK. For
example, ADK46Installer.log and ADK46Installeropt.log. These files are created
in the folder where you run the installation program.
44 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Chapter 7. Uninstalling the SQL server adapter
Before you remove the adapter, inform your users that the SQL Server adapter will
be unavailable. If the server is taken offline, adapter requests that were completed
might not be recovered when the server is back online.
To remove the SQL Server adapter, complete these steps:
1. Stop the adapter service.
2. Remove the adapter. For specific information about uninstalling the adapter, see
the online help or the information center for your IBM Tivoli Identity Manager
product.
© Copyright IBM Corp. 2002, 2006 45
46 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Appendix A. Adapter attributes
The IBM Tivoli Identity Manager server communicates with the SQL Server
adapter using attributes that are included in transmission packets that are sent
over a network. The combination of attributes, included in the packets, depends on
the type of action that the IBM Tivoli Identity Manager server requests from the
SQL Server adapter.
Attribute descriptions
Table 10 is an alphabetical listing of the attributes that are used by the SQL Server
adapter. The table gives a brief description and the data type for the value of the
attribute.
Table 10. Attributes, descriptions, and data types
Attribute Directory server attribute Description Data type
AccountPassword erPassword Specifies the password used to create a
SQL Server account.
Binary
DatabaseAlias ersqldbalias Specifies the alias to which the LoginId is
to be mapped in a database. The alias
must already exist in the specified
database. The format is:
database_name:alias
String
DatabaseRole ersqldbrole Specifies roles to be granted for the user
mapped to the login ID in the database.
If the user does not exist in the specified
database then the adapter creates a user
for the LoginId and grants specified
database roles to that user. The format is:
database_name:database_role_name
This role can be selected from the
support data search box.
String
DatabaseSchema ersqldbschema Note: This attribute is for SQL Server
2005 only.
Specifies the default schema for a user of
LoginId in a database. The format is:
database_name:schema_name
If no user of LoginId exists in the
specified database then a user is created
in the database and that user is granted
the specified schema as default schema.
String
DatabaseUser ersqldbuser Specifies the user to which the LoginId is
mapped in a database. The format is:
database_name:user_name
A user with a login ID is created
automatically in the login ID default
database.
String
© Copyright IBM Corp. 2002, 2006 47
Table 10. Attributes, descriptions, and data types (continued)
Attribute Directory server attribute Description Data type
DefaultDatabase erSQL2000DefaultDatabase Specifies the default database for the
user. If not provided, the default database
is master with public as default
permissions.
String
DefaultLanguage erSQL2000DefaultLanguage Specifies the default language of the user.
If not provided, the form default is
English.
String
Enforce password
expiration
ersql2000frpwexp Note: This attribute is for SQL Server
2005 only.
Specifies password expiration if Windows
password policy is enforced on SQL
Server accounts.
Check box
Enforce password policy ersql2000frpwdpol Note: This attribute is for SQL Server
2005 only.
Specifies whether the Windows password
policy is enforced on SQL server
accounts, if the SQL Server is installed on
Windows 2003.
Check box
LoginId erUid Specifies the login ID of the SQL Server
or the Windows Mapped login in the
SQL Server.
String
Permission to connect to
database engine
ersql2000connectsql Note: This attribute is for SQL Server
2005 only.
Specifies server level permission for the
LoginId in the SQL Server to connect to
the database engine.
Check box
ServerRole erSQL2000ServerRole Specifies the fixed server roles. Each roles
has certain predefined permissions on the
SQL Server. The roles can be granted and
revoked from the SQL LoginId.
String
ServicePassword erServicePwd1 Specifies the password used by the
adapter to connect to the SQL Server.
Binary
User must change
password at next login
ersql2000chgpwlgn Note: This attribute is for SQL Server
2005 only.
Specifies that a user must change the
password at the next login, if Windows
password policy is enforced on SQL
Server accounts, this attribute .
Check box
Attributes by SQL Server adapter actions
The following lists are typical SQL Server adapter actions by their functional
transaction group. The lists include more information about required and optional
attributes sent to the SQL Server adapter to complete that action.
Database Login Add
A System Login Add is a request to create a new user account with the specified
attributes.
48 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Table 11. Add request attributes
Required attribute Optional attribute
erUid
erSQL2000ServerName
erSQL2000AdminAccount
erSQL2000AdminPassword
All other supported attributes
Database Login Change
A System Login Change is a request to change one or more attributes for the
specified users.
Table 12. Change request attributes
Required attribute Optional attribute
erUid
erSQL2000ServerName
erSQL2000AdminAccount
erSQL2000AdminPassword
All other supported attributes
Database Login Delete
A System Login Delete is a request to remove the specified user from the directory.
Table 13. Delete request attributes
Required attribute Optional attribute
erUid
erSQL2000ServerName
erSQL2000AdminAccount
erSQL2000AdminPassword
None
Database Login Suspend
A System Login Suspend is a request to disable a user account. The user is neither
removed nor are their attributes modified.
Table 14. Suspend request attributes
Required attribute Optional attribute
erUid
erAccountStatus
erSQL2000ServerName
erSQL2000AdminAccount
erSQL2000AdminPassword
None
Appendix A. Adapter attributes 49
Database Login Restore
A System Login Restore is a request to activate a user account that was previously
suspended. Once an account is restored, the user can access the system with the
same attributes as those before the Suspend function was called.
Table 15. Restore request attributes
Required attribute Optional attribute
erUid
erAccountStatus
erSQL2000ServerName
erSQL2000AdminAccount
erSQL2000AdminPassword
None
Reconciliation
The Reconciliation request synchronizes user account information between IBM
Tivoli Identity Manager and the adapter.
Table 16. Reconciliation request attributes
Required attribute Optional attribute
erSQL2000ServerName
erSQL2000AdminAccount
erSQL2000AdminPassword
None
50 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Appendix B. Support information
This section describes the following options for obtaining support for IBM
products:
v “Searching knowledge bases”
v “Contacting IBM Software Support”
Searching knowledge bases
If you have a problem with your IBM software, you want it resolved quickly. Begin
by searching the available knowledge bases to determine whether the resolution to
your problem is already documented.
Search the information center on your local system or
network
IBM provides extensive documentation that can be installed on your local
computer or on an intranet server. You can use the search function of this
information center to query conceptual information, instructions for completing
tasks, reference information, and support documents.
Search the Internet
If you cannot find an answer to your question in the information center, search the
Internet for the latest, most complete information that might help you resolve your
problem. To locate Internet resources for your product, open one of the following
Web sites:
v Performance and tuning information
Provides information needed to tune your production environment, available on
the Web at:
http://publib.boulder.ibm.com/tividd/td/tdprodlist.html
Click the I character in the A-Z product list to locate IBM Tivoli Identity
Manager products. Click the link for your product, and then browse the
information center for the Technical Supplements section.
v Redbooks and white papers are available on the Web at:
http://www.ibm.com/software/sysmgmt/products/support/IBMTivoliIdentityManager.html
Browse to the Self Help section, in the Learn category, and click the Redbooks
link.
v Technotes are available on the Web at:
http://www.redbooks.ibm.com/redbooks.nsf/tips/
v Field guides are available on the Web at:
http://www.ibm.com/software/sysmgmt/products/support/Field_Guides.html
v For an extended list of other Tivoli Identity Manager resources, search the
following IBM developerWorks Web address:
http://www.ibm.com/developerworks/
Contacting IBM Software Support
IBM Software Support provides assistance with product defects.
© Copyright IBM Corp. 2002, 2006 51
Before contacting IBM Software Support, your company must have an active IBM
software maintenance contract, and you must be authorized to submit problems to
IBM. The type of software maintenance contract that you need depends on the
type of product you have:
v For IBM distributed software products (including, but not limited to, Tivoli,
Lotus, and Rational products, as well as DB2 and WebSphere products that run
on Windows or UNIX operating systems), enroll in Passport Advantage in one
of the following ways:
– Online: Go to the Passport Advantage Web page (http://www.lotus.com/services/passport.nsf/WebDocs/ Passport_Advantage_Home) and click How
to Enroll
– By phone: For the phone number to call in your country, go to the IBM
Software Support Web site (http://techsupport.services.ibm.com/guides/contacts.html) and click the name of your geographic region.
v For IBM eServer software products (including, but not limited to, DB2 and
WebSphere products that run in zSeries, pSeries, and iSeries environments), you
can purchase a software maintenance agreement by working directly with an
IBM sales representative or an IBM Business Partner. For more information
about support for eServer software products, go to the IBM Technical Support
Advantage Web page (http://www.ibm.com/servers/eserver/techsupport.html).
If you are not sure what type of software maintenance contract you need, call
1-800-IBMSERV (1-800-426-7378) in the United States or, from other countries, go to
the contacts page of the IBM Software Support Handbook on the Web
(http://techsupport.services.ibm.com/guides/contacts.html) and click the name of
your geographic region for phone numbers of people who provide support for
your location.
Follow the steps in this topic to contact IBM Software Support:
1. Determine the business impact of your problem.
2. Describe your problem and gather background information.
3. Submit your problem to IBM Software Support.
Determine the business impact of your problem
When you report a problem to IBM, you are asked to supply a severity level.
Therefore, you need to understand and assess the business impact of the problem
you are reporting. Use the following criteria:
Severity 1 Critical business impact: You are unable to use the program,
resulting in a critical impact on operations. This condition
requires an immediate solution.
Severity 2 Significant business impact: The program is usable but is
severely limited.
Severity 3 Some business impact: The program is usable with less
significant features (not critical to operations) unavailable.
Severity 4 Minimal business impact: The problem causes little impact on
operations, or a reasonable circumvention to the problem has
been implemented.
52 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Describe your problem and gather background information
When explaining a problem to IBM, be as specific as possible. Include all relevant
background information so that IBM Software Support specialists can help you
solve the problem efficiently. To save time, know the answers to these questions:
v What software versions were you running when the problem occurred?
v Do you have logs, traces, and messages that are related to the problem
symptoms? IBM Software Support is likely to ask for this information.
v Can the problem be re-created? If so, what steps led to the failure?
v Have any changes been made to the system? (For example, hardware, operating
system, networking software, and so on.)
v Are you currently using a workaround for this problem? If so, please be
prepared to explain it when you report the problem.
Submit your problem to IBM Software Support
You can submit your problem in one of two ways:
v Online: Go to the ″Submit and track problems″ page on the IBM Software
Support site (http://www.ibm.com/software/support/probsub.html). Enter
your information into the appropriate problem submission tool.
v By phone: For the phone number to call in your country, go to the contacts page
of the IBM Software Support Handbook on the Web (http://techsupport.services.ibm.com/guides/contacts.html) and click the name of your
geographic region.
If the problem you submit is for a software defect or for missing or inaccurate
documentation, IBM Software Support creates an Authorized Program Analysis
Report (APAR). The APAR describes the problem in detail. Whenever possible,
IBM Software Support provides a workaround for you to implement until the
APAR is resolved and a fix is delivered. IBM publishes resolved APARs on the
IBM product support Web pages daily, so that other users who experience the
same problem can benefit from the same resolutions.
For more information about problem resolution, see Searching knowledge bases.
Appendix B. Support information 53
54 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Appendix C. Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user’s responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not give you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
© Copyright IBM Corp. 2002, 2006 55
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged should contact:
IBM Corporation
2ZA4/101
11400 Burnet Road
Austin, TX 78758
U.S.A.
Such information may be available, subject to appropriate terms and conditions,
including in some cases, payment of a fee.
The licensed program described in this information and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement, or any equivalent agreement
between us.
Any performance data contained herein was determined in a controlled
environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of
those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
Trademarks
The following terms are trademarks or registered trademarks of International
Business Machines Corporation in the United States, other countries, or both:
AIX
DB2
developerWorks
eServer
IBM
iSeries
Lotus
MVS
Passport Advantage
pSeries
RACF
Rational
Redbooks
Tivoli
WebSphere
zSeries
56 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Microsoft®, Windows, Windows NT®, and the Windows logo are trademarks of
Microsoft Corporation in the United States, other countries, or both.
Intel®, Intel Inside® (logos), MMX and Pentium® are trademarks of Intel
Corporation in the United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Linux® is a trademark of Linus Torvalds in the U.S., other countries, or both.
Java™ and all Java-based trademarks are trademarks of Sun
Microsystems, Inc. in the United States, other countries, or
both.
Other company, product, and service names may be trademarks or service marks
of others.
Appendix C. Notices 57
58 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Index
Aaccessibility
pdf format, for screen-reader software viii
statement for documentation viii
text, alternative for document images viii
activity logging 18
adapterADK upgrade 43
attributesby adapter action 48
descriptions 47
configuration steps 6
customization steps 39
features 1
installation overview 1
profile purpose 4
removal 45
upgrade 43
SQL 2000 43
adapter configuration toolSee agentCfg
adapter overview 1
ADK46Installer.log file 44
ADK46Installeropt.log file 44
administrator authority 3
agentCfgarguments 22
changing adapter parametersconfiguration key 18
protocol settings 9
registry settings 20
request processing 20
menusactivity logging 18
advanced settings 21
event notification 12
help 22
Main Configuration 7
Protocol Configuration 8
registry 20
viewing configuration settings 8
attributesby SQL Server adapter action
add 48
change 49
delete 49
reconciliation 50
restore 50
suspend 49
descriptions 47
Bbooks
see publications viii
Ccertificate authority
definition 25
certificate signing request (CSR) 34
certificatesCA
available functions 32
deleting 35
installing 35
viewing installed 35
certificate management toolsSee CertTool
definition 25
examplescertificate signing request (CSR) 34
install 34
installationfrom file 34
sample 34
key formats 27
overview 25
private keys and digital certificates 26
protocol configuration toolSee CertTool
register 32
registeredregistering 36
removing 36
viewing 36
request 33
self-signed 26
viewinginstalled 35
registered 36
viewing installed 35
viewing registered 36
CertToolCA certificate
deleting 35
installing 35
viewing 35
certificateinstall 34
register 32
request 33
viewing installed 35
viewing registered 36
changing adapter parametersaccessing 27, 31
options 32
client authentication 32
install certificate 34
private key, generating 33
registered certificateregistering 36
removing 36
viewing 36
character sets, supported 21
client authentication 29
client validation, SSL 30
configurationkey
changing with agentCfg 18
default value 7, 18
© Copyright IBM Corp. 2002, 2006 59
configuration (continued)key (continued)
purpose 7
settingschanging with agentCfg 7
default value 8
viewing with agentCfg 8
SSL 28
contextbaseline database 17
deleting 14
listing 14
modifying 15
search attributes 16
target DN 17
conventionsHOME directory
Tivoli_Common_Directory xi
DB_INSTANCE_HOME x
HTTP_HOME xi
ITIM_HOME xi
LDAP_HOME x
WAS_HOME xi
WAS_MQ_HOME xi
WAS_NDM_HOME xi
typeface ix
UNIX variable, directory notation ix
used in this document ix
CSRdefinition 33
file, generating 33
customer supportsee Software Support 51
DDAML protocol
configuring with agentCfg 9
encryptiondefault value 9
type 9
options 9
properties, changing with agentCfgoptions 9
password 10
portnumber 10
require_cert_reg 11
srv_nodename 10
srv_portnumber 11
username 9
validate_client_ce 11
SSL authentication 27
DB_INSTANCE_HOMEDB2 UDB installation directory x
definition x
debug logdefault value 18
enable/disable with agentCfg 18
purpose 19
detail logdefault value 18
enable/disable with agentCfg 18
purpose 19
directoryDB_INSTANCE_HOME x
HTTP_HOME xi
directory (continued)installation
DB2 UDB x
IBM Directory Server x
IBM HTTP Server xi
WebSphere Application Server base product xi
WebSphere Application Server Network Deployment
product xi
WebSphere MQ xi
installation for Sun ONE Directory Server x
ITIM_HOME xi
LDAP_HOME x
names, UNIX notation ix
WAS_HOME xi
WAS_MQ_HOME xi
WAS_NDM_HOME xi
disabilities, using documentation viii
documentsIBM Tivoli Identity Manager library v
related viii
Eenable/disable with agentCfg 18
encrypted registry settings 20
encryptionDAML protocol
default value 9
type 9
SSL 25, 26
environment variableUNIX notation ix
event notificationcache size 13
changing with agentCfg 12
contextbaseline database 17
deleting 14
listing 14
modifying 15
search attributes 16
target DN 17
enable/disable 13
reconciliationattributes 14
context 14
intervals 13
modifying 14
process priority 14
starting manually 13
Hhelp menu for agentCfg 23
accessing with -help command 22
home directoriesDB_INSTANCE_HOME x
HTTP_HOME xi
ITIM_HOME xi
LDAP_HOME x
WAS_HOME xi
WAS_MQ_HOME xi
WAS_NDM_HOME xi
HTTP_HOMEdefinition xi
IBM HTTP Server installation directory xi
60 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
Iimport
adapter profile 4, 40
PKCS12 file 27
information centers, searching to find software problem
resolution 51
installationcertificate 34
directoryDB2 UDB x
IBM Directory Server x
IBM HTTP Server xi
Sun ONE Directory Server x
WebSphere Application Server base product xi
WebSphere Application Server Network Deployment
product xi
WebSphere MQ xi
profile 4
uninstall 45
installation prerequisitesadministrator authority 3
communication with Tivoli Identity Manager Express 3
communication with Tivoli Identity Manager server 3
network connectivity 3
operating system 3
server 3
system 3
Internet, searching to find software problem resolution 51
ITIM_HOMEdefinition xi
directory xi
Kknowledge bases, searching to find software problem
resolution 51
LLDAP_HOME
definition x
IBM Directory Server installation directory x
Sun ONE Directory Server installation directory x
logsactivity settings, changing 8
ADK46Installer.log file 44
ADK46Installeropt.log file 44
debug 18
detail 18
directory, changing with agentCfg 19
display using agentCfg 23
enable/disable, changing with agentCfg 19
file name, changing with agentCfg 18
settings, changing with adapterCfg 19
settings, changing with agentCfglog file name 19
max file size 19
settings, default values 18
statistics 22
view events 8
viewing statistics 22
Mmanuals
see publications viii
Nnetwork connectivity 3
non-encrypted registry settings 20
Oonline publications
accessing viii
operating system prerequisites 3
overview, SQL Server adapter 1
Ppassword protected file
See PKCS12 file
passwordschanging configuration key 18
configuration key, default value 7, 18
passwords, changing with agentCfgDAML protocol 10
path names, notation ix
pdf format, for screen-reader software viii
PKCS12 filecertificate and key installation 34
export certificate and key 37
portnumberchanging with agentCfg 9
portnumber, changing with agentCfg 10
private keydefinition 25
private key, generating 33
problem determinationdescribing problem for IBM Software Support 53
determining business impact for IBM Software Support 52
submitting problem to IBM Software Support 53
properties, changing with agentCfg 9
protocolDAML
configuring with agentCfg 9
encryption default value 9
encryption type 9
properties, changing with agentCfg 9
SSLoverview 25
server-to-adapter configuration 28
two-way configuration 29, 30
public key 26
publicationsaccessing online viii
IBM Tivoli Identity Manager library v
related viii
Rreconciliation
attributes 14, 50
context 14
intervals 13
modifying 14
process priority 14
Index 61
registry settingsencrypted 20
non-encrypted 20
require_cert_reg, changing with agentCfg 11
restoring accountspassword requirements 40
Sself-signed certificate 26
server prerequisites 3
Software Supportcontacting 51
describing problem for IBM Software Support 53
determining business impact for IBM Software Support 52
submitting problem to IBM Software Support 53
srv_nodename, changing with agentCfg 10
srv_portnumber, changing with agentCfg 11
SSLcertificate installation 25
certificate signing request 33
encryption 25
key formats 27
overview 25
private keys and digital certificates 26
self-signed certificates 26
server-to-adapter configuration 28
two-way configuration 29, 30
SSL implementations, DAML protocol 27
system prerequisites 3
Ttext, alternative for document images viii
thread count settingschanging with agentCfg 20
default values 20
maximum concurrent requests 20
reconciliation requests 21
system login add requests 21
system login change requests 21
system login delete requests 21
Tivoli Identity Manager Adaptercommunication with the server 29, 30
SSL communication 29, 30
Tivoli Identity Manager Servercommunication with the adapter 28
configuring event notification 12
importing adapter profile 4
SSL communication 28
Tivoli software information center viii
Tivoli_Common_Directorydefinition xi
two-way configurationSSL
client 29
client and server 30
typeface conventions ix
Uuninstallation 45
updatingadapter profile 39
upgradeadapter 43
upgrade (continued)SQL 2000 43
adapter profile 4
ADK 43
username, changing with agentCfg 9
UTF8 support 21
Vvalidate_client_ce, changing with agentCfg 11
WWAS_HOME
definition xi
WebSphere Application Server base installation
directory xi
WAS_MQ_HOMEdefinition xi
WebSphere MQ installation directory xi
WAS_NDM_HOMEdefinition xi
WebSphere Application Server Network Deployment
installation directory xi
western European character set, support 21
62 IBM Tivoli Identity Manager: SQL Server adapter Installation and Configuration Guide
����
Printed in USA
SC32-1230-03