Release Notes       

 

 

IBM® Security Verify Governance Adapter for

Broadcom Top Secret

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Version 10.0.5       

Second  Edition (December  20, 2024)

This edition applies to the current release of IBM Security Verify Governance Adapter for Top Secret and to all subsequent releases and modifications until otherwise indicated in new editions.

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

 

Contents

 

Table of Contents

Preface

Adapter Features and Purpose

IBM Security Verify Governance Service Groups Management

License Agreement

Contents of this Release

Adapter Version

New Features

Closed Issues

Known Issues

Installation and Configuration Notes

Major changes in the current release

Upgrading to the current release

Configuration

Profiles contained in this package

Starting and stopping the adapter

Customizing or Extending Adapter Features

Getting Started

Support for Customized Adapters

Installing the adapter language pack

IBM Security Verify Governance Resources:

Updates to the Broadcom Top Secret for z/OS Adapter installation and Configuration Guide

Overview

Adapter interactions with the Identity server

Planning

Installing

Running the ISPF dialog

Communication Configuration

Service/Target form details

Verifying that the adapter is working correctly

Procedure

Upgrading

Configuring

Configuration Notes

Troubleshooting

Frequently asked questions:

Reference

Registry settings

SSL configuration in Identity Manager:

Policy Agent samples:

Top Secret certificate configuration samples:

Troubleshooting Broadcom Top Secret Adapter errors

Troubleshooting profile issues.

Supported Configurations

Installation Platform

Trademarks

Preface

Welcome to the IBM Security Verify Governance Broadcom Top Secret Adapter.


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

 

Adapter Features and Purpose

The Broadcom Top Secret Adapter is designed to create and manage Broadcom Top Secret accounts. The adapter runs in ”agent” mode and must be installed on z/OS. One adapter is installed per Broadcom Top Secret Database, but the Broadcom Top Secret Adapter may be configured to support a subset of the accounts through the scope of authority feature on the Broadcom Top Secret Service Form.

 

The deployment configuration is based, in part, on the topology of your network domain, but the primary factor is the planned structure of your Identity Provisioning Policies and Approval Workflow process. Please refer to the IBM Knowledge Center for a discussion of these topics.

 

The Verify Governance Adapters are powerful tools that require administrator level authority. Adapters operate much like a human system administrator, creating accounts, permissions and home directories. Operations requested from the Verify server will fail if the adapter is not given sufficient authority to perform the requested task. IBM recommends that this adapter run with administrative permissions.

IBM Security Verify Governance Service Groups Management

By service groups, IBM Security Verify Governance - Identity Manager is referring to any logical entity that can group accounts together on the managed resource.


Managing service groups implies the following:

 Create service groups on the managed resource.

 Modify attribute of a service group.

 Delete a service group.

 

 Note that service group name change is not supported in the current IBM Security Verify Governance

             Adapter editions.

 

The Broadcom Top Secret Adapter does not support service groups management.

 

 

 

License Agreement

Review and agree to the terms of the IBM Security Verify Governance product 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

Component

Version

Build Date

December 13, 2024

Adapter Version

10.0.5

Component Versions

Adapter Build  10.0.005.000

Profile 10.0.005.00

ADK 10.0.100.00 z/OS

Documentation

Please check out the latest documentation on the IBM Security Verify Governance  Documentation Center.

Select the latest server release to navigate to the latest adapter guides.

 

 

New Features       

Internal#

RFE/CASE#

 

 

 

 

Items included in the current release

SVGAD-3471

ADAPT-154

 Update TSS adapter to replace OpenSSL with AT-TLS

 

 

Items included in release 10.0.4

RTC 190581

 

Support for z/OS 2.5

SVGAD-1095

ADAPT-140

Support for z/OS 3.1

 

 

 

Items included in release 10.0.3

 

 

No items included in this release

 

 

 

Items included in release 10.0.2

RTC 189230

 

Remove APPC dependency from Top Secret adapter

RTC 189232

 

abort if tag is missing

 

 

 

Items included in release 10.0.1

RTC 187573

 

Rebranding IBM Security Identity to IBM Security Verify

 

 

 

Items included in release 7.1.21

RFE 61969

RFE 142733

Add department full name to support automated employee transfer between branches.

RTC 187271

N/A

Add managed resource version.

RTC 187270

N/A

Define full Top Secret Profile name as the Master Description for entitlement type CATSSGroupProfile in IGI.

RFE 62721

RFE 144798

Add PHRASEONLY attribute

 

 

 

Items included in release 7.1.20

 

 

No items included in this release

 

 

 

Items included in release 7.1.19

 

 

No items included in this release

 

 

 

Items included in release 7.1.18

 

 

No items included in this release

 

 

 

Items included in release 7.1.17

 

 

No items included in this release

 

 

 

Items included in release 7.1.16

RTC 182213

 

 IGI 5.2.5 support -

As an adapter developer for z/OS I need to add support for supporting data and canonical values to the IGI profiles

 

 

 

Items included in release 7.1.15

 

 

No items included in this release

 

 

 

Items included in release 7.1.14

 

 

No items included in this release

 

 

 

Items included in release 7.1.13

 

 

