Skip to content

Commit 26167fb

Browse files
committed
Sync documentation of main branch
1 parent c747b08 commit 26167fb

9 files changed

+43
-37
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51288,6 +51288,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservic
5128851288
--
5128951289
A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.
5129051290

51291+
To learn more about Keycloak realm files, consult the link:https://www.keycloak.org/server/importExport[Importing and Exporting Keycloak Realms documentation].
51292+
5129151293

5129251294
ifdef::add-copy-button-to-env-var[]
5129351295
Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++[]
@@ -52487,7 +52489,7 @@ a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-path]] [.property-path]##`quar
5248752489

5248852490
[.description]
5248952491
--
52490-
The relative path of the Back-Channel Logout endpoint at the application.
52492+
The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.
5249152493

5249252494

5249352495
ifdef::add-copy-button-to-env-var[]
@@ -54475,7 +54477,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-path]] [.property-path]
5447554477

5447654478
[.description]
5447754479
--
54478-
The relative path of the Back-Channel Logout endpoint at the application.
54480+
The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.
5447954481

5448054482

5448154483
ifdef::add-copy-button-to-env-var[]

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservic
103103
--
104104
A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.
105105

106+
To learn more about Keycloak realm files, consult the link:https://www.keycloak.org/server/importExport[Importing and Exporting Keycloak Realms documentation].
107+
106108

107109
ifdef::add-copy-button-to-env-var[]
108110
Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++[]

_generated-doc/main/config/quarkus-oidc_quarkus.keycloak.devservices.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-oidc_quarkus-keycloak-devservic
9999
--
100100
A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.
101101

102+
To learn more about Keycloak realm files, consult the link:https://www.keycloak.org/server/importExport[Importing and Exporting Keycloak Realms documentation].
103+
102104

103105
ifdef::add-copy-button-to-env-var[]
104106
Environment variable: env_var_with_copy_button:+++QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH+++[]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1006,7 +1006,7 @@ a| [[quarkus-oidc_quarkus-oidc-logout-backchannel-path]] [.property-path]##`quar
10061006

10071007
[.description]
10081008
--
1009-
The relative path of the Back-Channel Logout endpoint at the application.
1009+
The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.
10101010

10111011

10121012
ifdef::add-copy-button-to-env-var[]
@@ -2994,7 +2994,7 @@ a| [[quarkus-oidc_quarkus-oidc-tenant-logout-backchannel-path]] [.property-path]
29942994

29952995
[.description]
29962996
--
2997-
The relative path of the Back-Channel Logout endpoint at the application.
2997+
The relative path of the Back-Channel Logout endpoint at the application. It must start with the forward slash '/', for example, '/back-channel-logout'. This value is always resolved relative to 'quarkus.http.root-path'.
29982998

29992999

30003000
ifdef::add-copy-button-to-env-var[]

