org.argeo.cms/src/org/argeo/cms/internal/kernel/NodeUserAdmin.java

   1 package org.argeo.cms.internal.kernel;
   2
   3 import java.io.IOException;
   4 import java.net.Inet6Address;
   5 import java.net.InetAddress;
   6 import java.net.URI;
   7 import java.net.URISyntaxException;
   8 import java.nio.file.Files;
   9 import java.nio.file.Path;
  10 import java.security.PrivilegedExceptionAction;
  11 import java.util.ArrayList;
  12 import java.util.Dictionary;
  13 import java.util.HashMap;
  14 import java.util.Hashtable;
  15 import java.util.Iterator;
  16 import java.util.Map;
  17 import java.util.Set;
  18
  19 import javax.naming.ldap.LdapName;
  20 import javax.security.auth.Subject;
  21 import javax.security.auth.callback.Callback;
  22 import javax.security.auth.callback.CallbackHandler;
  23 import javax.security.auth.callback.NameCallback;
  24 import javax.security.auth.callback.UnsupportedCallbackException;
  25 import javax.security.auth.kerberos.KerberosPrincipal;
  26 import javax.security.auth.login.LoginContext;
  27 import javax.security.auth.login.LoginException;
  28 import javax.transaction.TransactionManager;
  29
  30 import org.apache.commons.httpclient.auth.AuthPolicy;
  31 import org.apache.commons.httpclient.auth.CredentialsProvider;
  32 import org.apache.commons.httpclient.params.DefaultHttpParams;
  33 import org.apache.commons.httpclient.params.HttpMethodParams;
  34 import org.apache.commons.httpclient.params.HttpParams;
  35 import org.apache.commons.logging.Log;
  36 import org.apache.commons.logging.LogFactory;
  37 import org.argeo.cms.CmsException;
  38 import org.argeo.cms.internal.http.client.HttpCredentialProvider;
  39 import org.argeo.cms.internal.http.client.SpnegoAuthScheme;
  40 import org.argeo.naming.DnsBrowser;
  41 import org.argeo.node.NodeConstants;
  42 import org.argeo.osgi.useradmin.AbstractUserDirectory;
  43 import org.argeo.osgi.useradmin.AggregatingUserAdmin;
  44 import org.argeo.osgi.useradmin.LdapUserAdmin;
  45 import org.argeo.osgi.useradmin.LdifUserAdmin;
  46 import org.argeo.osgi.useradmin.OsUserDirectory;
  47 import org.argeo.osgi.useradmin.UserAdminConf;
  48 import org.argeo.osgi.useradmin.UserDirectory;
  49 import org.ietf.jgss.GSSCredential;
  50 import org.ietf.jgss.GSSException;
  51 import org.ietf.jgss.GSSManager;
  52 import org.ietf.jgss.GSSName;
  53 import org.ietf.jgss.Oid;
  54 import org.osgi.framework.BundleContext;
  55 import org.osgi.framework.Constants;
  56 import org.osgi.framework.FrameworkUtil;
  57 import org.osgi.framework.ServiceRegistration;
  58 import org.osgi.service.cm.ConfigurationException;
  59 import org.osgi.service.cm.ManagedServiceFactory;
  60 import org.osgi.service.useradmin.Authorization;
  61 import org.osgi.service.useradmin.UserAdmin;
  62 import org.osgi.util.tracker.ServiceTracker;
  63
  64 import bitronix.tm.BitronixTransactionManager;
  65 import bitronix.tm.resource.ehcache.EhCacheXAResourceProducer;
  66
  67 /**
  68  * Aggregates multiple {@link UserDirectory} and integrates them with system
  69  * roles.
  70  */
  71 class NodeUserAdmin extends AggregatingUserAdmin implements ManagedServiceFactory, KernelConstants {
  72         private final static Log log = LogFactory.getLog(NodeUserAdmin.class);
  73         private final BundleContext bc = FrameworkUtil.getBundle(getClass()).getBundleContext();
  74
  75         // OSGi
  76         private Map<String, LdapName> pidToBaseDn = new HashMap<>();
  77         private Map<String, ServiceRegistration<UserDirectory>> pidToServiceRegs = new HashMap<>();
  78         private ServiceRegistration<UserAdmin> userAdminReg;
  79
  80         // JTA
  81         private final ServiceTracker<TransactionManager, TransactionManager> tmTracker;
  82         private final String cacheName = UserDirectory.class.getName();
  83
  84         // GSS API
  85         private Path nodeKeyTab = KernelUtils.getOsgiInstancePath(KernelConstants.NODE_KEY_TAB_PATH);
  86         private GSSCredential acceptorCredentials;
  87
  88         private boolean singleUser = false;
  89
  90         public NodeUserAdmin(String systemRolesBaseDn) {
  91                 super(systemRolesBaseDn);
  92                 tmTracker = new ServiceTracker<>(bc, TransactionManager.class, null);
  93                 tmTracker.open();
  94         }
  95
  96         @Override
  97         public void updated(String pid, Dictionary<String, ?> properties) throws ConfigurationException {
  98                 String uri = (String) properties.get(UserAdminConf.uri.name());
  99                 URI u;
 100                 try {
 101                         if (uri == null) {
 102                                 String baseDn = (String) properties.get(UserAdminConf.baseDn.name());
 103                                 u = KernelUtils.getOsgiInstanceUri(KernelConstants.DIR_NODE + '/' + baseDn + ".ldif");
 104                         } else
 105                                 u = new URI(uri);
 106                 } catch (URISyntaxException e) {
 107                         throw new CmsException("Badly formatted URI " + uri, e);
 108                 }
 109
 110                 // Create
 111                 AbstractUserDirectory userDirectory;
 112                 if (UserAdminConf.SCHEME_LDAP.equals(u.getScheme())) {
 113                         userDirectory = new LdapUserAdmin(properties);
 114                 } else if (UserAdminConf.SCHEME_FILE.equals(u.getScheme())) {
 115                         userDirectory = new LdifUserAdmin(u, properties);
 116                 } else if (UserAdminConf.SCHEME_OS.equals(u.getScheme())) {
 117                         userDirectory = new OsUserDirectory(u, properties);
 118                         singleUser = true;
 119                 } else {
 120                         throw new CmsException("Unsupported scheme " + u.getScheme());
 121                 }
 122                 Object realm = userDirectory.getProperties().get(UserAdminConf.realm.name());
 123                 addUserDirectory(userDirectory);
 124
 125                 // OSGi
 126                 LdapName baseDn = userDirectory.getBaseDn();
 127                 Dictionary<String, Object> regProps = new Hashtable<>();
 128                 regProps.put(Constants.SERVICE_PID, pid);
 129                 if (isSystemRolesBaseDn(baseDn))
 130                         regProps.put(Constants.SERVICE_RANKING, Integer.MAX_VALUE);
 131                 regProps.put(UserAdminConf.baseDn.name(), baseDn);
 132                 ServiceRegistration<UserDirectory> reg = bc.registerService(UserDirectory.class, userDirectory, regProps);
 133                 pidToBaseDn.put(pid, baseDn);
 134                 pidToServiceRegs.put(pid, reg);
 135
 136                 if (log.isDebugEnabled())
 137                         log.debug("User directory " + userDirectory.getBaseDn() + " [" + u.getScheme() + "] enabled."
 138                                         + (realm != null ? " " + realm + " realm." : ""));
 139
 140                 if (!isSystemRolesBaseDn(baseDn)) {
 141                         if (userAdminReg != null)
 142                                 userAdminReg.unregister();
 143                         // register self as main user admin
 144                         Dictionary<String, Object> userAdminregProps = currentState();
 145                         userAdminregProps.put(NodeConstants.CN, NodeConstants.DEFAULT);
 146                         userAdminregProps.put(Constants.SERVICE_RANKING, Integer.MAX_VALUE);
 147                         userAdminReg = bc.registerService(UserAdmin.class, this, userAdminregProps);
 148                 }
 149         }
 150
 151         @Override
 152         public void deleted(String pid) {
 153                 assert pidToServiceRegs.get(pid) != null;
 154                 assert pidToBaseDn.get(pid) != null;
 155                 pidToServiceRegs.remove(pid).unregister();
 156                 LdapName baseDn = pidToBaseDn.remove(pid);
 157                 removeUserDirectory(baseDn);
 158         }
 159
 160         @Override
 161         public String getName() {
 162                 return "Node User Admin";
 163         }
 164
 165         @Override
 166         protected void addAbstractSystemRoles(Authorization rawAuthorization, Set<String> sysRoles) {
 167                 if (rawAuthorization.getName() == null) {
 168                         sysRoles.add(NodeConstants.ROLE_ANONYMOUS);
 169                 } else {
 170                         sysRoles.add(NodeConstants.ROLE_USER);
 171                 }
 172         }
 173
 174         protected void postAdd(AbstractUserDirectory userDirectory) {
 175                 // JTA
 176                 TransactionManager tm = tmTracker.getService();
 177                 if (tm == null)
 178                         throw new CmsException("A JTA transaction manager must be available.");
 179                 userDirectory.setTransactionManager(tm);
 180                 if (tmTracker.getService() instanceof BitronixTransactionManager)
 181                         EhCacheXAResourceProducer.registerXAResource(cacheName, userDirectory.getXaResource());
 182
 183                 Object realm = userDirectory.getProperties().get(UserAdminConf.realm.name());
 184                 if (realm != null) {
 185                         if (Files.exists(nodeKeyTab)) {
 186                                 String servicePrincipal = getKerberosServicePrincipal(realm.toString());
 187                                 if (servicePrincipal != null) {
 188                                         CallbackHandler callbackHandler = new CallbackHandler() {
 189                                                 @Override
 190                                                 public void handle(Callback[] callbacks) throws IOException, UnsupportedCallbackException {
 191                                                         for (Callback callback : callbacks)
 192                                                                 if (callback instanceof NameCallback)
 193                                                                         ((NameCallback) callback).setName(servicePrincipal);
 194
 195                                                 }
 196                                         };
 197                                         try {
 198                                                 LoginContext nodeLc = new LoginContext(NodeConstants.LOGIN_CONTEXT_NODE, callbackHandler);
 199                                                 nodeLc.login();
 200                                                 acceptorCredentials = logInAsAcceptor(nodeLc.getSubject(), servicePrincipal);
 201                                         } catch (LoginException e) {
 202                                                 throw new CmsException("Cannot log in kernel", e);
 203                                         }
 204                                 }
 205                         }
 206
 207                         // Register client-side SPNEGO auth scheme
 208                         AuthPolicy.registerAuthScheme(SpnegoAuthScheme.NAME, SpnegoAuthScheme.class);
 209                         HttpParams params = DefaultHttpParams.getDefaultParams();
 210                         ArrayList<String> schemes = new ArrayList<>();
 211                         schemes.add(SpnegoAuthScheme.NAME);// SPNEGO preferred
 212                         // schemes.add(AuthPolicy.BASIC);// incompatible with Basic
 213                         params.setParameter(AuthPolicy.AUTH_SCHEME_PRIORITY, schemes);
 214                         params.setParameter(CredentialsProvider.PROVIDER, new HttpCredentialProvider());
 215                         params.setParameter(HttpMethodParams.COOKIE_POLICY, KernelConstants.COOKIE_POLICY_BROWSER_COMPATIBILITY);
 216                         // params.setCookiePolicy(CookiePolicy.BROWSER_COMPATIBILITY);
 217                 }
 218         }
 219
 220         protected void preDestroy(AbstractUserDirectory userDirectory) {
 221                 if (tmTracker.getService() instanceof BitronixTransactionManager)
 222                         EhCacheXAResourceProducer.unregisterXAResource(cacheName, userDirectory.getXaResource());
 223
 224                 Object realm = userDirectory.getProperties().get(UserAdminConf.realm.name());
 225                 if (realm != null) {
 226                         if (acceptorCredentials != null) {
 227                                 try {
 228                                         acceptorCredentials.dispose();
 229                                 } catch (GSSException e) {
 230                                         // silent
 231                                 }
 232                                 acceptorCredentials = null;
 233                         }
 234                 }
 235         }
 236
 237         private String getKerberosServicePrincipal(String realm) {
 238                 String hostname;
 239                 try (DnsBrowser dnsBrowser = new DnsBrowser()) {
 240                         InetAddress localhost = InetAddress.getLocalHost();
 241                         hostname = localhost.getHostName();
 242                         String dnsZone = hostname.substring(hostname.indexOf('.') + 1);
 243                         String ipfromDns = dnsBrowser.getRecord(hostname, localhost instanceof Inet6Address ? "AAAA" : "A");
 244                         boolean consistentIp = localhost.getHostAddress().equals(ipfromDns);
 245                         String kerberosDomain = dnsBrowser.getRecord("_kerberos." + dnsZone, "TXT");
 246                         if (consistentIp && kerberosDomain != null && kerberosDomain.equals(realm) && Files.exists(nodeKeyTab)) {
 247                                 return NodeHttp.DEFAULT_SERVICE + "/" + hostname + "@" + kerberosDomain;
 248                         } else
 249                                 return null;
 250                 } catch (Exception e) {
 251                         log.warn("Exception when determining kerberos principal", e);
 252                         return null;
 253                 }
 254         }
 255
 256         private GSSCredential logInAsAcceptor(Subject subject, String servicePrincipal) {
 257                 // GSS
 258                 Iterator<KerberosPrincipal> krb5It = subject.getPrincipals(KerberosPrincipal.class).iterator();
 259                 if (!krb5It.hasNext())
 260                         return null;
 261                 KerberosPrincipal krb5Principal = null;
 262                 while (krb5It.hasNext()) {
 263                         KerberosPrincipal principal = krb5It.next();
 264                         if (principal.getName().equals(servicePrincipal))
 265                                 krb5Principal = principal;
 266                 }
 267
 268                 if (krb5Principal == null)
 269                         return null;
 270
 271                 GSSManager manager = GSSManager.getInstance();
 272                 try {
 273                         GSSName gssName = manager.createName(krb5Principal.getName(), null);
 274                         GSSCredential serverCredentials = Subject.doAs(subject, new PrivilegedExceptionAction<GSSCredential>() {
 275
 276                                 @Override
 277                                 public GSSCredential run() throws GSSException {
 278                                         return manager.createCredential(gssName, GSSCredential.INDEFINITE_LIFETIME, KERBEROS_OID,
 279                                                         GSSCredential.ACCEPT_ONLY);
 280
 281                                 }
 282
 283                         });
 284                         if (log.isDebugEnabled())
 285                                 log.debug("GSS acceptor configured for " + krb5Principal);
 286                         return serverCredentials;
 287                 } catch (Exception gsse) {
 288                         throw new CmsException("Cannot create acceptor credentials for " + krb5Principal, gsse);
 289                 }
 290         }
 291
 292         public GSSCredential getAcceptorCredentials() {
 293                 return acceptorCredentials;
 294         }
 295
 296         public boolean isSingleUser() {
 297                 return singleUser;
 298         }
 299
 300         public final static Oid KERBEROS_OID;
 301         static {
 302                 try {
 303                         KERBEROS_OID = new Oid("1.3.6.1.5.5.2");
 304                 } catch (GSSException e) {
 305                         throw new IllegalStateException("Cannot create Kerberos OID", e);
 306                 }
 307         }
 308
 309 }