Release notes - IBM Security Verify Governance Adapter v10.0.3 for SCIMHR

IBM Security Verify Governance adapter v10.0.3 for SCIMHR is available. Compatibility, installation, and other getting-started issues are addressed.

Copyright International Business Machines Corporation 2021, 2024. All rights reserved.
US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

 Contents

• Preface

• Adapter Features and Purpose

• License Agreement

• Contents of this Release

• Installation and Configuration Notes

• Supported Configurations

• Notices

 Preface

Welcome to the IBM Security Verify Governance adapter for SCIMHR.

This Release Notes contain information for the following products that was not available when the IBM Security Verify Governance manuals were printed:

• IBM Security Verify Governance Adapter for SCIMHR Installation and Configuration Guide

Adapter Features and Purpose

The SDI-based IBM Security Verify Governance Adapter for SCIMHR is designed to reconcile users, groups and roles on SCIMHR supported applications. It also supports user management tasks such as account add, modify, suspend, restore and password change.

The adapter runs in "agentless" mode and communicates using HTTPS protocol.

The IBM Verify Adapters are powerful tools that require Administrator Level authority. Adapters operate much like a human system administrator, managing users, groups and permissions. Operations requested from the IBM Security verify Governance will fail if the Adapter is not given sufficient authority to perform the requested task. IBM recommends that this Adapter run with administrative permissions.

License Agreement

Review and agree to the terms of the IBM Security Verify Governance Adapter License prior to using this product.

The license can be viewed from the "license" folder included in the product package.

Contents of this Release

Adapter Version

New Features

Closed Issues

Known Limitations

Installation and Configuration Notes

See the Installation Guide for IBM Security Verify Governance SCIMHR adapter for detailed instructions.

Corrections to Installation guide:

Chapter 1: Overview

             No updates for the current release

Chapter 2: Planning

             Prerequisites:

                          Please consult the release notes for the currently supported versions of the below products

                          Directory Integrator:

                          Remove Version 7.2 + FP6 + 7.2.0-ISS-SDI-LA0019 from the description

                          Identity server Verify Governance Server:

                          Update description as below:

                                       The following servers are supported:

                                       - IBM Security Verify Governance Identity Manager

                                       - IBM Security Verify Governance

Chapter 3: Installing

Installing the adapter binaries or connector

Procedure

