├── .gitignore ├── LICENSE ├── README.md ├── pom.xml └── src └── main ├── java └── com │ └── github │ └── lukaszbudnik │ └── keycloak │ └── ipauthenticator │ ├── IPAuthenticator.java │ └── IPAuthenticatorFactory.java └── resources └── META-INF └── services └── org.keycloak.authentication.AuthenticatorFactory /.gitignore: -------------------------------------------------------------------------------- 1 | /keycloak-ip-authenticator.iml 2 | /target/ 3 | /.idea/ 4 | -------------------------------------------------------------------------------- /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 [yyyy] [name of copyright owner] 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 | # keycloak-ip-authenticator 2 | 3 | This is a simple Keycloak Java Authenticator that checks if the user is coming from a trusted network or not. If the user is coming from a trusted network MFA step is skipped. If the user is coming from a non-trusted network MFA step is forced. 4 | 5 | The authenticator has to be used together with `Conditional OTP Form` component. 6 | 7 | See the following Youtube video which explains how to deploy and configure it in Keycloak: https://youtu.be/u36QK9oyrtM. 8 | 9 | ## build 10 | 11 | The Keycloak SPI is very stable but always make sure that Keycloak SPI dependencies and your Keycloak server versions match. Keycloak SPI dependencies version is configured in `pom.xml` in the `keycloak.version` property. 12 | 13 | To build the project execute the following command: 14 | 15 | ```bash 16 | mvn package 17 | ``` 18 | 19 | ## deploy 20 | 21 | Assuming `$KEYCLOAK_HOME` is pointing to you Keycloak installation. 22 | 23 | If you use legacy Keycloak running on WildFly copy it into deployments directory: 24 | 25 | ```bash 26 | cp target/keycloak-ip-authenticator.jar $KEYCLOAK_HOME/standalone/deployments/ 27 | ``` 28 | 29 | If you use latest Keycloak running on Quarkus copy it into providers directory: 30 | 31 | ```bash 32 | cp target/keycloak-ip-authenticator.jar $KEYCLOAK_HOME/providers/ 33 | ``` 34 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | com.github.lukaszbudnik 6 | keycloak-ip-authenticator 7 | 0.0.1-SNAPSHOT 8 | jar 9 | 10 | 12.0.4 11 | 2.0.1.Final 12 | 11 13 | 11 14 | UTF-8 15 | 16 | 17 | 18 | org.keycloak 19 | keycloak-server-spi 20 | ${keycloak.version} 21 | 22 | 23 | org.keycloak 24 | keycloak-server-spi-private 25 | ${keycloak.version} 26 | 27 | 28 | org.keycloak 29 | keycloak-core 30 | ${keycloak.version} 31 | 32 | 33 | org.keycloak 34 | keycloak-services 35 | ${keycloak.version} 36 | 37 | 38 | org.jboss.spec.javax.ws.rs 39 | jboss-jaxrs-api_2.1_spec 40 | ${jboss-jaxrs-api_2.1_spec} 41 | 42 | 43 | 44 | ${project.artifactId} 45 | 46 | -------------------------------------------------------------------------------- /src/main/java/com/github/lukaszbudnik/keycloak/ipauthenticator/IPAuthenticator.java: -------------------------------------------------------------------------------- 1 | package com.github.lukaszbudnik.keycloak.ipauthenticator; 2 | 3 | import java.util.Collections; 4 | import java.util.Map; 5 | 6 | import org.jboss.logging.Logger; 7 | import org.keycloak.authentication.AuthenticationFlowContext; 8 | import org.keycloak.authentication.Authenticator; 9 | import org.keycloak.models.*; 10 | import org.keycloak.models.credential.OTPCredentialModel; 11 | 12 | public class IPAuthenticator implements Authenticator { 13 | 14 | private static final Logger logger = Logger.getLogger(IPAuthenticator.class); 15 | private static final String IP_BASED_OTP_CONDITIONAL_USER_ATTRIBUTE = "ip_based_otp_conditional"; 16 | 17 | @Override 18 | public void authenticate(AuthenticationFlowContext context) { 19 | KeycloakSession session = context.getSession(); 20 | RealmModel realm = context.getRealm(); 21 | UserModel user = context.getUser(); 22 | 23 | String remoteIPAddress = context.getConnection().getRemoteAddr(); 24 | String allowedIPAddress = getAllowedIPAddress(context); 25 | 26 | if (!allowedIPAddress.equals(remoteIPAddress)) { 27 | logger.infof("IPs do not match. Realm %s expected %s but user %s logged from %s", realm.getName(), allowedIPAddress, user.getUsername(), remoteIPAddress); 28 | UserCredentialManager credentialManager = session.userCredentialManager(); 29 | 30 | if (!credentialManager.isConfiguredFor(realm, user, OTPCredentialModel.TYPE)) { 31 | user.addRequiredAction(UserModel.RequiredAction.CONFIGURE_TOTP); 32 | } 33 | 34 | user.setAttribute(IP_BASED_OTP_CONDITIONAL_USER_ATTRIBUTE, Collections.singletonList("force")); 35 | } else { 36 | user.setAttribute(IP_BASED_OTP_CONDITIONAL_USER_ATTRIBUTE, Collections.singletonList("skip")); 37 | } 38 | 39 | context.success(); 40 | } 41 | 42 | private String getAllowedIPAddress(AuthenticationFlowContext context) { 43 | AuthenticatorConfigModel configModel = context.getAuthenticatorConfig(); 44 | Map config = configModel.getConfig(); 45 | return config.get(IPAuthenticatorFactory.ALLOWED_IP_ADDRESS_CONFIG); 46 | } 47 | 48 | @Override 49 | public void action(AuthenticationFlowContext context) { 50 | } 51 | 52 | @Override 53 | public boolean requiresUser() { 54 | return true; 55 | } 56 | 57 | @Override 58 | public boolean configuredFor(KeycloakSession session, RealmModel realm, UserModel user) { 59 | return true; 60 | } 61 | 62 | @Override 63 | public void setRequiredActions(KeycloakSession session, RealmModel realm, UserModel user) { 64 | } 65 | 66 | @Override 67 | public void close() { 68 | } 69 | 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/com/github/lukaszbudnik/keycloak/ipauthenticator/IPAuthenticatorFactory.java: -------------------------------------------------------------------------------- 1 | package com.github.lukaszbudnik.keycloak.ipauthenticator; 2 | 3 | import static org.keycloak.provider.ProviderConfigProperty.STRING_TYPE; 4 | 5 | import java.util.Collections; 6 | import java.util.List; 7 | 8 | import org.keycloak.Config; 9 | import org.keycloak.authentication.Authenticator; 10 | import org.keycloak.authentication.AuthenticatorFactory; 11 | import org.keycloak.models.AuthenticationExecutionModel; 12 | import org.keycloak.models.KeycloakSession; 13 | import org.keycloak.models.KeycloakSessionFactory; 14 | import org.keycloak.provider.ProviderConfigProperty; 15 | 16 | public class IPAuthenticatorFactory implements AuthenticatorFactory { 17 | 18 | public static final String ID = "ipauthenticator"; 19 | 20 | private static final Authenticator AUTHENTICATOR_INSTANCE = new IPAuthenticator(); 21 | static final String ALLOWED_IP_ADDRESS_CONFIG = "allowed_ip_address"; 22 | 23 | @Override 24 | public Authenticator create(KeycloakSession keycloakSession) { 25 | return AUTHENTICATOR_INSTANCE; 26 | } 27 | 28 | @Override 29 | public String getDisplayType() { 30 | return "IP Authenticator"; 31 | } 32 | 33 | @Override 34 | public boolean isConfigurable() { 35 | return true; 36 | } 37 | 38 | @Override 39 | public AuthenticationExecutionModel.Requirement[] getRequirementChoices() { 40 | return new AuthenticationExecutionModel.Requirement[] { AuthenticationExecutionModel.Requirement.REQUIRED }; 41 | } 42 | 43 | @Override 44 | public boolean isUserSetupAllowed() { 45 | return false; 46 | } 47 | 48 | @Override 49 | public String getHelpText() { 50 | return "Limits access to only allowed IP Address"; 51 | } 52 | 53 | @Override 54 | public List getConfigProperties() { 55 | ProviderConfigProperty name = new ProviderConfigProperty(); 56 | 57 | name.setType(STRING_TYPE); 58 | name.setName(ALLOWED_IP_ADDRESS_CONFIG); 59 | name.setLabel("IP Address from which sign ins are allowed"); 60 | name.setHelpText("Only accepts IP addresses, no CIDR nor masks nor ranges supported"); 61 | 62 | return Collections.singletonList(name); 63 | } 64 | 65 | @Override 66 | public String getReferenceCategory() { 67 | return null; 68 | } 69 | 70 | @Override 71 | public void init(Config.Scope scope) { 72 | } 73 | 74 | @Override 75 | public void postInit(KeycloakSessionFactory keycloakSessionFactory) { 76 | } 77 | 78 | @Override 79 | public void close() { 80 | } 81 | 82 | @Override 83 | public String getId() { 84 | return ID; 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/org.keycloak.authentication.AuthenticatorFactory: -------------------------------------------------------------------------------- 1 | com.github.lukaszbudnik.keycloak.ipauthenticator.IPAuthenticatorFactory --------------------------------------------------------------------------------