PingDataGovernance Server 8.2.0.0 - December 2020 - PingDataGovernance - 8.2

Updated support for logging access and error log messages to a syslog server. While the server previously supported logging these messages to a syslog server (through the "syslog-based access log publisher" and "syslog-based error log publisher" logger implementations), these loggers used an older version of the syslog protocol (described in RFC 3164) and only offered support for communicating over UDP.

These loggers are still available for legacy backward compatibility, but we now also offer new "syslog text access log publisher" and "syslog text error log publisher" implementations that use a newer version of the syslog protocol (syslog version 1, described in RFC 5424) and support communicating over UDP or the more reliable TCP. When using TCP, it is also possible to encrypt communication with TLS, and it is possible to configure multiple servers for better redundancy. These loggers use the same space-delimited text format as the former loggers.

We also offer new "syslog JSON access log publisher" and "syslog JSON error log publisher" implementations that offer the same set of capabilities, but that format the message text as JSON objects, which can be more easily parsed by third-party software.

Added a config/sample-dsconfig-batch-files directory with set of well-commented dsconfig batch files to help you understand enabling or configuring a variety of features in the server.

Replaced the ldappasswordmodify tool with a new version that offers more functionality, including support for additional controls, support for multiple password change methods (the password modify extended operation, a regular LDAP modify operation, or an Active Directory-specific modify operation), and the ability to generate the new password on the client.

Updated setup to provide a --populateToolPropertiesFile argument that allows it to populate the config/tools.properties file with default values for command-line tool arguments. If requested, properties are provided for the server address, port, and communication security, and might also include a default bind DN and optionally a bind password. When running setup interactively, it now prompts to determine which properties (if any) should be populated in the properties file.

Updated the crypto manager to make it possible to augment the set of enabled TLS cipher suites with specific suites to add to or remove from the default set of enabled suites. To enable one or more suites in addition to those in the default set, prefix the names of those suites with the "+" symbol. To disable one or more suites in the default set of enabled suites, prefix the names of those suites with the "-" symbol. This was already possible when configuring cipher suites for the LDAP and HTTP connection handlers, but it was not an option for the crypto manager.

The SCIM 2 service now automatically generates a Swagger 2 specification document based on the server's SCIM 2 configuration. View this documentation by visiting the URL https://<your-server>/api-docs in a web browser.

Updated the System Information monitor with an isDocker attribute to identify if the server is running in a Docker container.

Updated setup to create a second encryption settings definition if data encryption is enabled. The tool continues to create a definition for 128-bit AES encryption for use as the preferred definition to preserve backward compatibility with existing servers in the topology, but it now also generates a definition for 256-bit AES encryption. The 256-bit AES definition might become the preferred definition in a future release, but you can use it now by first ensuring that any existing instances are updated to contain the new definition (with the encryption-settings export and encryption-settings import commands) and then making it the preferred definition (with encryption-settings set-preferred) in all instances.

The PingDataGovernance Policy Administration GUI start-server and stop-server tools are now more consistent with other Ping Identity products. In addition, users can now pass the --restart command-line option to stop-server to restart the server.

Updated the JVM memory usage monitor provider to fix an issue that could prevent the monitor from reporting the total amount of memory held by all memory consumers. Also, fixed an issue that could cause the memory-consumer attribute to use an incomplete message for consumers without a defined maximum size and added an additional memory-consumer-json attribute whose values are JSON objects with data that can be more easily extracted by automated processes.

Fixed an issue in which mapping a path parameter in inbound-base-path to a query parameter in outbound-base-path would cause the Gateway to encode the query delimiter ('?').

PingDataGovernance Server now validates path parameters used in Gateway API Endpoints and Sideband API Endpoints more strictly. The configuration properties service, resource-path, and policy-request-attribute now cannot refer to path parameters unless they are defined by the inbound-base-path property (for Gateway API Endpoints) or the base-path property (for Sideband API Endpoints). In addition, the inbound-base-path and base-path properties now cannot be defined with duplicate path parameters. For example, an inbound-base-path property such as /Posts/{id}/Comments/{id} is not allowed.

Updated the collect-support-data tool so that you can specify how much data to capture from the beginning and end of each log file to include in the support data archive. You can also specify the capture size when invoking the tool through an administrative task, recurring task, or extended operation.

Fixed an issue where some state associated with a JMX connection was not freed after the connection was closed. This led to a slow memory leak in servers that were monitored by an application that created a new JMX connection each polling interval.

