Skip to content

Commit 30b701f

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 7a89112 commit 30b701f

9 files changed

+141
-5
lines changed

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

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9946,7 +9946,7 @@ ifndef::add-copy-button-to-env-var[]
99469946
Environment variable: `+++QUARKUS_HTTP_UNHANDLED_ERROR_CONTENT_TYPE_DEFAULT+++`
99479947
endif::add-copy-button-to-env-var[]
99489948
--
9949-
a|`json`, `html`
9949+
a|`json`, `html`, `text`
99509950
|
99519951

99529952
a| [[quarkus-vertx-http_quarkus-http-same-site-cookie-same-site-cookie-case-sensitive]] [.property-path]##`quarkus.http.same-site-cookie."same-site-cookie".case-sensitive`##
@@ -10489,6 +10489,23 @@ endif::add-copy-button-to-env-var[]
1048910489
a|`strict`, `lax`, `none`
1049010490
|`strict`
1049110491

10492+
a| [[quarkus-vertx-http_quarkus-http-auth-form-cookie-max-age]] [.property-path]##`quarkus.http.auth.form.cookie-max-age`##
10493+
10494+
[.description]
10495+
--
10496+
Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed.
10497+
10498+
10499+
ifdef::add-copy-button-to-env-var[]
10500+
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++[]
10501+
endif::add-copy-button-to-env-var[]
10502+
ifndef::add-copy-button-to-env-var[]
10503+
Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++`
10504+
endif::add-copy-button-to-env-var[]
10505+
--
10506+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
10507+
|
10508+
1049210509

1049310510
h|[[quarkus-vertx-http_section_quarkus-http-cors]] [.section-name.section-level0]##The CORS config##
1049410511
h|Type
@@ -70578,6 +70595,23 @@ endif::add-copy-button-to-env-var[]
7057870595
|string
7057970596
|`/`
7058070597

70598+
a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-max-age]] [.property-path]##`quarkus.webauthn.cookie-max-age`##
70599+
70600+
[.description]
70601+
--
70602+
Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed.
70603+
70604+
70605+
ifdef::add-copy-button-to-env-var[]
70606+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++[]
70607+
endif::add-copy-button-to-env-var[]
70608+
ifndef::add-copy-button-to-env-var[]
70609+
Environment variable: `+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++`
70610+
endif::add-copy-button-to-env-var[]
70611+
--
70612+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
70613+
|
70614+
7058170615

7058270616
h|[.extension-name]##SmallRye GraphQL##
7058370617
h|Type

‎_generated-doc/main/config/quarkus-security-webauthn.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,23 @@ endif::add-copy-button-to-env-var[]
365365
|string
366366
|`/`
367367

368+
a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-max-age]] [.property-path]##`quarkus.webauthn.cookie-max-age`##
369+
370+
[.description]
371+
--
372+
Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed.
373+
374+
375+
ifdef::add-copy-button-to-env-var[]
376+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++[]
377+
endif::add-copy-button-to-env-var[]
378+
ifndef::add-copy-button-to-env-var[]
379+
Environment variable: `+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++`
380+
endif::add-copy-button-to-env-var[]
381+
--
382+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
383+
|
384+
368385
|===
369386

370387
ifndef::no-duration-note[]

‎_generated-doc/main/config/quarkus-security-webauthn_quarkus.webauthn.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,23 @@ endif::add-copy-button-to-env-var[]
365365
|string
366366
|`/`
367367

368+
a| [[quarkus-security-webauthn_quarkus-webauthn-cookie-max-age]] [.property-path]##`quarkus.webauthn.cookie-max-age`##
369+
370+
[.description]
371+
--
372+
Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed.
373+
374+
375+
ifdef::add-copy-button-to-env-var[]
376+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++[]
377+
endif::add-copy-button-to-env-var[]
378+
ifndef::add-copy-button-to-env-var[]
379+
Environment variable: `+++QUARKUS_WEBAUTHN_COOKIE_MAX_AGE+++`
380+
endif::add-copy-button-to-env-var[]
381+
--
382+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
383+
|
384+
368385
|===
369386

370387
ifndef::no-duration-note[]

‎_generated-doc/main/config/quarkus-vertx-http_quarkus.http.adoc‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1284,7 +1284,7 @@ ifndef::add-copy-button-to-env-var[]
12841284
Environment variable: `+++QUARKUS_HTTP_UNHANDLED_ERROR_CONTENT_TYPE_DEFAULT+++`
12851285
endif::add-copy-button-to-env-var[]
12861286
--
1287-
a|`json`, `html`
1287+
a|`json`, `html`, `text`
12881288
|
12891289

12901290
a| [[quarkus-vertx-http_quarkus-http-same-site-cookie-same-site-cookie-case-sensitive]] [.property-path]##`quarkus.http.same-site-cookie."same-site-cookie".case-sensitive`##
@@ -1827,6 +1827,23 @@ endif::add-copy-button-to-env-var[]
18271827
a|`strict`, `lax`, `none`
18281828
|`strict`
18291829

1830+
a| [[quarkus-vertx-http_quarkus-http-auth-form-cookie-max-age]] [.property-path]##`quarkus.http.auth.form.cookie-max-age`##
1831+
1832+
[.description]
1833+
--
1834+
Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed.
1835+
1836+
1837+
ifdef::add-copy-button-to-env-var[]
1838+
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++[]
1839+
endif::add-copy-button-to-env-var[]
1840+
ifndef::add-copy-button-to-env-var[]
1841+
Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++`
1842+
endif::add-copy-button-to-env-var[]
1843+
--
1844+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
1845+
|
1846+
18301847

