-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sync web site with Quarkus documentation
- Loading branch information
quarkusbot
committed
Jan 11, 2024
1 parent
41b6dba
commit 739b2e2
Showing
16 changed files
with
59 additions
and
21 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
...all-configuration-roots-generated-doc/io.quarkus.csrf.reactive.runtime.CsrfReactiveConfig
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
[{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.form-field-name","additionalKeys":[],"configDoc":"Form field name which keeps a CSRF token.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"form-field-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-header-name","additionalKeys":[],"configDoc":"Token header which can provide a CSRF token.","withinAMap":false,"defaultValue":"X-CSRF-TOKEN","javaDocSiteLink":"","docMapKey":"token-header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-name","additionalKeys":[],"configDoc":"CSRF cookie name.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.csrf-reactive.cookie-max-age","additionalKeys":[],"configDoc":"CSRF cookie max age.","withinAMap":false,"defaultValue":"10M","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cookie-max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-path","additionalKeys":[],"configDoc":"CSRF cookie path.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-domain","additionalKeys":[],"configDoc":"CSRF cookie domain.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the CSRF cookie will have its 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookie will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-http-only","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"cookie-http-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.create-token-path","additionalKeys":[],"configDoc":"Create CSRF token only if the HTTP GET relative request path matches one of the paths configured with this property. Use a comma to separate multiple path values.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.csrf-reactive.token-size","additionalKeys":[],"configDoc":"Random CSRF token size in bytes.","withinAMap":false,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"token-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-signature-key","additionalKeys":[],"configDoc":"CSRF token HMAC signature key, if this key is set then it must be at least 32 characters long.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-signature-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.verify-token","additionalKeys":[],"configDoc":"Verify CSRF token in the CSRF filter. If you prefer then you can disable this property and compare CSRF form and cookie parameters in the application code using JAX-RS jakarta.ws.rs.FormParam which refers to the `form-field-name` form property and jakarta.ws.rs.CookieParam which refers to the `CsrfReactiveConfig++#++cookieName` cookie. Note that even if the CSRF token verification in the CSRF filter is disabled, the filter will still perform checks to ensure the token is available, has the correct `token-size` in bytes and that the Content-Type HTTP header is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.require-form-url-encoded","additionalKeys":[],"configDoc":"Require that only 'application/x-www-form-urlencoded' or 'multipart/form-data' body is accepted for the token verification to proceed. Disable this property for the CSRF filter to avoid verifying the token for POST requests with other content types. This property is only effective if `verify-token` property is enabled and `token-header-name` is not configured.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"require-form-url-encoded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}}] | ||
[{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.form-field-name","additionalKeys":[],"configDoc":"Form field name which keeps a CSRF token.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"form-field-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-header-name","additionalKeys":[],"configDoc":"Token header which can provide a CSRF token.","withinAMap":false,"defaultValue":"X-CSRF-TOKEN","javaDocSiteLink":"","docMapKey":"token-header-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-name","additionalKeys":[],"configDoc":"CSRF cookie name.","withinAMap":false,"defaultValue":"csrf-token","javaDocSiteLink":"","docMapKey":"cookie-name","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.csrf-reactive.cookie-max-age","additionalKeys":[],"configDoc":"CSRF cookie max age.","withinAMap":false,"defaultValue":"2H","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"cookie-max-age","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-path","additionalKeys":[],"configDoc":"CSRF cookie path.","withinAMap":false,"defaultValue":"/","javaDocSiteLink":"","docMapKey":"cookie-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.cookie-domain","additionalKeys":[],"configDoc":"CSRF cookie domain.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"cookie-domain","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-force-secure","additionalKeys":[],"configDoc":"If enabled the CSRF cookie will have its 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookie will always be secure if HTTPS is used even if this property is set to false.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"cookie-force-secure","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.cookie-http-only","additionalKeys":[],"configDoc":"Set the HttpOnly attribute to prevent access to the cookie via JavaScript.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"cookie-http-only","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.create-token-path","additionalKeys":[],"configDoc":"Create CSRF token only if the HTTP GET relative request path matches one of the paths configured with this property. Use a comma to separate multiple path values.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"create-token-path","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"int","key":"quarkus.csrf-reactive.token-size","additionalKeys":[],"configDoc":"Random CSRF token size in bytes.","withinAMap":false,"defaultValue":"16","javaDocSiteLink":"","docMapKey":"token-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"string","key":"quarkus.csrf-reactive.token-signature-key","additionalKeys":[],"configDoc":"CSRF token HMAC signature key, if this key is set then it must be at least 32 characters long.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"token-signature-key","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.verify-token","additionalKeys":[],"configDoc":"Verify CSRF token in the CSRF filter. If you prefer then you can disable this property and compare CSRF form and cookie parameters in the application code using JAX-RS jakarta.ws.rs.FormParam which refers to the `form-field-name` form property and jakarta.ws.rs.CookieParam which refers to the `CsrfReactiveConfig++#++cookieName` cookie. Note that even if the CSRF token verification in the CSRF filter is disabled, the filter will still perform checks to ensure the token is available, has the correct `token-size` in bytes and that the Content-Type HTTP header is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"verify-token","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.csrf-reactive.require-form-url-encoded","additionalKeys":[],"configDoc":"Require that only 'application/x-www-form-urlencoded' or 'multipart/form-data' body is accepted for the token verification to proceed. Disable this property for the CSRF filter to avoid verifying the token for POST requests with other content types. This property is only effective if `verify-token` property is enabled and `token-header-name` is not configured.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"require-form-url-encoded","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.csrf-reactive","enum":false}}] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.