IBM Support

IBM Security Guardium Key Lifecycle Manager Version 4.2.1 - Fix Pack 1 README

Fix Readme


Abstract

Readme file for IBM Security Guardium Key Lifecycle Manager for distributed and containerized platforms, Version 4.2.1 Fix Pack 1 (4.2.1.1) including installation instructions, prerequisites and corequisites, and a list of fixes.

Content

Features and fixes
Features
None
Internal fixes

This release includes the fixes for the following issues:

  • Security fixes: Following CVEs have been fixed - CVE-2021-34428, CVE-2022-2047, CVE-2023-36479, CVE-2018-1553, CVE-2018-1683, CVE-2018-1755, CVE-2018-1838, CVE-2020-11987, CVE-2020-13954, CVE-2020-13956, CVE-2021-20328, CVE-2021-28169, CVE-2021-29425, CVE-2023-26048, CVE-2023-26049, CVE-2023-40167, CVE-2018-1851, CVE-2018-8039, CVE-2020-27216, CVE-2021-22696, CVE-2021-28165, CVE-2021-30468, CVE-2022-2048, CVE-2022-41704, CVE-2022-42890, CVE-2022-46363, CVE-2023-36478 CVE-2023-44487, CVE-2022-46364.
  • LDAP and OIDC - Bug fixes around LDAP and OIDC configuration.
  • Multi-master configuration - Improvement around master key management in multi master configured environment.
  • Multi-master configuration - Improvement around ROS in multi master configured environment.
  • Replication configuration - Bug fixes around replication.

For more information, see Known issues in IBM Security Guardium Key Lifecycle Manager, Version 4.2.1.

APAR fixes included in Version 4.2.1.1

APAR No.

Sev.

Abstract

DT261341

3

TS7700 Connection issue, works with clone but not master.[APAR is originally opened for GKLM 4.2]

DT261410

2

Error with incremental replication when there are pending certs.

DT380072

3

Production GKLM response time degraded and service unavailable.[APAR is originally opened for GKLM 4.1.1]

DT381442

3

Some tabs in GUI do not display correctly in Chinese environment.

DT392887

3

Some syslog fields are editable on clones.

DT398534

3

Socket connection over Port 1111 triggers replication audit entry.
 
Upgraded middleware
  • WebSphere Application Server Liberty 24.0.0.9
  • IBM SDK Java Technology Edition 8.0.8.30
Download instructions
  1. Go to IBM Fix Central home page: http://www.ibm.com/support/fixcentral/
  2. In the Product selector field, type IBM Security Key Lifecycle Manager, and select the product name when it appears.
  3. From the Installed Version list, select IBM Security Guardium Key Lifecycle Manager 4.2.1 version.
  4. From the Platform list, select the appropriate platform, and click Continue.
  5. On the Identify Fixes page, ensure that the Browse for Fixes is selected, and click Continue.
  6. On the Select Fixes page, select fix pack 4.2.1-ISS-GKLM-FP0001, and click Continue.
    You might be prompted to Sign In.  If you do not have an ID, click the Register now link and follow the registration steps.
  7. On the Download options page, select a download method (default is Download using Download Director).
  8. Select the associated files and README for fix pack: 4.2.1-ISS-GKLM-FP0001 and click Download now.

Back to top

Fix pack files checksum

Fix pack files checksum for IBM Security Guardium Key Lifecycle Manager traditional

Product/Component name

Platform

File name

Command

Checksum

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

AIX

4.2.1-ISS-GKLM-FP0001-AIX.tar.gz

 md5sum FileName.tar.gz

For example (UNIX/Linux): md5sum 4.2.1-ISS-GKLM-FP0001-AIX.tar.gz

Sample output
afedcef438592232962a8363f8bd62e6 4.2.1-ISS-GKLM-FP0001-AIX.tar.gz

afedcef438592232962a8363f8bd62e6

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

Linux

4.2.1-ISS-GKLM-FP0001-Linux.tar.gz

4c9dcdbac9d88acd7282eb58f5df3b79

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

zLinux (IBM Z)

4.2.1-ISS-GKLM-FP0001-zLinux.tar.gz

d68e13b3c2e91ed7005765b31ddd91f5

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

Linux PPC

