From 85e5d4a4dce75bd312081502448ba36516bc7630 Mon Sep 17 00:00:00 2001 From: sdelamo Date: Fri, 26 Jan 2024 08:38:43 +0000 Subject: [PATCH] Deploying to gh-pages - 08:38:43 --- snapshot/guide/configurationreference.html | 476 ++++++++++----------- 1 file changed, 238 insertions(+), 238 deletions(-) diff --git a/snapshot/guide/configurationreference.html b/snapshot/guide/configurationreference.html index 89cc165f4c..bd2b5445a5 100644 --- a/snapshot/guide/configurationreference.html +++ b/snapshot/guide/configurationreference.html @@ -51,9 +51,9 @@

Configuration Reference

Micronaut Security Config Properties

-🔗 +🔗 - +@@ -68,26 +68,26 @@

Micronaut Security Config Propert

- + - + - + - + - + - +
Table 1. Configuration Properties for BearerTokenConfigurationPropertiesTable 1. Configuration Properties for HttpHeaderTokenPropagatorConfigurationProperties

micronaut.security.token.bearer.enabled

micronaut.security.token.propagation.header.enabled

boolean

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

Enable HttpHeaderTokenPropagator. Default value (true).

micronaut.security.token.bearer.prefix

micronaut.security.token.propagation.header.prefix

java.lang.String

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

micronaut.security.token.bearer.header-name

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

java.lang.String

Sets the header name to use. Default value Authorization.
-🔗 +🔗 - +@@ -102,50 +102,38 @@

Micronaut Security Config Propert

- - - + + + - + - + - -
Table 2. Configuration Properties for IntrospectionConfigurationPropertiesTable 2. Configuration Properties for RedirectConfigurationProperties

micronaut.security.endpoints.introspection.enabled

boolean

micronaut.security.redirect.login-success

java.lang.String

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

micronaut.security.endpoints.introspection.path

micronaut.security.redirect.login-failure

java.lang.String

Path to the IntrospectionController. Default value "/token_info"

Where the user is redirected to after a failed login. Default value ("/").
-
-🔗 - - ----- - - - - + + + - - - + - + - - - + + +
Table 3. Configuration Properties for LoginControllerConfigurationProperties
PropertyTypeDescription

micronaut.security.redirect.logout

java.lang.String

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

micronaut.security.endpoints.login.enabled

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.endpoints.login.path

java.lang.String

Path to the LoginController. Default value "/login"

micronaut.security.redirect.enabled

boolean

Sets whether Redirection configuration enabled. Default value (true).
-🔗 +🔗 - +@@ -160,47 +148,16 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - +
Table 4. Configuration Properties for SecurityConfigurationPropertiesTable 3. Configuration Properties for BasicAuthAuthenticationConfiguration

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.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

micronaut.security.basic-auth.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).

Enables the {@link BasicAuthAuthenticationFetcher}. Default value true.
-🔗 +🔗 - +@@ -215,21 +172,21 @@

Micronaut Security Config Propert

- + - + - - + +
Table 5. Configuration Properties for X509ConfigurationPropertiesTable 4. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationProperties

micronaut.security.x509.subject-dn-regex

micronaut.security.redirect.unauthorized.url

java.lang.String

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

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

$)".

micronaut.security.x509.enabled

micronaut.security.redirect.unauthorized.enabled

boolean

Whether it should redirect on unauthorized rejections. Default value (true).
🔗 - +@@ -276,9 +233,9 @@

Micronaut Security Config Propert

Table 6. Configuration Properties for TokenPropagationConfigurationPropertiesTable 5. Configuration Properties for TokenPropagationConfigurationProperties
-🔗 +🔗 - +@@ -293,26 +250,21 @@

Micronaut Security Config Propert

- + - - - - - - + - +
Table 7. Configuration Properties for HttpHeaderTokenPropagatorConfigurationPropertiesTable 6. Configuration Properties for LoginControllerConfigurationProperties

micronaut.security.token.propagation.header.enabled

micronaut.security.endpoints.login.enabled

boolean

Enable HttpHeaderTokenPropagator. Default value (true).

micronaut.security.token.propagation.header.prefix