_versions/main/guides/extension-metadata.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ And here is the final version of the file included in the runtime JAR augmented
6464
----
6565
name: "Quarkus REST (formerly RESTEasy Reactive)"
6666
artifact: "io.quarkus:quarkus-rest:999-SNAPSHOT"
67+
description: "A Jakarta REST implementation utilizing build time processing and Vert.x.\
68+
\ This extension is not compatible with the quarkus-resteasy extension, or any of\
69+
\ the extensions that depend on it." <1>
6770
metadata:
6871
short-name: "rest"
6972
keywords:
@@ -84,13 +87,13 @@ metadata:
8487
artifact: "io.quarkus:quarkus-project-core-extension-codestarts::jar:999-SNAPSHOT"
8588
config:
8689
- "quarkus.rest."
87-
built-with-quarkus-core: "3.8.5" <1>
88-
requires-quarkus-core: "[3.8,)" <2>
89-
capabilities: <3>
90+
built-with-quarkus-core: "3.8.5" <2>
91+
requires-quarkus-core: "[3.8,)" <3>
92+
capabilities: <4>
9093
provides:
9194
- "io.quarkus.rest"
9295
- "io.quarkus.resteasy.reactive"
93-
extension-dependencies: <4>
96+
extension-dependencies: <5>
9497
- "io.quarkus:quarkus-rest-common"
9598
- "io.quarkus:quarkus-mutiny"
9699
- "io.quarkus:quarkus-smallrye-context-propagation"
@@ -100,21 +103,18 @@ metadata:
100103
- "io.quarkus:quarkus-vertx-http"
101104
- "io.quarkus:quarkus-core"
102105
- "io.quarkus:quarkus-jsonp"
103-
description: "A Jakarta REST implementation utilizing build time processing and Vert.x.\
104-
\ This extension is not compatible with the quarkus-resteasy extension, or any of\
105-
\ the extensions that depend on it." <5>
106-
scm-url: "https://github.com/quarkusio/quarkus" <6>
107-
sponsor: A Sponsoring Organisation <7>
106+
scm-url: "https://github.com/quarkusio/quarkus" <6>
107+
sponsor: A Sponsoring Organisation <7>
108108
----
109-
110-
<1> Quarkus version the extension was built with
111-
<2> The Quarkus version range this extension requires. Optional, and will be set automatically by using the `built-with-quarkus-core` as the minimum range.
112-
<3> https://quarkus.io/guides/capabilities[Capabilities] this extension provides
113-
<4> Direct dependencies on other extensions
114-
<5> Description that can be displayed to users. In this case, the description was copied from the `pom.xml` of the extension module but it could also be provided in the template file.
109+
<1> Description that can be displayed to users. In this case, the description was copied from the `pom.xml` of the extension module but it could also be provided in the template file.
110+
<2> Quarkus version the extension was built with
111+
<3> The Quarkus version range this extension requires. Optional, and will be set automatically by using the `built-with-quarkus-core` as the minimum range.
112+
<4> https://quarkus.io/guides/capabilities[Capabilities] this extension provides
113+
<5> Direct dependencies on other extensions
115114
<6> The source code repository of this extension. Optional, and will often be set automatically by using the `<scm>` information in the pom. In GitHub Actions builds, it will be inferred from the CI environment. For other GitHub repositories, it can be controlled by setting a `GITHUB_REPOSITORY` environment variable.
116115
<7> The sponsor(s) of this extension. Optional, and will sometimes be determined automatically from commit history.
117116

117+
118118
[[quarkus-extension-properties]]
119119
== META-INF/quarkus-extension.properties
120120

83.6 KB
Loading

_versions/main/guides/security-csrf-prevention.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@ At this stage no additional configuration is needed - by default the CSRF form f
126126

127127
[source,properties]
128128
----
129-
quarkus.csrf-reactive.form-field-name=csrftoken
130-
quarkus.csrf-reactive.cookie-name=csrftoken
129+
quarkus.rest-csrf.form-field-name=csrftoken
130+
quarkus.rest-csrf.cookie-name=csrftoken
131131
----
132132

133133
== Sign CSRF token
@@ -136,7 +136,7 @@ You can get `HMAC` signatures created for the generated CSRF tokens and have the
136136

137137
[source,properties]
138138
----
139-
quarkus.csrf-reactive.token-signature-key=AyM1SysPpbyDfgZld3umj1qzKObwVMkoqQ-EstJQLr_T-1qS0gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr1Z9CAow
139+
quarkus.rest-csrf.token-signature-key=AyM1SysPpbyDfgZld3umj1qzKObwVMkoqQ-EstJQLr_T-1qS0gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr1Z9CAow
140140
----
141141

142142
[[csrf-request-header]]
@@ -151,18 +151,18 @@ If HTML `form` tags are not used and you need to pass CSRF token as a header, th
151151
----
152152
<1> This expression is used to inject a CSRF token header and token. This token will be verified by the CSRF filter against a CSRF cookie.
153153

154-
Default header name is `X-CSRF-TOKEN`, you can customize it with `quarkus.csrf-reactive.token-header-name`, for example:
154+
Default header name is `X-CSRF-TOKEN`, you can customize it with `quarkus.rest-csrf.token-header-name`, for example:
155155

