External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-10 15:32:05 -03:30
Code Issues Packages Projects Releases Wiki Activity

fix: refining https-protocols documentation

Browse Source 
closes: #43164


(cherry picked from commit 700b86fad85c17d90cc133013e5704e760f30686)

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
This commit is contained in:
Steven Hawkins 2025-10-14 13:02:31 -04:00 committed by GitHub
parent a97613bf7b
commit f20dd66196
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 35 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guides/server/enabletls.adoc
View File

@ -52,7 +52,7 @@ However, as a temporary work-around, you can enable deprecated protocols by runn
<@kc.start parameters="--https-protocols=<protocol>[,<protocol>]"/>
To also allow TLSv1.2, use a command such as the following: `kc.sh start --https-protocols=TLSv1.3,TLSv1.2`.
For example to only enable TLSv1.3, use a command such as the following: `kc.sh start --https-protocols=TLSv1.3`.
== Switching the HTTPS port
{project_name} listens for HTTPS traffic on port `8443`. To change this port, use the following command:

6
quarkus/config-api/src/main/java/org/keycloak/config/HttpOptions.java
View File

@ -59,8 +59,10 @@ public class HttpOptions {
public static final Option<List<String>> HTTPS_PROTOCOLS = OptionBuilder.listOptionBuilder("https-protocols", String.class)
.category(OptionCategory.HTTP)
.description("The list of protocols to explicitly enable.")
.defaultValue(Arrays.asList("TLSv1.3,TLSv1.2"))
.description("The list of protocols to explicitly enable. If a value is not supported by the JRE / security configuration, it will be silently ignored.")
.expectedValues(Arrays.asList("TLSv1.3", "TLSv1.2"))
.strictExpectedValues(false)
.defaultValue(Arrays.asList("TLSv1.3", "TLSv1.2"))
.build();
public static final Option<String> HTTPS_CERTIFICATES_RELOAD_PERIOD = new OptionBuilder<>("https-certificates-reload-period", String.class)

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelp.approved.txt vendored
View File

@ -183,7 +183,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt vendored
View File

@ -243,7 +243,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelp.approved.txt vendored
View File

@ -215,7 +215,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt vendored
View File

@ -244,7 +244,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelp.approved.txt vendored
View File

@ -192,7 +192,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt vendored
View File

@ -221,7 +221,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelp.approved.txt vendored
View File

@ -214,7 +214,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelpAll.approved.txt vendored
View File

@ -243,7 +243,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelp.approved.txt vendored
View File

@ -212,7 +212,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.

4
quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelpAll.approved.txt vendored
View File

@ -241,7 +241,9 @@ HTTP(S):
no value is set, it defaults to 'BCFKS'.
--https-port <port> The used HTTPS port. Default: 8443.
--https-protocols <protocols>
The list of protocols to explicitly enable. Default: TLSv1.3,TLSv1.2.
The list of protocols to explicitly enable. If a value is not supported by the
JRE / security configuration, it will be silently ignored. Possible values
are: TLSv1.3, TLSv1.2, or a custom one. Default: TLSv1.3,TLSv1.2.
--https-trust-store-file <file>
The trust store which holds the certificate information of the certificates to
trust.