cache authentication for 60 seconds to improve svn and bzr performance

scm-core/src/main/java/sonia/scm/web/security/AuthenticationResult.java

@@ -186,8 +186,35 @@ public class AuthenticationResult
     return user;
   }
 
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  public boolean isCacheable()
+  {
+    return cacheable;
+  }
+
+  //~--- set methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param cacheable
+   */
+  public void setCacheable(boolean cacheable)
+  {
+    this.cacheable = cacheable;
+  }
+
   //~--- fields ---------------------------------------------------------------
 
+  /** Field description */
+  private boolean cacheable = true;
+
   /** Field description */
   private Collection<String> groups;
 

scm-webapp/src/main/java/sonia/scm/web/security/ChainAuthenticatonManager.java

@@ -42,6 +42,9 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import sonia.scm.SCMContextProvider;
+import sonia.scm.cache.CacheManager;
+import sonia.scm.cache.SimpleCache;
+import sonia.scm.security.EncryptionHandler;
 import sonia.scm.user.User;
 import sonia.scm.util.AssertUtil;
 import sonia.scm.util.IOUtil;
@@ -63,6 +66,9 @@ import javax.servlet.http.HttpServletResponse;
 public class ChainAuthenticatonManager extends AbstractAuthenticationManager
 {
 
+  /** Field description */
+  public static final String CACHE_NAME = "sonia.cache.auth";
+
   /** the logger for ChainAuthenticatonManager */
   private static final Logger logger =
     LoggerFactory.getLogger(ChainAuthenticatonManager.class);
@@ -74,13 +80,20 @@ public class ChainAuthenticatonManager extends AbstractAuthenticationManager
    *
    *
    * @param authenticationHandlerSet
+   * @param encryptionHandler
+   * @param cacheManager
    */
   @Inject
   public ChainAuthenticatonManager(
-          Set<AuthenticationHandler> authenticationHandlerSet)
+          Set<AuthenticationHandler> authenticationHandlerSet,
+          EncryptionHandler encryptionHandler, CacheManager cacheManager)
   {
     AssertUtil.assertIsNotEmpty(authenticationHandlerSet);
+    AssertUtil.assertIsNotNull(cacheManager);
     this.authenticationHandlerSet = authenticationHandlerSet;
+    this.encryptionHandler = encryptionHandler;
+    this.cache = cacheManager.getSimpleCache(String.class,
+            AuthenticationCacheValue.class, CACHE_NAME);
   }
 
   //~--- methods --------------------------------------------------------------
@@ -99,6 +112,74 @@ public class ChainAuthenticatonManager extends AbstractAuthenticationManager
   @Override
   public AuthenticationResult authenticate(HttpServletRequest request,
           HttpServletResponse response, String username, String password)