18311848
h|[[quarkus-vertx-http_section_quarkus-http-cors]] [.section-name.section-level0]##The CORS config##
18321849
h|Type

‎_generated-doc/main/config/quarkus-vertx-http_quarkus.http.auth.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,23 @@ endif::add-copy-button-to-env-var[]
476476
a|`strict`, `lax`, `none`
477477
|`strict`
478478

479+
a| [[quarkus-vertx-http_quarkus-http-auth_quarkus-http-auth-form-cookie-max-age]] [.property-path]##`quarkus.http.auth.form.cookie-max-age`##
480+
481+
[.description]
482+
--
483+
Max-Age attribute for the session cookie. This is the amount of time the browser will keep the cookie. The default value is empty, which means the cookie will be kept until the browser is closed.
484+
485+
486+
ifdef::add-copy-button-to-env-var[]
487+
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++[]
488+
endif::add-copy-button-to-env-var[]
489+
ifndef::add-copy-button-to-env-var[]
490+
Environment variable: `+++QUARKUS_HTTP_AUTH_FORM_COOKIE_MAX_AGE+++`
491+
endif::add-copy-button-to-env-var[]
492+
--
493+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
494+
|
495+
479496
|===
480497

481498
ifndef::no-duration-note[]

‎_versions/main/guides/scripting.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ INFO: Building native image source jar: /tmp/quarkus-jbang8082065952748314720/qu
415415
Mar 22, 2023 9:58:47 A.M. io.quarkus.deployment.pkg.steps.NativeImageBuildStep build
416416
INFO: Building native image from /tmp/quarkus-jbang8082065952748314720/quarkus-application-native-image-source-jar/quarkus-application-runner.jar
417417
Mar 22, 2023 9:58:47 A.M. io.quarkus.deployment.pkg.steps.NativeImageBuildStep getNativeImageBuildRunner
418-
WARN: Cannot find the `native-image` in the GRAALVM_HOME, JAVA_HOME and System PATH. Install it using `gu install native-image` Attempting to fall back to container build.
418+
WARN: Cannot find the `native-image` in the GRAALVM_HOME, JAVA_HOME and System PATH. Attempting to fall back to container build.
419419
Mar 22, 2023 9:58:47 A.M. io.quarkus.deployment.pkg.steps.NativeImageBuildContainerRunner <init>
420420
INFO: Using docker to run the native image builder
421421
Mar 22, 2023 9:58:47 A.M. io.quarkus.deployment.pkg.steps.NativeImageBuildContainerRunner setup

‎_versions/main/guides/security-keycloak-authorization.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,21 @@ export access_token=$(\
334334
)
335335
----
336336
337+
[NOTE]
338+
====
339+
When the `quarkus.oidc.authentication.user-info-required` property is set to `true` to require that an access token is used to request `UserInfo`, you must add a `scope=openid` query parameter to the token grant request command, for example:
340+
341+
[source,bash]
342+
----
343+
export access_token=$(\
344+
curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token \
345+
--user backend-service:secret \
346+
-H 'content-type: application/x-www-form-urlencoded' \
347+
-d 'username=alice&password=alice&grant_type=password&scope=openid' | jq --raw-output '.access_token' \
348+
)
349+
----
350+
====
351+
337352
The preceding example obtains an access token for user `alice`.
338353
339354
Any user is allowed to access the

‎_versions/main/guides/security-oidc-bearer-token-authentication-tutorial.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,21 @@ export access_token=$(\
319319
----
320320
====
321321

322+
[NOTE]
323+
====
324+
When the `quarkus.oidc.authentication.user-info-required` property is set to `true` to require that an access token is used to request `UserInfo`, you must add a `scope=openid` query parameter to the token grant request command, for example:
325+
326+
[source,bash]
327+
----
328+
export access_token=$(\
329+
curl --insecure -X POST http://localhost:8180/realms/quarkus/protocol/openid-connect/token \
330+
--user backend-service:secret \
331+
-H 'content-type: application/x-www-form-urlencoded' \
332+
-d 'username=alice&password=alice&grant_type=password&scope=openid' | jq --raw-output '.access_token' \
333+
)
334+
----
335+
====
336+
322337
The preceding example obtains an access token for the user `alice`.
323338

324339
* Any user can access the `http://localhost:8080/api/users/me` endpoint, which returns a JSON payload with details about the user.

‎_versions/main/guides/security-openid-connect-multitenancy.adoc‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -657,10 +657,13 @@ public class HelloResource {
657657
----
658658
<1> The `io.quarkus.oidc.Tenant` annotation must be placed on either the resource class or resource method.
659659

660-
[[TIP]]
660+
[TIP]
661+
====
661662
In the example above, authentication of the `sayHello` endpoint is enforced with the `@Authenticated` annotation.
663+
662664
Alternatively, if you use an the xref:security-authorize-web-endpoints-reference.adoc#authorization-using-configuration[HTTP Security policy]
663-
to secure the endpoint, then, for the `@Tenant` annotation be effective, you must delay this policy's permission check as shown in the example below:
665+
to secure the endpoint, then, for the `@Tenant` annotation be effective, you must delay this policy's permission check as shown in the following example:
666+
664667
[source,properties]
665668
----
666669
quarkus.http.auth.permission.authenticated.paths=/api/hello
@@ -669,6 +672,7 @@ quarkus.http.auth.permission.authenticated.policy=authenticated
669672
quarkus.http.auth.permission.authenticated.applies-to=JAXRS <1>
670673
----
671674
<1> Tell Quarkus to run the HTTP permission check after the tenant has been selected with the `@Tenant` annotation.
675+
====
672676

673677
[[tenant-config-resolver]]
674678
=== Dynamic tenant configuration resolution

0 commit comments

Comments
 (0)