Skip to content

Commit 29eb017

Browse files
shawkinsshawkins
authored
task: remove hostname v1 (keycloak#32352)
closes: keycloak#27731 Signed-off-by: Steve Hawkins <[email protected]>
1 parent d9ed0a3 commit 29eb017

File tree

23 files changed

+23
-1269
lines changed

23 files changed

+23
-1269
lines changed

‎common/src/main/java/org/keycloak/common/Profile.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,6 @@ public enum Feature {
108108

109109
CLIENT_TYPES("Client Types", Type.EXPERIMENTAL),
110110

111-
HOSTNAME_V1("Hostname Options V1", Type.DEPRECATED, 1),
112111
HOSTNAME_V2("Hostname Options V2", Type.DEFAULT, 2),
113112

114113
PERSISTENT_USER_SESSIONS("Persistent online user sessions across restarts and upgrades", Type.DEFAULT),

‎common/src/test/java/org/keycloak/common/ProfileTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class ProfileTest {
3131
private static final Profile.Feature DISABLED_BY_DEFAULT_FEATURE = Profile.Feature.DOCKER;
3232
private static final Profile.Feature PREVIEW_FEATURE = Profile.Feature.ADMIN_FINE_GRAINED_AUTHZ;
3333
private static final Profile.Feature EXPERIMENTAL_FEATURE = Profile.Feature.DYNAMIC_SCOPES;
34-
private static Profile.Feature DEPRECATED_FEATURE = Profile.Feature.HOSTNAME_V1;
34+
private static Profile.Feature DEPRECATED_FEATURE = Profile.Feature.LOGIN1;
3535

3636
@Rule
3737
public TemporaryFolder temporaryFolder = new TemporaryFolder();

‎docs/documentation/release_notes/topics/26_0_0.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,14 @@ not recommended at all in production deployments of Keycloak, it is fairly frequ
130130
of `localhost`. As an alternative to the `_LEGACY` cookies Keycloak now doesn't set the `secure` flag and sets `SameSite=Lax`
131131
instead of `SameSite=None` when it detects an insecure context is used.
132132

133+
= Hostname v1 feature removed
134+
135+
The deprecated hostname v1 feature was removed. This feature was deprecated in {project_name} 25 and replaced by hostname v2. If you are still using this feature, you must migrate to hostname v2. For more details, see the https://www.keycloak.org/server/hostname[Configuring the hostname (v2)] and https://www.keycloak.org/docs/latest/upgrading/#new-hostname-options[the initial migration guide].
136+
137+
= Proxy option removed
138+
139+
The deprecated `proxy` option was removed. This option was deprecated in {project_name} 24 and replaced by the `proxy-headers` option in combination with hostname options as needed. For more details, see https://www.keycloak.org/server/reverseproxy[using a reverse proxy] and https://www.keycloak.org/docs/latest/upgrading/index.html#deprecated-proxy-option[the initial migration guide].
140+
133141
= Property `origin` in the `UserRepresentation` is deprecated
134142

135143
The `origin` property in the `UserRepresentation` is deprecated and planned to be removed in future releases.

‎docs/documentation/upgrading/topics/changes/changes-26_0_0.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,3 +183,11 @@ Additionally, the following resources have been removed from the `common` theme:
183183
- `node_modules/jquery`
184184

185185
If you previously used any of the removed resources in your theme, make sure to add them to your own theme resources instead.
186+
187+
= Hostname v1 feature removed
188+
189+
The deprecated hostname v1 feature was removed. This feature was deprecated in {project_name} 25 and replaced by hostname v2. If you are still using this feature, you must migrate to hostname v2. For more details, see the https://www.keycloak.org/server/hostname[Configuring the hostname (v2)] and https://www.keycloak.org/docs/latest/upgrading/#new-hostname-options[the initial migration guide].
190+
191+
= Proxy option removed
192+
193+
The deprecated `proxy` option was removed. This option was deprecated in {project_name} 24 and replaced by the `proxy-headers` option in combination with hostname options as needed. For more details, see https://www.keycloak.org/server/reverseproxy[using a reverse proxy] and https://www.keycloak.org/docs/latest/upgrading/index.html#deprecated-proxy-option[the initial upgrading guide].

‎docs/guides/server/hostname-deprecated.adoc‎

Lines changed: 0 additions & 158 deletions
This file was deleted.

‎docs/guides/server/reverseproxy.adoc‎

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -31,31 +31,6 @@ NOTE: When using the `xforwarded` setting, the `X-Forwarded-Port` takes preceden
3131

3232
NOTE: If the TLS connection is terminated at the reverse proxy (edge termination), enabling HTTP through the ‘http-enabled’ setting is required.
3333

34-
== Proxy modes (deprecated)
35-
NOTE: The support for setting proxy modes is deprecated and will be removed in a future {project_name} release. Consider configuring accepted reverse proxy headers instead as described in the chapter above. For migration instructions consult the https://www.keycloak.org/docs/latest/upgrading/index.html#deprecated-proxy-option[Upgrading Guide].
36-
37-
For {project_name}, your choice of proxy modes depends on the TLS termination in your environment. The following proxy modes are available:
38-
39-
edge:: Enables communication through HTTP between the proxy and {project_name}.
40-
This mode is suitable for deployments with a highly secure internal network where the reverse proxy keeps a secure connection (HTTP over TLS) with clients while communicating with {project_name} using HTTP.
41-
42-
reencrypt:: Requires communication through HTTPS between the proxy and {project_name}.
43-
This mode is suitable for deployments where internal communication between the reverse proxy and {project_name} should also be protected.
44-
Different keys and certificates are used on the reverse proxy as well as on {project_name}.
45-
46-
passthrough:: The proxy forwards the HTTPS connection to {project_name} without terminating TLS.
47-
The secure connections between the server and clients are based on the keys and certificates used by the {project_name} server.
48-
49-
When in **edge** or **reencrypt** proxy mode, {project_name} will parse the following headers and expects the reverse proxy to set them:
50-
51-
* `Forwarded` as per https://www.rfc-editor.org/rfc/rfc7239.html[RFC7239]
52-
* Non-standard `X-Forwarded-*`, such as `X-Forwarded-For`, `X-Forwarded-Proto`, `X-Forwarded-Host`, and `X-Forwarded-Port`
53-
54-
=== Configure the proxy mode in {project_name}
55-
To select the proxy mode, enter this command:
56-
57-
<@kc.start parameters="--proxy <mode>"/>
58-
5934
== Different context-path on reverse proxy
6035

6136
{project_name} assumes it is exposed through the reverse proxy under the same context path as {project_name} is configured for. By default {project_name} is exposed through the root (`/`), which means it expects to be exposed through the reverse proxy on `/` as well.

‎quarkus/config-api/src/main/java/org/keycloak/config/HostnameV1Options.java‎

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)