Skip to content

Commit 58a5257

Browse files
jb3jb3
committed
Add vendored ldap-disabled mapping utility
1 parent 5b5fd70 commit 58a5257

File tree

8 files changed

+386
-0
lines changed

8 files changed

+386
-0
lines changed

‎vendor/keycloak-providers/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.iml
2+
.idea/
3+
target/
4+
.settings/

‎vendor/keycloak-providers/ORIGINAL-LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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 2023 Sascha Herzinger
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.

‎vendor/keycloak-providers/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# keycloak-providers
2+
3+
Build with `mvn clean package`. Copy resulting JARs into Keycloak build.
4+
5+
### disabled-ldap-status-mapper
6+
7+
- Create add a `user-attribute-ldap-mapper` that maps `nsAccountLock` from LDAP to the user attribute `nsAccountLock`.
8+
This is necessary for the next step because the attribute is not fetched unless explicitly requested.
9+
- Add `disabled-ldap-status-mapper` to automatically (un)lock users according to their `nsAccountLock` status in LDAP.

‎vendor/keycloak-providers/ldap-disabled-mapper/pom.xml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5+
<modelVersion>4.0.0</modelVersion>
6+
7+
<parent>
8+
<groupId>uk.owlcorp.keycloak</groupId>
9+
<artifactId>providers</artifactId>
10+
<version>${revision}</version>
11+
</parent>
12+
13+
<artifactId>ldap-disabled-mapper</artifactId>
14+
<version>${revision}</version>
15+
<packaging>jar</packaging>
16+
17+
<properties>
18+
</properties>
19+
20+
<dependencies>
21+
<dependency>
22+
<groupId>org.keycloak</groupId>
23+
<artifactId>keycloak-ldap-federation</artifactId>
24+
<version>${keycloak.version}</version>
25+
<scope>provided</scope>
26+
</dependency>
27+
</dependencies>
28+
29+
</project>

‎vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapper.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
package uk.owlcorp.keycloak;
2+
3+
import org.jboss.logging.Logger;
4+
import org.keycloak.component.ComponentModel;
5+
import org.keycloak.models.RealmModel;
6+
import org.keycloak.models.UserModel;
7+
import org.keycloak.storage.ldap.LDAPStorageProvider;
8+
import org.keycloak.storage.ldap.idm.model.LDAPObject;
9+
import org.keycloak.storage.ldap.idm.query.internal.LDAPQuery;
10+
import org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper;
11+
12+
public class DisabledStatusLDAPStorageMapper extends AbstractLDAPStorageMapper {
13+
14+
private final Logger log = Logger.getLogger(DisabledStatusLDAPStorageMapper.class);
15+
private static final String LDAP_LOCKED_ATTR = "nsAccountLock";
16+
17+
public DisabledStatusLDAPStorageMapper(ComponentModel mapperModel, LDAPStorageProvider ldapProvider) {
18+
super(mapperModel, ldapProvider);
19+
}
20+
21+
@Override
22+
public void onImportUserFromLDAP(
23+
LDAPObject ldapObject, UserModel userModel, RealmModel realmModel, boolean isCreate) {
24+
log.debugf("LDAP user attributes: %s", ldapObject.getAttributes());
25+
boolean accLocked = "TRUE".equals(ldapObject.getAttributeAsString(LDAP_LOCKED_ATTR));
26+
if (!isCreate && userModel.isEnabled() && accLocked) {
27+
log.infof("Disabling user [%s] in realm [%s] because their federated LDAP account got locked.",
28+
userModel.getUsername(), realmModel.getName());
29+
}
30+
if (!isCreate && !userModel.isEnabled() && !accLocked) {
31+
log.infof("Enabling user [%s] in realm [%s] because their federated LDAP account got un-locked.",
32+
userModel.getUsername(), realmModel.getName());
33+
}
34+
userModel.setEnabled(!accLocked);
35+
}
36+
37+
// This method is untested and unused unless we enable KC -> LDAP synchronisation in the future
38+
@Override
39+
public void onRegisterUserToLDAP(LDAPObject ldapObject, UserModel userModel, RealmModel realmModel) {
40+
throw new RuntimeException("KC -> LUMS Sync currently unsupported");
41+
}
42+
43+
@Override
44+
public UserModel proxy(LDAPObject ldapObject, UserModel userModel, RealmModel realmModel) {
45+
onImportUserFromLDAP(ldapObject, userModel, realmModel, false);
46+
return userModel;
47+
}
48+
49+
@Override
50+
public void beforeLDAPQuery(LDAPQuery ldapQuery) {
51+
}
52+
53+
}

