Skip to content

Commit b624a88

Browse files
authored
Merge pull request #42521 from rolfedh/update-extension-names-in-conditionals
Updates to reflect current extension names and configuration roots
2 parents cb72387 + 9f55339 commit b624a88

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

docs/src/main/asciidoc/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]]

docs/src/main/asciidoc/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

0 commit comments

Comments
 (0)