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

   1 package org.argeo.cms.auth;
   2
   3 import static org.argeo.api.cms.CmsConstants.ROLE_ADMIN;
   4 import static org.argeo.api.cms.CmsConstants.ROLE_ANONYMOUS;
   5 import static org.argeo.api.cms.CmsConstants.ROLE_USER;
   6 import static org.argeo.api.cms.CmsConstants.ROLE_USER_ADMIN;
   7
   8 import java.security.Principal;
   9 import java.util.Arrays;
  10 import java.util.Collections;
  11 import java.util.List;
  12 import java.util.Locale;
  13 import java.util.Set;
  14 import java.util.UUID;
  15
  16 //import javax.naming.InvalidNameException;
  17 //import javax.naming.ldap.LdapName;
  18 import javax.security.auth.Subject;
  19 import javax.security.auth.x500.X500Principal;
  20
  21 import org.argeo.api.cms.AnonymousPrincipal;
  22 import org.argeo.api.cms.CmsConstants;
  23 import org.argeo.api.cms.CmsSessionId;
  24 import org.argeo.api.cms.DataAdminPrincipal;
  25 import org.argeo.cms.internal.auth.CmsSessionImpl;
  26 import org.argeo.cms.internal.auth.ImpliedByPrincipal;
  27 import org.argeo.cms.internal.http.WebCmsSessionImpl;
  28 import org.argeo.cms.internal.runtime.CmsContextImpl;
  29 import org.argeo.osgi.useradmin.AuthenticatingUser;
  30 import org.osgi.service.useradmin.Authorization;
  31
  32 /** Centralises security related registrations. */
  33 class CmsAuthUtils {
  34         // Standard
  35         final static String SHARED_STATE_NAME = AuthenticatingUser.SHARED_STATE_NAME;
  36         final static String SHARED_STATE_PWD = AuthenticatingUser.SHARED_STATE_PWD;
  37         final static String HEADER_AUTHORIZATION = "Authorization";
  38         final static String HEADER_WWW_AUTHENTICATE = "WWW-Authenticate";
  39
  40         // Argeo specific
  41         final static String SHARED_STATE_HTTP_REQUEST = "org.argeo.cms.auth.http.request";
  42         final static String SHARED_STATE_SPNEGO_TOKEN = "org.argeo.cms.auth.spnegoToken";
  43         final static String SHARED_STATE_SPNEGO_OUT_TOKEN = "org.argeo.cms.auth.spnegoOutToken";
  44         final static String SHARED_STATE_CERTIFICATE_CHAIN = "org.argeo.cms.auth.certificateChain";
  45         final static String SHARED_STATE_REMOTE_ADDR = "org.argeo.cms.auth.remote.addr";
  46         final static String SHARED_STATE_REMOTE_PORT = "org.argeo.cms.auth.remote.port";
  47
  48         final static String SINGLE_USER_LOCAL_ID = "single-user";
  49
  50         private final static List<String> RESERVED_ROLES = Collections
  51                         .unmodifiableList(Arrays.asList(new String[] { ROLE_ADMIN, ROLE_ANONYMOUS, ROLE_USER, ROLE_USER_ADMIN }));
  52
  53         static void addAuthorization(Subject subject, Authorization authorization) {
  54                 assert subject != null;
  55                 checkSubjectEmpty(subject);
  56                 assert authorization != null;
  57
  58                 // required for display name:
  59                 subject.getPrivateCredentials().add(authorization);
  60
  61                 boolean singleUser = authorization instanceof SingleUserAuthorization;
  62
  63                 Set<Principal> principals = subject.getPrincipals();
  64 //              try {
  65                 String authName = authorization.getName();
  66
  67                 // determine user's principal
  68 //                      final LdapName name;
  69                 final Principal userPrincipal;
  70                 if (authName == null) {
  71 //                              name = NodeSecurityUtils.ROLE_ANONYMOUS_NAME;
  72                         userPrincipal = new AnonymousPrincipal();
  73                         principals.add(userPrincipal);
  74                 } else {
  75 //                              name = new LdapName(authName);
  76                         checkUserName(authName);
  77                         userPrincipal = new X500Principal(authName.toString());
  78                         principals.add(userPrincipal);
  79
  80                         if (singleUser) {
  81                                 principals.add(new ImpliedByPrincipal(CmsConstants.ROLE_ADMIN, userPrincipal));
  82                                 principals.add(new DataAdminPrincipal());
  83                         }
  84                 }
  85
  86                 // Add roles provided by authorization
  87                 for (String role : authorization.getRoles()) {
  88 //                              LdapName roleName = new LdapName(role);
  89                         if (role.equals(authName)) {
  90                                 // skip
  91                         } else if (role.equals(CmsConstants.ROLE_ANONYMOUS)) {
  92                                 // skip
  93                         } else {
  94 //                                      NodeSecurityUtils.checkImpliedPrincipalName(role);
  95                                 principals.add(new ImpliedByPrincipal(role, userPrincipal));
  96                                 if (role.equals(CmsConstants.ROLE_ADMIN))
  97                                         principals.add(new DataAdminPrincipal());
  98                         }
  99                 }
 100
 101 //              } catch (InvalidNameException e) {
 102 //                      throw new IllegalArgumentException("Cannot commit", e);
 103 //              }
 104         }
 105
 106         private static void checkSubjectEmpty(Subject subject) {
 107                 if (!subject.getPrincipals(AnonymousPrincipal.class).isEmpty())
 108                         throw new IllegalStateException("Already logged in as anonymous: " + subject);
 109                 if (!subject.getPrincipals(X500Principal.class).isEmpty())
 110                         throw new IllegalStateException("Already logged in as user: " + subject);
 111                 if (!subject.getPrincipals(DataAdminPrincipal.class).isEmpty())
 112                         throw new IllegalStateException("Already logged in as data admin: " + subject);
 113                 if (!subject.getPrincipals(ImpliedByPrincipal.class).isEmpty())
 114                         throw new IllegalStateException("Already authorized: " + subject);
 115         }
 116
 117         static void cleanUp(Subject subject) {
 118                 // Argeo
 119                 subject.getPrincipals().removeAll(subject.getPrincipals(X500Principal.class));
 120                 subject.getPrincipals().removeAll(subject.getPrincipals(ImpliedByPrincipal.class));
 121                 subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
 122                 subject.getPrincipals().removeAll(subject.getPrincipals(DataAdminPrincipal.class));
 123
 124                 subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(CmsSessionId.class));
 125                 subject.getPrivateCredentials().removeAll(subject.getPrivateCredentials(Authorization.class));
 126                 // Jackrabbit
 127                 // subject.getPrincipals().removeAll(subject.getPrincipals(AdminPrincipal.class));
 128                 // subject.getPrincipals().removeAll(subject.getPrincipals(AnonymousPrincipal.class));
 129         }
 130
 131         @SuppressWarnings("unused")
 132         synchronized static void registerSessionAuthorization(RemoteAuthRequest request, Subject subject,
 133                         Authorization authorization, Locale locale) {
 134                 // synchronized in order to avoid multiple registrations
 135                 // TODO move it to a service in order to avoid static synchronization
 136                 if (request != null) {
 137                         RemoteAuthSession httpSession = request.getSession();
 138                         assert httpSession != null;
 139                         String httpSessId = httpSession.getId();
 140                         boolean anonymous = authorization.getName() == null;
 141                         String remoteUser = !anonymous ? authorization.getName() : CmsConstants.ROLE_ANONYMOUS;
 142                         request.setAttribute(RemoteAuthRequest.REMOTE_USER, remoteUser);
 143                         request.setAttribute(RemoteAuthRequest.AUTHORIZATION, authorization);
 144
 145                         CmsSessionImpl cmsSession;
 146                         CmsSessionImpl currentLocalSession = CmsContextImpl.getCmsContext().getCmsSessionByLocalId(httpSessId);
 147                         if (currentLocalSession != null) {
 148                                 boolean currentLocalSessionAnonymous = currentLocalSession.getAuthorization().getName() == null;
 149                                 if (!anonymous) {
 150                                         if (currentLocalSessionAnonymous) {
 151                                                 currentLocalSession.close();
 152                                                 // new CMS session
 153                                                 UUID cmsSessionUuid = CmsContextImpl.getCmsContext().getUuidFactory().timeUUID();
 154                                                 cmsSession = new WebCmsSessionImpl(cmsSessionUuid, subject, authorization, locale, request);
 155                                                 CmsContextImpl.getCmsContext().registerCmsSession(cmsSession);
 156                                         } else if (!authorization.getName().equals(currentLocalSession.getAuthorization().getName())) {
 157                                                 throw new IllegalStateException("Inconsistent user " + authorization.getName()
 158                                                                 + " for existing CMS session " + currentLocalSession);
 159                                         } else {
 160                                                 // keep current session
 161                                                 cmsSession = currentLocalSession;
 162                                                 // credentials
 163                                                 // TODO control it more??
 164                                                 subject.getPrivateCredentials().addAll(cmsSession.getSubject().getPrivateCredentials());
 165                                                 subject.getPublicCredentials().addAll(cmsSession.getSubject().getPublicCredentials());
 166                                         }
 167                                 } else {// anonymous
 168                                         if (!currentLocalSessionAnonymous) {
 169                                                 currentLocalSession.close();
 170                                                 throw new IllegalStateException(
 171                                                                 "Existing CMS session " + currentLocalSession + " was not logged out properly.");
 172                                         }
 173                                         // keep current session
 174                                         cmsSession = currentLocalSession;
 175                                 }
 176                         } else {
 177                                 // new CMS session
 178                                 UUID cmsSessionUuid = CmsContextImpl.getCmsContext().getUuidFactory().timeUUID();
 179                                 cmsSession = new WebCmsSessionImpl(cmsSessionUuid, subject, authorization, locale, request);
 180                                 CmsContextImpl.getCmsContext().registerCmsSession(cmsSession);
 181                         }
 182
 183                         if (cmsSession == null)// should be dead code (cf. SuppressWarning of the method)
 184                                 throw new IllegalStateException("CMS session cannot be null");
 185
 186                         CmsSessionId nodeSessionId = new CmsSessionId(cmsSession.getUuid());
 187                         if (subject.getPrivateCredentials(CmsSessionId.class).size() == 0) {
 188                                 subject.getPrivateCredentials().add(nodeSessionId);
 189                         } else {
 190                                 UUID storedSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next().getUuid();
 191                                 if (!storedSessionId.equals(nodeSessionId.getUuid()))
 192                                         throw new IllegalStateException(
 193                                                         "Subject already logged with session " + storedSessionId + " (not " + nodeSessionId + ")");
 194                         }
 195                 } else {
 196                         CmsSessionImpl cmsSession = CmsContextImpl.getCmsContext().getCmsSessionByLocalId(SINGLE_USER_LOCAL_ID);
 197                         if (cmsSession == null) {
 198                                 UUID cmsSessionUuid = CmsContextImpl.getCmsContext().getUuidFactory().timeUUID();
 199                                 cmsSession = new CmsSessionImpl(cmsSessionUuid, subject, authorization, locale, SINGLE_USER_LOCAL_ID);
 200                                 CmsContextImpl.getCmsContext().registerCmsSession(cmsSession);
 201                         }
 202                         CmsSessionId nodeSessionId = new CmsSessionId(cmsSession.getUuid());
 203                         subject.getPrivateCredentials().add(nodeSessionId);
 204                 }
 205         }
 206
 207 //      public static CmsSessionImpl cmsSessionFromHttpSession(BundleContext bc, String httpSessionId) {
 208 //              Authorization authorization = null;
 209 //              Collection<ServiceReference<CmsSession>> sr;
 210 //              try {
 211 //                      sr = bc.getServiceReferences(CmsSession.class,
 212 //                                      "(" + CmsSession.SESSION_LOCAL_ID + "=" + httpSessionId + ")");
 213 //              } catch (InvalidSyntaxException e) {
 214 //                      throw new IllegalArgumentException("Cannot get CMS session for id " + httpSessionId, e);
 215 //              }
 216 //              CmsSessionImpl cmsSession;
 217 //              if (sr.size() == 1) {
 218 //                      cmsSession = (CmsSessionImpl) bc.getService(sr.iterator().next());
 219 ////                    locale = cmsSession.getLocale();
 220 //                      authorization = cmsSession.getAuthorization();
 221 //                      if (authorization.getName() == null)
 222 //                              return null;// anonymous is not sufficient
 223 //              } else if (sr.size() == 0)
 224 //                      return null;
 225 //              else
 226 //                      throw new IllegalStateException(sr.size() + ">1 web sessions detected for http session " + httpSessionId);
 227 //              return cmsSession;
 228 //      }
 229
 230         public static <T extends Principal> T getSinglePrincipal(Subject subject, Class<T> clss) {
 231                 Set<T> principals = subject.getPrincipals(clss);
 232                 if (principals.isEmpty())
 233                         return null;
 234                 if (principals.size() > 1)
 235                         throw new IllegalStateException("Only one " + clss + " principal expected in " + subject);
 236                 return principals.iterator().next();
 237         }
 238
 239         private static void checkUserName(String name) throws IllegalArgumentException {
 240                 if (RESERVED_ROLES.contains(name))
 241                         throw new IllegalArgumentException(name + " is a reserved name");
 242         }
 243
 244         private CmsAuthUtils() {
 245
 246         }
 247
 248 }