org.argeo.enterprise/src/org/argeo/osgi/useradmin/AbstractUserDirectory.java

   1 package org.argeo.osgi.useradmin;
   2
   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;
   9
  10 import java.io.File;
  11 import java.net.URI;
  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;
  20
  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;
  33
  34 import org.apache.commons.logging.Log;
  35 import org.apache.commons.logging.LogFactory;
  36 import org.argeo.naming.LdapAttrs;
  37 import org.osgi.framework.Filter;
  38 import org.osgi.framework.FrameworkUtil;
  39 import org.osgi.framework.InvalidSyntaxException;
  40 import org.osgi.service.useradmin.Authorization;
  41 import org.osgi.service.useradmin.Role;
  42 import org.osgi.service.useradmin.User;
  43 import org.osgi.service.useradmin.UserAdmin;
  44
  45 /** Base class for a {@link UserDirectory}. */
  46 public abstract class AbstractUserDirectory implements UserAdmin, UserDirectory {
  47         static final String SHARED_STATE_USERNAME = "javax.security.auth.login.name";
  48         static final String SHARED_STATE_PASSWORD = "javax.security.auth.login.password";
  49
  50         private final static Log log = LogFactory.getLog(AbstractUserDirectory.class);
  51
  52         private final Hashtable<String, Object> properties;
  53         private final LdapName baseDn, userBaseDn, groupBaseDn;
  54         private final String userObjectClass, userBase, groupObjectClass, groupBase;
  55
  56         private final boolean readOnly;
  57         private final boolean disabled;
  58         private final URI uri;
  59
  60         private UserAdmin externalRoles;
  61         // private List<String> indexedUserProperties = Arrays
  62         // .asList(new String[] { LdapAttrs.uid.name(), LdapAttrs.mail.name(),
  63         // LdapAttrs.cn.name() });
  64
  65         private String memberAttributeId = "member";
  66         private List<String> credentialAttributeIds = Arrays
  67                         .asList(new String[] { LdapAttrs.userPassword.name(), LdapAttrs.authPassword.name() });
  68
  69         // JTA
  70         private TransactionManager transactionManager;
  71         private WcXaResource xaResource = new WcXaResource(this);
  72
  73         public AbstractUserDirectory(URI uriArg, Dictionary<String, ?> props) {
  74                 properties = new Hashtable<String, Object>();
  75                 for (Enumeration<String> keys = props.keys(); keys.hasMoreElements();) {
  76                         String key = keys.nextElement();
  77                         properties.put(key, props.get(key));
  78                 }
  79
  80                 if (uriArg != null) {
  81                         uri = uriArg;
  82                         // uri from properties is ignored
  83                 } else {
  84                         String uriStr = UserAdminConf.uri.getValue(properties);
  85                         if (uriStr == null)
  86                                 uri = null;
  87                         else
  88                                 try {
  89                                         uri = new URI(uriStr);
  90                                 } catch (URISyntaxException e) {
  91                                         throw new UserDirectoryException("Badly formatted URI " + uriStr, e);
  92                                 }
  93                 }
  94
  95                 userObjectClass = UserAdminConf.userObjectClass.getValue(properties);
  96                 userBase = UserAdminConf.userBase.getValue(properties);
  97                 groupObjectClass = UserAdminConf.groupObjectClass.getValue(properties);
  98                 groupBase = UserAdminConf.groupBase.getValue(properties);
  99                 try {
 100                         baseDn = new LdapName(UserAdminConf.baseDn.getValue(properties));
 101                         userBaseDn = new LdapName(userBase + "," + baseDn);
 102                         groupBaseDn = new LdapName(groupBase + "," + baseDn);
 103                 } catch (InvalidNameException e) {
 104                         throw new UserDirectoryException("Badly formated base DN " + UserAdminConf.baseDn.getValue(properties), e);
 105                 }
 106                 String readOnlyStr = UserAdminConf.readOnly.getValue(properties);
 107                 if (readOnlyStr == null) {
 108                         readOnly = readOnlyDefault(uri);
 109                         properties.put(UserAdminConf.readOnly.name(), Boolean.toString(readOnly));
 110                 } else
 111                         readOnly = new Boolean(readOnlyStr);
 112                 String disabledStr = UserAdminConf.disabled.getValue(properties);
 113                 if (disabledStr != null)
 114                         disabled = new Boolean(disabledStr);
 115                 else
 116                         disabled = false;
 117         }
 118
 119         /** Returns the groups this user is a direct member of. */
 120         protected abstract List<LdapName> getDirectGroups(LdapName dn);
 121
 122         protected abstract Boolean daoHasRole(LdapName dn);
 123
 124         protected abstract DirectoryUser daoGetRole(LdapName key) throws NameNotFoundException;
 125
 126         protected abstract List<DirectoryUser> doGetRoles(Filter f);
 127
 128         protected abstract AbstractUserDirectory scope(User user);
 129
 130         public void init() {
 131
 132         }
 133
 134         public void destroy() {
 135
 136         }
 137
 138         protected boolean isEditing() {
 139                 return xaResource.wc() != null;
 140         }
 141
 142         protected UserDirectoryWorkingCopy getWorkingCopy() {
 143                 UserDirectoryWorkingCopy wc = xaResource.wc();
 144                 if (wc == null)
 145                         return null;
 146                 return wc;
 147         }
 148
 149         protected void checkEdit() {
 150                 Transaction transaction;
 151                 try {
 152                         transaction = transactionManager.getTransaction();
 153                 } catch (SystemException e) {
 154                         throw new UserDirectoryException("Cannot get transaction", e);
 155                 }
 156                 if (transaction == null)
 157                         throw new UserDirectoryException("A transaction needs to be active in order to edit");
 158                 if (xaResource.wc() == null) {
 159                         try {
 160                                 transaction.enlistResource(xaResource);
 161                         } catch (Exception e) {
 162                                 throw new UserDirectoryException("Cannot enlist " + xaResource, e);
 163                         }
 164                 } else {
 165                 }
 166         }
 167
 168         protected List<Role> getAllRoles(DirectoryUser user) {
 169                 List<Role> allRoles = new ArrayList<Role>();
 170                 if (user != null) {
 171                         collectRoles(user, allRoles);
 172                         allRoles.add(user);
 173                 } else
 174                         collectAnonymousRoles(allRoles);
 175                 return allRoles;
 176         }
 177
 178         private void collectRoles(DirectoryUser user, List<Role> allRoles) {
 179                 Attributes attrs = user.getAttributes();
 180                 // TODO centralize attribute name
 181                 Attribute memberOf = attrs.get(LdapAttrs.memberOf.name());
 182                 if (memberOf != null) {
 183                         try {
 184                                 NamingEnumeration<?> values = memberOf.getAll();
 185                                 while (values.hasMore()) {
 186                                         Object value = values.next();
 187                                         LdapName groupDn = new LdapName(value.toString());
 188                                         DirectoryUser group = doGetRole(groupDn);
 189                                         allRoles.add(group);
 190                                         if (log.isTraceEnabled())
 191                                                 log.trace("Add memberOf " + groupDn);
 192                                 }
 193                         } catch (Exception e) {
 194                                 throw new UserDirectoryException("Cannot get memberOf groups for " + user, e);
 195                         }
 196                 } else {
 197                         for (LdapName groupDn : getDirectGroups(user.getDn())) {
 198                                 // TODO check for loops
 199                                 DirectoryUser group = doGetRole(groupDn);
 200                                 allRoles.add(group);
 201                                 if (log.isTraceEnabled())
 202                                         log.trace("Add direct group " + groupDn);
 203                                 collectRoles(group, allRoles);
 204                         }
 205                 }
 206         }
 207
 208         private void collectAnonymousRoles(List<Role> allRoles) {
 209                 // TODO gather anonymous roles
 210         }
 211
 212         // USER ADMIN
 213         @Override
 214         public Role getRole(String name) {
 215                 return doGetRole(toDn(name));
 216         }
 217
 218         protected DirectoryUser doGetRole(LdapName dn) {
 219                 UserDirectoryWorkingCopy wc = getWorkingCopy();
 220                 DirectoryUser user;
 221                 try {
 222                         user = daoGetRole(dn);
 223                 } catch (NameNotFoundException e) {
 224                         user = null;
 225                 }
 226                 if (wc != null) {
 227                         if (user == null && wc.getNewUsers().containsKey(dn))
 228                                 user = wc.getNewUsers().get(dn);
 229                         else if (wc.getDeletedUsers().containsKey(dn))
 230                                 user = null;
 231                 }
 232                 return user;
 233         }
 234
 235         @Override
 236         public Role[] getRoles(String filter) throws InvalidSyntaxException {
 237                 UserDirectoryWorkingCopy wc = getWorkingCopy();
 238                 Filter f = filter != null ? FrameworkUtil.createFilter(filter) : null;
 239                 List<DirectoryUser> res = doGetRoles(f);
 240                 if (wc != null) {
 241                         for (Iterator<DirectoryUser> it = res.iterator(); it.hasNext();) {
 242                                 DirectoryUser user = it.next();
 243                                 LdapName dn = user.getDn();
 244                                 if (wc.getDeletedUsers().containsKey(dn))
 245                                         it.remove();
 246                         }
 247                         for (DirectoryUser user : wc.getNewUsers().values()) {
 248                                 if (f == null || f.match(user.getProperties()))
 249                                         res.add(user);
 250                         }
 251                         // no need to check modified users,
 252                         // since doGetRoles was already based on the modified attributes
 253                 }
 254                 return res.toArray(new Role[res.size()]);
 255         }
 256
 257         @Override
 258         public User getUser(String key, String value) {
 259                 // TODO check value null or empty
 260                 List<DirectoryUser> collectedUsers = new ArrayList<DirectoryUser>();
 261                 if (key != null) {
 262                         doGetUser(key, value, collectedUsers);
 263                 } else {
 264                         throw new UserDirectoryException("Key cannot be null");
 265                         // // try dn
 266                         // DirectoryUser user = null;
 267                         // try {
 268                         // user = (DirectoryUser) getRole(value);
 269                         // if (user != null)
 270                         // collectedUsers.add(user);
 271                         // } catch (Exception e) {
 272                         // // silent
 273                         // }
 274                         // // try all indexes
 275                         // for (String attr : getIndexedUserProperties())
 276                         // doGetUser(attr, value, collectedUsers);
 277                 }
 278                 if (collectedUsers.size() == 1)
 279                         return collectedUsers.get(0);
 280                 else if (collectedUsers.size() > 1)
 281                         log.warn(collectedUsers.size() + " users for " + (key != null ? key + "=" : "") + value);
 282                 return null;
 283         }
 284
 285         protected void doGetUser(String key, String value, List<DirectoryUser> collectedUsers) {
 286                 try {
 287                         Filter f = FrameworkUtil.createFilter("(" + key + "=" + value + ")");
 288                         List<DirectoryUser> users = doGetRoles(f);
 289                         collectedUsers.addAll(users);
 290                 } catch (InvalidSyntaxException e) {
 291                         throw new UserDirectoryException("Cannot get user with " + key + "=" + value, e);
 292                 }
 293         }
 294
 295         @Override
 296         public Authorization getAuthorization(User user) {
 297                 if (user == null || user instanceof DirectoryUser) {
 298                         return new LdifAuthorization(user, getAllRoles((DirectoryUser) user));
 299                 } else {
 300                         // bind
 301                         AbstractUserDirectory scopedUserAdmin = scope(user);
 302                         try {
 303                                 DirectoryUser directoryUser = (DirectoryUser) scopedUserAdmin.getRole(user.getName());
 304                                 if (directoryUser == null)
 305                                         throw new UserDirectoryException("No scoped user found for " + user);
 306                                 LdifAuthorization authorization = new LdifAuthorization(directoryUser,
 307                                                 scopedUserAdmin.getAllRoles(directoryUser));
 308                                 return authorization;
 309                         } finally {
 310                                 scopedUserAdmin.destroy();
 311                         }
 312                 }
 313         }
 314
 315         @Override
 316         public Role createRole(String name, int type) {
 317                 checkEdit();
 318                 UserDirectoryWorkingCopy wc = getWorkingCopy();
 319                 LdapName dn = toDn(name);
 320                 if ((daoHasRole(dn) && !wc.getDeletedUsers().containsKey(dn)) || wc.getNewUsers().containsKey(dn))
 321                         throw new UserDirectoryException("Already a role " + name);
 322                 BasicAttributes attrs = new BasicAttributes(true);
 323                 // attrs.put(LdifName.dn.name(), dn.toString());
 324                 Rdn nameRdn = dn.getRdn(dn.size() - 1);
 325                 // TODO deal with multiple attr RDN
 326                 attrs.put(nameRdn.getType(), nameRdn.getValue());
 327                 if (wc.getDeletedUsers().containsKey(dn)) {
 328                         wc.getDeletedUsers().remove(dn);
 329                         wc.getModifiedUsers().put(dn, attrs);
 330                         return getRole(name);
 331                 } else {
 332                         wc.getModifiedUsers().put(dn, attrs);
 333                         DirectoryUser newRole = newRole(dn, type, attrs);
 334                         wc.getNewUsers().put(dn, newRole);
 335                         return newRole;
 336                 }
 337         }
 338
 339         protected DirectoryUser newRole(LdapName dn, int type, Attributes attrs) {
 340                 LdifUser newRole;
 341                 BasicAttribute objClass = new BasicAttribute(objectClass.name());
 342                 if (type == Role.USER) {
 343                         String userObjClass = newUserObjectClass(dn);
 344                         objClass.add(userObjClass);
 345                         if (inetOrgPerson.name().equals(userObjClass)) {
 346                                 objClass.add(organizationalPerson.name());
 347                                 objClass.add(person.name());
 348                         } else if (organizationalPerson.name().equals(userObjClass)) {
 349                                 objClass.add(person.name());
 350                         }
 351                         objClass.add(top.name());
 352                         objClass.add(extensibleObject.name());
 353                         attrs.put(objClass);
 354                         newRole = new LdifUser(this, dn, attrs);
 355                 } else if (type == Role.GROUP) {
 356                         String groupObjClass = getGroupObjectClass();
 357                         objClass.add(groupObjClass);
 358                         // objClass.add(LdifName.extensibleObject.name());
 359                         objClass.add(top.name());
 360                         attrs.put(objClass);
 361                         newRole = new LdifGroup(this, dn, attrs);
 362                 } else
 363                         throw new UserDirectoryException("Unsupported type " + type);
 364                 return newRole;
 365         }
 366
 367         @Override
 368         public boolean removeRole(String name) {
 369                 checkEdit();
 370                 UserDirectoryWorkingCopy wc = getWorkingCopy();
 371                 LdapName dn = toDn(name);
 372                 boolean actuallyDeleted;
 373                 if (daoHasRole(dn) || wc.getNewUsers().containsKey(dn)) {
 374                         DirectoryUser user = (DirectoryUser) getRole(name);
 375                         wc.getDeletedUsers().put(dn, user);
 376                         actuallyDeleted = true;
 377                 } else {// just removing from groups (e.g. system roles)
 378                         actuallyDeleted = false;
 379                 }
 380                 for (LdapName groupDn : getDirectGroups(dn)) {
 381                         DirectoryUser group = doGetRole(groupDn);
 382                         group.getAttributes().get(getMemberAttributeId()).remove(dn.toString());
 383                 }
 384                 return actuallyDeleted;
 385         }
 386
 387         // TRANSACTION
 388         protected void prepare(UserDirectoryWorkingCopy wc) {
 389
 390         }
 391
 392         protected void commit(UserDirectoryWorkingCopy wc) {
 393
 394         }
 395
 396         protected void rollback(UserDirectoryWorkingCopy wc) {
 397
 398         }
 399
 400         // UTILITIES
 401         protected LdapName toDn(String name) {
 402                 try {
 403                         return new LdapName(name);
 404                 } catch (InvalidNameException e) {
 405                         throw new UserDirectoryException("Badly formatted name", e);
 406                 }
 407         }
 408
 409         // GETTERS
 410         protected String getMemberAttributeId() {
 411                 return memberAttributeId;
 412         }
 413
 414         protected List<String> getCredentialAttributeIds() {
 415                 return credentialAttributeIds;
 416         }
 417
 418         protected URI getUri() {
 419                 return uri;
 420         }
 421
 422         private static boolean readOnlyDefault(URI uri) {
 423                 if (uri == null)
 424                         return true;
 425                 if (uri.getScheme() == null)
 426                         return false;// assume relative file to be writable
 427                 if (uri.getScheme().equals(UserAdminConf.SCHEME_FILE)) {
 428                         File file = new File(uri);
 429                         if (file.exists())
 430                                 return !file.canWrite();
 431                         else
 432                                 return !file.getParentFile().canWrite();
 433                 } else if (uri.getScheme().equals(UserAdminConf.SCHEME_LDAP)) {
 434                         if (uri.getAuthority() != null)// assume writable if authenticated
 435                                 return false;
 436                 } else if (uri.getScheme().equals(UserAdminConf.SCHEME_OS)) {
 437                         return true;
 438                 }
 439                 return true;// read only by default
 440         }
 441
 442         public boolean isReadOnly() {
 443                 return readOnly;
 444         }
 445
 446         public boolean isDisabled() {
 447                 return disabled;
 448         }
 449
 450         protected UserAdmin getExternalRoles() {
 451                 return externalRoles;
 452         }
 453
 454         protected int roleType(LdapName dn) {
 455                 if (dn.startsWith(groupBaseDn))
 456                         return Role.GROUP;
 457                 else if (dn.startsWith(userBaseDn))
 458                         return Role.USER;
 459                 else
 460                         return Role.GROUP;
 461         }
 462
 463         /** dn can be null, in that case a default should be returned. */
 464         public String getUserObjectClass() {
 465                 return userObjectClass;
 466         }
 467
 468         public String getUserBase() {
 469                 return userBase;
 470         }
 471
 472         protected String newUserObjectClass(LdapName dn) {
 473                 return getUserObjectClass();
 474         }
 475
 476         public String getGroupObjectClass() {
 477                 return groupObjectClass;
 478         }
 479
 480         public String getGroupBase() {
 481                 return groupBase;
 482         }
 483
 484         public LdapName getBaseDn() {
 485                 return (LdapName) baseDn.clone();
 486         }
 487
 488         public Dictionary<String, Object> getProperties() {
 489                 return properties;
 490         }
 491
 492         public Dictionary<String, Object> cloneProperties() {
 493                 return new Hashtable<>(properties);
 494         }
 495
 496         public void setExternalRoles(UserAdmin externalRoles) {
 497                 this.externalRoles = externalRoles;
 498         }
 499
 500         public void setTransactionManager(TransactionManager transactionManager) {
 501                 this.transactionManager = transactionManager;
 502         }
 503
 504         public WcXaResource getXaResource() {
 505                 return xaResource;
 506         }
 507
 508 }