Update Gradle/NPM, dependencies, Keycloak to v26.1.0 #5050
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/gradlenpm-dependencies-keycloak
branch
from
bbc4db5 to
0d06d59
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
26.0.7->26.1.026.0.7->26.1.0Release Notes
keycloak/keycloak-nodejs-connect (keycloak-connect)
v26.1.0Compare Source
v26.0.8Compare Source
keycloak/keycloak (keycloak-js)
v26.1.0Compare Source
Highlights
Transport stack
jdbc-pingas new defaultKeycloak now uses by default its database to discover other nodes of the same cluster, which removes the need of additional network related configurations especially for cloud providers. It is also a default that will work out-of-the-box in cloud environments.
Previous versions of Keycloak used as a default UDP multicast to discover other nodes to form a cluster and to synchronize the replicated caches of Keycloak. This required multicast to be available and to be configured correctly, which is usually not the case in cloud environments.
Starting with this version, the default changes to the
jdbc-pingconfiguration which uses Keycloak’s database to discover other nodes. As this removes the need for multicast network capabilities and UDP and no longer using dynamic ports for the TCP-based failure detection, this is a simplification and a drop-in replacement for environments which used the previous default. To enable the previous behavior, choose the transport stackudpwhich is now deprecated.The Keycloak Operator will continue to configure
kubernetesas a transport stack.See the Configuring distributed caches guide for more information.
Virtual Threads enabled for Infinispan and JGroups thread pools
Starting from this release, Keycloak automatically enables the virtual thread pool support in both the embedded Infinispan and JGroups when running on OpenJDK 21. This removes the need to configure the JGroups thread pool, the need to align the JGroups thread pool with the HTTP worker thread pool, and reduces the overall memory footprint.
OpenTelemetry Tracing supported
In the previous release, the OpenTelemetry Tracing feature was preview and is fully supported now. It means the
opentelemetryfeature is enabled by default.There were made multiple improvements to the tracing capabilities in Keycloak such as:
Configuration via Keycloak CR in Keycloak Operator
Custom spans for:
Incoming/outgoing HTTP requests including Identity Providers brokerage
Database operations and connections
LDAP requests
Time-consuming operations (passwords hashing, persistent sessions operations, …​)
For more information, see the Enabling Tracing guide.
Infinispan default XML configuration location
Previous releases ignored any change to
conf/cache-ispn.xmlif the--cache-config-fileoption was not provided.Starting from this release, when
--cache-config-fileis not set, the default Infinispan XML configuration file isconf/cache-ispn.xmlas this is both the expected behavior and the implied behavior given the docs of the current and previous releases.Individual options for category-specific log levels
It is now possible to set category-specific log levels as individual
log-level-categoryoptions.For more details, see the Logging guide.
OpenID for Verifiable Credential Issuance
The OpenID for Verifiable Credential Issuance (OID4VCI) remains an experimental feature in Keycloak, but it has great improvements in this release. This feature benefits from much polishing of the existing configuration and making the feature more dynamic and customizable.
You will find significant development and discussions in the Keycloak OAuth SIG. Anyone from the Keycloak community is welcome to join.
Many thanks to all members of the OAuth SIG group for the participation in the development and discussions about this feature. Especially thanks to Francis Pouatcha, Ingrid Kamga, Pascal Knüppel, Thomas Darimont, Ogen Bertrand, Awambeng Rodrick and Takashi Norimatsu.
Minimum ACR Value for the client
The option Minimum ACR value is added as a configuration option on the realm OIDC clients. This addition is an enhancement related to step-up authentication, which makes it possible to enforce minimum ACR level when logging in to the particular client.
Many thanks to Simon Levermann for the contribution.
Support for prompt=create
Support now exists for the Initiating user registration standard, which allows OIDC clients to initiate the login request with the parameter
prompt=createto notify Keycloak that a new user should be registered rather than an existing user authenticated. Initiating user registration was already supported in Keycloak with the use of dedicated endpoint/realms/<realm>/protocol/openid-connect/registrations. However, this endpoint is now deprecated in favor of the standard way as it was a proprietary solution specific to Keycloak.Many thanks to Thomas Darimont for the contribution.
Option to create certificates for generated EC keys
A new option, Generate certificate, exists for EC-DSA and Ed-DSA key providers. When the generated key is created by a realm administrator, a certificate might be generated for this key. The certificate information is available in the Admin Console and in the JWK representation of this key, which is available from JWKS endpoint with the realm keys.
Many thanks to Pascal Knüppel for the contribution.
Authorization Code Binding to a DPoP Key
Support now exists for Authorization Code Binding to a DPoP Key including support for the DPoP with Pushed Authorization Requests.
Many thanks to Takashi Norimatsu for the contribution.
Maximum count and length for additional parameters sent to OIDC authentication request
The OIDC authentication request supports a limited number of additional custom parameters of maximum length. The additional parameters can be used for custom purposes (for example, adding the claims into the token with the use of the protocol mappers). In the previous versions, the maximum count of the parameters was hardcoded to 5 and the maximum length of the parameters was hardcoded to 2000. Now both values are configurable. Additionally it can be possible to configure if additional parameters cause a request to fail or if parameters are ignored.
Many thanks to Manuel Schallar and Patrick Weiner for the contribution.
Network Policy support added to the Keycloak Operator
To improve the security of your Kubernetes deployment, Network Policies can be specified in your Keycloak CR. The Keycloak Operator accepts the ingress rules, which define from where the traffic is allowed to come from, and automatically creates the necessary Network Policies.
LDAP users are created as enabled by default when using Microsoft Active Directory
If you are using Microsoft AD and creating users through the administrative interfaces, the user will be created as enabled by default.
In previous versions, it was only possible to update the user status after setting a (non-temporary) password to the user. This behavior was not consistent with other built-in user storages as well as not consistent with other LDAP vendors supported by the LDAP provider.
New conditional authenticators
Condition - sub-flow executedandCondition - client scopeThe Condition - sub-flow executed and Condition - client scope are new conditional authenticators in Keycloak. The condition Condition - sub-flow executed checks if a previous sub-flow was executed (or not executed) successfully during the authentication flow execution. The condition Condition - client scope checks if a configured client scope is present as a client scope of the client requesting authentication. For more details, see Conditions in conditional flows.
Defining dependencies between provider factories
When developing extensions for Keycloak, developers can now specify dependencies between provider factories classes by implementing the method
dependsOn()in theProviderFactoryinterface. See the Javadoc for a detailed description.Dark mode enabled for the welcome theme
We’ve now enabled dark mode support for all the
keycloakthemes. This feature was previously present in the admin console, account console and login, and is now also available on the welcome page. If a user indicates their preference through an operating system setting (e.g. light or dark mode) or a user agent setting, the theme will automatically follow these preferences.If you are using a custom theme that extends any of the
keycloakthemes and are not yet ready to support dark mode, or have styling conflicts that prevent you from implementing dark mode, you can disable support by adding the following property to your theme:Alternatively, you can disable dark mode support for the built-in Keycloak themes on a per-realm basis by turning off the Dark mode setting under the Theme tab in the realm settings.
Metrics on password hashing
There is a new metric available counting how many password validations were performed by Keycloak. This allows you to better assess where CPU resources are used, and can feed into your sizing calculations.
See Keycloak metrics and Concepts for sizing CPU and memory resources for more details.
Sign out all active sessions in admin console now effectively removes all sessions
In previous versions, clicking on Sign out all active sessions in the admin console resulted in the removal of regular sessions only. Offline sessions would still be displayed despite being effectively invalidated.
This has been changed. Now all sessions, regular and offline, are removed when signing out of all active sessions.
Dedicated release cycle for the Node.js adapter and JavaScript adapter
From this release onwards, the Keycloak JavaScript adapter and Keycloak Node.js adapter will have a release cycle independent of the Keycloak server release cycle. The 26.1.0 release may be the last one where these adapters are released together with the Keycloak server, but from now on, these adapters may be released at a different time than the Keycloak server.
Updates in quickstarts
The Keycloak quickstarts are now using
mainas the base branch. Thelatestbranch, used previously, is removed. Themainbranch depends on the last released version of the Keycloak server, Keycloak client libraries, and adapters. As a result, contributions to the quickstarts are immediately visible to quickstart consumers with no need to wait for the next Keycloak server release.Updated format of KEYCLOAK_SESSION cookie and AUTH_SESSION_ID cookie
The format of
KEYCLOAK_SESSIONcookie was slightly updated to not contain any private data in plain text. Until now, the format of the cookie wasrealmName/userId/userSessionId. Now the cookie contains user session ID, which is hashed by SHA-256 and URL encoded.The format of
AUTH_SESSION_IDcookie was updated to include a signature of the auth session id to ensure its integrity through signature verification. The new format isbase64(auth_session_id.auth_session_id_signature). With this update, the old format will no longer be accepted, meaning that old auth sessions will no longer be valid. This change has no impact on user sessions.These changes can affect you just in case when implementing your own providers and relying on the format of internal Keycloak cookies.
Removal of robots.txt file
The
robots.txtfile, previously included by default, is now removed. The defaultrobots.txtfile blocked all crawling, which prevented thenoindex/nofollowdirectives from being followed. The desired default behaviour is for Keycloak pages to not show up in search engine results and this is accomplished by the existingX-Robots-Tagheader, which is set tononeby default. The value of this header can be overridden per-realm if a different behaviour is needed.If you previously added a rule in your reverse proxy configuration for this, you can now remove it.
Imported key providers check and passivate keys with an expired cetificate
The key providers that allow to import externally generated keys (
rsaandjava-keystorefactories) now check the validity of the associated certificate if present. Therefore a key with a certificate that is expired cannot be imported in Keycloak anymore. If the certificate expires at runtime, the key is converted into a passive key (enabled but not active). A passive key is not used for new tokens, but it is still valid for validating previous issued tokens.The default
generatedkey providers generate a certificate valid for 10 years (the types that have or can have an associated certificate). Because of the long validity and the recommendation to rotate keys frequently, the generated providers do not perform this check.Admin events might include now additional details about the context when the event is fired
In this release, admin events might hold additional details about the context when the event is fired. When upgrading you should expect the database schema being updated to add a new column
DETAILS_JSONto theADMIN_EVENT_ENTITYtable.OpenShift v3 identity brokering removed
As OpenShift v3 reached end-of-life a while back, support for identity brokering with OpenShift v3 has been removed from Keycloak.
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
New features
corelogin/uioperatoroperatordist/quarkusdist/quarkusauthenticationaccount/uiauthenticationEnhancements
oidcoidcadapter/javascriptoidcauthenticationauthenticationstoragestorageauthorization-servicesoid4vcauthenticationoperatordist/quarkusoperatoraccount/uioid4vcoperatorstoragecoretestsuiteadmin/uiauthentication/webauthndist/quarkusauthenticationauthenticationlogin/uilogin/uiadmin/client-javaaccount/uidocsoidcoperatoridentity-brokeringldapoidcoidcdist/quarkusoidclogin/uidist/quarkuscoreaccount/uitestsuitecidocsoidcdocsoperatordocsdocstranslationsdocsciadmin/uitest-frameworktest-frameworktestsuiteBugs
adapter/javascriptadmin/apistorageldapoidcauthenticationadapter/javascriptoidcadapter/javascriptadmin/apiauthenticationauthentication/webauthnldapadapter/javascriptauthorization-servicesldapadapter/javascriptcistorageadmin/client-jstestsuiteauthenticationauthenticationcitoken-exchangeaccount/uiadmin/uicicicicorecoreauthenticationcoreadmin/apicicitoken-exchangecoreadmin/uildapcoredist/quarkusadmin/fine-grained-permissionsidentity-brokeringauthenticationciauthenticationauthentication/webauthnldapinfinispandocscorecoreciciadmin/apiadmin/uioidcoidccorecicici
- If you want to rebase/retry this PR, check this box
Configuration
📅 Schedule: Branch creation - "every weekday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR was generated by Mend Renovate. View the repository job log.