Fixed an issue in which PingDataGovernance formatted the following policy request attributes using a date/time format that the policy engine could not parse: HttpRequest.AccessToken.expiration, HttpRequest.AccessToken.issued_at, and HttpRequest.AccessToken.not_before. To support these changes, update the data type of the above fields in your Trust Framework to "Zoned Date Time" using the 8.1.0.0-to-8.2.0.0.SNAPSHOT file from the /resource/policies/upgrade-snapshots directory. For detailed upgrade instructions, see Upgrading PingDataGovernance.

Eliminated a misleading error message that could be logged at startup if the server was configured with one or more ACIs that only apply when using specific SASL mechanisms.

PingDataGovernance Server now provides more information about the current policy request to custom advice implementations written using the Server SDK. The additional information includes the service name, the token owner, and the access token claims.

Fixed an issue where disabling certain backends (such as 'alarms') caused an internal monitor to log unnecessary error messages every few seconds, about not being able to gather data from that backend.

Note that deliberately disabling the 'alarms' backend is not recommended in normal operation, but might occur during backup/restore operations.

Users can now start the PingDataGovernance Policy Administration GUI in the foreground by passing the --nodetach command-line option to the start-server script.

PingDataGovernance can now perform SCIM 2 paged searches on result sets greater than the configured lookthrough limit. This feature is only available when using an LDAP Store Adapter and requires configuring a VLV index on the backend PingDirectory Server first. For more information, see Using paged SCIM searches.

Fixed an issue with the manage-profile tool where files in a server profile's dsconfig/ directory without a .dsconfig extension could cause failures in manage-profile replace-profile when validating updated dsconfig files.

Fixed an issue that could result in duplicate column headers being produced by the Periodic Stats Logger, even when the header-prefix-per-column attribute was set to true.

Updated the Stats Collector Plugin with a new generate-collector-files configuration property.

When using the plugin exclusively for providing metrics to one or more StatsD Monitoring Endpoints, set this property to false to prevent unnecessary I/O.

You can use the --rejectInsecureRequests and --rejectUnauthenticatedRequests arguments with manage-profile by including them in the setup-arguments.txt file of the server profile.

Updated the interactive command-line tool framework to prefer establishing secure LDAP connections over insecure connections. Previously, when prompting for the information needed to establish a connection, the default option was to create an unencrypted LDAP connection. Now, tools will default to creating an SSL-encrypted connection if the server supports it, or to creating a StartTLS-encrypted connection if that is available but SSL is not. Tools will also default to using streamlined settings when establishing secure connections. Previously, they would always prompt about how to determine whether the server's certificate chain should be trusted. When using the streamlined settings, the tools will only prompt about certificates that cannot automatically be considered trusted using information in the JVM's default trust store, the server's default trust store (config/truststore), or the server's topology registry.

Updated the root password policy so that LDAP bind responses for root users and topology administrators are delayed by one second after five consecutive failed authentication attempts.

Updated the "delay bind response" failure lockout action to provide an option to delay the response to bind requests initiated by non-LDAP clients (for example, when using HTTP basic authentication). This option is disabled by default because delaying the bind response for non-LDAP clients might require temporarily blocking the thread used to process the request, which could increase the risk of a denial-of-service attack. To help mitigate this risk, if you enable delayed bind responses for non-LDAP clients, we recommend that you also increase the number of request handler threads for all enabled HTTP connection handlers.

Updated the server's command-line tool framework to make it easier and more convenient to communicate with the server over a secure connection when no trust-related arguments are provided. Most noninteractive tools now check the server's default trust store, the topology registry, and the JVM's default trust store to see if the presented certificate chain can be automatically trusted without the need to prompt the user. If the presented chain cannot be automatically trusted, the user might be interactively prompted to determine whether it should be trusted.

The advice type modify-scim-patch is now available. With this advice type, you can add new operations to the end of a SCIM patch during a SCIM modify request.

Optimized some searches commonly used by the status tool. This should improve the performance of the tool in more complex or large-scale environments.

Fixed an issue where using the encryption-settings tool to import definitions with the set-preferred flag could result in none of the imported definitions being set as the preferred definition.

Updated the server to require a minimum key size of 2048 bits when negotiating a TLS cipher suite that uses ephemeral Diffie-Hellman key exchange.

Replaced the ldapcompare tool with a new version that offers more functionality, including support for multiple compare assertions, following referrals, additional controls, and multiple output formats (including tab-delimited text, CSV, and JSON).

