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

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