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.Locale;
   6 import java.util.Set;
   7 import java.util.UUID;
   8
   9 import javax.naming.InvalidNameException;
  10 import javax.naming.ldap.LdapName;
  11 import javax.security.auth.Subject;
  12 import javax.security.auth.x500.X500Principal;
  13 import javax.servlet.http.HttpServletRequest;
  14 import javax.servlet.http.HttpSession;
  15
  16 import org.argeo.api.NodeConstants;
  17 import org.argeo.api.security.AnonymousPrincipal;
  18 import org.argeo.api.security.DataAdminPrincipal;
  19 import org.argeo.api.security.NodeSecurityUtils;
  20 import org.argeo.cms.internal.auth.CmsSessionImpl;
  21 import org.argeo.cms.internal.auth.ImpliedByPrincipal;
  22 import org.argeo.cms.internal.http.WebCmsSessionImpl;
  23 import org.argeo.cms.internal.kernel.Activator;
  24 import org.argeo.osgi.useradmin.AuthenticatingUser;
  25 import org.osgi.framework.BundleContext;
  26 import org.osgi.framework.InvalidSyntaxException;
  27 import org.osgi.framework.ServiceReference;
  28 import org.osgi.service.http.HttpContext;
  29 import org.osgi.service.useradmin.Authorization;
  30
  31 /** Centrlaises security related registrations. */
  32 class CmsAuthUtils {
  33         // Standard
  34         final static String SHARED_STATE_NAME = AuthenticatingUser.SHARED_STATE_NAME;
  35         final static String SHARED_STATE_PWD = AuthenticatingUser.SHARED_STATE_PWD;
  36         final static String HEADER_AUTHORIZATION = "Authorization";
  37         final static String HEADER_WWW_AUTHENTICATE = "WWW-Authenticate";
  38
  39         // Argeo specific
  40         final static String SHARED_STATE_HTTP_REQUEST = "org.argeo.cms.auth.http.request";
  41         final static String SHARED_STATE_SPNEGO_TOKEN = "org.argeo.cms.auth.spnegoToken";
  42         final static String SHARED_STATE_SPNEGO_OUT_TOKEN = "org.argeo.cms.auth.spnegoOutToken";
  43         final static String SHARED_STATE_CERTIFICATE_CHAIN = "org.argeo.cms.auth.certificateChain";
  44         final static String SHARED_STATE_REMOTE_ADDR = "org.argeo.cms.auth.remote.addr";
  45         final static String SHARED_STATE_REMOTE_PORT = "org.argeo.cms.auth.remote.port";
  46
  47         static void addAuthorization(Subject subject, Authorization authorization) {
  48                 assert subject != null;
  49                 checkSubjectEmpty(subject);
  50                 assert authorization != null;
  51
  52                 // required for display name:
  53                 subject.getPrivateCredentials().add(authorization);
  54
  55                 if (Activator.isSingleUser()) {
  56                         subject.getPrincipals().add(new DataAdminPrincipal());
  57                 }
  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                         } else {
  71                                 name = new LdapName(authName);
  72                                 NodeSecurityUtils.checkUserName(name);
  73                                 userPrincipal = new X500Principal(name.toString());
  74                                 principals.add(userPrincipal);
  75
  76                                 if (Activator.isSingleUser()) {
  77                                         principals.add(new ImpliedByPrincipal(NodeSecurityUtils.ROLE_ADMIN_NAME, userPrincipal));
  78                                 }
  79                         }
  80
  81                         // Add roles provided by authorization
  82                         for (String role : authorization.getRoles()) {
  83                                 LdapName roleName = new LdapName(role);
  84                                 if (roleName.equals(name)) {
  85                                         // skip
  86                                 } else if (roleName.equals(NodeSecurityUtils.ROLE_ANONYMOUS_NAME)) {
  87                                         // skip
  88                                 } else {
  89                                         NodeSecurityUtils.checkImpliedPrincipalName(roleName);
  90                                         principals.add(new ImpliedByPrincipal(roleName.toString(), userPrincipal));
  91                                         if (roleName.equals(NodeSecurityUtils.ROLE_ADMIN_NAME))
  92                                                 principals.add(new DataAdminPrincipal());
  93                                 }
  94                         }
  95
  96                 } catch (InvalidNameException e) {
  97                         throw new IllegalArgumentException("Cannot commit", e);
  98                 }
  99         }
 100
 101         private static void checkSubjectEmpty(Subject subject) {
 102                 if (!subject.getPrincipals(AnonymousPrincipal.class).isEmpty())
 103                         throw new IllegalStateException("Already logged in as anonymous: " + subject);
 104                 if (!subject.getPrincipals(X500Principal.class).isEmpty())
 105                         throw new IllegalStateException("Already logged in as user: " + subject);
 106                 if (!subject.getPrincipals(DataAdminPrincipal.class).isEmpty())
 107                         throw new IllegalStateException("Already logged in as data admin: " + subject);
 108                 if (!subject.getPrincipals(ImpliedByPrincipal.class).isEmpty())
 109                         throw new IllegalStateException("Already authorized: " + subject);
 110         }
 111
 112         static void cleanUp(Subject subject) {
 113                 // Argeo
 114                 subject.getPrincipals().removeAll(subject.getPrincipals(X500Principal.class));
 115                 subject.getPrincipals().removeAll(subject.getPrincipals(ImpliedByPrincipal.class));
 116                 subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
 117                 subject.getPrincipals().removeAll(subject.getPrincipals(DataAdminPrincipal.class));
 118
 119                 subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(CmsSessionId.class));
 120                 subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(Authorization.class));
 121                 // Jackrabbit
 122                 // subject.getPrincipals().removeAll(subject.getPrincipals(AdminPrincipal.class));
 123                 // subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
 124         }
 125
 126         synchronized static void registerSessionAuthorization(HttpServletRequest request, Subject subject,
 127                         Authorization authorization, Locale locale) {
 128                 // synchronized in order to avoid multiple registrations
 129                 // TODO move it to a service in order to avoid static synchronization
 130                 if (request != null) {
 131                         HttpSession httpSession = request.getSession(false);
 132                         assert httpSession != null;
 133                         String httpSessId = httpSession.getId();
 134                         String remoteUser = authorization.getName() != null ? authorization.getName()
 135                                         : NodeConstants.ROLE_ANONYMOUS;
 136                         request.setAttribute(HttpContext.REMOTE_USER, remoteUser);
 137                         request.setAttribute(HttpContext.AUTHORIZATION, authorization);
 138
 139                         CmsSessionImpl cmsSession = CmsSessionImpl.getByLocalId(httpSessId);
 140                         if (cmsSession != null) {
 141                                 if (authorization.getName() != null) {
 142                                         if (cmsSession.getAuthorization().getName() == null) {
 143                                                 cmsSession.close();
 144                                                 cmsSession = null;
 145                                         } else if (!authorization.getName().equals(cmsSession.getAuthorization().getName())) {
 146                                                 throw new IllegalStateException("Inconsistent user " + authorization.getName()
 147                                                                 + " for existing CMS session " + cmsSession);
 148                                         }
 149                                         // keyring
 150                                         if (cmsSession != null)
 151                                                 subject.getPrivateCredentials().addAll(cmsSession.getSecretKeys());
 152                                 } else {// anonymous
 153                                         if (cmsSession.getAuthorization().getName() != null) {
 154                                                 cmsSession.close();
 155                                                 // TODO rather throw an exception ? log a warning ?
 156                                                 cmsSession = null;
 157                                         }
 158                                 }
 159                         } else if (cmsSession == null) {
 160                                 cmsSession = new WebCmsSessionImpl(subject, authorization, locale, request);
 161                         }
 162                         // request.setAttribute(CmsSession.class.getName(), cmsSession);
 163                         if (cmsSession != null) {
 164                                 CmsSessionId nodeSessionId = new CmsSessionId(cmsSession.getUuid());
 165                                 if (subject.getPrivateCredentials(CmsSessionId.class).size() == 0)
 166                                         subject.getPrivateCredentials().add(nodeSessionId);
 167                                 else {
 168                                         UUID storedSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next()
 169                                                         .getUuid();
 170                                         // if (storedSessionId.equals(httpSessionId.getValue()))
 171                                         throw new IllegalStateException(
 172                                                         "Subject already logged with session " + storedSessionId + " (not " + nodeSessionId + ")");
 173                                 }
 174                         }
 175                 } else {
 176                         // TODO desktop, CLI
 177                 }
 178         }
 179
 180         public static CmsSession cmsSessionFromHttpSession(BundleContext bc, String httpSessionId) {
 181                 Authorization authorization = null;
 182                 Collection<ServiceReference<CmsSession>> sr;
 183                 try {
 184                         sr = bc.getServiceReferences(CmsSession.class,
 185                                         "(" + CmsSession.SESSION_LOCAL_ID + "=" + httpSessionId + ")");
 186                 } catch (InvalidSyntaxException e) {
 187                         throw new IllegalArgumentException("Cannot get CMS session for id " + httpSessionId, e);
 188                 }
 189                 CmsSession cmsSession;
 190                 if (sr.size() == 1) {
 191                         cmsSession = bc.getService(sr.iterator().next());
 192 //                      locale = cmsSession.getLocale();
 193                         authorization = cmsSession.getAuthorization();
 194                         if (authorization.getName() == null)
 195                                 return null;// anonymous is not sufficient
 196                 } else if (sr.size() == 0)
 197                         return null;
 198                 else
 199                         throw new IllegalStateException(sr.size() + ">1 web sessions detected for http session " + httpSessionId);
 200                 return cmsSession;
 201         }
 202
 203         public static <T extends Principal> T getSinglePrincipal(Subject subject, Class<T> clss) {
 204                 Set<T> principals = subject.getPrincipals(clss);
 205                 if (principals.isEmpty())
 206                         return null;
 207                 if (principals.size() > 1)
 208                         throw new IllegalStateException("Only one " + clss + " principal expected in " + subject);
 209                 return principals.iterator().next();
 210         }
 211
 212         private CmsAuthUtils() {
 213
 214         }
 215
 216 }