4.2.1-ISS-GKLM-FP0001-LinuxPPC.tar.gz

3e61e185723b612c732b99b359771bc1

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

Windows

4.2.1-ISS-GKLM-FP0001-Windows.zip

 certutil -hashfile FileName.zip md5

For example (Windows): certutil -hashfile 4.2.1-ISS-GKLM-FP0001-Windows.zip md5

Sample output
MD5 hash of file 4.2.1-ISS-GKLM-FP0001-Windows.zip: af610bf58c6cd467f52383893d6d46e4
CertUtil: -hashfile command completed successfully.

af610bf58c6cd467f52383893d6d46e4
 
Fix pack files checksum for IBM Security Guardium Key Lifecycle Manager container

Product/Component name

Platform

File name

Command

Checksum

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

Linux PPC

gklm4211-ppc64le.tar

 md5sum FileName.tar.gz

For example (UNIX/Linux): md5sum gklm4211-ppc64le.tar

Sample output
3b404a1279fe22f043d9ed4d9b5b2da9 gklm4211-ppc64le.tar

3b404a1279fe22f043d9ed4d9b5b2da9

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

zLinux (IBM Z)

gklm4211-s390x.tar

ab8608dbf21e73dbd62c4968e1b1979f

IBM Security Guardium Key Lifecycle Manager 4.2.1.1

x86_64

gklm4211-x86_64.tar

e9eeffc1c4c32161268a8da5b320a822

Back to top

Known limitations and issues

Known limitations

  • Rollback of installed fix pack is not supported.
  • DS8000 will not work with FIPS on. To use DS8000 with GKLM, FIPS has to be turned off.
  • Symmetric key export will not work with FIPS on. To export symmetric key on GKLM, FIPS has to be turned off.

Known issues

  • When the Multi-Master cluster goes into read-only state, user will not be able to perform backup or export operation from GKLM UI.
    Workaround:
    1. User can perform backup or export operation using swagger UI or REST.
    Note:
    1. In RoS mode backup rollover tasks will not be backed up.
    2. In Ros mode export import history and rollover will not be exported.

Back to top

