Forced authentication does not reset the AuthnInstant
[java-idp.git] / src / main / java / edu / internet2 / middleware / shibboleth / idp / authn / AuthenticationEngine.java
index 21d9b68..4bed051 100644 (file)
@@ -18,21 +18,22 @@ package edu.internet2.middleware.shibboleth.idp.authn;
 
 import java.io.IOException;
 import java.security.GeneralSecurityException;
-import java.security.NoSuchAlgorithmException;
+import java.security.MessageDigest;
 import java.security.Principal;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.Map.Entry;
 
-import javax.crypto.Mac;
-import javax.crypto.SecretKey;
 import javax.security.auth.Subject;
 import javax.servlet.RequestDispatcher;
 import javax.servlet.ServletConfig;
+import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
 import javax.servlet.http.Cookie;
 import javax.servlet.http.HttpServlet;
@@ -40,11 +41,10 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.joda.time.DateTime;
-import org.opensaml.common.IdentifierGenerator;
-import org.opensaml.common.impl.SecureRandomIdentifierGenerator;
 import org.opensaml.saml2.core.AuthnContext;
-import org.opensaml.util.storage.ExpiringObject;
+import org.opensaml.util.URLBuilder;
 import org.opensaml.util.storage.StorageService;
+import org.opensaml.ws.transport.http.HTTPTransportUtils;
 import org.opensaml.xml.util.Base64;
 import org.opensaml.xml.util.DatatypeHelper;
 import org.slf4j.Logger;
@@ -58,10 +58,23 @@ import edu.internet2.middleware.shibboleth.idp.session.ServiceInformation;
 import edu.internet2.middleware.shibboleth.idp.session.Session;
 import edu.internet2.middleware.shibboleth.idp.session.impl.AuthenticationMethodInformationImpl;
 import edu.internet2.middleware.shibboleth.idp.session.impl.ServiceInformationImpl;