Updated the server to use /dev/urandom (on non-Windows systems where that path exists and is readable) instead of /dev/random as the primary source for secure random data. Attempts to read from /dev/random can block if the underlying system does not have sufficient entropy, which can have a severe adverse effect on performance. Reads from /dev/urandom do not block, and the data that it provides is no less secure than data from /dev/random in any way that matters for the server.

The Policy Administration GUI now uses the MAX_HEAP_SIZE environment variable to set its minimum and maximum heap size. If there is no value available, the Policy Administration GUI uses a default value of 2g.

Fixed an issue where POLICY REQUEST-SKIPPED messages were being logged when response processing was not skipped by the Gateway, rather than when it was skipped.

The Policy Administration GUI command-line tools now produce execution logs in tool-specific log files.

Updated manage-profile replace-profile to set encryption settings definitions defined in the newer server profile as preferred in the encryption settings db.

The PingDataGovernance Policy Administration GUI setup tool now provides the --excludeSensitiveValues command-line option. When you provide sensitive values as environment variables, use this option to exclude those sensitive values from the generated configuration.yml file.

The Policy Administration GUI now adds JAR files placed in the lib/extensions folder to the server runtime classpath, for use during SpEL evaluation.

Previously, when evaluating a policy rule with multiple conditions, the policy engine would evaluate every condition in the group. The policy engine now stops evaluating conditions as soon as the overall result can be deduced. For example, given a group condition of the form "X AND Y", the policy engine will not evaluate Y if X is false.

This change is applicable to both embedded PDP mode and external PDP mode.

You can now configure the Policy Administration GUI to cryptographically sign deployment packages. You can configure PingDataGovernance Server in turn to only accept deployment packages signed by a trusted source. For information about configuring both the Policy Administration GUI and PingDataGovernance Server to use signed deployment packages, see Use signed deployment packages.

Fixed an issue in which the Directory REST API could fail to decode certain credentials when using basic authentication.

Added support for creating or importing a key pair configuration object using an elliptic curve (EC) key algorithm. You can use this to designate the encryption key pair for a JWT access token validator that handles EC-encrypted access tokens.

The JWT Access Token Validator can now validate JWT access tokens signed using the elliptic curve digital signature algorithms ES256, ES384, and ES512.

The JWT Access Token Validator can now validate JWT access tokens encrypted using elliptic curve cryptographic algorithms. The following key encryption algorithms are now supported in addition to RSA-OAEP: ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, and ECDH-ES+A256KW.

To support best practices for JWT security, you must now also configure the JWT Access Token Validator with explicit allow lists for key encryption and content encryption algorithms. For backward compatibility, the key encryption allow list defaults to RSA-OAEP, while the content encryption allow list defaults to A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512. We recommend setting both allow lists to the strict minimum set of algorithms needed by the Access Token Validator.

Updated the manage-profile replace-profile subcommand to better support updating the server's keystore and truststore files. When using the --generateSelfSignedCertificate argument in a server profile's setup-arguments.txt file, the server will maintain the original keystore and truststore files during replace-profile. Otherwise, replace-profile will use the keystore and truststore specified in the profile's setup-arguments.txt file.

Fixed an issue in which a request to /sideband/request with a "body" value of "" (an empty string) would result in a response with a "body" value of "null". Now the Sideband API will always omit null or empty values from responses.

Updated the server to set a unique cluster name when started for the first time.

Updated the online dsconfig step of the manage-profile replace-profile subcommand to support getting LDAP connection arguments from a tools.properties file on the server being updated.

Fixed an issue where boolean LDAP connection arguments like --useSSL and --trustAll would cause manage-profile replace-profile to fail when applying dsconfig online.

The Periodic Stats Logger can now publish performance statistics generated by the Sideband API. To enable this, use the included-http-servlet-stat property of the Periodic Stats Logger.

The Periodic Stats Logger can now publish performance statistics that the SCIM 2 service generates. To enable this, use the included-http-servlet-stat property of the Periodic Stats Logger.

The Periodic Stats Logger can now publish performance statistics that the Gateway service generates. To enable this, use the included-http-servlet-stat property of the Periodic Stats Logger.

Upgraded to Jetty 9.4.30.

Fixed an issue where the dsconfig list subcommand would not display requested properties.

To support best practices for JWT security, you must now configure the JWT Access Token Validator with an explicit list of the JWT signing algorithms that it accepts. For backward compatibility, this list defaults to the RSA signing algorithms RS256, RS384, and RS512, but we recommend setting this list to the strict minimum set of signing algorithms needed by the Access Token Validator.