‎vendor/keycloak-providers/ldap-disabled-mapper/src/main/java/lu/uni/lcsb/keycloak/DisabledStatusLDAPStorageMapperFactory.java‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
package uk.owlcorp.keycloak;
2+
3+
import org.keycloak.component.ComponentModel;
4+
import org.keycloak.storage.ldap.LDAPStorageProvider;
5+
import org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapper;
6+
import org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory;
7+
8+
9+
public class DisabledStatusLDAPStorageMapperFactory extends AbstractLDAPStorageMapperFactory {
10+
11+
private final static String MAPPER_NAME = "disabled-ldap-status-mapper";
12+
13+
@Override
14+
protected AbstractLDAPStorageMapper createMapper(ComponentModel componentModel, LDAPStorageProvider ldapStorageProvider) {
15+
return new DisabledStatusLDAPStorageMapper(componentModel, ldapStorageProvider);
16+
}
17+
18+
@Override
19+
public String getId() {
20+
return MAPPER_NAME;
21+
}
22+
23+
@Override
24+
public String getHelpText() {
25+
return "Maps the nsAccountLock LDAP attribute to the enabled status of the associated Keycloak account.";
26+
}
27+
28+
}

‎vendor/keycloak-providers/ldap-disabled-mapper/src/main/resources/META-INF/services/org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
uk.owlcorp.keycloak.DisabledStatusLDAPStorageMapperFactory

‎vendor/keycloak-providers/pom.xml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<project xmlns="http://maven.apache.org/POM/4.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
5+
<modelVersion>4.0.0</modelVersion>
6+
7+
<groupId>uk.owlcorp.keycloak</groupId>
8+
<artifactId>providers</artifactId>
9+
<version>${revision}</version>
10+
<packaging>pom</packaging>
11+
12+
<modules>
13+
<module>ldap-disabled-mapper</module>
14+
</modules>
15+
16+
<properties>
17+
<revision>1.0.0-SNAPSHOT</revision>
18+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
19+
<java.version>21</java.version>
20+
<maven.compiler.release>${java.version}</maven.compiler.release>
21+
<keycloak.version>26.1.1</keycloak.version>
22+
<jboss.logging.version>3.6.0.Final</jboss.logging.version>
23+
<maven.compiler.source>1.8</maven.compiler.source>
24+
<maven.compiler.target>1.8</maven.compiler.target>
25+
</properties>
26+
27+
28+
<dependencies>
29+
<dependency>
30+
<groupId>org.keycloak</groupId>
31+
<artifactId>keycloak-core</artifactId>
32+
<version>${keycloak.version}</version>
33+
<scope>provided</scope>
34+
</dependency>
35+
<dependency>
36+
<groupId>org.keycloak</groupId>
37+
<artifactId>keycloak-server-spi</artifactId>
38+
<version>${keycloak.version}</version>
39+
<scope>provided</scope>
40+
</dependency>
41+
<dependency>
42+
<groupId>org.keycloak</groupId>
43+
<artifactId>keycloak-server-spi-private</artifactId>
44+
<version>${keycloak.version}</version>
45+
<scope>provided</scope>
46+
</dependency>
47+
<dependency>
48+
<groupId>org.keycloak</groupId>
49+
<artifactId>keycloak-services</artifactId>
50+
<version>${keycloak.version}</version>
51+
<scope>provided</scope>
52+
</dependency>
53+
<dependency>
54+
<groupId>org.jboss.logging</groupId>
55+
<artifactId>jboss-logging</artifactId>
56+
<version>${jboss.logging.version}</version>
57+
<scope>provided</scope>
58+
</dependency>
59+
</dependencies>
60+
61+
</project>

0 commit comments

Comments
 (0)