Release Notes
These release notes summarize the changes in current and previous product updates.
PingFederate enables outbound and inbound solutions for single sign-on (SSO), federated identity management, mobile identity security, API security, social identity integration, and customer identity and access management (CIAM). PingFederate extends employee, customer, and partner identities across domains without passwords, using only standard identity protocols: SAML, WS-Federation, WS-Trust, OAuth, and System for Cross-domain Identity Management (SCIM).
PingFederate 12.0.5 (August 2024)
Relative path symbolic links retrieve wrong file
Security PF-35678
We’ve fixed a defect that caused PingFederate to retrieve the wrong file when using relative paths in symbolic links.
PingFederate 12.0.4 (July 2024)
Refresh token rolls when configured not to roll
Fixed PF-35166
We’ve fixed a defect that caused PingFederate to roll refresh tokens when Refresh Token Rolling Policy is disabled but Refresh Token Rolling Interval has a value.
OAuth client only validates one access token manager when aud
parameter included
Fixed PF-35737
We’ve fixed a defect that caused PingFederate to validate only the first OAuth client access token manager it found when Validate Against All Eligible Access Token Managers was checked, and the aud
parameter was included in the request.
Custom adapter not returning IPv4 addresses
Fixed PF-35783
We’ve fixed a defect where PingFederate failed to return IPv4 addresses in a custom adapter request using the request.getRemoteAddr()
method.
Error message after user session expires
Fixed PF-35815
We’ve fixed a defect that caused PingFederate to present an error message when user tries to sign on again after a session expires due to inactivity.
OIDC admin login failure
Fixed PF-34523
We’ve fixed a defect that caused the OIDC administrative console login to fail when the node.group.id
didn’t match a server’s node id.
OAuth client in-use detection
Fixed PF-35744
We’ve fixed a defect where client in-use detection caused an IndexOutOfBoundsException when a custom solution is used for client storage.
PingFederate 12.0.3 (May 2024)
PingOne admin URL property
New PF-31859
Added support for the Australia region to the pf.pingone.admin.url.region
property.
The Asia region is deprecated. We recommend using the Australia region instead.
Learn more in Configuring PingFederate properties.
Authentication API allows different user for change password flow
Fixed PF-35609
Fixed a defect that caused the authentication API to allow a different user to proceed with the MUST_CHANGE_PASSWORD
function than the user who initiated the flow.
In all cases, the target user’s password was required to complete the change password operation. |
Memory heap increase when using admin API on policy tree
Fixed PF-35423
Fixed a defect that caused PingFederate not to release memory when using the admin API on the policy tree.
Authentication API password change flow ignores credentials
Fixed PF-35618
Fixed a defect that caused the authentication API to ignore credentials for password changes provided after user authentication.
Authentication API validation error
Fixed PF-35430
Fixed a defect that caused a validation error in the authentication API when including the ui_locales
parameter.
PingFederate 12.0.2 (April 2024)
Java thread exhaustion in PingOne Advanced Services
Fixed PF-35411
Fixed a defect that caused repeated looping in authentication policy involving a local Identity profile.
OAuth clients In Use detection
Fixed PF-35407
Fixed a defect with In Use detection when DynamoDB is used for OAuth client storage.
OIDC policy DELETE request timeout
Fixed PF-35357
Fixed a defect where deleting an OIDC policy fails when using DynamoDB storage for a large number of OAuth clients.
Authentication policy extended properties using OGNL
Fixed PF-35111
Fixed a defect where extended properties retrieved by OGNL are not populated.
Policy fragment rules processing
Fixed PF-35134
Fixed a defect that caused PingFederate to not process authentication policy rules for fragment nodes that do not contain an output contract.
Active Directory binary attribute caused thread proliferation
Fixed PF-35142
Fixed a defect that caused LDAP data source connection pools to close when still in use after the LDAP data source is modified and replicating under heavy load.
Mixed maintenance release cluster caused JWKS errors
Fixed PF-35195
Fixed a defect that caused errors in synchronization and accessing dynamic JSON Web Key Set (JWKS) keys when running a cluster that was a mix of PingFederate versions 12.0 and 12.0.1.
JWKS algorithm parameter not populated after processing shared keys from cluster
Fixed PF-35309
Fixed a defect that caused the alg
parameter to fail to populate when EC dynamic keys are rotated on a lead cluster node and shared to the cluster.
PingFederate 12.0.1 (February 2024)
Rest datastore security vulnerability
Security PF-34720
Fixed a JSON injection vulnerability in REST datastores described in security advisory SECADV044.
Runtime nodes security vulnerability
Security PF-34896
Fixed a path traversal vulnerability in Runtime nodes described in security advisory SECADV044.
OpenID Connect policy management editor security vulnerability
Security PF-35081
Fixed a Cross-Site Scripting vulnerability in the OpenID Connect Policy Management Editor described in security advisory SECADV044.
Runtime notification when thread dumps are enabled but log4j2.xml
is not configured
Improved PF-34832
Added a feature to generate a warning message on the Runtime Notifications tab if you have enabled thread dumps, but you have not configured the ThreadDumpAppender
and ThreadDumpLogger
properties in the log4j2.xml
file.
To learn more about configuring thread pool exhaustion events, see Configuring runtime notifications.
Randomly-generated provisioner node ids
Improved PF-30913
Added a feature allowing you to generate random provisioner.node.id
values.
To learn more about configuring provisioners, see Deploying provisioning failover.
Custom KeyID
Improved PF-34883
Added a feature allowing administrators to define custom KeyID values for static OAuth and OIDC keys and token signing keys.
Fixed an defect that caused PingFederate to not publish the alg
parameter on the JWKS endpoint. This issue occurred for dynamically-generated EC signing keys on engine nodes.
To learn more about keys, see Keys for OAuth and OpenID Connect.
GET SAML request signature processing error
Fixed PF-34641
Fixed a defect where SAML requests using HTTP GET method with multiple signature-related parameters encoded in the RelayState parameter were causing errors in processing signature validation.
NPE notification error
Fixed PF-34813
Fixed a defect that caused PingFederate to issue null pointer exception (NPE) errors when querying the token endpoint.
Certificate expiry notification error
Fixed PF-34854
Fixed a defect that caused the certificate expiry warning notification icon to remain when there were no notifications to display.
Reencyption causes connection or client to fail on engine
Fixed PF-34409
Fixed a defect where changes made on the administrative console were not replicated to the engine during reencryption.
JMX registration failure for imported archives
Fixed PF-34796
Fixed a defect that caused the JMX monitoring to fail to register archive files that are imported to PingFederate.
Content type changes if well_known
endpoint response is too large
Fixed PF-34865
Fixed a defect that caused the content-type
of a response from the well_known
endpoint to change from JSON to HTML if a response is too large.
PingFederate displays unlock your account page for unlocked users
Fixed PF-34701
Fixed a defect that caused PingFederate to display an unlock your account page during self-service password reset to accounts that are not locked.
RHEL 8 using OS-level FIPS causes PingFederate failure
Fixed PF-34879
Fixed a defect that caused PingFederate to fail on startup when installed on a Red Hat Enterprise Linux (RHEL) server with OS-levels FIPS enabled.
Error message for authentication policy fragment with invalid localIdentityRef
Fixed PF-34882
Fixed a defect that returned a 500
error with no details when an authentication policy fragment had a LOCAL_IDENTITY_MAPPING
action with an invalid localIdentityRef
ID.
PingFederate 12.0 (December 2023)
New features and improvements in PingFederate 12.0.
New features and enhancements
Support for RP-initiated logout
New PF-34418
OpenID Connect (OIDC) relying party (RP) initiated logout allows OAuth clients to request that the OpenID Provider (OP) perform a federated logout. PingFederate now supports this standard, both when PingFederate acts as the OP as well as when it acts as the RP via an OIDC IdP connection.
For more information, see OAuth Client Management Service, Configuring OpenID Provider information, and OpenID Connect RP-initiated logout endpoint.
Add risk provider to Identifier First Adapter
New PF-34415
You can now add risk provider such as CAPTCHA to Identifier First adapters.
For more information, see Configuring an Identifier First Adapter instance
Skip redirect to authentication application if no action is required
New PF-34413
API-capable IdP adapters can now prevent a redirect to the authentication application if no user interaction is required.
For more information, see Upgrade considerations.
Alert and report when approaching maxThreads
New PF-34437
You can now configure runtime notifications to alert you when the number of threads in use exceeds a set threshold. You can also use this feature to initiate and log a thread dump event.
For more information, see Configuring runtime notifications.
Persist consent decision when revoking refresh_token
New PF-33318
You can now configure your authorization server settings for OAuth and OIDC users so that their decisions to grant access can be persisted after a refresh_token
is revoked.
For more information, see Authorization Consent in Configuring authorization server settings.
Admin console notification of expiring certificates
New PF-34428
PingFederate will now issue a notification in the admin console before a certificate expires. You can configure the duration of the notification before and after expiry in the Runtime Notifications menu.
Deleted certificates are removed from the notifications menu.
For more information, see Configuring runtime notifications.
Selective replication for connections and OAuth clients
New PF-33989
We further improved support for self-service and application on-boarding use cases. OAuth applications and SAML connections can now be replicated to PingFederate engine nodes without affecting any dependencies. This enhancement lets development teams manage their applications without the help of PingFederate administrators. For more information, see Cluster management.
OpenID Connect Front-Channel Logout support
New PF-33986
Continuing the PingFederate tradition of recognizing open identity standards, it now supports the OpenID Connect Front-Channel Logout specification. This feature enables global sign-off user journeys. It’s available in addition to PingFederate’s proprietary front-channel logout protocol. For more information, see Configuring OAuth clients.
Log category to capture details of protocol requests and responses
New PF-33987
For OpenID Connect IDP connections, log files now include more details so that you can analyze and resolve connection problems easier. You can enable this feature just by selecting a check box in the Log Settings. For more information, see Log settings.
Creating short-lived or non-persistent sessions when This is my device isn’t selected
New PF-33982
Now you can configure PingFederate to enable sessions on shared devices. Devices can be configured as private or public (unspecified) and maintain persistent sessions. This feature is available through the HTML Form Adapter. For more information, see Configuring authentication sessions.
The CyberArk Secret Manager can pull different username values from CyberArk
New PF-33985
The integration with the CyberArk Secret Manager now allows access to all values available through the CyberArk interface. This gives you more freedom when building user journeys. For more information, see Configuring instances of the secret manager plugin for the CyberArk Credential Provider.
Password reset email OTL returns users to authentication API applications when using redirectless mode
New PF-33983
When you use OAuth and OpenID Connect flows with response_mode=pi.flow
, users are redirected back to the associated authentication application rather than to PingFederate. This is enables more consistent user journeys. For more information, see Configuring self-service account recovery.
Amazon DynamoDB account linking
New PF-33988
To further support Amazon DynamoDB use cases, now you can also use account linking with this NoSQL database. For more information, see Configuring an Amazon DynamoDB for account-link storage.
Optional input and output contracts for policy fragments
New PF-33332
This feature simplifies the use of PingFederate policies because it no longer requires input or output contracts for certain fragments. This improves the readability, maintainability, and performance of these policies. For more information, see Defining policy fragments.
OpenBanking plugin support for the dpop_bound_access_tokens
parameter
New PF-33631
Enhancing PingFederate’s support for OAuth DPoP, this release includes support for this type of access token. It lets developers learn more about the use and importance of the dpop_bound_access_tokens
parameter. For more information about the parameter, see the PingFederate Open Banking Software Assertion Validator plug-in on GitHub.
Toggle plugin creation/initialization during startup
New PF-34640
In rare cases where plugin creation and initialization significantly slows down PingFederate startup, you can now turn off plugin creation and initialization. Plugins will then only be initialized on first use.
The default startup behavior is recommended for most customers. For more information about this option and the tradeoffs involved in enabling it, open a support case.
PingOne Protect Integration Kit
New PF-34147
The PingOne Protect Integration Kit is now bundled with PingFederate.
PingID Integration Kit
Improved PF-34369
The PingID Integration Kit has been updated to version 2.26.
PingOne MFA Integration Kit
Improved PF-34368
The PingOne MFA Integration Kit has been updated to version 2.2.1.
Java 17 support for Thales Luna Network HSM integration
Improved PF-34168
When integrating with Thales Luna Network hardware security modules (HSMs), you can now use Java 17.
For more information, see Integrating with Thales Luna Network HSM
Improved OGNL expression logging
Improved PF-34050
The administrator audit log file (admin.log
) now logs any OGNL expression tests performed and the expression variables used with an event type of TEST_EXPRESSION
. For more information, see Administrator audit logging.
Improved CSD
Improved PF-33095
The Collect Support Data (CSD) script has been improved to capture more details.
Authenticating to Azure SQL Managed Instance through Azure Active Directory
Improved PF-33621
Now PingFederate supports authentication to Azure SQL Managed Instance through Azure Active Directory without a username and password. For more information, see Configuring a JDBC connection.
Upgraded BCFIPS library
Improved PF-32747
Upgraded the BCFIPS library to 1.0.2.4, which now supports enabling BCFIPS mode with Java 17.
For more information, see Bouncy Castle FIPS provider and Integrating Bouncy Castle FIPS providers.
Resolved issues
Improved client authentication security
Security PF-34645
Fixed a potential security vulnerability described in SECADV040.
Resolved a vulnerability in the Initial Setup Wizard
Security PF-34646
Fixed a Server-Side Request Forgery vulnerability in the Initial Setup Wizard described in security advisory SECADV041.
Prevent JGroups thread pool exhaustion in large clusters
Fixed PF-34718
For fresh installs, we changed the default value of pf.cluster.TCPPING.return_entire_cache
in jgroups.properties
from true
to false
.
This prevents an issue where remote procedure calls (RPCs) can be dropped in large clusters that use TCPPING.
For more information, see Upgrade considerations.
Swagger response for oauth/accessTokenMappings
Fixed PF-34500
Fixed an issue with the administrative API doc on the /oauth/accessTokenMappings
endpoint not matching the actual endpoint response.
[.codeph]``multi-value
contains DN`` in policy rule check no longer case-sensitive [.ping_changetype-fixed]#Fixed# [.ping_ticket]#PF-33560#
Policy Rules conditions that use multi-value contains
DN
now ignore case while comparing the DN value.
Log messages about illegal characters in API calls
Fixed PF-33305
Now log messages about illegal characters in API calls are logged at the DEBUG level rather than the WARN level.
Support for none
as a valid token endpoint value
Fixed PF-34115
Added the value none
to /.well-known/openid-configuration/token_endpoint_auth_methods_supported
The id_token_jti
property in token endpoint responses
Fixed PF-34210
The id_token_jti
property is no longer included in token endpoint responses.
Administrative API defect when fragment rules have Default to Success disabled
Fixed PF-34216
Fixed an administrative API defect when a fragment rule had Default to Success disabled
Fixed /idp/startSLO.ping
404
caused by virtual issuer configuration
Fixed PF-34322
Fixed an issue that was returning a 404
error if the /idp/startSLO.ping
endpoint was hit while a virtual issuer was configured. You can now configure virtual issuers with a context path.
Client JWKS now sets properly when using DynamoDB storage
Fixed PF-34504
Clients that maintain a JWKS endpoint can now use private key JWT based authentication when requesting an access token.
Fixed NPE when checking an existing persistent grant that is expired with DynamoDB
Fixed PF-34606
Checking for existing but expired grants with DynamoDB no longer causes a null pointer exception error (NPE).
Connections close after getting a 401
or 403
from PingOne API
Fixed PF-34545
Fixed an issue preventing PingFederate from closing connections after receiving a 401
or 403
response from PingOne MFA.
PingFederate systematically adds server-side sort control
Fixed PF-33466
You can now turn off server-side sorting via a configuration option.
Unable to copy and paste policy contract in specific situations
Fixed PF-34433
You can now copy and paste a policy contract below a selector node.
XML decryption failing with KeyName
element
Fixed PF-34536
Fixed an issue where decryption of an encrypted SAML element could fail if a KeyName
was specified.
One-time link in password-reset email messages
Fixed PF-33983
When using redirectless mode, now the one-time link (OTL) in password-reset email messages returns users to the authentication API application configured for the policy, rather than to PingFederate.
Incorrect error template when using service provider authentication policies
Fixed PF-34111
When a service provider (SP) authentication policy fails, PingFederate now renders the sp.sso.error.page.template.html
page instead of the idp.sso.error.page.template.html
page.
Updating OAuth clients with dynamic client registration
Fixed PF-34146
Fixed a defect where an OAuth client created with dynamic client registration (DCR) couldn’t be updated with DCR after it was modified with the administrative console.
Idle JDBC datastore connections
Fixed PF-34163
Now PingFederate closes idle JDBC datastore connections until the minimum pool size is reached instead of closing and recreating all of them.
The id_token_jti
property in token endpoint responses
Fixed PF-34210
The id_token_jti
property is no longer included in token endpoint responses.
Administrative API defect when fragment rules have Default to Success disabled
Fixed PF-34216
Fixed an administrative API defect when a fragment rule had Default to Success disabled
Email notifications for licensing events even when disabled
Fixed PF-34225
Resolved an issue that caused PingFederate to send email notifications for licensing events even though they were disabled in the Runtime Notifications configuration.
Jetty library upgrade
Fixed PF-31865
We upgraded the Jetty library, resolving CVE-2022-2047 and CVE-2022-2048.
OAuth scope names
Fixed PF-33056
Using submit
and onSubmit
as OAuth scope names in the administrative UI drop-down no longer causes front-end JavaScript errors.
Policy fragment validation error
Fixed PF-33156
Policy fragments with valid authentication sources no longer fail with an Invalid Configuration error during runtime.
Eliminating redundant group updates
Fixed PF-33441
PingFederate, when configured with PingDirectory as an outbound provisioning data source, no longer sends redundant group updates in each provisioning cycle when the entry remains unchanged.
Potential security vulnerability
Fixed PF-33449
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
PingFederate as a Windows service
Fixed PF-33450
We fixed an issue so that PingFederate as a Windows service now runs on Java 17. When updating to the latest maintenance release using an in-place update method (for example, from 11.3.0 to 11.3.x), in addition to the steps in Updating to the latest maintenance release, you must remove the existing PingFederate Windows service. After removal, re-install the PingFederate Windows Service to apply this fix.
Authentication policy fail path
Fixed PF-33519
When an OIDC identity provider (IdP) connection fails in an authentication policy, PingFederate now continues on to the fail path of the authentication policy.
Fragment mapping validation error
Fixed PF-33722
We resolved an issue that incorrectly produced an administrative API validation error when the fragment mapping references context.RequestedUser
as the mapping source.
Authorization details within a RAR
Fixed PF-33863
PingFederate now processes authorization details within a rich authorization request (RAR) as a JSON Array in a JWT request. Additionally, PingFederate no longer supports authorization details sent as stringified JSON arrays.
Cluster engine nodes starting without replication data
Fixed PF-33881
Resolved a replication issue that, in rare cases, caused an engine node in a cluster to start without replication data from other nodes.
Server error when revoking user sessions
Fixed PF-33920
Resolved an issue that prevented user sessions from being revoked through the session management API when using persistent sessions.
Potential security vulnerability
Fixed PF-33935
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
Fragment mapping validation errors
Fixed PF-33957
When utilizing the PingFederate administrative API to create or update a fragment that includes another fragment, the API will no longer produce a validation error when fragment mapping involves an input source type.
Updated template variable
Fixed PF-34016
The message-template-end-user-password-change.html
template now contains the USERNAME variable.
Potential security vulnerability
Fixed PF-34017
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
Policy evaluation issue
Fixed PF-34051
We fixed a policy evaluation issue that occurred when ui_locales
was present in an authentication request.
Certificate import improvements
Fixed PF-34074
We updated the administrative UI to include certification serial number in the drop-down, thus preventing import errors for certifications sharing the same Subject DN and expiration date combination.
Known issues and limitations
PingID password credential validator with integrated RADIUS server
Issue
PingFederate versions 11.1.4, 11.1.5, 11.2.1, and 11.2.2 contain version 3.0.2 of the PingID password credential validator (PCV). That version of the PCV has known issues that you should review before upgrading. For more information, see Known issues in PingID RADIUS PCV 3.0.2.
Administrative console and administrative API
Issue
-
Although PingFederate 11.3 and later support DPoP, a known limitation is that the following features don’t support DPoP when PingFederate is the RP:
-
The administrative console authentication scheme using OIDC
-
The administrative API authentication scheme using OAuth 2.0
-
-
/bulk: Only resource types currently supported by the administrative API are included in the exported data. We don’t intend to introduce administrative API support to the following areas:
-
Previously, the administrative API did not accurately reflect a Persistent Grant Max Lifetime setting of 29 days (or shorter) with the selection of the Grants Do Not Timeout Due To Inactivity option. As a result, if you have configured such OAuth authorization server settings and have generated a bulk export in version 10.0 through 10.0.2, we recommend that you re-generate a new bulk export after upgrading to version 10.0.3 (or a more recent version). The newly exported data does not contain the aforementioned flaw, and you can safely import it to version 10.0.3 (or a more recent version).
-
When enabling mTLS certificate-based authentication, administrators often configure a list of acceptable client certificate issuers. When you use a browser to access the console or the administrative API documentation, PingFederate returns to the browser the list of acceptable issuers as part of the TLS handshake. If the browser’s client certificate store contains multiple client certificates, the browser often presents you only the certificates whose issuer matches one of the acceptable issuers. However, when PingFederate runs in a Java 11 environment, Chrome presents you all its configured client certificates, regardless of whether the issuer matches one of the acceptable issuers or not.
-
When using mTLS authentication to authenticate to an LDAP server for administrative console or administrative API access, PingFederate doesn’t support using a Microsoft Active Directory server.
-
Prior to toggling the status of a connection with the administrative API, you must ensure that any expired certificates or no longer available attributes are replaced with valid certificates or attributes; otherwise, the update request fails.
-
When creating or updating a child instance of a hierarchical plugin, the administrative API retains objects with an
"inherited": false
name/value pair (or without such name/value pair altogether), ignores those with a value oftrue
, and returns a 200 HTTP status code. No error messages are returned for the ignored objects. -
Using the browser’s navigation mechanisms (for example, the Back button) causes inconsistent behavior in the administrative console. Use the navigation buttons provided at the bottom of windows in the PingFederate console.
-
Using the PingFederate console in multiple tabs on one browser might cause inconsistent behavior which could corrupt its configuration.
-
If authenticated to the PingFederate administrative console using certificate authentication, a session that has timed out might not appear to behave as expected. Normally (when using password authentication), when a session has timed out and a user attempts some action in the console, the browser is redirected to the sign-on page, and then back to the administrative console after authentication is complete. Similar behavior applies for certificate authentication, in principle. However, because the browser might automatically resubmit the certificate for authentication, the browser might redirect to the administrative console and not the sign on page.
PingOne MFA CIBA Authenticator
Issue PingOne MFA
PingFederate 11.3 is not compatible with the PingOne MFA CIBA Authenticator bundled in PingOne MFA Integration Kit version 2.1 and earlier. This issue was resolved in version 2.2 of that integration kit.
TLSv1.3
Issue
For Java versions that don’t support TLSv1.3 (meaning versions earlier than 8u261), PingFederate fails on start up with a NoSuchAlgorithmException
exception. To resolve this error, remove TLSv1.3
from the following settings in the run.properties
file:
-
pf.tls.client.protocols
-
pf.tls.runtime.server.protocols
-
pf.tls.admin.server.protocols
TLS cipher suite customization
Issue
PingFederate’s TLS cipher suites can be customized by modifying com.pingidentity.crypto.SunJCEManager.xml
(or a similarly-named file if BCFIPS or an HSM is configured). After updating the file and replicating, all cluster nodes must be restarted for the change to take effect.
Java
Issue
-
CloudHSM is not supported when using Java 17.
-
Updating Java version 8 to version 11 results in an error when PingFederate is already installed and running on Windows. To work around this issue, uninstall and reinstall the PingFederate Windows service by running the
UninstallPingFederateService.bat
andInstallPingFederateService.bat
files located in<pf_install>/pingfederate/sbin/wrapper
.
HSMs
Issue
AWS CloudHSM
-
It is not possible to use an elliptic curve (EC) certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
Thales HSMs
-
JWT token decryption using ECDH-ES may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored on the HSM, and PingFederate is consuming a token encrypted with this key.
-
It is not possible to use an EC certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
Entrust HSMs
-
JWT token decryption using ECDH-ES may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored on the HSM, and PingFederate is consuming a token encrypted with this key.
-
It is not possible to import a PKCS12- or PEM-formatted EC certificate.
-
It is not possible to use an EC certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
SSO and SLO
Issue
-
When consuming SAML metadata, PingFederate does not report an error when neither the
validUntil
nor thecacheDuration
attribute is included in the metadata. Note that PingFederate does reject expired SAML metadata as indicated by thevalidUntil
attribute value, if it is provided. -
The anchored-certificate trust model cannot be used with the Single log off (SLO) redirect binding because the certificate cannot be included with the logout request.
-
If an IdP connection is configured for multiple virtual server IDs, PingFederate will always use the default virtual server ID for IdP Discovery during an SP-initiated SSO event.
Composite Adapter configuration
Issue
SLO is not supported when users are authenticated through a Composite Adapter instance that contains another instance of the Composite Adapter.
Self-service password reset
Issue
Passwords can be reset for Microsoft Active Directory user accounts without the permission to change password.
Session revocation API
Issue PPQ-33519
POST requests to the Session Revocation API do not support the Private Key JWT authentication type.
OAuth
Issue
PingFederate does not support a case-sensitive naming convention for OAuth client ID values when client records are stored in a directory server. For example, after creating a client with an ID value of sampleClient
, PingFederate does not allow the creation of another client with an ID value of SampleClient
.
Although it’s possible to create clients using the same ID values with different casings when client records are stored in XML files, a database server, or custom storage, we recommend not doing so to avoid potential record migration issues.
Customer identity and access management
Issue
Some browsers display a date-picker user interface for fields that have been designed for date-specific inputs. Some browsers do not. If one or more date-specific fields are defined on the registration page or the profile management page (or both), end users must enter the dates manually if their browsers do not display a date-picker user interface for those fields.
Provisioning
Issue
-
LDAP referrals return an error and cause provisioning to fail if the
user
orgroup
objects are defined at the DC level, and not within an OU or within the Users CN. -
The
totalResults
value in SCIM responses indicates the number of results returned in the current response, not the total number of estimated results on the LDAP server.
Logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
Database logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
RADIUS NAS-IP-Address
Issue
The RADIUS NAS-IP-Address is only included in Access-Request packets when the pf.bind.engine.address
is set with an IPv4 address. IPv6 is not supported.
Amazon SNS Notification Publisher
Issue
When deploying PingFederate with a forward proxy, plugins based on the AWS SDK, such as the Amazon SNS Notification Publisher, will only honor the http.proxyHost
, http.proxyPort
, http.proxyUser
, and http.proxyPassword
properties in run.properties
. The plugin will rely on these properties even if the service URL is https
.
Deprecated features
SAML IdP Discovery and SAML SP Affiliations
Info
As of PingFederate 12.0, these features have been deprecated, and will be removed in a future release.
Text Message SSPR
Info
Starting with PingFederate 12.0, self-service password reset (SSPR) has been removed.
Upgrade from PingFederate 6.x and 7.x
Info
Starting with version 12.0, PingFederate no longer supports upgrading from PingFederate version 6.x and 7.x.
PingOne Fraud integration kit
Info PingOne Fraud
The PingOne Fraud integration kit is no longer bundled with PingFederate.
Microsoft Internet Explorer 11
Info
Ping Identity commits to deliver the best experience for administrators and users. As we continue to improve our products, we encourage you to migrate off of Microsoft Internet Explorer 11. Starting with PingFederate 11.0, Internet Explorer 11 is no longer included in the PingFederate qualification process for administrators or users. For a list of supported browsers, see System requirements.
Configcopy tool, Connection Management Service, SSO Directory Service
Info
As of PingFederate 10.2, these features have been deprecated and will be removed in a future release.
Oracle Directory Server Enterprise Edition
Info
As Oracle ended its Premier Support for Oracle Directory Server Enterprise Edition (ODSEE 11g) in December 2019, we no longer include ODSEE as part of the PingFederate qualification process (starting with PingFederate 10.2). We continue to qualify against Oracle Unified Directory (www.oracle.com/middleware/technologies/unified-directory.html) and other supported directory servers. For a full list, see System requirements.
SNMP
Info
Starting with PingFederate 10.2, monitoring and reporting through the SNMP has been removed.
Roles and protocols
Info
Starting with PingFederate 10.1, roles and protocols are always enabled and no longer configurable through the administrative console and API.
PingFederate 11.3.8 (July 2024)
OIDC admin login failure
Fixed PF-34523
We’ve fixed a defect that caused the OIDC administrative console login to fail when the node.group.id
didn’t match a server’s node id.
OGNL Extended Property
retrieval failure
Fixed PF-35111
We’ve fixed a defect that caused OGNL to fail to obtain the Extended Property
value in authorization policies or fragments.
Refresh token rolls when configured not to roll
Fixed PF-35166
We’ve fixed a defect that caused PingFederate to roll refresh tokens when Refresh Token Rolling Policy is disabled but Refresh Token Rolling Interval has a value.
OAuth client only validates one access token manager when aud
parameter included
Fixed PF-35737
We’ve fixed a defect that caused PingFederate to validate only the first OAuth client access token manager it found when Validate Against All Eligible Access Token Managers was checked, and the aud
parameter was included in the request.
PingFederate 11.3.7 (May 2024)
PingOne admin URL property
New PF-31859
Added support for the Australia region to the pf.pingone.admin.url.region
property.
The Asia region is deprecated. We recommend using the Australia region instead.
To learn more, see Configuring PingFederate properties.
Authentication API allows different user for change password flow
Fixed PF-35609
Fixed a defect that caused the authentication API to allow a different user to proceed with the MUST_CHANGE_PASSWORD
function than the user who initiated the flow.
Note that in all cases, the target user’s password was required to complete the change password operation.
Memory heap increase when using admin API on policy tree
Fixed PF-35423
Fixed a defect that caused PingFederate not to release memory when using the admin API on the policy tree.
Authentication API password change flow ignores credentials
Fixed PF-35618
Fixed a defect that caused the authentication API to ignore credentials for password changes provided after user authentication.
PingFederate 11.3.6 (April 2024)
Java thread exhaustion in PingOne Advanced Services
Fixed PF-35411
Fixed a defect that caused repeated looping in authentication policy involving a local Identity profile.
OAuth clients in use detection
Fixed PF-35407
Fixed a defect with In Use detection when DynamoDB is used for OAuth client storage.
OIDC policy DELETE request timeout
Fixed PF-35357
Fixed a defect where deleting an OIDC Policy fails when using DynamoDB storage for a large number of OAuth clients.
Active Directory binary attribute caused thread proliferation
Fixed PF-35142
Fixed a defect that caused LDAP data source connection pools to close when still in use after the LDAP data source is modified and replicating under heavy load.
PingFederate 11.3.5 (February 2024)
Rest datastore security vulnerability
Security PF-34720
Fixed a JSON injection vulnerability in REST datastores described in security advisory SECADV044.
Runtime nodes security vulnerability
Security PF-34896
Fixed a path traversal vulnerability in Runtime nodes described in security advisory SECADV044.
OpenID Connect policy management editor security vulnerability
Security PF-35081
Fixed a Cross-Site Scripting vulnerability in the OpenID Connect Policy Management Editor described in security advisory SECADV044.
GET SAML request signature processing error
Fixed PF-34641
Fixed a defect where SAML request using HTTP GET method with multiple signature-related parameters encoded in the RelayState parameter were causing errors in processing signature validation.
NPE notification error
Fixed PF-34813
Fixed a defect that caused PingFederate to issue null pointer exception (NPE) errors when querying the token endpoint.
Reencyption causes connection or client to fail on engine
Fixed PF-34409
Fixed a defect where changes made on the administrative console were not replicated to the engine during reencryption.
JMX registration failure for imported archives
Fixed PF-34796
Fixed a defect that caused the JMX monitoring to fail to register archive files that are imported to PingFederate.
Content type changes if well_known
endpoint response is too large
Fixed PF-34865
Fixed a defect that caused the content-type
of a response from the well_known
endpoint to change from JSON to HTML if a response is too large.
RHEL 8 using OS-level FIPS causes PingFederate failure
Fixed PF-34879
Fixed a defect that caused PingFederate to fail on startup when installed on a Red Hat Enterprise Linux (RHEL) server with OS-levels FIPS enabled.
PingFederate 11.3.3 (November 2023)
Enhancements and resolved issues in PingFederate 11.3.3.
Improved client authentication security
Security PF-34645
Fixed a potential security vulnerability described in security advisory SECADV040.
Added support for partitioned cookies
New PF-34440
PingFederate now supports using the Partitioned
attribute to address third-party cookie issues with the iframe-based login widgets in Google Chrome.
Fixed /idp/startSLO.ping
404
caused by virtual issuer configuration
Fixed PF-34322
Fixed an issue that was returning a 404
error if the /idp/startSLO.ping
endpoint was hit while a virtual issuer was configured. You can now configure virtual issuers with a context path.
Client JWKS now sets properly when using DynamoDB storage
Fixed PF-34504
Clients that maintain a JWKS endpoint can now use private key JWT based authentication when requesting an access token.
Fixed NPE when checking an existing persistent grant that is expired with DynamoDB
Fixed PF-34606
Checking for existing but expired grants with DynamoDB no longer causes a null pointer exception error (NPE).
Connections close after getting a 401
or 403
from PingOne API
Fixed PF-34545
Fixed an issue preventing PingFederate from closing connections after receiving a 401
or 403
response from PingOne MFA.
Outbound provisioning performance improvement
Fixed PF-33466
You can now turn off server-side sorting for LDAP requests related to outbound provisioning, which can improve performance in some environments.
Configure this option using the ProvisionWithServerSort
parameter in the com.pingidentity.common.util.ldap.LDAPUtil.xml
file.
Unable to copy and paste policy contract in specific situations
Fixed PF-34433
You can now copy and paste a policy contract below a selector node.
XML decryption failing with KeyName
element
Fixed PF-34536
Fixed an issue where decryption of an encrypted SAML element could fail if a KeyName
was specified.
Resolved a vulnerability in the Initial Setup Wizard
Security PF-34646
Fixed a Server-Side Request Forgery vulnerability in the Initial Setup Wizard described in security advisory SECADV041.
PingFederate 11.3.2 (September 2023)
Authenticating to Azure SQL Managed Instance through Azure Active Directory
Improved
Now PingFederate supports authentication to Azure SQL Managed Instance through Azure Active Directory without a username and password. For more information, see Configuring a JDBC connection.
One-time link in password-reset email messages
Fixed PF-33983
When using redirectless mode, now the one-time link (OTL) in password-reset email messages returns users to the authentication API application configured for the policy, rather than to PingFederate.
Incorrect error template when using service provider authentication policies
Fixed PF-34111
When a service provider (SP) authentication policy fails, PingFederate now renders the sp.sso.error.page.template.html
page instead of the idp.sso.error.page.template.html
page.
Updating OAuth clients with dynamic client registration
Fixed PF-34146
Fixed a defect where an OAuth client created with dynamic client registration (DCR) couldn’t be updated with DCR after it was modified with the administrative console.
Idle JDBC datastore connections
Fixed PF-34163
Now PingFederate closes idle JDBC datastore connections until the minimum pool size is reached instead of closing and recreating all of them.
The id_token_jti
property in token endpoint responses
Fixed PF-34210
The id_token_jti
property is no longer included in token endpoint responses.
PingFederate 11.3.1 (August 2023)
Configuration retrieval on engine start up
Improved PF-33667
We introduced new settings in the cluster-config-replication.conf
file to improve configuration retrieval reliability during engine startup. By setting publish.replication.data.on.startup to true
, the administrative console automatically publishes the last replicated configuration upon startup, eliminating the need to initiate replication through the administrative UI or API after a console restart. Additionally, you can configure engines to fail startup if they cannot retrieve configuration data by setting require.replication.data.on.startup to true
. This setting proves beneficial in DevOps deployments, where fresh engine nodes are frequently created without any initial configuration. For more information, see the publish.replication.data.on.startup and require.replication.data.on.startup property descriptions in Cluster management.
Jetty library upgrade
Fixed PF-31865
We upgraded the Jetty library, resolving CVE-2022-2047 and CVE-2022-2048.
OAuth scope names
Fixed PF-33056
Using submit
and onSubmit
as OAuth scope names in the administrative UI drop-down no longer causes front-end JavaScript errors.
Policy fragment validation error
Fixed PF-33156
Policy fragments with valid authentication sources no longer fail with an Invalid Configuration error during runtime.
Eliminating redundant group updates
Fixed PF-33441
PingFederate, when configured with PingDirectory as an outbound provisioning data source, no longer sends redundant group updates in each provisioning cycle when the entry remains unchanged.
Potential security vulnerability
Fixed PF-33449
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
PingFederate as a Windows service
Fixed PF-33450
We fixed an issue so that PingFederate as a Windows service now runs on Java 17. When updating to the latest maintenance release using an in-place update method (for example, from 11.3.0 to 11.3.x), in addition to the steps in Updating to the latest maintenance release, you must remove the existing PingFederate Windows service. After removal, re-install the PingFederate Windows Service to apply this fix.
Authentication policy fail path
Fixed PF-33519
When an OIDC identity provider (IdP) connection fails in an authentication policy, PingFederate now continues on to the fail path of the authentication policy.
Fragment mapping validation error
Fixed PF-33722
We resolved an issue that incorrectly produced an administrative API validation error when the fragment mapping references context.RequestedUser
as the mapping source.
Authorization details within a RAR
Fixed PF-33863
PingFederate now processes authorization details within a rich authorization request (RAR) as a JSON Array in a JWT request. Additionally, PingFederate no longer supports authorization details sent as stringified JSON arrays.
Cluster engine nodes starting without replication data
Fixed PF-33881
Resolved a replication issue that, in rare cases, caused an engine node in a cluster to start without replication data from other nodes.
Server error when revoking user sessions
Fixed PF-33920
Resolved an issue that prevented user sessions from being revoked through the session management API when using persistent sessions.
Potential security vulnerability
Fixed PF-33935
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
Fragment mapping validation errors
Fixed PF-33957
When utilizing the PingFederate administrative API to create or update a fragment that includes another fragment, the API will no longer produce a validation error when fragment mapping involves an input source type.
Updated template variable
Fixed PF-34016
The message-template-end-user-password-change.html
template now contains the USERNAME variable.
Potential security vulnerability
Fixed PF-34017
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
Policy evaluation issue
Fixed PF-34051
We fixed a policy evaluation issue that occurred when ui_locales
was present in an authentication request.
PingFederate 11.3 (June 2023)
New features and improvements in PingFederate 11.3.
Support for nbf
and iat
claims in JWT access token managers
New
Now you can configure access token managers to include the JSON web token (JWT) access_token
claims nbf
(not before) and iat
(issued at). This enables stronger validations by receiving clients or protected resources that process that access_token. For more information, go to Configuring an access token management instance, and in the JSON web token data model section click the JSON token management tab.
Retries for client-side LDAP errors
New
To further improve reliability and robustness, now PingFederate executes retries rather than failover only. PingFederate initiates a single retry if a request fails and it appears the connection has become invalid. For more information, see the Retry Failed Operations field in Setting advanced LDAP options.
Referencing incoming PAR parameters in authentication policies
New
For authorization requests, parameters can now be referenced for incoming PAR requests (pushed authorization requests) inside authentication policies. This lets PingFederate process incoming requests independently of how it received them. For more information, see Pushed authorization requests endpoint.
Unique identifiers for PingFederate transactions
New
To improve logging, PingFederate now uses a transactionId
. For each transaction, this value won’t change between the initial request and the final response. This is especially useful for troubleshooting. For more information, see the transactionid
field in Security audit logging.
All user attributes available to HTML and mail templates
New
Now you can configure HTML and mail templates with user details. With these details, you can personalize user facing pages and include messages, such as greetings by name, or email addresses that were used for a password recovery flow. The attributes are documented in the templates.
Logging certificate expiration advance warnings
New
Previously, PingFederate produced notifications to inform administrators about expiring certificates. Now you can configure PingFederate to log upcoming expirations without producing notifications. For more information, see Configuring runtime notifications.
Improved European Union compliance with SAML 2.0
New
Two major SAML 2.0 messaging improvements align PingFederate closer to EU regulations:
-
Now PingFederate can decrypt
EncryptedID
elements included as SAML attributes. They no longer must be enclosed as anEncryptedAttribute
. For more information, see Specifying XML encryption policy (for SAML 2.0). -
To enhance signing capabilities, PingFederate now also supports some of the RSASSA-PSS algorithms. For more information, see Signing algorithms.
Support for credential-protected forward proxy servers
New
Because proxy servers can require credentials for authentication purposes, now you can configure PingFederate with proxy server credentials so that connections can be easily established and secured. For more information, see Configuring forward proxy server settings.
Amazon DynamoDB for attribute source lookups
New
Our continued effort to support Amazon DynamoDB (NoSQL) now lets you use DynamoDB as a source for attribute lookups. The connector supports the DynamoDB query language so you can easily configure it. For more information, see Configuring an AWS DynamoDB datastore.
OAuth 2.0 DPoP
New
As regulations for APIs in the context of financial services tighten, it’s important to support highly secure API authentication and authorization methods. OAuth DPoP (Demonstrating Proof-of-Possession) is an extension to the OAuth framework and specifies how OAuth tokens are bound to clients. Clients must digitally prove the ownership of these tokens at runtime, which prevents unauthorized clients from misusing them. This extension is useful for any OAuth scenario, not only in financial environments. For more information, see Configuring authorization server settings.
Logging the TLS version that clients use
New
For TLS connections, PingFederate can now log the TLS version that clients use. This gives you an easy way to identify clients that might need updates to use newer versions. For more information, see the tlsversion field in Security audit logging.
Certificate expiration dates added to certificate menus
New
In the administrative console, now certificate selection menus show the distinguished name (DN) and expiration date for each certificate, rather than a serial number. This gives you easy access to relevant information.
New JWT Token Processor
New
A new JWT token processor enhances the token exchange capabilities so that you can leverage any configured issuer. Now PingFederate can validate and accept incoming tokens that were created by pre-configured issuers. For more information, see Configuring a JWT Token Processor 2.0 instance.
Enhanced authentication policies
New
Complex authentication policies are sometimes challenging to manage. To simplify your work and add flexibility to policies, PingFederate provides several policy enhancements:
-
Now the Requested AuthN Context Authentication Selector can determine the authentication context for flows. For more information, see Configuring the Requested AuthN Context Authentication Selector.
-
Now you can use Context and Extended Properties for attribute sources when mapping authentication policy contracts and local identity profiles. For more information, see Configuring contract mapping, Configuring local identity mapping, and Defining issuance criteria for contract or local identity mapping.
-
Now you can use the Scope and Virtual Server ID attributes for authentication sources in policy rules. For more information, see Scope and Virtual Server ID in Configuring rules in authentication policies.
-
Now you can use OGNL expressions to configure more complex policy rules. For more information, see Expression in Configuring rules in authentication policies.
PAR support for OIDC IdP connections and OIDC admin authentication
New
PingFederate now initiates outbound authorization requests using the PAR endpoint of the target authorization server if you expose it. This enhancement lets PingFederate use PAR inbound and outbound, which improves OAuth flow security. For more information, see the Pushed Authorization Request Endpoint field in Configuring OpenID Provider information.
Support for OpenID Connect back-channel logout
New
In the context of OpenID session management, PingFederate now supports back-channel logout. PingFederate supports this feature whether it’s configured as an OpenID Connect provider (OP) or a relying party (RP). For more information, see the OpenID Connect Back-Channel Logout 1.0 specification.
Ability to include x5t and typ in ID token headers
New
Now PingFederate can include JWT header values x5t
and typ
in the ID tokens it issues. You can include the x5t
header with static keys enabled, whereas you can configure the typ
header to an appropriate value without a dependency on the types of keys. The x5t
header adds another mechanism for verifying the validity of a received JWT. For information about the x5t
and typ
parameters, see the JSON web key (JWK) and JWT specifications, respectively, and steps 9 and 10 in Configuring policy and ID token settings.
Support for the alg parameter response for JWKS keys
New
The alg
header is now supported in PingFederate’s JWKS endpoint. Any elliptic curve keys and all RSA-256 based keys expose this header. This feature lets clients verify that a received JWT has been signed by the advertised algorithm. For information about the alg
parameter, see the JWK specification and JSON Web Keys endpoint.
Support for client_secret_jwt as client authentication
New
With the client_secret_jwt authentication method, a client can choose to create a signed JWT when authenticating against PingFederate’s token endpoint, introspection endpoint, PAR endpoint, or CIBA endpoint instead of providing the client secret. This feature prevents potential client secret leakage because it’s not actively exchanged with any party. PingFederate also supports this feature when it acts as an RP. For more information, see client_secret_jwt in the Open ID Connect specification and Client authentication schemes.
Refresh token reuse and revocation best practice
New
PingFederate now revokes a chain of tokens if a refresh token is revoked or if a refresh token is reused. This includes derived authorization codes and access tokens. For more information, see the Refresh Token settings section of Configuring authorization server settings.
Overriding configuration settings using environment variables
New
Now you can configure many properties as environment variables instead of setting them in properties files. This is especially important for container environments, which is common practice.
Auditing enhancements
New
Several enhancements provide more details in PingFederate generated logs. These include the logging of JWT IDs (jti), hashed values of authorization codes, access tokens, and refresh tokens. Also, PingFederate now logs which system has locked out users after multiple, unsuccessful login attempts, so you’ll know if it was PingFederate or an LDAP server. PingFederate also adds more details to the administrative API logs, so now there are almost no differences between logs generated when using the administrative console or administrative API. For more information, see Administrator audit logging, Administrative API audit log, and Security audit logging.
Amazon DynamoDB and OAuth client records
New
Now you can manage OAuth clients in Amazon DynamoDB. With this update, you can use DynamoDB to manage OAuth clients, persistent grants, and persistent authorization sessions. For more information, see Configuring an Amazon DynamoDB for client storage.
Upgraded Velocity Engine 2.3
New
PingFederate now supports Apache Velocity Engine 2.3. For more information, see Upgrading in the Apache Velocity Engine documentation.
Support for strict content security policy (CSP) for HTML templates
New
Now you can include CSP policies for HTML templates without having to implement workarounds. For more information, see Customizable user-facing pages.
Ability to use additional Velocity tools
New
Now you can use Velocity templates with more tools, such as cookieTool.
Support for Microsoft Azure SQL Managed Instance
New
PingFederate now supports Microsoft Azure SQL Managed Instance. For more information, see the Datastore integration table in System requirements, and for more information on how to configure a connection to Microsoft Azure SQL Managed Instance, see Configuring a JDBC connection.
mTLS authentication for REST API datastores
New
PingFederate now supports mutual TLS (mTLS) client authentication for REST API datastores.
mTLS authentication for LDAP datastores
New
PingFederate now supports mTLS client authentication for LDAP datastores.
Entrust nShield Connect HSM and Java 11
New
Now when you integrate an Entrust nShield hardware security module (HSM) with PingFederate, you can use Java 11.
Bundled User Count Utility
New
We added the User Count Utility (UCU) as a bundled component. You can use the UCU to produce unique and active user counts in a PingFederate environment.
Upgraded third-party components
New
We upgraded the following third-party components:
-
Upgraded Spring Framework to 5.3.27
-
Upgraded jose4j to 0.9.3
SAML login session tracking
Fixed PF-33168
We improved SP-Initiated SAML login session tracking. This security improvement can affect existing SAML SP connections that rely on multiple session states in a single transaction.
For more information about how your configuration can be affected, and the steps to resolve issues, see Solicited SAML Response Validation in the Ping Identity Support Portal.
Log message when multiple entries match the LDAP PCV search filter
Fixed PF-32427
Now when multiple entries match the LDAP PCV search filter, the following message appears in the log at DEBUG level: error code 4 - This
search operation has sent the maximum of 1 entries to the
client
Multivalued authorization request parameters
Fixed PF-32783
Now multivalued request parameters work as expected in authorization requests for OIDC administrative console authentication.
Tracked parameters in the LDAP search filter when using the administrative API
Fixed PF-32914
Now you can use tracked parameters in the Attribute Sources and User Lookup LDAP search filter when using the administrative API.
Showing and hiding passwords being entered
Fixed PF-33059
Now all password entry fields in PingFederate templates have icons that let users show and hide the password they’re entering.
Connections and OAuth clients referencing deleted extended properties
Fixed PF-33311
When a connection or OAuth client references a deleted extended property, PingFederate no longer throws a null pointer exception. Instead it ignores the extended property and logs an error.
Custom error messages from external consent adapters
Fixed PF-33151
Now PingFederate can use customized messages from external consent adapters in error responses.
Restricting password credential validators
Fixed PF-33487
When restrictToDefaultAccessTokenManager
is enabled on an OAuth client, the client can only get access tokens when being validated by password credential validators that are mapped to the restricted access token manager.
Bypass Authorization Approval and prompt parameters
Fixed PF-33598
When an OAuth client has Bypass Authorization Approval enabled, now that setting takes precedence over the prompt
parameter in requests.
The memoryoptions
script allocates excessive JVM heap
Fixed PF-33610
The memoryoptions
script no longer allocates excessive JVM heap on Windows systems.
Authorization Code and Device Authorization grant handling
Fixed PF-33622
For the Device Authorization grant type, if Check Activation Code is set to Before Authentication, then authorization detail is set in the input parameters map when IdpAuthenticationAdapterV2
in the SDK is invoked.
Converting the values of binary attributes from PingOne LDAP gateway datastores
Fixed PF-33637
Now when PingFederate retrieves a binary attribute from a PingOne LDAP gateway datastore, it correctly converts the attribute value to the specified format (base64, SID, hex).
Unexpected certificate usage
Fixed PF-33709
When more than one trusted CA matches the issuer DN of an OAuth client, now PingFederate only flags the trusted CA as in use if its certificate hasn’t expired and its subject DN matches the client’s configured issuer DN.
Potential information disclosure vulnerability
Fixed PF-33867
Removed a potential information disclosure vulnerability.
Jetty unable to serve gzip precompressed resources
Fixed PF-33869
Now PingFederate allows Jetty to precompress resources such as images and CSS.
Returning 400
error instead of a 500
error
Fixed PF-30236
When a system-level issue causes a data source attribute lookup to fail during OAuth flows, if the <pf_install>/pingfederate/server/default/data/config-store/org.sourceid.saml20.domain.AttributeMapping.xml
file’s AbortOnAttrLookupFailure
attribute is set to true
, now PingFederate returns a 500
error instead of a 400
error.
Usercount Utility’s aggregate command
Fixed PF-32757
When you run the Usercount Utility’s aggregate command:
-
If all
.ucu
files contain tracking IDs, the utility generates a user count for each event, like before. -
If no
.ucu
files contain tracking IDs, now the utility generates a user count for each application. -
If some
.ucu
files contain tracking ids but others don’t:-
for the files without tracking IDs, now the utility generates a user count for each application.
-
for the files with tracking IDs, now the utility generates a user count for each event.
-
CPU load displayed as N/A
Fixed PF-32837
Now when the CPU load is 0, heartbeat pages display the value with digits instead of as “N/A”.
Unexpected carriage return in audit logs
Fixed PF-32989
We resolved an issue that caused an unexpected carriage return in audit logs during SP-initiated single sign-on (SSO) if an identity provider responded with a non-success status.
Known issues and limitations
PingID password credential validator with integrated RADIUS server
Issue
PingFederate versions 11.1.4, 11.1.5, 11.2.1, and 11.2.2 contain version 3.0.2 of the PingID password credential validator (PCV). That version of the PCV has known issues that you should review before upgrading. For more information, see Known issues in PingID RADIUS PCV 3.0.2.
Administrative console and administrative API
Issue
-
Although PingFederate 11.3 and later support DPoP, a known limitation is that the following features don’t support DPoP when PingFederate is the RP:
-
The administrative console authentication scheme using OIDC
-
The administrative API authentication scheme using OAuth 2.0
-
-
/bulk: Only resource types currently supported by the administrative API are included in the exported data. We don’t intend to introduce administrative API support to the following areas:
-
Previously, the administrative API did not accurately reflect a Persistent Grant Max Lifetime setting of 29 days (or shorter) with the selection of the Grants Do Not Timeout Due To Inactivity option. As a result, if you have configured such OAuth authorization server settings and have generated a bulk export in version 10.0 through 10.0.2, we recommend that you re-generate a new bulk export after upgrading to version 10.0.3 (or a more recent version). The newly exported data does not contain the aforementioned flaw, and you can safely import it to version 10.0.3 (or a more recent version).
-
When enabling mTLS certificate-based authentication, administrators often configure a list of acceptable client certificate issuers. When you use a browser to access the console or the administrative API documentation, PingFederate returns to the browser the list of acceptable issuers as part of the TLS handshake. If the browser’s client certificate store contains multiple client certificates, the browser often presents you only the certificates whose issuer matches one of the acceptable issuers. However, when PingFederate runs in a Java 11 environment, Chrome presents you all its configured client certificates, regardless of whether the issuer matches one of the acceptable issuers or not.
-
When using mTLS authentication to authenticate to an LDAP server for administrative console or administrative API access, PingFederate doesn’t support using a Microsoft Active Directory server.
-
Prior to toggling the status of a connection with the administrative API, you must ensure that any expired certificates or no longer available attributes are replaced with valid certificates or attributes; otherwise, the update request fails.
-
When creating or updating a child instance of a hierarchical plugin, the administrative API retains objects with an
"inherited": false
name/value pair (or without such name/value pair altogether), ignores those with a value oftrue
, and returns a 200 HTTP status code. No error messages are returned for the ignored objects. -
Using the browser’s navigation mechanisms (for example, the Back button) causes inconsistent behavior in the administrative console. Use the navigation buttons provided at the bottom of windows in the PingFederate console.
-
Using the PingFederate console in multiple tabs on one browser might cause inconsistent behavior which could corrupt its configuration.
-
If authenticated to the PingFederate administrative console using certificate authentication, a session that has timed out might not appear to behave as expected. Normally (when using password authentication), when a session has timed out and a user attempts some action in the console, the browser is redirected to the sign-on page, and then back to the administrative console after authentication is complete. Similar behavior applies for certificate authentication, in principle. However, because the browser might automatically resubmit the certificate for authentication, the browser might redirect to the administrative console and not the sign on page.
PingOne MFA CIBA Authenticator
Issue PingOne MFA
PingFederate 11.3 is not compatible with the PingOne MFA CIBA Authenticator bundled in PingOne MFA Integration Kit version 2.1 and earlier. This issue was resolved in version 2.2 of that integration kit.
TLSv1.3
Issue
For Java versions that don’t support TLSv1.3 (meaning versions earlier than 8u261), PingFederate fails on start up with a NoSuchAlgorithmException
exception. To resolve this error, remove TLSv1.3
from the following settings in the run.properties
file:
-
pf.tls.client.protocols
-
pf.tls.runtime.server.protocols
-
pf.tls.admin.server.protocols
TLS cipher suite customization
Issue
PingFederate’s TLS cipher suites can be customized by modifying com.pingidentity.crypto.SunJCEManager.xml
(or a similarly-named file if BCFIPS or an HSM is configured). After updating the file and replicating, all cluster nodes must be restarted for the change to take effect.
Java
Issue
-
As of PingFederate 11.1, BC-FIPS and HSMs are not supported when using Java 17.
-
Updating Java version 8 to version 11 results in an error when PingFederate is already installed and running on Windows. To work around this issue, uninstall and reinstall the PingFederate Windows service by running the
UninstallPingFederateService.bat
andInstallPingFederateService.bat
files located in<pf_install>/pingfederate/sbin/wrapper
.
HSMs
Issue
AWS CloudHSM
-
It is not possible to use an elliptic curve (EC) certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
Thales HSMs
-
JWT token decryption using ECDH-ES may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored on the HSM, and PingFederate is consuming a token encrypted with this key.
-
It is not possible to use an EC certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
Entrust HSMs
-
JWT token decryption using ECDH-ES may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored on the HSM, and PingFederate is consuming a token encrypted with this key.
-
It is not possible to import a PKCS12- or PEM-formatted EC certificate.
-
It is not possible to use an EC certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
SSO and SLO
Issue
-
When consuming SAML metadata, PingFederate does not report an error when neither the
validUntil
nor thecacheDuration
attribute is included in the metadata. Note that PingFederate does reject expired SAML metadata as indicated by thevalidUntil
attribute value, if it is provided. -
The anchored-certificate trust model cannot be used with the Single log off (SLO) redirect binding because the certificate cannot be included with the logout request.
-
If an IdP connection is configured for multiple virtual server IDs, PingFederate will always use the default virtual server ID for IdP Discovery during an SP-initiated SSO event.
Composite Adapter configuration
Issue
SLO is not supported when users are authenticated through a Composite Adapter instance that contains another instance of the Composite Adapter.
Self-service password reset
Issue
Passwords can be reset for Microsoft Active Directory user accounts without the permission to change password.
Session revocation API
Issue PPQ-33519
POST requests to the Session Revocation API do not support the Private Key JWT authentication type.
OAuth
Issue
PingFederate does not support a case-sensitive naming convention for OAuth client ID values when client records are stored in a directory server. For example, after creating a client with an ID value of sampleClient
, PingFederate does not allow the creation of another client with an ID value of SampleClient
.
Although it’s possible to create clients using the same ID values with different casings when client records are stored in XML files, a database server, or custom storage, we recommend not doing so to avoid potential record migration issues.
Customer identity and access management
Issue
Some browsers display a date-picker user interface for fields that have been designed for date-specific inputs. Some browsers do not. If one or more date-specific fields are defined on the registration page or the profile management page (or both), end users must enter the dates manually if their browsers do not display a date-picker user interface for those fields.
Provisioning
Issue
-
LDAP referrals return an error and cause provisioning to fail if the
user
orgroup
objects are defined at the DC level, and not within an OU or within the Users CN. -
The
totalResults
value in SCIM responses indicates the number of results returned in the current response, not the total number of estimated results on the LDAP server.
Logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
Database logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
RADIUS NAS-IP-Address
Issue
The RADIUS NAS-IP-Address is only included in Access-Request packets when the pf.bind.engine.address
is set with an IPv4 address. IPv6 is not supported.
Amazon SNS Notification Publisher
Issue
When deploying PingFederate with a forward proxy, plugins based on the AWS SDK, such as the Amazon SNS Notification Publisher, will only honor the http.proxyHost
, http.proxyPort
, http.proxyUser
, and http.proxyPassword
properties in run.properties
. The plugin will rely on these properties even if the service URL is https
.
PingOne Fraud integration kit
Info PingOne Fraud
The PingOne Fraud integration kit is no longer bundled with PingFederate.
Microsoft Internet Explorer 11
Info
Ping Identity commits to deliver the best experience for administrators and users. As we continue to improve our products, we encourage you to migrate off of Microsoft Internet Explorer 11. Starting with PingFederate 11.0, Internet Explorer 11 is no longer included in the PingFederate qualification process for administrators or users. For a list of supported browsers, see System requirements.
Configcopy tool, Connection Management Service, SSO Directory Service
Info
As of PingFederate 10.2, these features have been deprecated and will be removed in a future release.
Oracle Directory Server Enterprise Edition
Info
As Oracle ended its Premier Support for Oracle Directory Server Enterprise Edition (ODSEE 11g) in December 2019, we no longer include ODSEE as part of the PingFederate qualification process (starting with PingFederate 10.2). We continue to qualify against Oracle Unified Directory (www.oracle.com/middleware/technologies/unified-directory.html) and other supported directory servers. For a full list, see System requirements.
SNMP
Info
Starting with PingFederate 10.2, monitoring and reporting through the SNMP has been removed.
Roles and protocols
Info
Starting with PingFederate 10.1, roles and protocols are always enabled and no longer configurable through the administrative console and API.
PingFederate 11.2.10 (July 2024)
OAuth client only validates one access token manager when aud
parameter included
Fixed PF-35737
Fixed a defect that caused PingFederate to validate only the first OAuth client access token manager it found when Validate Against All Eligible Access Token Managers was checked, and the aud
parameter was included in the request.
PingFederate 11.2.9 (April 2024)
Rest datastore security vulnerability
Security PF-34720
Fixed a JSON injection vulnerability in REST datastores described in security advisory SECADV044.
Runtime nodes security vulnerability
Security PF-34896
Fixed a path traversal vulnerability in Runtime nodes described in security advisory SECADV044.
OpenID Connect policy management editor security vulnerability
Security PF-35081
Fixed a Cross-Site Scripting vulnerability in the OpenID Connect Policy Management Editor described in security advisory SECADV044.
PingFederate 11.2.8 (December 2023)
Configurable option to turn on/off plugin creation and initialization during PingFederate startup.
New PF-34640
Added the ConfigurePluginsOnStartup variable to the config-store
file.
Default value of true
creates and initializes plugins during startup. false
prevents creation and initialization of plugins, which can reduce startup time.
Improved OGNL expression logging
Improved PF-34050
The administrator audit log file (admin.log
) now logs any OGNL expression tests performed and the expression variables used with an event type of TEST_EXPRESSION
.
For more information, see Administrator audit logging
Resolved a vulnerability in the Initial Setup Wizard
Security PF-34646
Fixed a Server-Side Request Forgery vulnerability in the Initial Setup Wizard described in security advisory SECADV041.
PingFederate systematically adds server-side sort control
Fixed PF-33466
You can now turn off server-side sorting using a configuration option.
PingFederate 11.2.7 (August 2023)
PingFederate 11.2.6 (June 2023)
Policy fragment validation error
Fixed PF-33156
Policy fragments with valid authentication sources no longer fail with an Invalid Configuration error during runtime.
The memoryoptions
utility allocates excessive JVM heap
Fixed PF-33610
The memoryoptions
utility no longer allocates excessive JVM heap on Windows systems.
The device authorization grant type and the Check Activation Code setting
Fixed PF-33622
For the device authorization grant type, if Check Activation Code is set to Before Authentication, now authorization detail is set in the input parameters map when IdpAuthenticationAdapterV2
in the SDK is invoked.
Binary attributes handled incorrectly when using PingOne LDAP gateway datastores
Fixed PF-33637
Now when PingFederate retrieves a binary attribute from a PingOne LDAP gateway datastore, it correctly converts the attribute value to the specified format (base64, SID, hex).
Jetty unable to precompress resources
Fixed PF-33869
Now PingFederate allows Jetty to precompress resources such as images and CSS.
PingFederate 11.2.5 (May 2023)
Multi-value request parameters for OIDC for console login
Fixed PF-32783
We fixed an issue where multi-value request parameters were not working as expected when using OIDC for console login.
Preservation of changes to certain validation rules
Fixed PF-33093
We fixed an issue where PingFederate did not preserve changes to certain validation rules in the http-request-parameter-validation.xml
file upon upgrade.
SAML login session tracking
Fixed PF-33168
We improved SP-Initiated SAML login session tracking. This security improvement can affect existing SAML SP connections that rely on multiple session states in a single transaction.
For more information about how your configuration can be affected, and the steps to resolve issues, see Solicited SAML Response Validation in the Ping Identity Support Portal.
OTL reset page error messaging
Fixed PF-33307
The one-time link (OTL) reset page now displays an error message when the link is expired.
Access token bug fix
Fixed PF-33342
We resolved an issue where an access token may not include the pi.sri
claim after refresh. This issue only occurs when reuse of existing access grants is enabled.
Attribute retrieval
Fixed PF-33484
In OAuth and OpenID Connect (OIDC) flows, external consent adapters can now retrieve attributes from the chained attributes map.
LDAP bug fix
Fixed PF-33503
We fixed an LDAP issue where new access grant records were not created with new scopes when Reuse Existing Persistent Access Grants for Grant Types was enabled.
ID token ACR claim
Fixed PF-33557
We resolved an issue where an ID token would not include the Authentication Context Class Reference (ACR) claim if an old client secret was used during the retention period.
Redundancies in key algorithm generation
Fixed PF-33607
We fixed an issue that affected cluster replication when PingFederate was deployed with AWS CloudHSM. When replication was initiated, engines generated a number of temporary key pairs, and the increased load on the HSM could trigger SSO errors.
PingFederate 11.2.4 (March 2023)
Base DN reference attribute
Fixed PF-32971
We’ve fixed an issue where upstream data stores in the chain could not recognize the reference attribute for base distinguished name (DN) during lookup.
Identity store provisioner validation rules
Fixed PF-33017
We’ve improved validation rules to ensure that only identity store provisioners that support groups require group attribute contract validation.
DCR with client secret retention
Fixed PF-33035
We’ve resolved a null pointer exception (NPE) error that occurred when attempting to set up Dynamic Client Registration (DCR) with client secret retention.
Response handling logs
Fixed PF-33131
We’ve added additional logging to help debug unexpected errors in response handling.
OIDC policies with fragments configured
Fixed PF-33158
We’ve resolved an issue that occurred when saving OpenID Connect (OIDC) policies with fragments configured.
PingFederate 11.2.3 (February 2023)
Potential security vulnerability
Fixed PF-32748
We’ve resolved a potential security vulnerability that is described in security advisory SECADV035.
PingFederate 11.2.2 (February 2023)
Enhancements and resolved issues in PingFederate 11.2.2.
Server log warnings
Fixed PF-33037
We’ve added a warning to server logs if the ds-pwp-state-json attribute is not present in PingDirectory’s LDAP Response. This warning appears in the log every time a user interacts with the profile management page. Please enable this attribute to adhere to PingDirectory’s security configuration best practices. PingDirectory version 8.1 and later supports this attribute, and customers running older versions are encouraged to upgrade to a supported version as soon as possible.
PingFederate 11.2.1 (February 2023)
Enhancements and resolved issues in PingFederate 11.2.1.
OAuth client management
Fixed PF-32790
When managing OAuth clients, we’ve resolved a defect where selecting the Require JWT Secured Authorization Response Mode text toggled the incorrect check box.
Potential security vulnerability
Fixed PF-32805
We’ve resolved a potential security vulnerability that is described in security advisory SECADV033.
Informing adapters of end policy result
Fixed PF-32890
When processing policy fragments, all adapters invoked in the fragment now correctly execute their respective post-processing step (if applicable) to inform the adapter of the end policy result.
Managing certificates within Metadata Export
Fixed PF-32965
Managing certificates within the Metadata Export flow no longer displays or saves an empty list of certificates, clearing out existing ones in the process. For more information, see Metadata export.
Cluster data replication
Fixed PF-32983
We’ve resolved a defect where cluster data replication could remove keys from engine node’s pf.jwk
file instead of merging and retaining the keys.
Other improvements
New
-
We also updated the following bundled components and third-party dependencies:
-
PingID Integration Kit 2.23
-
PingID Adapter 2.13.2
-
PingID PCV (with integrated RADIUS server) 3.0.2
This version of the PingID PCV has known issues that you should review before upgrading. For more information, see Known issues in PingID RADIUS PCV 3.0.2.
-
PingFederate 11.2 (December 2022)
New features and improvements in PingFederate 11.2.
Support for OAuth 2.0 authorization server metadata
New
PingFederate now supports OAuth 2.0 authorization server metadata. This allows OAuth clients to retrieve relevant endpoints and other details about features that PingFederate supports. The API response is like the OpenID Connect Discovery endpoints response but doesn’t include OpenID Connect relevant details. This lets you configure endpoints for your particular use case. See OAuth authorization server metadata endpoint.
Support for nested groups and nested search for PingDirectory
New
For outbound provisioning, PingFederate now supports nested groups and nested search for PingDirectory. This lets you freely choose your favorite directory without needing to choose based on the support for nested groups. See nested group and nested search in Specifying a source location.
Exposed AccessGrantManagerAccessor
as part of the SDK
New
The AccessGrantManagerAccessor
is now accessible in the PingFederate SDK. This lets developers query existing persistent grants at run time. See <pf_install>/pingfederate/sdk/doc/com/pingidentity/access/AccessGrantManagerAccessor.html
in the SDK documentation.
Improved the sign-on experience after users change their password
New
Now you can configure PingFederate to keep users signed in after they change their password. This prevents users from having to sign on again, right after updating their password, improving the user experience. See the Require Re-authentication settings HTML Form Adapter advanced fields.
Administrative API supports multiple authentication and authorization schemes
New
Now you can configure the PingFederate administrative API to accept either OAuth access_token
or basic authentication. This is especially useful in cases where applications shouldn’t include administrator’s credentials in API requests. See pf.admin.api.authentication
in Configuring PingFederate properties.
Support for Google reCAPTCHA v3 and integration with multiple CAPTCHA providers
New
PingFederate now supports Google reCAPTCHA v3. reCAPTCHA v3 produces a score between 0.0 - 1.0 (risky to safe) that you can use in policies to require step-up authentication or other actions. By default, reCAPTCHA v3 doesn’t interrupt user journeys, which are in the control of application developers. See Managing CAPTCHA providers.
PingFederate also now provides an SDK that allows for integrations with custom CAPTCHA providers, which adds great flexibility to the CAPTCHA feature.
Improved cluster replication notification
New
Instead of showing an active bell icon, the administrative console now displays a banner when cluster replication is required. The banner includes a link to the Cluster Management window for easy access. See Cluster management.
The administrative console supports OIDC claims parameter
New
You can configure PingFederate to function as an OpenID Connect client and let administrators sign on to the administrative console using their PingOne credentials. PingFederate initiates an OpenID Connect flow that includes the claims parameter. You can also use this feature outside the PingOne environment, leveraging any authorization server that supports the claims parameter. This allows for a simpler, seamless login flow. See Request Parameters in Enabling OIDC-based authentication.
The administrative console supports third party-initiated login
New
You can configure PingFederate to accept incoming parameters, such as iss
, that are processed and included in an outgoing authorization request if configured to do so. This feature lets administrators sign on to PingFederate from PingOne. This feature also supports other OpenID Connect authorization servers that support incoming parameters. See Request Parameters in Enabling OIDC-based authentication.
PingOne DaVinci integration kit
New
The PingFederate distribution now includes the PingOne DaVinci integration kit. See PingOne DaVinci Adapter in Bundled adapters and authenticators.
Amazon DynamoDB and persistent authentication sessions
New
PingFederate can now manage persistent user sessions in AWS DynamoDB. Persistent user sessions keep sessions active even after a restart of PingFederate. This feature reduces the interruption of user journeys. See Configuring an Amazon DynamoDB for persistent authentication sessions in Defining a datastore for persistent authentication sessions.
Enhanced policy rules
New
When defining policy rules, now attributes that were processed in an earlier step can be accessed further down in the policy tree. This feature enhances the management and usability of policies. See Configuring rules in authentication policies.
The heartbeat endpoint and JMX expose more information
New
The data exposed by the heartbeat endpoint and JMX interface now include more details, such as the number of errors per data store. See Liveliness and responsiveness.
Updated the bundled PingOne MFA Adapter
Improved
Updated the bundled PingOne MFA Adapter to the newest version, 2.0. See PingOne MFA Adapter in Bundled adapters and authenticators.
Toggle log verbosity with ease
New
Gone are the days you had to edit the log4j2.xml
file on multiple servers to enable or disable DEBUG messages in their server logs. Now you can toggle log settings in the administrative console or with the administrative API.
PingFederate provides a set of message categories, each targeting a specific scenario. For example, the XML Signatures category helps you troubleshoot XML signature issues. You can also add your own categories to suit your unique requirements.
Timestamps for clients and connections
New
When viewing lists of OAuth clients and Browser single sign-on (SSO)/security token service (STS) connections, you can now sort them by modification or creation time. The timestamps can also help you understand the history and the relationship between clients and connections.
AWS CloudHSM and Java 11
New
If you integrate with Amazon Web Services (AWS) CloudHSM, now you can choose between Java 8 and Java 11.
OAuth Rich Authorization Requests
New
OAuth rich authorization requests (RAR) provide a standard way for OAuth client applications to specify fine-grained authorization requirements in their requests. For example, when initiating a money transfer, a personal banking application can pass all relevant information to the authorization server via the new parameter authorization_details
. The authorization server supporting RAR processes the authorization_details
parameter value accordingly and ultimately returns tokens to the application if the process completes successfully.
RAR is on track to become a requirement in Financial-grade API (FAPI) 2.0. With this new capability, you can confidently build your open banking solutions with PingFederate.
Other enhancements
New
Now you can optionally define a sender name for each SMTP notification publisher instance.
PingFederate now supports XML Encryption 1.1.
Sorting LDAP and database-related fields
Fixed PF-29355
For LDAP and database-related fields, PingFederate now sorts values alphabetically and in case-insensitive order.
Detailed comments added to log4j2.xml file
Fixed PF-30514
We’ve added detailed comments to the log4j2.xml
file to prevent misconfigurations that could lead to service hangs and production outages. For more information on logging, see Log4j 2 logging service and configuration.
Configuration options added to control SAML error responses
Fixed PF-30514
We’ve added a configuration option to control whether SAML error responses include Cause
. The new setting is IncludeErrorCauseInSamlResponse
in config-store/org.sourceid.saml20.protocol.StatusResponseTypeUtil.xml
. The default value is true.
Improved SP STS message customization
Fixed PF-31149
The #HttpServletRequest and #HttpServletResponse variables are now available in SP STS message customization. For more information, see Message types and available variables.
Connections with multiple protocol types
Fixed PF-31531
We’ve resolved an issue where connections with multiple protocol types would only filter on a single protocol type.
OpenID Connect (OIDC) for administrative console authentication
Fixed PF-31717
When using OIDC for administrative console authentication, PingFederate no longer throws an NPE if private_key_jwt
is used for client authentication method and the client.secret
property is not set.
Improvements to refresh token rolling criteria
Fixed PF-31761
We’ve introduced a new separate stored value to track when refresh tokens should be reissued to OAuth clients, resolving a defect where rolling refresh tokens read the incorrect update timestamp to determine refresh token rolling criteria. For more information, see Configuring authorization server settings.
Store clients with special characters
Fixed PF-31786
When adding clients to Active Directory (AD) or other LDAP stores, PingFederate now automatically escapes reserved characters from clientIDs.
Improved detection around invalid Group DN
Fixed PF-31791
We’ve improved detection around invalid Group distinguished names (DN) and added exceptions in the provisioner log. For more information on Group DN, see Specifying a source location.
Updates to the SameSite=None header attribute supported browsers list
Fixed PF-31806
We’ve updated the supported browsers list for the SameSite=None
header attribute to filter out problematic clients with the SameSite
cookie attribute bug: Safari version 12 and Embedded Apple Webkit Browser Safari 12 on macOS.
Expired user sessions and session log out
Fixed PF-31807
PingFederate’s administrative console now identifies expired user sessions on timeout and properly removes the session regardless of user interaction.
Policy and fragment logging
Fixed PF-31862
PingFederate now logs the policy and fragment name before fragment processing.
Bulk import for IdP connections
Fixed PF-31870
Resolved an issue where bulk import fails for identity provider (IdP) connections that fulfill Persistent Grant Extended Attributes.
Connection failures on external LDAP authentication login
Fixed PF-32001
PingFederate now recovers from initial connection failure when logging into the administrative console using external LDAP authentication.
Hiding user information from authentication API responses
Fixed PF-32028
You can now configure the IncludeUserInfoInResponses
setting in the <install
dir>/server/default/data/config-store/org.sourceid.saml20.domain.mgmt.impl.AuthnApiManagerImpl.xml
file to hide user information from authentication API responses.
Errors on policy fragments configured to handle failures locally
Fixed PF-32073
When an error occurs on policies containing fragments and configured to handle failures locally, PingFederate no longer redirects a user to the service provider (SP) error page on SP-initiated SSO.
Password management
Fixed PF-32081
We’ve resolved an issue around password requirements messaging during password management.
Updated description text on Import Connections page
Fixed PF-32088
We’ve updated the description text on the import IdP/SP connection page to indicate that PingFederate only performs minimal validation for imported connections. We suggest using the administrative API for connection migration, which performs thorough validation.
OTL for password reset expiry or reuse error reporting
Fixed PF-32090
In the case where a one-time link (OTL) for password reset expires or is reused, PingFederate now responds with the appropriate error message in the authentication API and logs the error response in the audit.log
. For more information on OTL for password reset, see Configuring self-service account recovery.
Duplicate scope and scope group name values
Fixed PF-32234
We’ve resolved a defect that allowed scope and scope group names to be the same when saved through the administrative console. For more information on scopes, see Scopes and scope management.
Warning during SQL provisioning table creation
Fixed PF-32254
We’ve decreased the maximum key length for saasGroupName
, resolving a warning that occurred when creating SQL provisioning tables.
'Change Password' link accessibility
Fixed PF-32343
On sign-on pages, we’ve improved the accessibility of the 'Change Password' link, regardless of browser window size.
Notification publisher accessor added to SDK
Fixed PF-32345
We’ve added a notification publisher accessor to the SDK, addressing an error where plugins utilizing a notification publisher could not invoke one of the notification publishers configured in PingFederate.
Fragment processing now independent of policy processing
Fixed PF-32461
PingFederate now processes policy fragments independently from policies and other fragments.
LIP registration via a third-party service and the authentication API
Fixed PF-32574
We’ve resolved a defect where Local Identity Profile (LIP) registration via a third-party service and the authentication API would still require a password, despite previously registering with the third party.
PingID password credential validator with integrated RADIUS server
Issue
PingFederate versions 11.1.4, 11.1.5, 11.2.1, and 11.2.2 contain version 3.0.2 of the PingID password credential validator (PCV). That version of the PCV has known issues that you should review before upgrading. For more information, see Known issues in PingID RADIUS PCV 3.0.2.
Administrative console and administrative API
Issue
-
/bulk: Only resource types currently supported by the administrative API are included in the exported data. We don’t intend to introduce administrative API support to the following areas:
-
Previously, the administrative API did not accurately reflect a Persistent Grant Max Lifetime setting of 29 days (or shorter) with the selection of the Grants Do Not Timeout Due To Inactivity option. As a result, if you have configured such OAuth authorization server settings and have generated a bulk export in version 10.0 through 10.0.2, we recommend that you re-generate a new bulk export after upgrading to version 10.0.3 (or a more recent version). The newly exported data does not contain the aforementioned flaw, and you can safely import it to version 10.0.3 (or a more recent version).
-
When enabling mutual TLS certificate-based authentication, administrators often configure a list of acceptable client certificate issuers. When you use a browser to access the console or the administrative API documentation, PingFederate returns to the browser the list of acceptable issuers as part of the TLS handshake. If the browser’s client certificate store contains multiple client certificates, the browser often presents you only the certificates whose issuer matches one of the acceptable issuers. However, when PingFederate runs in a Java 11 environment, Chrome presents you all its configured client certificates, regardless of whether the issuer matches one of the acceptable issuers or not.
-
Prior to toggling the status of a connection with the administrative API, you must ensure that any expired certificates or no longer available attributes are replaced with valid certificates or attributes; otherwise, the update request fails.
-
When creating or updating a child instance of a hierarchical plugin, the administrative API retains objects with an
"inherited": false
name/value pair (or without such name/value pair altogether), ignores those with a value oftrue
, and returns a 200 HTTP status code. No error messages are returned for the ignored objects. -
Using the browser’s navigation mechanisms (for example, the Back button) causes inconsistent behavior in the administrative console. Use the navigation buttons provided at the bottom of windows in the PingFederate console.
-
Using the PingFederate console in multiple tabs on one browser might cause inconsistent behavior which could corrupt its configuration.
-
If authenticated to the PingFederate administrative console using certificate authentication, a session that has timed out might not appear to behave as expected. Normally (when using password authentication), when a session has timed out and a user attempts some action in the console, the browser is redirected to the sign-on page, and then back to the administrative console after authentication is complete. Similar behavior applies for certificate authentication, in principle. However, because the browser might automatically resubmit the certificate for authentication, the browser might redirect to the administrative console and not the sign on page.
TLSv1.3
Issue
For Java versions that don’t support TLSv1.3 (meaning versions earlier than 8u261), PingFederate fails on start up with a NoSuchAlgorithmException
exception. To resolve this error, remove TLSv1.3
from the following settings in the run.properties
file:
-
pf.tls.client.protocols
-
pf.tls.runtime.server.protocols
-
pf.tls.admin.server.protocols
TLS cipher suite customization
Issue
PingFederate’s TLS cipher suites can be customized by modifying com.pingidentity.crypto.SunJCEManager.xml
(or a similarly-named file if BCFIPS or a hardware security module (HSM) is configured). After updating the file and replicating, all cluster nodes must be restarted for the change to take effect.
Java
Issue
-
As of PingFederate 11.1, BC-FIPS and HSMs are not supported when using Java 17.
-
Updating Java version 8 to version 11 results in an error when PingFederate is already installed and running. To work around this issue, uninstall and reinstall the PingFederate Windows service by running the
UninstallPingFederateService.bat
andInstallPingFederateService.bat
files located in<pf_install>/pingfederate/sbin/wrapper
.
Hardware security modules (HSMs)
Issue
AWS CloudHSM
-
It is not possible to use an elliptic curve (EC) certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
Thales HSMs
-
JWT token decryption using ECDH-ES may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored on the HSM, and PingFederate is consuming a token encrypted with this key.
-
It is not possible to use an elliptic curve (EC) certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
Entrust HSMs
-
PingFederate must be deployed with Oracle Server Java Runtime Environment (JRE) 8 or Amazon Corretto 8.
-
JWT token decryption using ECDH-ES or RSAES OAEP may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored on the HSM, and PingFederate is consuming a token encrypted with this key.
-
SAML assertion decryption using RSA OAEP may fail when the decryption key is stored on the HSM.
-
It is not possible to use an elliptic curve (EC) certificate as an SSL server certificate.
-
TLS 1.3 is not currently supported.
SSO and SLO
Issue
-
When consuming SAML metadata, PingFederate does not report an error when neither the
validUntil
nor thecacheDuration
attribute is included in the metadata. Note that PingFederate does reject expired SAML metadata as indicated by thevalidUntil
attribute value, if it is provided. -
The anchored-certificate trust model cannot be used with the Single log off (SLO) redirect binding because the certificate cannot be included with the logout request.
-
If an IdP connection is configured for multiple virtual server IDs, PingFederate will always use the default virtual server ID for IdP Discovery during an SP-initiated SSO event.
Composite Adapter configuration
Issue
SLO is not supported when users are authenticated through a Composite Adapter instance that contains another instance of the Composite Adapter.
Self-service password reset
Issue
Passwords can be reset for Microsoft Active Directory user accounts without the permission to change password.
OAuth
Issue
PingFederate does not support a case-sensitive naming convention for OAuth client ID values when client records are stored in a directory server. For example, after creating a client with an ID value of sampleClient
, PingFederate does not allow the creation of another client with an ID value of SampleClient
.
Although it’s possible to create clients using the same ID values with different casings when client records are stored in XML files, a database server, or custom storage, we recommend not doing so to avoid potential record migration issues.
Customer identity and access management
Issue
Some browsers display a date-picker user interface for fields that have been designed for date-specific inputs. Some browsers do not. If one or more date-specific fields are defined on the registration page or the profile management page (or both), end users must enter the dates manually if their browsers do not display a date-picker user interface for those fields.
Provisioning
Issue
-
LDAP referrals return an error and cause provisioning to fail if the
user
orgroup
objects are defined at the DC level, and not within an OU or within the Users CN. -
The
totalResults
value in SCIM responses indicates the number of results returned in the current response, not the total number of estimated results on the LDAP server.
Logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
Database logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
RADIUS NAS-IP-Address
Issue
The RADIUS NAS-IP-Address is only included in Access-Request packets when the pf.bind.engine.address
is set with an IPv4 address. IPv6 is not supported.
PingOne Fraud integration kit
Info PingOne Fraud
The PingOne Fraud integration kit is no longer bundled with PingFederate.
Microsoft Internet Explorer 11
Info
Ping Identity commits to deliver the best experience for administrators and users. As we continue to improve our products, we encourage you to migrate off of Microsoft Internet Explorer 11. Starting with PingFederate 11.0, Internet Explorer 11 is no longer included in the PingFederate qualification process for administrators or users. For a list of supported browsers, see System requirements.
Configcopy tool, Connection Management Service, SSO Directory Service
Info
As of PingFederate 10.2, these features have been deprecated and will be removed in a future release.
Oracle Directory Server Enterprise Edition
Info
As Oracle ended its Premier Support for Oracle Directory Server Enterprise Edition (ODSEE 11g) in December 2019, we no longer include ODSEE as part of the PingFederate qualification process (starting with PingFederate 10.2). We continue to qualify against Oracle Unified Directory (www.oracle.com/middleware/technologies/unified-directory.html) and other supported directory servers. For a full list, see System requirements.
SNMP
Info
Starting with PingFederate 10.2, monitoring and reporting through the Simple Network Management Protocol (SNMP) has been removed.
Roles and protocols
Info
Starting with PingFederate 10.1, roles and protocols are always enabled and no longer configurable through the administrative console and API.
PingFederate 11.1.10 (April 2024)
Rest datastore security vulnerability
Security PF-34720
Fixed a JSON injection vulnerability in REST datastores described in security advisory SECADV044.
Runtime nodes security vulnerability
Security PF-34896
Fixed a path traversal vulnerability in Runtime nodes described in security advisory SECADV044.
OpenID Connect policy management editor security vulnerability
Security PF-35081
Fixed a Cross-Site Scripting vulnerability in the OpenID Connect Policy Management Editor described in security advisory SECADV044.
PingFederate 11.1.9 (November 30)
Enhancements and resolved issues in PingFederate 11.1.9.
Outbound provisioning performance improvement
Fixed PF-33466
You can now turn off server-side sorting for LDAP requests related to outbound provisioning, which can improve performance in some environments.
Configure this option using the ProvisionWithServerSort
parameter in the com.pingidentity.common.util.ldap.LDAPUtil.xml
file.
Updating OAuth clients with dynamic client registration
Fixed PF-34146
Fixed a defect where an OAuth client created with dynamic client registration (DCR) couldn’t be updated with DCR after it was modified with the administrative console.
Resolved a vulnerability in the Initial Setup Wizard
Security PF-34646
Fixed a Server-Side Request Forgery vulnerability in the Initial Setup Wizard described in security advisory SECADV041.
PingFederate 11.1.8 (August 2023)
Enhancements and resolved issues in PingFederate 11.1.8.
Potential security vulnerability
Fixed PF-33449
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
Binary attributes handled incorrectly when using PingOne LDAP gateway datastores
Fixed PF-33637
Now when PingFederate retrieves a binary attribute from a PingOne LDAP gateway datastore, it correctly converts the attribute value to the specified format (base64, SID, hex).
Potential security vulnerability
Fixed PF-34017
We’ve resolved a potential security vulnerability that is described in security advisory SECADV037.
PingFederate 11.1.7 (May 2023)
PingFederate 11.1.6 (February 2023)
PingFederate 11.1.5 (February 2023)
Server log warnings
Fixed PF-33037
We’ve added a warning to server logs if the ds-pwp-state-json attribute is not present in PingDirectory’s LDAP Response. This warning appears in the log every time a user interacts with the profile management page. Please enable this attribute to adhere to PingDirectory’s security configuration best practices. PingDirectory version 8.1 and later supports this attribute, and customers running older versions are encouraged to upgrade to a supported version as soon as possible.
PingFederate 11.1.4 (February 2023)
OAuth client management
Fixed PF-32790
When managing OAuth clients, we’ve resolved a defect where selecting the Require JWT Secured Authorization Response Mode text toggled the incorrect check box.
Potential security vulnerability
Fixed PF-32805
We’ve resolved a potential security vulnerability that is described in security advisory SECADV033.
Informing adapters of end policy result
Fixed PF-32890
When processing policy fragments, all adapters invoked in the fragment now correctly execute their respective post-processing step (if applicable) to inform the adapter of the end policy result.
Managing certificates within Metadata Export
Fixed PF-32965
Managing certificates within the Metadata Export flow no longer displays or saves an empty list of certificates, clearing out existing ones in the process. For more information, see Metadata export.
PingFederate 11.1.3 (December 2022)
Enhancements and resolved issues in PingFederate 11.1.3.
Improvements to custom revocation checker
Fixed PF-32395
We’ve improved PingFederate’s custom revocation checker, ensuring that when the server returns stapled Online Certificate Status Protocol (OCSP) responses, PingFederate invokes the checker. Previously, PingFederate used the default revocation checker to validate these responses, which could cause single sign-on (SSO) failures with BCFIPS mode enabled. For more information, see Configuring certificate revocation.
Cluster replication notifications
Fixed PF-32398
We’ve improved notifications to signal to administrators that in the event of a replication failure or any changes to cluster configuration require replication. For more information, see Cluster management.
Null pointer exception during dependency error detection
Fixed PF-32553
During PingFederate dependency error detection, OGNL expressions in adapter-to-adapter mappings no longer raise a null pointer exception (NPE).
PingFederate updates to HSM ordering
Fixed PF-32556
We’ve updated the recommended security provider ordering for the Thales Luna Network hardware security module (HSM) to address an issue where temporary keys and sessions could accumulate on the HSM, eventually resulting in resource exhaustion. A limitation of the new ordering is that EC certificates can no longer operate as SSL server certificates. For details on the new order, see Integrating with Thales Luna Network HSM.
PingFederate 11.1.2 (October 2022)
Enhancements and resolved issues in PingFederate 11.1.2.
Bulk import for IdP connections
Fixed PF-31870
Resolved an issue where bulk import fails for identity provider (IdP) connections that fulfill Persistent Grant Extended Attributes.
Connection failures on external LDAP authentication login
Fixed PF-32001
PingFederate now recovers from initial connection failure when logging into the administrative console using external LDAP authentication.
Hiding user information from authentication API responses
Fixed PF-32028
You can now configure the setting IncludeUserInfoInResponses
in the <install dir>/server/default/data/config-store/org.sourceid.saml20.domain.mgmt.impl.AuthnApiManagerImpl.xml
file to hide user information from authentication API responses.
Errors on policy fragments configured to handle failures locally
Fixed PF-32073
When an error occurs on policies containing fragments and configured to handle failures locally, PingFederate no longer redirects a user to the service provider (SP) error page on SP-initiated single sign-on (SSO).
Outbound TLS connection failures
Fixed PF-32199
The certificate path-building algorithm now uses PingFederate’s custom revocation checker. This fix resolves a bug where outbound TLS connections failed for servers that presented out-of-order certificate chains.
PingFederate 11.1.1 (July 2022)
Enhancements and resolved issues in PingFederate 11.1.1.
Administrative API enhancement
Info
Improved the administrative API to manage the System for Cross-domain Identity Management (SCIM) inbound provisioning settings in identity provider (IdP) connections.
Message customization enhancement
Info
Enhanced PingFederate message customization by adding the following FedHub-specific context variables:
-
FedHubSpConnApplicationName
-
FedHubSpConnName
-
FedHubOAuthClientId
-
FedHubOAuthClientName
Cluster management enhancement
Info
Revised the Cluster Management window to make it more obvious when changes to the configuration on the administrative node have not been replicated to the engine nodes.
Security around password expiration
Fixed PF-29706 PingDirectory
Improved the security around password expiration when using PingDirectory as a user store.
Issuance criteria in authentication policy contracts
Fixed PF-31485
Issuance criteria in authentication policy contracts no longer cause the logs to indicate invalid XML errors. This issue did not cause runtime errors.
HTTP header for client IP addresses
Fixed PF-31735
Resolved an issue that sometimes occurred when IPV6 addresses were specified in the HTTP Header for Client IP Addresses field on the Incoming Proxy Settings window.
Error descriptions
Fixed PF-31753
PingFederate error descriptions no longer disclose details of java classes.
MasterKeyEncryptor failure during cluster replication
Fixed PF-31795
When PingFederate is using a custom MasterKeyEncryptor that relies on an SSL call to an external service, cluster replication no longer causes cascading failures because PingFederate is unable to open Java key store files.
PingFederate 11.1 (June 2022)
New features and improvements in PingFederate 11.1.
PingOne integration
New PingOne
We’ve added Kerberos authentication via PingOne and the PingOne LDAP Gateway Data Store. This new capability allows PingFederate in the cloud, without a direct connection to Active Directory, to complete Kerberos authentication for browser-based SSO requests and STS transactions through PingOne.
JWT Secured Authorization Response Mode (JARM)
New
We’re proud to support JWT Secured Authorization Response Mode (JARM) in version 11.1. JARM allows authorization servers to transmit authorization responses in JSON web tokens (JWTs), providing digital signature and encryption, sender authentication, and audience restriction. As JARM becomes a requirement in FAPI 2, you can deploy open banking solutions confidently.
JWT Response for OAuth Token Introspection
New
We’re also introducing support for JWT Response for OAuth Token Introspection, a draft specification on track to become one of the authorization server requirements in the FAPI 2 Advanced Profile. JWT-secured introspection responses provide stronger assurance to the introspection requesters, most relevant when the requester, such as a resource server, expects to receive verified claims from the authorization server.
Client secret management
New
Seamless client secret rotation no longer requires real-time coordination between PingFederate administrators and the application development teams. You can now configure PingFederate to retain previous secrets for a configurable period, during which the application teams can work on updating the client secrets in their apps. This enhancement drastically lowers the costs of securing applications that use client secrets for authentication. For more information, see "Client Secret Retention Period" in the topic Managing client configuration defaults.
API support for Device Authorization Grant
New
In addition to template-driven user experience, the user authorization step from Device Authorization Grant supports API now. You can also decide whether PingFederate should check the device activation code before or after authentication. These new capabilities enable you to build applications with the desired user experience for input-constrained devices, such as smart TVs or telepresence equipment.
Amazon DynamoDB for grants
New
You can store OAuth persistent grants in Amazon DynamoDB, which allows you to take advantage of a NoSQL database where it matters most: delivering responsive experiences to globally distributed users and offering high availability at ease.
Revocation of self-contained access tokens
New
You can optionally enable direct revocation for self-contained access tokens (JWT access tokens). This flexibility provides a secure way to invalidate access tokens without revoking the underlying refresh tokens or persistent grants. For more information, see Configuring JSON token management and its description of the Enable Token Revocation check box.
A new alert system
New
PingFederate 11.1 centralizes alerts, such as the reminder to replicate configuration, under the new bell icon in the top menu. You can review important alerts from any configuration window.
Copy-and-paste authentication policies and fragments
New
Previously, if you wanted to update an authentication policy or a reusable policy fragment midstream, they had to reconfigure all downstream paths, which can take some effort. With PingFederate 11.1, you can copy a subtree of policy paths before removing a step (such as an IdP adapter), adding a new step (such as a selector or another IdP adapter), and then pasting the subtree back to the policy. This new capability applies to reusable policy fragments and between authentication policies and reusable policy fragments.
Administrative API to move individual policies
New
You can use the administrative API to move an individual policy to a specific location. This enhancement makes re-organizing policies by API requests easier and safer.
Cluster configuration management
New
PingFederate engine nodes now capture common configuration replication issues in their server logs and send replication status back to the console node. The Cluster Management window provides live updates when you select Replicate Configuration in the Cluster Management window. If an error occurs, you can act on it immediately and recover from potential outages faster.
Passthrough IdP Adapter
New
You can now associate authentication sessions with user identities passed through the new Passthrough Identity Provider (IdP) Adapter. By placing the Passthrough IdP Adapter downstream from an IdP connection in a policy tree, you can take advantage of additional capabilities associated with defining a user key. For example, you can use the user key to query or revoke a user’s authentication sessions.
Kerberos authentication and ObjectSID
New
The Kerberos Adapter and the Kerberos Token Processor now return the ObjectSID
attribute value. Because ObjectSID
uniquely identifies the user in Active Directory, leveraging it helps streamline the Attribute Source & Lookup configuration.
Kerberos authentication and re-authentication
New
You can configure the Kerberos Adapter to fail when the service provider asks for re-authentication by including ForceAuthn=true
(SAML 2.0) or prompt=login
(OpenID Connect) in their authentication requests. For example, suppose user interactions are required when the partners ask for re-authentication. In that case, you can add the HTML Form Adapter to the Fail policy path of the Kerberos Adapter.
More error handling options
New
-
You now can configure individual authentication policies to handle authentication failures locally without redirecting to the service providers or returning error messages to the OAuth clients. This flexibility addresses the scenario where an IdP-oriented end-user experience is desirable.
-
PingFederate now includes error results from issuance criteria in error responses. Partners can use the error results to resolve issues as needed. If the invoked policy is configured to handle failures locally, you can do the same to improve the end-user experience.
-
You can now optionally configure the HTML Form Adapter not to return control to PingFederate when an account lockout occurs. Instead, PingFederate returns a “please try again later” message to the browser or the authentication API application.
Extended properties for end-user interactions
New
You can now leverage extended properties in Velocity templates when customizing template-driven end-user interactions. You can reference extended properties in the templates instead of creating multiple If
/ElseIf
/Else
directives, significantly reducing the initial effort. New and updated experiences can be inherited from extended property values from the OAuth client records and Browser SSO connections, eliminating most of the maintenance costs. PingFederate also passes extended property values to authentication API applications. As a result, application developers who create and maintain end-user UX for customer identities will benefit from this new enhancement.
Better documentation in Velocity templates
New
We’ve also improved inline documentation in our Velocity templates. Moving forward, we will maintain variable names and their definitions consistently to communicate changes, such as introducing new variables.
Enhancements in Thales HSM integration
New
Both Java 11 and 8 environments are supported when integrating with Thales Luna Cloud Hardware Security Module (HSM) Services or Luna Network HSMs. For more information about Thales Luna HSM Client, see the Luna Cloud HSM Service Client Guide and Luna Network HSM Documentation Archive.
Secondary signing certificate
New
You can now add a secondary signing certificate to your connections. If configured, PingFederate includes it in both the metadata exports and the metadata URL responses. This flexibility allows you to notify your partners about upcoming changes more easily through metadata.
Administrative API improvements
New
We improved the PingFederate administrative API to manage the following configurations:
-
JIT provisioning settings in IdP connections
-
System → Data & Credential Stores → Identity Store Provisioners
-
System → Server → General Settings
-
System → Server → WS-Trust Settings
Other improvements
New
-
We significantly improved our metrics exposed through HTTP (at the heartbeat endpoint) and JMX to help you detect and diagnose performance issues. Both channels include HTTP response code counts, data source response time statistics, and Jetty queue size information; these metrics help troubleshoot latency issues associated with datastores or traffic volume.
-
PingFederate now uses OCSP to obtain certificate revocation status by default on new installations. As part of this enhancement, PingFederate uses the OCSP responder URL provided in the certificate first, followed by the now optional Default OCSP Responder URL, and lastly, CRL, making the certificate validation process more efficient.
-
The administrative console now provides guidance when you attempt to import a configuration archive obtained from a different version of PingFederate.
-
PingFederate 11.1 supports Amazon IAM roles for service accounts, which increases security posture with credential isolation and auditability.
-
PingOne Verify is now part of the PingFederate distribution
.zip
file and Windows installer. -
We also updated the following bundled components and third-party dependencies:
-
PingID Integration Kit 2.17
-
PingOne Fraud Integration Kit 1.0
-
PingOne Protect Integration Kit 1.2
-
Jackson-Databind 2.12.7
-
Log4j2 2.17.2
-
Spring Framework 5.3.20
-
A username in the URL during change password flows
Fixed PF-24501
The username no longer appears in the URL during change password flows.
OAuth client Issuer DN
Fixed PF-29368
If the administrative API was used to create an OAuth client that has the Client Certificate authentication type, and the client’s Issuer DN does not have a normalized DN value, the administrative console’s Client window no longer fails to show the Issuer DN as the default value. This issue didn’t affect runtime behavior.
Time stamp for last update
Fixed PF-29761
When a user record in a datastore mistakenly has a future date for the last update time, PingFederate no longer uses that date as the value of attrib_last_timestamp
in the channel_variable
table. Instead, PingFederate sets the value to the maximum time stamp that is not in the future.
Number and Boolean data types in JSON responses from REST API data source lookups
Fixed PF-29835
The JSON response from REST API data source lookups now retains number and Boolean data types instead of converting them to strings.
NotYetConnectedException
warning messages from JGroup in the server.log
Fixed PF-30075
Resolved an issue that caused the NotYetConnectedException
warning message to repeatedly appear in the server.log
when using AWS_PING for dynamic cluster discovery.
Matching OAuth client’s redirection URIs
Fixed PF-30146
If the OAuth client’s redirection URI contains a wild card in the authority part of the URI, and the redirect_uri
parameter of the token request contains userinfo in the authority part, then PingFederate will no longer consider the redirection URI a match.
Logging invalid assertion errors
Fixed PF-30495
In a specific case, when PingFederate logs an invalid assertion error, the error message no longer fails to include a remark about why the assertion or response is invalid.
Null pointer exception in authentication API password reset flow
Fixed PF-30558
When an OAuth client is performing a password reset through the authentication API, if PingFederate does not find any session attributes, now PingFederate logs an error state instead of a null pointer exception.
Determining authentication instants for flows
Fixed PF-30770
Resolved an issue that prevented PingFederate from correctly determining the authentication instant for the flow when the initial OIDC authorization request specifies a max_age, the flow falls through to legacy authentication source selection (policies are disabled or no policy applies), and the user chooses an upstream OIDC IdP connection.
Templates for PingOne MFA 1.6.1
Fixed PF-30806 PingOne MFA
PingFederate now includes all the templates for PingOne MFA 1.6.1.
Dependency errors for SAML token processors and generators
Fixed PF-31054
When saving SAML token processors or generators, PingFederate now correctly handles dependency errors caused by misconfigured settings on the Protocol Settings window’s Federation Info tab.
Preserving the order of map type configurations
Fixed PF-31145
Now PingFederate preserves the order of map type configurations under <pf_install>/pingfederate/server/default/data/config-store
when performing a bulk export or a GET operation at the /configStore
administrative API endpoint.
Warning about using the administrative console in multiple tabs
Fixed PF-31280
Now if you use the PingFederate administrative console in multiple tabs on one browser, it warns you that doing so might cause inconsistent behavior which could corrupt its configuration.
Saving authorization server settings overwrites scope.whitelist
Fixed PF-31304
Resolved an issue that caused PingFederate to overwrite the scope.whitelist
in the \data\config-store\org.sourceid.oauth20.domain.AuthzServerManagerImpl.xml
file when you save the authorization server settings.
OAuth client IDs added to admin.log entries
Fixed PF-31561
Now OAuth client MODIFY, CREATE, and DELETE event log entries in the admin.log
include the client ID.
Honoring the property for maximum HTTP request body size
Fixed PF-31575
Now PingFederate honors the value of http.maxRequestBodySize
in the run.properties
file, which specifies the maximum HTTP request body size of any incoming request to PingFederate’s web services and administrative API.
Administrative console and administrative API
Issue
-
/bulk: Only resource types currently supported by the administrative API are included in the exported data. We don’t intend to introduce administrative API support to the following areas:
-
Previously, the administrative API did not accurately reflect a Persistent Grant Max Lifetime setting of 29 days (or shorter) with the selection of the Grants Do Not Timeout Due To Inactivity option. As a result, if you have configured such OAuth authorization server settings and have generated a bulk export in version 10.0 through 10.0.2, we recommend that you re-generate a new bulk export after upgrading to version 10.0.3 (or a more recent version). The newly exported data does not contain the aforementioned flaw, and you can safely import it to version 10.0.3 (or a more recent version).
-
When enabling mutual TLS certificate-based authentication, administrators often configure a list of acceptable client certificate issuers. When you use a browser to access the console or the administrative API documentation, PingFederate returns to the browser the list of acceptable issuers as part of the TLS handshake. If the browser’s client certificate store contains multiple client certificates, the browser often presents you only the certificates whose issuer matches one of the acceptable issuers. However, when PingFederate runs in a Java 11 environment, Chrome presents you all its configured client certificates, regardless of whether the issuer matches one of the acceptable issuers or not.
-
Prior to toggling the status of a connection with the administrative API, you must ensure that any expired certificates or no longer available attributes are replaced with valid certificates or attributes; otherwise, the update request fails.
-
When creating or updating a child instance of a hierarchical plugin, the administrative API retains objects with an
"inherited": false
name/value pair (or without such name/value pair altogether), ignores those with a value oftrue
, and returns a 200 HTTP status code. No error messages are returned for the ignored objects. -
Using the browser’s navigation mechanisms (for example, the Back button) causes inconsistent behavior in the administrative console. Use the navigation buttons provided at the bottom of windows in the PingFederate console.
-
Using the PingFederate console in multiple tabs on one browser might cause inconsistent behavior which could corrupt its configuration.
-
If authenticated to the PingFederate administrative console using certificate authentication, a session that has timed out might not appear to behave as expected. Normally (when using password authentication), when a session has timed out and a user attempts some action in the console, the browser is redirected to the sign-on page, and then back to the administrative console after authentication is complete. Similar behavior applies for certificate authentication, in principle. However, because the browser might automatically resubmit the certificate for authentication, the browser might redirect to the administrative console and not the sign on page.
TLSv1.3
Issue
For Java versions that don’t support TLSv1.3 (meaning versions earlier than 8u261), PingFederate fails on start up with a NoSuchAlgorithmException
exception. To resolve this error, remove TLSv1.3
from the following settings in the run.properties
file:
-
pf.tls.client.protocols
-
pf.tls.runtime.server.protocols
-
pf.tls.admin.server.protocols
TLS cipher suite customization
Issue
PingFederate’s TLS cipher suites can be customized by modifying com.pingidentity.crypto.SunJCEManager.xml
(or a similarly-named file if BCFIPS or a hardware security module (HSM) is configured). After updating the file and replicating, all cluster nodes must be restarted for the change to take effect.
Java
Issue
-
As of PingFederate 11.1, BC-FIPS and HSMs are not supported when using Java 17.
-
Updating Java version 8 to version 11 results in an error when PingFederate is already installed and running. To work around this issue, uninstall and reinstall the PingFederate Windows service by running the
UninstallPingFederateService.bat
andInstallPingFederateService.bat
files located in<pf_install>/pingfederate/sbin/wrapper
.
Hardware security modules (HSM)
Issue
-
For Entrust HSMs, it is not possible to use an elliptic curve (EC) certificate as an SSL server certificate.
-
For Entrust HSMs, PingFederate must be deployed with Oracle Server JRE 8 or Amazon Corretto 8.
-
For keys stored in AWS CloudHSMs, JWT token signing fails when using RSASSA-PSS SHA-512.
-
For keys stored in Thales HSMs, JWT token decryption fails when using RSAES OAEP with AES-CBC-192 or AES-CBC-256. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys and is consuming a token encrypted with one of these keys.
-
When PingFederate is configured in hybrid mode with a Thales HSM, it is not possible to export a locally-stored EC key pair.
-
When PingFederate is configured in hybrid mode with a Thales HSM, JWT token decryption using ECDH-ES may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored locally, and PingFederate is consuming a token encrypted with this key.
-
TLS 1.3 is not currently supported with any HSM.
SSO and SLO
Issue
-
When consuming SAML metadata, PingFederate does not report an error when neither the
validUntil
nor thecacheDuration
attribute is included in the metadata. Note that PingFederate does reject expired SAML metadata as indicated by thevalidUntil
attribute value, if it is provided. -
The anchored-certificate trust model cannot be used with the Single log off (SLO) redirect binding because the certificate cannot be included with the logout request.
-
If an IdP connection is configured for multiple virtual server IDs, PingFederate will always use the default virtual server ID for IdP Discovery during an SP-initiated SSO event.
Composite Adapter configuration
Issue
SLO is not supported when users are authenticated through a Composite Adapter instance that contains another instance of the Composite Adapter.
Self-service password reset
Issue
Passwords can be reset for Microsoft Active Directory user accounts without the permission to change password.
OAuth
Issue
PingFederate does not support a case-sensitive naming convention for OAuth client ID values when client records are stored in a directory server. For example, after creating a client with an ID value of sampleClient
, PingFederate does not allow the creation of another client with an ID value of SampleClient
.
Although it’s possible to create clients using the same ID values with different casings when client records are stored in XML files, a database server, or custom storage, we recommend not doing so to avoid potential record migration issues.
Customer identity and access management
Issue
Some browsers display a date-picker user interface for fields that have been designed for date-specific inputs. Some browsers do not. If one or more date-specific fields are defined on the registration page or the profile management page (or both), end users must enter the dates manually if their browsers do not display a date-picker user interface for those fields.
Provisioning
Issue
-
LDAP referrals return an error and cause provisioning to fail if the
user
orgroup
objects are defined at the DC level, and not within an OU or within the Users CN. -
The
totalResults
value in SCIM responses indicates the number of results returned in the current response, not the total number of estimated results on the LDAP server.
Logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
Database logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
RADIUS NAS-IP-Address
Issue
The RADIUS NAS-IP-Address is only included in Access-Request packets when the pf.bind.engine.address
is set with an IPv4 address. IPv6 is not supported.
Microsoft Internet Explorer 11
Info
Ping Identity commits to deliver the best experience for administrators and users. As we continue to improve our products, we encourage you to migrate off of Microsoft Internet Explorer 11. Starting with PingFederate 11.0, Internet Explorer 11 is no longer included in the PingFederate qualification process for administrators or users. For a list of supported browsers, see System requirements.
Configcopy tool, Connection Management Service, SSO Directory Service
Info
As of PingFederate 10.2, these features have been deprecated and will be removed in a future release.
Oracle Directory Server Enterprise Edition
Info
As Oracle ended its Premier Support for Oracle Directory Server Enterprise Edition (ODSEE 11g) in December 2019, we no longer include ODSEE as part of the PingFederate qualification process (starting with PingFederate 10.2). We continue to qualify against Oracle Unified Directory (www.oracle.com/middleware/technologies/unified-directory.html) and other supported directory servers. For a full list, see System requirements.
SNMP
Info
Starting with PingFederate 10.2, monitoring and reporting through the Simple Network Management Protocol (SNMP) has been removed.
Roles and protocols
Info
Starting with PingFederate 10.1, roles and protocols are always enabled and no longer configurable through the administrative console and API.
PingFederate 11.0.10 - April 2024
Rest datastore security vulnerability
Security PF-34720
Fixed a JSON injection vulnerability in REST datastores described in security advisory SECADV044.
Runtime nodes security vulnerability
Security PF-34896
Fixed a path traversal vulnerability in Runtime nodes described in security advisory SECADV044.
OpenID Connect policy management editor security vulnerability
Security PF-35081
Fixed a Cross-Site Scripting vulnerability in the OpenID Connect Policy Management Editor described in security advisory SECADV044.
PingFederate 11.0.9 - December 2023
For a summary of the features introduced in the 11.0 release, see PingFederate 11.0 - December 2021.
Ticket ID | Description |
---|---|
PF-34646 |
Fixed a Server-Side Request Forgery vulnerability in the Initial Setup Wizard described in security advisory SECADV041. |
PingFederate 11.0.8 (August 2023)
PingFederate 11.0.7 (February 2023)
Server log warnings
Fixed PF-33037
We’ve added a warning to server logs if the ds-pwp-state-json attribute is not present in PingDirectory’s LDAP Response. This warning appears in the log every time a user interacts with the profile management page. Please enable this attribute to adhere to PingDirectory’s security configuration best practices. PingDirectory version 8.1 and later supports this attribute, and customers running older versions are encouraged to upgrade to a supported version as soon as possible.
PingFederate 11.0.6 (February 2023)
Potential security vulnerability
Fixed PF-32805
We’ve resolved a potential security vulnerability that is described in security advisory SECADV033.
PingFederate 11.0.5 (October 2022)
IPV6 address issue
Fixed PF-31735
Resolved an issue that sometimes occurred when IPV6 addresses were specified in the HTTP Header for Client IP Addresses field on the Incoming Proxy Settings window.
PingFederate 11.0.4 (August 2022)
New features and improvements in PingFederate 11.0.4.
MasterKeyEncryptor and cluster replication
Fixed PF-31795
When PingFederate uses a custom MasterKeyEncryptor that relies on an SSL call to an external service, cluster replication no longer causes cascading failures because PingFederate cannot open Java key store files.
Rule matching for fragment nodes and NullPointerException
Fixed PF-31929
When using rule matching for fragment nodes, PingFederate no longer raises a NullPointerException (NPE) if a fragment fails.
Zero byte archives
Fixed PF-31966
Resolved an issue that caused PingFederate to generate a zero byte archive when it couldn’t read a file in the <pf_install>/pingfederate/server/default/data
directory.
JWT access token lifetimes
Fixed PF-31989
When using centralized and dynamically rotating keys for OAuth and OpenID Connect, PingFederate now prevents you from setting the JWT access token lifetime to be longer than the dynamic-rotation-period-in-days
specified in <pf_install>/pingfederate/server/default/data/config-store/jwks-endpoint-configuration.xml
.
PingFederate 11.0.3 (May 2022)
New features and improvements in PingFederate 11.0.3.
Intermittent failure to respond after restart caused by LDAP SDK
Fixed PF30776
To resolve an issue in which PingFederate occasionally stopped responding after a restart, the UnboundID LDAP SDK for Java was updated to version 6.0.4.
PingFederate 11.0.2 (March 2022)
New features and improvements in PingFederate 11.0.2.
Updated PingOne MFA adapter
Info PingOne MFA
Updated the bundled PingOne MFA adapter to version 1.6.
LDAP connections
Fixed PF-30804
Resolved an issue that caused LDAP connections to periodically fail during provisioning.
Bulk export
Fixed PF-30863
Bulk export no longer fails to include all XML OAuth clients in the response payload.
Single sign-on from browsers on iOS
Fixed PF-31057
Resolved an issue that caused single sign-on from browsers on iOS to fail when an authentication policy terminates on Kerberos Adapter fallback that has an existing session.
nCipher mode
Fixed PF-31064
When running PingFederate in nCipher mode, now the administrative API successfully generates elliptic curve (EC) keys when the optional signatureAlgorithm field is not provided.
TLS 1.3 for inbound connections
Fixed PF-31112
PingFederate now supports TLS 1.3 for inbound connections when running on Java 8 versions 8u261 and newer.
Symantec VIP Adapter
Fixed PF-31123
Resolved an issue that prevented PingFederate from using the Symantec VIP Adapter.
Signature verification for certificate revocation lists
Fixed PF-31159
Resolved an issue where signature verification for certificate revocation lists could take more than 10 seconds on Windows. When LDAP-based authentication was enabled in the administrative console, this could prevent administrative users from signing on.
PingFederate 11.0.1 (January 2022)
New features and improvements in PingFederate 11.0.1.
Rolling grace period for refresh tokens
Improved
When PingFederate rotates a refresh token, if the client fails to get the new token, now PingFederate can accept the previous token for the short period that you specify with the Refresh Token Rolling Grace Period setting.
Performance improvement
Info
Improved performance of the administrative console when a large number of OAuth clients are stored in LDAP or JDBC datastores.
URL region of the PingOne home button
Info PingOne
When configuring the URL of the PingOne home button in the PingFederate administrative console, now pf.pingone.admin.url.region
in run.properties
supports Canada
as a region.
AWS CloudHSM client
Info
PingFederate can be successfully integrated with AWS CloudHSM client version 3.4.4.
Resolved a potential security vulnerability
Security PF-30450
Resolved a potential security vulnerability that is described in security bulletin SECBL021.
Updated Apache Log4j2
Security PF-30536
Resolved a potential security vulnerability by updating Apache Log4j2 to version 2.17.1.
PingFederate 11.0 (December 2021)
New features and improvements in PingFederate 11.0.
PingOne LDAP Gateway datastore
New PingOne
PingFederate in the cloud can now connect to on-premise directory servers through the PingOne LDAP Gateway. This new capability reduces the complexity of moving to the cloud, while maintaining connectivity to on-premise end-user data.
PingOne unified admin integration
New PingOne
Administrators can now open the PingOne unified admin from any configuration window in the PingFederate administrative console. To activate the new Home icon, enter the PingOne region and the environment ID in the run.properties
file.
Management of configuration encryption keys
New
PingFederate maintains a set of configuration encryption keys to encrypt sensitive configuration information provided by the administrators and decrypt them later as needed. While we continue recommending customers to protect their configuration encryption keys by AWS KMS or custom solutions based on the PingFederate SDK (the MasterKeyEncryptor
interface), we are introducing two enhancements in this area.
-
Key rotatation: Administrators or key-management processes can now insert a new configuration encryption key into the system with one click in the administrative console or a single administrative API request. Once rotated, PingFederate starts using this new encryption key when it needs to encrypt sensitive configuration data.
-
Re-encryption of configuration data: Version 11 also comes with a new
configkeymgr
command-line utility. Administrators can optionally scan, review, re-encrypt, and delete older configuration encryption keys in their systems. Furthermore, administrators can now choose to re-encrypt sensitive information when importing an archive from a different environment; this is most useful when administrators do not want to share configuration encryption keys between the two environments.
Secret Managers
New
The new Secret Managers support allows customers to store certain credentials, such as data store credentials, in external secret management systems and have PingFederate retrieve them as needed. It helps customers comply with internal IT policies or meet and exceed their industry standards. Version 11 integrates out-of-the-box with CyberArk Credential Provider. Customers can also develop custom solutions based on the PingFederate SDK (the SecretManager
interface), to connect to other secret management systems.
FAPI 1 Advanced Final certifications
New
Ping Identity remains a solid contributor to the financial-grade API initiatives from the OpenID Foundation. We’re proud that PingFederate is a certified implementation of various FAPI 1 Advanced Final profiles, including all profiles under Australia CDR and UK Open Banking and four profiles under Brazil Open Banking. Deploy Open Banking solutions with confidence and rest assured that we will continue to invest in OAuth, OpenID Connect, and FAPI specifications. For more information about OpenID certifications, visit https://openid.net/certification/#FAPI_OPs.
Flexibility in ID token issuance
New
When processing an OpenID Connect hybrid flow, in addition to issuing an ID token from the token endpoint, PingFederate may also return an ID token from the authorization endpoint, depending on the requested response type. Administrators now have the flexibility to separate these two ID token issuances and configure their fulfillment differently. These enhancements allow our customers to comply with the regulatory requirements and open standards set by the Australian CDR and FAPI specifications.
Encrypted request objects
New
PingFederate now supports encrypted request objects that OAuth clients send to its Authorization endpoint and the Pushed Authorization Requests (PAR) endpoint. As needed, administrators can make encrypted request objects mandatory. This new capability further secures the confidentiality of authentication request parameters.
Authorization server issuer identification
New
The OAuth 2.0 Authorization Server Issuer Identification draft specification intends to mitigate the scenario where mix-up attacks are a potential threat to all OAuth clients interacting with multiple authorization servers. As needed, administrators can enable this optional capability.
Better private key JWT validation
New
In the context of OAuth client authentication, when processing private key JWTs from applications, PingFederate now ensures that the issuer (iss
) claim value matches the client ID. This enhancement removes the need to use issuance criteria to enforce this validation requirement.
Message customization in OIDC IdP connection
New
PingFederate 11 can now take the request parameters from the SAML 2.0 SP or the OpenID Connect relying party (OIDC RP) into account when building its OIDC authentication request to the third-party OpenID Provider (OP). This capability allows administrators to selectively configure the values in the outbound OIDC authentication requests if their use cases or the third-party OPs have the need to gather more information from the originating SP or RP.
Multi-valued attribute format
New
Administrators can optionally indicate that PingFederate should always return an array for an attribute value regardless of whether the attribute contains one or multiple values. This flexibility simplifies the logic required to consume attribute values from access tokens or ID tokens.
Streamlined initial setup experience
New
We’re pleased to introduce a brand new initial setup experience, where administrators can finish their initial setup in as little as four steps, rapidly making our rock-solid capabilities available after starting PingFederate for the first time.
Individual policy management by API
New
Administrators can now focus solely on one policy without including other policies as part of the API request when managing an individual authentication policy through the administrative API. This simplification improves the API experience and eliminates the risk of making unexpected changes in other authentication policies.
Console heartbeat
New
Monitoring the status of the console node is now more straightforward with the addition of the /pf/heartbeat.ping
heartbeat endpoint to the administrative port. Like its runtime counterpart, the administrative heartbeat endpoint is also capable of returning additional information. If administrators want detailed information in the responses, set the pf.heartbeat.system.monitoring
property to true
in the run.properties
file.
Datastore enhancements
New
-
We expanded the REST API datastore with HTTP POST support. Administrators can connect to data repositories that prefer or require the HTTP POST method.
-
Administrators can add attribute options in their LDAP directory searches. This enhancement expands what PingFederate can retrieve from the directory servers that support attribute options, PingDirectory being one of them.
-
When configuring an LDAP search filter that uses one or more variables, an administrator can optionally specify default values for them, most useful in the scenarios where these variables may not contain any values at runtime.
Migration of templates
New
Our upgrade tools now copy customized default templates from the previous installation to the new one. This improvement preserves the end-user experience and branding, making it easier to verify and move forward with version 11 and beyond.
New configuration for dynamic discovery settings
New
Previously, administrators could only define dynamic discovery settings to discover cluster membership in the server/default/conf/tcp.xml
file. Version 11 provides a new configuration file for these settings, jgroups.properties
in the bin
directory. This new approach streamlines future upgrade experiences. For new installations, we recommend defining dynamic discovery settings in the jgroups.properties
file. While upgraded environments will continue to look for dynamic discovery settings from the tcp.xml
file, we recommend performing a one-time migration to ease the upgrade experiences in the future.
Email ownership verification by OTP
New
For customer identities, in addition to email ownership verification by one-time link, administrators can now enable email ownership verification by one-time passcode (OTP). This new option offers a modern verification experience. It also helps customers who prefer not to send hyperlinks via email to their consumers.
Request context to authentication API applications
New
Administrators can optionally configure PingFederate to pass contextual information, such as the OAuth client ID or tracked HTTP parameters, from the sign-on requests to the authentication API applications. This allows developers to build applications that offer tailored experiences and satisfy branding requirements from their organizations based on contextual information from the sign-on requests.
Kerberos authentication improvement
New
Administrators can now ensure Kerberos authentication remains functional for service tickets associated with older Kerberos service account passwords after updating the Domain/Realm Password field with a new password in PingFederate. This optional capability increases productivity because workforce identities are no longer required to restart their Windows sessions in order to authenticate via Kerberos.
Contextual information in Session Management API responses
New
The Session Management API now includes IP address and User-Agent information in its responses. Clients with access to this API can learn more about their users and provide suitable offerings based on this new insight.
Security enhancements
New
-
PingFederate now supports Amazon EC2 Instance Metadata Service version 2 (IMDSv2) when AWS_PING is the chosen dynamic discovery method. No PingFederate configuration changes are required, and IMDSv1 remains supported.
-
PingFederate now records administrative timed-out events in the administrator audit log (
admin.log
). -
The Change Password and Password Reset end user-facing pages now time out after 30 minutes. This is the new default behavior for new and upgraded installations. As needed, administrators can configure a different Password Update Timeout value per HTML Form Adapter instance to suit the needs of their organizations.
Other improvements
New
-
PingFederate now includes HTTP/2 support for inbound requests for better performance.
-
Administrators can optionally configure PingFederate to mask values obtained from tracked parameters in the server log. Look for the
MaskTrackedParams
setting in theorg.sourceid.saml20.domain.mgmt.impl.TrackedHttpParamManagerImpl.xml
file. -
Administrators are free to enable the refresh token grant type independently on a per-client basis regardless of whether session validation is enabled in any Access Token Managers.
-
Administrators can optionally configure PingFederate to redirect end-users back to the Sign On page after successfully updating their soon-to-expire password as part of their SSO requests.
-
The Reuse Existing Persistent Access Grants for Grant Types authorization server setting is now overridable per client.
-
PingFederate now supports RSAES OAEP using SHA-256 and MGF1 with SHA-256 (RSA-OAEP-256) when minting outbound ID tokens or processing inbound encrypted request objects
-
Administrators can optionally restrict access to the redirectless mode per authentication API application. Additionally, administrators can further limit each application to an OAuth client to improve security around the redirectless mode of the authentication API.
-
We upgraded the framework of our administrative API documentation to Swagger 2.0.
-
PingFederate now preserves line breaks and indentations of OGNL expressions.
-
The following templates now share the following Velocity template variables, which makes branding end-user experiences easier.
Templates Variables -
identifier.first.template.html
-
html.form.login.challenge.template.html
-
html.form.login.template.html
-
html.form.message.template.html
-
html.form.password.expiring.notification.template.html
-
$client_id
- The ID of the OAuth client used by the request -
$entityId
- The entity ID of the SP connection used by the request -
$connectionName
- The name of the SP connection used by the request -
$baseUrl
- The base URL of PingFederate instance -
$adapterId
- The IdP adapter ID used by the request -
$spAdapterId
- The SP adapter ID used by the request
-
-
Updated the following bundled components and third-party dependencies:
-
Jetty 9.4.44
-
JGroups 4.2.16
-
jose4j 0.7.9
-
Log4j 2.16.0
-
PingFederate Agentless Integration Kit 2.0.4
-
PingID Integration Kit 2.15.0
-
PingOne Integration Kit 2.4.1
-
Spring Framework 5.3.5
-
Cluster dynamic OAuth/OpenID Connect keys
Fixed PF-20709
Resolved an issue that sometimes caused a cluster’s dynamic OAuth/OpenID Connect keys to fail to synchronize when a node restarts.
Provisioning
Fixed PF-27519
Resolved an issue that prevented a PingFederate provisioner from using a group of GUIDs as the source to detect new and removed records.
Configuring the favicon.ico
URL
Fixed PF-28074
Now PingFederate correctly applies customizations of response-header-runtime-config.xml
to the favicon.ico
URL.
Retrieving OAuth clients from Oracle databases
Fixed PF-28842
Reduced the time it takes for PingFederate to retrieve OAuth clients from Oracle databases.
Unnecessary dependency error banners
Fixed PF-29189
Unnecessary dependency error banners no longer appear in the administrative console when you use the administrative API to modify selectors or service provider adapters.
Localizing end user messages from the authentication API
Fixed PF-29202
Now you can localize end user messages from the authentication API for registration failure scenarios.
Device authorization flow using IdP connection OAuth attribute mapping
Fixed PF-29294
Resolved an issue that stopped PingFederate from completing a device authorization flow when using IdP connection OAuth attribute mapping.
Multiple Sign-On Delay template redirects
Fixed PF-29318
When a proxy is in front of PingFederate, the Multiple Sign-On Delay template now redirects to the correct port.
Logging [.codeph]``XMLCipher::decryptElement called without a key and unable to
resolve`` [.ping_changetype-fixed]#Fixed# [.ping_ticket]#PF-29352#
As a service provider (SP), when PingFederate can’t decrypt an assertion using the primary encryption certificate, it now logs the following message at the WARN level instead of the ERROR level: "XMLCipher::decryptElement called without a key and unable
to resolve
".
Security vulnerability
Fixed PF-29381
Resolved a potential security vulnerability caused by web server URI mishandling.
Response headers for /pf-ws
and /pf-scim
endpoints
Fixed PF-29392
Introduced the ability to add response headers to the /pf-ws
and /pf-scim
endpoints.
Upgrade utility
Fixed PF-29470
Fixed the upgrade utility so that, in non-interactive mode, it retains cipher related settings that are different from the default settings in the source version. PingFederate changes to new default settings on upgrade only if the settings have not been changed from the defaults in the source install.
Custom template specified for the HTML Form Adapter
Fixed PF-29509
Resolved an issue that caused PingFederate to render the default forgot-password-error.html
template instead of the custom template specified in the Password Reset Error Template field for the HTML Form Adapter.
Partial matches for resource URIs with OAuth 2.0 Token Exchange
Fixed PF-29668
Resolved an issue that prevented the use of partial matches for resource URIs with OAuth 2.0 Token Exchange and produced the error message: "Unable to find a token generation policy instance to issue
a token
".
Adding attributes to data source lookups
Fixed PF-29795
Now, when administrators add an attribute to a data source lookup but do not use the attribute anywhere, such as for contract mapping or issuance criteria, the attribute persists in the administrative console and API.
Microsoft Active Directory LDIF script for persistent grant storage
Fixed PF-29847
The Microsoft Active Directory LDIF script for persistent grant storage now creates an index for the accessGrantGuid
attribute.
Notification publisher
Fixed PF-29870
Resolved the following notification publisher issues:
-
When the SMTP server queues a message but has not sent it yet, the log now indicates that the message was queued, not that it was sent.
-
PingFederate now respects the Connection Timeout setting for the notification publisher’s SMTP server.
-
Deprecated the Retry Attempt and Retry Delay fields for the notification publisher’s SMTP server and removed them from the administrative console. PingFederate can still handle API configurations with those fields but they do nothing.
Target resources that don’t start with http://
or https://
Fixed PF-30002
Now target resources that don’t start with http://
or https://
are also available for mapping and issuance criteria.
Response code for an invalid transport method
Fixed PF-30039
Now various endpoints return 400 Bad Request
instead of 500 Internal Server Error
when they receive requests with an invalid transport method. For example, calling the ACS endpoint with a GET
instead of a POST
now returns 400 Bad Request
.
Custom IDP adapters that use the class for filterable dropdown controls
Fixed PF-30232
The administrative console no longer shows an error message when you try to create an instance of a custom IDP adapter that uses the class for filterable dropdown controls, ConnectionSelectionFieldDescriptor
.
Memory usage during certificate revocation list (CRL) parsing
Fixed PF-30272
Reduced memory usage during certificate revocation list (CRL) parsing, which speeds up CRL retrieval and avoids memory exhaustion in the case of very large CRLs.
Administrative console and administrative API
Issue
-
/sp/idpConnections: For identity provider (IdP) connections, the administrative API connection support is limited to Browser SSO, WS-Trust STS, and OAuth Assertion Grant connections. As a result, when updating an IdP connection using the administrative API, it is possible to lose inbound provisioning settings previously configured using the administrative console.
-
/bulk: Only resource types currently supported by the administrative API are included in the exported data. Resources not yet supported include:
-
Identity Store Provisioners
-
Inbound provisioning settings from IdP connections
-
SMS Provider settings
-
-
Previously, the administrative API did not accurately reflect a Persistent Grant Max Lifetime setting of 29 days (or shorter) with the selection of the Grants Do Not Timeout Due To Inactivity option. As a result, if you have configured such OAuth authorization server settings and have generated a bulk export in version 10.0 through 10.0.2, we recommend that you re-generate a new bulk export after upgrading to version 10.0.3 (or a more recent version). The newly exported data does not contain the aforementioned flaw, and you can safely import it to version 10.0.3 (or a more recent version).
-
When enabling mutual TLS certificate-based authentication, administrators often configure a list of acceptable client certificate issuers. When an administrator uses a browser to access the console or the administrative API documentation, PingFederate returns to the browser the list of acceptable issuers as part of the TLS handshake. If the browser’s client certificate store contains multiple client certificates, the browser often presents to the user only the certificates whose issuer matches one of the acceptable issuers. However, when PingFederate runs in a Java 11 environment, Chrome presents to the administrator all its configured client certificates, regardless of whether the issuer matches one of the acceptable issuers or not.
-
Prior to toggling the status of a connection with the administrative API, an administrator must ensure that any expired certificates or no longer available attributes are replaced with valid certificates or attributes; otherwise, the update request fails.
-
When creating or updating a child instance of a hierarchical plugin, the administrative API retains objects with an
"inherited": false
name/value pair (or without such name/value pair altogether), ignores those with a value oftrue
, and returns a 200 HTTP status code. No error messages are returned for the ignored objects. -
Using the browser’s navigation mechanisms (for example, the Back button) causes inconsistent behavior in the administrative console. Use the navigation buttons provided at the bottom of windows in the PingFederate console.
-
Using the PingFederate console in multiple tabs on one browser might cause inconsistent behavior which could corrupt its configuration.
-
If authenticated to the PingFederate administrative console using certificate authentication, a session that has timed out might not appear to behave as expected. Normally (when using password authentication), when a session has timed out and a user attempts some action in the console, the browser is redirected to the login page, and then back to the administrative console after authentication is complete. Similar behavior applies for certificate authentication, in principle. However, because the browser might automatically resubmit the certificate for authentication, the browser might redirect to the administrative console and not the login page.
TLSv1.3
Issue
For Java versions that don’t support TLSv1.3 (meaning versions earlier than 8u261), PingFederate fails on start up with a NoSuchAlgorithmException
exception. To resolve this error, remove TLSv1.3
from the following settings in the run.properties
file:
-
pf.tls.client.protocols
-
pf.tls.runtime.server.protocols
-
pf.tls.admin.server.protocols
TLS cipher suite customization
Issue
PingFederate’s TLS cipher suites can be customized by modifying com.pingidentity.crypto.SunJCEManager.xml
(or a similarly-named file if BCFIPS or a hardware security module (HSM) is configured). After updating the file and replicating, all cluster nodes must be restarted for the change to take effect.
Updating Java 8 to Java 11
Issue
Updating Java version 8 to version 11 results in an error when PingFederate is already installed and running. To work around this issue, uninstall and reinstall the PingFederate Windows service by running the UninstallPingFederateService.bat
and InstallPingFederateService.bat
files located in <pf_install>/pingfederate/sbin/wrapper
.
Hardware security modules (HSM)
Issue
-
For Entrust HSMs or AWS CloudHSM, PingFederate must be deployed with Oracle Server JRE 8 or Amazon Corretto 8.
-
For Entrust HSMs, it is not possible to use an elliptic curve (EC) certificate as an SSL server certificate.
-
For keys stored in Thales HSMs, JWT token decryption fails when using RSAES OAEP with AES-CBC-192 or AES-CBC-256. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys and is consuming a token encrypted with one of these keys.
-
When PingFederate is configured in hybrid mode with a Thales HSM, it is not possible to export a locally-stored EC key pair.
-
When PingFederate is configured in hybrid mode with a Thales HSM, JWT token decryption using ECDH-ES may fail. This issue only arises if PingFederate is configured with static OAuth and OpenID Connect keys, a static key is stored locally, and PingFederate is consuming a token encrypted with this key.
-
TLS 1.3 is not currently supported with any HSM.
SSO and SLO
Issue
-
When consuming SAML metadata, PingFederate does not report an error when neither the
validUntil
nor thecacheDuration
attribute is included in the metadata. Note that PingFederate does reject expired SAML metadata as indicated by thevalidUntil
attribute value, if it is provided. -
The anchored-certificate trust model cannot be used with the SLO redirect binding because the certificate cannot be included with the logout request.
-
If an IdP connection is configured for multiple virtual server IDs, PingFederate will always use the default virtual server ID for IdP Discovery during an SP-initiated SSO event.
Composite Adapter configuration
Issue
SLO is not supported when users are authenticated through a Composite Adapter instance that contains another instance of the Composite Adapter.
Self-service password reset
Issue
Passwords can be reset for Microsoft Active Directory user accounts without the permission to change password.
OAuth
Issue
PingFederate does not support a case-sensitive naming convention for OAuth client ID values when client records are stored in a directory server. For example, after creating a client with an ID value of sampleClient
, PingFederate does not allow the creation of another client with an ID value of SampleClient
.
Although it’s possible to create clients using the same ID values with different casings when client records are stored in XML files, a database server, or custom storage, we recommend not doing so to avoid potential record migration issues.
Customer identity and access management
Issue
Some browsers display a date-picker user interface for fields that have been designed for date-specific inputs. Some browsers do not. If one or more date-specific fields are defined on the registration page or the profile management page (or both), end users must enter the dates manually if their browsers do not display a date-picker user interface for those fields.
Provisioning
Issue
-
LDAP referrals return an error and cause provisioning to fail if the
user
orgroup
objects are defined at the DC level, and not within an OU or within the Users CN. -
The
totalResults
value in SCIM responses indicates the number of results returned in the current response, not the total number of estimated results on the LDAP server.
Logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
Database logging
Issue
-
If a source attribute has been configured for masking in an IdP adapter or IdP connection and the source attribute is mapped to OAuth’s persistent grant
USER_KEY
attribute, theUSER_KEY
attribute will not be masked in the server logs. Other persistent grant attributes will be masked. -
Even if a source attribute has been configured for masking in an IdP adapter and the source attribute is mapped as the adapter’s unique user key, the user key attribute is not masked in the server or audit logs.
Microsoft Internet Explorer 11
Info
Ping Identity commits to deliver the best experience for administrators and users. As we continue to improve our products, we encourage our customers to migrate off of Microsoft Internet Explorer 11. Starting with PingFederate 11.0, Internet Explorer 11 is no longer included in the PingFederate qualification process for administrators or users. For a list of supported browsers, see System requirements.
Configcopy tool, Connection Management Service, SSO Directory Service
Info
As of PingFederate 10.2, these features have been deprecated and will be removed in a future release.
Oracle Directory Server Enterprise Edition
Info
As Oracle ended its Premier Support for Oracle Directory Server Enterprise Edition (ODSEE 11g) in December 2019, we no longer include ODSEE as part of the PingFederate qualification process (starting with PingFederate 10.2). We continue to qualify against Oracle Unified Directory (www.oracle.com/middleware/technologies/unified-directory.html) and other supported directory servers. For a full list, see System requirements.
SNMP
Info
Starting with PingFederate 10.2, monitoring and reporting through the Simple Network Management Protocol (SNMP) has been removed.
Roles and protocols
Info
Starting with PingFederate 10.1, roles and protocols are always enabled and no longer configurable through the administrative console and API.