Ticket Reference handling #1048

Paul Martin

2016-04-27 c2188a840bc4153ae92112b04b2e06a90d3944aa

 src/main/java/com/gitblit/manager/AuthenticationManager.java

@@ -27,19 +27,21 @@
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.apache.wicket.RequestCycle;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.gitblit.Constants;
import com.gitblit.Constants.AccountType;
import com.gitblit.Constants.AuthenticationType;
import com.gitblit.Constants.Role;
import com.gitblit.IStoredSettings;
import com.gitblit.Keys;
import com.gitblit.auth.AuthenticationProvider;
import com.gitblit.auth.AuthenticationProvider.UsernamePasswordAuthenticationProvider;
import com.gitblit.auth.HtpasswdAuthProvider;
import com.gitblit.auth.HttpHeaderAuthProvider;
import com.gitblit.auth.LdapAuthProvider;
import com.gitblit.auth.PAMAuthProvider;
import com.gitblit.auth.RedmineAuthProvider;
@@ -47,11 +49,13 @@
import com.gitblit.auth.WindowsAuthProvider;
import com.gitblit.models.TeamModel;
import com.gitblit.models.UserModel;
import com.gitblit.transport.ssh.SshKey;
import com.gitblit.utils.Base64;
import com.gitblit.utils.HttpUtils;
import com.gitblit.utils.StringUtils;
import com.gitblit.utils.X509Utils.X509Metadata;
import com.gitblit.wicket.GitBlitWebSession;
import com.google.inject.Inject;
import com.google.inject.Singleton;

/**
 * The authentication manager handles user login & logout.
@@ -59,6 +63,7 @@
 * @author James Moger
 *
 */
@Singleton
public class AuthenticationManager implements IAuthenticationManager {

   private final Logger logger = LoggerFactory.getLogger(getClass());
@@ -75,6 +80,7 @@

   private final Map<String, String> legacyRedirects;

   @Inject
   public AuthenticationManager(
         IRuntimeManager runtimeManager,
         IUserManager userManager) {
@@ -87,6 +93,7 @@
      // map of shortcut provider names
      providerNames = new HashMap<String, Class<? extends AuthenticationProvider>>();
      providerNames.put("htpasswd", HtpasswdAuthProvider.class);
      providerNames.put("httpheader", HttpHeaderAuthProvider.class);
      providerNames.put("ldap", LdapAuthProvider.class);
      providerNames.put("pam", PAMAuthProvider.class);
      providerNames.put("redmine", RedmineAuthProvider.class);
@@ -160,8 +167,16 @@
      return this;
   }

   public void addAuthenticationProvider(AuthenticationProvider prov) {
      authenticationProviders.add(prov);
   }