+import edu.internet2.middleware.shibboleth.idp.util.HttpServletHelper;
 
 /** Manager responsible for handling authentication requests. */
 public class AuthenticationEngine extends HttpServlet {
 
+    /**
+     * Name of the Servlet config init parameter that indicates whether the public credentials of a {@link Subject} are
+     * retained after authentication.
+     */
+    public static final String RETAIN_PUBLIC_CREDENTIALS = "retainSubjectsPublicCredentials";
+
+    /**
+     * Name of the Servlet config init parameter that indicates whether the private credentials of a {@link Subject} are
+     * retained after authentication.
+     */
+    public static final String RETAIN_PRIVATE_CREDENTIALS = "retainSubjectsPrivateCredentials";
+
     /** Name of the Servlet config init parameter that holds the partition name for login contexts. */
     public static final String LOGIN_CONTEXT_PARTITION_NAME_INIT_PARAM_NAME = "loginContextPartitionName";
 
@@ -80,17 +93,17 @@ public class AuthenticationEngine extends HttpServlet {
     /** Class logger. */
     private static final Logger LOG = LoggerFactory.getLogger(AuthenticationEngine.class);
 
+    // TODO remove once HttpServletHelper does redirects
+    private static ServletContext context;
+
     /** Storage service used to store {@link LoginContext}s while authentication is in progress. */
     private static StorageService<String, LoginContextEntry> storageService;
 
-    /** Name of the storage service partition used to store login contexts. */
-    private static String loginContextPartitionName;
-
-    /** Lifetime of stored login contexts. */
-    private static long loginContextEntryLifetime;
+    /** Whether the public credentials of a {@link Subject} are retained after authentication. */
+    private boolean retainSubjectsPublicCredentials;
 
-    /** ID generator. */
-    private static IdentifierGenerator idGen;
+    /** Whether the private credentials of a {@link Subject} are retained after authentication. */
+    private boolean retainSubjectsPrivateCredentials;
 
     /** Profile handler manager. */
     private IdPProfileHandlerManager handlerManager;
@@ -102,114 +115,36 @@ public class AuthenticationEngine extends HttpServlet {
     public void init(ServletConfig config) throws ServletException {
         super.init(config);
 
-        String handlerManagerId = config.getInitParameter("handlerManagerId");
-        if (DatatypeHelper.isEmpty(handlerManagerId)) {
-            handlerManagerId = "shibboleth.HandlerManager";
-        }
-        handlerManager = (IdPProfileHandlerManager) getServletContext().getAttribute(handlerManagerId);
-
-        String sessionManagerId = config.getInitParameter("sessionManagedId");
-        if (DatatypeHelper.isEmpty(sessionManagerId)) {
-            sessionManagerId = "shibboleth.SessionManager";
-        }
-        sessionManager = (SessionManager<Session>) getServletContext().getAttribute(sessionManagerId);
-
-        String storageServiceId = config.getInitParameter("storageServiceId");
-        if (DatatypeHelper.isEmpty(storageServiceId)) {
-            storageServiceId = "shibboleth.StorageService";
-        }
-        storageService = (StorageService<String, LoginContextEntry>) getServletContext().getAttribute(storageServiceId);
-
-        String partitionName = DatatypeHelper.safeTrimOrNullString(config
-                .getInitParameter(LOGIN_CONTEXT_PARTITION_NAME_INIT_PARAM_NAME));
-        if (partitionName != null) {
-            loginContextPartitionName = partitionName;
-        } else {
-            loginContextPartitionName = "loginContexts";
-        }
-
-        String lifetime = DatatypeHelper.safeTrimOrNullString(config
-                .getInitParameter(LOGIN_CONTEXT_LIFETIME_INIT_PARAM_NAME));
-        if (lifetime != null) {
-            loginContextEntryLifetime = Long.parseLong(lifetime);
+        String retain = DatatypeHelper.safeTrimOrNullString(config.getInitParameter(RETAIN_PRIVATE_CREDENTIALS));
+        if (retain != null) {
+            retainSubjectsPrivateCredentials = Boolean.parseBoolean(retain);
         } else {
-            loginContextEntryLifetime = 1000 * 60 * 30;
-        }
-
-        try {
-            idGen = new SecureRandomIdentifierGenerator();
-        } catch (NoSuchAlgorithmException e) {
-            throw new ServletException("Error create random number generator", e);
-        }
-    }
-
-    /**
-     * Retrieves a login context.
-     * 
-     * @param httpRequest current HTTP request
-     * @param removeFromStorageService whether the login context should be removed from the storage service as it is
-     *            retrieved
-     * 
-     * @return the login context or null if one is not available (e.g. because it has expired)
-     */
-    protected static LoginContext retrieveLoginContext(HttpServletRequest httpRequest, boolean removeFromStorageService) {
-        // When the login context comes from the profile handlers its attached to the request
-        // Prior to the authentication engine handing control over to a login handler it stores
-        // the login context into the storage service so that the login handlers do not have to
-        // maintain a reference to the context and return it to the engine.
-        LoginContext loginContext = (LoginContext) httpRequest.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
-        if (loginContext != null) {
-            LOG.trace("Login context retrieved from HTTP request attribute");
-            return loginContext;
-        }
-
-        String contextId = DatatypeHelper.safeTrimOrNullString((String) httpRequest
-                .getAttribute(LOGIN_CONTEXT_KEY_NAME));
-
-        if (contextId == null) {
-            Cookie[] requestCookies = httpRequest.getCookies();
-            if (requestCookies != null) {
-                for (Cookie requestCookie : requestCookies) {
-                    if (DatatypeHelper.safeEquals(requestCookie.getName(), LOGIN_CONTEXT_KEY_NAME)) {
-                        LOG.trace("Located cookie with login context key");
-                        contextId = requestCookie.getValue();
-                        break;
-                    }
-                }
-            }
+            retainSubjectsPrivateCredentials = false;
         }
 
-        LOG.trace("Using login context key {} to look up login context", contextId);
-        LoginContextEntry entry;
-        if (removeFromStorageService) {
-            entry = storageService.remove(loginContextPartitionName, contextId);
+        retain = DatatypeHelper.safeTrimOrNullString(config.getInitParameter(RETAIN_PUBLIC_CREDENTIALS));
+        if (retain != null) {
+            retainSubjectsPublicCredentials = Boolean.parseBoolean(retain);
         } else {
-            entry = storageService.get(loginContextPartitionName, contextId);
-        }
-        if (entry == null) {
-            LOG.trace("No entry for login context found in storage service.");
-            return null;
-        } else if (entry.isExpired()) {
-            LOG.trace("Login context entry found in storage service but it was expired.");
-            return null;
-        } else {
-            LOG.trace("Login context entry found in storage service.");
-            return entry.getLoginContext();
+            retainSubjectsPublicCredentials = false;
         }
+        context = config.getServletContext();
+        handlerManager = HttpServletHelper.getProfileHandlerManager(context);
+        sessionManager = HttpServletHelper.getSessionManager(context);
+        storageService = (StorageService<String, LoginContextEntry>) HttpServletHelper.getStorageService(context);
     }
 
-    /**
-     * Returns control back to the authentication engine.
+    /* Returns control back to the authentication engine.
      * 
      * @param httpRequest current HTTP request
      * @param httpResponse current HTTP response
      */
     public static void returnToAuthenticationEngine(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
         LOG.debug("Returning control to authentication engine");
-        LoginContext loginContext = retrieveLoginContext(httpRequest, false);
+        LoginContext loginContext = HttpServletHelper.getLoginContext(storageService, context, httpRequest);
         if (loginContext == null) {
-            LOG.error("No login context available, unable to return to authentication engine");
-            forwardRequest("/idp-error.jsp", httpRequest, httpResponse);
+            LOG.warn("No login context available, unable to return to authentication engine");
+            forwardRequest("/error.jsp", httpRequest, httpResponse);
         } else {
             forwardRequest(loginContext.getAuthenticationEngineURL(), httpRequest, httpResponse);
         }
@@ -218,21 +153,25 @@ public class AuthenticationEngine extends HttpServlet {
     /**
      * Returns control back to the profile handler that invoked the authentication engine.
      * 
-     * @param loginContext current login context
      * @param httpRequest current HTTP request
      * @param httpResponse current HTTP response
      */
-    public static void returnToProfileHandler(LoginContext loginContext, HttpServletRequest httpRequest,
-            HttpServletResponse httpResponse) {
-        LOG.debug("Returning control to profile handler at: {}", loginContext.getProfileHandlerURL());
-        httpRequest.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
-
-        // Cleanup this cookie
-        Cookie lcKeyCookie = new Cookie(LOGIN_CONTEXT_KEY_NAME, "");
-        lcKeyCookie.setMaxAge(0);
-        httpResponse.addCookie(lcKeyCookie);
+    public static void returnToProfileHandler(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
+        LOG.debug("Returning control to profile handler");
+        LoginContext loginContext = HttpServletHelper.getLoginContext(storageService, context, httpRequest);
+        if (loginContext == null) {
+            LOG.warn("No login context available, unable to return to profile handler");
+            forwardRequest("/error.jsp", httpRequest, httpResponse);
+        }
 
-        forwardRequest(loginContext.getProfileHandlerURL(), httpRequest, httpResponse);
+        String profileUrl = HttpServletHelper.getContextRelativeUrl(httpRequest, loginContext.getProfileHandlerURL())
+                .buildURL();
+        LOG.debug("Redirecting user to profile handler at {}", profileUrl);
+        try {
+            httpResponse.sendRedirect(profileUrl);
+        } catch (IOException e) {
+            LOG.warn("Error sending user back to profile handler at " + profileUrl, e);
+        }
     }
 
     /**
@@ -265,7 +204,7 @@ public class AuthenticationEngine extends HttpServlet {
             LOG.error("HTTP Response already committed");
         }
 
-        LoginContext loginContext = retrieveLoginContext(httpRequest, true);
+        LoginContext loginContext = HttpServletHelper.getLoginContext(storageService, getServletContext(), httpRequest);
         if (loginContext == null) {
             LOG.error("Incoming request does not have attached login context");
             throw new ServletException("Incoming request does not have attached login context");
@@ -289,15 +228,14 @@ public class AuthenticationEngine extends HttpServlet {
      */
     protected void startUserAuthentication(LoginContext loginContext, HttpServletRequest httpRequest,
             HttpServletResponse httpResponse) {
-        LOG.debug("Beginning user authentication process");
+        LOG.debug("Beginning user authentication process.");
         try {
             Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
             if (idpSession != null) {
                 LOG.debug("Existing IdP session available for principal {}", idpSession.getPrincipalName());
             }
 
-            Map<String, LoginHandler> possibleLoginHandlers = determinePossibleLoginHandlers(loginContext);
-            LOG.debug("Possible authentication handlers for this request: {}", possibleLoginHandlers);
+            Map<String, LoginHandler> possibleLoginHandlers = determinePossibleLoginHandlers(idpSession, loginContext);
 
             // Filter out possible candidate login handlers by forced and passive authentication requirements
             if (loginContext.isForceAuthRequired()) {
@@ -308,29 +246,17 @@ public class AuthenticationEngine extends HttpServlet {
                 filterByPassiveAuthentication(idpSession, loginContext, possibleLoginHandlers);
             }
 
-            // If the user already has a session and its usage is acceptable than use it
-            // otherwise just use the first candidate login handler
-            LOG.debug("Possible authentication handlers after filtering: {}", possibleLoginHandlers);
-            LoginHandler loginHandler;
-            if (idpSession != null && possibleLoginHandlers.containsKey(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX)) {
-                loginContext.setAttemptedAuthnMethod(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
-                loginHandler = possibleLoginHandlers.get(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
-            } else {
-                possibleLoginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
-                Entry<String, LoginHandler> chosenLoginHandler = possibleLoginHandlers.entrySet().iterator().next();
-                loginContext.setAttemptedAuthnMethod(chosenLoginHandler.getKey());
-                loginHandler = chosenLoginHandler.getValue();
-            }
-
-            // Send the request to the login handler
-            LOG.debug("Authenticating user with login handler of type {}", loginHandler.getClass().getName());
+            LoginHandler loginHandler = selectLoginHandler(possibleLoginHandlers, loginContext, idpSession);
             loginContext.setAuthenticationAttempted();
             loginContext.setAuthenticationEngineURL(HttpHelper.getRequestUriWithoutContext(httpRequest));
-            storeLoginContext(loginContext, httpRequest, httpResponse);
+
+            // Send the request to the login handler
+            HttpServletHelper.bindLoginContext(loginContext, storageService, getServletContext(), httpRequest,
+                    httpResponse);
             loginHandler.login(httpRequest, httpResponse);
         } catch (AuthenticationException e) {
             loginContext.setAuthenticationFailure(e);
-            returnToProfileHandler(loginContext, httpRequest, httpResponse);
+            returnToProfileHandler(httpRequest, httpResponse);
         }
     }
 
@@ -338,39 +264,42 @@ public class AuthenticationEngine extends HttpServlet {
      * Determines which configured login handlers will support the requested authentication methods.
      * 
      * @param loginContext current login context
+     * @param idpSession current user's session, or null if they don't have one
      * 
      * @return login methods that may be used to authenticate the user
      * 
      * @throws AuthenticationException thrown if no login handler meets the given requirements
      */
-    protected Map<String, LoginHandler> determinePossibleLoginHandlers(LoginContext loginContext)
+    protected Map<String, LoginHandler> determinePossibleLoginHandlers(Session idpSession, LoginContext loginContext)
             throws AuthenticationException {
-        Map<String, LoginHandler> supportedLoginHandlers = new HashMap<String, LoginHandler>(handlerManager
-                .getLoginHandlers());
-        LOG.trace("Supported login handlers: {}", supportedLoginHandlers);
-        LOG.trace("Requested authentication methods: {}", loginContext.getRequestedAuthenticationMethods());
-
-        // If no preferences Authn method preference is given, then we're free to use any
-        if (loginContext.getRequestedAuthenticationMethods().isEmpty()) {
-            LOG.trace("No preference given for authentication methods");
-            return supportedLoginHandlers;
-        }
-
-        // Otherwise we need to filter all the mechanism supported by the IdP so that only the request types are left
-        // Previous session handler is a special case, we always to keep that around if it's configured
-        Iterator<Entry<String, LoginHandler>> supportedLoginHandlerItr = supportedLoginHandlers.entrySet().iterator();
-        Entry<String, LoginHandler> supportedLoginHandler;
-        while (supportedLoginHandlerItr.hasNext()) {
-            supportedLoginHandler = supportedLoginHandlerItr.next();
-            if (!supportedLoginHandler.getKey().equals(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX)
-                    && !loginContext.getRequestedAuthenticationMethods().contains(supportedLoginHandler.getKey())) {
-                supportedLoginHandlerItr.remove();
-                continue;
+        Map<String, LoginHandler> supportedLoginHandlers = new HashMap<String, LoginHandler>(
+                handlerManager.getLoginHandlers());
+        LOG.debug("Filtering configured LoginHandlers: {}", supportedLoginHandlers);
+
+        // First, if the service provider requested a particular authentication method, filter out everything but
+        List<String> requestedMethods = loginContext.getRequestedAuthenticationMethods();
+        if (requestedMethods != null && !requestedMethods.isEmpty()) {
+            LOG.debug("Filtering possible login handlers by requested authentication methods: {}", requestedMethods);
+            Iterator<Entry<String, LoginHandler>> supportedLoginHandlerItr = supportedLoginHandlers.entrySet()
+                    .iterator();
+            Entry<String, LoginHandler> supportedLoginHandlerEntry;
+            while (supportedLoginHandlerItr.hasNext()) {
+                supportedLoginHandlerEntry = supportedLoginHandlerItr.next();
+                if (!supportedLoginHandlerEntry.getKey().equals(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX)
+                        && !requestedMethods.contains(supportedLoginHandlerEntry.getKey())) {
+                    LOG.debug(
+                            "Filtering out login handler for authentication {}, it does not provide a requested authentication method",
+                            supportedLoginHandlerEntry.getKey());
+                    supportedLoginHandlerItr.remove();
+                }
             }
         }
 
+        // Next, determine, if present, if the previous session handler can be used
+        filterPreviousSessionLoginHandler(supportedLoginHandlers, idpSession, loginContext);
+
         if (supportedLoginHandlers.isEmpty()) {
-            LOG.error("No authentication method, requested by the service provider, is supported");
+            LOG.warn("No authentication method, requested by the service provider, is supported");
             throw new AuthenticationException(
                     "No authentication method, requested by the service provider, is supported");
         }
@@ -379,6 +308,61 @@ public class AuthenticationEngine extends HttpServlet {
     }
 
     /**
+     * Filters out the previous session login handler if there is no existing IdP session, no active authentication
+     * methods, or if at least one of the active authentication methods do not match the requested authentication
+     * methods.
+     * 
+     * @param supportedLoginHandlers login handlers supported by the authentication engine for this request, never null
+     * @param idpSession current IdP session, may be null if no session currently exists
+     * @param loginContext current login context, never null
+     */
+    protected void filterPreviousSessionLoginHandler(Map<String, LoginHandler> supportedLoginHandlers,
+            Session idpSession, LoginContext loginContext) {
+        if (!supportedLoginHandlers.containsKey(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX)) {
+            return;
+        }
+
+        if (idpSession == null) {
+            LOG.debug("Filtering out previous session login handler because there is no existing IdP session");
+            supportedLoginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
+            return;
+        }
+        Collection<AuthenticationMethodInformation> currentAuthnMethods = idpSession.getAuthenticationMethods()
+                .values();
+
+        Iterator<AuthenticationMethodInformation> methodItr = currentAuthnMethods.iterator();
+        while (methodItr.hasNext()) {
+            AuthenticationMethodInformation info = methodItr.next();
+            if (info.isExpired()) {
+                methodItr.remove();
+            }
+        }
+        if (currentAuthnMethods.isEmpty()) {
+            LOG.debug("Filtering out previous session login handler because there are no active authentication methods");
+            supportedLoginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
+            return;
+        }
+
+        List<String> requestedMethods = loginContext.getRequestedAuthenticationMethods();
+        if (requestedMethods != null && !requestedMethods.isEmpty()) {
+            boolean retainPreviousSession = false;
+            for (AuthenticationMethodInformation currentAuthnMethod : currentAuthnMethods) {
+                if (loginContext.getRequestedAuthenticationMethods().contains(
+                        currentAuthnMethod.getAuthenticationMethod())) {
+                    retainPreviousSession = true;
+                    break;
+                }
+            }
+
+            if (!retainPreviousSession) {
+                LOG.debug("Filtering out previous session login handler, no active authentication methods match required methods");
+                supportedLoginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
+                return;
+            }
+        }
+    }
+
+    /**
      * Filters out any login handler based on the requirement for forced authentication.
      * 
      * During forced authentication any handler that has not previously been used to authenticate the user or any
@@ -406,6 +390,8 @@ public class AuthenticationEngine extends HttpServlet {
             loginHandler = loginHandlers.get(activeMethod.getAuthenticationMethod());
             if (loginHandler != null && !loginHandler.supportsForceAuthentication()) {
                 for (String handlerSupportedMethods : loginHandler.getSupportedAuthenticationMethods()) {
+                    LOG.debug("Removing LoginHandler {}, it does not support forced re-authentication", loginHandler
+                            .getClass().getName());
                     loginHandlers.remove(handlerSupportedMethods);
                 }
             }
@@ -451,38 +437,59 @@ public class AuthenticationEngine extends HttpServlet {
                 loginHandlers);
 
         if (loginHandlers.isEmpty()) {
-            LOG.error("Passive authentication required but no login handlers available to support it");
+            LOG.warn("Passive authentication required but no login handlers available to support it");
             throw new PassiveAuthenticationException();
         }
     }
 
     /**
-     * Stores the login context in the storage service. The key for the stored login context is then bound to an HTTP
-     * request attribute and set a cookie.
+     * Selects a login handler from a list of possible login handlers that could be used for the request.
      * 
-     * @param loginContext login context to store
-     * @param httpRequest current HTTP request
-     * @param httpResponse current HTTP response
+     * @param possibleLoginHandlers list of possible login handlers that could be used for the request
+     * @param loginContext current login context
+     * @param idpSession current IdP session, if one exists
+     * 
+     * @return the login handler to use for this request
+     * 
+     * @throws AuthenticationException thrown if no handler can be used for this request
      */
-    protected void storeLoginContext(LoginContext loginContext, HttpServletRequest httpRequest,
-            HttpServletResponse httpResponse) {
-        String contextId = idGen.generateIdentifier();
+    protected LoginHandler selectLoginHandler(Map<String, LoginHandler> possibleLoginHandlers,
+            LoginContext loginContext, Session idpSession) throws AuthenticationException {
+        LOG.debug("Selecting appropriate login handler from filtered set {}", possibleLoginHandlers);
+        LoginHandler loginHandler;
+        if (idpSession != null && possibleLoginHandlers.containsKey(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX)) {
+            LOG.debug("Authenticating user with previous session LoginHandler");
+            loginHandler = possibleLoginHandlers.get(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
 
-        storageService.put(loginContextPartitionName, contextId, new LoginContextEntry(loginContext,
-                loginContextEntryLifetime));
+            for (AuthenticationMethodInformation authnMethod : idpSession.getAuthenticationMethods().values()) {
+                if (authnMethod.isExpired()) {
+                    continue;
+                }
 
-        httpRequest.setAttribute(LOGIN_CONTEXT_KEY_NAME, contextId);
+                if (loginContext.getRequestedAuthenticationMethods().isEmpty()
+                        || loginContext.getRequestedAuthenticationMethods().contains(
+                                authnMethod.getAuthenticationMethod())) {
+                    LOG.debug("Basing previous session authentication on active authentication method {}",
+                            authnMethod.getAuthenticationMethod());
+                    loginContext.setAttemptedAuthnMethod(authnMethod.getAuthenticationMethod());
+                    loginContext.setAuthenticationMethodInformation(authnMethod);
+                    return loginHandler;
+                }
+            }
+        }
 
-        Cookie cookie = new Cookie(LOGIN_CONTEXT_KEY_NAME, contextId);
-        String contextPath = httpRequest.getContextPath();
-        if (DatatypeHelper.isEmpty(contextPath)) {
-            cookie.setPath("/");
+        if (loginContext.getDefaultAuthenticationMethod() != null
+                && possibleLoginHandlers.containsKey(loginContext.getDefaultAuthenticationMethod())) {
+            loginHandler = possibleLoginHandlers.get(loginContext.getDefaultAuthenticationMethod());
+            loginContext.setAttemptedAuthnMethod(loginContext.getDefaultAuthenticationMethod());
         } else {
-            cookie.setPath(contextPath);
+            Entry<String, LoginHandler> chosenLoginHandler = possibleLoginHandlers.entrySet().iterator().next();
+            loginContext.setAttemptedAuthnMethod(chosenLoginHandler.getKey());
+            loginHandler = chosenLoginHandler.getValue();
         }
-        cookie.setSecure(httpRequest.isSecure());
-        cookie.setMaxAge(-1);
-        httpResponse.addCookie(cookie);
+
+        LOG.debug("Authenticating user with login handler of type {}", loginHandler.getClass().getName());
+        return loginHandler;
     }
 
     /**
@@ -503,34 +510,52 @@ public class AuthenticationEngine extends HttpServlet {
         Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
 
         try {
-            // Check to make sure the login handler did the right thing
-            validateSuccessfulAuthentication(loginContext, httpRequest);
-
             // We allow a login handler to override the authentication method in the
             // event that it supports multiple methods
             String actualAuthnMethod = DatatypeHelper.safeTrimOrNullString((String) httpRequest
                     .getAttribute(LoginHandler.AUTHENTICATION_METHOD_KEY));
-            if (actualAuthnMethod == null) {
+            if (actualAuthnMethod != null) {
+                if (!loginContext.getRequestedAuthenticationMethods().isEmpty()
+                        && !loginContext.getRequestedAuthenticationMethods().contains(actualAuthnMethod)) {
+                    String msg = "Relying patry required an authentication method of "
+                            + loginContext.getRequestedAuthenticationMethods() + " but the login handler performed "
+                            + actualAuthnMethod;
+                    LOG.error(msg);
+                    throw new AuthenticationException(msg);
+                }
+            } else {
                 actualAuthnMethod = loginContext.getAttemptedAuthnMethod();
             }
+            
+            // Check to make sure the login handler did the right thing
+            validateSuccessfulAuthentication(loginContext, httpRequest, actualAuthnMethod);
+
+            // Check for an overridden authn instant.
+            DateTime actualAuthnInstant = (DateTime) httpRequest.getAttribute(LoginHandler.AUTHENTICATION_INSTANT_KEY);
 
             // Get the Subject from the request. If force authentication was required then make sure the
             // Subject identifies the same user that authenticated before
             Subject subject = getLoginHandlerSubject(httpRequest);
             if (loginContext.isForceAuthRequired()) {
                 validateForcedReauthentication(idpSession, actualAuthnMethod, subject);
+                
+                // Reset the authn instant.
+                if (actualAuthnInstant == null) {
+                    actualAuthnInstant = new DateTime();
+                }
             }
 
             loginContext.setPrincipalAuthenticated(true);
-            updateUserSession(loginContext, subject, actualAuthnMethod, httpRequest, httpResponse);
-            LOG.debug("User {} authenticated with method {}", loginContext.getPrincipalName(), actualAuthnMethod);
+            updateUserSession(loginContext, subject, actualAuthnMethod, actualAuthnInstant, httpRequest, httpResponse);
+            LOG.debug("User {} authenticated with method {}", loginContext.getPrincipalName(),
+                    loginContext.getAuthenticationMethod());
         } catch (AuthenticationException e) {
             LOG.error("Authentication failed with the error:", e);
             loginContext.setPrincipalAuthenticated(false);
             loginContext.setAuthenticationFailure(e);
         }
 
-        returnToProfileHandler(loginContext, httpRequest, httpResponse);
+        returnToProfileHandler(httpRequest, httpResponse);
     }
 
     /**
@@ -541,19 +566,33 @@ public class AuthenticationEngine extends HttpServlet {
      * 
      * @param loginContext current login context
      * @param httpRequest current HTTP request
+     * @param authenticationMethod the authentication method used to authenticate the user
      * 
      * @throws AuthenticationException thrown if the authentication was not successful
      */
-    protected void validateSuccessfulAuthentication(LoginContext loginContext, HttpServletRequest httpRequest)
-            throws AuthenticationException {
+    protected void validateSuccessfulAuthentication(LoginContext loginContext, HttpServletRequest httpRequest,
+            String authenticationMethod) throws AuthenticationException {
+        LOG.debug("Validating authentication was performed successfully");
+
+        if (authenticationMethod == null) {
+            LOG.error("No authentication method reported by login handler.");
+            throw new AuthenticationException("No authentication method reported by login handler.");
+        }
+
         String errorMessage = DatatypeHelper.safeTrimOrNullString((String) httpRequest
                 .getAttribute(LoginHandler.AUTHENTICATION_ERROR_KEY));
         if (errorMessage != null) {
-            LOG.error("Error returned from login handler for authentication method {}:\n{}", loginContext
-                    .getAttemptedAuthnMethod(), errorMessage);
+            LOG.error("Error returned from login handler for authentication method {}:\n{}",
+                    loginContext.getAttemptedAuthnMethod(), errorMessage);
             throw new AuthenticationException(errorMessage);
         }
 
+        AuthenticationException authnException = (AuthenticationException) httpRequest
+                .getAttribute(LoginHandler.AUTHENTICATION_EXCEPTION_KEY);
+        if (authnException != null) {
+            throw authnException;
+        }
+
         Subject subject = (Subject) httpRequest.getAttribute(LoginHandler.SUBJECT_KEY);
         Principal principal = (Principal) httpRequest.getAttribute(LoginHandler.PRINCIPAL_KEY);
         String principalName = DatatypeHelper.safeTrimOrNullString((String) httpRequest
@@ -630,13 +669,15 @@ public class AuthenticationEngine extends HttpServlet {
      * @param loginContext current login context
      * @param authenticationSubject subject created from the authentication method
      * @param authenticationMethod the method used to authenticate the subject
+     * @param authenticationInstant the time of authentication
      * @param httpRequest current HTTP request
      * @param httpResponse current HTTP response
      */
     protected void updateUserSession(LoginContext loginContext, Subject authenticationSubject,
-            String authenticationMethod, HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
-
+            String authenticationMethod, DateTime authenticationInstant,
+            HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
         Principal authenticationPrincipal = authenticationSubject.getPrincipals().iterator().next();
+        LOG.debug("Updating session information for principal {}", authenticationPrincipal.getName());
 
         Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
         if (idpSession == null) {
@@ -650,12 +691,22 @@ public class AuthenticationEngine extends HttpServlet {
         // login handler subject
         idpSession.setSubject(mergeSubjects(idpSession.getSubject(), authenticationSubject));
 
-        LOG.debug("Recording authentication and service information in Shibboleth session for principal: {}",
-                authenticationPrincipal.getName());
-        LoginHandler loginHandler = handlerManager.getLoginHandlers().get(authenticationMethod);
-        AuthenticationMethodInformation authnMethodInfo = new AuthenticationMethodInformationImpl(idpSession
-                .getSubject(), authenticationPrincipal, authenticationMethod, new DateTime(), loginHandler
-                .getAuthenticationDuration());
+        // Check if an existing authentication method with no updated timestamp was used (i.e. SSO occurred);
+        // if not record the new information
+        AuthenticationMethodInformation authnMethodInfo = idpSession.getAuthenticationMethods().get(
+                authenticationMethod);
+        if (authnMethodInfo == null || authenticationInstant != null) {
+            LOG.debug("Recording authentication and service information in Shibboleth session for principal: {}",
+                    authenticationPrincipal.getName());
+            LoginHandler loginHandler = handlerManager.getLoginHandlers().get(loginContext.getAttemptedAuthnMethod());
+            authnMethodInfo = new AuthenticationMethodInformationImpl(
+                    idpSession.getSubject(),
+                    authenticationPrincipal,
+                    authenticationMethod,
+                    (authenticationInstant != null ? authenticationInstant : new DateTime()),
+                    loginHandler.getAuthenticationDuration()
+                    );
+        }
 
         loginContext.setAuthenticationMethodInformation(authnMethodInfo);
         idpSession.getAuthenticationMethods().put(authnMethodInfo.getAuthenticationMethod(), authnMethodInfo);
@@ -667,7 +718,11 @@ public class AuthenticationEngine extends HttpServlet {
     }
 
     /**
-     * Merges the principals and public and private credentials from two subjects into a new subject.
+     * Merges the two {@link Subject}s in to a new {@link Subject}. The new subjects contains all the {@link Principal}s
+     * from both subjects. If {@link #retainSubjectsPrivateCredentials} is true then the new subject will contain all
+     * the private credentials from both subjects, if not the new subject will not contain private credentials. If
+     * {@link #retainSubjectsPublicCredentials} is true then the new subject will contain all the public credentials
+     * from both subjects, if not the new subject will not contain public credentials.
      * 
      * @param subject1 first subject to merge, may be null
      * @param subject2 second subject to merge, may be null
@@ -675,6 +730,10 @@ public class AuthenticationEngine extends HttpServlet {
      * @return subject containing the merged information
      */
     protected Subject mergeSubjects(Subject subject1, Subject subject2) {
+        if (subject1 == null && subject2 == null) {
+            return new Subject();
+        }
+
         if (subject1 == null) {
             return subject2;
         }
@@ -683,21 +742,23 @@ public class AuthenticationEngine extends HttpServlet {
             return subject1;
         }
 
-        if (subject1 == null && subject2 == null) {
-            return new Subject();
-        }
-
-        Set<Principal> principals = new HashSet<Principal>();
+        Set<Principal> principals = new HashSet<Principal>(3);
         principals.addAll(subject1.getPrincipals());
         principals.addAll(subject2.getPrincipals());
 
-        Set<Object> publicCredentials = new HashSet<Object>();
-        publicCredentials.addAll(subject1.getPublicCredentials());
-        publicCredentials.addAll(subject2.getPublicCredentials());
+        Set<Object> publicCredentials = new HashSet<Object>(3);
+        if (retainSubjectsPublicCredentials) {
+            LOG.debug("Merging in subjects public credentials");
+            publicCredentials.addAll(subject1.getPublicCredentials());
+            publicCredentials.addAll(subject2.getPublicCredentials());
+        }
 
-        Set<Object> privateCredentials = new HashSet<Object>();
-        privateCredentials.addAll(subject1.getPrivateCredentials());
-        privateCredentials.addAll(subject2.getPrivateCredentials());
+        Set<Object> privateCredentials = new HashSet<Object>(3);
+        if (retainSubjectsPrivateCredentials) {
+            LOG.debug("Merging in subjects private credentials");
+            privateCredentials.addAll(subject1.getPrivateCredentials());
+            privateCredentials.addAll(subject2.getPrivateCredentials());
+        }
 
         return new Subject(false, principals, publicCredentials, privateCredentials);
     }
@@ -717,77 +778,31 @@ public class AuthenticationEngine extends HttpServlet {
         byte[] sessionId = userSession.getSessionID().getBytes();
 
         String signature = null;
-        SecretKey signingKey = userSession.getSessionSecretKey();
         try {
-            Mac mac = Mac.getInstance("HmacSHA256");
-            mac.init(signingKey);
-            mac.update(remoteAddress);
-            mac.update(sessionId);
-            signature = Base64.encodeBytes(mac.doFinal());
+            MessageDigest digester = MessageDigest.getInstance("SHA");
+            digester.update(userSession.getSessionSecret());
+            digester.update(remoteAddress);
+            digester.update(sessionId);
+            signature = Base64.encodeBytes(digester.digest());
         } catch (GeneralSecurityException e) {
             LOG.error("Unable to compute signature over session cookie material", e);
         }
 
         LOG.debug("Adding IdP session cookie to HTTP response");
-        Cookie sessionCookie = new Cookie(IDP_SESSION_COOKIE_NAME, Base64.encodeBytes(remoteAddress,
-                Base64.DONT_BREAK_LINES)
-                + "|" + Base64.encodeBytes(sessionId, Base64.DONT_BREAK_LINES) + "|" + signature);
+        StringBuilder cookieValue = new StringBuilder();
+        cookieValue.append(Base64.encodeBytes(remoteAddress, Base64.DONT_BREAK_LINES)).append("|");
+        cookieValue.append(Base64.encodeBytes(sessionId, Base64.DONT_BREAK_LINES)).append("|");
+        cookieValue.append(signature);
 
-        String contextPath = httpRequest.getContextPath();
-        if (DatatypeHelper.isEmpty(contextPath)) {
-            sessionCookie.setPath("/");
-        } else {
-            sessionCookie.setPath(contextPath);
-        }
+        String cookieDomain = HttpServletHelper.getCookieDomain(context);
 
+        Cookie sessionCookie = new Cookie(IDP_SESSION_COOKIE_NAME, HTTPTransportUtils.urlEncode(cookieValue.toString()));
+        sessionCookie.setVersion(1);
+        if (cookieDomain != null) {
+            sessionCookie.setDomain(cookieDomain);
+        }
+        sessionCookie.setPath("".equals(httpRequest.getContextPath()) ? "/" : httpRequest.getContextPath());
         sessionCookie.setSecure(httpRequest.isSecure());
-        sessionCookie.setMaxAge(-1);
-
         httpResponse.addCookie(sessionCookie);
     }
-
-    /** Storage service entry for login contexts. */
-    public class LoginContextEntry implements ExpiringObject {
-
-        /** Stored login context. */
-        private LoginContext loginCtx;
-
-        /** Time the entry expires. */
-        private DateTime expirationTime;
-
-        /**
-         * Constructor.
-         * 
-         * @param ctx context to store
-         * @param lifetime lifetime of the entry
-         */
-        public LoginContextEntry(LoginContext ctx, long lifetime) {
-            loginCtx = ctx;
-            expirationTime = new DateTime().plus(lifetime);
-        }
-
-        /**
-         * Gets the login context.
-         * 
-         * @return login context
-         */
-        public LoginContext getLoginContext() {
-            return loginCtx;
-        }
-
-        /** {@inheritDoc} */
-        public DateTime getExpirationTime() {
-            return expirationTime;
-        }
-
-        /** {@inheritDoc} */
-        public boolean isExpired() {
-            return expirationTime.isBeforeNow();
-        }
-
-        /** {@inheritDoc} */
-        public void onExpire() {
-
-        }
-    }
 }
\ No newline at end of file