1.      Copy tdi/connectors/*.jar ScimConnector.jar from the adapter package to the ITDI_HOME/jars/connectors directory.

2.      Copy tdi/functions/*.jar from the adapter package to the ITDI_HOME/jars/functions directory

Installing 3rd party client libraries

Third party client libraries are libraries and/or configuration files that are provided by the target vendor. These 3rd party client libraries must be installed with the adapter. This is not required for all adapters.This topic is not applicable for this adapter. The adapter requires access to the following jars at runtime.

About this task Before you begin:

Download Jars listed below (Refer release notes for the supported library version details) and copy them to the Security Directory Integrator environment:

1.      httpclient-<version>.jar

2.      httpcore-<version>.jar

3.      json-simple-<version>.jar

Procedure:

1.      Download the above-mentioned JAR files. Copy the files into SDI_HOME\jars\3rdparty\others directory.

Note: If there are issues with NoClassDefFoundError, copy the files into SDI_HOME\jars\patches instead of SDI_HOME\jars\3rd party\others.

2.      Restart the Dispatcher service once all JAR files are placed under SDI_HOME\jars\3rdparty\others directory.

For information about starting and stopping the service, see the Dispatcher Installation and Configuration Guide.

Service/Target form

Adapter Details tab

(Add below detail)

Mark accounts without active value as active?

Select one of the below values:

Yes:  The accounts without any status in the API response will be displayed as active.

No: The accounts without any status in the API response will be displayed as inactive.

Note: If nothing is specified, the accounts without any status in the API response will be displayed as inactive

Installing in Virtual Appliance (Chapter present under ISVG only)

For SCIM HR target management, you can install an IBM Security Verify Governance Adapters or a custom adapter on the built-in Security Directory Integrator in the virtual appliance instead of installing the adapter externally. As such, there is no need to manage a separate virtual machine or system.

About this task

This procedure is applicable to install this adapter on the virtual appliance.

Procedure

1.      Download the adapter package from the IBM Passport Advantage.

For example, Adapter-<Adaptername>.zip.

The adapter package includes the following files:

2.      From the top-level menu of the Appliance Dashboard, click Configure > SDI Management.

3.      Select the instance of the Security Directory Integrator for which you want to manage the adapters and click Manage > SDI Adapters

The SDI Adapters window is displayed with a table that list the name, version, and any comments about the installed adapters.

4.      On the SDI Adapters window, click Install.

5.      On the File Upload window, click Browse to locate the adapter package and then click OK.

For example, Adapter-<Adaptername>.zip.

6.      Provide the missing 3rd party libraries when prompted.

a.      On the File Upload for Pre-requisite files window, click Select Files.

A new File Upload window is displayed.

b.      Browse and select all the missing libraries. For example, httpclient-4.0.1.jar

c.      Click Open.

The selected files are listed in the File Upload for Pre-requisite files window.

d.      Click OK.

The missing files are uploaded, and the adapter package is updated with the 3rd party libraries.

7.      Enable secure communication.

a.      Select the instance of the Security Directory Integrator for which you want to manage the adapter.

b.      Click Edit.

c.      Click the Enable SSL check box.

d.      Click Save Configuration.

8.      Import the SSL certificate to the IBM® Security Directory Integrator server.

a.      Select the instance of the Security Directory Integrator for which you want to manage the adapter.

b.      Click Manage > Certificates.

c.      Click the Signer tab.

d.      Click Import.

The Import Certificate window is displayed.

e.      Browse for the certificate file.

f.       Specify a label for the certificate. It can be any name.

g.      Click Save.

Note: While uploading the Adapter package, you may receive System Error: A file included in the SDI Adapter zip already exists on the system and the Server Message log under Appliance tab of VA will have a reference to error com.ibm.identity.sdi.SDIManagementService E File ibm.com_IBM_Security_Verify_Governance_xxxx.swidtag found in the adapter zip at location ILMT-Tags/ already exists in system. This is because, you can install the same swidtags only once. So, if another adapter of the same type is installed, remove the swidtags.

The ibm.com_IBM_Security_Verify_Governance_Enterprise-xxxx.swidtag file is common to all adapters. In addition to the common swidtag file, an application adapter needs ibm.com_IBM_Security_Verify_Governance_Application_Adapters-xxxx.swidtag file and an infra adapter needs ibm.com_IBM_Security_Verify_Governance_Lifecycle-xxxx.swidtag and ibm.com_IBM_Security_Verify_Governance_Compliance-xxxx.swidtag files. So, if an application adapter is already installed and this is an infra adapter, then only install the infra-specific swidtags and the other way around. Please visit Security Verify Governance Adapters v10.x link to identify the adapter type of the installed adapters.

Installing in an IBM Security Verify Directory Dispatcher Container

Before you begin

The steps to install adapter and related files into the container can be performed using the adapterUtil.sh script, which is shipped with the dispatcher package. This script should be staged on the machine running Kubernetes cli. The adapterUtil.sh script is also readily available in the bin directory of ISIM IBM Security Verify Governance Identity Manager Container Starter Kit installation directory (If ISVDI was selected for installation during the ISIM container installation steps).

If, for any reason, the adapter util script cannot be executed or used, the below manual instructions must be followed to copy the files to the persistent volume.

Note: The container must be restarted after installing or uninstalling the adapter and any changes to the configuration yaml. To activate changes and restart the container run the following commands:

·        <path_to_starterkit>/bin/createConfigs.sh isvdi

·        For OpenShift container:   oc -n isvgim rollout restart deployment isvdi

·        For Kubernetes container: kubectl -n isvgim rollout restart deployment isvdi

Note: This document only describes the adapterUtil.sh command options that are required to install this adapter. For other command options, such as listing installed connectors and 3rd party jars, please refer to the Dispatcher10 Installation and Configuration Guide.

Installing / Upgrading / Re-installing / Downgrading the adapter

Using Script

Use below command to install / upgrade/ re-install / downgrade the adapter:

/path/to/adapterUtil.sh -loadAdapter "/path/to/Adapter-SCIMHRFeed-*.zip" accept

Where /path/to/adapterUtil.sh is the location where the adapterUtil.sh script is installed and /path/to/Adapter-SCIMHRFeed-*.zip is the location where the Adapter zip file is staged on the machine running Kubernetes cli.

Manually copying files to Persistent Volume

Copy the files to the persistent volume mapped to the /opt/IBM/svgadapters directory of the container image as per the given directory structure:

ScimConnector.jar

Copy this file to <Persistent_Volume>/jars/connectors directory.

ILMT-Tags

Copy below files to <Persistent_Volume>/swidtag directory:

·        ibm.com_IBM_Security_Verify_Governance_Compliance-10.0.2.swidtag

·        ibm.com_IBM_Security_Verify_Governance_Enterprise-10.0.2.swidtag

·        ibm.com_IBM_Security_Verify_Governance_Lifecycle-10.0.2.swidtag

Copying 3rd party libraries:

Using Script

Use below command to copy 3rd party jars:

/path/to/adapterUtil.sh -copyToPatches "/path/to/httpclient-*.jar"

/path/to/adapterUtil.sh -copyToPatches "/path/to/httpcore-*.jar"

/path/to/adapterUtil.sh -copyToPatches "/path/to/json-simple-*.jar"

This command will copy the 3rd party jars to <Persistent_Volume>/jars/patches directory.

Manually copying files to Persistent Volume

Copy below 3rd party jar files to <Persistent_Volume>/jars/patches directory (Refer release notes for the supported jar versions):

·        httpclient-*.jar

·        httpcore-*.jar

·        json-simple-*.jar

Configuring the SSL connection between the IBM Security Verify Directory Integrator Container and the SCIM HR Target

Uploading the certificates

For non-ISVG-IM container env, download the root certificate / Signer Certificate from the secured URL of the SCIM Target and place the certificate in the certs directory of config volume which contains the config.yaml file. The default location for this config volume is /opt/IBM/dispatcher/config.

For ISVG-IM container env, copy the downloaded root certificate files to the machine that runs the adapter in the <path_to_starterkit>/config/certs directory:

cp <path_to_certificate_that_was_downloaded_from_scim_target> <path_to_starterkit>/config/certs

e.g.

cp /home/ibmuser/DigiCertGlobalRootCA.pem /root/isvg/config/certs

Refer https://www.ibm.com/docs/api/v1/content/SSCQGF_10.0.0/container/html/verify-directory-integrator.html#keyfile_trusted-certificates page from SVDI.

If the config.yaml file which is used as the YAML_CONFIG_FILE environment variable for the container doesn't have a trusted-certificates element, follow the instructions that are provided in https://www.ibm.com/docs/api/v1/content/SSCQGF_10.0.0/container/html/verify-directory-integrator.html#keyfile_trusted-certificates to add a trusted-certificates section to the config.yaml file.

Provide this path of the certificate in config.yaml file as shown in the example below:

keyfile:

  trusted-certificates:

  - '@/opt/IBM/dispatcher/config/certs/ca_cert.pem'

Updating the container

Using Script

To update the dispatcher container with the new certificate using the ISVG-IM starter kit, run the following commands:

·        <path_to_starterkit>/bin/createConfigs.sh isvdi

·        For OpenShift container: oc -n isvgim rollout restart deployment isvdi

·        For Kubernetes container: kubectl -n isvgim rollout restart deployment isvdi

Manually

To update the dispatcher container with the new certificate on Kubernetes/OpenShift, now run the following commands to create a config map and update the dispatcher specific yaml:

<kubectl or oc > create configmap <namespace> --from-file=<path to main isvdi config yaml> --from-file=<directory where certificates are stored> --dry-run=client -o yaml –namespace=<namespace where dispatcher container resides> > <path_to_dispatcher_container_that_runs_this_adapter_yaml>

e.g.

kubectl create configmap isvgimsdi --from-file=/root/isvg/config/adapters/isvdi_config.yaml --from-file=/root/isvg/config/certs --dry-run=client -o yaml --namespace=isvgim > /root/isvg/yaml/045-config-adapters.yaml

Then apply the updated dispatcher that runs this adapter yaml.

<kubectl or oc> apply -f <path_to_dispatcher_container_that_runs_this_adapter_yaml>

e.g.

oc apply -f /root/isvg/yaml/045-config-adapters.yaml

Finally restart the container

<kubectl or oc> rollout restart deployment <isvdi container deployment>

e.g.

oc -n isvgim rollout restart deployment isvdi

Enabling TLS 1.2

Refer https://www.ibm.com/docs/api/v1/content/SSCQGF_10.0.0/container/html/verify-directory-integrator.html#advanced page from SVDI.

If the config.yaml file which is used as the YAML_CONFIG_FILE environment variable for the container doesn't have an advanced configuration element, follow the instructions that are provided in https://www.ibm.com/docs/api/v1/content/SSCQGF_10.0.0/container/html/verify-directory-integrator.html#advanced to add an advanced configuration section to the config.yaml file.

To enable TLSv1.2, add 2 attr and value (key pair as mentioned in the SVDI guide) as below:

- attr: com.ibm.di.SSLProtocols

  value: 'TLSv1.2'

- attr: com.ibm.di.SSLServerProtocols

  value: 'TLSv1.2'

Note: The container must be restarted after making these changes to the configuration yaml. To activate changes and restart the container run the following commands:

·        <path_to_starterkit>/bin/createConfigs.sh isvdi

·        For OpenShift container:   oc -n isvgim rollout restart deployment isvdi

·        For Kubernetes container: kubectl -n isvgim rollout restart deployment isvdi

Enabling debug logs and disabling json-logging

Refer https://www.ibm.com/docs/api/v1/content/SSCQGF_10.0.0/container/html/verify-directory-integrator.html#general_logging page from SVDI.

If the config.yaml file which is used as the YAML_CONFIG_FILE environment variable for the container doesn't have root-level and json-logging configuration elements, follow the instructions that are provided in https://www.ibm.com/docs/api/v1/content/SSCQGF_10.0.0/container/html/verify-directory-integrator.html#general_logging to the add root-level and json-logging configuration elements section to the config.yaml file.

To enable debug logs, set value for root-level to debug and to disable json logging, set value for json-logging element to false.

Note: The container must be restarted after making these changes to the configuration yaml. To activate changes and restart the container run the following commands:

·        <path_to_starterkit>/bin/createConfigs.sh isvdi

·        For OpenShift container:   oc -n isvgim rollout restart deployment isvdi

·        For Kubernetes container: kubectl -n isvgim rollout restart deployment isvdi

Uninstalling the adapter

Using Script

Use below command to remove the adapter:

/path/to/adapterUtil.sh -removeAdapter Adapter-SCIM-HR-Feed

Manually copying files to Persistent Volume

Remove files from the given directory structure of the persistent volume mapped to /opt/IBM/svgadapters directory of the container image.

Note: Some 3rd party jars and ILMT-Tags files might be common with other installed adapters, and hence should not be removed while uninstalling this adapter:

ScimConnector.jar

Remove this file from <Persistent_Volume>/jars/connectors directory.

ILMT-Tags

Remove below files from <Persistent_Volume>/swidtag directory:

·        ibm.com_IBM_Security_Verify_Governance_Compliance-10.0.2.swidtag

·        ibm.com_IBM_Security_Verify_Governance_Enterprise-10.0.2.swidtag

·        ibm.com_IBM_Security_Verify_Governance_Lifecycle-10.0.2.swidtag

3rd party jars

Remove appropriate version of 3rd party jar files used by this adapter listed below from <Persistent_Volume>/jars/patches directory:

·        httpclient-*.jar

·        httpcore-*.jar

·        json-simple-*.jar

Chapter 4: Configuring

No updates for the current release

Chapter 5: Troubleshooting

Enabling DEBUG Logs on SDI Server

Procedure: (Replace existing procedure with below)

1.       Stop the SDI Server process

Pre-7.2.0-ISS-SDI-FP0008

2.       Edit the <SDI_Solution_Directory>/etc/log4j.properties

3.       Modify the following line:

 log4j.rootCategory=INFO, Default

 to

 log4j.rootCategory=DEBUG, Default

Post-7.2.0-ISS-SDI-FP0008

2.       Edit the <SDI_HOME>/etc/log4j2.xml

3.       Modify the following line:

 <Root level="info">

 to

 <Root level="debug">

Post-7.2.0-ISS-SDI-FP0011 (To enable TCB block in debug)

4.       Append the line com.ibm.di.logging.close=false in the <SDI_HOME >/etc/global.properties file.

5.      Start the SDI Server process

6.       Re-create the problem and collect the /logs/ibmdi.log

Logs are not getting printed in FP13 in Windows OS

Procedure:

1.      Copy log4j2.xml file from <SDI_Home_Dir>/etc and add to the <SDI_Solution_Dir>/etc (which was missing there).

2.      Configure <SDI_Solution_Dir>/ibmdiservice.props with below parameter:

jvmcmdoptions=-Dlog4j2.configurationFile=etc\log4j2.xml

3.      Restart SDI Server process

Chapter 6: Uninstalling

Procedure:

Remove step 2.b, note below it and step 3 from the procedure. Apart from this, update step 2.a as below:

2.a. Delete ScimConnector.jar and scimconnector.jar from the ITDI_HOME/jars/connectors directory.

Chapter 7: Reference

No updates for the current release 

Supported Configurations

Installation Platform

The IBM Security Verify Governance Adapter for SCIMHR was built and tested on the following product versions.

Adapter Installation Platform: 

Due to continuous Java security updates that may be applied to your ISVG or ISVGIM servers, the following SDI releases are the officially supported versions:

• Security Directory Integrator 7.2 + FP13

• IBM Security Verify Directory Integrator 10.0.0

Note: Earlier SDI supported version may function properly, however to resolve any communication errors, you must upgrade your SDI releases to the officially supported versions by the adapters

3rd Party Client Libraries:

·        httpclient-4.5.14.jar
https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient/4.5.14

·        httpcore-4.4.16.jar
https://mvnrepository.com/artifact/org.apache.httpcomponents/httpcore/4.4.16

·        json-simple-1.1.1.jar
https://mvnrepository.com/artifact/com.googlecode.json-simple/json-simple/1.1.1

Managed Resource:

SCIM Supported Target

Applications registered to Aquera 

IBM Security Verify Governance Servers:

IBM Security Verify Governance Identity Manager (v10.0.1 FP4 release or later)

IBM Security Verify Governance v10.0

*Unless this document specifies a specific fix pack version of ISVG Identity Manager v10, we expect the adapter to work with ISIM 6 as well. However, it will only be debugged and fixed from the perspective of ISVG-IM v10

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:

Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan

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.

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

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.

Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.