java.lang.String

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

micronaut.security.endpoints.login.path

java.lang.String

Path to the LoginController. Default value "/login"
-🔗 +🔗 - +@@ -327,26 +279,51 @@

Micronaut Security Config Propert

- + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - - + +
Table 8. Configuration Properties for LogoutControllerConfigurationPropertiesTable 7. Configuration Properties for TokenCookieConfigurationProperties

micronaut.security.endpoints.logout.enabled

micronaut.security.token.cookie.cookie-domain

java.lang.String

micronaut.security.token.cookie.cookie-http-only

java.lang.Boolean

micronaut.security.token.cookie.cookie-secure

java.lang.Boolean

micronaut.security.token.cookie.cookie-max-age

java.time.Duration

micronaut.security.token.cookie.cookie-same-site

SameSite

Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: Strict, Lax or None.

micronaut.security.token.cookie.enabled

boolean

micronaut.security.endpoints.logout.path

micronaut.security.token.cookie.cookie-name

java.lang.String

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

micronaut.security.endpoints.logout.get-allowed

boolean

micronaut.security.token.cookie.cookie-path

java.lang.String
-🔗 +🔗 - +@@ -361,21 +338,51 @@

Micronaut Security Config Propert

- + - + - + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + +
Table 9. Configuration Properties for RedirectConfigurationProperties$UnauthorizedRedirectConfigurationPropertiesTable 8. Configuration Properties for RefreshTokenCookieConfigurationProperties

micronaut.security.redirect.unauthorized.url

micronaut.security.token.refresh.cookie.cookie-domain

java.lang.String

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

micronaut.security.redirect.unauthorized.enabled

micronaut.security.token.refresh.cookie.cookie-http-only

java.lang.Boolean

micronaut.security.token.refresh.cookie.cookie-secure

java.lang.Boolean

micronaut.security.token.refresh.cookie.cookie-max-age

java.time.Duration

micronaut.security.token.refresh.cookie.cookie-same-site

SameSite

Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: Strict, Lax or None.

micronaut.security.token.refresh.cookie.enabled

boolean

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

micronaut.security.token.refresh.cookie.cookie-name

java.lang.String

micronaut.security.token.refresh.cookie.cookie-path

java.lang.String
-🔗 +🔗 - +@@ -390,26 +397,26 @@

Micronaut Security Config Propert

- + - + - + - + - - - + + +
Table 10. Configuration Properties for OauthControllerConfigurationPropertiesTable 9. Configuration Properties for BearerTokenConfigurationProperties

micronaut.security.endpoints.oauth.enabled

micronaut.security.token.bearer.enabled

boolean

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

micronaut.security.endpoints.oauth.path

micronaut.security.token.bearer.prefix

java.lang.String

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

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

micronaut.security.endpoints.oauth.get-allowed

boolean

micronaut.security.token.bearer.header-name

java.lang.String

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

Micronaut Security Config Propert

- + + + + + + - + - + - +
Table 11. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationPropertiesTable 10. Configuration Properties for LogoutControllerConfigurationProperties

micronaut.security.redirect.forbidden.url

micronaut.security.endpoints.logout.enabled

boolean

micronaut.security.endpoints.logout.path

java.lang.String

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

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

micronaut.security.redirect.forbidden.enabled

micronaut.security.endpoints.logout.get-allowed

boolean

Whether it should redirect on forbidden rejections. Default value (true).
-🔗 +🔗 - +@@ -453,21 +465,47 @@

Micronaut Security Config Propert

- - - + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 12. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationPropertiesTable 11. Configuration Properties for SecurityConfigurationProperties

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.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.redirect.refresh.enabled

micronaut.security.enabled

boolean

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

If Security is enabled. Default value true

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).
-🔗 +🔗 - +@@ -482,16 +520,21 @@

Micronaut Security Config Propert

- - - + + + + + + + +
Table 13. Configuration Properties for AccessTokenConfigurationPropertiesTable 12. Configuration Properties for X509ConfigurationProperties

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

java.lang.Integer

Access token expiration. Default value (3600).

micronaut.security.x509.subject-dn-regex