No items included in this release

 

 

 

Items included in release 7.1.13

RTC 52661

RTC 173352

115005

As an AD for z/OS developer I need to offer the ability to explicitly disable TLS1.0 in all ADK based adapters.

RTC 173354

TS000074249

As an ADK for z/OS developer I need to add diagnostic messages to the ADK that allow troubleshooting 2-way ssl connections

RTC 173351

 

As an ADK for z/OS developer I need to upgrade to OpenSSL 1.0.2n

 

 

 

Items included in release 7.1.12

RTC163066

 

As a Top Secret adapter customer, I would like to use the adapter in an  IBM Security Verify Governance and Intelligence (IGI) environment.

 

 

 

Items included in release 7.0.11

RTC166462

32451

TSS access FACILITIES as supporting data

RTC71407

 

MATCHLIM support

RTC163356

 

Enable SSL by default in the ISPF installation panels

 

 

 

 

Items included in release 7.0.10

RTC154238

 

Update OpenSSL to release 1.0.2j

RTC154263

PMR 42182,122,000

Disable SSLV3 and RC4 ciphers and certify TLS 1.1 / 1.2 is supported by the ADK

RTC156347

32546

 

Adapter appears to be running while it was unable to connect to the socket.

RTC149041

 

 

Add two initial lines to CustomLabels.properties which are required for translation and update the profile version to match the adapter version.

 

 

 

Items included in release 7.0.9

 

 

No items included in this release

 

 

 

Items included in release 7.0.8

 

 

User lookup APPC configuration (see Configuration notes section below)

RTC 115559

35062

21865

ertopzdivisionacid,  ertopzdepartmtacid and ertopzzoneacid attributes modification

 

RTC 125711

 

33906

 

ISIM Top Secret Adapter compatibility with Passphrase

 

 

ISIM 6.0.2 release

 

Closed Issues

Internal#

APAR/CASE#

Description

 

 

 

 

Items closed in the current release

 

 

None

 

 

 

Items included in release 10.0.4

RTC 190566

TS008810700

Top Secret TSS0598E errors in the adapter log

 

RTC 190565

TS008810700

Top Secret Accounts out of sync in ISIM

 

 

 

Items included in release 10.0.3

RTC 189819

TS006522378

Add _CEE_RUNOPTS to adapter start script

RTC 189820

 

To remove an ERTOPZSECLABEL we need to specify the label too, not just REM(acid) SECLABEL

 

 

 

Items included in release 10.0.2

RTC 189233

TS005561111

invalid servicegroup mapping results in CTGIMU551E/CTGIMF007E directory server error

RTC 189234

TS005537447

CEE3204S The system detected a protection exception (System Completion Code=0C4).

          From entry point _adkRegistryGetSubFolderString at compile unit offset +000001F0 at entry offset +000001F0 at

          address 121B4110.

RTC 189235

TS004946716

CEE3204S The system detected a protection exception (System Completion Code=0C4)

From entry point _payloadFree at compile unit offset +00000060 at entry  offset +00000060 at address 33E4DE70.

 

 

 

Items included in release 10.0.1

RTC 187968

 

Upgrade to Expat 2.2.10

RTC 187969

 

DEFECT - remove profile() returns warning

 

 

 

Items included in release 7.1.21

RTC 187269

N/A

Error in canonical value mapping for erTopzOPCLASS

 

 

 

Items included in release 7.1.20

RTC 186767

TS003554276

ISIM_ADAPTER_CIPHER_LIST variable is not having any effect with RACF adapter 6.0.39

RTC 186768

TS003680545

Error when processing unmodified values in reply message

RTC 186769

TS003568847

Abend when processing reconciliation request xmls

 

 

 

Items included in release 7.1.19

RTC 186218

TS003341275

Adapter STC does not abort when running out of memory required for

new connection pthreads.

RTC 186213

TS003405510

vulnerability CVE-2016-2183(SWEET32) reported on ISIM V6.0

RTC 186214

DT040780/TS0

01615497

Memory leak in ConnectionTest operations.

 

 

 

Items included in release 7.1.18

RTC 184015

TS002309740

Adapter abend 40D, RC10 with the below messages in the CEEDUMP

 5     _ermAlloc   +00000076              libErmApi.dll                                                Call

   6     ErmSBCSStrtoUCS2Str

                     +000000C0              libErmApi.dll                                              

 

RTC 184017

TS002309740

Excessive non-ISIM server connections causing abend

Starting SSL handshake (OpenSSL)...

Handshake failed.  Error code: 1

SD_SEND to socket

Start SSL cleanup

Shutting down SSL server...

Received a segmentation violation...

RTC 183205

TS000891911

Debug output in agentCfg tool causes DAML protocol configuration issues.

RTC 183798

TS001862044

Small ListNew allocations result in abend when receiving unexpected results in account Modify output.

RTC 184032

TS002211805

APPC class defined as hardcoded A in AGTSJB06 for single account lookup transaction

 

 

 

Items included in release 7.1.17

RTC 182687

 

Disallow external calls to agentCfg port

RTC 182516

 IJ12296

Reconciliation doesn't return all accounts.

RTC 182686

 

