Make CMS sesison management more robust.
[lgpl/argeo-commons.git] / org.argeo.cms / src / org / argeo / cms / auth / CmsAuthUtils.java
index 760544b8189f38b57154976726f034cc51619af4..f5503d5c5d74185b4dfbb18b2c2c102efdd8a08e 100644 (file)
@@ -2,7 +2,9 @@ package org.argeo.cms.auth;
 
 import java.security.Principal;
 import java.util.Collection;
+import java.util.Locale;
 import java.util.Set;
+import java.util.UUID;
 
 import javax.naming.InvalidNameException;
 import javax.naming.ldap.LdapName;
@@ -11,36 +13,38 @@ import javax.security.auth.x500.X500Principal;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpSession;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-//import org.apache.jackrabbit.core.security.AnonymousPrincipal;
-//import org.apache.jackrabbit.core.security.SecurityConstants;
-//import org.apache.jackrabbit.core.security.principal.AdminPrincipal;
-import org.argeo.cms.CmsException;
+import org.argeo.api.NodeConstants;
+import org.argeo.api.security.AnonymousPrincipal;
+import org.argeo.api.security.DataAdminPrincipal;
+import org.argeo.api.security.NodeSecurityUtils;
+import org.argeo.cms.internal.auth.CmsSessionImpl;
 import org.argeo.cms.internal.auth.ImpliedByPrincipal;
-import org.argeo.cms.internal.kernel.WebCmsSessionImpl;
-import org.argeo.node.security.AnonymousPrincipal;
-import org.argeo.node.security.DataAdminPrincipal;
-import org.argeo.node.security.NodeSecurityUtils;
+import org.argeo.cms.internal.http.WebCmsSessionImpl;
+import org.argeo.cms.internal.kernel.Activator;
+import org.argeo.osgi.useradmin.AuthenticatingUser;
 import org.osgi.framework.BundleContext;
 import org.osgi.framework.InvalidSyntaxException;
 import org.osgi.framework.ServiceReference;
 import org.osgi.service.http.HttpContext;
 import org.osgi.service.useradmin.Authorization;
 