Added new override-status-code and additional-response-contents attributes to the Availability State HTTP Servlet Extension. These new attributes can be used to customize the response code and JSON response body of the servlet.

The PingDataGovernance Policy Administration GUI now provides the Test Suite capability, allowing policy writers to store and re-run test scenarios.

Fixed a typo in the password-expiring template that caused password_expiration_time_of_day to be printed instead of the password expiration time.

Updated the manage-profile tool logs to include the duration of each step the tool takes. The new --verbose argument can also be used to display timing information in the tool's console output.

Added a JSON-formatted stats logger to the server's default configuration. The stats logger is disabled by default.

Updated noninteractive setup (including manage-profile setup) to allow the password for the initial root user to be provided in pre-encoded form using the PBKDF2, SSHA256, SSHA384, or SSHA512 password storage scheme. This eliminates the need to have access to the clear-text password when setting up the server.

Fixed an issue where PingDataGovernance Server was sometimes unable to automatically restart following an unplanned reboot. This happened if it was configured to run as a Microsoft Windows service and was due to a corrupted server status file.

The Administrative Console configuration settings have been updated to account for the new SSO functionality.

Fixed an issue where the PingDataGovernance Gateway rejected requests with methods such as GET or DELETE if a message body was included. The Gateway now allows these, unless advanced setting strict-http-request-validation is set to true.

For Windows only, there can be a hang on start when global configuration property startup-error-logger-output-location is set to values that contain standard-error. For Windows only, standard-error values are silently mapped to equivalent standard-output values.

Updated the manage-profile generate-profile subcommand to ignore files larger than 100 megabytes when generating a server profile. Fixed an issue where many large files in the server root could cause the tool to run out of memory.

Added the --adminPasswordFile argument to the manage-topology add-server command, to allow specifying the administrator password with a file rather than with the command line.

Fixed an issue where the PingDataGovernance Gateway API used status code 500 Internal Server Error when responding to gateway requests with invalid query syntax. The API now responds with status code 400 Bad Request.

Added support for ID Token Validators, which validate the integrity and content of ID tokens issued by OpenID Connect providers. Use these validators with the OAuth Bearer SASL Mechanism Handler to enable single sign-on (SSO) for the Administrative Console using an OpenID Connect provider such as PingOne. Currently, only PingOne is supported for SSO.

Added three built-in identity mappers that you can use to look up administrative accounts stored in the server configuration: Root DN Users, Topology Admin Users, and All Admin Users.

Updated setup and replace-certificate to improve the way we generate self-signed certificates and certificate signing requests to make them more palatable to clients.

To reduce the frequency with which administrators had to replace self-signed certificates, we previously used a very long lifetime for self-signed certificates generated by setup or replace-certificate. However, some clients (especially web browsers and other HTTP clients) have started more strenuously objecting to certificates to long lifetimes, so we now generate self-signed certificates with a one-year validity period. The inter-server certificate (which is used internally within the server and does not get exposed to normal clients) is still created with a twenty-year lifetime.

Increased the maximum number of RDN components that a DN can have from 50 to 100.

Updated log publisher logic to reduce the amount of CPU that the server consumes when it is idle.

The Policy Administration GUI setup and start-server tools now use the PING_EXTERNAL_BASE_URL environment variable, if it is present, to set the hostname and port of the Policy Administration GUI's OpenID Connect redirect URI. The PING_EXTERNAL_BASE_URL environment variable should contain the server's public hostname and port in the form "hostname:port" or "hostname" (if using the default HTTPS port of 443).

Updated the system information monitor provider to restrict the set of environment variables that can be included. Previously, the monitor entry included information about all defined environment variables, as that information can be useful for diagnostic purposes. However, some deployments might include credentials, secret keys, or other sensitive information in environment variables, and that should not be exposed in the monitor. The server will now only include values from a predefined set of environment variables that are expected to be the most useful for troubleshooting problems, and that are not expected to contain sensitive information.

Updated the jose4j library used for JWT signing and encryption to version 0.7.2.

For use with collections, added repeatable policies and attributes to apply to each item in a collection to provide more fine-grained decision making.

You can test repeatable attributes during policy development.

Added the Current Repetition Value resolver type to allow resolution against each collection value in a collection attribute.

You configure these values in an options file. For an example, see the config/options.yml file.