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