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