org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUserAdmin.java

   1 package org.argeo.osgi.useradmin;
   2
   3 import java.io.File;
   4 import java.io.FileOutputStream;
   5 import java.io.IOException;
   6 import java.io.InputStream;
   7 import java.io.OutputStream;
   8 import java.util.ArrayList;
   9 import java.util.Dictionary;
  10 import java.util.Hashtable;
  11 import java.util.List;
  12 import java.util.SortedMap;
  13 import java.util.TreeMap;
  14
  15 import javax.naming.InvalidNameException;
  16 import javax.naming.NamingEnumeration;
  17 import javax.naming.directory.Attributes;
  18 import javax.naming.ldap.LdapName;
  19 import javax.transaction.TransactionManager;
  20
  21 import org.apache.commons.io.IOUtils;
  22 import org.osgi.framework.Filter;
  23 import org.osgi.service.useradmin.Role;
  24 import org.osgi.service.useradmin.User;
  25
  26 /**
  27  * A user admin based on a LDIF files. Requires a {@link TransactionManager} and
  28  * an open transaction for write access.
  29  */
  30 public class LdifUserAdmin extends AbstractUserDirectory {
  31         private SortedMap<LdapName, DirectoryUser> users = new TreeMap<LdapName, DirectoryUser>();
  32         private SortedMap<LdapName, DirectoryGroup> groups = new TreeMap<LdapName, DirectoryGroup>();
  33
  34         public LdifUserAdmin(String uri, String baseDn) {
  35                 this(fromUri(uri, baseDn));
  36         }
  37
  38         public LdifUserAdmin(Dictionary<String, ?> properties) {
  39                 super(properties);
  40         }
  41
  42         public LdifUserAdmin(InputStream in) {
  43                 super(new Hashtable<String, Object>());
  44                 load(in);
  45                 setReadOnly(true);
  46                 setUri(null);
  47         }
  48
  49         private static Dictionary<String, Object> fromUri(String uri, String baseDn) {
  50                 Hashtable<String, Object> res = new Hashtable<String, Object>();
  51                 res.put(UserAdminConf.uri.property(), uri);
  52                 res.put(UserAdminConf.baseDn.property(), baseDn);
  53                 return res;
  54         }
  55
  56         public void init() {
  57                 try {
  58                         if (getUri().getScheme().equals("file")) {
  59                                 File file = new File(getUri());
  60                                 if (!file.exists())
  61                                         return;
  62                         }
  63                         load(getUri().toURL().openStream());
  64                 } catch (Exception e) {
  65                         throw new UserDirectoryException("Cannot open URL " + getUri(), e);
  66                 }
  67         }
  68
  69         public void save() {
  70                 if (getUri() == null || isReadOnly())
  71                         throw new UserDirectoryException("Cannot save LDIF user admin");
  72                 try (FileOutputStream out = new FileOutputStream(new File(getUri()))) {
  73                         save(out);
  74                 } catch (IOException e) {
  75                         throw new UserDirectoryException("Cannot save user admin to "
  76                                         + getUri(), e);
  77                 }
  78         }
  79
  80         public void save(OutputStream out) throws IOException {
  81                 try {
  82                         LdifWriter ldifWriter = new LdifWriter(out);
  83                         for (LdapName name : groups.keySet())
  84                                 ldifWriter.writeEntry(name, groups.get(name).getAttributes());
  85                         for (LdapName name : users.keySet())
  86                                 ldifWriter.writeEntry(name, users.get(name).getAttributes());
  87                 } finally {
  88                         IOUtils.closeQuietly(out);
  89                 }
  90         }
  91
  92         protected void load(InputStream in) {
  93                 try {
  94                         users.clear();
  95                         groups.clear();
  96
  97                         LdifParser ldifParser = new LdifParser();
  98                         SortedMap<LdapName, Attributes> allEntries = ldifParser.read(in);
  99                         for (LdapName key : allEntries.keySet()) {
 100                                 Attributes attributes = allEntries.get(key);
 101                                 NamingEnumeration<?> objectClasses = attributes.get(
 102                                                 "objectClass").getAll();
 103                                 objectClasses: while (objectClasses.hasMore()) {
 104                                         String objectClass = objectClasses.next().toString();
 105                                         if (objectClass.equals("inetOrgPerson")) {
 106                                                 users.put(key, new LdifUser(this, key, attributes));
 107                                                 break objectClasses;
 108                                         } else if (objectClass.equals("groupOfNames")) {
 109                                                 groups.put(key, new LdifGroup(this, key, attributes));
 110                                                 break objectClasses;
 111                                         }
 112                                 }
 113                         }
 114                 } catch (Exception e) {
 115                         throw new UserDirectoryException(
 116                                         "Cannot load user admin service from LDIF", e);
 117                 }
 118         }
 119
 120         public void destroy() {
 121                 users.clear();
 122                 users = null;
 123                 groups.clear();
 124                 groups = null;
 125         }
 126
 127         protected DirectoryUser daoGetRole(LdapName key) {
 128                 if (groups.containsKey(key))
 129                         return groups.get(key);
 130                 if (users.containsKey(key))
 131                         return users.get(key);
 132                 return null;
 133         }
 134
 135         protected Boolean daoHasRole(LdapName dn) {
 136                 return users.containsKey(dn) || groups.containsKey(dn);
 137         }
 138
 139         @SuppressWarnings("unchecked")
 140         protected List<DirectoryUser> doGetRoles(Filter f) {
 141                 ArrayList<DirectoryUser> res = new ArrayList<DirectoryUser>();
 142                 if (f == null) {
 143                         res.addAll(users.values());
 144                         res.addAll(groups.values());
 145                 } else {
 146                         // Filter f = FrameworkUtil.createFilter(filter);
 147                         for (DirectoryUser user : users.values())
 148                                 if (f.match(user.getProperties()))
 149                                         res.add(user);
 150                         for (DirectoryUser group : groups.values())
 151                                 if (f.match(group.getProperties()))
 152                                         res.add(group);
 153                 }
 154                 return res;
 155         }
 156
 157         @Override
 158         protected List<DirectoryGroup> getDirectGroups(User user) {
 159                 LdapName dn;
 160                 if (user instanceof LdifUser)
 161                         dn = ((LdifUser) user).getDn();
 162                 else
 163                         try {
 164                                 dn = new LdapName(user.getName());
 165                         } catch (InvalidNameException e) {
 166                                 throw new UserDirectoryException("Badly formatted user name "
 167                                                 + user.getName(), e);
 168                         }
 169
 170                 List<DirectoryGroup> directGroups = new ArrayList<DirectoryGroup>();
 171                 for (LdapName name : groups.keySet()) {
 172                         DirectoryGroup group = groups.get(name);
 173                         if (group.getMemberNames().contains(dn))
 174                                 directGroups.add(group);
 175                 }
 176                 return directGroups;
 177         }
 178
 179         @Override
 180         protected void prepare(WorkingCopy wc) {
 181                 // delete
 182                 for (LdapName dn : wc.getDeletedUsers().keySet()) {
 183                         if (users.containsKey(dn))
 184                                 users.remove(dn);
 185                         else if (groups.containsKey(dn))
 186                                 groups.remove(dn);
 187                         else
 188                                 throw new UserDirectoryException("User to delete no found "
 189                                                 + dn);
 190                 }
 191                 // add
 192                 for (LdapName dn : wc.getNewUsers().keySet()) {
 193                         DirectoryUser user = wc.getNewUsers().get(dn);
 194                         if (Role.USER == user.getType())
 195                                 users.put(dn, user);
 196                         else if (Role.GROUP == user.getType())
 197                                 groups.put(dn, (DirectoryGroup) user);
 198                         else
 199                                 throw new UserDirectoryException("Unsupported role type "
 200                                                 + user.getType() + " for new user " + dn);
 201                 }
 202                 // modify
 203                 for (LdapName dn : wc.getModifiedUsers().keySet()) {
 204                         Attributes modifiedAttrs = wc.getModifiedUsers().get(dn);
 205                         DirectoryUser user;
 206                         if (users.containsKey(dn))
 207                                 user = users.get(dn);
 208                         else if (groups.containsKey(dn))
 209                                 user = groups.get(dn);
 210                         else
 211                                 throw new UserDirectoryException("User to modify no found "
 212                                                 + dn);
 213                         user.publishAttributes(modifiedAttrs);
 214                 }
 215         }
 216
 217         @Override
 218         protected void commit(WorkingCopy wc) {
 219                 save();
 220         }
 221
 222         @Override
 223         protected void rollback(WorkingCopy wc) {
 224                 init();
 225         }
 226
 227 }