+  {
+    AssertUtil.assertIsNotEmpty(username);
+    AssertUtil.assertIsNotEmpty(password);
+
+    String encryptedPassword = encryptionHandler.encrypt(password);
+    AuthenticationResult ar = getCached(username, encryptedPassword);
+
+    if (ar == null)
+    {
+      ar = doAuthentication(request, response, username, password);
+
+      if ((ar != null) && ar.isCacheable())
+      {
+        cache.put(username,
+                  new AuthenticationCacheValue(ar, encryptedPassword));
+      }
+    }
+    else if (logger.isDebugEnabled())
+    {
+      logger.debug("authenticate {} via cache", username);
+    }
+
+    return ar;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @throws IOException
+   */
+  @Override
+  public void close() throws IOException
+  {
+    for (AuthenticationHandler authenticator : authenticationHandlerSet)
+    {
+      IOUtil.close(authenticator);
+    }
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param context
+   */
+  @Override
+  public void init(SCMContextProvider context)
+  {
+    for (AuthenticationHandler authenticator : authenticationHandlerSet)
+    {
+      authenticator.init(context);
+    }
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param request
+   * @param response
+   * @param username
+   * @param password
+   *
+   * @return
+   */
+  private AuthenticationResult doAuthentication(HttpServletRequest request,
+          HttpServletResponse response, String username, String password)
   {
     AuthenticationResult ar = null;
 
@@ -142,38 +223,80 @@ public class ChainAuthenticatonManager extends AbstractAuthenticationManager
     return ar;
   }
 
-  /**
-   * Method description
-   *
-   *
-   * @throws IOException
-   */
-  @Override
-  public void close() throws IOException
-  {
-    for (AuthenticationHandler authenticator : authenticationHandlerSet)
-    {
-      IOUtil.close(authenticator);
-    }
-  }
+  //~--- get methods ----------------------------------------------------------
 
   /**
    * Method description
    *
    *
-   * @param context
+   * @param username
+   * @param encryptedPassword
+   *
+   * @return
    */
-  @Override
-  public void init(SCMContextProvider context)
+  private AuthenticationResult getCached(String username,
+          String encryptedPassword)
   {
-    for (AuthenticationHandler authenticator : authenticationHandlerSet)
+    AuthenticationResult result = null;
+    AuthenticationCacheValue value = cache.get(username);
+
+    if (value != null)
     {
-      authenticator.init(context);
+      String cachedPassword = value.password;
+
+      if (cachedPassword.equals(encryptedPassword))
+      {
+        result = value.authenticationResult;
       }
     }
 
+    return result;
+  }
+
+  //~--- inner classes --------------------------------------------------------
+
+  /**
+   * Class description
+   *
+   *
+   * @version        Enter version here..., 2011-01-15
+   * @author         Sebastian Sdorra
+   */
+  private static class AuthenticationCacheValue
+  {
+
+    /**
+     * Constructs ...
+     *
+     *
+     * @param authenticationResult
+     * @param password
+     */
+    public AuthenticationCacheValue(AuthenticationResult authenticationResult,
+                                    String password)
+    {
+      this.authenticationResult = authenticationResult;
+      this.password = password;
+    }
+
+    //~--- fields -------------------------------------------------------------
+
+    /** Field description */
+    private AuthenticationResult authenticationResult;
+
+    /** Field description */
+    private String password;
+  }
+
+
   //~--- fields ---------------------------------------------------------------
 
   /** Field description */
   private Set<AuthenticationHandler> authenticationHandlerSet;
+
+  /** Field description */
+  private SimpleCache<String, AuthenticationCacheValue> cache;
+
+  /** Field description */
+  private EncryptionHandler encryptionHandler;
 }

scm-webapp/src/main/resources/config/ehcache.xml

@@ -97,6 +97,16 @@
         diskExpiryThreadIntervalSeconds="2400"
   />
 
+  <cache
+        name="sonia.cache.auth"
+        maxElementsInMemory="200000"
+        eternal="false"
+        overflowToDisk="false"
+        timeToIdleSeconds="30"
+        timeToLiveSeconds="60"
+        diskPersistent="false"
+  />
+
   <cache
         name="sonia.cache.repository"
         maxElementsInMemory="20000"

scm-webapp/src/test/java/sonia/scm/web/security/ChainAuthenticationManagerTest.java

@@ -39,6 +39,9 @@ import org.junit.Test;
 
 import sonia.scm.AbstractTestBase;
 import sonia.scm.SCMContextProvider;
+import sonia.scm.cache.CacheManager;
+import sonia.scm.cache.EhCacheManager;
+import sonia.scm.security.MessageDigestEncryptionHandler;
 import sonia.scm.user.User;
 import sonia.scm.user.UserTestData;
 import sonia.scm.util.MockUtil;
@@ -69,8 +72,8 @@ public class ChainAuthenticationManagerTest extends AbstractTestBase
   @Test
   public void testAuthenticateFailed()
   {
-    AuthenticationResult result = manager.authenticate(request, response, trillian.getName(),
-                                     "trillian");
+    AuthenticationResult result = manager.authenticate(request, response,
+                                    trillian.getName(), "trillian");
 
     assertNull(result);
   }
@@ -82,7 +85,8 @@ public class ChainAuthenticationManagerTest extends AbstractTestBase
   @Test
   public void testAuthenticateNotFound()
   {
-    AuthenticationResult result = manager.authenticate(request, response, "dent", "trillian");
+    AuthenticationResult result = manager.authenticate(request, response,
+                                    "dent", "trillian");
 
     assertNull(result);
   }
@@ -94,8 +98,8 @@ public class ChainAuthenticationManagerTest extends AbstractTestBase
   @Test
   public void testAuthenticateSuccess()
   {
-    AuthenticationResult result = manager.authenticate(request, response, trillian.getName(),
-                                     "trillian123");
+    AuthenticationResult result = manager.authenticate(request, response,
+                                    trillian.getName(), "trillian123");
 
     assertNotNull(result);
     assertUserEquals(trillian, result.getUser());
@@ -126,7 +130,8 @@ public class ChainAuthenticationManagerTest extends AbstractTestBase
     trillian.setPassword("trillian123");
     handlerSet.add(new SingleUserAuthenticaionHandler("trilliansType",
             trillian));
-    manager = new ChainAuthenticatonManager(handlerSet);
+    manager = new ChainAuthenticatonManager(handlerSet,
+            new MessageDigestEncryptionHandler(), cacheManager);
     manager.init(contextProvider);
     request = MockUtil.getHttpServletRequest();
     response = MockUtil.getHttpServletResponse();
@@ -266,6 +271,9 @@ public class ChainAuthenticationManagerTest extends AbstractTestBase
 
   //~--- fields ---------------------------------------------------------------
 
+  /** Field description */
+  private CacheManager cacheManager = new EhCacheManager();
+
   /** Field description */
   private ChainAuthenticatonManager manager;