Installation instructions
Prerequisites
Applicable to all operating systems and platforms
  • Ensure that IBM Security Guardium Key Lifecycle Manager, Version 4.2.1 GA (4.2.1) is already installed.
  • Ensure that IBM Security Guardium Key Lifecycle Manager is not in use.
  • Back up the IBM Security Guardium Key Lifecycle Manager server. For instructions, see Configuring backup and restore.
  • Ensure that /tmp directory does not contain klmPrev.properties. If it is present, rename or remove this file before you start applying the fix pack. Also, ensure that the /tmp directory has all the permissions and does not have noexec set.
  • Ensure that umask is set to 0022.
  • Back up the WebSphere Liberty files.
    1. Open a command line.
    2. Stop WebSphere Liberty.
      • Windows 
        WAS_HOME\bin\stopServer.bat
      • Linux 
        WAS_HOME/bin/stopServer.sh
    3. Make a temporary directory.
      • Windows 
        mkdir WAS_BACKUP_DIRECTORY
        For example: mkdir C:\wasbackup
      • Linux 
        mkdir WAS_BACKUP_DIRECTORY
        For example: mkdir /tmp/wasbackup
    4. Change directory to the temporary directory.
      • Windows 
        cd C:\wasbackup
      • Linux 
        cd /tmp/wasbackup
    5. Copy or archive the files from the directory where WebSphere Liberty is installed.
      • Windows 
        xcopy /y /e /d WAS_HOME C:\wasbackup
      • Linux 
        tar -cvf wasbackup.tar WAS_HOME/*
    6. Start WebSphere Liberty.
      • Windows 
        WAS_HOME\bin\startServer.bat
      • Linux 
        WAS_HOME/bin/startServer.sh
Applicable to Linux/Ubuntu/AIX
  • On Ubuntu, run the following command as root user:

    ln -s DB_INSTANCE_HOME/gklm421properties/ $HOME/gklm421properties

    Where, DB_INSTANCE_HOME is the directory that contains the Db2 database instance for IBM Security Guardium Key Lifecycle Manager.

    For example,

    ln -s /home/klmdb421/gklm421properties/ $HOME/gklm421properties

  • On Linux for System z server, ensure that gtk 2 libraries are installed. Also, add the following parameter in the IM_INSTALL_DIR/eclipse/IBMIM.ini file. Add the following properties just before "--launcher.appendVmargs" in IBMIM.ini file.
    --launcher.GTK_version
    2
Installation steps
Depending on your setup, see the relevant section:

Installing the fix pack on GKLM traditional

You can use one of the following modes to install a fix pack:

Graphical mode

Complete the following instructions:
  1. Download the fix pack installer files. For instructions, see Download instructions.
  2. Extract the installer files to a folder of your choice.
  3. Open a command line.
  4. Change the directory to the directory where you extracted the fix pack installer files.
  5. Run the following command to launch the Installation Manager:

    • Windows

      updateSKLM.bat IM_INSTALL_LOCATION WAS_HOME
      For example:
      updateSKLM.bat "C:\Program Files\IBM\Installation Manager" "C:\Program Files\IBM\WebSphere\Liberty"

    • Linux

      chmod +x ./updateSKLM.sh

./updateSKLM.sh IM_INSTALL_DIR WAS_HOME
      For example:
      ./updateSKLM.sh /opt/IBM/InstallationManager /opt/IBM/WebSphere/Liberty
  6. In the Update Packages pane, select the Update all packages (mandatory) with recommended updates and recommended fixes checkbox. Click Next.
  7. Read the license agreement carefully. If okay, accept the license agreement. Click Next.
  8. In the WebSphere Liberty configuration window, do not select the checkbox to connect to the online IBM WebSphere Liberty Repository. Click Next.
  9. Installation Manager fetches the assets and lists all the fixes and features to be installed. Click Next.
  10. In the Update Packages Configuration for IBM Security Guardium Key Lifecycle Manager v4.2.1.1 pane:
    • Enter Username and Password for IBM Security Guardium Key Lifecycle Manager Application Administrator.
    • Enter Username and Password for IBM Db2 user.
  11. Click Validate Credentials. Validation might take few minutes. Wait until the Next button is enabled. Click Next.
  12. In the Update Packages > Summary pane, review the software packages that you want to install, and click Update. After Installation Manager successfully updates the fix pack for the services that you select, a message is displayed.

Silent mode

Complete the following instructions:
  1. Download the fix pack installer files. For instructions, see Download instructions.
  2. Go to the directory where you extracted the fix pack installation files.
  3. Open the /sklm directory, which is within the directory where the fix pack is extracted. It contains the response file (SKLM_Silent_Update_platform_Resp.xml) that we need to edit for the installation.
  4. Locate the response file. Create a backup of the response file: 
    For example: SKLM_Silent_Update_platform_Resp_original.xml. 
  5. Open the response file for editing. Edit the relevant elements of the response file SKLM_Silent_Update_platform_Resp.xml.
  6. Edit the repository location to point to the current location of the installer.
    • Windows 
      <repository location='C:\sklminstall_windowsfp\wasfp\repository.config'/>
<repository location='C:\sklminstall_windowsfp\sklmwasfp\repository.config'/>
    • Linux 
      <repository location='/sklminstall_linuxfp/wasfp/repository.config'/>
<repository location='/sklminstall_linuxfp/sklm/repository.config'/>
  7. Edit GKLM Administrator username and password. The password must be encrypted. To encrypt the password, see Encrypting a password.
    • Windows 
      <data key='user.SKLM_ADMIN_USER,com.ibm.gklm42.win' value='SKLMAdmin'/>
<data key='user.SKLM_ADMIN_PASSWORD,com.ibm.gklm42.win' value='9YTRJMRIydDSdfhaHPs1ag=='/>
    • Linux 
      <data key='user.SKLM_ADMIN_USER,com.ibm.gklm42.linux' value='SKLMAdmin'/>
<data key='user.SKLM_ADMIN_PASSWORD,com.ibm.gklm42.linux' value='9YTRJMRIydDSdfhaHPs1ag=='/>
  8. Edit Db2 username and password. The password must be encrypted. To encrypt the password, see Encrypting a password.
    • Windows
      <data key='user.DB_ADMIN_USER,com.ibm.gklm42.win' value='klmdb421'/>
<data key='user.DB_ADMIN_PASSWORD,com.ibm.gklm42.win' value='QTh/0AiFvrljhs9gnOYkGA=='/>
    • Linux 
      <data key='user.DB_ADMIN_USER,com.ibm.gklm42.linux' value='klmdb421'/>
<data key='user.DB_ADMIN_PASSWORD,com.ibm.gklm42.linux' value='9YTRJMRIydDSdfhaHPs1ag=='/>
  9. Open a command line, and change directory to the directory where the installer files are extracted.
  10. Run the following command:
    • Windows 
      silent_updateSKLM.bat IM_INSTALL_DIR WAS_HOME
      For example:
      silent_updateSKLM.bat "C:\Program Files\IBM\Installation Manager" "C:\Program Files\IBM\WebSphere\Liberty"
    • Linux 
      chmod +x ./silent_updateSKLM.sh
./silent_updateSKLM.sh IM_INSTALL_DIR WAS_HOME
      For example: 
      chmod +x ./silent_updateSKLM.sh
./silent_updateSKLM.sh /opt/IBM/InstallationManager /opt/IBM/WebSphere/Liberty
Encrypting a password
Generate an encrypted password. To do so, follow these steps:
  1. Open a command line.
  2. Change directory to the IM_INSTALL_DIR/eclipse/tools directory.
  3. Run the following command: imcl.exe encryptString password_to_encrypt
  4. An encrypted password is generated.

Installing the fix pack on a Multi-Master setup


Prerequisites 

If the original primary master server is acting as a standby master server, promote it to primary and then, install the fix pack. Otherwise, the database updates are not applied to the cluster.

To promote a master server to primary, see Promote to primary. 

To install the fix pack
  1. Stop WebSphere Liberty on all the master servers, in any sequence.
    1. Open a command line.
    2. Go to the WAS_HOME\bin directory.
      Windows
      C:\Program Files\IBM\WebSphere\Liberty\bin
      Linux
      /opt/IBM/WebSphere/Liberty/bin
  2. Stop the IBM Security Guardium Key Lifecycle Manager server.
    Windows
    stopServer.bat
    Linux
    ./stopServer.sh
  3. Stop Agent on all the master servers, in any sequence.
    1. Open a command line.
    2. Go to the GKLM_INSTALL_HOME\agent directory.
      Windows
      C:\Program Files\IBM\GKLMV42\agent
      Linux
      /opt/IBM/GKLMV42/agent
    3. Stop the Agent.
      Windows
      stopAgent.bat WAS_HOME
      For example: stopAgent.bat "C:\Program Files\IBM\WebSphere\Liberty"
      Linux
      ./stopAgent.sh WAS_HOME
      For example: ./stopAgent.sh /opt/IBM/WebSphere/Liberty
       
  4. Apply fix pack on each master server and verify the installation.
    Complete this step in the following sequence:
    • Primary master server
    • Principal standby master server
    • Auxiliary standby master servers
  5. For steps to install the fix pack, see Installing the fix pack.
    • To verify the installation:
    • Log in to IBM Security Guardium Key Lifecycle Manager and check the version number.
    • Ensure that the master server is running and available for use.
Installing the fix pack on GKLM container

Depending on your platform, see the relevant section:

Installing on a Kubernetes cluster

Install IBM Security Guardium Key Lifecycle Manager container V4.2.1.1 (target).

In the Helm charts, ensure that you configure the same database and volume details that were referenced by the earlier container (source).

For more information, see Install on a Kubernetes cluster.

Installing on a Red Hat OpenShift Container Platform cluster

Install IBM Security Guardium Key Lifecycle Manager container V4.2.1.1 (target).

In the Helm charts, ensure that you configure the same database and volume details that were referenced by the earlier container (source).

For more information, see Install on a Red Hat OpenShift Container Platform cluster.

Back to top

Post fix-pack installation activities

  1. Run the following scripts.
    • On Windows:
      1. Log in as the administrator user and open the Db2 command prompt.
      2. Run the following commands: 
        cd C:\Program Files\IBM\DB2GKLMV421\BIN
db2 connect to klmdb421 user <Db2_USER> using <Db2_PASSWORD>
db2 -td# -vf  C:\gklm421properties\scripts\gklmsql-fp.db2
    • On Linux:
      1. Log in as the Db2 user and open a terminal.
      2. Run the following commands: 
        su - klmdb421
db2 connect to klmdb421 user <Db2_user> using <Db2_password>
/opt/IBM/DB2GKLMV421/bin/db2 -td# -vf /home/klmdb421/gklm421properties/scripts/gklmsql-fp.db2
    • Note: In case you are getting this warning:- "KLMDB421.KMT_EVENT_TYPE" from having duplicate values for the index key" , you can ignore it as this means values are already present in table.
  2. Use one of the following methods to verify the installation.
    • Using graphical user interface:
      a. Log in to the graphical user interface.
      b. On the Welcome page header bar, click the Help (?) icon.
      c. Click About.
      The page displays the version details.
    • Using REST interface:
      Run the Version Info REST Service.  For more information, see Swagger UI. 
      For IBM Security Guardium Key Lifecycle Manager Traditional:
      IBM Security Guardium Key Lifecycle Manager Version: 4.2.1.1
IBM Security Guardium Key Lifecycle Manager Build Level: 202410151621
Liberty WAS Version: 24.0.0.9
Database Version: DB2/AIX64 SQL110590
Java Version: JRE 1.8.0_421 IBM J9 VM 2.9
Operating System Version: AIX:7.2:ppc64
Agent Version: 2.0
License Status: Trial Version expires in 89 days (Jan 14 2025)
      For IBM Security Guardium Key Lifecycle Manager Container:
      IBM Security Guardium Key Lifecycle Manager Version: 4.2.1.1
IBM Security Guardium Key Lifecycle Manager Build Level: 202410152331
Liberty WAS Version: 24.0.0.9
Database Version: PostgreSQL 16.3 (Debian 16.3-1.pgdg120+1)
Java Version: JRE 1.8.0_421 IBM J9 VM 2.9
Operating System Version: Linux:5.15.153.1-microsoft-standard-WSL2:amd64
Image Tag: 4.2.1.1
License Status: Trial Version expires in 90 days (Jan 15 2025)
  3. Back up the IBM Security Guardium Key Lifecycle Manager server. For more information, see Configuring backup and restore.

Back to top

Uninstalling the fix pack

Important: The following steps uninstall the entire product package, including IBM Security Guardium Key Lifecycle Manager, IBM Db2, and WebSphere Liberty, and all your data is lost. Take a backup before uninstalling.

Uninstalling IBM Security Guardium Key Lifecycle Manager with the fix pack by using the graphical user interface

 

Uninstalling IBM Security Guardium Key Lifecycle Manager with the fix pack silently

 

Back to top

Copyright and trademark information

http://www.ibm.com/legal/copytrade.shtml

Notices

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 jurisdictions do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement might 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.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

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

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

THIRD-PARTY LICENSE TERMS AND CONDITIONS, NOTICES AND INFORMATION

The license agreement for this product refers you to this file for details concerning terms and conditions applicable to third party software code included in this product, and for certain notices and other information IBM must provide to you under its license to certain software code. The relevant terms and conditions, notices and other information are provided or referenced below. Please note that any non-English version of the licenses below is unofficial and is provided to you for your convenience only. The English version of the licenses below, provided as part of the English version of this file, is the official version.

Notwithstanding the terms and conditions of any other agreement you may have with IBM or any of its related or affiliated entities (collectively "IBM"), the third party software code identified below are "Excluded Components" and are subject to the following terms and conditions:

  • the Excluded Components are provided on an "AS IS" basis.

  • IBM DISCLAIMS ANY AND ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS WITH RESPECT TO THE EXCLUDED COMPONENTS, INCLUDING, BUT NOT LIMITED TO, THE WARRANTY OF NON-INFRINGEMENT OR INTERFERENCE AND THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

  • IBM will not be liable to you or indemnify you for any claims related to the Excluded Components.

  • IBM will not be liable for any direct, indirect, incidental, special, exemplary, punitive or consequential damages with respect to the Excluded Components.

[{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSTJE47","label":"IBM Security Guardium Key Lifecycle Manager"},"ARM Category":[{"code":"a8m0z000000cvdzAAA","label":"SKLM-\u003EINSTALL-\u003EFIXPACK"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"4.2.1"}]

Document Information

Modified date:
04 December 2024

UID

ibm17173192

Page Feedback