java.lang.String

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

$)".

micronaut.security.x509.enabled

boolean
-🔗 +🔗 - +@@ -506,51 +549,26 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - + +
Table 14. Configuration Properties for TokenCookieConfigurationPropertiesTable 13. Configuration Properties for OauthControllerConfigurationProperties

micronaut.security.token.cookie.cookie-domain

java.lang.String

micronaut.security.token.cookie.cookie-http-only

java.lang.Boolean

micronaut.security.token.cookie.cookie-secure

java.lang.Boolean

micronaut.security.token.cookie.cookie-max-age

java.time.Duration

micronaut.security.token.cookie.cookie-same-site

SameSite

Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: Strict, Lax or None.

micronaut.security.token.cookie.enabled

micronaut.security.endpoints.oauth.enabled

boolean

micronaut.security.token.cookie.cookie-name

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.cookie.cookie-path

java.lang.String

micronaut.security.endpoints.oauth.get-allowed

boolean
-🔗 +🔗 - +@@ -565,21 +583,21 @@

Micronaut Security Config Propert

- - - + + + - - - + + +
Table 15. Configuration Properties for SecurityFilterConfigurationPropertiesTable 14. Configuration Properties for RedirectConfigurationProperties$RefreshRedirectConfigurationProperties

micronaut.security.filter.enabled

boolean

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.filter.path

java.lang.String

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

micronaut.security.redirect.refresh.enabled

boolean

Whether it should redirect on forbidden rejections. Default value (true).
-🔗 +🔗 - +@@ -594,16 +612,21 @@

Micronaut Security Config Propert

- + - + + + + + +
Table 16. Configuration Properties for BasicAuthAuthenticationConfigurationTable 15. Configuration Properties for IntrospectionConfigurationProperties

micronaut.security.basic-auth.enabled

micronaut.security.endpoints.introspection.enabled

boolean

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

micronaut.security.endpoints.introspection.path

java.lang.String

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

Micronaut Security Config Propert

- - - - - - - - - - - - - - - - + - + - - - + + +
Table 17. Configuration Properties for RedirectConfigurationPropertiesTable 16. Configuration Properties for SecurityFilterConfigurationProperties

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

java.lang.String

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

micronaut.security.redirect.prior-to-login

micronaut.security.filter.enabled

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).

micronaut.security.filter.path

java.lang.String

Pattern the {@link SecurityFilter} should match. Default value /**. URLS NOT MATCHED BY PREVIOUS PATTERN ARE NOT SECURED
-🔗 +🔗 - +@@ -664,51 +670,16 @@

Micronaut Security Config Propert

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
Table 18. Configuration Properties for RefreshTokenCookieConfigurationPropertiesTable 17. Configuration Properties for AccessTokenConfigurationProperties

micronaut.security.token.refresh.cookie.cookie-domain

java.lang.String

micronaut.security.token.refresh.cookie.cookie-http-only

java.lang.Boolean

micronaut.security.token.refresh.cookie.cookie-secure

java.lang.Boolean

micronaut.security.token.refresh.cookie.cookie-max-age

java.time.Duration

micronaut.security.token.refresh.cookie.cookie-same-site

SameSite

Sets the same-site setting of the cookie. Default value null. Value is case sensitive. Allowed values: Strict, Lax or None.

micronaut.security.token.refresh.cookie.enabled

boolean

micronaut.security.token.refresh.cookie.cookie-name

java.lang.String

micronaut.security.token.refresh.cookie.cookie-path

java.lang.String

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

java.lang.Integer

Access token expiration. Default value (3600).
🔗 - +@@ -745,6 +716,35 @@

Micronaut Security Config Propert

Table 19. Configuration Properties for TokenConfigurationPropertiesTable 18. Configuration Properties for TokenConfigurationProperties
+🔗 + + +++++ + + + + + + + + + + + + + + + + + + + +
Table 19. Configuration Properties for RedirectConfigurationProperties$ForbiddenRedirectConfigurationProperties
PropertyTypeDescription

micronaut.security.redirect.forbidden.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.redirect.forbidden.enabled

boolean

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

+

Micronaut Security Jwt Config Properties