Release Notes
Abstract
This technical note provides guidance for installing IBM Security Guardium Data Protection Windows Agents v11.5.0.338, including any new features or enhancements, resolved or known issues, or notices associated with the patch.
Content
Patch information
| Product: | IBM Security Guardium |
|---|---|
| Release version: | Guardium 11.5 Windows S-TAP |
| Completion date: | 8 May 2024 |
Fix IDs
| Guardium_11.5.0.338_S-TAP_Windows |
Finding the patch
This document provides a reference to the contents of this patch. If applicable, the detailed description of each fix and instructions for applying this patch are contained within the download package. The actual package is available for downloading from the IBM Fix Central website at http://www.ibm.com/support/fixcentral/
Make the following selections on Fix Central:
Product selector: IBM Security Guardium
Installed Version: 11.0
Platform: Windows
Click "Continue", then select "Browse for fixes" and click "Continue" again.
Make the following selections on Fix Central:
Product selector: IBM Security Guardium
Installed Version: 11.0
Platform: Windows
Click "Continue", then select "Browse for fixes" and click "Continue" again.
When to reboot after installing or upgrading to v11.5 Windows S-TAP
- Fresh install of v11.5, no reboot required.
- The NmpProxy driver requires a reboot in order to complete the upgrade. If there are no issues with your current NmpProxy functionality, you can delay the reboot until the next maintenance cycle. No fixes will be applied to the NmpProxy driver until a server reboot is completed.
- Guardium strongly recommends that you do not use the following builds as they contain instabilities that can lead to system failure:
11.4.0.168 through 11.4.0.204
11.3.0.257 through 11.3.0.287
Best practice is to uninstall these builds and reboot before you install S-TAP v11.5. For all other builds, you can upgrade as usual.
Attention
SHA256 GIM client certificates
After applying patch 11.0p530 or newer, Guardium supports SHA256 GIM certificates. This has the following implications:
After applying patch 11.0p530 or newer, Guardium supports SHA256 GIM certificates. This has the following implications:
- If using default certificates, GIM connections are secured using SHA128. Custom certificates using SHA256 are more secure and are recommended for GIM connections.
Note that GIM connectivity is not interrupted after applying this patch. - GIM only verifies bundles signed with SHA256 and requires installing a transitional GIM bundle to support the change from SHA128 to SHA256.
For more information, see Updating Guardium Data Protection GIM clients with SHA256 certificates.
Deprecated support and functionality
Windows Server 2012 and 2012 R2
Windows Server 2012 and 2012 R2 have reached end of support by Microsoft on October 10, 2023 and will no longer receive security updates. For this reason, as of March 31, 2024, Guardium can no longer maintain support for these operating systems. For more information, please see: IBM Security Guardium support discontinuance notification for Microsoft Windows Server version 2012 and 2012 R2
Microsoft SQL Server 2012
IBM Security Guardium no longer supports Microsoft SQL Server 2012 as of July 12, 2022. For more information, please see: IBM Security Guardium support discontinuance notification for Microsoft SQL Server version 2008 and 2012
Windows Server 2012 and 2012 R2 have reached end of support by Microsoft on October 10, 2023 and will no longer receive security updates. For this reason, as of March 31, 2024, Guardium can no longer maintain support for these operating systems. For more information, please see: IBM Security Guardium support discontinuance notification for Microsoft Windows Server version 2012 and 2012 R2
Microsoft SQL Server 2012
IBM Security Guardium no longer supports Microsoft SQL Server 2012 as of July 12, 2022. For more information, please see: IBM Security Guardium support discontinuance notification for Microsoft SQL Server version 2008 and 2012
New features and enhancement
S-TAP status monitoring
S-TAP status monitoring allows you to monitor the DB server environment. Initially introduced in v11.4 for protocol 7 S-TAPs, this functionality is now available for protocol 8 S-TAPs.
For more information, see Configuring S-TAP in the S-TAP Control page.
Automatically correct a local IP
If the local IP is misconfigured or missing, S-TAP attempts to automatically select an appropriate IP from a list provided by the operating system. In the case of multiple available IPs, a Windows API selects the best option for creating a stable connection with the appliance.
S-TAP configuration utility
S-TAP now includes an easy-to-use command line-based utility, guard-config-update.exe, that you can use to modify the S-TAP configuration file. This utility lends itself to automating configuration processes.
For more information see Windows: Configuring S-TAP with guard-config-update.
Must Gather v3.1
As with previous versions, Must Gather continues to aid customers and support teams in troubleshooting issues by gathering and uploading debugging information. V3.1 adds a parsing option delivered by a new PowerShell script that aggregates important information from many files into a simple summary. For more information, see Must gather for Windows S-TAP and other Windows agents.
Mute logs for improved performance
When increased S-TAP performance is required due to significant traffic loads, you can mute the driver debug logs from either the installer or GIM. This provides a significant performance boost but can impact the ability to troubleshoot should problems arise.
To mute the driver logs using CLI, set the value to ON. Any other value sets the parameters to OFF. When using GIM, set the value to 1 to mute or 0 to unmute. The new parameters are:
S-TAP status monitoring allows you to monitor the DB server environment. Initially introduced in v11.4 for protocol 7 S-TAPs, this functionality is now available for protocol 8 S-TAPs.
For more information, see Configuring S-TAP in the S-TAP Control page.
Automatically correct a local IP
If the local IP is misconfigured or missing, S-TAP attempts to automatically select an appropriate IP from a list provided by the operating system. In the case of multiple available IPs, a Windows API selects the best option for creating a stable connection with the appliance.
S-TAP configuration utility
S-TAP now includes an easy-to-use command line-based utility, guard-config-update.exe, that you can use to modify the S-TAP configuration file. This utility lends itself to automating configuration processes.
For more information see Windows: Configuring S-TAP with guard-config-update.
Must Gather v3.1
As with previous versions, Must Gather continues to aid customers and support teams in troubleshooting issues by gathering and uploading debugging information. V3.1 adds a parsing option delivered by a new PowerShell script that aggregates important information from many files into a simple summary. For more information, see Must gather for Windows S-TAP and other Windows agents.
Mute logs for improved performance
When increased S-TAP performance is required due to significant traffic loads, you can mute the driver debug logs from either the installer or GIM. This provides a significant performance boost but can impact the ability to troubleshoot should problems arise.
To mute the driver logs using CLI, set the value to ON. Any other value sets the parameters to OFF. When using GIM, set the value to 1 to mute or 0 to unmute. The new parameters are:
| CLI | GIM | Description |
|---|---|---|
| -LOG-STAP-MUTE | WINSTAP_LOG_STAP_MUTE | Mute the stap.ctl log |
| -LOG-NMP-MUTE | WINSTAP_LOG_NMP_MUTE | Mute the NmpMonitor.ctl log |
| -LOG-WFP-MUTE | WINSTAP_LOG_WFP_MUTE | Mute the WfpMonitor.ctl log |
For more information see Protocol 7 Debug parameters and Protocol 8 Debug parameters.
Db2 Exit with auto-discovery
You can now use auto-discovery to configure a Db2 Exit-specific inspection engine instead of the default Db2 inspection engine. Auto-discovery will supply the default Db2 inspection engine when DB2_EXIT_DRIVER_INSTALLED=0 and will replace it with a Db2 Exit inspection engine when DB2_EXIT_DRIVER_INSTALLED=1. For more information on Db2 Exit, see Windows: Configuring the Db2 Exit Library.
Db2 Exit Configuration Utility
S-TAP includes a new Guardium utility for configuring Db2, db2configure.exe:
Db2 Exit with auto-discovery
You can now use auto-discovery to configure a Db2 Exit-specific inspection engine instead of the default Db2 inspection engine. Auto-discovery will supply the default Db2 inspection engine when DB2_EXIT_DRIVER_INSTALLED=0 and will replace it with a Db2 Exit inspection engine when DB2_EXIT_DRIVER_INSTALLED=1. For more information on Db2 Exit, see Windows: Configuring the Db2 Exit Library.
Db2 Exit Configuration Utility
S-TAP includes a new Guardium utility for configuring Db2, db2configure.exe:
- Run db2configure.exe from an administrative command prompt with no parameters to configure the Db2 database and inspection engine to capture traffic using Db2 Exit.
- Run db2configure.exe from an administrative command prompt with the UNINSTALL parameter to remove the database configuration.
Note: Restart of the database is required to finish installing or uninstalling the configuration for Db2 Exit
Enterprise load balancing configuration
S-TAP now supports managed user (MU) group and S-TAP group configuration through GIM as well as guard_tap.ini. Use of these groups is now strictly enforced when using the S-TAP installation wizard as well as GIM so that an MU group cannot be configured without an S-TAP group configuration
For more information, see Associating S-TAP group with a managed unit group for enterprise load balancing.
Extended Session Key
The new randomly generated 32-bit Extended Session Key (ESK) has been added to S-TAP’s v7 protocol for unique identification of each database session to address proper session carry-overs during failover events. GlobalSessionKey configuration parameter has been added to signal Guardium Appliance to enable or disable the usage of ESKs.
New parameter details
Guard_tap.ini: GLOBAL_SESSION_KEY
GIM: WINSTAP_GLOBAL_SESSION_KEY
Default value: 0
Description: This parameter toggles the use of extended session keys for unique session identification. 0=disabled, 1=enabled.
Improved failover functionality
S-TAP now comes with significant improvements in failover performance, ensuring that data integrity is preserved when data fails over to another configured collector.
Dropped packet count
S-TAP can handle large loads of database traffic but is not immune to buffer overflows. When data packets are dropped, S-TAP keeps a count of these to better inform customers of the state of their Guardium environment.
For more information, see Windows: S-TAP statistics
Enterprise load balancing configuration
S-TAP now supports managed user (MU) group and S-TAP group configuration through GIM as well as guard_tap.ini. Use of these groups is now strictly enforced when using the S-TAP installation wizard as well as GIM so that an MU group cannot be configured without an S-TAP group configuration
For more information, see Associating S-TAP group with a managed unit group for enterprise load balancing.
Extended Session Key
The new randomly generated 32-bit Extended Session Key (ESK) has been added to S-TAP’s v7 protocol for unique identification of each database session to address proper session carry-overs during failover events. GlobalSessionKey configuration parameter has been added to signal Guardium Appliance to enable or disable the usage of ESKs.
New parameter details
Guard_tap.ini: GLOBAL_SESSION_KEY
GIM: WINSTAP_GLOBAL_SESSION_KEY
Default value: 0
Description: This parameter toggles the use of extended session keys for unique session identification. 0=disabled, 1=enabled.
Improved failover functionality
S-TAP now comes with significant improvements in failover performance, ensuring that data integrity is preserved when data fails over to another configured collector.
Dropped packet count
S-TAP can handle large loads of database traffic but is not immune to buffer overflows. When data packets are dropped, S-TAP keeps a count of these to better inform customers of the state of their Guardium environment.
For more information, see Windows: S-TAP statistics
Known limitations and workarounds
Guardium Windows S-TAP v11.5.0.338
| Issue Key | Description |
|---|---|
| GRD-68904 | For more information, see GRD-68904 in the “Resolved issues” section of these release notes. |
| GRD-64080 | Guardium 11.5 does not support some versions of Windows S-TAP when it's used with the enterprise load balancing feature. Using incompatible versions can lead to a loss of communication with S-TAPs. Workaround: Before you upgrade your Guardium system to 11.5, you must upgrade your Windows S-TAPs to a version that is equal or higher than the following: version 11.3 revision 11.3.0.321 version 11.4 revision 11.4.0.267 version 11.5 revision 11.5.0.143. For more information, refer to: https://www.ibm.com/support/pages/node/6839291 |
| GRD-54373 | When upgrading, S-TAP stops capturing traffic for open sessions. Data for these sessions may be lost. Best Practice: Schedule upgrades during low-traffic hours. |
| GRD-52552 | Redact policies that use REGEX can only scrub data types that are null-terminated. Workaround: Fast scrub policies can improve scrubbing functionality for data that is not null-terminated. |
| GRD-44569 | Injected DLLs have been updated to allow easy loading and unloading from the system. This change does mean that the following configuration steps are required when upgrading from any 11.3 version or older. Db2 Exit configuration has changed and will not work as previously configured. Best Practice: Following upgrade to 11.5 from any 11.3 version or older, Db2 Exit should be reconfigured as described in https://www.ibm.com/docs/en/guardium/11.5?topic=tap-windows-configuring-db2-exit-library. Injected DLLs for Db2 have been updated in 11.4 and traffic will not be captured for Db2 after upgrade without a Db2 service restart. Best Practice: To capture Db2 traffic following upgrade to 11.5 from any release prior to 11.4, the Db2 service must be restarted following upgrade to S-TAP v11.5. Subsequent upgrades will not require a Db2 service restart. |
| GRD-68347 | The default value for the QUERY_REWRITE_FAIL_CLOSE parameter is 8 for S-TAP 11.1 and earlier versions. If you upgrade from an earlier version (either directly or indirectly) and are using the v7 protocol, this value might be retained in the new S-TAP. For QUERY_REWRITE_FAIL_CLOSE, 8 is no longer a valid value. Workaround: Replace the invalid value with the new default value, 0, following an upgrade from versions 11.1 and earlier. For more information about QUERY_REWRITE_FAIL_CLOSE, see Protocols 7 and 8 Query rewrite parameters. |
Resolved issues
Guardium Windows S-TAP v11.5.0.338
| Patch | Issue Key | Summary | APAR (Known Issue) |
|---|---|---|---|
| v11.5.0.159 | Link to v11.5.0.159 on Fix Central | ||
| v11.5.0.201 | Link to v11.5.0.201 on Fix Central | ||
| v11.5.0.258 | Link to v11.5.0.258 on Fix Central | ||
| V11.5.0.338 | GRD-68423 | Moved matching of login packets to Kerberos authenticated sessions from SQL Server into S-TAP to reduce occurrence of missing DB_USER and support TDS 7.0. New parameters are introduced in guard_tap.ini and GIM as follows: SSPI_NAME_LIMIT Default value: 10000 Value range: 500-20000 Description: The maximum number of SSPI names that the correlators can store in the S-TAP at any one time. Any names over this limit are dropped. SSPI_NAME_TTL Default value: 120 Value range: 5-300 Description: The number of seconds that an SSPI name is stored in the S-TAP. Names that linger beyond this time interval are dropped. SSPI_SESSION_TTL Default value: 60 Value range: 1-300 Description: The number of seconds that login packets wait for a Kerberos name to arrive for it. Login packets that linger beyond this time are released to the collector. SSPI_SESSION_MEMORY Default value: 40 Value range: 1-1024 Description: The amount of memory, in MB, that can be used to buffer traffic while waiting for Kerberos names to be delivered for active sessions. The default value for the following parameter was NOT updated in this release and remains as follows. CORRELATION_TIMEOUT Default value: 300 Guardium recommends using a value of 120 for average use. |
DT249847 |
| GRD-70198 | Improved performance of S-TAP's firewall related functionality. | DT244172 | |
| GRD-71840 | A new regex option for regular expressions allows you to specify the length of the database column to redact. This feature helps insure that the correct data is scrubbed. For more information, see REDACT - Working with regex on Windows DB servers. |
DT249854 | |
| GRD-72932 | Replaced memcpy with memmove to avoid nonsense DB_USER values. | DT249848 | |
| GRD-73574 | Fixed an issue with Guardium db2 Exit DLL freeing a pointer twice, when stopping the S-TAP service. | DT244227 | |
| GRD-76256 | Fixed inconsistent raw pointer and shared pointer when failover happens using protocol 7 and PARTICIPATE_IN_LOAD_BALANCING=1. | DT249830 | |
| GRD-76337 | Expanded the scope of the redact functionality to incorporate non-printable Unicode. | DT255187 | |
| GRD-76964 | Fixed excessive display of Event ID 5156 "The Windows Filtering Platform has permitted a connection" in event viewer when enabling success auditing for Windows Filtering Platform connections. | DT256988 | |
| GRD-77451 | Fixed a potential server instability caused by Correlator.sys | DT259486 | |
| GRD-78380 | Fixed an issue where S-TAP service would not start when configured with V8 and IBM Common Inventory Technology (CIT) tool is installed on the server. | DT259582 | |
| GRD-80188 | Restored functionality to GIM parameter WINSTAP_ENABLEGAM such that the GAM service is fully disabled when WINSTAP_ENABLEGAM=0. | DT365798 | |
| GRD-80264 | Removed the deprecated parameter TCP_ALIVE_MESSAGE from guard_tap.ini |
Installers with MD5Sums
| MD5Sum | File Name |
|---|---|
| 1e25a68234d7afeabced843072a20d62 | Windows-STAP-V11.5.0.338.zip |
| 0409e4da5b4b057227ab3b486a248276 | conf.reload.WINSTAP |
| b0b8c747d1441b2fcc76eb9ee1c4ffc7 | guard-WINSTAP-11.5_r110500338_1-x86_x64.gim |
| 5b06f6a64d76951c4373d09efaa8f0e2 | guard-WINSTAP-guardium_11.5_r110500338_1-Windows-Server-Windows-x86_x64.exe.signed |
[{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSMPHH","label":"IBM Security Guardium"},"ARM Category":[{"code":"a8m3p000000PCTuAAO","label":"Platform\/Installation\/Deployment"}],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]
Was this topic helpful?
Document Information
Modified date:
27 August 2024
UID
ibm17148487