Upgrade to  OpenSSL 1.0.2.q

 

 

 

Items included in release 7.1.16

RTC 182224

TS001778432

As an adapter for Top Secret adapter developer I need to add service groups definitions for ISIGADI

RTC 181308

 

Upgrade to ICU 3.6

RTC 181309

TS000891911

Hebrew writing direction

RTC 181310

 

Upgrade to Expat 2.2.6

RTC 181303

 

Upgrade to z/OS ADK 6.0.6

 

 

 

Items included in release 7.1.15

RTC 179043

 

Upgrade to OpenSSL 1.0.2p

 

 

 

Items included in release 7.1.14

RTC 174696

 

As an ADK for z/OS developer I need to upgrade to OpenSSL 1.0.2o to address PSIRT CVE-2018-0739

RTC 176722

TS000113385

TS 7.1.12 throws "java.lang.NullPointerException"

 

 

 

 

Items included in release 7.1.13

RTC 173353

TS000114491

As an ADK for z/OS developer I need to ensure that manually dropping the DAML_PORT socket doesn't result in a loop

RTC 173360

TS000013259

Since installing 6.0.29 customer cannot longer change the DAML password

RTC 173723

 

Attempt to destroy context for invalid socket results in dump in _ermListFree

 

 

 

Items included in release 7.1.12

RTC169659

 

PSIRT Malformed X.509 IPAddressFamily could cause OOB read (CVE-2017-3735)

 

 

 

Items included in release 7.0.11

RTC166463

PMR 22742,003,756

RSA key length used by certTool increased from 1024 to 4096, which allows it to be NIST compliant beyond 2021.

RTC166463

 

Unmodified attribute values for failed add/remove profile operations not returned to the server

 

 

 

Items included in release 7.0.10

RTC156346

 

Attribute values following the string PASSWORD are masked in the adapter log

RTC156842

PMR 17895,001,862

Heap storage problem in RACF agent

CEE3204S The system detected a protection exception (System Completion Code=0C4).

          From entry point _ermFree at compile unit offset +0000008A at entry offset +0000008A at address 2500BF4A.

 

 

 

Items included in release 7.0.9

RTC

149789

 

ICN 1469 - UNIX File Directory Usage for N/A N/A

RTC 147988

PMR 30634,082,000

ACID Profiles numbering sequence gets changed on reconciliation

 

RTC 149790

PMR 14970,082,000

TopSecret support for Z/OS V2.2, R16

 

 

 

 

Items included in release 7.0.8

 

 

No items included in this release

Known Issues

INTERNAL#

APAR/CASE#

Description

RTC67316

 

Earlier releases of the Broadcom Top Secret Adapter do not place a password on the Broadcom Top Secret ACID adapter when created. IBM supports the use of a password on this account. Please note that adding a password to the Verify Governance Adapter ACID may result in the console prompting for the password at adapter start up.

 

 

N/A

This release of the Broadcom Top Secret Adapter does not support FIPS.

 

 

N/A

