Skip to content

Commit e942749

Browse files
authored
Merge pull request quarkusio#47716 from fedinskiy/tls-registry-clients
Clarify documentation for usage of TLS registry in Quarkus clients
2 parents f0edda4 + 2ba7074 commit e942749

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

adr/0004-using-the-tls-registry-for-clients.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The TLS registry is an extension processing the `quarkus.tls` configuration and
2626
Note that the configuration and the runtime API are different.
2727
The configuration is used to define the TLS settings, while the runtime API is used to access these pre-processed settings.
2828

29-
hen using the options directly under `quarkus.tls.`, one configures the default (_unamed_) configuration, while using options under `quarkus.tls.<name>.` configures a _named_ configuration.
29+
When using the options directly under `quarkus.tls.`, one configures the default (_unnamed_) configuration, while using options under `quarkus.tls.<name>.` configures a _named_ configuration.
3030
For each configuration, trust stores and key stores can be defined, as well as the default protocol, cipher suites, etc.
3131
More details can be found in the https://quarkus.io/version/main/guides/tls-registry-reference[documentation] and in the https://github.com/quarkusio/quarkus/blob/main/extensions/tls-registry/runtime/src/main/java/io/quarkus/tls/runtime/config/TlsBucketConfig.java[code].
3232

docs/src/main/asciidoc/tls-registry-reference.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ Each named TLS configuration, or "TLS bucket," must provide its own properties.
5555
For instance, `quarkus.tls.reload-period` will only be applied to the default TLS configuration.
5656
====
5757

58+
[IMPORTANT]
59+
====
60+
As described in detail link:https://github.com/quarkusio/quarkus/blob/main/adr/0004-using-the-tls-registry-for-clients.adoc#configuring-clients-with-the-tls-registry[here], Quarkus client extensions (REST, GRPC, etc) ignore properties, defined in default (ie unnamed) TLS configuration.
61+
The only exception is `quarkus.tls.trust-all` property.
62+
====
63+
5864
=== Configuring HTTPS for a HTTP server
5965

6066
To ensure secure client-server communication, the client is often required to verify the server's authenticity.

extensions/resteasy-classic/rest-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -262,10 +262,9 @@ public interface RestClientsConfig {
262262
* <p>
263263
* If a name is configured, it uses the configuration from {@code quarkus.tls.<name>.*}
264264
* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
265+
* The default TLS configuration will be ignored.
265266
* <p>
266-
* If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used.
267-
* <p>
268-
* The default TLS configuration is <strong>not</strong> used by default.
267+
* If no named TLS configuration is set, then the key-store, trust-store, etc. properties will be used.
269268
* <p>
270269
* This property is not applicable to the RESTEasy Client.
271270
*/
@@ -546,10 +545,9 @@ default Optional<String> uriReload() {
546545
* <p>
547546
* If a name is configured, it uses the configuration from {@code quarkus.tls.<name>.*}
548547
* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
548+
* The default TLS configuration will be ignored.
549549
* <p>
550-
* If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used.
551-
* <p>
552-
* The default TLS configuration is <strong>not</strong> used by default.
550+
* If no named TLS configuration is set, then the key-store, trust-store, etc. properties will be used.
553551
* <p>
554552
* This property is not applicable to the RESTEasy Client.
555553
*/

0 commit comments

Comments
 (0)