org.argeo.cms/src/org/argeo/cms/auth/CmsAuthUtils.java

   1 package org.argeo.cms.auth;
   2
   3 import java.security.Principal;
   4 import java.util.Collection;
   5 import java.util.Set;
   6 import java.util.UUID;
   7
   8 import javax.naming.InvalidNameException;
   9 import javax.naming.ldap.LdapName;
  10 import javax.security.auth.Subject;
  11 import javax.security.auth.x500.X500Principal;
  12 import javax.servlet.http.HttpServletRequest;
  13 import javax.servlet.http.HttpSession;
  14
  15 import org.apache.commons.logging.Log;
  16 import org.apache.commons.logging.LogFactory;
  17 //import org.apache.jackrabbit.core.security.AnonymousPrincipal;
  18 //import org.apache.jackrabbit.core.security.SecurityConstants;
  19 //import org.apache.jackrabbit.core.security.principal.AdminPrincipal;
  20 import org.argeo.cms.CmsException;
  21 import org.argeo.cms.internal.auth.CmsSessionImpl;
  22 import org.argeo.cms.internal.auth.ImpliedByPrincipal;
  23 import org.argeo.cms.internal.http.WebCmsSessionImpl;
  24 import org.argeo.node.security.AnonymousPrincipal;
  25 import org.argeo.node.security.DataAdminPrincipal;
  26 import org.argeo.node.security.NodeSecurityUtils;
  27 import org.osgi.framework.BundleContext;
  28 import org.osgi.framework.InvalidSyntaxException;
  29 import org.osgi.framework.ServiceReference;
  30 import org.osgi.service.http.HttpContext;
  31 import org.osgi.service.useradmin.Authorization;
  32
  33 class CmsAuthUtils {
  34         private final static Log log = LogFactory.getLog(CmsAuthUtils.class);
  35
  36         /** Shared HTTP request */
  37         final static String SHARED_STATE_HTTP_REQUEST = "org.argeo.cms.auth.http.request";
  38         /** From org.osgi.service.http.HttpContext */
  39         final static String SHARED_STATE_AUTHORIZATION = "org.osgi.service.useradmin.authorization";
  40         /** From com.sun.security.auth.module.*LoginModule */
  41         final static String SHARED_STATE_NAME = "javax.security.auth.login.name";
  42         /** From com.sun.security.auth.module.*LoginModule */
  43         final static String SHARED_STATE_PWD = "javax.security.auth.login.password";
  44
  45         final static String SHARED_STATE_SPNEGO_TOKEN = "org.argeo.cms.auth.spnegoToken";
  46         final static String SHARED_STATE_SPNEGO_OUT_TOKEN = "org.argeo.cms.auth.spnegoOutToken";
  47
  48         final static String HEADER_AUTHORIZATION = "Authorization";
  49         final static String HEADER_WWW_AUTHENTICATE = "WWW-Authenticate";
  50
  51         static void addAuthorization(Subject subject, Authorization authorization, HttpServletRequest request) {
  52                 assert subject != null;
  53                 checkSubjectEmpty(subject);
  54                 assert authorization != null;
  55
  56                 // required for display name:
  57                 subject.getPrivateCredentials().add(authorization);
  58
  59                 Set<Principal> principals = subject.getPrincipals();
  60                 try {
  61                         String authName = authorization.getName();
  62
  63                         // determine user's principal
  64                         final LdapName name;
  65                         final Principal userPrincipal;
  66                         if (authName == null) {
  67                                 name = NodeSecurityUtils.ROLE_ANONYMOUS_NAME;
  68                                 userPrincipal = new AnonymousPrincipal();
  69                                 principals.add(userPrincipal);
  70                                 // principals.add(new AnonymousPrincipal());
  71                         } else {
  72                                 name = new LdapName(authName);
  73                                 NodeSecurityUtils.checkUserName(name);
  74                                 userPrincipal = new X500Principal(name.toString());
  75                                 principals.add(userPrincipal);
  76                                 principals.add(new ImpliedByPrincipal(NodeSecurityUtils.ROLE_USER_NAME, userPrincipal));
  77                         }
  78
  79                         // Add roles provided by authorization
  80                         for (String role : authorization.getRoles()) {
  81                                 LdapName roleName = new LdapName(role);
  82                                 if (roleName.equals(name)) {
  83                                         // skip
  84                                 } else {
  85                                         NodeSecurityUtils.checkImpliedPrincipalName(roleName);
  86                                         principals.add(new ImpliedByPrincipal(roleName.toString(), userPrincipal));
  87                                         if (roleName.equals(NodeSecurityUtils.ROLE_ADMIN_NAME))
  88                                                 principals.add(new DataAdminPrincipal());
  89                                 }
  90                         }
  91
  92                 } catch (InvalidNameException e) {
  93                         throw new CmsException("Cannot commit", e);
  94                 }
  95
  96                 registerSessionAuthorization(request, subject, authorization);
  97         }
  98
  99         private static void checkSubjectEmpty(Subject subject) {
 100                 if (!subject.getPrincipals(AnonymousPrincipal.class).isEmpty())
 101                         throw new IllegalStateException("Already logged in as anonymous: " + subject);
 102                 if (!subject.getPrincipals(X500Principal.class).isEmpty())
 103                         throw new IllegalStateException("Already logged in as user: " + subject);
 104                 if (!subject.getPrincipals(DataAdminPrincipal.class).isEmpty())
 105                         throw new IllegalStateException("Already logged in as data admin: " + subject);
 106                 if (!subject.getPrincipals(ImpliedByPrincipal.class).isEmpty())
 107                         throw new IllegalStateException("Already authorized: " + subject);
 108         }
 109
 110         static void cleanUp(Subject subject) {
 111                 // Argeo
 112                 subject.getPrincipals().removeAll(subject.getPrincipals(X500Principal.class));
 113                 subject.getPrincipals().removeAll(subject.getPrincipals(ImpliedByPrincipal.class));
 114                 // Jackrabbit
 115                 // subject.getPrincipals().removeAll(subject.getPrincipals(AdminPrincipal.class));
 116                 // subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
 117         }
 118
 119         // SHARED STATE KEYS
 120         // compatible with com.sun.security.auth.module.*LoginModule
 121         // public static final String SHARED_STATE_USERNAME =
 122         // "javax.security.auth.login.name";
 123         // public static final String SHARED_STATE_PASSWORD =
 124         // "javax.security.auth.login.password";
 125
 126         private static void registerSessionAuthorization(HttpServletRequest request, Subject subject,
 127                         Authorization authorization) {
 128                 if (request != null) {
 129                         HttpSession httpSession = request.getSession();
 130                         String httpSessId = httpSession.getId();
 131                         if (authorization.getName() != null) {
 132                                 request.setAttribute(HttpContext.REMOTE_USER, authorization.getName());
 133                                 request.setAttribute(HttpContext.AUTHORIZATION, authorization);
 134
 135                                 CmsSession cmsSession = CmsSessionImpl.getByLocalId(httpSessId);
 136                                 if (cmsSession == null)
 137                                         cmsSession = new WebCmsSessionImpl(subject, authorization, httpSessId);
 138                                 request.setAttribute(CmsSession.class.getName(), cmsSession);
 139                                 CmsSessionId nodeSessionId = new CmsSessionId(cmsSession.getUuid());
 140                                 if (subject.getPrivateCredentials(CmsSessionId.class).size() == 0)
 141                                         subject.getPrivateCredentials().add(nodeSessionId);
 142                                 else {
 143                                         UUID storedSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next()
 144                                                         .getUuid();
 145                                         // if (storedSessionId.equals(httpSessionId.getValue()))
 146                                         throw new CmsException(
 147                                                         "Subject already logged with session " + storedSessionId + " (not " + nodeSessionId + ")");
 148                                 }
 149                         }
 150                 } else {
 151                         // TODO desktop, CLI
 152                 }
 153         }
 154
 155         static boolean logoutSession(BundleContext bc, Subject subject) {
 156                 UUID nodeSessionId;
 157                 if (subject.getPrivateCredentials(CmsSessionId.class).size() == 1)
 158                         nodeSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next().getUuid();
 159                 else
 160                         return false;
 161                 Collection<ServiceReference<CmsSession>> srs;
 162                 try {
 163                         srs = bc.getServiceReferences(CmsSession.class, "(" + CmsSession.SESSION_UUID + "=" + nodeSessionId + ")");
 164                 } catch (InvalidSyntaxException e) {
 165                         throw new CmsException("Cannot retrieve CMS session #" + nodeSessionId, e);
 166                 }
 167
 168                 if (srs.size() == 0) {
 169                         if (log.isTraceEnabled())
 170                                 log.warn("No CMS web session found for http session " + nodeSessionId);
 171                         return false;
 172                 } else if (srs.size() > 1)
 173                         throw new CmsException(srs.size() + " CMS web sessions found for http session " + nodeSessionId);
 174
 175                 WebCmsSessionImpl cmsSession = (WebCmsSessionImpl) bc.getService(srs.iterator().next());
 176                 cmsSession.cleanUp();
 177                 subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(CmsSessionId.class));
 178                 if (log.isDebugEnabled())
 179                         log.debug("Cleaned up " + cmsSession);
 180                 return true;
 181         }
 182
 183         public static <T extends Principal> T getSinglePrincipal(Subject subject, Class<T> clss) {
 184                 Set<T> principals = subject.getPrincipals(clss);
 185                 if (principals.isEmpty())
 186                         return null;
 187                 if (principals.size() > 1)
 188                         throw new IllegalStateException("Only one " + clss + " principal expected in " + subject);
 189                 return principals.iterator().next();
 190         }
 191
 192         private CmsAuthUtils() {
 193
 194         }
 195
 196 }