libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

9925 Review of the hostname topic

Browse source
This commit is contained in:
AndyMunro 2022-02-02 17:36:50 -05:00 committed by Stian Thorgersen
parent d8c5f9e2fc
commit eedf1ef6cb
1 changed files with 16 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs/guides/src/main/server/hostname.adoc
View file

@ -7,44 +7,43 @@ title="Configure the Hostname"
summary="Learn how to configure the frontend and backchannel endpoints exposed by Keycloak."
includedOptions="hostname-* proxy">
When running Keycloak in environments such as Kubernetes, OpenShift or even on-premise, you usually do not want to expose the internal URLs to the public facing internet. Instead, you want to use your public hostname. This guide will show you how to configure Keycloak to use the right hostname for different scenarios.
When running Keycloak in environments such as Kubernetes, OpenShift, or on-premise, you want to protect the internal URLs from exposure to the public facing internet. You want to use your public hostname. This guide describes how to configure Keycloak to use the right hostname for different scenarios.
== Keycloak API Endpoint categories
Keycloak exposes three different API endpoint categories, each using a specific base URL. These categories are:
As this section explains, Keycloak exposes three API endpoint categories: frontend, backend, and administrative. Each category uses a specific base URL.
=== Frontend Endpoints
Frontend endpoints are used to externally access Keycloak. When no Hostname is set, the base URL used for the frontend is taken from the incoming request. This has some major disadvantages, e.g. in High availability setups spanning multiple Keycloak instances, where it should not depend on the instance the request lands what URL is used, but instead one URL should be used for all instances, so they are seen as one system from the outside.
Frontend endpoints are used to externally access Keycloak. When no hostname is set, the base URL used for the frontend is taken from the incoming request. This choice has some major disadvantages. For example, in a high availability scenario, you may have multiple Keycloak instances. The choice of URL should not depend on the instance where the request lands. The URL should be used for all instances, so they are seen as one system from the outside.
The `hostname` property can be used to set the hostname part of the frontend base URL:
To set the hostname part of the frontend base URL, enter the `kc.start` command in this format:
<@kc.start parameters="--hostname=<value>"/>
=== Backend Endpoints
Backend endpoints are used for direct communication between Keycloak and applications. Examples are the Token endpoint or the User info endpoint. Backend endpoints are also taking the base URL from the request by default. To override this behaviour, set the `hostname-strict-backchannel` configuration option:
Backend endpoints are used for direct communication between Keycloak and applications. Examples of backend endpoints are the Token endpoint and the User info endpoint. Backend endpoints are also taking the base URL from the request by default. To override this behavior, set the `hostname-strict-backchannel` configuration option by entering the `kc.start` command in this format:
<@kc.start parameters="--hostname=<value> --hostname-strict-backchannel=true"/>
When all applications connected to Keycloak communicate through the public URL, set `hostname-strict-backchannel` to true. Otherwise, leave it as false to allow internal applications to communicate with Keycloak through an internal URL
When all applications connected to Keycloak communicate through the public URL, set `hostname-strict-backchannel` to true. Otherwise, leave this parameter as false to allow internal applications to communicate with Keycloak through an internal URL.
=== Administrative Endpoints
When the admin console is exposed on a different hostname, use `--hostname-admin` to link to it:
When the Admin Console is exposed on a different hostname, use `--hostname-admin` to link to it. Enter the `kc.start` command in this format:
<@kc.start parameters="--hostname=<hostname> --hostname-admin=<adminHostname>"/>
When `hostname-admin` is configured, all links and static resources used to render the admin console are served from the value you enter for `<adminHostname>` instead of using `<hostname>`.
When `hostname-admin` is configured, all links and static resources used to render the Admin Console are served from the value you enter for `<adminHostname>` instead of the value for `<hostname>`.
Keycloaks administration endpoints and its admin console should not be publicly accessible at all to reduce attack surface, so you might want to secure them using a reverse proxy. For more information about which paths to expose using a reverse proxy, please refer to the <@links.server id="proxy"/> Guide.
To reduce attack surface, the administration endpoints for Keycloak and the Admin Console should not be publicly accessible. Therefore, you can secure them by using a reverse proxy. For more information about which paths to expose using a reverse proxy, see the <@links.server id="proxy"/> Guide.
== Overriding the hostname path
When running behind a reverse proxy, you may expose Keycloak using a different context path such as `myproxy.url/mykeycloak`. To do this, you can override the hostname path to use the path defined in your reverse proxy:
When running Keycloak behind a reverse proxy, you may expose Keycloak using a different context path such as `myproxy.url/mykeycloak`. To perform this action, you can override the hostname path to use the path defined in your reverse proxy:
<@kc.start parameters="--hostname=myurl --hostname-path=mykeycloak"/>
The `hostname-path` configuration only takes effect when a reverse proxy is enabled. Please see the <@links.server id="proxy"/> Guide for details.
The `hostname-path` configuration takes effect when a reverse proxy is enabled. For details, see the <@links.server id="proxy"/> Guide.
== Using the hostname in development mode
When running Keycloak in development mode by using `start-dev`, the hostname setting is optional. When the `hostname` is not specified the incoming request headers will be used.
You run Keycloak in development mode by using `start-dev`. In this mode, the hostname setting is optional. When it is omitted, the incoming request headers are used.
=== Example: Hostname in development mode
.Keycloak configuration:
@ -63,16 +62,16 @@ curl GET "https://localhost:8080/realms/master/.well-known/openid-configuration"
# Backend endpoints: request://request:request -> http://localhost:8080
----
Invoking the curl GET request above when running in development mode will show you the current OpenID Discovery configuration. In this configuration, all base URLS will be taken from the incoming request, so `http://localhost:8080` will be used for all endpoints.
In this example of using a curl GET request, the result shows the current OpenID Discovery configuration. All base URLS are taken from the incoming request, so `http://localhost:8080` is used for all endpoints.
== Example Scenarios
Here are a few more example scenarios and the corresponding commands for setting up a hostname.
The following are more example scenarios and the corresponding commands for setting up a hostname.
=== Assumptions for all scenarios
* Keycloak is set up using HTTPS certificates and Port 8443.
* `intlUrl` refers to an internal IP/DNS for Keycloak
* `intlUrl` refers to an internal IP/DNS for Keycloak.
* `myUrl` refers to an exposed public URL
* Keycloak runs in production mode using the `start` command
* Keycloak runs in production mode using the `start` command.
=== Example 1: Hostname configuration without reverse proxy
.Keycloak configuration: