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

   1 package org.argeo.cms.auth;
   2
   3 import static org.argeo.naming.LdapAttrs.cn;
   4
   5 import java.io.IOException;
   6 import java.security.PrivilegedAction;
   7 import java.util.Arrays;
   8 import java.util.HashSet;
   9 import java.util.List;
  10 import java.util.Locale;
  11 import java.util.Map;
  12 import java.util.Set;
  13
  14 import javax.naming.ldap.LdapName;
  15 import javax.security.auth.Subject;
  16 import javax.security.auth.callback.Callback;
  17 import javax.security.auth.callback.CallbackHandler;
  18 import javax.security.auth.callback.LanguageCallback;
  19 import javax.security.auth.callback.NameCallback;
  20 import javax.security.auth.callback.PasswordCallback;
  21 import javax.security.auth.callback.UnsupportedCallbackException;
  22 import javax.security.auth.kerberos.KerberosPrincipal;
  23 import javax.security.auth.login.CredentialNotFoundException;
  24 import javax.security.auth.login.LoginException;
  25 import javax.security.auth.spi.LoginModule;
  26 import javax.servlet.http.HttpServletRequest;
  27
  28 import org.apache.commons.logging.Log;
  29 import org.apache.commons.logging.LogFactory;
  30 import org.argeo.api.NodeConstants;
  31 import org.argeo.api.security.CryptoKeyring;
  32 import org.argeo.cms.internal.kernel.Activator;
  33 import org.argeo.naming.LdapAttrs;
  34 import org.argeo.osgi.useradmin.AuthenticatingUser;
  35 import org.argeo.osgi.useradmin.IpaUtils;
  36 import org.argeo.osgi.useradmin.TokenUtils;
  37 import org.osgi.framework.BundleContext;
  38 import org.osgi.framework.FrameworkUtil;
  39 import org.osgi.framework.ServiceReference;
  40 import org.osgi.service.useradmin.Authorization;
  41 import org.osgi.service.useradmin.Group;
  42 import org.osgi.service.useradmin.User;
  43 import org.osgi.service.useradmin.UserAdmin;
  44
  45 /**
  46  * Use the {@link UserAdmin} in the OSGi registry as the basis for
  47  * authentication.
  48  */
  49 public class UserAdminLoginModule implements LoginModule {
  50         private final static Log log = LogFactory.getLog(UserAdminLoginModule.class);
  51
  52         private Subject subject;
  53         private CallbackHandler callbackHandler;
  54         private Map<String, Object> sharedState = null;
  55
  56         private List<String> indexedUserProperties = Arrays
  57                         .asList(new String[] { LdapAttrs.mail.name(), LdapAttrs.uid.name(), LdapAttrs.authPassword.name() });
  58
  59         // private state
  60         private BundleContext bc;
  61         private User authenticatedUser = null;
  62         private Locale locale;
  63
  64         private Authorization bindAuthorization = null;
  65
  66 //      private boolean singleUser = Activator.isSingleUser();
  67
  68         @SuppressWarnings("unchecked")
  69         @Override
  70         public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState,
  71                         Map<String, ?> options) {
  72                 this.subject = subject;
  73                 try {
  74                         bc = FrameworkUtil.getBundle(UserAdminLoginModule.class).getBundleContext();
  75                         this.callbackHandler = callbackHandler;
  76                         this.sharedState = (Map<String, Object>) sharedState;
  77                 } catch (Exception e) {
  78                         throw new IllegalStateException("Cannot initialize login module", e);
  79                 }
  80         }
  81
  82         @Override
  83         public boolean login() throws LoginException {
  84                 UserAdmin userAdmin = Activator.getUserAdmin();
  85                 final String username;
  86                 final char[] password;
  87                 Object certificateChain = null;
  88                 boolean preauth = false;
  89                 if (sharedState.containsKey(CmsAuthUtils.SHARED_STATE_NAME)
  90                                 && sharedState.containsKey(CmsAuthUtils.SHARED_STATE_PWD)) {
  91                         // NB: required by Basic http auth
  92                         username = (String) sharedState.get(CmsAuthUtils.SHARED_STATE_NAME);
  93                         password = (char[]) sharedState.get(CmsAuthUtils.SHARED_STATE_PWD);
  94                         // // TODO locale?
  95                 } else if (sharedState.containsKey(CmsAuthUtils.SHARED_STATE_NAME)
  96                                 && sharedState.containsKey(CmsAuthUtils.SHARED_STATE_CERTIFICATE_CHAIN)) {
  97                         String certDn = (String) sharedState.get(CmsAuthUtils.SHARED_STATE_NAME);
  98 //                      LdapName ldapName;
  99 //                      try {
 100 //                              ldapName = new LdapName(certificateName);
 101 //                      } catch (InvalidNameException e) {
 102 //                              e.printStackTrace();
 103 //                              return false;
 104 //                      }
 105 //                      username = ldapName.getRdn(ldapName.size() - 1).getValue().toString();
 106                         username = certDn;
 107                         certificateChain = sharedState.get(CmsAuthUtils.SHARED_STATE_CERTIFICATE_CHAIN);
 108                         password = null;
 109                 } else if (sharedState.containsKey(CmsAuthUtils.SHARED_STATE_NAME)
 110                                 && sharedState.containsKey(CmsAuthUtils.SHARED_STATE_REMOTE_ADDR)
 111                                 && sharedState.containsKey(CmsAuthUtils.SHARED_STATE_REMOTE_PORT)) {// ident
 112                         username = (String) sharedState.get(CmsAuthUtils.SHARED_STATE_NAME);
 113                         password = null;
 114                         preauth = true;
 115 //              } else if (singleUser) {
 116 //                      username = OsUserUtils.getOsUsername();
 117 //                      password = null;
 118 //                      // TODO retrieve from http session
 119 //                      locale = Locale.getDefault();
 120                 } else {
 121
 122                         // ask for username and password
 123                         NameCallback nameCallback = new NameCallback("User");
 124                         PasswordCallback passwordCallback = new PasswordCallback("Password", false);
 125                         LanguageCallback langCallback = new LanguageCallback();
 126                         try {
 127                                 callbackHandler.handle(new Callback[] { nameCallback, passwordCallback, langCallback });
 128                         } catch (IOException e) {
 129                                 throw new LoginException("Cannot handle callback: " + e.getMessage());
 130                         } catch (UnsupportedCallbackException e) {
 131                                 return false;
 132                         }
 133
 134                         // i18n
 135                         locale = langCallback.getLocale();
 136                         if (locale == null)
 137                                 locale = Locale.getDefault();
 138                         // FIXME add it to Subject
 139                         // Locale.setDefault(locale);
 140
 141                         username = nameCallback.getName();
 142                         if (username == null || username.trim().equals("")) {
 143                                 // authorization = userAdmin.getAuthorization(null);
 144                                 throw new CredentialNotFoundException("No credentials provided");
 145                         }
 146                         if (passwordCallback.getPassword() != null)
 147                                 password = passwordCallback.getPassword();
 148                         else
 149                                 throw new CredentialNotFoundException("No credentials provided");
 150                         sharedState.put(CmsAuthUtils.SHARED_STATE_NAME, username);
 151                         sharedState.put(CmsAuthUtils.SHARED_STATE_PWD, password);
 152                 }
 153                 User user = searchForUser(userAdmin, username);
 154
 155                 // Tokens
 156                 if (user == null) {
 157                         String token = username;
 158                         Group tokenGroup = searchForToken(userAdmin, token);
 159                         if (tokenGroup != null) {
 160                                 Authorization tokenAuthorization = getAuthorizationFromToken(userAdmin, tokenGroup);
 161                                 if (tokenAuthorization != null) {
 162                                         bindAuthorization = tokenAuthorization;
 163                                         authenticatedUser = (User) userAdmin.getRole(bindAuthorization.getName());
 164                                         return true;
 165                                 }
 166                         }
 167                 }
 168
 169                 if (user == null)
 170                         return true;// expect Kerberos
 171
 172                 if (password != null) {
 173                         // try bind first
 174                         try {
 175                                 AuthenticatingUser authenticatingUser = new AuthenticatingUser(user.getName(), password);
 176                                 bindAuthorization = userAdmin.getAuthorization(authenticatingUser);
 177                                 // TODO check tokens as well
 178                                 if (bindAuthorization != null) {
 179                                         authenticatedUser = user;
 180                                         return true;
 181                                 }
 182                         } catch (Exception e) {
 183                                 // silent
 184                                 if (log.isTraceEnabled())
 185                                         log.trace("Bind failed", e);
 186                         }
 187
 188                         // works only if a connection password is provided
 189                         if (!user.hasCredential(null, password)) {
 190                                 return false;
 191                         }
 192                 } else if (certificateChain != null) {
 193                         // TODO check CRLs/OSCP validity?
 194                         // NB: authorization in commit() will work only if an LDAP connection password
 195                         // is provided
 196 //              } else if (singleUser) {
 197 //                      // TODO verify IP address?
 198                 } else if (preauth) {
 199                         // ident
 200                 } else {
 201                         throw new CredentialNotFoundException("No credentials provided");
 202                 }
 203
 204                 authenticatedUser = user;
 205                 return true;
 206         }
 207
 208         @Override
 209         public boolean commit() throws LoginException {
 210                 if (locale != null)
 211                         subject.getPublicCredentials().add(locale);
 212
 213 //              if (singleUser) {
 214 //                      OsUserUtils.loginAsSystemUser(subject);
 215 //              }
 216                 UserAdmin userAdmin = Activator.getUserAdmin();
 217                 Authorization authorization;
 218                 if (callbackHandler == null) {// anonymous
 219                         authorization = userAdmin.getAuthorization(null);
 220                 } else if (bindAuthorization != null) {// bind
 221                         authorization = bindAuthorization;
 222                 } else {// Kerberos
 223                         User authenticatingUser;
 224                         Set<KerberosPrincipal> kerberosPrincipals = subject.getPrincipals(KerberosPrincipal.class);
 225                         if (kerberosPrincipals.isEmpty()) {
 226                                 if (authenticatedUser == null) {
 227                                         if (log.isTraceEnabled())
 228                                                 log.trace("Neither kerberos nor user admin login succeeded. Login failed.");
 229                                         throw new CredentialNotFoundException("Bad credentials.");
 230                                 } else {
 231                                         authenticatingUser = authenticatedUser;
 232                                 }
 233                         } else {
 234                                 KerberosPrincipal kerberosPrincipal = kerberosPrincipals.iterator().next();
 235                                 LdapName dn = IpaUtils.kerberosToDn(kerberosPrincipal.getName());
 236                                 authenticatingUser = new AuthenticatingUser(dn);
 237                                 if (authenticatedUser != null && !authenticatingUser.getName().equals(authenticatedUser.getName()))
 238                                         throw new LoginException("Kerberos login " + authenticatingUser.getName()
 239                                                         + " is inconsistent with user admin login " + authenticatedUser.getName());
 240                         }
 241                         authorization = Subject.doAs(subject, new PrivilegedAction<Authorization>() {
 242
 243                                 @Override
 244                                 public Authorization run() {
 245                                         Authorization authorization = userAdmin.getAuthorization(authenticatingUser);
 246                                         return authorization;
 247                                 }
 248
 249                         });
 250                         if (authorization == null)
 251                                 throw new LoginException(
 252                                                 "User admin found no authorization for authenticated user " + authenticatingUser.getName());
 253                 }
 254
 255                 // Log and monitor new login
 256                 HttpServletRequest request = (HttpServletRequest) sharedState.get(CmsAuthUtils.SHARED_STATE_HTTP_REQUEST);
 257                 CmsAuthUtils.addAuthorization(subject, authorization);
 258
 259                 // Unlock keyring (underlying login to the JCR repository)
 260                 char[] password = (char[]) sharedState.get(CmsAuthUtils.SHARED_STATE_PWD);
 261                 if (password != null) {
 262                         ServiceReference<CryptoKeyring> keyringSr = bc.getServiceReference(CryptoKeyring.class);
 263                         if (keyringSr != null) {
 264                                 CryptoKeyring keyring = bc.getService(keyringSr);
 265                                 Subject.doAs(subject, new PrivilegedAction<Void>() {
 266
 267                                         @Override
 268                                         public Void run() {
 269                                                 try {
 270                                                         keyring.unlock(password);
 271                                                 } catch (Exception e) {
 272                                                         e.printStackTrace();
 273                                                         log.warn("Could not unlock keyring with the password provided by " + authorization.getName()
 274                                                                         + ": " + e.getMessage());
 275                                                 }
 276                                                 return null;
 277                                         }
 278
 279                                 });
 280                         }
 281                 }
 282
 283                 // Register CmsSession with initial subject
 284                 CmsAuthUtils.registerSessionAuthorization(request, subject, authorization, locale);
 285
 286                 if (log.isDebugEnabled())
 287                         log.debug("Logged in to CMS: " + subject);
 288                 return true;
 289         }
 290
 291         @Override
 292         public boolean abort() throws LoginException {
 293                 return true;
 294         }
 295
 296         @Override
 297         public boolean logout() throws LoginException {
 298                 if (log.isTraceEnabled())
 299                         log.trace("Logging out from CMS... " + subject);
 300                 CmsAuthUtils.cleanUp(subject);
 301                 return true;
 302         }
 303
 304         protected User searchForUser(UserAdmin userAdmin, String providedUsername) {
 305                 try {
 306                         // TODO check value null or empty
 307                         Set<User> collectedUsers = new HashSet<>();
 308                         // try dn
 309                         User user = null;
 310                         user = null;
 311                         // try all indexes
 312                         for (String attr : indexedUserProperties) {
 313                                 user = userAdmin.getUser(attr, providedUsername);
 314                                 if (user != null)
 315                                         collectedUsers.add(user);
 316                         }
 317                         if (collectedUsers.size() == 1) {
 318                                 user = collectedUsers.iterator().next();
 319                                 return user;
 320                         } else if (collectedUsers.size() > 1) {
 321                                 log.warn(collectedUsers.size() + " users for provided username" + providedUsername);
 322                         }
 323                         // try DN as a last resort
 324                         try {
 325                                 user = (User) userAdmin.getRole(providedUsername);
 326                                 if (user != null)
 327                                         return user;
 328                         } catch (Exception e) {
 329                                 // silent
 330                         }
 331                         return null;
 332                 } catch (Exception e) {
 333                         if (log.isTraceEnabled())
 334                                 log.warn("Cannot search for user " + providedUsername, e);
 335                         return null;
 336                 }
 337
 338         }
 339
 340         protected Group searchForToken(UserAdmin userAdmin, String token) {
 341                 String dn = cn + "=" + token + "," + NodeConstants.TOKENS_BASEDN;
 342                 Group tokenGroup = (Group) userAdmin.getRole(dn);
 343                 return tokenGroup;
 344         }
 345
 346         protected Authorization getAuthorizationFromToken(UserAdmin userAdmin, Group tokenGroup) {
 347                 if (TokenUtils.isExpired(tokenGroup))
 348                         return null;
 349 //              String expiryDateStr = (String) tokenGroup.getProperties().get(description.name());
 350 //              if (expiryDateStr != null) {
 351 //                      Instant expiryDate = NamingUtils.ldapDateToInstant(expiryDateStr);
 352 //                      if (expiryDate.isBefore(Instant.now())) {
 353 //                              if (log.isDebugEnabled())
 354 //                                      log.debug("Token " + tokenGroup.getName() + " has expired.");
 355 //                              return null;
 356 //                      }
 357 //              }
 358                 String userDn = TokenUtils.userDn(tokenGroup);
 359                 User user = (User) userAdmin.getRole(userDn);
 360                 Authorization auth = userAdmin.getAuthorization(user);
 361                 return auth;
 362         }
 363 }