├── .gitignore ├── .travis.yml ├── Dockerfile ├── LICENSE ├── README.md ├── pom.xml └── src └── main ├── java └── uk │ └── co │ └── caci │ └── iig │ └── hibp │ ├── HaveIBeenPwned.java │ ├── HibpPasswordPolicyProvider.java │ ├── HibpPasswordPolicyProviderFactory.java │ └── PrefixResponseHandler.java └── resources └── META-INF └── services └── org.keycloak.policy.PasswordPolicyProviderFactory /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | /.classpath 3 | /.project 4 | /.settings 5 | /pom.xml.versionsBackup 6 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | jdk: openjdk8 3 | 4 | cache: 5 | directories: 6 | - $HOME/.m2 7 | 8 | deploy: 9 | provider: releases 10 | api_key: "$GITHUB_TOKEN" 11 | file: "target/keycloak-hibp-policy-${TRAVIS_TAG}.jar" 12 | skip_cleanup: true 13 | on: 14 | tags: true 15 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM maven:3-jdk-8-alpine AS build 2 | WORKDIR /opt/build 3 | 4 | COPY pom.xml pom.xml 5 | RUN mvn install 6 | 7 | COPY src src 8 | RUN mvn clean package 9 | 10 | FROM jboss/keycloak:4.4.0.Final 11 | 12 | COPY --from=build /opt/build/target/keycloak-hibp-policy*.jar keycloak/standalone/deployments/hibp-password-policy.jar 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2019 CACI IIG 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # HaveIBeenPwned Password Policy for Keycloak PoC 2 | 3 | ## Intro 4 | 5 | [Apache Keycloak](https://www.keycloak.org/about.html) is an open source IDAM solution supporting OpenID Connect, OAuth 2.0, and SAML. 6 | 7 | Have I Been Pwned (HIBP) is a service that aims to inform people if their email addresses or passwords have been present in any known security breaches. 8 | 9 | This proof of concept implements a [Service Provider Interface (SPIs)](https://www.keycloak.org/docs/latest/server_development/index.html#_providers) to block the usage of passwords present in data breaches, 10 | using the [HIBP Password API](https://haveibeenpwned.com/API/v2#PwnedPasswords). 11 | 12 | **NB**: This is a proof of concept, with several modifications required to be made before sensible to be used in a live environment, see #future-work 13 | 14 | ## Installation 15 | 16 | The Dockerfile provides the necessary installation and registration steps, which match those [documented by Keycloak](https://www.keycloak.org/docs/latest/server_development/index.html#registering-provider-implementations). 17 | 18 | Using the `Keycloak Deployer`, the only step required is copying the build jar into `standalone/deployments/` within Keycloak. 19 | 20 | ## Configuration 21 | 22 | Once registered, the Policy can be added via `Authentication -> Password Policy` and selecting `HIBP Data Breaches` from the Policy dropdown. 23 | 24 | The `Policy Value` is the maximum number of breaches a password can have occurred in to be accepted, defaulting to `0`. 25 | 26 | ## Future Work 27 | 28 | * Handle cases where HIBP API is not accessible 29 | * Configurable allow/deny in those cases. 30 | * Configurable to allow an offline/local version of the HIBP API to be used. 31 | * Handle / respect rate limiting responses from HIBP API 32 | * Error message on password change failure should link to HIBP for an explanation. 33 | * Make the version of Keycloak easily configurable. 34 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 4 | 4.0.0 5 | uk.co.caci.iig 6 | keycloak-hibp-policy 7 | 1.0.1-SNAPSHOT 8 | 9 | 10 | 4.4.0.Final 11 | 1.8 12 | 13 | 14 | 15 | 16 | org.keycloak 17 | keycloak-server-spi 18 | ${keycloak.version} 19 | provided 20 | 21 | 22 | org.keycloak 23 | keycloak-server-spi-private 24 | ${keycloak.version} 25 | provided 26 | 27 | 28 | org.keycloak 29 | keycloak-core 30 | ${keycloak.version} 31 | provided 32 | 33 | 34 | org.jboss.logging 35 | jboss-logging 36 | 3.3.1.Final 37 | provided 38 | 39 | 40 | org.apache.httpcomponents 41 | httpclient 42 | 4.5.2 43 | provided 44 | 45 | 46 | commons-codec 47 | commons-codec 48 | 1.11 49 | 50 | 51 | 52 | 53 | 54 | 55 | org.apache.maven.plugins 56 | maven-shade-plugin 57 | 3.2.1 58 | 59 | 60 | package 61 | 62 | shade 63 | 64 | 65 | 66 | 67 | commons-codec:commons-codec 68 | 69 | ** 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | -------------------------------------------------------------------------------- /src/main/java/uk/co/caci/iig/hibp/HaveIBeenPwned.java: -------------------------------------------------------------------------------- 1 | package uk.co.caci.iig.hibp; 2 | 3 | import java.io.IOException; 4 | 5 | import org.apache.commons.codec.digest.DigestUtils; 6 | import org.apache.http.client.ClientProtocolException; 7 | import org.apache.http.client.ResponseHandler; 8 | import org.apache.http.client.methods.HttpGet; 9 | import org.apache.http.impl.client.CloseableHttpClient; 10 | import org.apache.http.impl.client.HttpClients; 11 | 12 | public class HaveIBeenPwned { 13 | private static final String apiUrl = "https://api.pwnedpasswords.com/range/"; 14 | 15 | public static class ApiException extends Exception { 16 | private static final long serialVersionUID = 4310312365802997437L; 17 | 18 | public ApiException(Exception e) { 19 | super(e); 20 | } 21 | } 22 | 23 | private CloseableHttpClient httpclient; 24 | 25 | public HaveIBeenPwned() { 26 | httpclient = HttpClients.createDefault(); 27 | } 28 | 29 | public int lookup(String password) throws ApiException { 30 | try { 31 | String sha1 = getSha1(password); 32 | return getBreachCount(sha1); 33 | } catch (Exception e) { 34 | throw new ApiException(e); 35 | } 36 | } 37 | 38 | private int getBreachCount(String sha1) throws ClientProtocolException, IOException { 39 | String prefix = sha1.substring(0, 5); 40 | String suffix = sha1.substring(5); 41 | 42 | String uri = apiUrl + prefix; 43 | HttpGet httpGet = new HttpGet(uri); 44 | 45 | String sha1Count = httpclient.execute(httpGet, createPrefixHandler(suffix)); 46 | return Integer.parseInt(sha1Count.substring(suffix.length() + 1)); 47 | } 48 | 49 | private ResponseHandler createPrefixHandler(String prefix) { 50 | return new PrefixResponseHandler(prefix); 51 | } 52 | 53 | private String getSha1(String input) { 54 | return DigestUtils.sha1Hex(input); 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /src/main/java/uk/co/caci/iig/hibp/HibpPasswordPolicyProvider.java: -------------------------------------------------------------------------------- 1 | package uk.co.caci.iig.hibp; 2 | 3 | import org.jboss.logging.Logger; 4 | import org.keycloak.models.KeycloakContext; 5 | import org.keycloak.models.RealmModel; 6 | import org.keycloak.models.UserModel; 7 | import org.keycloak.policy.PasswordPolicyProvider; 8 | import org.keycloak.policy.PolicyError; 9 | 10 | import uk.co.caci.iig.hibp.HaveIBeenPwned.ApiException; 11 | 12 | public class HibpPasswordPolicyProvider implements PasswordPolicyProvider { 13 | private static final Logger LOG = Logger.getLogger(HibpPasswordPolicyProvider.class); 14 | 15 | private KeycloakContext context; 16 | private HaveIBeenPwned haveIBeenPwned; 17 | 18 | public HibpPasswordPolicyProvider(KeycloakContext context) { 19 | this.context = context; 20 | this.haveIBeenPwned = new HaveIBeenPwned(); 21 | } 22 | 23 | public PolicyError validate(String user, String password) { 24 | Integer allowedBreaches = context.getRealm().getPasswordPolicy() 25 | .getPolicyConfig(HibpPasswordPolicyProviderFactory.ID); 26 | 27 | try { 28 | int breachOccurrences = haveIBeenPwned.lookup(password); 29 | if (breachOccurrences > allowedBreaches) { 30 | return new PolicyError("The entered password is present in {0} data breaches and cannot be used", 31 | breachOccurrences); 32 | } 33 | } catch (ApiException e) { 34 | LOG.error("Failed to lookup password with HIBP, allowing password", e); 35 | } 36 | return null; 37 | } 38 | 39 | public PolicyError validate(RealmModel realm, UserModel user, String password) { 40 | return validate(user.getUsername(), password); 41 | } 42 | 43 | 44 | public Object parseConfig(String value) { 45 | return Integer.valueOf(value); 46 | } 47 | 48 | public void close() { 49 | } 50 | 51 | } 52 | -------------------------------------------------------------------------------- /src/main/java/uk/co/caci/iig/hibp/HibpPasswordPolicyProviderFactory.java: -------------------------------------------------------------------------------- 1 | package uk.co.caci.iig.hibp; 2 | 3 | import org.keycloak.Config; 4 | import org.keycloak.models.KeycloakSession; 5 | import org.keycloak.models.KeycloakSessionFactory; 6 | import org.keycloak.policy.PasswordPolicyProvider; 7 | import org.keycloak.policy.PasswordPolicyProviderFactory; 8 | 9 | public class HibpPasswordPolicyProviderFactory implements PasswordPolicyProviderFactory { 10 | 11 | public static final String ID = "HIBP"; 12 | 13 | public PasswordPolicyProvider create(KeycloakSession session) { 14 | return new HibpPasswordPolicyProvider(session.getContext()); 15 | } 16 | 17 | public void init(Config.Scope config) { 18 | } 19 | 20 | public void postInit(KeycloakSessionFactory factory) { 21 | 22 | } 23 | 24 | public void close() { 25 | 26 | } 27 | 28 | public String getId() { 29 | return ID; 30 | } 31 | 32 | public String getDisplayName() { 33 | return "HIBP Data Breaches"; 34 | } 35 | 36 | public String getConfigType() { 37 | return PasswordPolicyProvider.INT_CONFIG_TYPE; 38 | } 39 | 40 | public String getDefaultConfigValue() { 41 | return "0"; 42 | } 43 | 44 | public boolean isMultiplSupported() { 45 | return false; 46 | } 47 | 48 | } 49 | -------------------------------------------------------------------------------- /src/main/java/uk/co/caci/iig/hibp/PrefixResponseHandler.java: -------------------------------------------------------------------------------- 1 | package uk.co.caci.iig.hibp; 2 | 3 | import java.io.BufferedReader; 4 | import java.io.IOException; 5 | import java.io.InputStreamReader; 6 | 7 | import org.apache.http.HttpEntity; 8 | import org.apache.http.HttpResponse; 9 | import org.apache.http.client.ClientProtocolException; 10 | import org.apache.http.client.ResponseHandler; 11 | 12 | public class PrefixResponseHandler implements ResponseHandler { 13 | 14 | private String prefix; 15 | 16 | public PrefixResponseHandler(String prefix) { 17 | this.prefix = prefix.toUpperCase(); 18 | } 19 | 20 | public String handleResponse(HttpResponse response) throws ClientProtocolException, IOException { 21 | int status = response.getStatusLine().getStatusCode(); 22 | if (status == 200) { 23 | HttpEntity entity = response.getEntity(); 24 | BufferedReader br = new BufferedReader(new InputStreamReader(entity.getContent())); 25 | try { 26 | String inputLine; 27 | while ((inputLine = br.readLine()) != null) { 28 | if (inputLine.startsWith(prefix)) { 29 | br.close(); 30 | return inputLine; 31 | } 32 | } 33 | br.close(); 34 | throw new ClientProtocolException("No entry found for: " + prefix); 35 | } catch (IOException e) { 36 | throw new ClientProtocolException("Exception thrown reading response", e); 37 | } 38 | } else { 39 | throw new ClientProtocolException("Unexpected response status: " + status); 40 | } 41 | 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/org.keycloak.policy.PasswordPolicyProviderFactory: -------------------------------------------------------------------------------- 1 | # 2 | # See https://www.keycloak.org/docs/4.4/server_development/index.html#_providers 3 | # 4 | 5 | uk.co.caci.iig.hibp.HibpPasswordPolicyProviderFactory --------------------------------------------------------------------------------