156156
[source,properties]
157157
----
158-
quarkus.csrf-reactive.token-header-name=CUSTOM-X-CSRF-TOKEN
158+
quarkus.rest-csrf.token-header-name=CUSTOM-X-CSRF-TOKEN
159159
----
160160

161161
If you need to access the CSRF cookie from JavaScript in order to pass its value as a header, use `{inject:csrf.cookieName}` and `{inject:csrf.headerName}` to inject the cookie name which has to be read as a CSRF header value and allow accessing this cookie:
162162

163163
[source,properties]
164164
----
165-
quarkus.csrf-reactive.cookie-http-only=false
165+
quarkus.rest-csrf.cookie-http-only=false
166166
----
167167

168168
== Cross-origin resource sharing
@@ -255,11 +255,11 @@ As you can see a CSRF token verification will be required at the `/service/user`
255255
[source,properties]
256256
----
257257
# Verify CSRF token only for the `/service/user` path, ignore other paths such as `/service/users`
258-
quarkus.csrf-reactive.create-token-path=/service/user
258+
quarkus.rest-csrf.create-token-path=/service/user
259259
260260
# If `/service/user` path accepts not only `application/x-www-form-urlencoded` payloads but also other ones such as JSON then allow them
261261
# Setting this property is not necessary when the token is submitted as a header value
262-
quarkus.csrf-reactive.require-form-url-encoded=false
262+
quarkus.rest-csrf.require-form-url-encoded=false
263263
----
264264

265265
== Verify CSRF token in the application code
@@ -316,7 +316,7 @@ Also disable the token verification in the filter:
316316

317317
[source,properties]
318318
----
319-
quarkus.csrf-reactive.verify-token=false
319+
quarkus.rest-csrf.verify-token=false
320320
----
321321

322322
[[csrf-reactive-configuration-reference]]

_versions/main/guides/security-openid-connect-client-reference.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1155,7 +1155,7 @@ quarkus.oidc-client.credentials.secret=secret
11551155
quarkus.oidc-client.grant.type=exchange
11561156
quarkus.oidc-client.grant-options.exchange.audience=quarkus-app-exchange
11571157
1158-
quarkus.oidc-token-propagation.exchange-token=true <1>
1158+
quarkus.resteasy-client-oidc-token-propagation.exchange-token=true <1>
11591159
----
11601160
<1> Please note that the `exchange-token` configuration property is ignored when the OidcClient name is set with the `io.quarkus.oidc.token.propagation.AccessToken#exchangeTokenClient` annotation attribute.
11611161

@@ -1173,10 +1173,10 @@ quarkus.oidc-client.grant.type=jwt
11731173
quarkus.oidc-client.grant-options.jwt.requested_token_use=on_behalf_of
11741174
quarkus.oidc-client.scopes=https://graph.microsoft.com/user.read,offline_access
11751175
1176-
quarkus.oidc-token-propagation.exchange-token=true
1176+
quarkus.resteasy-client-oidc-token-propagation.exchange-token=true
11771177
----
11781178

1179-
`AccessTokenRequestReactiveFilter` uses a default `OidcClient` by default. A named `OidcClient` can be selected with a `quarkus.oidc-token-propagation-reactive.client-name` configuration property or with the `io.quarkus.oidc.token.propagation.AccessToken#exchangeTokenClient` annotation attribute.
1179+
`AccessTokenRequestReactiveFilter` uses a default `OidcClient` by default. A named `OidcClient` can be selected with a `quarkus.rest-client-oidc-token-propagation.client-name` configuration property or with the `io.quarkus.oidc.token.propagation.AccessToken#exchangeTokenClient` annotation attribute.
11801180

11811181
[[token-propagation]]
11821182
== Token Propagation
@@ -1231,7 +1231,7 @@ public interface ProtectedResourceService {
12311231
}
12321232
----
12331233

