com.tivoli.pd.jcfg.SvrSslCfg utility for TAM single sign-on

 

Purpose

The SvrSslCfg utility is used to configure WAS with a Tivoli Access Manager server.

Run the svrsslcfg script first on the dmgr and then on the other nodes in the cell.

java com.tivoli.pd.jcfg.SvrSslCfg
     -action {config | unconfig} 
     -admin_id admin_user_ID 
     -admin_pwd admin_password 
     -appsvr_id application_server_name 
     -appsvr_pwd application_server_password 
     -mode{local|remote} 
     -host host_name_of_application_server 
     -policysvr policy_server_name:port:rank [,...] 
     -authzsvr authorization_server_name:port:rank [,...] 
     -cfg_file fully_qualified_name_of_configuration_file 
     -domain Tivoli_Acccess_Manager_domain 
     -key_file fully_qualified_name_of_keystore_file 
     -cfg_action {create|replace}

 

Parameters

-action {config | unconfig}	Configuration action that is performed by the script. The following options apply: -action config Set a server creates user and server information in the user registry and creates local configuration and key store files on the appserver. Use the -action unconfig option to reverse this operation. If this action is specified, the following options are required: -admin_id, -admin_pwd, -appsvr_id, -port, -mode, -policysvr, -authzsvr, and -key_file. -action unconfig Reconfigures an appserver to complete the following actions: Remove the user and server information from the user registry Delete the local key store file Remove information for this application from the configuration file without deleting the file The reconfiguration operation fails only if the caller is unauthorized or the policy server cannot be contacted. This action can succeed when a configuration file does not exist. When the configuration file does not exist, it is created and used as a temporary file to hold configuration information during the operation, and then the file is deleted completely. If this action is specified, the following options are required: -admin_id, -admin_pwd, -appsvr_id, and -policysvr.
-admin_id admin_user_ID	TAM administrator name. If this option is not specified, sec_master is the default. A valid admin ID is an alphanumeric, case-sensitive string. String values are expected to be characters that are part of the local code set. We cannot use a space in the admin ID. For example, for U.S. English the valid characters are the letters a-Z, the numbers 0-9, a period (.), an underscore (_), a plus sign (+), a hyphen (-), an at sign (@), an ampersand (&), and an asterisk (*). The minimum and maximum lengths of the admin ID, if there are limits, are imposed by the underlying registry.
-admin_password admin_password	Password of the TAM administrator user that is associated with the -admin_id parameter. The password restrictions depend upon the password policy for the TAM configuration.
-appsvr_id application_server_name	Name of the appserver. The name is combined with the host name to create unique names for TAM objects created for the application. The following names are reserved for TAM applications: ivacld, secmgrd, ivnet, and ivweb.
-appsvr_pwd application_server_password	Password of the appserver. This option is required. A password is created by the system and the configuration file is updated with the password created by the system. If this option is not specified, the server password will be read from standard input.
-authzsvr authorization_server_name	Name of the TAM authorization server with which the appserver communicates. The server is specified by fully qualified host name, the SSL port number, and the rank. The default SSL port number is 7136. For example: myauth.mycompany.com:7136:1. We can specify multiple servers if the entries are separated by a comma (,).
-cfg_action {create | replace}	Action to take when creating the configuration and key files. Valid values are create or replace. Use the create option to initially create the configuration and keystore files. Use the replace option if these files already exist. If we use the create option and the configuration or keystore files already exist, an exception is created.Options are as follows: create Create the configuration and key store files during server configuration. Configuration fails if either of these files already exists. replace Replace the configuration and key store files during server configuration. Configuration deletes any existing files and replaces them with new ones.
-cfg_file fully_qualified_name_of_configuration_file	Configuration file path and name. A file name should be an absolute file name (fully qualified file name) to be valid.
-domain Tivoli_Access_Manager_domain	TAM domain name to which the administrator is authenticated. This domain must exist and an the administrator ID and password must be valid for this domain. The appserver is specified in this domain. If not specified, the local domain that was specified during TAM runtime configuration will be used. The local domain value will be retrieved from the configuration file. A valid domain name is an alphanumeric, case-sensitive string. String values are expected to be characters that are part of the local code set. We cannot use a space in the domain name. For example, for U.S. English the valid characters for domain names are the letters a-Z, the numbers 0-9, a period ( . ), an underscore (_), a plus sign (+), a hyphen (-), an at sign (@), an ampersand (&), and an asterisk (*). The minimum and maximum lengths of the domain name, if there are limits, are imposed by the underlying registry.
-host host_name_of_application_server	TCP host name used by the TAM policy server to contact this server. This name is saved in the configuration file using the azn-app-host key. The default is the local host name returned by the operating system. Valid values for host_name include any valid IP host name. Examples: host = libra host = libra.dallas.ibm.com
-key_file fully_qualified_name_of_keystore_file	Directory that is to contain the key files for the server. A valid directory name is determined by the operating system. Use a fully qualified file name that contains the appserver certificate and key file. Make sure that server user (for example, ivmgr) or all users have permission to access the .kdb file and the folder that contains the .kdb file. Required.
-mode server_mode	Mode in which the application operates. This value must be either local or remote.
-policysvr policy_server_name	Name of the policy server.

 

Comments

After the successful configuration of a TAM Java appserver, SvrSslCfg creates a user account and server entries representing the Java appserver in the TAM user registry. In addition, SvrSslCfg creates a configuration file and a Java key store file, which securely stores a client certificate, locally on the appserver. This client certificate permits callers to make authenticated use of TAM services. Conversely, reconfiguration removes the user and server entries from the user registry and cleans up the local configuration and keystore files.

The contents of an existing configuration file can be modified by using the SvrSslCfg utility. The configuration file and the key store file must already exist when calling SvrSslCfg with all options other than -action config or -action unconfig.

The following options are parsed and processed into the configuration file, but are otherwise ignored in this version of TAM: The host name is used to build a unique name (identity) for the application. The pdadmin user list command displays the application identity name in the following format:

server_name/host_name

The pdadmin server list command displays the server name in a slightly different format:

server_name-host_name

 

Example

CLASSPATH=${WAS_HOME}/java/jre/lib/ext/PD.jar:${WAS_CLASSPATH} java \
-cp ${CLASSPATH} \
-Dpd.cfg.home= ${WAS_HOME}/java/jre \
-Dfile.encoding=ISO8859-1 \
-Dws.output.encoding=CP1047 \
-Xnoargsconversion \
 com.tivoli.pd.jcfg.SvrSslCfg \
-action config \
-admin_id sec_master \
-admin_pwd $TAM_PASSWORD \
-appsvr_id $APPSVR_ID \
-policysvr ${TAM_HOST}:7135:1 \
-port 7135 \
-authzsvr ${TAM_HOST}:7136:1 \
-mode remote \
-cfg_file ${CFG_FILE} \
-key_file ${KEY_FILE} \
-cfg_action create

---

 

Related tasks

Set single sign-on capability with TAM or WebSEAL