   /**
    * Authenticate a user based on HTTP request parameters.
    * Used to handle authentication for page requests.
    *
    * This allows authentication to occur based on the contents of the request
    * itself. If no configured @{AuthenticationProvider}s authenticate succesffully,
    * a request for login will be shown.
    *
    * Authentication by X509Certificate is tried first and then by cookie.
    *
@@ -176,7 +191,7 @@
   /**
    * Authenticate a user based on HTTP request parameters.
    *
    * Authentication by servlet container principal, X509Certificate, cookie,
    * Authentication by custom HTTP header, servlet container principal, X509Certificate, cookie,
    * and finally BASIC header.
    *
    * @param httpRequest
@@ -185,6 +200,14 @@
    */
   @Override
   public UserModel authenticate(HttpServletRequest httpRequest, boolean requiresCertificate) {

      // Check if this request has already been authenticated, and trust that instead of re-processing
      String reqAuthUser = (String) httpRequest.getAttribute(Constants.ATTRIB_AUTHUSER);
      if (!StringUtils.isEmpty(reqAuthUser)) {
         logger.debug("Called servlet authenticate when request is already authenticated.");
         return userManager.getUserModel(reqAuthUser);
      }

      // try to authenticate by servlet container principal
      if (!requiresCertificate) {
         Principal principal = httpRequest.getUserPrincipal();
@@ -195,10 +218,10 @@
               UserModel user = userManager.getUserModel(username);
               if (user != null) {
                  // existing user
                  flagWicketSession(AuthenticationType.CONTAINER);
                  flagRequest(httpRequest, AuthenticationType.CONTAINER, user.username);
                  logger.debug(MessageFormat.format("{0} authenticated by servlet container principal from {1}",
                        user.username, httpRequest.getRemoteAddr()));
                  return user;
                  return validateAuthentication(user, AuthenticationType.CONTAINER);
               } else if (settings.getBoolean(Keys.realm.container.autoCreateAccounts, false)
                     && !internalAccount) {
                  // auto-create user from an authenticated container principal
@@ -206,11 +229,34 @@
                  user.displayName = username;
                  user.password = Constants.EXTERNAL_ACCOUNT;
                  user.accountType = AccountType.CONTAINER;
						
                  // Try to extract user's informations for the session
                  // it uses "realm.container.autoAccounts.*" as the attribute name to look for
                  HttpSession session = httpRequest.getSession();
                  String emailAddress = resolveAttribute(session, Keys.realm.container.autoAccounts.emailAddress);
                  if(emailAddress != null) {
                     user.emailAddress = emailAddress;
                  }
                  String displayName = resolveAttribute(session, Keys.realm.container.autoAccounts.displayName);
                  if(displayName != null) {
                     user.displayName = displayName;
                  }
                  String userLocale = resolveAttribute(session, Keys.realm.container.autoAccounts.locale);
                  if(userLocale != null) {
                     user.getPreferences().setLocale(userLocale);
                  }
                  String adminRole = settings.getString(Keys.realm.container.autoAccounts.adminRole, null);
                  if(adminRole != null && ! adminRole.isEmpty()) {
                     if(httpRequest.isUserInRole(adminRole)) {
                        user.canAdmin = true;
                     }
                  }
						
                  userManager.updateUserModel(user);
                  flagWicketSession(AuthenticationType.CONTAINER);
                  flagRequest(httpRequest, AuthenticationType.CONTAINER, user.username);
                  logger.debug(MessageFormat.format("{0} authenticated and created by servlet container principal from {1}",
                        user.username, httpRequest.getRemoteAddr()));
                  return user;
                  return validateAuthentication(user, AuthenticationType.CONTAINER);
               } else if (!internalAccount) {
                  logger.warn(MessageFormat.format("Failed to find UserModel for {0}, attempted servlet container authentication from {1}",
                        principal.getName(), httpRequest.getRemoteAddr()));
@@ -228,10 +274,10 @@
         UserModel user = userManager.getUserModel(model.username);
         X509Metadata metadata = HttpUtils.getCertificateMetadata(httpRequest);
         if (user != null) {
            flagWicketSession(AuthenticationType.CERTIFICATE);
            flagRequest(httpRequest, AuthenticationType.CERTIFICATE, user.username);
            logger.debug(MessageFormat.format("{0} authenticated by client certificate {1} from {2}",
                  user.username, metadata.serialNumber, httpRequest.getRemoteAddr()));
            return user;
            return validateAuthentication(user, AuthenticationType.CERTIFICATE);
         } else {
            logger.warn(MessageFormat.format("Failed to find UserModel for {0}, attempted client certificate ({1}) authentication from {2}",
                  model.username, metadata.serialNumber, httpRequest.getRemoteAddr()));
@@ -250,10 +296,10 @@
      if (!StringUtils.isEmpty(cookie)) {
         user = userManager.getUserModel(cookie.toCharArray());
         if (user != null) {
            flagWicketSession(AuthenticationType.COOKIE);
            flagRequest(httpRequest, AuthenticationType.COOKIE, user.username);
            logger.debug(MessageFormat.format("{0} authenticated by cookie from {1}",
               user.username, httpRequest.getRemoteAddr()));
            return user;
            return validateAuthentication(user, AuthenticationType.COOKIE);
         }
      }

@@ -270,28 +316,139 @@
         if (values.length == 2) {
            String username = values[0];
            char[] password = values[1].toCharArray();
            user = authenticate(username, password);
            user = authenticate(username, password, httpRequest.getRemoteAddr());
            if (user != null) {
               flagWicketSession(AuthenticationType.CREDENTIALS);
               flagRequest(httpRequest, AuthenticationType.CREDENTIALS, user.username);
               logger.debug(MessageFormat.format("{0} authenticated by BASIC request header from {1}",
                     user.username, httpRequest.getRemoteAddr()));
               return user;
            } else {
               logger.warn(MessageFormat.format("Failed login attempt for {0}, invalid credentials from {1}",
                     username, httpRequest.getRemoteAddr()));
               return validateAuthentication(user, AuthenticationType.CREDENTIALS);
            }
         }
      }

      // Check each configured AuthenticationProvider
      for (AuthenticationProvider ap : authenticationProviders) {
         UserModel authedUser = ap.authenticate(httpRequest);
         if (null != authedUser) {
            flagRequest(httpRequest, ap.getAuthenticationType(), authedUser.username);
            logger.debug(MessageFormat.format("{0} authenticated by {1} from {2} for {3}",
                  authedUser.username, ap.getServiceName(), httpRequest.getRemoteAddr(),
                  httpRequest.getPathInfo()));
            return validateAuthentication(authedUser, ap.getAuthenticationType());
         }
      }
      return null;
   }

   protected void flagWicketSession(AuthenticationType authenticationType) {
      RequestCycle requestCycle = RequestCycle.get();
      if (requestCycle != null) {
         // flag the Wicket session, if this is a Wicket request
         GitBlitWebSession session = GitBlitWebSession.get();
         session.authenticationType = authenticationType;
	
   /**
    * Extract given attribute from the session and return it's content
    * it return null if attributeMapping is empty, or if the value is
    * empty
    * 
    * @param session The user session
    * @param attributeMapping
    * @return
    */
   private String resolveAttribute(HttpSession session, String attributeMapping) {
      String attributeName = settings.getString(attributeMapping, null);
      if(StringUtils.isEmpty(attributeName)) {
         return null;
      }
      Object attributeValue = session.getAttribute(attributeName);
      if(attributeValue == null) {
         return null;
      }
      String value = attributeValue.toString();
      if(value.isEmpty()) {
         return null;
      }
      return value;
   }

   /**
    * Authenticate a user based on a public key.
    *
    * This implementation assumes that the authentication has already take place
    * (e.g. SSHDaemon) and that this is a validation/verification of the user.
    *
    * @param username
    * @param key
    * @return a user object or null
    */
   @Override
   public UserModel authenticate(String username, SshKey key) {
      if (username != null) {
         if (!StringUtils.isEmpty(username)) {
            UserModel user = userManager.getUserModel(username);
            if (user != null) {
               // existing user
               logger.debug(MessageFormat.format("{0} authenticated by {1} public key",
                     user.username, key.getAlgorithm()));
               return validateAuthentication(user, AuthenticationType.PUBLIC_KEY);
            }
            logger.warn(MessageFormat.format("Failed to find UserModel for {0} during public key authentication",
                     username));
         }
      } else {
         logger.warn("Empty user passed to AuthenticationManager.authenticate!");
      }
      return null;
   }


   /**
    * Return the UserModel for already authenticated user.
    *
    * This implementation assumes that the authentication has already take place
    * (e.g. SSHDaemon) and that this is a validation/verification of the user.
    *
    * @param username
    * @return a user object or null
    */
   @Override
   public UserModel authenticate(String username) {
      if (username != null) {
         if (!StringUtils.isEmpty(username)) {
            UserModel user = userManager.getUserModel(username);
            if (user != null) {
               // existing user
               logger.debug(MessageFormat.format("{0} authenticated externally", user.username));
               return validateAuthentication(user, AuthenticationType.CONTAINER);
            }
            logger.warn(MessageFormat.format("Failed to find UserModel for {0} during external authentication",
                     username));
         }
      } else {
         logger.warn("Empty user passed to AuthenticationManager.authenticate!");
      }
      return null;
   }


   /**
    * This method allows the authentication manager to reject authentication
    * attempts.  It is called after the username/secret have been verified to
    * ensure that the authentication technique has been logged.
    *
    * @param user
    * @return
    */
   protected UserModel validateAuthentication(UserModel user, AuthenticationType type) {
      if (user == null) {
         return null;
      }
      if (user.disabled) {
         // user has been disabled
         logger.warn("Rejected {} authentication attempt by disabled account \"{}\"",
               type, user.username);
         return null;
      }
      return user;
   }

   protected void flagRequest(HttpServletRequest httpRequest, AuthenticationType authenticationType, String authedUsername) {
      httpRequest.setAttribute(Constants.ATTRIB_AUTHUSER,  authedUsername);
      httpRequest.setAttribute(Constants.ATTRIB_AUTHTYPE,  authenticationType);
   }

   /**
@@ -303,12 +460,18 @@
    * @return a user object or null
    */
   @Override
   public UserModel authenticate(String username, char[] password) {
   public UserModel authenticate(String username, char[] password, String remoteIP) {
      if (StringUtils.isEmpty(username)) {
         // can not authenticate empty username
         return null;
      }

      if (username.equalsIgnoreCase(Constants.FEDERATION_USER)) {
         // can not authenticate internal FEDERATION_USER at this point
         // it must be routed to FederationManager
         return null;
      }
		
      String usernameDecoded = StringUtils.decodeUsername(username);
      String pw = new String(password);
      if (StringUtils.isEmpty(pw)) {
@@ -320,41 +483,59 @@

      // try local authentication
      if (user != null && user.isLocalAccount()) {
         UserModel returnedUser = null;
         if (user.password.startsWith(StringUtils.MD5_TYPE)) {
            // password digest
            String md5 = StringUtils.MD5_TYPE + StringUtils.getMD5(new String(password));
            if (user.password.equalsIgnoreCase(md5)) {
               returnedUser = user;
            }
         } else if (user.password.startsWith(StringUtils.COMBINED_MD5_TYPE)) {
            // username+password digest
            String md5 = StringUtils.COMBINED_MD5_TYPE
                  + StringUtils.getMD5(username.toLowerCase() + new String(password));
            if (user.password.equalsIgnoreCase(md5)) {
               returnedUser = user;
            }
         } else if (user.password.equals(new String(password))) {
            // plain-text password
            returnedUser = user;
         UserModel returnedUser = authenticateLocal(user, password);
         if (returnedUser != null) {
            // user authenticated
            return returnedUser;
         }
         return returnedUser;
      }

      // try registered external authentication providers
      if (user == null) {
      } else {
         // try registered external authentication providers
         for (AuthenticationProvider provider : authenticationProviders) {
            if (provider instanceof UsernamePasswordAuthenticationProvider) {
               user = provider.authenticate(usernameDecoded, password);
               if (user != null) {
               UserModel returnedUser = provider.authenticate(usernameDecoded, password);
               if (returnedUser != null) {
                  // user authenticated
                  user.accountType = provider.getAccountType();
                  return user;
                  returnedUser.accountType = provider.getAccountType();
                  return validateAuthentication(returnedUser, AuthenticationType.CREDENTIALS);
               }
            }
         }
      }
      return user;

      // could not authenticate locally or with a provider
      logger.warn(MessageFormat.format("Failed login attempt for {0}, invalid credentials from {1}", username, 
            remoteIP != null ? remoteIP : "unknown"));
		
      return null;
   }

   /**
    * Returns a UserModel if local authentication succeeds.
    *
    * @param user
    * @param password
    * @return a UserModel if local authentication succeeds, null otherwise
    */
   protected UserModel authenticateLocal(UserModel user, char [] password) {
      UserModel returnedUser = null;
      if (user.password.startsWith(StringUtils.MD5_TYPE)) {
         // password digest
         String md5 = StringUtils.MD5_TYPE + StringUtils.getMD5(new String(password));
         if (user.password.equalsIgnoreCase(md5)) {
            returnedUser = user;
         }
      } else if (user.password.startsWith(StringUtils.COMBINED_MD5_TYPE)) {
         // username+password digest
         String md5 = StringUtils.COMBINED_MD5_TYPE
               + StringUtils.getMD5(user.username.toLowerCase() + new String(password));
         if (user.password.equalsIgnoreCase(md5)) {
            returnedUser = user;
         }
      } else if (user.password.equals(new String(password))) {
         // plain-text password
         returnedUser = user;
      }
      return validateAuthentication(returnedUser, AuthenticationType.CREDENTIALS);
   }

   /**
@@ -386,10 +567,30 @@
    * @param user
    */
   @Override
   @Deprecated
   public void setCookie(HttpServletResponse response, UserModel user) {
      setCookie(null, response, user);
   }

   /**
    * Sets a cookie for the specified user.
    *
    * @param request
    * @param response
    * @param user
    */
   @Override
   public void setCookie(HttpServletRequest request, HttpServletResponse response, UserModel user) {
      if (settings.getBoolean(Keys.web.allowCookieAuthentication, true)) {
         GitBlitWebSession session = GitBlitWebSession.get();
         boolean standardLogin = session.authenticationType.isStandard();
         boolean standardLogin = true;

         if (null != request) {
            // Pull the auth type from the request, it is set there if container managed
            AuthenticationType authenticationType = (AuthenticationType) request.getAttribute(Constants.ATTRIB_AUTHTYPE);

            if (null != authenticationType)
               standardLogin = authenticationType.isStandard();
         }

         if (standardLogin) {
            Cookie userCookie;
@@ -409,7 +610,13 @@
                  userCookie.setMaxAge((int) TimeUnit.DAYS.toSeconds(7));
               }
            }
            userCookie.setPath("/");
            String path = "/";
            if (request != null) {
               if (!StringUtils.isEmpty(request.getContextPath())) {
                  path = request.getContextPath();
               }
            }
            userCookie.setPath(path);
            response.addCookie(userCookie);
         }
      }
@@ -418,11 +625,25 @@
   /**
    * Logout a user.
    *
    * @param response
    * @param user
    */
   @Override
   @Deprecated
   public void logout(HttpServletResponse response, UserModel user) {
      setCookie(response,  null);
      setCookie(null, response,  null);
   }

   /**
    * Logout a user.
    *
    * @param request
    * @param response
    * @param user
    */
   @Override
   public void logout(HttpServletRequest request, HttpServletResponse response, UserModel user) {
      setCookie(request, response,  null);
   }

   /**
@@ -480,6 +701,28 @@
      return (team != null && team.isLocalTeam()) || findProvider(team).supportsTeamMembershipChanges();
   }

   /**
    * Returns true if the user's role can be changed.
    *
    * @param user
    * @return true if the user's role can be changed
    */
   @Override
   public boolean supportsRoleChanges(UserModel user, Role role) {
      return (user != null && user.isLocalAccount()) || findProvider(user).supportsRoleChanges(user, role);
   }

   /**
    * Returns true if the team's role can be changed.
    *
    * @param user
    * @return true if the team's role can be changed
    */
   @Override
   public boolean supportsRoleChanges(TeamModel team, Role role) {
      return (team != null && team.isLocalTeam()) || findProvider(team).supportsRoleChanges(team, role);
   }

   protected AuthenticationProvider findProvider(UserModel user) {
      for (AuthenticationProvider provider : authenticationProviders) {
         if (provider.getAccountType().equals(user.accountType)) {