1234-
Alternatively, `AccessTokenRequestFilter` can be registered automatically with all MP Rest or Jakarta REST clients if the `quarkus.oidc-token-propagation.register-filter` property is set to `true` and `quarkus.oidc-token-propagation.json-web-token` property is set to `false` (which is a default value).
1234+
Alternatively, `AccessTokenRequestFilter` can be registered automatically with all MP Rest or Jakarta REST clients if the `quarkus.resteasy-client-oidc-token-propagation.register-filter` property is set to `true` and `quarkus.resteasy-client-oidc-token-propagation.json-web-token` property is set to `false` (which is a default value).
12351235

12361236
==== Exchange token before propagation
12371237

@@ -1245,7 +1245,7 @@ quarkus.oidc-client.credentials.secret=secret
12451245
quarkus.oidc-client.grant.type=exchange
12461246
quarkus.oidc-client.grant-options.exchange.audience=quarkus-app-exchange
12471247
1248-
quarkus.oidc-token-propagation.exchange-token=true
1248+
quarkus.resteasy-client-oidc-token-propagation.exchange-token=true
12491249
----
12501250

12511251
If you work with providers such as `Azure` that link:https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#example[require using] link:https://www.rfc-editor.org/rfc/rfc7523#section-2.1[JWT bearer token grant] to exchange the current token, then you can configure `AccessTokenRequestFilter` to exchange the token like this:
@@ -1260,12 +1260,12 @@ quarkus.oidc-client.grant.type=jwt
12601260
quarkus.oidc-client.grant-options.jwt.requested_token_use=on_behalf_of
12611261
quarkus.oidc-client.scopes=https://graph.microsoft.com/user.read,offline_access
12621262
1263-
quarkus.oidc-token-propagation.exchange-token=true
1263+
quarkus.resteasy-client-oidc-token-propagation.exchange-token=true
12641264
----
12651265

12661266
Note `AccessTokenRequestFilter` will use `OidcClient` to exchange the current token, and you can use `quarkus.oidc-client.grant-options.exchange` to set the additional exchange properties expected by your OpenID Connect Provider.
12671267

1268-
`AccessTokenRequestFilter` uses a default `OidcClient` by default. A named `OidcClient` can be selected with a `quarkus.oidc-token-propagation.client-name` configuration property.
1268+
`AccessTokenRequestFilter` uses a default `OidcClient` by default. A named `OidcClient` can be selected with a `quarkus.resteasy-client-oidc-token-propagation.client-name` configuration property.
12691269

12701270
=== RestClient JsonWebTokenRequestFilter
12711271

@@ -1307,7 +1307,7 @@ public interface ProtectedResourceService {
13071307
}
13081308
----
13091309

1310-
Alternatively, `JsonWebTokenRequestFilter` can be registered automatically with all MicroProfile REST or Jakarta REST clients if both `quarkus.oidc-token-propagation.register-filter` and `quarkus.resteasy-client-oidc-token-propagation.json-web-token` properties are set to `true`.
1310+
Alternatively, `JsonWebTokenRequestFilter` can be registered automatically with all MicroProfile REST or Jakarta REST clients if both `quarkus.resteasy-client-oidc-token-propagation.register-filter` and `quarkus.resteasy-client-oidc-token-propagation.json-web-token` properties are set to `true`.
13111311

13121312
==== Update token before propagation
13131313

_versions/main/guides/security-openid-connect-providers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ In order to set up OIDC for GitHub you need to create a new OAuth application in
207207

208208
image::oidc-github-1.png[role="thumb"]
209209

210-
Make sure to fill in the appropriate details, but more importantly the Authorization Callback URL, set to `http://localhost:8080/_renarde/security/github-success`
210+
Make sure to fill in the appropriate details, but more importantly the Authorization Callback URL, set to `http://localhost:8080/_renarde/security/oidc-success`
211211
(if you intend to test this using the Quarkus dev mode).
212212

213213
Now click on `Register application` and you'll be shown your application page:

0 commit comments

Comments
 (0)