Promote OIDC Logout Support to Default Stability
Overview
OIDC logout support (RP-Initiated Logout, Front-Channel Logout, and Back-Channel Logout) is currently available under PREVIEW stability. This analysis proposes promoting the feature to DEFAULT stability so the functionality is available in the standard WildFly distribution and defaults.
User Stories
-
A user secures applications with
elytron-oidc-clientand expects a complete logout flow (local application logout plus provider-driven session termination) without requiring preview-only server operation. -
A user needs front-channel or back-channel logout in production deployments using the default WildFly installation profile.
Issue Metadata
Related Issues
Affected Projects or Components
Relevant Installation Types
-
Traditional standalone server (unzipped or provisioned by Galleon)
-
Managed domain
-
OpenShift Source-to-Image (S2I)
-
Bootable jar
Requirements
The OIDC logout functionality moves from PREVIEW to DEFAULT stability:
-
RP-Initiated Logout remains supported.
-
Front-Channel Logout remains supported.
-
Back-Channel Logout remains supported.
Existing configuration attributes remain available:
-
logout-path -
post-logout-redirect-uri -
logout-callback-path -
logout-session-required -
back-channel-logout-session-invalidation-limit -
provider-jwt-claims-typ
The same logout flows remain supported, but default values of attributes and path matching behavior are tightened compared to the previous proposal.
Changed Requirements
-
The
elytron-oidc-clientlogout capabilities are available in DEFAULT stability. -
OIDC logout attributes no longer have default values.
-
logout-pathandlogout-callback-pathare not defaulted to/logoutand/logout/callback. -
Deployments that enable logout must configure the required attributes explicitly.
-
-
Logout configuration is applied only when at least one of
logout-path,logout-callback-path, orpost-logout-redirect-uriis set.-
logout-pathis optional; configure it only when the application exposes an RP-initiated logout entry point. Front-channel and back-channel logout require onlylogout-callback-path. -
post-logout-redirect-uriremains optional.
-
-
logout-callback-pathis optional and accepts either:-
a relative path (for example
/myapp/logout/callback), or -
an absolute
httporhttpsURI (only the URI path component is matched against the incoming request).
-
-
Request-path matching is exact (normalized path equality), not suffix matching.
-
logout-pathandlogout-callback-pathmust match the request relative path exactly.
-
-
RP-Initiated Logout invalidates the local application session before redirecting to the provider
end_session_endpoint.
Non-Requirements
-
No new OIDC logout configuration attributes are introduced.
Future Work
-
Evaluate additional logout interoperability scenarios against providers beyond currently covered testing sets.
Backwards Compatibility
Deployments that relied on PREVIEW defaults or suffix-based path matching may need configuration updates when moving to DEFAULT.
-
Deployments that depended on implicit defaults (
/logout,/logout/callback) must set them explicitly now -
Deployments that relied on suffix matching for
logout-pathmust use the exact callback/logout path.
Default Configuration
No implicit default values are provided for OIDC logout paths when logout is enabled. This promotion removes PREVIEW-era defaults rather than introducing new subsystem defaults.
Deployments
Deployments with explicit logout configuration continue to work after updating paths/URIs to the stricter matching rules. Deployments no longer need PREVIEW stability solely to use OIDC logout support.
Interoperability
No new interoperability concerns are introduced by this stability promotion.
Implementation Plan
-
Promote OIDC logout support and related model/schema elements from PREVIEW to DEFAULT.
Admin Clients
TODO
Security Considerations
TODO
Test Plan
-
Continue and expand integration coverage in
testsuite/integration/elytron-oidc-clientfor logout flows at default stability. -
Verify RP-Initiated, Front-Channel, and Back-Channel logout behavior in default server configurations.
Community Documentation
Update Elytron_OIDC_Client documentation to remove/adjust any PREVIEW-only wording, document DEFAULT availability for logout support, and document explicit logout attribute requirements (no defaults, what is optional and what is not, and format options).
Release Note Content
OIDC RP-initiated, front-channel, and back-channel logout support in elytron-oidc-client is now available at default stability.