From 8c071b7ebe6fb3c9be626d62b594b8d8addebfac Mon Sep 17 00:00:00 2001 From: sdelamo Date: Thu, 30 Jan 2025 15:37:59 +0000 Subject: [PATCH] Deploying to gh-pages - 15:37:59 --- snapshot/guide/configurationreference.html | 388 ++++++++++----------- 1 file changed, 194 insertions(+), 194 deletions(-) diff --git a/snapshot/guide/configurationreference.html b/snapshot/guide/configurationreference.html index 0bb66dc2ed..7bc203a9d5 100644 --- a/snapshot/guide/configurationreference.html +++ b/snapshot/guide/configurationreference.html @@ -149,9 +149,9 @@

Micronaut Security Config Propert
-🔗 +🔗 - +@@ -166,21 +166,47 @@

Micronaut Security Config Propert

- + + + + + + - + - - - + + + + + + + + + + + + + + + + + + + + + + +
Table 3. Configuration Properties for SecurityFilterConfigurationPropertiesTable 3. Configuration Properties for SecurityConfigurationProperties

micronaut.security.filter.enabled

micronaut.security.authentication

AuthenticationMode

Defines which authentication to use. Defaults to null. Possible values bearer, session, cookie, idtoken. Should + only be supplied if the service handles login and logout requests.

micronaut.security.enabled

boolean

If Security is enabled. Default value true

micronaut.security.filter.path

java.lang.String

