Add vendored ldap-disabled mapping utility

8 files changed, 386 insertions, 0 deletions

diff --git a/vendor/keycloak-providers/.gitignore b/vendor/keycloak-providers/.gitignore
new file mode 100644
index 0000000..5b82dcc
--- /dev/null
+++ b/vendor/keycloak-providers/.gitignore
@@ -0,0 +1,4 @@
+*.iml
+.idea/
+target/
+.settings/
\ No newline at end of file
diff --git a/vendor/keycloak-providers/ORIGINAL-LICENSE b/vendor/keycloak-providers/ORIGINAL-LICENSE
new file mode 100644
index 0000000..98a23fc
--- /dev/null
+++ b/vendor/keycloak-providers/ORIGINAL-LICENSE
@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Sascha Herzinger
+
+   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.
diff --git a/vendor/keycloak-providers/README.md b/vendor/keycloak-providers/README.md
new file mode 100644
index 0000000..61f922b
--- /dev/null
+++ b/vendor/keycloak-providers/README.md
@@ -0,0 +1,9 @@
+# keycloak-providers
+
+Build with `mvn clean package`. Copy resulting JARs into Keycloak build.
+
+### disabled-ldap-status-mapper
+
+- Create add a `user-attribute-ldap-mapper` that maps `nsAccountLock` from LDAP to the user attribute `nsAccountLock`.
+This is necessary for the next step because the attribute is not fetched unless explicitly requested.
+- Add `disabled-ldap-status-mapper` to automatically (un)lock users according to their `nsAccountLock` status in LDAP. 
diff --git a/vendor/keycloak-providers/ldap-disabled-mapper/pom.xml b/vendor/keycloak-providers/ldap-disabled-mapper/pom.xml
new file mode 100644
index 0000000..ec3b4d6
--- /dev/null
+++ b/vendor/keycloak-providers/ldap-disabled-mapper/pom.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>uk.owlcorp.keycloak</groupId>
+        <artifactId>providers</artifactId>
+        <version>${revision}</version>
+    </parent>
+
+    <artifactId>ldap-disabled-mapper</artifactId>
+    <version>${revision}</version>
+    <packaging>jar</packaging>
+
+    <properties>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-ldap-federation</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapper.java b/vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapper.java
new file mode 100644
index 0000000..223fdc1
--- /dev/null
+++ b/vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapper.java
@@ -0,0 +1,53 @@
+package uk.owlcorp.keycloak;
+
+import org.jboss.logging.Logger;
+import org.keycloak.component.ComponentModel;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.storage.ldap.LDAPStorageProvider;
+import org.keycloak.storage.ldap.idm.model.LDAPObject;
+import org.keycloak.storage.ldap.idm.query.internal.LDAPQuery;
+import org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper;
+
+public class DisabledStatusLDAPStorageMapper extends AbstractLDAPStorageMapper {
+
+    private final Logger log = Logger.getLogger(DisabledStatusLDAPStorageMapper.class);
+    private static final String LDAP_LOCKED_ATTR = "nsAccountLock";
+
+    public DisabledStatusLDAPStorageMapper(ComponentModel mapperModel, LDAPStorageProvider ldapProvider) {
+        super(mapperModel, ldapProvider);
+    }
+
+    @Override
+    public void onImportUserFromLDAP(
+            LDAPObject ldapObject, UserModel userModel, RealmModel realmModel, boolean isCreate) {
+        log.debugf("LDAP user attributes: %s", ldapObject.getAttributes());
+        boolean accLocked = "TRUE".equals(ldapObject.getAttributeAsString(LDAP_LOCKED_ATTR));
+        if (!isCreate && userModel.isEnabled() && accLocked) {
+            log.infof("Disabling user [%s] in realm [%s] because their federated LDAP account got locked.",
+                    userModel.getUsername(), realmModel.getName());
+        }
+        if (!isCreate && !userModel.isEnabled() && !accLocked) {
+            log.infof("Enabling user [%s] in realm [%s] because their federated LDAP account got un-locked.",
+                    userModel.getUsername(), realmModel.getName());
+        }
+        userModel.setEnabled(!accLocked);
+    }
+
+    // This method is untested and unused unless we enable KC -> LDAP synchronisation in the future
+    @Override
+    public void onRegisterUserToLDAP(LDAPObject ldapObject, UserModel userModel, RealmModel realmModel) {
+        throw new RuntimeException("KC -> LUMS Sync currently unsupported");
+    }
+
+    @Override
+    public UserModel proxy(LDAPObject ldapObject, UserModel userModel, RealmModel realmModel) {
+        onImportUserFromLDAP(ldapObject, userModel, realmModel, false);
+        return userModel;
+    }
+
+    @Override
+    public void beforeLDAPQuery(LDAPQuery ldapQuery) {
+    }
+
+}
diff --git a/vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapperFactory.java b/vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapperFactory.java
new file mode 100644
index 0000000..325c91f
--- /dev/null
+++ b/vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapperFactory.java
@@ -0,0 +1,28 @@
+package uk.owlcorp.keycloak;
+
+import org.keycloak.component.ComponentModel;
+import org.keycloak.storage.ldap.LDAPStorageProvider;
+import org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper;
+import org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory;
+
+
+public class DisabledStatusLDAPStorageMapperFactory extends AbstractLDAPStorageMapperFactory {
+
+    private final static String MAPPER_NAME = "disabled-ldap-status-mapper";
+
+    @Override
+    protected AbstractLDAPStorageMapper createMapper(ComponentModel componentModel, LDAPStorageProvider ldapStorageProvider) {
+        return new DisabledStatusLDAPStorageMapper(componentModel, ldapStorageProvider);
+    }
+
+    @Override
+    public String getId() {
+        return MAPPER_NAME;
+    }
+
+    @Override
+    public String getHelpText() {
+        return "Maps the nsAccountLock LDAP attribute to the enabled status of the associated Keycloak account.";
+    }
+
+}
diff --git a/vendor/keycloak-providers/ldap-disabled-mapper/src/main/resources/META-INF/services/org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory b/vendor/keycloak-providers/ldap-disabled-mapper/src/main/resources/META-INF/services/org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory
new file mode 100644
index 0000000..6b4e9c8
--- /dev/null
+++ b/vendor/keycloak-providers/ldap-disabled-mapper/src/main/resources/META-INF/services/org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory
@@ -0,0 +1 @@
+uk.owlcorp.keycloak.DisabledStatusLDAPStorageMapperFactory
diff --git a/vendor/keycloak-providers/pom.xml b/vendor/keycloak-providers/pom.xml
new file mode 100644
index 0000000..e9f6ff3
--- /dev/null
+++ b/vendor/keycloak-providers/pom.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>uk.owlcorp.keycloak</groupId>
+    <artifactId>providers</artifactId>
+    <version>${revision}</version>
+    <packaging>pom</packaging>
+
+    <modules>
+        <module>ldap-disabled-mapper</module>
+    </modules>
+
+    <properties>
+        <revision>1.0.0-SNAPSHOT</revision>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <java.version>21</java.version>
+        <maven.compiler.release>${java.version}</maven.compiler.release>
+        <keycloak.version>26.1.1</keycloak.version>
+        <jboss.logging.version>3.6.0.Final</jboss.logging.version>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
+    </properties>
+
+
+    <dependencies>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-core</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-server-spi</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-server-spi-private</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-services</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.jboss.logging</groupId>
+            <artifactId>jboss-logging</artifactId>
+            <version>${jboss.logging.version}</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+</project>