1 package org
.argeo
.osgi
.useradmin
;
3 import java
.util
.ArrayList
;
4 import java
.util
.Arrays
;
5 import java
.util
.HashMap
;
6 import java
.util
.HashSet
;
11 import javax
.naming
.InvalidNameException
;
12 import javax
.naming
.ldap
.LdapName
;
14 import org
.osgi
.framework
.InvalidSyntaxException
;
15 import org
.osgi
.service
.useradmin
.Authorization
;
16 import org
.osgi
.service
.useradmin
.Group
;
17 import org
.osgi
.service
.useradmin
.Role
;
18 import org
.osgi
.service
.useradmin
.User
;
19 import org
.osgi
.service
.useradmin
.UserAdmin
;
22 * Aggregates multiple {@link UserDirectory} and integrates them with system
25 public class AggregatingUserAdmin
implements UserAdmin
{
26 private final LdapName systemRolesBaseDn
;
27 private final LdapName tokensBaseDn
;
30 private AbstractUserDirectory systemRoles
= null;
31 private AbstractUserDirectory tokens
= null;
32 private Map
<LdapName
, AbstractUserDirectory
> businessRoles
= new HashMap
<LdapName
, AbstractUserDirectory
>();
34 public AggregatingUserAdmin(String systemRolesBaseDn
, String tokensBaseDn
) {
36 this.systemRolesBaseDn
= new LdapName(systemRolesBaseDn
);
37 if (tokensBaseDn
!= null)
38 this.tokensBaseDn
= new LdapName(tokensBaseDn
);
40 this.tokensBaseDn
= null;
41 } catch (InvalidNameException e
) {
42 throw new UserDirectoryException("Cannot initialize " + AggregatingUserAdmin
.class, e
);
47 public Role
createRole(String name
, int type
) {
48 return findUserAdmin(name
).createRole(name
, type
);
52 public boolean removeRole(String name
) {
53 boolean actuallyDeleted
= findUserAdmin(name
).removeRole(name
);
54 systemRoles
.removeRole(name
);
55 return actuallyDeleted
;
59 public Role
getRole(String name
) {
60 return findUserAdmin(name
).getRole(name
);
64 public Role
[] getRoles(String filter
) throws InvalidSyntaxException
{
65 List
<Role
> res
= new ArrayList
<Role
>();
66 for (UserAdmin userAdmin
: businessRoles
.values()) {
67 res
.addAll(Arrays
.asList(userAdmin
.getRoles(filter
)));
69 res
.addAll(Arrays
.asList(systemRoles
.getRoles(filter
)));
70 return res
.toArray(new Role
[res
.size()]);
74 public User
getUser(String key
, String value
) {
75 List
<User
> res
= new ArrayList
<User
>();
76 for (UserAdmin userAdmin
: businessRoles
.values()) {
77 User u
= userAdmin
.getUser(key
, value
);
81 // Note: node roles cannot contain users, so it is not searched
82 return res
.size() == 1 ? res
.get(0) : null;
86 public Authorization
getAuthorization(User user
) {
87 if (user
== null) {// anonymous
88 return systemRoles
.getAuthorization(null);
90 AbstractUserDirectory userReferentialOfThisUser
= findUserAdmin(user
.getName());
91 Authorization rawAuthorization
= userReferentialOfThisUser
.getAuthorization(user
);
93 String displayNameToUse
;
94 if (user
instanceof Group
) {
95 // TODO check whether this is still working
96 String ownerDn
= TokenUtils
.userDn((Group
) user
);
97 if (ownerDn
!= null) {// tokens
98 UserAdmin ownerUserAdmin
= findUserAdmin(ownerDn
);
99 User ownerUser
= (User
) ownerUserAdmin
.getRole(ownerDn
);
100 usernameToUse
= ownerDn
;
101 displayNameToUse
= LdifAuthorization
.extractDisplayName(ownerUser
);
103 usernameToUse
= rawAuthorization
.getName();
104 displayNameToUse
= rawAuthorization
.toString();
106 } else {// regular users
107 usernameToUse
= rawAuthorization
.getName();
108 displayNameToUse
= rawAuthorization
.toString();
111 // gather roles from other referentials
112 final AbstractUserDirectory userAdminToUse
;// possibly scoped when authenticating
113 if (user
instanceof DirectoryUser
) {
114 userAdminToUse
= userReferentialOfThisUser
;
115 } else if (user
instanceof AuthenticatingUser
) {
116 userAdminToUse
= userReferentialOfThisUser
.scope(user
);
118 throw new IllegalArgumentException("Unsupported user type " + user
.getClass());
122 Set
<String
> sysRoles
= new HashSet
<String
>();
123 for (String role
: rawAuthorization
.getRoles()) {
124 User userOrGroup
= (User
) userAdminToUse
.getRole(role
);
125 Authorization auth
= systemRoles
.getAuthorization(userOrGroup
);
126 systemRoles
: for (String systemRole
: auth
.getRoles()) {
127 if (role
.equals(systemRole
))
128 continue systemRoles
;
129 sysRoles
.add(systemRole
);
131 // sysRoles.addAll(Arrays.asList(auth.getRoles()));
133 addAbstractSystemRoles(rawAuthorization
, sysRoles
);
134 Authorization authorization
= new AggregatingAuthorization(usernameToUse
, displayNameToUse
, sysRoles
,
135 rawAuthorization
.getRoles());
136 return authorization
;
138 if (userAdminToUse
!= null && userAdminToUse
.isScoped()) {
139 userAdminToUse
.destroy();
145 * Enrich with application-specific roles which are strictly programmatic, such
146 * as anonymous/user semantics.
148 protected void addAbstractSystemRoles(Authorization rawAuthorization
, Set
<String
> sysRoles
) {
153 // USER ADMIN AGGREGATOR
155 protected void addUserDirectory(AbstractUserDirectory userDirectory
) {
156 LdapName baseDn
= userDirectory
.getBaseDn();
157 if (isSystemRolesBaseDn(baseDn
)) {
158 this.systemRoles
= userDirectory
;
159 systemRoles
.setExternalRoles(this);
160 } else if (isTokensBaseDn(baseDn
)) {
161 this.tokens
= userDirectory
;
162 tokens
.setExternalRoles(this);
164 if (businessRoles
.containsKey(baseDn
))
165 throw new UserDirectoryException("There is already a user admin for " + baseDn
);
166 businessRoles
.put(baseDn
, userDirectory
);
168 userDirectory
.init();
169 postAdd(userDirectory
);
172 /** Called after a new user directory has been added */
173 protected void postAdd(AbstractUserDirectory userDirectory
) {
176 // private UserAdmin findUserAdmin(User user) {
178 // throw new IllegalArgumentException("User should not be null");
179 // AbstractUserDirectory userAdmin = findUserAdmin(user.getName());
180 // if (user instanceof DirectoryUser) {
183 // return userAdmin.scope(user);
187 private AbstractUserDirectory
findUserAdmin(String name
) {
189 return findUserAdmin(new LdapName(name
));
190 } catch (InvalidNameException e
) {
191 throw new UserDirectoryException("Badly formatted name " + name
, e
);
195 private AbstractUserDirectory
findUserAdmin(LdapName name
) {
196 if (name
.startsWith(systemRolesBaseDn
))
198 if (tokensBaseDn
!= null && name
.startsWith(tokensBaseDn
))
200 List
<AbstractUserDirectory
> res
= new ArrayList
<>(1);
201 userDirectories
: for (LdapName baseDn
: businessRoles
.keySet()) {
202 AbstractUserDirectory userDirectory
= businessRoles
.get(baseDn
);
203 if (name
.startsWith(baseDn
)) {
204 if (userDirectory
.isDisabled())
205 continue userDirectories
;
206 // if (res.isEmpty()) {
207 res
.add(userDirectory
);
209 // for (AbstractUserDirectory ud : res) {
210 // LdapName bd = ud.getBaseDn();
211 // if (userDirectory.getBaseDn().startsWith(bd)) {
212 // // child user directory
219 throw new UserDirectoryException("Cannot find user admin for " + name
);
221 throw new UserDirectoryException("Multiple user admin found for " + name
);
225 protected boolean isSystemRolesBaseDn(LdapName baseDn
) {
226 return baseDn
.equals(systemRolesBaseDn
);
229 protected boolean isTokensBaseDn(LdapName baseDn
) {
230 return tokensBaseDn
!= null && baseDn
.equals(tokensBaseDn
);
233 // protected Dictionary<String, Object> currentState() {
234 // Dictionary<String, Object> res = new Hashtable<String, Object>();
235 // // res.put(NodeConstants.CN, NodeConstants.DEFAULT);
236 // for (LdapName name : businessRoles.keySet()) {
237 // AbstractUserDirectory userDirectory = businessRoles.get(name);
238 // String uri = UserAdminConf.propertiesAsUri(userDirectory.getProperties()).toString();
244 public void destroy() {
245 for (LdapName name
: businessRoles
.keySet()) {
246 AbstractUserDirectory userDirectory
= businessRoles
.get(name
);
247 destroy(userDirectory
);
249 businessRoles
.clear();
250 businessRoles
= null;
251 destroy(systemRoles
);
255 private void destroy(AbstractUserDirectory userDirectory
) {
256 preDestroy(userDirectory
);
257 userDirectory
.destroy();
260 protected void removeUserDirectory(LdapName baseDn
) {
261 if (isSystemRolesBaseDn(baseDn
))
262 throw new UserDirectoryException("System roles cannot be removed ");
263 if (!businessRoles
.containsKey(baseDn
))
264 throw new UserDirectoryException("No user directory registered for " + baseDn
);
265 AbstractUserDirectory userDirectory
= businessRoles
.remove(baseDn
);
266 destroy(userDirectory
);
270 * Called before each user directory is destroyed, so that additional actions
273 protected void preDestroy(AbstractUserDirectory userDirectory
) {