Pattern the {@link SecurityFilter} should match. Default value /**. URLS NOT MATCHED BY PREVIOUS PATTERN ARE NOT SECURED

micronaut.security.intercept-url-map

java.util.List

Map that defines the interception patterns.

micronaut.security.ip-patterns

java.util.List

Allowed IP patterns. Default value (["0.0.0.0"])

micronaut.security.intercept-url-map-prepend-pattern-with-context-path

boolean

Whether the intercept URL patterns should be prepended with context path if defined. Defaults to true.

micronaut.security.authentication-provider-strategy

AuthenticationStrategy

Determines how authentication providers should be processed. Default value ANY. Possible values: ANY or ALL.

micronaut.security.reject-not-found

boolean

Whether the server should respond with 401 for requests that do not match any routes on the server, if you set it to false, it will return 404 for requests that do not match any routes on the server. Default value (true).
-🔗 +🔗 - +@@ -195,41 +221,26 @@

Micronaut Security Config Propert

- - - + + + - + - - - - - - - - - - - - - - - - +
Table 4. Configuration Properties for TokenPropagationConfigurationPropertiesTable 4. Configuration Properties for HttpHeaderTokenPropagatorConfigurationProperties

micronaut.security.token.propagation.service-id-regex

java.lang.String

micronaut.security.token.propagation.header.enabled

boolean

Enable HttpHeaderTokenPropagator. Default value (true).

micronaut.security.token.propagation.uri-regex

micronaut.security.token.propagation.header.prefix

java.lang.String

micronaut.security.token.propagation.service-id-pattern

java.util.regex.Pattern

micronaut.security.token.propagation.uri-pattern

java.util.regex.Pattern

micronaut.security.token.propagation.enabled

boolean

Enables TokenPropagationHttpClientFilter. Default value false

micronaut.security.token.propagation.path

micronaut.security.token.propagation.header.header-name

java.lang.String
-🔗 +🔗 - +@@ -244,21 +255,21 @@

Micronaut Security Config Propert

- - - + + + - - - + + +
Table 5. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationPropertiesTable 5. Configuration Properties for IntrospectionConfigurationProperties

micronaut.security.redirect.refresh.url

java.lang.String

Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/").

micronaut.security.endpoints.introspection.enabled

boolean

micronaut.security.redirect.refresh.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).

micronaut.security.endpoints.introspection.path

java.lang.String

Path to the IntrospectionController. Default value "/token_info"
-🔗 +🔗 - +@@ -273,38 +284,21 @@

Micronaut Security Config Propert

- - - - - - - - - - - + - - - - - - + - + - +
Table 6. Configuration Properties for RedirectConfigurationPropertiesTable 6. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationProperties

micronaut.security.redirect.login-success

java.lang.String

Where the user is redirected to after a successful login. Default value ("/").

micronaut.security.redirect.login-failure

java.lang.String

Where the user is redirected to after a failed login. Default value ("/").

micronaut.security.redirect.logout

micronaut.security.redirect.unauthorized.url

java.lang.String

URL where the user is redirected after logout. Default value ("/").

micronaut.security.redirect.prior-to-login

boolean

If true, the user should be redirected back to the unauthorized - request that initiated the login flow. Supersedes the <code>login-success</code> - configuration for those cases. Default value false.

Where the user is redirected to after trying to access a secured route. Default value ("/").

micronaut.security.redirect.enabled

micronaut.security.redirect.unauthorized.enabled

boolean

Sets whether Redirection configuration enabled. Default value (true).

Whether it should redirect on unauthorized rejections. Default value (true).
-🔗 +🔗 - +@@ -319,16 +313,16 @@

Micronaut Security Config Propert

- - - + + +
Table 7. Configuration Properties for BasicAuthAuthenticationConfigurationTable 7. Configuration Properties for AccessTokenConfigurationProperties

micronaut.security.basic-auth.enabled

boolean

Enables the {@link BasicAuthAuthenticationFetcher}. Default value true.

micronaut.security.token.generator.access-token.expiration

java.lang.Integer

Access token expiration. Default value (3600).
-🔗 +🔗 - +@@ -343,26 +337,31 @@

Micronaut Security Config Propert

- + + + + + + - + - + - + - - + +
Table 8. Configuration Properties for HttpHeaderTokenPropagatorConfigurationPropertiesTable 8. Configuration Properties for OauthControllerConfigurationProperties

micronaut.security.token.propagation.header.enabled

micronaut.security.endpoints.oauth.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.oauth.enabled

boolean

Enable HttpHeaderTokenPropagator. Default value (true).

Whether the controller is enabled.

micronaut.security.token.propagation.header.prefix

micronaut.security.endpoints.oauth.path

java.lang.String

Sets the path to map the {@link OauthController} to. Default value ("/oauth/access_token").

micronaut.security.token.propagation.header.header-name

java.lang.String

micronaut.security.endpoints.oauth.get-allowed

boolean
-🔗 +🔗 - +@@ -377,21 +376,21 @@

Micronaut Security Config Propert

- - - + + + - - - + + +
Table 9. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationPropertiesTable 9. Configuration Properties for SecurityFilterConfigurationProperties

micronaut.security.redirect.unauthorized.url

java.lang.String

Where the user is redirected to after trying to access a secured route. Default value ("/").

micronaut.security.filter.enabled

boolean

micronaut.security.redirect.unauthorized.enabled

boolean

Whether it should redirect on unauthorized rejections. Default value (true).

micronaut.security.filter.path

java.lang.String

Pattern the {@link SecurityFilter} should match. Default value /**. URLS NOT MATCHED BY PREVIOUS PATTERN ARE NOT SECURED
-🔗 +🔗 - +@@ -406,76 +405,41 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - + + + - - - + + + - - - + + + - - - + + + - + - - - -
Table 10. Configuration Properties for SecurityConfigurationPropertiesTable 10. Configuration Properties for TokenPropagationConfigurationProperties

micronaut.security.authentication

AuthenticationMode

Defines which authentication to use. Defaults to null. Possible values bearer, session, cookie, idtoken. Should - only be supplied if the service handles login and logout requests.

micronaut.security.enabled

boolean

If Security is enabled. Default value true

micronaut.security.intercept-url-map

java.util.List

Map that defines the interception patterns.

micronaut.security.token.propagation.service-id-regex

java.lang.String

micronaut.security.ip-patterns

java.util.List

Allowed IP patterns. Default value (["0.0.0.0"])

micronaut.security.token.propagation.uri-regex

java.lang.String

micronaut.security.intercept-url-map-prepend-pattern-with-context-path

boolean

Whether the intercept URL patterns should be prepended with context path if defined. Defaults to true.

micronaut.security.token.propagation.service-id-pattern

java.util.regex.Pattern

micronaut.security.authentication-provider-strategy

AuthenticationStrategy

Determines how authentication providers should be processed. Default value ANY. Possible values: ANY or ALL.

micronaut.security.token.propagation.uri-pattern

java.util.regex.Pattern

micronaut.security.reject-not-found

micronaut.security.token.propagation.enabled

boolean

Whether the server should respond with 401 for requests that do not match any routes on the server, if you set it to false, it will return 404 for requests that do not match any routes on the server. Default value (true).

-
-🔗 - - ----- - - - - - + - - - + - - - - - - +
Table 11. Configuration Properties for X509ConfigurationProperties
PropertyTypeDescription

Enables TokenPropagationHttpClientFilter. Default value false

micronaut.security.x509.subject-dn-regex

micronaut.security.token.propagation.path

java.lang.String

Set the Subject DN regex. Default value "CN=(.*?)(?:,

$)".

micronaut.security.x509.enabled

boolean
-🔗 +🔗 - +@@ -490,26 +454,31 @@

Micronaut Security Config Propert

- + - + - + - + + + + + +
Table 12. Configuration Properties for LoginControllerConfigurationPropertiesTable 11. Configuration Properties for LogoutControllerConfigurationProperties

micronaut.security.endpoints.login.post-content-types

micronaut.security.endpoints.logout.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.login.enabled

micronaut.security.endpoints.logout.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.login.path

micronaut.security.endpoints.logout.path

java.lang.String

Path to the controller.

Path to the LogoutController. Default value "/logout".

micronaut.security.endpoints.logout.get-allowed

boolean
🔗 - +@@ -566,9 +535,9 @@

Micronaut Security Config Propert

Table 13. Configuration Properties for TokenCookieConfigurationPropertiesTable 12. Configuration Properties for TokenCookieConfigurationProperties
-🔗 +🔗 - +@@ -583,31 +552,21 @@

Micronaut Security Config Propert

- - - - - - - - - - - + - + - + + -
Table 14. Configuration Properties for OauthControllerConfigurationPropertiesTable 13. Configuration Properties for X509ConfigurationProperties

micronaut.security.endpoints.oauth.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.oauth.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.oauth.path

micronaut.security.x509.subject-dn-regex

java.lang.String

Sets the path to map the {@link OauthController} to. Default value ("/oauth/access_token").

Set the Subject DN regex. Default value "CN=(.*?)(?:,

micronaut.security.endpoints.oauth.get-allowed

$)".

micronaut.security.x509.enabled

boolean
-🔗 +🔗 - +@@ -622,16 +581,26 @@

Micronaut Security Config Propert

- - - + + + + + + + + + + + + +
Table 15. Configuration Properties for AccessTokenConfigurationPropertiesTable 14. Configuration Properties for BearerTokenConfigurationProperties

micronaut.security.token.generator.access-token.expiration

java.lang.Integer

Access token expiration. Default value (3600).

micronaut.security.token.bearer.enabled

boolean

Set whether to enable bearer token authentication. Default value true.

micronaut.security.token.bearer.prefix

java.lang.String

Sets the prefix to use for the auth token. Default value Bearer.

micronaut.security.token.bearer.header-name

java.lang.String

Sets the header name to use. Default value Authorization.
-🔗 +🔗 - +@@ -646,21 +615,26 @@

Micronaut Security Config Propert

- + + + + + + - + - + - +
Table 16. Configuration Properties for IntrospectionConfigurationPropertiesTable 15. Configuration Properties for LoginControllerConfigurationProperties

micronaut.security.endpoints.introspection.enabled

micronaut.security.endpoints.login.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.login.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.introspection.path

micronaut.security.endpoints.login.path

java.lang.String

Path to the IntrospectionController. Default value "/token_info"

Path to the controller.
-🔗 +🔗 - +@@ -675,26 +649,38 @@

Micronaut Security Config Propert

- - - + + + - + - + - + - + + + + + + + + + + +
Table 17. Configuration Properties for BearerTokenConfigurationPropertiesTable 16. Configuration Properties for RedirectConfigurationProperties

micronaut.security.token.bearer.enabled

boolean

Set whether to enable bearer token authentication. Default value true.

micronaut.security.redirect.login-success

java.lang.String

Where the user is redirected to after a successful login. Default value ("/").

micronaut.security.token.bearer.prefix

micronaut.security.redirect.login-failure

java.lang.String

Sets the prefix to use for the auth token. Default value Bearer.

Where the user is redirected to after a failed login. Default value ("/").

micronaut.security.token.bearer.header-name

micronaut.security.redirect.logout

java.lang.String

Sets the header name to use. Default value Authorization.

URL where the user is redirected after logout. Default value ("/").

micronaut.security.redirect.prior-to-login

boolean

If true, the user should be redirected back to the unauthorized + request that initiated the login flow. Supersedes the <code>login-success</code> + configuration for those cases. Default value false.

micronaut.security.redirect.enabled

boolean

Sets whether Redirection configuration enabled. Default value (true).
-🔗 +🔗 - +@@ -709,31 +695,21 @@

Micronaut Security Config Propert

- - - - - - - - - - - + - + - + - +
Table 18. Configuration Properties for LogoutControllerConfigurationPropertiesTable 17. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationProperties

micronaut.security.endpoints.logout.post-content-types

java.util.Set

Supported content types for POST endpoints. Default Value application/json and application/x-www-form-urlencoded

micronaut.security.endpoints.logout.enabled

boolean

Whether the controller is enabled.

micronaut.security.endpoints.logout.path

micronaut.security.redirect.refresh.url

java.lang.String

Path to the LogoutController. Default value "/logout".

Where the user is redirected to after trying to access a secured route which he is forbidden to access. Default value ("/").

micronaut.security.endpoints.logout.get-allowed

micronaut.security.redirect.refresh.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).
🔗 - +@@ -760,6 +736,30 @@

Micronaut Security Config Propert

Table 19. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationPropertiesTable 18. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationProperties
+🔗 + + +++++ + + + + + + + + + + + + + + +
Table 19. Configuration Properties for BasicAuthAuthenticationConfiguration
PropertyTypeDescription

micronaut.security.basic-auth.enabled

boolean

Enables the {@link BasicAuthAuthenticationFetcher}. Default value true.

+

Micronaut Security Csrf Config Properties