forked from keycloak/keycloak
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Better management of domains in TrustedHostClientRegistrationPolicy (#…
…139) (keycloak#28876) Closes keycloak/keycloak-private#63 Signed-off-by: rmartinc <[email protected]>
- Loading branch information
Showing
3 changed files
with
160 additions
and
26 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
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
125 changes: 125 additions & 0 deletions
125
...loak/services/clientregistration/policy/impl/TrustedHostClientRegistrationPolicyTest.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,125 @@ | ||
| /* | ||
| * Copyright 2024 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. | ||
| */ | ||
| package org.keycloak.services.clientregistration.policy.impl; | ||
|
|
||
| import java.net.InetAddress; | ||
| import java.net.UnknownHostException; | ||
| import org.junit.Assert; | ||
| import org.junit.BeforeClass; | ||
| import org.junit.Test; | ||
| import org.keycloak.common.Profile; | ||
| import org.keycloak.common.crypto.CryptoIntegration; | ||
| import org.keycloak.common.crypto.CryptoProvider; | ||
| import org.keycloak.component.ComponentModel; | ||
| import org.keycloak.models.KeycloakSession; | ||
| import org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyException; | ||
| import org.keycloak.services.resteasy.ResteasyKeycloakSession; | ||
| import org.keycloak.services.resteasy.ResteasyKeycloakSessionFactory; | ||
|
|
||
| /** | ||
| * | ||
| * @author rmartinc | ||
| */ | ||
| public class TrustedHostClientRegistrationPolicyTest { | ||
|
|
||
| private static KeycloakSession session; | ||
|
|
||
| @BeforeClass | ||
| public static void beforeClass() { | ||
| Profile.defaults(); | ||
| CryptoIntegration.init(CryptoProvider.class.getClassLoader()); | ||
| ResteasyKeycloakSessionFactory sessionFactory = new ResteasyKeycloakSessionFactory(); | ||
| sessionFactory.init(); | ||
| session = new ResteasyKeycloakSession(sessionFactory); | ||
| } | ||
|
|
||
| @Test | ||
| public void testLocalhostName() { | ||
| TrustedHostClientRegistrationPolicyFactory factory = new TrustedHostClientRegistrationPolicyFactory(); | ||
| ComponentModel model = createComponentModel("localhost"); | ||
| TrustedHostClientRegistrationPolicy policy = (TrustedHostClientRegistrationPolicy) factory.create(session, model); | ||
|
|
||
| policy.verifyHost("127.0.0.1"); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.verifyHost("10.0.0.1")); | ||
| policy.checkURLTrusted("https://localhost", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.checkURLTrusted("https://otherhost", | ||
| policy.getTrustedHosts(), policy.getTrustedDomains())); | ||
| } | ||
|
|
||
| @Test | ||
| public void testLocalhostDomain() { | ||
| TrustedHostClientRegistrationPolicyFactory factory = new TrustedHostClientRegistrationPolicyFactory(); | ||
| ComponentModel model = createComponentModel("*.localhost"); | ||
| TrustedHostClientRegistrationPolicy policy = (TrustedHostClientRegistrationPolicy) factory.create(session, model); | ||
|
|
||
| policy.verifyHost("127.0.0.1"); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.verifyHost("10.0.0.1")); | ||
| policy.checkURLTrusted("https://localhost", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| policy.checkURLTrusted("https://other.localhost", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.checkURLTrusted("https://otherlocalhost", | ||
| policy.getTrustedHosts(), policy.getTrustedDomains())); | ||
| } | ||
|
|
||
| @Test | ||
| public void testLocalhostIP() { | ||
| TrustedHostClientRegistrationPolicyFactory factory = new TrustedHostClientRegistrationPolicyFactory(); | ||
| ComponentModel model = createComponentModel("127.0.0.1"); | ||
| TrustedHostClientRegistrationPolicy policy = (TrustedHostClientRegistrationPolicy) factory.create(session, model); | ||
|
|
||
| policy.verifyHost("127.0.0.1"); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.verifyHost("10.0.0.1")); | ||
| policy.checkURLTrusted("https://127.0.0.1", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.checkURLTrusted("https://localhost", | ||
| policy.getTrustedHosts(), policy.getTrustedDomains())); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGoogleCrawlBot() { | ||
| // https://developers.google.com/search/blog/2006/09/how-to-verify-googlebot | ||
| TrustedHostClientRegistrationPolicyFactory factory = new TrustedHostClientRegistrationPolicyFactory(); | ||
| ComponentModel model = createComponentModel("*.googlebot.com"); | ||
| TrustedHostClientRegistrationPolicy policy = (TrustedHostClientRegistrationPolicy) factory.create(session, model); | ||
|
|
||
| policy.verifyHost("66.249.66.1"); | ||
| policy.checkURLTrusted("https://www.googlebot.com", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| policy.checkURLTrusted("https://googlebot.com", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.checkURLTrusted("https://www.othergooglebot.com", | ||
| policy.getTrustedHosts(), policy.getTrustedDomains())); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGithubDomain() throws UnknownHostException { | ||
| TrustedHostClientRegistrationPolicyFactory factory = new TrustedHostClientRegistrationPolicyFactory(); | ||
| ComponentModel model = createComponentModel("*.github.com"); | ||
| TrustedHostClientRegistrationPolicy policy = (TrustedHostClientRegistrationPolicy) factory.create(session, model); | ||
|
|
||
| policy.verifyHost(InetAddress.getByName("www.github.com").getHostAddress()); | ||
| policy.verifyHost(InetAddress.getByName("github.com").getHostAddress()); | ||
| policy.checkURLTrusted("https://www.github.com", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| policy.checkURLTrusted("https://github.com", policy.getTrustedHosts(), policy.getTrustedDomains()); | ||
| Assert.assertThrows(ClientRegistrationPolicyException.class, () -> policy.checkURLTrusted("https://othergithub.com", | ||
| policy.getTrustedHosts(), policy.getTrustedDomains())); | ||
| } | ||
|
|
||
| private ComponentModel createComponentModel(String... hosts) { | ||
| ComponentModel model = new ComponentModel(); | ||
| model.put(TrustedHostClientRegistrationPolicyFactory.HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH, "true"); | ||
| model.put(TrustedHostClientRegistrationPolicyFactory.CLIENT_URIS_MUST_MATCH, "true"); | ||
| model.getConfig().addAll(TrustedHostClientRegistrationPolicyFactory.TRUSTED_HOSTS, hosts); | ||
| return model; | ||
| } | ||
| } |