+/** Centrlaises security related registrations. */
 class CmsAuthUtils {
-       private final static Log log = LogFactory.getLog(CmsAuthUtils.class);
-
-       /** Shared HTTP request */
-       static final String SHARED_STATE_HTTP_REQUEST = "org.argeo.cms.auth.http.request";
-       /** From org.osgi.service.http.HttpContext */
-       static final String SHARED_STATE_AUTHORIZATION = "org.osgi.service.useradmin.authorization";
-       /** From com.sun.security.auth.module.*LoginModule */
-       static final String SHARED_STATE_NAME = "javax.security.auth.login.name";
-       /** From com.sun.security.auth.module.*LoginModule */
-       static final String SHARED_STATE_PWD = "javax.security.auth.login.password";
-
-       static void addAuthentication(Subject subject, Authorization authorization) {
+       // Standard
+       final static String SHARED_STATE_NAME = AuthenticatingUser.SHARED_STATE_NAME;
+       final static String SHARED_STATE_PWD = AuthenticatingUser.SHARED_STATE_PWD;
+       final static String HEADER_AUTHORIZATION = "Authorization";
+       final static String HEADER_WWW_AUTHENTICATE = "WWW-Authenticate";
+
+       // Argeo specific
+       final static String SHARED_STATE_HTTP_REQUEST = "org.argeo.cms.auth.http.request";
+       final static String SHARED_STATE_SPNEGO_TOKEN = "org.argeo.cms.auth.spnegoToken";
+       final static String SHARED_STATE_SPNEGO_OUT_TOKEN = "org.argeo.cms.auth.spnegoOutToken";
+       final static String SHARED_STATE_CERTIFICATE_CHAIN = "org.argeo.cms.auth.certificateChain";
+       final static String SHARED_STATE_REMOTE_ADDR = "org.argeo.cms.auth.remote.addr";
+       final static String SHARED_STATE_REMOTE_PORT = "org.argeo.cms.auth.remote.port";
+
+       static void addAuthorization(Subject subject, Authorization authorization) {
                assert subject != null;
                checkSubjectEmpty(subject);
                assert authorization != null;
@@ -48,6 +52,10 @@ class CmsAuthUtils {
                // required for display name:
                subject.getPrivateCredentials().add(authorization);
 
+               if (Activator.isSingleUser()) {
+                       subject.getPrincipals().add(new DataAdminPrincipal());
+               }
+
                Set<Principal> principals = subject.getPrincipals();
                try {
                        String authName = authorization.getName();
@@ -59,13 +67,15 @@ class CmsAuthUtils {
                                name = NodeSecurityUtils.ROLE_ANONYMOUS_NAME;
                                userPrincipal = new AnonymousPrincipal();
                                principals.add(userPrincipal);
-                               // principals.add(new AnonymousPrincipal());
                        } else {
                                name = new LdapName(authName);
                                NodeSecurityUtils.checkUserName(name);
                                userPrincipal = new X500Principal(name.toString());
                                principals.add(userPrincipal);
-                               principals.add(new ImpliedByPrincipal(NodeSecurityUtils.ROLE_USER_NAME, userPrincipal));
+
+                               if (Activator.isSingleUser()) {
+                                       principals.add(new ImpliedByPrincipal(NodeSecurityUtils.ROLE_ADMIN_NAME, userPrincipal));
+                               }
                        }
 
                        // Add roles provided by authorization
@@ -73,6 +83,8 @@ class CmsAuthUtils {
                                LdapName roleName = new LdapName(role);
                                if (roleName.equals(name)) {
                                        // skip
+                               } else if (roleName.equals(NodeSecurityUtils.ROLE_ANONYMOUS_NAME)) {
+                                       // skip
                                } else {
                                        NodeSecurityUtils.checkImpliedPrincipalName(roleName);
                                        principals.add(new ImpliedByPrincipal(roleName.toString(), userPrincipal));
@@ -82,7 +94,7 @@ class CmsAuthUtils {
                        }
 
                } catch (InvalidNameException e) {
-                       throw new CmsException("Cannot commit", e);
+                       throw new IllegalArgumentException("Cannot commit", e);
                }
        }
 
@@ -101,95 +113,109 @@ class CmsAuthUtils {
                // Argeo
                subject.getPrincipals().removeAll(subject.getPrincipals(X500Principal.class));
                subject.getPrincipals().removeAll(subject.getPrincipals(ImpliedByPrincipal.class));
+               subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
+               subject.getPrincipals().removeAll(subject.getPrincipals(DataAdminPrincipal.class));
+
+               subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(CmsSessionId.class));
+               subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(Authorization.class));
                // Jackrabbit
                // subject.getPrincipals().removeAll(subject.getPrincipals(AdminPrincipal.class));
                // subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
        }
 
-       // SHARED STATE KEYS
-       // compatible with com.sun.security.auth.module.*LoginModule
-       // public static final String SHARED_STATE_USERNAME =
-       // "javax.security.auth.login.name";
-       // public static final String SHARED_STATE_PASSWORD =
-       // "javax.security.auth.login.password";
-
-       static void registerSessionAuthorization(BundleContext bc, HttpServletRequest request, Subject subject,
-                       Authorization authorization) {
-               String httpSessId = request.getSession().getId();
-               if (authorization.getName() != null) {
-                       request.setAttribute(HttpContext.REMOTE_USER, authorization.getName());
+       @SuppressWarnings("unused")
+       synchronized static void registerSessionAuthorization(HttpServletRequest request, Subject subject,
+                       Authorization authorization, Locale locale) {
+               // synchronized in order to avoid multiple registrations
+               // TODO move it to a service in order to avoid static synchronization
+               if (request != null) {
+                       HttpSession httpSession = request.getSession(false);
+                       assert httpSession != null;
+                       String httpSessId = httpSession.getId();
+                       boolean anonymous = authorization.getName() == null;
+                       String remoteUser = !anonymous ? authorization.getName() : NodeConstants.ROLE_ANONYMOUS;
+                       request.setAttribute(HttpContext.REMOTE_USER, remoteUser);
                        request.setAttribute(HttpContext.AUTHORIZATION, authorization);
 
-                       HttpSession httpSession = request.getSession();
-                       if (httpSession.getAttribute(HttpContext.AUTHORIZATION) == null) {
-
-                               Collection<ServiceReference<WebCmsSession>> sr;
-                               try {
-                                       sr = bc.getServiceReferences(WebCmsSession.class,
-                                                       "(" + WebCmsSession.CMS_SESSION_ID + "=" + httpSessId + ")");
-                               } catch (InvalidSyntaxException e) {
-                                       throw new CmsException("Cannot get CMS session for id " + httpSessId, e);
+                       CmsSessionImpl cmsSession;
+                       CmsSessionImpl currentLocalSession = CmsSessionImpl.getByLocalId(httpSessId);
+                       if (currentLocalSession != null) {
+                               boolean currentLocalSessionAnonymous = currentLocalSession.getAuthorization().getName() == null;
+                               if (!anonymous) {
+                                       if (currentLocalSessionAnonymous) {
+                                               currentLocalSession.close();
+                                               // new CMS session
+                                               cmsSession = new WebCmsSessionImpl(subject, authorization, locale, request);
+                                       } else if (!authorization.getName().equals(currentLocalSession.getAuthorization().getName())) {
+                                               throw new IllegalStateException("Inconsistent user " + authorization.getName()
+                                                               + " for existing CMS session " + currentLocalSession);
+                                       } else {
+                                               // keep current session
+                                               cmsSession = currentLocalSession;
+                                               // keyring
+                                               subject.getPrivateCredentials().addAll(cmsSession.getSecretKeys());
+                                       }
+                               } else {// anonymous
+                                       if (!currentLocalSessionAnonymous) {
+                                               currentLocalSession.close();
+                                               throw new IllegalStateException(
+                                                               "Existing CMS session " + currentLocalSession + " was not logged out properly.");
+                                       }
+                                       // keep current session
+                                       cmsSession = currentLocalSession;
                                }
-                               ServiceReference<WebCmsSession> cmsSessionRef;
-                               if (sr.size() == 1) {
-                                       cmsSessionRef = sr.iterator().next();
-                               } else if (sr.size() == 0) {
-                                       WebCmsSessionImpl cmsSessionImpl = new WebCmsSessionImpl(httpSessId, authorization);
-                                       cmsSessionRef = cmsSessionImpl.getServiceRegistration().getReference();
-                                       if (log.isDebugEnabled())
-                                               log.debug("Initialized " + cmsSessionImpl + " for " + authorization.getName());
-                               } else
-                                       throw new CmsException(sr.size() + " CMS sessions registered for " + httpSessId);
-
-                               WebCmsSessionImpl cmsSession = (WebCmsSessionImpl) bc.getService(cmsSessionRef);
-                               cmsSession.addHttpSession(request);
-                               if (log.isTraceEnabled())
-                                       log.trace("Added " + request.getServletPath() + " to " + cmsSession + " (" + request.getRequestURI()
-                                                       + ")");
-                               // httpSession.setAttribute(HttpContext.REMOTE_USER,
-                               // authorization.getName());
-                               // httpSession.setAttribute(HttpContext.AUTHORIZATION,
-                               // authorization);
+                       } else {
+                               // new CMS session
+                               cmsSession = new WebCmsSessionImpl(subject, authorization, locale, request);
                        }
-               }
-               HttpSessionId httpSessionId = new HttpSessionId(httpSessId);
-               if (subject.getPrivateCredentials(HttpSessionId.class).size() == 0)
-                       subject.getPrivateCredentials().add(httpSessionId);
-               else {
-                       String storedSessionId = subject.getPrivateCredentials(HttpSessionId.class).iterator().next().getValue();
-                       // if (storedSessionId.equals(httpSessionId.getValue()))
-                       throw new CmsException(
-                                       "Subject already logged with session " + storedSessionId + " (not " + httpSessionId + ")");
+
+                       if (cmsSession == null)// should be dead code (cf. SuppressWarning of the method)
+                               throw new IllegalStateException("CMS session cannot be null");
+
+                       CmsSessionId nodeSessionId = new CmsSessionId(cmsSession.getUuid());
+                       if (subject.getPrivateCredentials(CmsSessionId.class).size() == 0) {
+                               subject.getPrivateCredentials().add(nodeSessionId);
+                       } else {
+                               UUID storedSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next().getUuid();
+                               // if (storedSessionId.equals(httpSessionId.getValue()))
+                               throw new IllegalStateException(
+                                               "Subject already logged with session " + storedSessionId + " (not " + nodeSessionId + ")");
+                       }
+               } else {
+                       // TODO desktop, CLI
                }
        }
 
-       static boolean logoutSession(BundleContext bc, Subject subject) {
-               String httpSessionId;
-               if (subject.getPrivateCredentials(HttpSessionId.class).size() == 1)
-                       httpSessionId = subject.getPrivateCredentials(HttpSessionId.class).iterator().next().getValue();
-               else
-                       return false;
-               Collection<ServiceReference<WebCmsSession>> srs;
+       public static CmsSession cmsSessionFromHttpSession(BundleContext bc, String httpSessionId) {
+               Authorization authorization = null;
+               Collection<ServiceReference<CmsSession>> sr;
                try {
-                       srs = bc.getServiceReferences(WebCmsSession.class,
-                                       "(" + WebCmsSession.CMS_SESSION_ID + "=" + httpSessionId + ")");
+                       sr = bc.getServiceReferences(CmsSession.class,
+                                       "(" + CmsSession.SESSION_LOCAL_ID + "=" + httpSessionId + ")");
                } catch (InvalidSyntaxException e) {
-                       throw new CmsException("Cannot retrieve CMS session #" + httpSessionId, e);
+                       throw new IllegalArgumentException("Cannot get CMS session for id " + httpSessionId, e);
                }
+               CmsSession cmsSession;
+               if (sr.size() == 1) {
+                       cmsSession = bc.getService(sr.iterator().next());
+//                     locale = cmsSession.getLocale();
+                       authorization = cmsSession.getAuthorization();
+                       if (authorization.getName() == null)
+                               return null;// anonymous is not sufficient
+               } else if (sr.size() == 0)
+                       return null;
+               else
+                       throw new IllegalStateException(sr.size() + ">1 web sessions detected for http session " + httpSessionId);
+               return cmsSession;
+       }
 
-               if (srs.size() == 0) {
-                       if (log.isTraceEnabled())
-                               log.warn("No CMS web session found for http session " + httpSessionId);
-                       return false;
-               } else if (srs.size() > 1)
-                       throw new CmsException(srs.size() + " CMS web sessions found for http session " + httpSessionId);
-
-               WebCmsSessionImpl cmsSession = (WebCmsSessionImpl) bc.getService(srs.iterator().next());
-               cmsSession.cleanUp();
-               subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(HttpSessionId.class));
-               if (log.isDebugEnabled())
-                       log.debug("Cleaned up " + cmsSession);
-               return true;
+       public static <T extends Principal> T getSinglePrincipal(Subject subject, Class<T> clss) {
+               Set<T> principals = subject.getPrincipals(clss);
+               if (principals.isEmpty())
+                       return null;
+               if (principals.size() > 1)
+                       throw new IllegalStateException("Only one " + clss + " principal expected in " + subject);
+               return principals.iterator().next();
        }
 
        private CmsAuthUtils() {