Tivoli ® Identity Manager IBM Tivoli Identity Manager CiscoSecure ACS Adapter for Windows Installation and Configuration Guide Version 4.6 SC32-1749-01
Tivoli® Identity Manager
IBM Tivoli Identity ManagerCiscoSecure ACS Adapter for WindowsInstallation and Configuration Guide
Version 4.6
SC32-1749-01
���
Tivoli® Identity Manager
IBM Tivoli Identity ManagerCiscoSecure ACS Adapter for WindowsInstallation and Configuration Guide
Version 4.6
SC32-1749-01
���
Note:
Before using this information and the product it supports, read the information in Appendix C, “Notices,” on page 57.
UPDATE Edition (June 2005)
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 2003, 2005. 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 directory variables . . . . x
Chapter 1. Overview . . . . . . . . . 1
Chapter 2. Adapter Installation . . . . . 3
Requirements . . . . . . . . . . . . . . 3
Before You Start . . . . . . . . . . . . . 3
Step 1: Testing Network Connectivity . . . . . . 4
Step 2: Installing the Adapter . . . . . . . . . 4
Step 3: Activating the Adapter as a Service . . . . 5
Step 4: Configuring the Adapter . . . . . . . . 5
Step 5: Installing the Adapter’s Certificate . . . . 5
Step 6: Importing the Adapter Profile . . . . . . 5
Step 7: Configuring the Adapter’s Forms . . . . . 6
Step 8: Configuring the ACS DB Synchronization . . 6
Chapter 3. Configuring the adapter for
IBM Tivoli Identity Manager . . . . . . 9
Starting the adapter configuration tool . . . . . . 9
Viewing configuration settings . . . . . . . . 10
Changing protocol configuration settings . . . . 10
Configuring event notification . . . . . . . . 13
Setting event notification triggers . . . . . . 16
Modifying an event notification context . . . . 16
Changing the configuration key . . . . . . . 18
Changing activity logging settings . . . . . . . 18
Changing registry settings . . . . . . . . . 20
Modifying Non-encrypted Registry Settings . . 21
Changing advanced settings . . . . . . . . . 21
Viewing statistics . . . . . . . . . . . . 22
Changing code page settings . . . . . . . . 23
Accessing help and additional options . . . . . 23
Chapter 4. Configuring SSL
authentication for the adapter . . . . . 27
Overview of SSL and digital certificates . . . . . 27
Private keys, public keys, and digital certificates 28
Self-signed certificates . . . . . . . . . . 28
Certificate and key formats . . . . . . . . 29
The use of SSL authentication . . . . . . . . 29
Configuring certificates for SSL authentication . . . 30
Configuring certificates for one-way SSL
authentication . . . . . . . . . . . . 30
Configuring certificates for two-way SSL
authentication . . . . . . . . . . . . 31
Configuring certificates when the adapter
operates as an SSL client . . . . . . . . . 32
Managing SSL certificates using CertTool . . . . 33
Starting CertTool . . . . . . . . . . . 33
Generating a private key and certificate request 35
Installing the certificate . . . . . . . . . 36
Installing the certificate and key from a PKCS12
file . . . . . . . . . . . . . . . . 36
Viewing the installed certificate . . . . . . . 37
Installing a ca certificate . . . . . . . . . 37
Viewing ca certificates . . . . . . . . . . 37
Deleting a ca certificate . . . . . . . . . 37
Viewing registered certificates . . . . . . . 38
Registering a certificate . . . . . . . . . 38
Unregistering a certificate . . . . . . . . 38
Exporting a certificate and key to PKCS12 file . . 39
Chapter 5. Customizing the adapter . . 41
Copy the ACSWProfile.jar file and extract the files 41
Create a new JAR file and install the new attributes
on the Tivoli Identity Manager Server . . . . . 42
Managing passwords when restoring accounts . . . 42
Chapter 6. Upgrading the CiscoSecure
ACS adapter or the ADK . . . . . . . 45
Upgrading the CiscoSecure ACS adapter . . . . 45
Upgrading the ADK . . . . . . . . . . . 45
Log files . . . . . . . . . . . . . . 46
Chapter 7. Uninstalling the
CiscoSecure ACS adapter . . . . . . 47
Appendix A. Adapter Variables . . . . 49
Variable Descriptions . . . . . . . . . . . 49
Variables by CiscoSecure ACS Adapter Actions . . 51
System Login Add . . . . . . . . . . . 51
System Login Change . . . . . . . . . . 51
System Login Delete . . . . . . . . . . 51
System Login Suspend . . . . . . . . . 51
System Login Restore . . . . . . . . . . 51
Reconciliation . . . . . . . . . . . . 52
Appendix B. Support information . . . 53
Searching knowledge bases . . . . . . . . . 53
Search the information center on your local
system or network . . . . . . . . . . . 53
Search the Internet . . . . . . . . . . . 53
Obtaining fixes . . . . . . . . . . . . . 54
Contacting IBM Software Support . . . . . . . 54
Determine the business impact of your problem 55
© Copyright IBM Corp. 2003, 2005 iii
Describe your problem and gather background
information . . . . . . . . . . . . . 55
Submit your problem to IBM Software Support 55
Appendix C. Notices . . . . . . . . . 57
Trademarks . . . . . . . . . . . . . . 58
Index . . . . . . . . . . . . . . . 61
iv Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Preface
The IBM® Tivoli® Identity Manager CiscoSecure Access Control Server (ACS) 3.2
Adapter for Windows® (CiscoSecure ACS Adapter) enables connectivity between
the IBM Tivoli Identity Manager Server and systems running the CiscoSecure
Access Control Server. After the adapter is installed and prepared, Tivoli Identity
Manager manages access to CiscoSecure ACS user attributes. This manual
describes how to install and prepare the CiscoSecure ACS Adapter.
Who should read this book
This manual is intended for security administrators responsible for installing
software on their site’s computer systems. Readers are expected to understand
security administration concepts. The person completing the installation procedure
should also be familiar with their site’s system standards. Readers should be able
to perform routine security administration tasks.
Publications and related information
Read the descriptions of the 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 Tivoli Identity Manager technical documentation library 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 IBM Tivoli Identity Manager Release Notes
Provides software and hardware requirements for Tivoli Identity Manager, and
additional fix, patch, and other support information.
v IBM Tivoli Identity Manager Documentation Read This First Card
Lists the Tivoli Identity Manager publications.
Online user assistance:
Provides online help topics and an information center for all Tivoli Identity
Manager administrative tasks. The information center includes information that
was previously provided in the IBM Tivoli Identity Manager Configuration Guide and
the IBM Tivoli Identity Manager Policy and Organization Administration Guide.
Server installation and configuration:
© Copyright IBM Corp. 2003, 2005 v
IBM Tivoli Identity Manager Server Installation and Configuration Guide for WebSphere
Environments provides installation and configuration information for Tivoli Identity
Manager.
Configuration information that was previously provided in the IBM Tivoli Identity
Manager Configuration Guide is now included in either the installation guide or in
the IBM Tivoli Identity Manager Information Center.
Problem determination:
IBM Tivoli Identity Manager Problem Determination Guide provides problem
determination, logging, and message information for the Tivoli Identity Manager
product.
Technical supplements:
The following technical supplements are provided by developers or by other
groups who are interested in this product:
v IBM Tivoli Identity Manager Performance Tuning Guide
Provides information needed to tune Tivoli Identity Manager Server for a
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, and then, click the Tivoli Identity
Manager link. 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 Tivoli Identity Manager Server technical documentation library also includes
an evolving set of platform-specific installation documents for the adapter
components of a Tivoli Identity Manager Server implementation. Locate adapters
on the Web at:
http://www.ibm.com/software/sysmgmt/products/support/IBMTivoliIdentityManager.html
Browse to the Other resources, and click the link for the current inventory of
adapters.
Skills and training:
vi Tivoli Identity Manager CiscoSecure ACS Adapter Guide
The following additional skills and technical training information were available at
the time that this manual was published:
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 Tivoli Identity Manager Server. Publications are
available from the following locations:
v Operating systems
– IBM AIX®
http://www16.boulder.ibm.com/pseries/en_US/infocenter/base/aix52.htm
– Sun Solaris
http://docs.sun.com/db?q=solaris+9
– Red Hat Linux®
http://www.redhat.com/docs/
– Microsoft® Windows Server 2003
http://www.microsoft.com/windowsserver2003/proddoc/default.mspxv Database servers
– IBM DB2®
- 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 2000
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 Tivoli Identity Manager Server 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 Tivoli Identity Manager
link 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 local 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 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
v Searching knowledge bases: You can search across a large collection of known
problems and workarounds, Technotes, and other information.
v Obtaining fixes: You can locate the latest fixes that are already available for your
product.
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 53.
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 UNIX® convention for specifying environment variables and
for directory notation.
When using the Windows command line, replace $variable with %variable% for
environment variables and replace each forward slash (/) with a backslash (\) 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.
Preface ix
Note: If you are using the bash shell on a Windows system, you can use the UNIX
conventions.
Definitions for HOME 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 for the Windows operating system is drive:\Program Files. The
value of path for the AIX operating system is /usr. The value of path is /opt for
other UNIX and Linux operating systems.
Path Variable Default Definition Description
DB_INSTANCE_HOME Windows:
path\IBM\SQLLIB
UNIX and Linux:
v AIX, Linux: /home/dbinstancename
v Solaris:
/export/home/dbinstancename
The directory that
contains the database
for Tivoli Identity
Manager.
LDAP_HOME v IBM Directory Server
Windows:
path\IBM\LDAP
UNIX:
path/IBM/LDAP
v Sun ONE Directory Server
Windows:
path\Sun\MPS
UNIX:
/var/Sun/mps
The directory that
contains the directory
server code.
HTTP_HOME Windows:
path\IBMHttpServer
UNIX and Linux:
path/IBMHttpServer
The directory that
contains the IBM HTTP
Server code.
ITIM_HOME Windows:
path\IBM\itim
UNIX and Linux:
path/IBM/itim
The base directory that
contains the Tivoli
Identity Manager code,
configuration, and
documentation.
WAS_HOME Windows:
path\WebSphere\AppServer
UNIX and Linux:
path/WebSphere/AppServer
The WebSphere
Application Server
home directory
x Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Path Variable Default Definition Description
WAS_MQ_HOME Windows:
path\IBM\WebSphereMQ
UNIX and Linux:
path/mqm
The directory that
contains the
WebSphere MQ code.
WAS_NDM_HOME Windows:
path\WebSphere\DeploymentManager
UNIX and Linux:
path/WebSphere/DeploymentManager
The home directory on
the deployment
manager
Tivoli_Common_Directory Windows:
path\IBM\Tivoli\Common\CTGIM
UNIX and Linux:
path/IBM/Tivoli/Common/CTGIM
The central location for
all serviceability-related
files, such as logs and
first-failure capture
data
Preface xi
xii Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Chapter 1. Overview
An adapter is a program that provides an interface between a managed resource
and the Tivoli Identity Manager Server. Adapters reside on the managed resource
and the 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 Tivoli
Identity Manager Server.
The IBM Tivoli Identity Manager CiscoSecure ACS Adapter enables connectivity
between the Tivoli Identity Manager Server and a system running the Windows
NT servers. This installation guide provides the basic information that you need to
install and configure the CiscoSecure ACS Adapter components. This chapter
provides an overview of the adapter and the features of the adapter.
The following lists the basic procedures necessary to install, configure, and run the
adapter:
v Create an account on the managed resource for the adapter to use.
v Install the adapter software.
v Load the Tivoli Identity Manager events.
v Activate the CiscoSecure ACS Adapter as a service on the adapter’s system.
v Configure the adapter’s communication protocols to enable the CiscoSecure ACS
Adapter to communicate with the Tivoli Identity Manager Server.
v Install the adapter’s profile on the Tivoli Identity Manager Server.
v Configure the Tivoli Identity Manager Server to recognize the adapter as a
service.
© Copyright IBM Corp. 2003, 2005 1
2 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Chapter 2. Adapter Installation
Installing and configuring the CiscoSecure ACS 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.
Requirements
The following table identifies hardware, software, and authorization requirements
to install the CiscoSecure ACS Adapter. Verify that all of the requirements have
been met before installing the CiscoSecure ACS Adapter.
Table 1. Requirements to install the adapter
System The adapter must be installed on a server with a 32-bit
x86-based microprocessor (486 minimum), at least 256 MB
of memory, and at least 300 MB of free disk space.
Operating System Windows NT 4.0 with SP6, or Windows 2000 workstation
with SP2, or Windows 2003.
CiscoSecure ACS Software The CiscoSecure ACS 3.2(1) run-time environment must
be installed and operational on the system where the
adapter is installed.
Network Connectivity The adapter must be installed on a system that can
communicate with the Tivoli Identity Manager Server
through a TCP/IP network.
System Administrator
Authority
The person completing the CiscoSecure ACS Adapter
installation procedure must have system administrator
authority to complete the steps in this chapter.
Server Communication Communication between the Tivoli Identity Manager
Server and the CiscoSecure ACS Adapter should be tested
with a low-level communication ping before installing
any IBM software. This makes troubleshooting easier if
you encounter installation problems.
Before You Start
This section identifies the information that you will need to know during
installation of the CiscoSecure ACS Adapter.
To test network connectivity between the Tivoli Identity Manager Server and the
system where the CiscoSecure ACS Adapter is being installed, you will need to
know:
v Host name or IP address of the system where the Tivoli Identity Manager Server
is installed,
v Host name or IP address of the workstation where the CiscoSecure ACS Adapter
will be installed.
To run the adapter installation, you will need to know:
v CiscoSecure ACS Adapter installation directory (the default is:
c:\tivoli\agents\ACSWAgent\bin\),
© Copyright IBM Corp. 2003, 2005 3
v CiscoSecure ACS Adapter administrator account ID,
v CiscoSecure ACS Adapter administrator account password.
Step 1: Testing Network Connectivity
This step tests basic network connectivity and file transfer capability. Testing is
done between the Windows workstation where the CiscoSecure ACS Adapter will
be installed, and the workstation where the Tivoli Identity Manager Server is or
will be located.
You must issue a ping command from the Tivoli Identity Manager to the
designated adapter workstations to verify communication.
1. Log on to the workstation running Tivoli Identity Manager.
2. Test communication between the system where the Tivoli Identity Manager
Server is located and the Windows workstation.
# ping host_name
Step 2: Installing the Adapter
An executable installation program is provided for the CiscoSecure ACS Adapter.
When you run the installation program, you can accept the default settings or
select new values.
The Tivoli Identity Manager CiscoSecure ACS Adapter installation files are
available for download from IBM’s Web site. Contact your IBM account
representative for the Web address and download instructions.
To install the adapter, do the following:
1. Download the CiscoSecure ACS Adapter installation zip file from IBM’s Web
site.
2. Extract the contents of the CiscoSecure ACS Adapter installation zip file into a
temporary directory.
3. Select Run... from the Start menu and type the path to the temporary directory
followed by Setup.exe. For example:
C:\Temp\Setup.exe
The Welcome dialog window appears.
4. Click Next.
The Software Licence Agreement dialog window appears. Read the license
agreement carefully and, if you accept the agreement, select the I accept the
terms in the license agreement option.
5. Click Next.
The Select Destination Directory dialog window appears.Select Destination
Directory dialog window
6. Accept the default or select an alternate destination path and click Next.
The Install Summary dialog window appears.
7. Click Next.
The CiscoSecure ACS installation directory dialog is displayed.
8. Accept the default CiscoSecure installation directory or enter the actual
installation directory path for your CiscoSecure ACS server, then click Next.
9. The CiscoSecure ACS Adapter is installed and a completion dialog is displayed.
Click Finish.
4 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Step 3: Activating the Adapter as a Service
The CiscoSecure ACS Adapter is installed on the Windows NT® Server and
automatically starts whenever the server is rebooted. However, the service is not
active after installation. Select the CiscoSecure ACS Adapter service to start the
CiscoSecure ACS Adapter software on the target platform.
Step 4: Configuring the Adapter
The CiscoSecure ACS Adapter uses the DAML protocol to ensure secure
communication with the Tivoli Identity Manager Server. Default protocol values
are provided. However, you must configure the DAML protocol for your site’s
systems. Refer to “Changing protocol configuration settings” on page 10 for more
information.
Note: A certificate must be installed for the DAML protocol. Refer to “Step 5:
Installing the Adapter’s Certificate” for more information about installing
certificates.
Step 5: Installing the Adapter’s Certificate
A certificate must also be installed for the DAML protocol. You must obtain a
production certificate from a well-known Certificate Authority or create your own
certificate using your own Certificate Authority. The CiscoSecure ACS Adapter
does not come prepackaged with a certificate.
When you install the new certificate, you will also need to install the new
Certificate Authority on the Tivoli Identity Manager Server. Refer to the Tivoli
Identity Manager Configuration Guide for more information.
Note: You must configure the DAML protocol before installing your certificate.
Stop and restart the adapter after the certificate is installed.
Step 6: 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 onto the Tivoli Identity
Manager Server before using the CiscoSecure ACS Adapter. The profile is used to
create a CiscoSecure ACS 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 Before importing the adapter profile, the Tivoli Identity Manager Server must be
installed and running.
v In order to configure the CiscoSecure ACS Adapter profile, you must have root
or Administrator authority on the Tivoli Identity Manager Server.
In order to import the adapter profile, complete the following steps:
1. Log in to the Tivoli Identity Manager Server using an account that has the
authority to perform administrative tasks.
2. From the Main Menu Navigation Bar, select the Configuration tab.
3. On the Configuration window, select Import/Export → Import tabs.
Chapter 2. Adapter Installation 5
4. On the Import window, in the File to Upload field, type the location of the
ACSWProfile.jar file, or click Browse to locate the file.
5. Click the Import data into Identity manager link to import the adapter profile
into the Tivoli Identity Manager Server.
v If the adapter profile import completes successfully, the following message is
displayed:
Profile installation complete.
v If the adapter profile import fails, the following message is displayed:
Profile installation failed.
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 handle.file.fileDir property that is
defined in the Tivoli Identity Manager enRoleLogging.properties file, which
is located in the Tivoli Identity Manager \data directory.
Step 7: Configuring the Adapter’s Forms
Configure the adapter’s service maintenance and account maintenance forms on
the Tivoli Identity Manager Server. Refer to the IBM Tivoli Identity Manager
Information Center for more information.
Step 8: Configuring the ACS DB Synchronization
The adapter uses DB Synchronization to manage CiscoSecure ACS user accounts.
The CiscoSecure ACS version 3.2(1) supports only one data source for DB
Synchronization. Currently it is not possible to simultaneously enable both the ACS
Adapter and another DB Synchronization.
Perform the following steps in sequence to set up DB Synchronization for the ACS
Adapter:
Enable DB Synchronization User Interface Settings:
1. Start the CiscoSecure ACS Web administration interface and go to
Interface Configuration.
2. Select Advanced Options and check the RDBMS Synchronization
check box.
3. Press Submit button.
Add AAA Server for DB Synchronization:
1. Go to Network Configuration.
2. In the Add Servers section, select Add Entry.
3. Add AAA Server with the name ACSWAgent, with its own IP address,
and an arbitrary key. The AAA Server type should be CiscoSecure ACS
with inbound/outbound synchronization.
4. Press Submit and Restart.
Note: The IP Overlapping error message can be safely ignored.
Stop DB Synchronization Service:
1. Stop the CSDBSync service.
2. Change the CSDBSync service startup type to manual.
Setup the ODBC data source for ACSW Agent:
6 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
1. Select Start then Settings then Control Panel then Administrative
Tools then Data Source (ODBS).
2. Select the System DSN tab.
3. Select Add.
4. From the driver list, select Microsoft text driver (*.txt, *.csv).
5. Press Finish.
6. Specify the Name: ACSWAgent, and Description: ACSW Agent data
source.
7. Uncheck the Use current directory check box.
8. Press the Select Directory button.
9. Select the adapter’s bin directory (e.g.
C:\Tivoli\Agents\ACSWAgent\bin).
10. Press OK.
11. Highlight ACSWAgent and press the Configuration button.
12. Select the Options>> button.
13. Press the Define Format button.
14. Select the file accountactions.csv.
15. Uncheck the Column Name Header check box.
16. Press the OK button.
17. Press the OK button.
18. Press the OK button.
Setup RDBMS Synchronization partners:
1. Go to System Configuration.
2. Select RDBMS Synchronization.
3. Select and Add ACSWAgent from Synchronization Partners.
4. Press Submit.
Edit proper data source name in Cisco Secure ACS registry settings:
1. Start the regedit utility.
2. Go to HKEY_LOCAL_MACHINE\SOFTWARE\Cisco\CiscoAAAv3.2\CSDbSync.
3. Change the OdbcUpdateTable variable value to:
accountactions.csv
4. Change the OdbcDataSource variable value to ACSWAgent.
5. Exit the regedit utility.
Test DB Synchronization:
1. Go to the directory C:\Program Files\CiscoSecure ACS v3.2\CSDBSync
2. Run the command:
CSDBSync.exe -run
Chapter 2. Adapter Installation 7
8 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Chapter 3. Configuring the adapter for IBM Tivoli Identity
Manager
Use the adapter configuration program, agentCfg, in order to view or modify the
CiscoSecure ACS 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 CiscoSecure ACS
Adapter parameters, complete these steps:
1. From the Start Menu, select Programs → Accessories → Command Prompt.
2. In the DOS Command Prompt window, change to the bin directory for the
adapter. For example, type the following command, if the CiscoSecure ACS
Adapter directory is in the default location:
cd \Tivoli\Agents\ACSWAgent\bin
3. Type the following command:
agentCfg -agent ACSWAgent
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 23 for procedures on using additional arguments.
4. At the Enter configuration key for Agent ’ACSWAgent’: prompt, type the
configuration key for the CiscoSecure ACS 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 10 for
procedures to change the configuration key.
The Main Configuration menu is displayed.
ACSWAgent 4.6.x 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 configuration settings See page 10.
B Changing protocol configuration settings See page 10.
© Copyright IBM Corp. 2003, 2005 9
Table 2. Options for the main configuration menu (continued)
C Configuring event notification See page 13.
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 21.
H Viewing statistics See page 22.
I Changing code page settings See page 23.
Viewing configuration settings
The following procedure describes how to view the CiscoSecure ACS Adapter
configuration settings.
1. At the Agent Main Configuration Menu, type A. The configuration settings for
the CiscoSecure ACS Adapter are displayed. The following screen is an
example of the CiscoSecure ACS Adapter configuration settings.
Configuration Settings
-------------------------------------------
Name : ACSWAgent
Version : 4.6.xxxx
ADK Version : 4.xx
ERM Version : 4.xx
EnRole Version : 4.0
License : NONE
Asynchronous ADD Requests : FALSE
Asynchronous MOD Requests : FALSE
Asynchronous DEL Requests : FALSE
Asynchronous SEA Requests : FALSE
Available Protocols : DAML
Configured Protocols : DAML
Logging Enabled : TRUE
Logging Directory : C:\Tivoli\Agents\ACSWAgent\Log
Log File Name : ACSWAgent.log
Max. log files : 3
Max.log file size (Mbytes) : 1
Debug Logging Enabled : TRUE
Detail Logging Enabled : FALSE
Thread Logging Enabled : FALSE
Press any key to continue
2. Press any key to return to the Main Menu.
Changing protocol configuration settings
The CiscoSecure ACS 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 36 for more
information about installing certificates.
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.
10 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
In order to configure the DAML protocol for the CiscoSecure ACS 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 CiscoSecure ACS 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 Configure Protocol
menu is displayed.
3. At the Configure Protocol menu, type C. The Protocol Properties menu for the
configured protocol is displayed with protocol properties. 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 9.38.215.20 ;Event Notif. Server name.
G. SRV_PORTNUMBER 9443 ;Event Notif. Server port number.
H. VALIDATE_CLIENT_CE FALSE ;Require client certificate.
I. REQUIRE_CERT_REG FALSE ;Require registered certificate.
X. Done
Select menu option:
4. Type the menu option of the letter 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, for example, admin.
This value is the user ID that the Tivoli Identity Manager Server uses to connect to the
adapter.
B The following prompt is displayed:
Modify Property ’PASSWORD’:
Type a password, for example, admin.
This value is the password for the user ID that the Tivoli Identity Manager Server uses to
connect to the adapter.
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 11
Table 3. Options for the DAML protocol menu (continued)
Option Configuration task
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 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 36.
F The following prompt is displayed:
Modify Property ’SRV_NODENAME’:
Type a server name, for example, 9.38.215.20.
This value is the DNS name or IP address of the Tivoli Identity Manager Server 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.
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 is 9443.
H 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 H.
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 Tivoli Identity Manager Server certificate. For more information on using CertTool,
see “Managing SSL certificates using CertTool” on page 33.
12 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Table 3. Options for the DAML protocol menu (continued)
Option Configuration task
I The following prompt is displayed:
Modify Property ’REQUIRE_CERT_REG’:
This value only applies when option H 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
adapter,” on page 27.
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.
Configuring event notification
Event notification is a feature of the CiscoSecure ACS 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 stay in
synchronization 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 10.
2. Type the menu option for the SRV_NODENAME property.
3. Specify the IP address or fully-qualified host name that identifies the Tivoli
Identity Manager Server, and press Enter.
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 13
The Protocol Properties menu is displayed with your new settings.
4. Type 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 band press Enter.
The Protocol Properties menu is displayed with your new settings.
The example menu shows all 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.
Event Notification Menu
--------------------------------------------------------------
* Reconciliation interval : 1 day(s)
* Next Reconciliation time : 23 hour(s) 56 min(s). 23 sec(s).
* Configured Contexts : Jupiter, dd309
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.
X. Done
Select menu option:
Note: This menu shows all 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 menu option of the letter that you want to change.
Option A must be enabled in order for the values of the other options to take
affect.
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, it automatically changes to enabled
v Enabled, it automatically changes to disabled
Type A to toggle between the options.
14 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Table 4. Options for the event notification menu (continued)
Option Configuration task
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 intense, therefore this value must not be set
to run too frequently.
C The following prompt is displayed:
Enter new cache size[5]:
Type a different value to change the processing cache size.
D If this option is selected, event notification is started.
E The Event Notification Entry Types menu is displayed. See “Setting event notification
triggers” on page 16 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.
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:
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 16 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}
-----------------------------------------------
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 menu
option letter.
The Event Notification menu is displayed with your new settings.
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 15
Setting event notification triggers
By default, all attributes are queried for value changes. Select 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. USER
B. GROUP
X. Done
Select menu option:
The USER and GROUP types will 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.
3. Type the letter option for the attribute to exclude from an event notification.
Attributes that are marked with the 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 CiscoSecure ACS
Adapter can have several Tivoli Identity Manager services, by specifying a
different base point for each service. 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 3 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 menu letter for the context that you want to modify. The Modify
Context menu for the selected context is displayed.
16 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
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 17.
B Configuring the target DN for event notification contexts See page 17.
C Removing the baseline database for event notification
contexts
See page 18.
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.
Reconciliation Attributes Passed to Agent for Context: Context1
----------------------------------------------------
----------------------------------------------------
A. Add new attribute
B. Modify attribute value
C. Remove attribute
X. Done
Select menu option:
2. Type the menu option of the letter 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:
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 17
1. At the Modify Context menu for the context, type B. The following prompt is
displayed:
Enter Target DN:
2. 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:
erservicename
Name of the target service.
o Name of the organization.
ou Name of the tenant in which the organization is located.
rootsuffix
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.
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 CiscoSecure ACS 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, Tivoli Identity Manager maintains a dated log file of all
transactions, ACSWAgent.log. By default, the log file is located in the \log directory.
In order to change the CiscoSecure ACS 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.
18 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Agent Activity Logging Menu
-------------------------------------
A. Activity Logging (Enabled).
B. Logging Directory (current: C:\Tivoli\Agents\ACSWAgent\Log).
C. Activity Log File Name (current: ACSWAgent.log).
D. Activity Logging Max. File Size ( 1 mbytes)
E. Activity Logging Max. Files ( 3 )
F. Debug Logging (Enabled).
G. Detail Logging (Disabled).
H. Base Logging (Disabled).
I. Thread Logging (Disabled).
X. Done
Select menu option:
2. Type the menu option letter of the activity logging 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.
Table 6. 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, it automatically changes to enabled
v Enabled, it automatically 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
located 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.
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 19
Table 6. Options for the activity logging menu (continued)
Option Configuration Task
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.
H If this option is set to enabled, the adapter maintains a log file of all transactions in the
Agent 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 menu option
letter.
The Agent Activity Logging menu is displayed with your new settings.
Changing registry settings
In order to change the CiscoSecure ACS Adapter registry settings, complete the
following steps:
1. Type F (Registry Settings) at the main menu prompt.
The Registry menu appears.
ACSWAgent 4.6.0 Agent Registry Menu
-------------------------------------------
A. Modify Non-encrypted registry settings.
B. Modify encrypted registry settings.
C. Multi-instance settings.
X. Done
Select menu option:
20 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
2. See the following procedures on modifying registry settings.
Note: There are no encrypted registry settings for this adapter.
Modifying Non-encrypted Registry Settings
1. Type A (Modifying Non-encrypted Registry Settings) at the Registry menu
prompt.
The Non-encrypted Registry settings menu appears.
Agent Registry Items
---------------------------
01. ENROLE_Version ’4.0’
02. ExecTimeout ’6000’
03. ManageHomeDirs ’TRUE’
04. ReconBufferSize ’-1’
05. ReconHomeDirSecurity ’FALSE’
06. ReconLastLogon ’FALSE’
07. ReconLastLogonAllowErrors ’FALSE’
08. WtsEnable ’FALSE’
--------------------------------
Page 1 of 1
A. Add new attribute
B. Modify attribute value
C. Remove attribute
X. Done
Select menu option:
2. Type one of the following options:
v A) Add new attribute
v B) Modify attribute value
v C) Remove attribute
v X) Done3. Type the registry item name, and press Enter.
4. Type the registry item value, if you selected option A or B, and press Enter.
The non-encrypted registry settings menu reappears and displays your new
setting(s).
Changing advanced settings
You can change the CiscoSecure ACS 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 CiscoSecure
ACS Adapter processes concurrently. In order to change these settings, complete
the following steps:
1. At the Main Menu prompt, type G.
The Advanced Settings menu is displayed. The following example shows the
default thread count settings.
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 21
ACSWAgent 4.6.0 Advanced Settings Menu
-------------------------------------------
A. Single Thread Agent (current:TRUE)
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 menu option letter of the advanced setting that you want to change.
For a description of each option, see Table 7.
Table 7. Options for the advanced settings menu
Option Descriptions
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.
Viewing statistics
In order to view an event log for the CiscoSecure ACS Adapter, complete the
following steps:
1. At the Main Menu prompt, type H.
The activity history for the adapter is displayed.
22 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
ACSWAgent 4.6.0 Agent Request Statistics
--------------------------------------------------------------------
Date Add Mod Del Ssp Res Rec
-----------------------------------------------------------------
11/15/02 000001 000000 000000 000000 000000 000001
-----------------------------------------------------------------
X. Done
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 CiscoSecure ACS
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 CiscoSecure ACS Adapter,
complete the following steps:
1. At the Main Menu prompt, type I.
The code page support menu for the adapter is displayed.
ACSWAgent 4.6.0 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 ACSWAgent 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:
1. At the Main Menu prompt, type X. The DOS 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:
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 23
-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 8 describes each argument.
Table 8. Options and descriptions for the agentCfg help menu
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 commands 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 CiscoSecure ACS 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.
-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 Windows NT servers. This allows you to verify that the
adapter can connect to Windows NT servers without the Tivoli Identity
Manager Server.
24 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Table 8. Options and descriptions for the agentCfg help menu (continued)
-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.
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 default node for the Tivoli Identity Manager Server is 44970. The
output is similar to the following output:
Agent(s) installed on node ’127.0.0.1’
-----------------------
ACSWAgent (44970)
Type agentCfg -agent ACSWAgent to display the Main Menu of the agentCfg
tool, which is used to view or modify the CiscoSecure ACS 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. Note that the default node for the CiscoSecure
ACS Adapter is 44970. The output is similar to the following output:
Agent(s) installed on node ’192.9.200.7’
------------------
ACSWAgent (44970)
Type agentCfg -agent ACSWAgent -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 CiscoSecure ACS Adapter parameters.
Chapter 3. Configuring the adapter for IBM Tivoli Identity Manager 25
26 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Chapter 4. Configuring SSL authentication for the adapter
In order to establish a secure connection between a 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 that is 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 Tivoli Identity Manager into 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
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 the
certificate. A certificate authority can be well-known and widely used by other
© Copyright IBM Corp. 2003, 2005 27
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 (ca).
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
28 Tivoli Identity Manager CiscoSecure ACS Adapter 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 private key,
extract a self-signed certificate, and 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 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 on 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 adapter 29
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 10.
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 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, Application A operates as the Tivoli Identity Manager Server, and
Application B operates as the 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 (ca) 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)
30 Tivoli Identity Manager CiscoSecure ACS Adapter 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 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 Application A, and the
Tivoli Identity Manager adapter operates as Application B.
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 30. 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 adapter 31
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 new 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 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. Tivoli Identity Manager adapter operating as an SSL server and an SSL client
32 Tivoli Identity Manager CiscoSecure ACS Adapter 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 35.
v “Installing the certificate” on page 36.
v “Installing the certificate and key from a PKCS12 file” on page 36.
v “Viewing the installed certificate” on page 37.
v “Viewing ca certificates” on page 37.
v “Installing a ca certificate” on page 37.
v “Deleting a ca certificate” on page 37.
v “Viewing registered certificates” on page 38.
v “Registering a certificate” on page 38.
v “Unregistering a certificate” on page 38.
Starting CertTool
In order to start the certificate configuration tool, CertTool, for the CiscoSecure
ACS 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 CiscoSecure ACS Adapter
directory is in the default location, type the following command:
cd\Tivoli\Agents\ACSWAgent\bin
3. Type CertTool -agent ACSWAgent at the prompt. The Main menu is displayed:
Main menu - Configuring agent: ACSWAgent
------------------------------
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 adapter 33
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 Certificate Signing
Request (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 (ca). For more information on option A, see “Generating a private
key and certificate request” on page 35.
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 36.
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 36.
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 37.
The second set of options enable you to install root ca certificates on the adapter. A
ca certificate is used by the Tivoli Identity Manager adapter to validate the
corresponding certificate presented by a client, such as the Tivoli Identity Manager
Server.
E. List CA certificates
Show the installed ca certificates. The adapter only communicates with
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 37.
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 37.
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 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.
34 Tivoli Identity Manager CiscoSecure ACS Adapter 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 option F. Install a CA
certificate.
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 38.
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 38.
J. Unregister a certificate
Unregister (remove) a certificate from the registered list. For more
information on unregistering certificates, see “Registering a certificate” on
page 38.
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 39.
Generating a private key and certificate request
A certificate signing request (csr) 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
is 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 Country prompt, type the country in which the adapter resides, and
press Enter.
7. At the State prompt, type the state in which the adapter resides (if the adapter
is located 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.
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 adapter 35
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\<adaptername>\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\< adaptername>\bin
2. At the Main Menu for the CertTool, type C. The following prompt is displayed:
Enter name of PKCS12 file:
-------------------------------------------------------------------------
36 Tivoli Identity Manager CiscoSecure ACS Adapter 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.
Chapter 4. Configuring SSL authentication for the adapter 37
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:
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,
complete the following steps:
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)
38 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
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.
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 are transported to the PKCS12 file, and the Main
Menu is displayed.
Chapter 4. Configuring SSL authentication for the adapter 39
40 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Chapter 5. Customizing the adapter
You can update the CiscoSecure ACS Adapter JAR file, ACSWProfile.jar, to make
changes to the adapter schema, 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.
Follow these steps in the listed order to customize the CiscoSecure ACS 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 ACSWProfile.jar file and
extract the files.”
2. Make the appropriate file changes.
3. Install the new attributes on the 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 42.
Copy the ACSWProfile.jar file and extract the files
The profile JAR file, ACSWProfile.jar, is included in the CiscoSecure ACS Adapter
compressed file that you downloaded from the IBM Web site. The ACSWProfile.jar
file contains the following files:
v CustomLabels.properties
v erACSWAccount.xml
v erACSWDAMLService.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 “Step 6:
Importing the Adapter Profile” on page 5.
In order to modify the ACSWProfile.jar file, complete the following steps:
1. Log on to the system where the CiscoSecure ACS Adapter is located.
2. On the Start menu, click Programs → Accessories → Command Prompt.
3. Copy the ACSWProfile.jar file into a temporary directory.
4. Extract the contents of` the ACSWProfile.jar file into the temporary directory by
running the following command:
cd c:\temp
jar -xvf ACSWProfile.jar
The jar command will create the c:\temp\ADProfile directory.
5. Edit the appropriate file.
© Copyright IBM Corp. 2003, 2005 41
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 ACSWProfile.jar ACSWProfile
2. Import the ACSWProfile.jar file into the Tivoli Identity Manager Application
Server. For more information on importing the file, see “Step 6: Importing the
Adapter Profile” on page 5.
3. Stop and start the directory server.
4. Stop and start the CiscoSecure ACS 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 Windows NT servers 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 Tivoli
Identity Manager to forego the new password requirement. You can set the
CiscoSecure ACS 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 CiscoSecure ACS Adapter to not prompt for a new
password when restoring accounts:
1. Stop the Tivoli Identity Manager Server.
2. Extract the files from the ACSWProfile.jar file. For more information on
customizing the adapter profile file, see “Copy the ACSWProfile.jar file and
extract the files” on page 41.
3. Change to the \ADProfile directory, where the resource.def file has been
created.
42 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
4. Edit the resource.def file to add the new protocol options, for example:
<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 changing these two values, you are ensuring that you will not be prompted
for a password when an account is restored.
5. Create a new ACSWProfile.jar file using the resource.def file and import the
adapter profile file into the Tivoli Identity Manager Server. For more
information on , see “Create a new JAR file and install the new attributes on
the Tivoli Identity Manager Server” on page 42.
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 CiscoSecure ACS adapter” on page 45.
Chapter 5. Customizing the adapter 43
44 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Chapter 6. Upgrading the CiscoSecure ACS adapter or the
ADK
You can either upgrade the CiscoSecure ACS Adapter or the Agent 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.
On the other hand, 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 CiscoSecure ACS adapter
If you currently have version 4.4 or 4.5 of the CiscoSecure ACS Adapter installed,
and you want version 4.6, an upgrade of the adapter is necessary. 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 CiscoSecure ACS Adapter service.
2. Install the new version of the adapter.
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, “Adapter Installation,”
on page 3.
When the upgraded adapter starts for the first time, new log files will be 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.
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.
© Copyright IBM Corp. 2003, 2005 45
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 CiscoSecure ACS 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 .ZIP file into a temporary directory.
3. Stop the CiscoSecure ACS 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 <ADKVersion>Installer.log and
<ADKVersion>Installeropt.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.
46 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Chapter 7. Uninstalling the CiscoSecure ACS adapter
Before you remove the adapter, inform your users that the CiscoSecure ACS
Adapter will be unavailable and removed from the system. If the server is taken
offline, CiscoSecure ACS Adapter requests that are not completed will not be
recoverable when the server is back online.
In order to remove the CiscoSecure ACS Adapter, complete these steps:
1. Stop the CiscoSecure ACS Adapter service.
2. Open Windows Explorer and run <adapter_directory>\_uninst\uninstaller.exe,
where adapter_directory is the directory where the adapter was installed.
3. In the Welcome window, click Next.
4. In the CiscoSecure ACS Adapter uninstallation summary window, click Next.
5. Click Finish.
Inspect the adapter directory for CiscoSecure ACS Adapter directories,
subdirectories, and files to verify that the uninstallation is complete. The
instance of the CiscoSecure ACS Adapter that was uninstalled should no longer
appear in the Services window.
© Copyright IBM Corp. 2003, 2005 47
48 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Appendix A. Adapter Variables
As part of the adapter implementation, a dedicated account for Tivoli Identity
Manager to access Windows NT servers is created on Windows NT servers. The
CiscoSecure ACS Adapter consists of files and directories that are owned by the
Tivoli Identity Manager account. These files establish communication with the
Tivoli Identity Manager Server.
Variable Descriptions
The Tivoli Identity Manager Server communicates with the CiscoSecure ACS
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 Tivoli Identity Manager Server requests from the
CiscoSecure ACS Adapter.
Table 9 is an alphabetical listing of the attributes that are used by the CiscoSecure
ACS Adapter. The table gives a brief description and the data type for the value of
the attribute.
Table 9. Variable descriptions
Variable
Directory Server
Attribute Description Data Type
UserName erUid User Login Id String
erACSWAuthType erACSWAuthType User
Authentication
Type
StringPASS_TYPE_CSDBPASS_TYPE_NTPASS_TYPE_NDSPASS_TYPE_LDAPPASS_TYPE_ODBCPASS_TYPE_ANPIPASS_TYPE_ACTVPASS_TYPE_VASCOPASS_TYPE_CRYPTOPASS_TYPE_RADIUSPASS_TYPE_SDIPASS_TYPE_ENIGMAPASS_TYPE_LEAP
erACSWProfile erACSWProfile Group Name String
erACSWSep erACSWSep Separate
Password
Boolean
erACSWPassword erACSWPassword Separate
Password
(CHAP/MS-CHAP/ARAP)
erPassword erPassword Password Character String Password
USER erUid User Account String
erACSWUF1 erACSWUF1 User Field 1 String
erACSWUF2 erACSWUF2 User Field 2 String
erACSWUF3 erACSWUF3 User Field 3 String
© Copyright IBM Corp. 2003, 2005 49
Table 9. Variable descriptions (continued)
Variable
Directory Server
Attribute Description Data Type
erACSWUF4 erACSWUF4 User Field 4 String
erACSWUF5 erACSWUF5 User Field 5 String
erACSWCallBck erACSWCallBck Callback Setting StringCB_NOTCB_GROUPCB_NUMBERCB_CLIENTCB_WINDB
erACSWCBNum erACSWCBNum Callback Setting String
erACSWIPAssig erACSWIPAssig Client IP Address
Assignment
StringIPA_NOTIPA_DIALUPIPA_AAAIPA_GROUPIPA_STATIC
erACSWIPAddr erACSWIPAddr Static IP Address String
erACSWCPool erACSWCPool Client pool by
AAA
String
erACSWMaxSess erACSWMaxSess Max sessions
settings
StringMS_UNLIMITEDMS_GROUPMS_NUMBER
erACSWNumSess erACSWNumSess Number of max
sessions
Integer
erACSWAccDis erACSWAccDis Account Disable
settings
StringAD_NEVERAD_DATE_EXCAD_FAILED_EXCAD_EXC
erACSWExDate erACSWExDate Date Exceeds String
erACSWFailAtt erACSWFailAtt Dialed attempts
exceeds
String
erACSWIPRest erACSWIPRest IP-based access
restrictions
settings
StringRES_NONERES_DENIEDRES_PERMIT
erACSWIPTable erACSWIPTable Table (AAA
Client, port,
address)
String
erACSWCLIRest erACSWCLIRest CLI/NDIS-based
access restrictions
StringRES_NONERES_DENIEDRES_PERMIT
erACSWCLITable erACSWCLITable Table (AAA
Client, port, CLI,
NDIS)
String
50 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Variables by CiscoSecure ACS Adapter Actions
The following lists are typical CiscoSecure ACS Adapter actions by their functional
transaction group. The lists include more information about required and optional
attributes sent to the CiscoSecure ACS Adapter to complete that action.
System Login Add
A System Login Add is a request to create a new user account in the domain with
the specified attributes.
Table 10. Add function attributes
Required Variables Optional Variables
UserName All other supported attributes.
erACSWUid
erPassword
erACSWAuthType
System Login Change
A System Login Change is a request to change one or more attributes for the
specified users.
Table 11. Change function attributes
Required Variables Optional Variables
UserName All other supported attributes.
System Login Delete
A System Login Delete is a request to remove the specified user from the Active
Directory.
Table 12. Delete function
Required Variables Optional Variables
UserName All other supported attributes.
System 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 13. Suspend function
Required Variables Optional Variables
UserName All other supported attributes.
System 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 is called.
Appendix A. Adapter Variables 51
Table 14. Suspend function
Required Variables Optional Variables
UserName All other supported attributes.
Reconciliation
The Reconciliation function synchronizes user account information between Tivoli
Identity Manager and the adapter. The following table is a full set of attributes
returned by reconciliation. An asterisk (*) denotes attributes that are for
informational purposes only.
Table 15. Reconciliation function
Attributes Returned During Reconciliation
UserName erACSWUid All other supported attributes.
52 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
Appendix B. Support information
This section describes the following options for obtaining support for IBM
products:
v “Searching knowledge bases”
v “Obtaining fixes” on page 54
v “Contacting IBM Software Support” on page 54
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 IBM Tivoli Identity Manager Performance Tuning Guide
Provides information needed to tune Tivoli Identity Manager Server for a
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, and then, click the Tivoli Identity
Manager link. 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/
© Copyright IBM Corp. 2003, 2005 53
Obtaining fixes
A product fix might be available to resolve your problem. You can determine what
fixes are available for your IBM software product by checking the product support
Web site:
1. Go to the IBM Software Support Web site
(http://www.ibm.com/software/support).
2. Under Products support pages A to Z, select the letter for your product name.
3. In the list of specific products, click IBM Tivoli Identity Manager.
4. Under Self help, you find a list of fixes, fix packs, and other service updates
for your product.
5. Click the name of a fix to read the description and optionally download the fix.
To receive weekly e-mail notifications about fixes and other news about IBM
products, follow these steps:
1. From the support page for any IBM product, click My support in the upper-left
corner of the page.
2. If you have already registered, skip to the next step. If you have not registered,
click register in the upper-right corner of the support page to establish your
user ID and password.
3. Sign in to My support.
4. On the My support page, click Edit profiles in the left navigation pane, and
scroll to Select Mail Preferences. Select a product family and check the
appropriate boxes for the type of information you want.
5. Click Submit.
6. For e-mail notification for other products, repeat Steps 4 and 5.
For more information about types of fixes, see the Software Support Handbook
(http://techsupport.services.ibm.com/guides/handbook.html).
Contacting IBM Software Support
IBM Software Support provides assistance with product defects.
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
54 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
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.
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.
Appendix B. Support information 55
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
and Obtaining fixes.
56 Tivoli Identity Manager CiscoSecure ACS Adapter 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. 2003, 2005 57
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:
IBM
IBM logo
AIX
DB2
Novell
SecureWay
Tivoli
Tivoli logo
Universal Database
WebSphere
Lotus is a registered trademark of Lotus Development Corporation and/or IBM
Corporation.
Domino is a trademark of International Business Machines Corporation and Lotus
Development Corporation in the United States, other countries, or both.
58 Tivoli Identity Manager CiscoSecure ACS Adapter 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 59
60 Tivoli Identity Manager CiscoSecure ACS Adapter 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 45
as a service 5
attributesby adapter action 51
descriptions 49
certificate installation 5
configuration overview 5
customization steps 41
form configuration 6
installationwizard 4
installation overview 1
profile installation 5
removal 47
Synchronization 6
upgrade 45
adapter configuration toolSee agentCfg
adapter overview 1
ADK46Installer.log file 46
ADK46Installeropt.log file 46
administrator authority 3
agentCfgarguments 23
changing adapter parametersconfiguration key 18
protocol settings 11
registry settings 20
request processing 21
menusactivity logging 18
advanced settings 21
event notification 13
help 23
Main Configuration 9
Protocol Configuration 10
registry 20
viewing configuration settings 10
attributesby CiscoSecure ACS Adapter action
add 51
change 51
delete 51
reconciliation 52
restore 51
suspend 51
descriptions 49
Bbooks
see publications viii
CCertificate Authority
definition 27
certificate signing request (csr) 36
certificatesca
available functions 34
deleting 37
installing 37
viewing installed 37
certificate management toolsSee CertTool
definition 27
examplescertificate signing request (csr) 36
install 36
installationfrom file 36
sample 36
key formats 29
overview 27
private keys and digital certificates 28
protocol configuration toolSee CertTool
register 34
registeredregistering 38
removing 38
viewing 38
request 35
self-signed 28
viewinginstalled 37
registered 38
viewing installed 37
viewing registered 38
CertToolca certificate
deleting 37
installing 37
viewing 37
certificateinstall 36
register 34
request 35
viewing installed 37
viewing registered 38
changing adapter parametersaccessing 29, 33
options 34
client authentication 34
install certificate 36
private key, generating 35
registered certificateregistering 38
removing 38
viewing 38
character sets, supported 22
client authentication 31
client validation, SSL 32
© Copyright IBM Corp. 2003, 2005 61
configurationkey
changing with agentCfg 18
default value 9, 18
purpose 9
settingschanging with agentCfg 9
default value 10
viewing with agentCfg 10
SSL 30
contextbaseline database 18
deleting 15
listing 15
modifying 16
search attributes 17
target DN 17
conventionsHOME directory
Tivoli_Common_Directory xi
DB_INSTANCE_HOME x
HTTP_HOME x
ITIM_HOME x
LDAP_HOME x
WAS_HOME x
WAS_MQ_HOME xi
WAS_NDM_HOME xi
typeface ix
UNIX variable, directory notation ix
used in this document ix
csrdefinition 35
file, generating 35
customer supportsee Software Support 54
DDAML protocol
configuring with agentCfg 11
encryptiondefault value 11
type 11
options 11
properties, changing with agentCfgoptions 11
password 11
portnumber 12
require_cert_reg 13
srv_nodename 12
srv_portnumber 12
username 11
validate_client_ce 12
SSL authentication 29
DB_INSTANCE_HOMEDB2 UDB installation directory x
definition x
debug logdefault value 19
enable/disable with agentCfg 18
purpose 20
detail logdefault value 19
enable/disable with agentCfg 18
purpose 20
directoryDB_INSTANCE_HOME x
directory (continued)HTTP_HOME x
installationDB2 UDB x
IBM Directory Server x
IBM HTTP Server x
WebSphere Application Server base product x
WebSphere Application Server Network Deployment
product xi
WebSphere MQ xi
installation for Sun ONE Directory Server x
ITIM_HOME x
LDAP_HOME x
names, UNIX notation ix
WAS_HOME x
WAS_MQ_HOME xi
WAS_NDM_HOME xi
disabilities, using documentation viii
documentsrelated viii
Tivoli Identity Manager library v
Eenable/disable with agentCfg 18
encrypted registry settings 20
encryptionDAML protocol
default value 11
type 11
SSL 27, 28
environment variableUNIX notation ix
event notificationcache size 15
changing with agentCfg 13
contextbaseline database 18
deleting 15
listing 15
modifying 16
search attributes 17
target DN 17
enable/disable 14
reconciliationattributes 15
context 15
intervals 15
modifying 15
process priority 15
starting manually 15
Ffixes, obtaining 54
Hhelp menu for agentCfg 23
accessing with -help command 23
home directoriesDB_INSTANCE_HOME x
HTTP_HOME x
ITIM_HOME x
LDAP_HOME x
WAS_HOME x
62 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
home directories (continued)WAS_MQ_HOME xi
WAS_NDM_HOME xi
HTTP_HOMEdefinition x
IBM HTTP Server installation directory x
Iimport
adapter profile 42
PKCS12 file 29
information centers, searching to find software problem
resolution 53
information worksheet 3
installationcertificate 36
directoryDB2 UDB x
IBM Directory Server x
IBM HTTP Server x
Sun ONE Directory Server x
WebSphere Application Server base product x
WebSphere Application Server Network Deployment
product xi
WebSphere MQ xi
uninstall 47
installation information worksheet 3
installation requirementsadministrator authority 3
network connectivity 3
operating system 3
server 3
server communication 3
system 3
Internet, searching to find software problem resolution 53, 54
ITIM_HOMEdefinition x
directory x
Kknowledge bases, searching to find software problem
resolution 53
LLDAP_HOME
definition x
IBM Directory Server installation directory x
Sun ONE Directory Server installation directory x
logsactivity settings, changing 10
ADK46Installer.log file 46
ADK46Installeropt.log file 46
debug 18
detail 18
directory, changing with agentCfg 19
display using agentCfg 24
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
logs (continued)statistics 22
trace.log file 6
view events 10
viewing statistics 22
Mmanuals
see publications viii
Nnetwork connectivity 3
non-encrypted registry settings 20, 21
Oonline publications
accessing viii
operating system requirements 3
Ppassword protected file
See PKCS12 file
passwordschanging configuration key 18
configuration key, default value 9, 18
passwords, changing with agentCfgDAML protocol 11
path names, notation ix
pdf format, for screen-reader software viii
PKCS12 filecertificate and key installation 36
export certificate and key 39
portnumberchanging with agentCfg 11
portnumber, changing with agentCfg 12
private keydefinition 27
private key, generating 35
problem determinationdescribing problem for IBM Software Support 55
determining business impact for IBM Software Support 55
submitting problem to IBM Software Support 55
properties, changing with agentCfg 11
protocolDAML
configuring with agentCfg 11
encryption default value 11
encryption type 11
properties, changing with agentCfg 11
SSLoverview 27
server-to-adapter configuration 30
two-way configuration 31, 32
public key 28
publicationsaccessing online viii
related viii
Tivoli Identity Manager library v
Index 63
Rreconciliation
attributes 15, 52
context 15
intervals 15
modifying 15
process priority 15
registry settingsencrypted 20
non-encrypted 20, 21
require_cert_reg, changing with agentCfg 13
restoring accountspassword requirements 42
Sself-signed certificate 28
server requirements 3
Software Supportcontacting 54
describing problem for IBM Software Support 55
determining business impact for IBM Software Support 55
submitting problem to IBM Software Support 55
srv_nodename, changing with agentCfg 12
srv_portnumber, changing with agentCfg 12
SSLcertificate installation 27
Certificate Signing Request 35
encryption 27
key formats 29
overview 27
private keys and digital certificates 28
self-signed certificates 28
server-to-adapter configuration 30
two-way configuration 31, 32
SSL implementations, DAML protocol 29
system requirements 3
Ttext, alternative for document images viii
thread count settingschanging with agentCfg 21
default values 21
maximum concurrent requests 21
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 31, 32
SSL communication 31, 32
Tivoli Identity Manager Servercommunication with the adapter 30
configuring event notification 13
SSL communication 30
Tivoli software information center viii
Tivoli_Common_Directorydefinition xi
trace.log file 6
two-way configurationSSL
client 31
client and server 32
typeface conventions ix
Uuninstallation 47
updatingadapter profile 41
upgradeadapter 45
adapter profile 5
ADK 45
username, changing with agentCfg 11
UTF8 support 22
Vvalidate_client_ce, changing with agentCfg 12
WWAS_HOME
definition x
WebSphere Application Server base installation
directory x
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 22
64 Tivoli Identity Manager CiscoSecure ACS Adapter Guide
����
Printed in USA
SC32-1749-01