Skip to content

Commit 1e326a1

Browse files
committed
Sync documentation of main branch
1 parent 0feadcf commit 1e326a1

File tree

5 files changed

+93
-0
lines changed

5 files changed

+93
-0
lines changed

_generated-doc/main/config/quarkus-all-config.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71490,6 +71490,34 @@ endif::add-copy-button-to-env-var[]
7149071490
a|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`], tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type]
7149171491
|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]
7149271492

71493+
a| [[quarkus-oidc_quarkus-oidc-authentication-cache-control]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cache-control[`quarkus.oidc.authentication.cache-control`]##
71494+
ifdef::add-copy-button-to-config-props[]
71495+
config_property_copy_button:+++quarkus.oidc.authentication.cache-control+++[]
71496+
endif::add-copy-button-to-config-props[]
71497+
71498+
71499+
`quarkus.oidc."tenant".authentication.cache-control`
71500+
ifdef::add-copy-button-to-config-props[]
71501+
config_property_copy_button:+++quarkus.oidc."tenant".authentication.cache-control+++[]
71502+
endif::add-copy-button-to-config-props[]
71503+
71504+
[.description]
71505+
--
71506+
Set of cache-control directives that must be set when a new session cookie is created, either after a successful authorization code completion or token refresh.
71507+
71508+
Currently, only a `no-store` directive that prohibits caching the session cookie anywhere in the client request chain can be configured.
71509+
71510+
71511+
ifdef::add-copy-button-to-env-var[]
71512+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_CACHE_CONTROL+++[]
71513+
endif::add-copy-button-to-env-var[]
71514+
ifndef::add-copy-button-to-env-var[]
71515+
Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_CACHE_CONTROL+++`
71516+
endif::add-copy-button-to-env-var[]
71517+
--
71518+
a|list of `no-store`
71519+
|
71520+
7149371521
a| [[quarkus-oidc_quarkus-oidc-authentication-redirect-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-redirect-path[`quarkus.oidc.authentication.redirect-path`]##
7149471522
ifdef::add-copy-button-to-config-props[]
7149571523
config_property_copy_button:+++quarkus.oidc.authentication.redirect-path+++[]

_generated-doc/main/config/quarkus-oidc.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3079,6 +3079,34 @@ endif::add-copy-button-to-env-var[]
30793079
a|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`], tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type]
30803080
|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]
30813081

3082+
a| [[quarkus-oidc_quarkus-oidc-authentication-cache-control]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cache-control[`quarkus.oidc.authentication.cache-control`]##
3083+
ifdef::add-copy-button-to-config-props[]
3084+
config_property_copy_button:+++quarkus.oidc.authentication.cache-control+++[]
3085+
endif::add-copy-button-to-config-props[]
3086+
3087+
3088+
`quarkus.oidc."tenant".authentication.cache-control`
3089+
ifdef::add-copy-button-to-config-props[]
3090+
config_property_copy_button:+++quarkus.oidc."tenant".authentication.cache-control+++[]
3091+
endif::add-copy-button-to-config-props[]
3092+
3093+
[.description]
3094+
--
3095+
Set of cache-control directives that must be set when a new session cookie is created, either after a successful authorization code completion or token refresh.
3096+
3097+
Currently, only a `no-store` directive that prohibits caching the session cookie anywhere in the client request chain can be configured.
3098+
3099+
3100+
ifdef::add-copy-button-to-env-var[]
3101+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_CACHE_CONTROL+++[]
3102+
endif::add-copy-button-to-env-var[]
3103+
ifndef::add-copy-button-to-env-var[]
3104+
Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_CACHE_CONTROL+++`
3105+
endif::add-copy-button-to-env-var[]
3106+
--
3107+
a|list of `no-store`
3108+
|
3109+
30823110
a| [[quarkus-oidc_quarkus-oidc-authentication-redirect-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-redirect-path[`quarkus.oidc.authentication.redirect-path`]##
30833111
ifdef::add-copy-button-to-config-props[]
30843112
config_property_copy_button:+++quarkus.oidc.authentication.redirect-path+++[]

_generated-doc/main/config/quarkus-oidc_quarkus.oidc.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3079,6 +3079,34 @@ endif::add-copy-button-to-env-var[]
30793079
a|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`], tooltip:form-post[Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser and transmitted by the HTTP POST method using the application/x-www-form-urlencoded content type]
30803080
|tooltip:query[Authorization response parameters are encoded in the query string added to the `redirect_uri`]
30813081

3082+
a| [[quarkus-oidc_quarkus-oidc-authentication-cache-control]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-cache-control[`quarkus.oidc.authentication.cache-control`]##
3083+
ifdef::add-copy-button-to-config-props[]
3084+
config_property_copy_button:+++quarkus.oidc.authentication.cache-control+++[]
3085+
endif::add-copy-button-to-config-props[]
3086+
3087+
3088+
`quarkus.oidc."tenant".authentication.cache-control`
3089+
ifdef::add-copy-button-to-config-props[]
3090+
config_property_copy_button:+++quarkus.oidc."tenant".authentication.cache-control+++[]
3091+
endif::add-copy-button-to-config-props[]
3092+
3093+
[.description]
3094+
--
3095+
Set of cache-control directives that must be set when a new session cookie is created, either after a successful authorization code completion or token refresh.
3096+
3097+
Currently, only a `no-store` directive that prohibits caching the session cookie anywhere in the client request chain can be configured.
3098+
3099+
3100+
ifdef::add-copy-button-to-env-var[]
3101+
Environment variable: env_var_with_copy_button:+++QUARKUS_OIDC_AUTHENTICATION_CACHE_CONTROL+++[]
3102+
endif::add-copy-button-to-env-var[]
3103+
ifndef::add-copy-button-to-env-var[]
3104+
Environment variable: `+++QUARKUS_OIDC_AUTHENTICATION_CACHE_CONTROL+++`
3105+
endif::add-copy-button-to-env-var[]
3106+
--
3107+
a|list of `no-store`
3108+
|
3109+
30823110
a| [[quarkus-oidc_quarkus-oidc-authentication-redirect-path]] [.property-path]##link:#quarkus-oidc_quarkus-oidc-authentication-redirect-path[`quarkus.oidc.authentication.redirect-path`]##
30833111
ifdef::add-copy-button-to-config-props[]
30843112
config_property_copy_button:+++quarkus.oidc.authentication.redirect-path+++[]

_versions/main/guides/security-oidc-expanded-configuration.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,7 @@ Session cookie is created after an authorizaion code flow is completed. An expir
575575
|quarkus.oidc.token.refresh-token-time-skew || Refresh token time skew
576576
|quarkus.oidc.authentication.session-age-extension |5 minutes| Session age extension
577577
|quarkus.oidc.authentication.session-expired-path || Session expired path
578+
|quarkus.oidc.authentication.cache-control || Set of Cache-Control header directives
578579
|====
579580

580581
`quarkus.oidc.token.refresh-expired` can be used to enable automatic user session renewal when the user session has expired and the refresh token is available. This property is not enabled by default because with the automatic renewal, the user, after authenticating once, may not be asked to re-authenticate for a very long time. Therefore an admin level decision may be required to enable an automatic session renewal.
@@ -592,6 +593,9 @@ The `quarkus.oidc.token.refresh-token` property is automatically enabled if the
592593

593594
See also the <<token-state-manager>> section for more information about managing session cookies.
594595

596+
When a new session cookie is created, either after a successful authorization code flow completion or a token refresh, it may be necessary to control how the session cookie is managed by HTTP cache intermediaries and the browser cache.
597+
Currently, only a `Cache-Control` `no-store` directive that prohibits caching the session cookie anywhere in the client request chain can be configured.
598+
595599
[[token-state-manager]]
596600
== Store authorization code flow tokens
597601

_versions/main/guides/spring-web.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,11 @@ In addition to the method parameters that can be annotated with the appropriate
446446
`jakarta.servlet.http.HttpServletRequest` and `jakarta.servlet.http.HttpServletResponse` are also supported.
447447
For this to function however, users need to add the `quarkus-undertow` dependency.
448448

449+
⚠️ Important: These types are only available when using the Classic RESTEasy stack (quarkus-resteasy / quarkus-resteasy-jackson) because they rely on the Servlet API provided by Undertow (quarkus-undertow).
450+
451+
If your application uses the Reactive stack (quarkus-rest / quarkus-rest-jackson), then the Servlet API is not supported.
452+
In this case, adding the quarkus-undertow dependency will not enable servlet injection and will result in runtime errors.
453+
449454
=== Exception handler method return types
450455

451456
The following method return types are supported:

0 commit comments

Comments
 (0)