User-defined ACID fields are supported for a data length of up to 249 bytes. Field data containing characters other than letters, numbers, or national characters (@, #, $) may have unpredictable results.

 

 

N/A

When changing profile assignments in Verify - Governance, the ISVG server will send two requests to the adapter. One for the rights value or permission that was deleted and one for the rights value or permission that was added.  

 

Installation and Configuration Notes

 

 

Major changes in the current release

 

In this release the ADK is upgrade to a version which no longer supports OpenSSL-based SSL communication. SSL connections require the use of AT-TLS. It also no longer supports the use of the DAML_USER and DAML_PASSWORD based authentication using the adapter internal accounts. This release of the adapter mandates a protected adapter logonid to run the started task and a valid SURROGATE ACF loginud and password to authenticate to the adapter and perform all the supported operations such as performing reconciliations, add users, changing passwords and connecting users to groups. The use of a separate ACF2 logonid that can be used to authenticate using a password or password phrase is required as well as the use of a separate, protected logonid for the adapter, since the logonid that is used to authenticate with might get locked out after a defined number of failed login attempts.   The ADAPTER ID requires update access to BPX.SERVER in class FACILITY and READ access to the profile for the SURROGATE ID in class SURROGAT.  The SURROGATE logonid requires READ access to all the documented IRR.RADMIN.XX profiles . This has not changed for those who already used a SURROGAT ID in previous releases of this adapter. The only difference is that the use of a SURROGATE ID  now is mandatory and it's value is defined in the DAML_USER and DAML_PASSWORD section of the service form on the server , rather than in the erracfrequester variable.

 

A secondary security control has been added to the authentication process. If a specific server exceeds a configuration amount of failed login attempts, the server will be disallowed to try to authenticate for a configurable number of seconds.

 

The AT-TLS configuration using the policy agent requires a valid certificate in a keyring,

https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-acf2-for-z-os/16-0/administrating/digital-certificate-support.html

 

 

The adapter supports two operating modes:  SSLMODE NONE and SSLMODE ATTLS. If, during installation, SSLMODE NONE is specified, it is possible to connect to the adapter using plain  HTTP.

To enable AT-TLS, SSLMODE ATTLS must be selected during installation. Please refer to the Reference chapter in the documentation updates in this document for sample AT-TLS and certificate configurations and the following documentation for more information regarding AT-TLS:

 

https://www.ibm.com/docs/en/zos/3.1.0?topic=protection-tls-policy-configuration

https://www.ibm.com/docs/en/zos/3.1.0?topic=protection-getting-started-tls

 

 

In this release, the OpenSSL-based tools : certTool, agentCfg, IsamTool and regis are no longer part of the adapter.  The registry file is removed and starting this release, the former registry settings are migrated to a data set member (PARMLIB member) that exports the configurable parameters as environment settings under control of the language environment. This also implies that there will only be one port required for the adapter from now on, which is the DAML_PORT that is used for communication between the server and the adapter and that the adapter will require a restart after an update of the registry/configuration settings.

 

Upgrading to the current release

Upgrading to the current release requires a full installation. Refer to the Installing and configuring section of the Broadcom Top Secret adapter guide for detailed instructions.

 

Configuration

 

Profiles contained in this package

In the  V7.1.15  and later installation package three profiles are included, one specific for ISVG, one specific for Governance Data Integration and one specific for Identity Manager (SVI).  

Installing the ISVI specific version on an Identity Manager server removes the requirement to install the Complex Attribute Handler.  This can be of interest when you have defined policies on the Identity Manager server that manage ertopzprofile related processing.

If no customization has been done to the Identity Manager server that involves the ertopzprofile attribute, the ISVG-specific profile can be used in combination with the Complex Attribute Handler on Identity Manager servers.

 

For the Governance Data Integration profile the complex attribute handler is not required. It merely defines the Top Secret Profile object class as a Service Group for ISVG compatibility.This profile can be used if Top Secret profile assignments are being made from  ISVG.

 

If you want to be able to make changes in Top Secret profile assignments in both ISVG and Identity Manager, you will have to modify the resource.def file that is included in the profile jar to define the ertopzprofile attribute as complex attribute and the complex attribute handler properties as depicted below.  Then include the complex attribute handler jar file in the ITIM_LIB shared library on ISVI/WAS server and with ISIGADI include it in the jars of SDI running ISIGADI.  With ISIQ, the handler is already included in the ISIQ side code.

 

Required additions to the <ProtocollProperties> section of the resource.def when using ISIGADI and managing Top Secret profile assignments from both ISVI and ISVG.

 

      <Property Name  = "ercomplexattributes"

                Value    = "ertopzprofile" />

      <Property Name  = "erattributehandler"

                Value    = "com.ibm.isim.util.complexattribute.TopSecretComplexAttributeHandler" />

 

 

 

 

Starting and stopping the adapter

Before you start the adapter, ensure that TCP/IP is active.

Starting ADK release 6.0.3 the adapter will write a message to SYSLOG and shutdown if it can not connect to the IP communications port. In previous releases the adapter would write an error to the adapter log and remain active without an indication that it could not communicate with the server in the SYSLOG.

 

Customizing or Extending Adapter Features

The Verify Governance Adapters can be customized and/or extended. The type and method of this customization may vary from adapter to adapter.

 

Getting Started

Customizing and extending adapters requires a number of additional skills. The developer must be familiar with the following concepts and skills prior to beginning the modifications:

 

 

Note:  This adapter supports customization only through the use of pre-Exec and post-Exec scripting. The Broadcom Top Secret adapter has REXX scripting options. Please see the Broadcom Top Secret Installation and Configuration guide for additional details.

 

IBM Security Verify Resources:

Check the “Learn” section of the IBM Security Verify Governance Documentation for links to training, publications, and demos.

 

Support for Customized Adapters

The integration to the Verify Governance server – the adapter framework – is supported. However, IBM does not support the customization, scripts, or other modifications. If you experience a problem with a customized adapter, IBM Support may require the problem to be demonstrated on the GA version of the adapter before a case is opened.

 

Installing the adapter language pack

 

 

See the IBM Security Verify Install library and search for information about installing the adapter language pack.

 

 

IBM Security Verify Governance Resources:

Please check out the latest documentation on the site.

Select the latest server release to navigate to the latest version of the adapter documentation.

Updates to the Broadcom Top Secret for z/OS Adapter installation and Configuration Guide

 

Overview

 

Adapter considerations

Replace withL

The Top Secret Adapter requires APF authorization.

The Top Secret resources that require consideration are:

FACILITY class profile STGADMIN.IGG.DEFDEL.UALIAS, with READ

The adapter requires permissions to update the master catalog. Therefore, the surrogate ACID must have one of the following permissions:

 

The adapter must run under a valid CA Top Secret loginid, with access to z/OS UNIX System Services, a valid UID, and a valid TSO account.

The name of the adapter instance must match the name of the started task user.

If you are using shared OMVS userIDs you must ensure that the output for the following command is never empty if the adapter is running: ` ps -ef | grep -i <ADAPTERID> | grep -v grep`

The adapter requires READ  permission to be defined for the  SURROGATE user on the following resources:

Table 1.

CLASS

RESOURCE

IBMFAC

IRR.RADMIN.ADDUSER

IBMFAC

IRR.RADMIN.ALTUSER

IBMFAC

IRR.RADMIN.CONNECT

IBMFAC

IRR.RADMIN.DELUSER

IBMFAC

IRR.RADMIN.PASSWORD

IBMFAC

IRR.RADMIN.REMOVE

 

The adapter ID requires UPDATE on IBMFAC BPX.SERVER and the adapter ID requires READ on IBMFAC BPX.SRV.surrogateid

Adapter interactions with the Identity server

Replace with below :

 

 

The Top Secret Adapter uses IBM Security Verify Governance Identity Manager to perform user tasks on Top Secret for z/OS®.

The adapter can add, modify, suspend, restore, reconcile, or delete users from Top Secret. The adapter uses the TCP/IP protocol to communicate with IBM Security Verify Governance Identity Manager.

The Top Secret Adapter does not use Secure Socket Layer (SSL) by default to communicate with IBM Security Verify Governance Identity Manager. To enable SSL you must perform post configuration steps.

SSL requires digital certificates and private keys to establish communication between the endpoints. Regarding SSL, the Top Secret Adapter is considered a server. When the adapter uses the SSL protocol, the server endpoint must contain a digital certificate and a private key. The client endpoint (Verify Governance Identity Server) must contain the Certificate Authority or CA certificate.

To enable SSL communication by default, install a digital certificate and a private key on the adapter and install the CA certificate on the Verify Governance Identity Server.

The default TCP/IP port on the z/OS host for the adapter and server communication is 45580. You can change this port to a different port. When you specify the port number on the adapter service form on IBM Security Verify Governance Identity Manager, make sure that it references the same port number that is configured for the adapter on the z/OS host. The port number is can be configured by updating the VERAGT00 PARMLIB member and restarting the adapter.

You can restrict the use of these ports to the Top Secret Adapter. To protect these ports with the Top Secret protection, define the profiles in the Top Secret Adapter SERVAUTH resource class. For more information, see the z/OS Communications Server, IP Configuration Guide.

Planning

No updates in the current release

 

Installing

Running the ISPF dialog

Update the panel for Step  7.a  Select Disk location parameters to define or alter data set and UNIX System Services (USS) locations.

As below:

-------- VERIFY Top Secret Adapter Customization -----

 

  Input Data Sets

 

   Fully qualified data set name of the UPLOAD data set.

    ===>                             +

 

   Fully qualified name of a dataset in the PARMLIB concatenation.

   This dataset will be used to copy the environment settings member to.

 

    ===>

 Enter data sets names, volume ID, Storage Class and z/OS Unix directories.

 

   USS Adapter read-only home

    ===>

 

   USS Adapter read/write home

    ===>

 

   Storage Class %===>

     and/or

   Disk Volume ID%===>

 

   Fully qualified data set name of Adapter Load Library

    ===>                              +

 

   Fully qualified data set name of Adapter EXEC Library

                                   +

Fully qualified data set name of the UPLOAD data set

Specifies the name of the data set that you have received earlier. For example, IBMUSER.VERTSS.UPLOAD.XMI.

 

Fully qualified name of a dataset in the PARMLIB concatenation.            

    Fully qualified name of a dataset in the PARMLIB concatenation.            

    This dataset will be used to copy the environment settings member VERAGT00 to.

This member contains all the adapter configuration settings as used to be available in the registry.dat file for adapter versions prior to version 10.0.010.00

For more information regarding parmlib concatenations see https://www.ibm.com/docs/en/zos/3.1.0?topic=installations-using-parmlib-concatenation-logical-parmlib

 

 

Unix System Services (USS) Adapter read-only home

Specifies the location where the adapter USS binaries are stored. The adapter installer creates the directories and the subordinate directories later.

 

USS Adapter read/write home

Specifies the location where the adapter registry file, certificates, and log files are written. The adapter installer creates the directories and the subordinate directories later.

Note: The read-only home and the read/write home must specify different locations. If

they are the same location, the installation might fail.

 

Storage class

Specifies the storage class for the Load and EXEC libraries.

 

DASD (Disk) volume ID

Specifies the Disk ID for the Load and EXEC libraries.

Fully qualified data set name of Adapter Load Library and Fully qualified data set name of Adapter EXEC Library

Specify the fully qualified data set name for the Load and EXEC libraries.

Update the panel for Step 7.c Select Disk location parameters to define or alter data set and UNIX System Services (USS) locations    

as below:

Adapter communication parameters

 

   IP Communications Port Number                %===>

 

   Specify SSL Mode: NONE or ATTLS              %===>

Note:+You must install a certificate when SSL is enabled.

       Review the documentation for more information.

 

   Maximum failed login attempts                %===>

 

  Seconds to block ip after max failed logins        %===>

IP Communications Port Number

Specifies the default IP Communications Port Number, which is 45580. When more than one adapter is active in the same LPAR, use a different port number for each adapter instance.

 

 

Specify SSL Mode: NONE or ATTLS              

Specifies the default SSL implementation:  specify NONE to use plaintext http communication or ATTLS to use AT-TLS

 

 

Maximum failed login attempts..  

Specify maximum number of failed login attempts for this ISVG/ISVGIM server after which, on the next attempt, new authentication attempts from the same ISVG/ISVGIM server will be blocked for a given number of seconds.

 

 

Seconds to block ip after max login attempts

Specify number of seconds to block the ISVG/ISVG-IM server address after exceeding the maximum number of failed login attempts

Communication Configuration

Service/Target form details

Top Secret ID under which requests will be processed

Optional: Specify a Top Secret ACID other than the one that is used by the adapter. This ACID can be a Control ACID with authority over a subset of ACIDs in the Top Secret database.

Verifying that the adapter is working correctly

Procedure

  1. 1.Test the connection for the service that you created on the Identity server.  

  2. 2.Run a full reconciliation from the Identity server.  

  3. 3.Run all supported operations such as add, modify, and delete on one user account.  

  4. 4.Verify the ibmdi.log  adapter logfile and the z/OS syslog after each operation to ensure that no errors are reported.  

  5. 5.Verify the trace.log file to ensure that no errors are reported when you run an adapter operation.  

Upgrading

No updates in the current release

Configuring

Remove the below paragraph

 

 

Configuring the adapter parameters

 

Remove the following paragraphs:

  1. 1.Starting the adapter configuration tool 

  2. 2.Viewing configuration settings 

  3. 3.Changing protocol configuration settings 

  4. 4.Configuring event notification 

  5. 5.Changing the configuration key 

  6. 6.Changing activity logging settings 

  7. 7.Modifying registry settings 

  8. 8.Modifying non-encrypted registry settings 

  9. 9.Changing advanced settings 

  10. 10.Viewing statistics 

  11. 11.Changing code page settings 

  12. 12.Accessing help and additional options 

 

 

 

Add the below paragraph:

 

Changing configuration settings:

 

To change a configuration setting, edit the parmlib member and restart the adapter.

Note that the configuration/registry settings need to be added in the format: name=value. Each setting/value combination needs to be specified on a new line.

E.g.  SSLMODE=ATTLS

 

See the following references for more information:

https://www.ibm.com/docs/en/zos/3.1.0?topic=applications-environment-variables

https://www.ibm.com/docs/en/zos/3.1.0?topic=evszxcl-cee-envfile#ceeenvf

 

 

See  Chapter 7 of the adapter Installation and Configuration Guide for an overview of the registry settings and their values.

 

 

Next in

Section: Configuring SSL Authentication

 

Remove:

 

DAML SSL implementation

 

Add the below paragraph:

Selecting an AT-TLS configuration mode:

 

1. aware - set controlling to false and enabled to true in /etc/pagent/ttls.policy . Use https in the connection from ISVG/ISVGIM. Define SSLMODE=NONE in parmlib member

2. application controlled: set controlling and enabled to true etc/pagent/ttls.policy . Use https in the connection from ISVG/ISVGIM. Define SSLMODE=ATTLS in parmlib member

3. don't use AT-TLS:  set enabled and controlling to false in /etc/pagent/ttls.policy. User http in the connection from ISVG/ISVGIM. Define SSLMODE=none in parmlib member

Note: if you set controlling to false and SSLMODE=ATTLS, you will see an ioct error in the adapter logs

 

For more information see: https://www.ibm.com/docs/en/zos/2.5.0?topic=applications-tls-policy-statements

 

 

 In section: Configuring certificates for SSL authentication

Paragraph: Configuring certificates for one-way SSL authentication

 

 

Replace the below text

On the adapter, complete these steps:

  1. a.Start the certTool utility.  

  2. b.Configure the SSL-server application with a signed certificate issued by a certificate authority.  

    1. i.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. ii.Submit the CSR to the certificate authority by using the instructions that are supplied by the CA. When you submit the CSR, specify that you want the root CA certificate that is returned with the server certificat 

 

 

 

With: configure a KEYRING and certificate as described in the samples in Chapter 7 – Reference

In Configuring certificates when the adapter operates as an SSL client

Replace the below text:

 

Install the CA certificate on the adapter with the certTool utility.

With: Install the CA certificate in the keyring for the account that owns the adapter as specified in the at-tls policy. See chapter 7 - Reference

 

Remove paragraph: Install the CA certificate on the adapter with the certTool utility.

 

 

Remove paragraph: Using the Regis Tool

Configuration Notes

 

Profile entitlements and Rights

 

The order of profiles attached to an ACID is important and affects the checking of the profile permissions.

To add profiles in a particular order you must add the profile names in the account form in this manner. The first number indicates the order and the separator is a vertical bar character:

010|PROFA

020|PROFB

The profile names are sorted by number (if necessary) by the adapter and added to the ACID in that order.

Any request to update ertopzprofile values must have the profile values in the request sorted from the lowest sequence to the highest sequence.

For instance:

 

<Modification Operation="replace">

<attr name="ertopzprofile">

                               <value>010|T3AUTO40</value>

                               <value>020|T3AUTO20</value>

                               <value>030|T3AUTO50</value>

</attr>

</Modification>

 

If the profiles in the request are not ordered by sequence, this will result in inconsistency in the profile assignments.

 

 

Troubleshooting

Add paragraph:

AT-TLS return codes:

For AT-TLS return codes, please see:

https://www.ibm.com/docs/en/zos/2.5.0?topic=tls-return-codes

 

 

Add paragraph:

 

RACF SURROGATE ID authentication.

The adapter uses the BPX1PWD callable service to determine if the DAML_USER and DAML_PASSWORD that are specified in the service form are valid and if the ADAPTER ID has READ access on the profile for this account  as defined in the SURROGAT class.

 

For an overview of Return and Reason codes see:

https://www.ibm.com/docs/en/zos/3.1.0?topic=csd-passwd-passwd-applid-bpx1pwd-bpx4pwd-verify-change-security-information

 

 

Logs

 

 

Add:

The size of a log file, the number of log files, the directory path, and the detailed level of logging are configured in the parmlib member.

See the below example:

Specify TRUE to enable a specific log level and FALSE to disable

Agent_Debug=TRUE                    

Agent_Detail=TRUE              

Agent_EnableLogging=TRUE      

Agent_LogDir=/var/ibm/veragent/v10-010/log

Agent_LogFile=veragnt.log                  

Agent_MaxFileSize=10                      

Agent_MaxFiles=3                          

Agent_Thread=FALSE

 

 

Frequently asked questions:

 

add:  

 

Q: I can see "__errno2 = "" message in the log .  What do they mean?

 

 

A: you  can use the bpxmtext utility to find the full text for the errorno2 number. E.g.:

 

bpxmtext 77b77221                                                                                                                                                    

TCPIP

JRGetConnErr: The connection was not in the proper state for retrieving.

 

Action: Try the request later.

 

bpxmtext 05230138                                                                                                                                                    

BPXFSCLS 02/14/24

JRFileIsBlocked: The file is blocked

 

Action: The request cannot be processed.  Try again later.

 

 

 

 

remove:

 

Why is my registry file cleared?

There might be several causes. To determine the cause, provide an answer to the following questions when contacting support:

It might be useful to collect the output from the following commands at the time a correct, configured registry file is active and compare that output to the output for the same commands after an IPL when you notice the registry is reset:

 

df -k /adapter_readwrite_home

ls -Elg /adapter_readwrite_home/data

/adapter_readwrite_home/bin/regis /adapter_readwrite_home/data/<adapter_name>.dat -list

 

Reference

 

Registry settings

Move the table to the "Environment variables" paragraph and rename that paragraph to "Configuration settings/Environment variables".

 

Add the below rows to the table:

   

 

Option  Default value    Valid Value    Function and Meaning             Required                          

SSLMODE     ATTLS                 ATTLS, NONE  Use SSL or not                          No

TLSVER         VERSION1   VERSION1,   AT-TLS Version      No

         VERSION2

 

TIMEOUT  N/A      any numeric   Seconds wait before allowing  No

              new authentication attempts

MFAILED N/A      any numeric   Maximum failed login attempts  No

              before setting the TIMEOUT for

              the service.

 

 

Remove the rows for REGISTRY and ISIM_ADAPTER_CIPHER_LIST from the Adapter environment variables table.

 

 

Add the below paragraphs:

 

SSL configuration in Identity Manager:

https://www.ibm.com/support/pages/node/713583?mhsrc=ibmsearch_a&mhq=defining-and-securing-keystores-or-truststores
https://www.ibm.com/support/pages/setting-tls-12-support-between-ibm-security-identity-manager-virtual-appliance-and-middleware-servers-such-identity-data-store-and-directory-server
https://www.ibm.com/docs/en/sim/7.0.1.13?topic=configuration-managing-server-settings

 

Update enRole.properties:
com.ibm.daml.jndi.DAMLContext.SSL_PROTOCOL=TLSv1.2

 

Restart the IM server.

 

 

 

https://www.ibm.com/docs/en/zos/3.1.0?topic=reference-application-transparent-transport-layer-security-tls

 

Policy Agent samples:

https://www.ibm.com/docs/en/zos/3.1.0?topic=applications-starting-policy-agent-as-started-task

https://www.ibm.com/docs/en/zos/3.1.0?topic=statements-ttlscipherparms-statement

 

/etc/pagent #>cat ttls.policy


TTLSConnectionAdvancedParms VERAGNT_Conn_adv { SSLv3 Off TLSv1 Off TLSv1.1 Off TLSv1.2 On ApplicationControlled On SecondaryMap Off HandshakeTimeout 20 }


TTLSCipherParms VERAGNT_cipherparms { V3CipherSuites TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 V3CipherSuites TLS_RSA_WITH_AES_256_CBC_SHA256 V3CipherSuites TLS_DHE_RSA_WITH_AES_256_SHA V3CipherSuites TLS_DHE_DSS_WITH_AES_256_SHA V3CipherSuites TLS_DHE_DSS_WITH_AES_256_CBC_SHA V3CipherSuites TLS_DH_RSA_WITH_AES_256_CBC_SHA V3CipherSuites TLS_DH_DSS_WITH_AES_256_CBC_SHA V3CipherSuites TLS_RSA_WITH_AES_256_CBC_SHA V3CipherSuites TLS_RSA_WITH_AES_128_GCM_SHA256 V3CipherSuites TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 V3CipherSuites TLS_DH_RSA_WITH_AES_128_GCM_SHA256 V3CipherSuites TLS_RSA_WITH_AES_128_CBC_SHA256 V3CipherSuites TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 V3CipherSuites TLS_DH_RSA_WITH_AES_128_CBC_SHA256 V3CipherSuites TLS_DHE_RSA_WITH_AES_128_CBC_SHA V3CipherSuites TLS_DHE_DSS_WITH_AES_128_CBC_SHA V3CipherSuites TLS_DH_RSA_WITH_AES_128_CBC_SHA V3CipherSuites TLS_DH_DSS_WITH_AES_128_CBC_SHA V3CipherSuites TLS_RSA_WITH_AES_128_CBC_SHA V3CipherSuites TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 V3CipherSuites TLS_RSA_WITH_AES_256_GCM_SHA384 V3CipherSuites TLS_RSA_WITH_AES_256_CBC_SHA256 }


TTLSRule VERAGNT { LocalPortRange 45580 Direction Inbound TTLSGroupActionRef VERAGNT_group TTLSEnvironmentActionRef VERAGNT_env TTLSConnectionActionRef VERAGNT_conn }

TTLSGroupAction VERAGNT_group{ TTLSEnabled On }

TTLSEnvironmentAction VERAGNT_env
{
HandshakeRole Server
EnvironmentUserInstance 0
TTLSKeyringParms

{ Keyring VERAGNT/KEYRING }

}

TTLSConnectionAction VERAGNT_conn

{ HandshakeRole Server TTLSCipherParmsRef VERAGNT_cipherparms TTLSConnectionAdvancedParmsRef VERAGNT_Conn_adv CtraceClearText On Trace 255 }

 

restart the policy agent after updating the configuration file:

ISPF, SDSF,  /F PAGENT,UPDATE                      

 

Top Secret  certificate configuration samples:

Please consult https://techdocs.broadcom.com/us/en/ca-mainframe-software/security/ca-top-secret-for-z-os/16-0/administrating/digital-certificates.html

To work with CERTSITE certificates, you need CONTROL authority for the IRR.DIGTCERT.

function

resource within the IBMFAC resource class (where

function

includes GENCERT, LISTRING, and LIST).

 

 TSS GENCERT CERTAUTH DIGICERT(CACERT) SUBJECTN ('n=”My Company z/OS CA” o=”My Company” ou=”My Dept” l=”My location” sp=”Illinois” c=”US”’) NADATE(12/31/25) NBDATE(12/20/25)

 TSS GENCERT CERTSITE DIGICERT(SITECERT) SUBJECTN ('n=”My Company z/OS CA” o=”My Company” ou=”My Dept” l=”My location” sp=”Illinois” c=”US”’)

NADATE(12/31/25) NBDATE(12/20/25) SIGNWITH(CACERT)

 TSS GENCERT VERAGNT  DIGICERT(VERCERT) SUBJECTN ('cn=”VERAGNT” o=”My Company” ou=”My Dept” l=”My location” sp=”Illinois” c=”US”’)

NADATE(12/31/25) NBDATE(12/20/25) SIGNWITH(CACERT)

 TSS ADDTO(VERAGNT) KEYRING(KEYRING) LABLRING(VERRING) RINGDATA(VERAGNT.VERCERT) RINGDATA(CERTAUTH.CACERT) RINGDATA(CERTSITE.SITECERT) DEFAULT USAGE(PERSONAL)

TSS EXPORT(VERAGNT) DIGICERT(VERCERT) DCDSN(VERAGNT.CERT.P12) FORMAT(PKCS12DER) PKCSPASS(passw0rd)

 

 

Troubleshooting Broadcom Top Secret Adapter errors

 

Troubleshooting profile issues.

If you experience issues opening an account form after upgrading to the latest release , it might be required to start the design forms editor, open the Top Secret account form and select save. It is not required to make any changes to the form.

 

 

 

Supported Configurations

Installation Platform

The IBM Security Verify Governance Adapter supports any combination of the following product

versions.

 

Operating Systems:

z/OS V2.5

z/OS V3.1

 

Managed Resource:

Broadcom CA Top Secret for z/OS R16

 

 

 IBM Security Verify Governance:

 IBM Security Verify Governance  v10.x

 

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.

 

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

Adobe, Acrobat, Portable Document Format (PDF), and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, other countries, or both.

Cell Broadband Engine and Cell/B.E. are trademarks of Sony Computer Entertainment, Inc., in the United States, other countries, or both and is used under license therefrom.

 

 

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

 

 

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

 

Intel®, Intel logo, Intel Inside®, Intel Inside logo, Intel Centrino™, Intel Centrino logo, Celeron®, Intel Xeon™, Intel SpeedStep®, Itanium®, and Pentium® are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

 

CA ACF2, and CA Top Secret are trademarks of Broadcom, Inc. 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.

 

ITIL® is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office.

 

IT Infrastructure Library® is a registered trademark of the Central Computer and Telecommunications Agency which is now part of the Office of Government Commerce.

 

Other company, product, and service names may be trademarks or service marks of others.

 

 

End of Release Notes