-
Notifications
You must be signed in to change notification settings - Fork 6.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
KEYCLOAK-2469 - Introduced new redirect endpoint for clients.
Previously one had to configure hardcoded urls to link from one client
application to others since keycloak didn't provide a way to get the
actual client URL by providing clientId and realm information.
We now support a new endpoint with the path {realm}/clients/{client_id}/redirect
that responds to GET requests with a 307 (temporary redirect) with the
configured client URL. This allows to refer to any client just by the
realmName and clientId and let Keycloak redirect to the actual client
application.
Add documentation for new redirect endpoint.- Loading branch information
1 parent
4b69cb4
commit 41358ee
Showing
4 changed files
with
182 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
docbook/auth-server-docs/reference/en/en-US/modules/clients.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| <!-- | ||
| ~ Copyright 2016 Red Hat, Inc. and/or its affiliates | ||
| ~ and other contributors as indicated by the @author tags. | ||
| ~ | ||
| ~ Licensed under the Apache License, Version 2.0 (the "License"); | ||
| ~ you may not use this file except in compliance with the License. | ||
| ~ You may obtain a copy of the License at | ||
| ~ | ||
| ~ http://www.apache.org/licenses/LICENSE-2.0 | ||
| ~ | ||
| ~ Unless required by applicable law or agreed to in writing, software | ||
| ~ distributed under the License is distributed on an "AS IS" BASIS, | ||
| ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| ~ See the License for the specific language governing permissions and | ||
| ~ limitations under the License. | ||
| --> | ||
|
|
||
| <chapter id="clients"> | ||
| <title>Clients</title> | ||
|
|
||
| <para> | ||
| Keycloak provides support for managing OAuth clients. | ||
| </para> | ||
|
|
||
| <section id="client-config"> | ||
| <title>Client Config</title> | ||
| <para> | ||
| Keycloak supports flexible configuration of OAuth Clients. | ||
| </para> | ||
|
|
||
| <section> | ||
| <title>Redirect Endpoint</title> | ||
| <para> | ||
| For scenarios where one wants to link from one client to another, Keycloak provides a special redirect endpoint: | ||
| <literal>/realms/realm_name/clients/client_id/redirect</literal>. | ||
| </para> | ||
|
|
||
| <para> | ||
| If a client accesses this endpoint via an <literal>HTTP GET</literal> request, Keycloak returns the configured base URL | ||
| for the provided Client and Realm in the form of an <literal>HTTP 307</literal> (Temporary Redirect) via the response's <literal>Location</literal> header. | ||
| </para> | ||
|
|
||
| <para> | ||
| Thus, a client only needs to know the Realm name and the Client ID in order to link to them. | ||
| This indirection helps avoid hard-coding client base URLs. | ||
| </para> | ||
|
|
||
| <para> | ||
| As an example, given the realm <literal>master</literal> and the client-id <literal>account</literal>: | ||
| <programlisting>http://keycloak-host:keycloak-port/auth/realms/master/clients/account/redirect</programlisting> | ||
|
|
||
| Would temporarily redirect to: | ||
| <programlisting>http://keycloak-host:keycloak-port/auth/realms/master/account</programlisting> | ||
| </para> | ||
| </section> | ||
| </section> | ||
| </chapter> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
testsuite/integration/src/test/java/org/keycloak/testsuite/RealmResourceTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| package org.keycloak.testsuite; | ||
|
|
||
| import org.junit.ClassRule; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
| import org.keycloak.models.ClientModel; | ||
| import org.keycloak.models.RealmModel; | ||
| import org.keycloak.services.managers.RealmManager; | ||
| import org.keycloak.testsuite.rule.KeycloakRule; | ||
| import org.keycloak.testsuite.rule.KeycloakRule.KeycloakSetup; | ||
| import org.keycloak.testsuite.rule.WebResource; | ||
| import org.keycloak.testsuite.rule.WebRule; | ||
| import org.openqa.selenium.WebDriver; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
|
|
||
| /** | ||
| * @author <a href="mailto:thomas.darimont@gmail.com">Thomas Darimont</a> | ||
| */ | ||
| public class RealmResourceTest { | ||
|
|
||
| @ClassRule | ||
| public static KeycloakRule keycloakRule = new KeycloakRule(new KeycloakSetup() { | ||
|
|
||
| @Override | ||
| public void config(RealmManager manager, RealmModel adminstrationRealm, RealmModel appRealm) { | ||
|
|
||
| RealmModel testRealm = manager.getRealmByName("test"); | ||
|
|
||
| ClientModel launchpadClient = testRealm.addClient("launchpad-test"); | ||
| launchpadClient.setBaseUrl(""); | ||
| launchpadClient.setRootUrl("http://example.org/launchpad"); | ||
|
|
||
| ClientModel dummyClient = testRealm.addClient("dummy-test"); | ||
| dummyClient.setRootUrl("http://example.org/dummy"); | ||
| dummyClient.setBaseUrl("/base-path"); | ||
| } | ||
| }); | ||
|
|
||
| @Rule | ||
| public WebRule webRule = new WebRule(this); | ||
|
|
||
| @WebResource | ||
| protected OAuthClient oauth; | ||
|
|
||
| @WebResource | ||
| protected WebDriver webDriver; | ||
|
|
||
| private static int getKeycloakPort() { | ||
|
|
||
| String keycloakPort = System.getProperty("keycloak.port", System.getenv("KEYCLOAK_DEV_PORT")); | ||
|
|
||
| try { | ||
| return Integer.parseInt(keycloakPort); | ||
| } catch (Exception ex) { | ||
| return 8081; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Integration test for {@link org.keycloak.services.resources.RealmsResource#getRedirect(String, String)}. | ||
| * | ||
| * @throws Exception | ||
| */ | ||
| @Test | ||
| public void testClientRedirectEndpoint() throws Exception { | ||
|
|
||
| oauth.doLogin("test-user@localhost", "password"); | ||
|
|
||
| webDriver.get("http://localhost:" + getKeycloakPort() + "/auth/realms/test/clients/launchpad-test/redirect"); | ||
| assertEquals("http://example.org/launchpad", webDriver.getCurrentUrl()); | ||
|
|
||
| webDriver.get("http://localhost:" + getKeycloakPort() + "/auth/realms/test/clients/dummy-test/redirect"); | ||
| assertEquals("http://example.org/dummy/base-path", webDriver.getCurrentUrl()); | ||
|
|
||
| webDriver.get("http://localhost:" + getKeycloakPort() + "/auth/realms/test/clients/account/redirect"); | ||
| assertEquals("http://localhost:" + getKeycloakPort() + "/auth/realms/test/account", webDriver.getCurrentUrl()); | ||
| } | ||
| } |