Prevous session is used if the user has an existing session but the SP requests an...
[java-idp.git] / src / main / java / edu / internet2 / middleware / shibboleth / idp / authn / AuthenticationEngine.java
1 /*
2  * Copyright 2006 University Corporation for Advanced Internet Development, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package edu.internet2.middleware.shibboleth.idp.authn;
18
19 import java.io.IOException;
20 import java.security.GeneralSecurityException;
21 import java.security.MessageDigest;
22 import java.security.NoSuchAlgorithmException;
23 import java.security.Principal;
24 import java.util.ArrayList;
25 import java.util.HashMap;
26 import java.util.HashSet;
27 import java.util.Iterator;
28 import java.util.Map;
29 import java.util.Set;
30 import java.util.Map.Entry;
31
32 import javax.security.auth.Subject;
33 import javax.servlet.RequestDispatcher;
34 import javax.servlet.ServletConfig;
35 import javax.servlet.ServletException;
36 import javax.servlet.http.Cookie;
37 import javax.servlet.http.HttpServlet;
38 import javax.servlet.http.HttpServletRequest;
39 import javax.servlet.http.HttpServletResponse;
40
41 import org.joda.time.DateTime;
42 import org.opensaml.common.IdentifierGenerator;
43 import org.opensaml.common.impl.SecureRandomIdentifierGenerator;
44 import org.opensaml.saml2.core.AuthnContext;
45 import org.opensaml.util.storage.StorageService;
46 import org.opensaml.ws.transport.http.HTTPTransportUtils;
47 import org.opensaml.xml.util.Base64;
48 import org.opensaml.xml.util.DatatypeHelper;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
51
52 import edu.internet2.middleware.shibboleth.common.session.SessionManager;
53 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
54 import edu.internet2.middleware.shibboleth.idp.profile.IdPProfileHandlerManager;
55 import edu.internet2.middleware.shibboleth.idp.session.AuthenticationMethodInformation;
56 import edu.internet2.middleware.shibboleth.idp.session.ServiceInformation;
57 import edu.internet2.middleware.shibboleth.idp.session.Session;
58 import edu.internet2.middleware.shibboleth.idp.session.impl.AuthenticationMethodInformationImpl;
59 import edu.internet2.middleware.shibboleth.idp.session.impl.ServiceInformationImpl;
60
61 /** Manager responsible for handling authentication requests. */
62 public class AuthenticationEngine extends HttpServlet {
63
64     /** Name of the Servlet config init parameter that holds the partition name for login contexts. */
65     public static final String LOGIN_CONTEXT_PARTITION_NAME_INIT_PARAM_NAME = "loginContextPartitionName";
66
67     /** Name of the Servlet config init parameter that holds lifetime of a login context in the storage service. */
68     public static final String LOGIN_CONTEXT_LIFETIME_INIT_PARAM_NAME = "loginContextEntryLifetime";
69
70     /** Name of the IdP Cookie containing the IdP session ID. */
71     public static final String IDP_SESSION_COOKIE_NAME = "_idp_session";
72
73     /** Name of the key under which to bind the storage service key for a login context. */
74     public static final String LOGIN_CONTEXT_KEY_NAME = "_idp_authn_lc_key";
75
76     /** Serial version UID. */
77     private static final long serialVersionUID = -8479060989001890156L;
78
79     /** Class logger. */
80     private static final Logger LOG = LoggerFactory.getLogger(AuthenticationEngine.class);
81
82     /** Storage service used to store {@link LoginContext}s while authentication is in progress. */
83     private static StorageService<String, LoginContextEntry> storageService;
84
85     /** Name of the storage service partition used to store login contexts. */
86     private static String loginContextPartitionName;
87
88     /** Lifetime of stored login contexts. */
89     private static long loginContextEntryLifetime;
90
91     /** ID generator. */
92     private static IdentifierGenerator idGen;
93
94     /** Profile handler manager. */
95     private IdPProfileHandlerManager handlerManager;
96
97     /** Session manager. */
98     private SessionManager<Session> sessionManager;
99
100     /** {@inheritDoc} */
101     public void init(ServletConfig config) throws ServletException {
102         super.init(config);
103
104         String handlerManagerId = config.getInitParameter("handlerManagerId");
105         if (DatatypeHelper.isEmpty(handlerManagerId)) {
106             handlerManagerId = "shibboleth.HandlerManager";
107         }
108         handlerManager = (IdPProfileHandlerManager) getServletContext().getAttribute(handlerManagerId);
109
110         String sessionManagerId = config.getInitParameter("sessionManagedId");
111         if (DatatypeHelper.isEmpty(sessionManagerId)) {
112             sessionManagerId = "shibboleth.SessionManager";
113         }
114         sessionManager = (SessionManager<Session>) getServletContext().getAttribute(sessionManagerId);
115
116         String storageServiceId = config.getInitParameter("storageServiceId");
117         if (DatatypeHelper.isEmpty(storageServiceId)) {
118             storageServiceId = "shibboleth.StorageService";
119         }
120         storageService = (StorageService<String, LoginContextEntry>) getServletContext().getAttribute(storageServiceId);
121
122         String partitionName = DatatypeHelper.safeTrimOrNullString(config
123                 .getInitParameter(LOGIN_CONTEXT_PARTITION_NAME_INIT_PARAM_NAME));
124         if (partitionName != null) {
125             loginContextPartitionName = partitionName;
126         } else {
127             loginContextPartitionName = "loginContexts";
128         }
129
130         String lifetime = DatatypeHelper.safeTrimOrNullString(config
131                 .getInitParameter(LOGIN_CONTEXT_LIFETIME_INIT_PARAM_NAME));
132         if (lifetime != null) {
133             loginContextEntryLifetime = Long.parseLong(lifetime);
134         } else {
135             loginContextEntryLifetime = 1000 * 60 * 30;
136         }
137
138         try {
139             idGen = new SecureRandomIdentifierGenerator();
140         } catch (NoSuchAlgorithmException e) {
141             throw new ServletException("Error create random number generator", e);
142         }
143     }
144
145     /**
146      * Retrieves a login context.
147      * 
148      * @param httpRequest current HTTP request
149      * @param removeFromStorageService whether the login context should be removed from the storage service as it is
150      *            retrieved
151      * 
152      * @return the login context or null if one is not available (e.g. because it has expired)
153      */
154     protected static LoginContext retrieveLoginContext(HttpServletRequest httpRequest, boolean removeFromStorageService) {
155         // When the login context comes from the profile handlers its attached to the request
156         // Prior to the authentication engine handing control over to a login handler it stores
157         // the login context into the storage service so that the login handlers do not have to
158         // maintain a reference to the context and return it to the engine.
159         LoginContext loginContext = (LoginContext) httpRequest.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
160         if (loginContext != null) {
161             LOG.trace("Login context retrieved from HTTP request attribute");
162             return loginContext;
163         }
164
165         String contextId = DatatypeHelper.safeTrimOrNullString((String) httpRequest
166                 .getAttribute(LOGIN_CONTEXT_KEY_NAME));
167
168         if (contextId == null) {
169             Cookie[] requestCookies = httpRequest.getCookies();
170             if (requestCookies != null) {
171                 for (Cookie requestCookie : requestCookies) {
172                     if (DatatypeHelper.safeEquals(requestCookie.getName(), LOGIN_CONTEXT_KEY_NAME)) {
173                         LOG.trace("Located cookie with login context key");
174                         contextId = requestCookie.getValue();
175                         break;
176                     }
177                 }
178             }
179         }
180
181         LOG.trace("Using login context key {} to look up login context", contextId);
182         LoginContextEntry entry;
183         if (removeFromStorageService) {
184             entry = storageService.remove(loginContextPartitionName, contextId);
185         } else {
186             entry = storageService.get(loginContextPartitionName, contextId);
187         }
188         if (entry == null) {
189             LOG.trace("No entry for login context found in storage service.");
190             return null;
191         } else if (entry.isExpired()) {
192             LOG.trace("Login context entry found in storage service but it was expired.");
193             return null;
194         } else {
195             LOG.trace("Login context entry found in storage service.");
196             return entry.getLoginContext();
197         }
198     }
199
200     /**
201      * Returns control back to the authentication engine.
202      * 
203      * @param httpRequest current HTTP request
204      * @param httpResponse current HTTP response
205      */
206     public static void returnToAuthenticationEngine(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
207         LOG.debug("Returning control to authentication engine");
208         LoginContext loginContext = retrieveLoginContext(httpRequest, false);
209         if (loginContext == null) {
210             LOG.error("No login context available, unable to return to authentication engine");
211             forwardRequest("/idp-error.jsp", httpRequest, httpResponse);
212         } else {
213             forwardRequest(loginContext.getAuthenticationEngineURL(), httpRequest, httpResponse);
214         }
215     }
216
217     /**
218      * Returns control back to the profile handler that invoked the authentication engine.
219      * 
220      * @param loginContext current login context
221      * @param httpRequest current HTTP request
222      * @param httpResponse current HTTP response
223      */
224     public static void returnToProfileHandler(LoginContext loginContext, HttpServletRequest httpRequest,
225             HttpServletResponse httpResponse) {
226         LOG.debug("Returning control to profile handler at: {}", loginContext.getProfileHandlerURL());
227         httpRequest.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
228
229         // Cleanup this cookie
230         Cookie lcKeyCookie = new Cookie(LOGIN_CONTEXT_KEY_NAME, "");
231         lcKeyCookie.setMaxAge(0);
232         httpResponse.addCookie(lcKeyCookie);
233
234         forwardRequest(loginContext.getProfileHandlerURL(), httpRequest, httpResponse);
235     }
236
237     /**
238      * Forwards a request to the given path.
239      * 
240      * @param forwardPath path to forward the request to
241      * @param httpRequest current HTTP request
242      * @param httpResponse current HTTP response
243      */
244     protected static void forwardRequest(String forwardPath, HttpServletRequest httpRequest,
245             HttpServletResponse httpResponse) {
246         try {
247             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(forwardPath);
248             dispatcher.forward(httpRequest, httpResponse);
249             return;
250         } catch (IOException e) {
251             LOG.error("Unable to return control back to authentication engine", e);
252         } catch (ServletException e) {
253             LOG.error("Unable to return control back to authentication engine", e);
254         }
255     }
256
257     /** {@inheritDoc} */
258     @SuppressWarnings("unchecked")
259     protected void service(HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws ServletException,
260             IOException {
261         LOG.debug("Processing incoming request");
262
263         if (httpResponse.isCommitted()) {
264             LOG.error("HTTP Response already committed");
265         }
266
267         LoginContext loginContext = retrieveLoginContext(httpRequest, true);
268         if (loginContext == null) {
269             LOG.error("Incoming request does not have attached login context");
270             throw new ServletException("Incoming request does not have attached login context");
271         }
272
273         if (!loginContext.getAuthenticationAttempted()) {
274             startUserAuthentication(loginContext, httpRequest, httpResponse);
275         } else {
276             completeAuthentication(loginContext, httpRequest, httpResponse);
277         }
278     }
279
280     /**
281      * Begins the authentication process. Determines if forced re-authentication is required or if an existing, active,
282      * authentication method is sufficient. Also determines, when authentication is required, which handler to use
283      * depending on whether passive authentication is required.
284      * 
285      * @param loginContext current login context
286      * @param httpRequest current HTTP request
287      * @param httpResponse current HTTP response
288      */
289     protected void startUserAuthentication(LoginContext loginContext, HttpServletRequest httpRequest,
290             HttpServletResponse httpResponse) {
291         LOG.debug("Beginning user authentication process.");
292         try {
293             Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
294             if (idpSession != null) {
295                 LOG.debug("Existing IdP session available for principal {}", idpSession.getPrincipalName());
296             }
297
298             Map<String, LoginHandler> possibleLoginHandlers = determinePossibleLoginHandlers(idpSession, loginContext);
299             LOG.debug("Possible authentication handlers for this request: {}", possibleLoginHandlers);
300
301             // Filter out possible candidate login handlers by forced and passive authentication requirements
302             if (loginContext.isForceAuthRequired()) {
303                 filterByForceAuthentication(idpSession, loginContext, possibleLoginHandlers);
304             }
305
306             if (loginContext.isPassiveAuthRequired()) {
307                 filterByPassiveAuthentication(idpSession, loginContext, possibleLoginHandlers);
308             }
309
310             // If the user already has a session and its usage is acceptable than use it
311             // otherwise just use the first candidate login handler
312             LOG.debug("Possible authentication handlers after filtering: {}", possibleLoginHandlers);
313             LoginHandler loginHandler;
314             if (idpSession != null && possibleLoginHandlers.containsKey(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX)) {
315                 loginContext.setAttemptedAuthnMethod(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
316                 loginHandler = possibleLoginHandlers.get(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
317             } else {
318                 possibleLoginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
319                 Entry<String, LoginHandler> chosenLoginHandler = possibleLoginHandlers.entrySet().iterator().next();
320                 loginContext.setAttemptedAuthnMethod(chosenLoginHandler.getKey());
321                 loginHandler = chosenLoginHandler.getValue();
322             }
323
324             // Send the request to the login handler
325             LOG.debug("Authenticating user with login handler of type {}", loginHandler.getClass().getName());
326             loginContext.setAuthenticationAttempted();
327             loginContext.setAuthenticationEngineURL(HttpHelper.getRequestUriWithoutContext(httpRequest));
328             storeLoginContext(loginContext, httpRequest, httpResponse);
329             loginHandler.login(httpRequest, httpResponse);
330         } catch (AuthenticationException e) {
331             loginContext.setAuthenticationFailure(e);
332             returnToProfileHandler(loginContext, httpRequest, httpResponse);
333         }
334     }
335
336     /**
337      * Determines which configured login handlers will support the requested authentication methods.
338      * 
339      * @param loginContext current login context
340      * @param idpSession current user's session, or null if they don't have one
341      * 
342      * @return login methods that may be used to authenticate the user
343      * 
344      * @throws AuthenticationException thrown if no login handler meets the given requirements
345      */
346     protected Map<String, LoginHandler> determinePossibleLoginHandlers(Session idpSession, LoginContext loginContext)
347             throws AuthenticationException {
348         Map<String, LoginHandler> supportedLoginHandlers = new HashMap<String, LoginHandler>(handlerManager
349                 .getLoginHandlers());
350         LOG.debug("Filtering configured login handlers by requested athentication methods.");
351         LOG.debug("Configured LoginHandlers: {}", supportedLoginHandlers);
352         LOG.debug("Requested authentication methods: {}", loginContext.getRequestedAuthenticationMethods());
353
354         // If no preferences Authn method preference is given, then we're free to use any
355         if (loginContext.getRequestedAuthenticationMethods().isEmpty()) {
356             LOG.trace("No preference given for authentication methods");
357             return supportedLoginHandlers;
358         }
359
360         // If the previous session handler is configured, the user has an existing session, and the SP requested
361         // that a certain set of authentication methods be used then we need to check to see if the user has
362         // authenticated with one or more of those methods, if not we can't use the previous session handler
363         if (supportedLoginHandlers.containsKey(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX) && idpSession != null
364                 && loginContext.getRequestedAuthenticationMethods() != null) {
365             boolean retainPreviousSession = false;
366
367             Map<String, AuthenticationMethodInformation> currentAuthnMethods = idpSession.getAuthenticationMethods();
368             for (String currentAuthnMethod : currentAuthnMethods.keySet()) {
369                 if (loginContext.getRequestedAuthenticationMethods().contains(currentAuthnMethod)) {
370                     retainPreviousSession = true;
371                     break;
372                 }
373             }
374
375             if (!retainPreviousSession) {
376                 supportedLoginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
377             }
378         }
379
380         // Otherwise we need to filter all the mechanism supported by the IdP so that only the request types are left
381         // Previous session handler is a special case, we always to keep that around if it's configured
382         Iterator<Entry<String, LoginHandler>> supportedLoginHandlerItr = supportedLoginHandlers.entrySet().iterator();
383         Entry<String, LoginHandler> supportedLoginHandler;
384         while (supportedLoginHandlerItr.hasNext()) {
385             supportedLoginHandler = supportedLoginHandlerItr.next();
386             if (!supportedLoginHandler.getKey().equals(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX)
387                     && !loginContext.getRequestedAuthenticationMethods().contains(supportedLoginHandler.getKey())) {
388                 supportedLoginHandlerItr.remove();
389                 continue;
390             }
391         }
392
393         if (supportedLoginHandlers.isEmpty()) {
394             LOG.error("No authentication method, requested by the service provider, is supported");
395             throw new AuthenticationException(
396                     "No authentication method, requested by the service provider, is supported");
397         }
398
399         return supportedLoginHandlers;
400     }
401
402     /**
403      * Filters out any login handler based on the requirement for forced authentication.
404      * 
405      * During forced authentication any handler that has not previously been used to authenticate the user or any
406      * handlers that have been and support force re-authentication may be used. Filter out any of the other ones.
407      * 
408      * @param idpSession user's current IdP session
409      * @param loginContext current login context
410      * @param loginHandlers login handlers to filter
411      * 
412      * @throws ForceAuthenticationException thrown if no handlers remain after filtering
413      */
414     protected void filterByForceAuthentication(Session idpSession, LoginContext loginContext,
415             Map<String, LoginHandler> loginHandlers) throws ForceAuthenticationException {
416         LOG.debug("Forced authentication is required, filtering possible login handlers accordingly");
417
418         ArrayList<AuthenticationMethodInformation> activeMethods = new ArrayList<AuthenticationMethodInformation>();
419         if (idpSession != null) {
420             activeMethods.addAll(idpSession.getAuthenticationMethods().values());
421         }
422
423         loginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
424
425         LoginHandler loginHandler;
426         for (AuthenticationMethodInformation activeMethod : activeMethods) {
427             loginHandler = loginHandlers.get(activeMethod.getAuthenticationMethod());
428             if (loginHandler != null && !loginHandler.supportsForceAuthentication()) {
429                 for (String handlerSupportedMethods : loginHandler.getSupportedAuthenticationMethods()) {
430                     loginHandlers.remove(handlerSupportedMethods);
431                 }
432             }
433         }
434
435         LOG.debug("Authentication handlers remaining after forced authentication requirement filtering: {}",
436                 loginHandlers);
437
438         if (loginHandlers.isEmpty()) {
439             LOG.info("Force authentication requested but no login handlers available to support it");
440             throw new ForceAuthenticationException();
441         }
442     }
443
444     /**
445      * Filters out any login handler that doesn't support passive authentication if the login context indicates passive
446      * authentication is required.
447      * 
448      * @param idpSession user's current IdP session
449      * @param loginContext current login context
450      * @param loginHandlers login handlers to filter
451      * 
452      * @throws PassiveAuthenticationException thrown if no handlers remain after filtering
453      */
454     protected void filterByPassiveAuthentication(Session idpSession, LoginContext loginContext,
455             Map<String, LoginHandler> loginHandlers) throws PassiveAuthenticationException {
456         LOG.debug("Passive authentication is required, filtering poassible login handlers accordingly.");
457
458         if (idpSession == null) {
459             loginHandlers.remove(AuthnContext.PREVIOUS_SESSION_AUTHN_CTX);
460         }
461
462         LoginHandler loginHandler;
463         Iterator<Entry<String, LoginHandler>> authnMethodItr = loginHandlers.entrySet().iterator();
464         while (authnMethodItr.hasNext()) {
465             loginHandler = authnMethodItr.next().getValue();
466             if (!loginHandler.supportsPassive()) {
467                 authnMethodItr.remove();
468             }
469         }
470
471         LOG.debug("Authentication handlers remaining after passive authentication requirement filtering: {}",
472                 loginHandlers);
473
474         if (loginHandlers.isEmpty()) {
475             LOG.error("Passive authentication required but no login handlers available to support it");
476             throw new PassiveAuthenticationException();
477         }
478     }
479
480     /**
481      * Stores the login context in the storage service. The key for the stored login context is then bound to an HTTP
482      * request attribute and set a cookie.
483      * 
484      * @param loginContext login context to store
485      * @param httpRequest current HTTP request
486      * @param httpResponse current HTTP response
487      */
488     protected void storeLoginContext(LoginContext loginContext, HttpServletRequest httpRequest,
489             HttpServletResponse httpResponse) {
490         String contextId = idGen.generateIdentifier();
491
492         storageService.put(loginContextPartitionName, contextId, new LoginContextEntry(loginContext,
493                 loginContextEntryLifetime));
494
495         httpRequest.setAttribute(LOGIN_CONTEXT_KEY_NAME, contextId);
496
497         Cookie cookie = new Cookie(LOGIN_CONTEXT_KEY_NAME, contextId);
498         String contextPath = httpRequest.getContextPath();
499         if (DatatypeHelper.isEmpty(contextPath)) {
500             cookie.setPath("/");
501         } else {
502             cookie.setPath(contextPath);
503         }
504         cookie.setSecure(httpRequest.isSecure());
505         cookie.setMaxAge(-1);
506         httpResponse.addCookie(cookie);
507     }
508
509     /**
510      * Completes the authentication process.
511      * 
512      * The principal name set by the authentication handler is retrieved and pushed in to the login context, a
513      * Shibboleth session is created if needed, information indicating that the user has logged into the service is
514      * recorded and finally control is returned back to the profile handler.
515      * 
516      * @param loginContext current login context
517      * @param httpRequest current HTTP request
518      * @param httpResponse current HTTP response
519      */
520     protected void completeAuthentication(LoginContext loginContext, HttpServletRequest httpRequest,
521             HttpServletResponse httpResponse) {
522         LOG.debug("Completing user authentication process");
523
524         Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
525
526         try {
527             // Check to make sure the login handler did the right thing
528             validateSuccessfulAuthentication(loginContext, httpRequest);
529
530             // We allow a login handler to override the authentication method in the
531             // event that it supports multiple methods
532             String actualAuthnMethod = DatatypeHelper.safeTrimOrNullString((String) httpRequest
533                     .getAttribute(LoginHandler.AUTHENTICATION_METHOD_KEY));
534             if (actualAuthnMethod == null) {
535                 actualAuthnMethod = loginContext.getAttemptedAuthnMethod();
536             } else {
537                 LOG.debug("Authentication method overriden by LoginHandler.  It was {} and is now {}", loginContext
538                         .getAttemptedAuthnMethod(), actualAuthnMethod);
539             }
540
541             // Get the Subject from the request. If force authentication was required then make sure the
542             // Subject identifies the same user that authenticated before
543             Subject subject = getLoginHandlerSubject(httpRequest);
544             if (loginContext.isForceAuthRequired()) {
545                 validateForcedReauthentication(idpSession, actualAuthnMethod, subject);
546             }
547
548             loginContext.setPrincipalAuthenticated(true);
549             updateUserSession(loginContext, subject, actualAuthnMethod, httpRequest, httpResponse);
550             LOG.debug("User {} authenticated with method {}", loginContext.getPrincipalName(), loginContext
551                     .getAuthenticationMethod());
552         } catch (AuthenticationException e) {
553             LOG.error("Authentication failed with the error:", e);
554             loginContext.setPrincipalAuthenticated(false);
555             loginContext.setAuthenticationFailure(e);
556         }
557
558         returnToProfileHandler(loginContext, httpRequest, httpResponse);
559     }
560
561     /**
562      * Validates that the authentication was successfully performed by the login handler. An authentication is
563      * considered successful if no error is bound to the request attribute {@link LoginHandler#AUTHENTICATION_ERROR_KEY}
564      * and there is a value for at least one of the following request attributes: {@link LoginHandler#SUBJECT_KEY},
565      * {@link LoginHandler#PRINCIPAL_KEY}, or {@link LoginHandler#PRINCIPAL_NAME_KEY}.
566      * 
567      * @param loginContext current login context
568      * @param httpRequest current HTTP request
569      * 
570      * @throws AuthenticationException thrown if the authentication was not successful
571      */
572     protected void validateSuccessfulAuthentication(LoginContext loginContext, HttpServletRequest httpRequest)
573             throws AuthenticationException {
574         LOG.debug("Validating authentication was performed successfully");
575
576         String errorMessage = DatatypeHelper.safeTrimOrNullString((String) httpRequest
577                 .getAttribute(LoginHandler.AUTHENTICATION_ERROR_KEY));
578         if (errorMessage != null) {
579             LOG.error("Error returned from login handler for authentication method {}:\n{}", loginContext
580                     .getAttemptedAuthnMethod(), errorMessage);
581             throw new AuthenticationException(errorMessage);
582         }
583
584         Subject subject = (Subject) httpRequest.getAttribute(LoginHandler.SUBJECT_KEY);
585         Principal principal = (Principal) httpRequest.getAttribute(LoginHandler.PRINCIPAL_KEY);
586         String principalName = DatatypeHelper.safeTrimOrNullString((String) httpRequest
587                 .getAttribute(LoginHandler.PRINCIPAL_NAME_KEY));
588
589         if (subject == null && principal == null && principalName == null) {
590             LOG.error("No user identified by login handler.");
591             throw new AuthenticationException("No user identified by login handler.");
592         }
593     }
594
595     /**
596      * Gets the subject from the request coming back from the login handler.
597      * 
598      * @param httpRequest request coming back from the login handler
599      * 
600      * @return the {@link Subject} created from the request
601      * 
602      * @throws AuthenticationException thrown if no subject can be retrieved from the request
603      */
604     protected Subject getLoginHandlerSubject(HttpServletRequest httpRequest) throws AuthenticationException {
605         Subject subject = (Subject) httpRequest.getAttribute(LoginHandler.SUBJECT_KEY);
606         Principal principal = (Principal) httpRequest.getAttribute(LoginHandler.PRINCIPAL_KEY);
607         String principalName = DatatypeHelper.safeTrimOrNullString((String) httpRequest
608                 .getAttribute(LoginHandler.PRINCIPAL_NAME_KEY));
609
610         if (subject == null && (principal != null || principalName != null)) {
611             subject = new Subject();
612             if (principal == null) {
613                 principal = new UsernamePrincipal(principalName);
614             }
615             subject.getPrincipals().add(principal);
616         }
617
618         return subject;
619     }
620
621     /**
622      * If forced authentication was required this method checks to ensure that the re-authenticated subject contains a
623      * principal name that is equal to the principal name associated with the authentication method. If this is the
624      * first time the subject has authenticated with this method than this check always passes.
625      * 
626      * @param idpSession user's IdP session
627      * @param authnMethod method used to authenticate the user
628      * @param subject subject that was authenticated
629      * 
630      * @throws AuthenticationException thrown if this check fails
631      */
632     protected void validateForcedReauthentication(Session idpSession, String authnMethod, Subject subject)
633             throws AuthenticationException {
634         if (idpSession != null) {
635             AuthenticationMethodInformation authnMethodInfo = idpSession.getAuthenticationMethods().get(authnMethod);
636             if (authnMethodInfo != null) {
637                 boolean princpalMatch = false;
638                 for (Principal princpal : subject.getPrincipals()) {
639                     if (authnMethodInfo.getAuthenticationPrincipal().equals(princpal)) {
640                         princpalMatch = true;
641                         break;
642                     }
643                 }
644
645                 if (!princpalMatch) {
646                     throw new ForceAuthenticationException(
647                             "Authenticated principal does not match previously authenticated principal");
648                 }
649             }
650         }
651     }
652
653     /**
654      * Updates the user's Shibboleth session with authentication information. If no session exists a new one will be
655      * created.
656      * 
657      * @param loginContext current login context
658      * @param authenticationSubject subject created from the authentication method
659      * @param authenticationMethod the method used to authenticate the subject
660      * @param httpRequest current HTTP request
661      * @param httpResponse current HTTP response
662      */
663     protected void updateUserSession(LoginContext loginContext, Subject authenticationSubject,
664             String authenticationMethod, HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
665         Principal authenticationPrincipal = authenticationSubject.getPrincipals().iterator().next();
666         LOG.debug("Updating session information for principal {}", authenticationPrincipal.getName());
667
668         Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
669         if (idpSession == null) {
670             LOG.debug("Creating shibboleth session for principal {}", authenticationPrincipal.getName());
671             idpSession = (Session) sessionManager.createSession();
672             loginContext.setSessionID(idpSession.getSessionID());
673             addSessionCookie(httpRequest, httpResponse, idpSession);
674         }
675
676         // Merge the information in the current session subject with the information from the
677         // login handler subject
678         idpSession.setSubject(mergeSubjects(idpSession.getSubject(), authenticationSubject));
679
680         LOG.debug("Recording authentication and service information in Shibboleth session for principal: {}",
681                 authenticationPrincipal.getName());
682         LoginHandler loginHandler = handlerManager.getLoginHandlers().get(loginContext.getAttemptedAuthnMethod());
683         AuthenticationMethodInformation authnMethodInfo = new AuthenticationMethodInformationImpl(idpSession
684                 .getSubject(), authenticationPrincipal, authenticationMethod, new DateTime(), loginHandler
685                 .getAuthenticationDuration());
686
687         loginContext.setAuthenticationMethodInformation(authnMethodInfo);
688         idpSession.getAuthenticationMethods().put(authnMethodInfo.getAuthenticationMethod(), authnMethodInfo);
689         sessionManager.indexSession(idpSession, authnMethodInfo.getAuthenticationPrincipal().getName());
690
691         ServiceInformation serviceInfo = new ServiceInformationImpl(loginContext.getRelyingPartyId(), new DateTime(),
692                 authnMethodInfo);
693         idpSession.getServicesInformation().put(serviceInfo.getEntityID(), serviceInfo);
694     }
695
696     /**
697      * Merges the principals and public and private credentials from two subjects into a new subject.
698      * 
699      * @param subject1 first subject to merge, may be null
700      * @param subject2 second subject to merge, may be null
701      * 
702      * @return subject containing the merged information
703      */
704     protected Subject mergeSubjects(Subject subject1, Subject subject2) {
705         if (subject1 == null) {
706             return subject2;
707         }
708
709         if (subject2 == null) {
710             return subject1;
711         }
712
713         if (subject1 == null && subject2 == null) {
714             return new Subject();
715         }
716
717         Set<Principal> principals = new HashSet<Principal>();
718         principals.addAll(subject1.getPrincipals());
719         principals.addAll(subject2.getPrincipals());
720
721         Set<Object> publicCredentials = new HashSet<Object>();
722         publicCredentials.addAll(subject1.getPublicCredentials());
723         publicCredentials.addAll(subject2.getPublicCredentials());
724
725         Set<Object> privateCredentials = new HashSet<Object>();
726         privateCredentials.addAll(subject1.getPrivateCredentials());
727         privateCredentials.addAll(subject2.getPrivateCredentials());
728
729         return new Subject(false, principals, publicCredentials, privateCredentials);
730     }
731
732     /**
733      * Adds an IdP session cookie to the outbound response.
734      * 
735      * @param httpRequest current request
736      * @param httpResponse current response
737      * @param userSession user's session
738      */
739     protected void addSessionCookie(HttpServletRequest httpRequest, HttpServletResponse httpResponse,
740             Session userSession) {
741         httpRequest.setAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE, userSession);
742
743         byte[] remoteAddress = httpRequest.getRemoteAddr().getBytes();
744         byte[] sessionId = userSession.getSessionID().getBytes();
745
746         String signature = null;
747         try {
748             MessageDigest digester = MessageDigest.getInstance("SHA");
749             digester.update(userSession.getSessionSecret());
750             digester.update(remoteAddress);
751             digester.update(sessionId);
752             signature = Base64.encodeBytes(digester.digest());
753         } catch (GeneralSecurityException e) {
754             LOG.error("Unable to compute signature over session cookie material", e);
755         }
756
757         LOG.debug("Adding IdP session cookie to HTTP response");
758         StringBuilder cookieValue = new StringBuilder();
759         cookieValue.append(Base64.encodeBytes(remoteAddress, Base64.DONT_BREAK_LINES)).append("|");
760         cookieValue.append(Base64.encodeBytes(sessionId, Base64.DONT_BREAK_LINES)).append("|");
761         cookieValue.append(signature);
762         Cookie sessionCookie = new Cookie(IDP_SESSION_COOKIE_NAME, HTTPTransportUtils.urlEncode(cookieValue.toString()));
763
764         String contextPath = httpRequest.getContextPath();
765         if (DatatypeHelper.isEmpty(contextPath)) {
766             sessionCookie.setPath("/");
767         } else {
768             sessionCookie.setPath(contextPath);
769         }
770
771         sessionCookie.setSecure(httpRequest.isSecure());
772         sessionCookie.setMaxAge(-1);
773
774         httpResponse.addCookie(sessionCookie);
775     }
776 }