1 package org
.argeo
.osgi
.useradmin
;
3 import static org
.argeo
.naming
.LdapAttrs
.objectClass
;
4 import static org
.argeo
.naming
.LdapObjs
.extensibleObject
;
5 import static org
.argeo
.naming
.LdapObjs
.inetOrgPerson
;
6 import static org
.argeo
.naming
.LdapObjs
.organizationalPerson
;
7 import static org
.argeo
.naming
.LdapObjs
.person
;
8 import static org
.argeo
.naming
.LdapObjs
.top
;
12 import java
.net
.URISyntaxException
;
13 import java
.util
.ArrayList
;
14 import java
.util
.Arrays
;
15 import java
.util
.Dictionary
;
16 import java
.util
.Enumeration
;
17 import java
.util
.Hashtable
;
18 import java
.util
.Iterator
;
19 import java
.util
.List
;
21 import javax
.naming
.InvalidNameException
;
22 import javax
.naming
.NameNotFoundException
;
23 import javax
.naming
.NamingEnumeration
;
24 import javax
.naming
.directory
.Attribute
;
25 import javax
.naming
.directory
.Attributes
;
26 import javax
.naming
.directory
.BasicAttribute
;
27 import javax
.naming
.directory
.BasicAttributes
;
28 import javax
.naming
.ldap
.LdapName
;
29 import javax
.naming
.ldap
.Rdn
;
30 import javax
.transaction
.SystemException
;
31 import javax
.transaction
.Transaction
;
32 import javax
.transaction
.TransactionManager
;
34 import org
.argeo
.naming
.LdapAttrs
;
35 import org
.osgi
.framework
.Filter
;
36 import org
.osgi
.framework
.FrameworkUtil
;
37 import org
.osgi
.framework
.InvalidSyntaxException
;
38 import org
.osgi
.service
.useradmin
.Authorization
;
39 import org
.osgi
.service
.useradmin
.Role
;
40 import org
.osgi
.service
.useradmin
.User
;
41 import org
.osgi
.service
.useradmin
.UserAdmin
;
43 /** Base class for a {@link UserDirectory}. */
44 public abstract class AbstractUserDirectory
implements UserAdmin
, UserDirectory
{
45 static final String SHARED_STATE_USERNAME
= "javax.security.auth.login.name";
46 static final String SHARED_STATE_PASSWORD
= "javax.security.auth.login.password";
48 private final Hashtable
<String
, Object
> properties
;
49 private final LdapName baseDn
, userBaseDn
, groupBaseDn
;
50 private final String userObjectClass
, userBase
, groupObjectClass
, groupBase
;
52 private final boolean readOnly
;
53 private final boolean disabled
;
54 private final String uri
;
56 private UserAdmin externalRoles
;
57 // private List<String> indexedUserProperties = Arrays
58 // .asList(new String[] { LdapAttrs.uid.name(), LdapAttrs.mail.name(),
59 // LdapAttrs.cn.name() });
61 private final boolean scoped
;
63 private String memberAttributeId
= "member";
64 private List
<String
> credentialAttributeIds
= Arrays
65 .asList(new String
[] { LdapAttrs
.userPassword
.name(), LdapAttrs
.authPassword
.name() });
68 private TransactionManager transactionManager
;
69 private WcXaResource xaResource
= new WcXaResource(this);
71 AbstractUserDirectory(URI uriArg
, Dictionary
<String
, ?
> props
, boolean scoped
) {
73 properties
= new Hashtable
<String
, Object
>();
74 for (Enumeration
<String
> keys
= props
.keys(); keys
.hasMoreElements();) {
75 String key
= keys
.nextElement();
76 properties
.put(key
, props
.get(key
));
80 uri
= uriArg
.toString();
81 // uri from properties is ignored
83 String uriStr
= UserAdminConf
.uri
.getValue(properties
);
90 userObjectClass
= UserAdminConf
.userObjectClass
.getValue(properties
);
91 userBase
= UserAdminConf
.userBase
.getValue(properties
);
92 groupObjectClass
= UserAdminConf
.groupObjectClass
.getValue(properties
);
93 groupBase
= UserAdminConf
.groupBase
.getValue(properties
);
95 baseDn
= new LdapName(UserAdminConf
.baseDn
.getValue(properties
));
96 userBaseDn
= new LdapName(userBase
+ "," + baseDn
);
97 groupBaseDn
= new LdapName(groupBase
+ "," + baseDn
);
98 } catch (InvalidNameException e
) {
99 throw new UserDirectoryException("Badly formated base DN " + UserAdminConf
.baseDn
.getValue(properties
), e
);
101 String readOnlyStr
= UserAdminConf
.readOnly
.getValue(properties
);
102 if (readOnlyStr
== null) {
103 readOnly
= readOnlyDefault(uri
);
104 properties
.put(UserAdminConf
.readOnly
.name(), Boolean
.toString(readOnly
));
106 readOnly
= Boolean
.parseBoolean(readOnlyStr
);
107 String disabledStr
= UserAdminConf
.disabled
.getValue(properties
);
108 if (disabledStr
!= null)
109 disabled
= Boolean
.parseBoolean(disabledStr
);
114 /** Returns the groups this user is a direct member of. */
115 protected abstract List
<LdapName
> getDirectGroups(LdapName dn
);
117 protected abstract Boolean
daoHasRole(LdapName dn
);
119 protected abstract DirectoryUser
daoGetRole(LdapName key
) throws NameNotFoundException
;
121 protected abstract List
<DirectoryUser
> doGetRoles(Filter f
);
123 protected abstract AbstractUserDirectory
scope(User user
);
129 public void destroy() {
133 protected boolean isEditing() {
134 return xaResource
.wc() != null;
137 protected UserDirectoryWorkingCopy
getWorkingCopy() {
138 UserDirectoryWorkingCopy wc
= xaResource
.wc();
144 protected void checkEdit() {
145 Transaction transaction
;
147 transaction
= transactionManager
.getTransaction();
148 } catch (SystemException e
) {
149 throw new UserDirectoryException("Cannot get transaction", e
);
151 if (transaction
== null)
152 throw new UserDirectoryException("A transaction needs to be active in order to edit");
153 if (xaResource
.wc() == null) {
155 transaction
.enlistResource(xaResource
);
156 } catch (Exception e
) {
157 throw new UserDirectoryException("Cannot enlist " + xaResource
, e
);
163 protected List
<Role
> getAllRoles(DirectoryUser user
) {
164 List
<Role
> allRoles
= new ArrayList
<Role
>();
166 collectRoles(user
, allRoles
);
169 collectAnonymousRoles(allRoles
);
173 private void collectRoles(DirectoryUser user
, List
<Role
> allRoles
) {
174 Attributes attrs
= user
.getAttributes();
175 // TODO centralize attribute name
176 Attribute memberOf
= attrs
.get(LdapAttrs
.memberOf
.name());
177 // if user belongs to this directory, we only check meberOf
178 if (memberOf
!= null && user
.getDn().startsWith(getBaseDn())) {
180 NamingEnumeration
<?
> values
= memberOf
.getAll();
181 while (values
.hasMore()) {
182 Object value
= values
.next();
183 LdapName groupDn
= new LdapName(value
.toString());
184 DirectoryUser group
= doGetRole(groupDn
);
188 } catch (Exception e
) {
189 throw new UserDirectoryException("Cannot get memberOf groups for " + user
, e
);
192 for (LdapName groupDn
: getDirectGroups(user
.getDn())) {
193 // TODO check for loops
194 DirectoryUser group
= doGetRole(groupDn
);
197 collectRoles(group
, allRoles
);
203 private void collectAnonymousRoles(List
<Role
> allRoles
) {
204 // TODO gather anonymous roles
209 public Role
getRole(String name
) {
210 return doGetRole(toDn(name
));
213 protected DirectoryUser
doGetRole(LdapName dn
) {
214 UserDirectoryWorkingCopy wc
= getWorkingCopy();
217 user
= daoGetRole(dn
);
218 } catch (NameNotFoundException e
) {
222 if (user
== null && wc
.getNewUsers().containsKey(dn
))
223 user
= wc
.getNewUsers().get(dn
);
224 else if (wc
.getDeletedUsers().containsKey(dn
))
231 public Role
[] getRoles(String filter
) throws InvalidSyntaxException
{
232 UserDirectoryWorkingCopy wc
= getWorkingCopy();
233 Filter f
= filter
!= null ? FrameworkUtil
.createFilter(filter
) : null;
234 List
<DirectoryUser
> res
= doGetRoles(f
);
236 for (Iterator
<DirectoryUser
> it
= res
.iterator(); it
.hasNext();) {
237 DirectoryUser user
= it
.next();
238 LdapName dn
= user
.getDn();
239 if (wc
.getDeletedUsers().containsKey(dn
))
242 for (DirectoryUser user
: wc
.getNewUsers().values()) {
243 if (f
== null || f
.match(user
.getProperties()))
246 // no need to check modified users,
247 // since doGetRoles was already based on the modified attributes
249 return res
.toArray(new Role
[res
.size()]);
253 public User
getUser(String key
, String value
) {
254 // TODO check value null or empty
255 List
<DirectoryUser
> collectedUsers
= new ArrayList
<DirectoryUser
>();
257 doGetUser(key
, value
, collectedUsers
);
259 throw new UserDirectoryException("Key cannot be null");
262 if (collectedUsers
.size() == 1) {
263 return collectedUsers
.get(0);
264 } else if (collectedUsers
.size() > 1) {
265 // log.warn(collectedUsers.size() + " users for " + (key != null ? key + "=" :
271 protected void doGetUser(String key
, String value
, List
<DirectoryUser
> collectedUsers
) {
273 Filter f
= FrameworkUtil
.createFilter("(" + key
+ "=" + value
+ ")");
274 List
<DirectoryUser
> users
= doGetRoles(f
);
275 collectedUsers
.addAll(users
);
276 } catch (InvalidSyntaxException e
) {
277 throw new UserDirectoryException("Cannot get user with " + key
+ "=" + value
, e
);
282 public Authorization
getAuthorization(User user
) {
283 if (user
== null || user
instanceof DirectoryUser
) {
284 return new LdifAuthorization(user
, getAllRoles((DirectoryUser
) user
));
287 AbstractUserDirectory scopedUserAdmin
= scope(user
);
289 DirectoryUser directoryUser
= (DirectoryUser
) scopedUserAdmin
.getRole(user
.getName());
290 if (directoryUser
== null)
291 throw new UserDirectoryException("No scoped user found for " + user
);
292 LdifAuthorization authorization
= new LdifAuthorization(directoryUser
,
293 scopedUserAdmin
.getAllRoles(directoryUser
));
294 return authorization
;
296 scopedUserAdmin
.destroy();
302 public Role
createRole(String name
, int type
) {
304 UserDirectoryWorkingCopy wc
= getWorkingCopy();
305 LdapName dn
= toDn(name
);
306 if ((daoHasRole(dn
) && !wc
.getDeletedUsers().containsKey(dn
)) || wc
.getNewUsers().containsKey(dn
))
307 throw new UserDirectoryException("Already a role " + name
);
308 BasicAttributes attrs
= new BasicAttributes(true);
309 // attrs.put(LdifName.dn.name(), dn.toString());
310 Rdn nameRdn
= dn
.getRdn(dn
.size() - 1);
311 // TODO deal with multiple attr RDN
312 attrs
.put(nameRdn
.getType(), nameRdn
.getValue());
313 if (wc
.getDeletedUsers().containsKey(dn
)) {
314 wc
.getDeletedUsers().remove(dn
);
315 wc
.getModifiedUsers().put(dn
, attrs
);
316 return getRole(name
);
318 wc
.getModifiedUsers().put(dn
, attrs
);
319 DirectoryUser newRole
= newRole(dn
, type
, attrs
);
320 wc
.getNewUsers().put(dn
, newRole
);
325 protected DirectoryUser
newRole(LdapName dn
, int type
, Attributes attrs
) {
327 BasicAttribute objClass
= new BasicAttribute(objectClass
.name());
328 if (type
== Role
.USER
) {
329 String userObjClass
= newUserObjectClass(dn
);
330 objClass
.add(userObjClass
);
331 if (inetOrgPerson
.name().equals(userObjClass
)) {
332 objClass
.add(organizationalPerson
.name());
333 objClass
.add(person
.name());
334 } else if (organizationalPerson
.name().equals(userObjClass
)) {
335 objClass
.add(person
.name());
337 objClass
.add(top
.name());
338 objClass
.add(extensibleObject
.name());
340 newRole
= new LdifUser(this, dn
, attrs
);
341 } else if (type
== Role
.GROUP
) {
342 String groupObjClass
= getGroupObjectClass();
343 objClass
.add(groupObjClass
);
344 // objClass.add(LdifName.extensibleObject.name());
345 objClass
.add(top
.name());
347 newRole
= new LdifGroup(this, dn
, attrs
);
349 throw new UserDirectoryException("Unsupported type " + type
);
354 public boolean removeRole(String name
) {
356 UserDirectoryWorkingCopy wc
= getWorkingCopy();
357 LdapName dn
= toDn(name
);
358 boolean actuallyDeleted
;
359 if (daoHasRole(dn
) || wc
.getNewUsers().containsKey(dn
)) {
360 DirectoryUser user
= (DirectoryUser
) getRole(name
);
361 wc
.getDeletedUsers().put(dn
, user
);
362 actuallyDeleted
= true;
363 } else {// just removing from groups (e.g. system roles)
364 actuallyDeleted
= false;
366 for (LdapName groupDn
: getDirectGroups(dn
)) {
367 DirectoryUser group
= doGetRole(groupDn
);
368 group
.getAttributes().get(getMemberAttributeId()).remove(dn
.toString());
370 return actuallyDeleted
;
374 protected void prepare(UserDirectoryWorkingCopy wc
) {
378 protected void commit(UserDirectoryWorkingCopy wc
) {
382 protected void rollback(UserDirectoryWorkingCopy wc
) {
387 protected LdapName
toDn(String name
) {
389 return new LdapName(name
);
390 } catch (InvalidNameException e
) {
391 throw new UserDirectoryException("Badly formatted name", e
);
396 protected String
getMemberAttributeId() {
397 return memberAttributeId
;
400 protected List
<String
> getCredentialAttributeIds() {
401 return credentialAttributeIds
;
404 protected String
getUri() {
408 private static boolean readOnlyDefault(String uriStr
) {
411 /// TODO make it more generic
414 uri
= new URI(uriStr
.split(" ")[0]);
415 } catch (URISyntaxException e
) {
416 throw new IllegalArgumentException(e
);
418 if (uri
.getScheme() == null)
419 return false;// assume relative file to be writable
420 if (uri
.getScheme().equals(UserAdminConf
.SCHEME_FILE
)) {
421 File file
= new File(uri
);
423 return !file
.canWrite();
425 return !file
.getParentFile().canWrite();
426 } else if (uri
.getScheme().equals(UserAdminConf
.SCHEME_LDAP
)) {
427 if (uri
.getAuthority() != null)// assume writable if authenticated
429 } else if (uri
.getScheme().equals(UserAdminConf
.SCHEME_OS
)) {
432 return true;// read only by default
435 public boolean isReadOnly() {
439 public boolean isDisabled() {
443 protected UserAdmin
getExternalRoles() {
444 return externalRoles
;
447 protected int roleType(LdapName dn
) {
448 if (dn
.startsWith(groupBaseDn
))
450 else if (dn
.startsWith(userBaseDn
))
456 /** dn can be null, in that case a default should be returned. */
457 public String
getUserObjectClass() {
458 return userObjectClass
;
461 public String
getUserBase() {
465 protected String
newUserObjectClass(LdapName dn
) {
466 return getUserObjectClass();
469 public String
getGroupObjectClass() {
470 return groupObjectClass
;
473 public String
getGroupBase() {
477 public LdapName
getBaseDn() {
478 return (LdapName
) baseDn
.clone();
481 public Dictionary
<String
, Object
> getProperties() {
485 public Dictionary
<String
, Object
> cloneProperties() {
486 return new Hashtable
<>(properties
);
489 public void setExternalRoles(UserAdmin externalRoles
) {
490 this.externalRoles
= externalRoles
;
493 public void setTransactionManager(TransactionManager transactionManager
) {
494 this.transactionManager
= transactionManager
;
497 public WcXaResource
getXaResource() {
501 public boolean isScoped() {