Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 30, 2024
1 parent 8a62fd9 commit 1042f3f
Show file tree
Hide file tree
Showing 7 changed files with 122 additions and 12 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

26 changes: 24 additions & 2 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6040,14 +6040,36 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]`


[.description]
--
Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:

- RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.
- 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.
- 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).
- 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier`

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++`
endif::add-copy-button-to-env-var[]
--|string
|`CN`


a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]`


[.description]
--
Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.

Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
Expand Down
26 changes: 24 additions & 2 deletions _generated-doc/main/config/quarkus-http-http-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,36 @@ h|[[quarkus-http-http-configuration_configuration]]link:#quarkus-http-http-confi
h|Type
h|Default

a| [[quarkus-http-http-configuration_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-http-http-configuration_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]`


[.description]
--
Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:

- RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.
- 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.
- 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).
- 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier`

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++`
endif::add-copy-button-to-env-var[]
--|string
|`CN`


a| [[quarkus-http-http-configuration_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-http-http-configuration_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]`


[.description]
--
Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.

Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,36 @@ h|[[quarkus-vertx-http-config-group-auth-runtime-config_configuration]]link:#qua
h|Type
h|Default

a| [[quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]`


[.description]
--
Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:

- RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.
- 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.
- 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).
- 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier`

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++`
endif::add-copy-button-to-env-var[]
--|string
|`CN`


a| [[quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http-config-group-auth-runtime-config_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]`


[.description]
--
Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.

Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,36 @@ endif::add-copy-button-to-env-var[]
|`true`


a| [[quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]`


[.description]
--
Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:

- RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.
- 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.
- 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).
- 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier`

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++`
endif::add-copy-button-to-env-var[]
--|string
|`CN`


a| [[quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http-general-config-items_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]`


[.description]
--
Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.

Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
Expand Down
26 changes: 24 additions & 2 deletions _generated-doc/main/config/quarkus-vertx-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -251,14 +251,36 @@ endif::add-copy-button-to-env-var[]
|


a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-attribute[quarkus.http.auth.certificate-role-attribute]`


[.description]
--
Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:

- RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.
- 'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.
- 'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).
- 'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: `subjectAltName=otherName:1.2.3.4;UTF8:other-identifier`

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE+++`
endif::add-copy-button-to-env-var[]
--|string
|`CN`


a| [[quarkus-vertx-http_quarkus-http-auth-certificate-role-properties]]`link:#quarkus-vertx-http_quarkus-http-auth-certificate-role-properties[quarkus.http.auth.certificate-role-properties]`


[.description]
--
Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.
Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.

Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.
Properties file is expected to have the `CN_VALUE=role1,role,...,roleN` format and should be encoded using UTF-8.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES+++[]
Expand Down

0 comments on commit 1042f3f

Please sign in to comment.