b28918903da973d4c916ee4ea3c00aef9fc33685
[java-idp.git] / src / 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.util.ArrayList;
21 import java.util.HashMap;
22 import java.util.Iterator;
23 import java.util.Map;
24 import java.util.Map.Entry;
25
26 import javax.security.auth.Subject;
27 import javax.servlet.RequestDispatcher;
28 import javax.servlet.ServletConfig;
29 import javax.servlet.ServletException;
30 import javax.servlet.http.Cookie;
31 import javax.servlet.http.HttpServlet;
32 import javax.servlet.http.HttpServletRequest;
33 import javax.servlet.http.HttpServletResponse;
34 import javax.servlet.http.HttpSession;
35
36 import org.joda.time.DateTime;
37 import org.opensaml.xml.util.DatatypeHelper;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
40
41 import edu.internet2.middleware.shibboleth.common.session.SessionManager;
42 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
43 import edu.internet2.middleware.shibboleth.idp.authn.provider.PreviousSessionLoginHandler;
44 import edu.internet2.middleware.shibboleth.idp.profile.IdPProfileHandlerManager;
45 import edu.internet2.middleware.shibboleth.idp.session.AuthenticationMethodInformation;
46 import edu.internet2.middleware.shibboleth.idp.session.ServiceInformation;
47 import edu.internet2.middleware.shibboleth.idp.session.Session;
48 import edu.internet2.middleware.shibboleth.idp.session.impl.AuthenticationMethodInformationImpl;
49 import edu.internet2.middleware.shibboleth.idp.session.impl.ServiceInformationImpl;
50
51 /**
52  * Manager responsible for handling authentication requests.
53  */
54 public class AuthenticationEngine extends HttpServlet {
55
56     /** Name of the IdP Cookie containing the IdP session ID. */
57     public static final String IDP_SESSION_COOKIE_NAME = "_idp_session";
58
59     /** Serial version UID. */
60     private static final long serialVersionUID = 8494202791991613148L;
61
62     /** Class logger. */
63     private static final Logger LOG = LoggerFactory.getLogger(AuthenticationEngine.class);
64
65     /** Profile handler manager. */
66     private IdPProfileHandlerManager handlerManager;
67
68     /** Session manager. */
69     private SessionManager<Session> sessionManager;
70
71     /** {@inheritDoc} */
72     public void init(ServletConfig config) throws ServletException {
73         super.init(config);
74
75         String handlerManagerId = config.getInitParameter("handlerManagerId");
76         if (DatatypeHelper.isEmpty(handlerManagerId)) {
77             handlerManagerId = "shibboleth.HandlerManager";
78         }
79         handlerManager = (IdPProfileHandlerManager) getServletContext().getAttribute(handlerManagerId);
80
81         String sessionManagerId = config.getInitParameter("sessionManagedId");
82         if (DatatypeHelper.isEmpty(sessionManagerId)) {
83             sessionManagerId = "shibboleth.SessionManager";
84         }
85
86         sessionManager = (SessionManager<Session>) getServletContext().getAttribute(sessionManagerId);
87     }
88
89     /**
90      * Returns control back to the authentication engine.
91      * 
92      * @param httpRequest current http request
93      * @param httpResponse current http response
94      */
95     public static void returnToAuthenticationEngine(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
96         LOG.debug("Returning control to authentication engine");
97         HttpSession httpSession = httpRequest.getSession();
98         LoginContext loginContext = (LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
99         if (loginContext == null) {
100             LOG.error("User HttpSession did not contain a login context.  Unable to return to authentication engine");
101             forwardRequest("/idp-error.jsp", httpRequest, httpResponse);
102         } else {
103             forwardRequest(loginContext.getAuthenticationEngineURL(), httpRequest, httpResponse);
104         }
105     }
106
107     /**
108      * Returns control back to the profile handler that invoked the authentication engine.
109      * 
110      * @param loginContext current login context
111      * @param httpRequest current http request
112      * @param httpResponse current http response
113      */
114     public static void returnToProfileHandler(LoginContext loginContext, HttpServletRequest httpRequest,
115             HttpServletResponse httpResponse) {
116         LOG.debug("Returning control to profile handler at: {}", loginContext.getProfileHandlerURL());
117         httpRequest.getSession().removeAttribute(LoginContext.LOGIN_CONTEXT_KEY);
118         httpRequest.setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
119         forwardRequest(loginContext.getProfileHandlerURL(), httpRequest, httpResponse);
120     }
121
122     /**
123      * Forwards a request to the given path.
124      * 
125      * @param forwardPath path to forward the request to
126      * @param httpRequest current HTTP request
127      * @param httpResponse current HTTP response
128      */
129     protected static void forwardRequest(String forwardPath, HttpServletRequest httpRequest,
130             HttpServletResponse httpResponse) {
131         try {
132             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(forwardPath);
133             dispatcher.forward(httpRequest, httpResponse);
134             return;
135         } catch (IOException e) {
136             LOG.error("Unable to return control back to authentication engine", e);
137         } catch (ServletException e) {
138             LOG.error("Unable to return control back to authentication engine", e);
139         }
140     }
141
142     /** {@inheritDoc} */
143     @SuppressWarnings("unchecked")
144     protected void service(HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws ServletException,
145             IOException {
146         LOG.debug("Processing incoming request");
147
148         if (httpResponse.isCommitted()) {
149             LOG.error("HTTP Response already committed");
150         }
151
152         LoginContext loginContext = (LoginContext) httpRequest.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
153         if (loginContext == null) {
154             // When the login context comes from the profile handlers its attached to the request
155             // The authn engine attaches it to the session to allow the handlers to do any number of
156             // request/response pairs without maintaining or losing the login context
157             loginContext = (LoginContext) httpRequest.getSession().getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
158         }
159
160         if (loginContext == null) {
161             LOG.error("Incoming request does not have attached login context");
162             throw new ServletException("Incoming request does not have attached login context");
163         }
164
165         if (!loginContext.getAuthenticationAttempted()) {
166             startUserAuthentication(loginContext, httpRequest, httpResponse);
167         } else {
168             completeAuthentication(loginContext, httpRequest, httpResponse);
169         }
170     }
171
172     /**
173      * Begins the authentication process. Determines if forced re-authentication is required or if an existing, active,
174      * authentication method is sufficient. Also determines, when authentication is required, which handler to use
175      * depending on whether passive authentication is required.
176      * 
177      * @param loginContext current login context
178      * @param httpRequest current HTTP request
179      * @param httpResponse current HTTP response
180      */
181     protected void startUserAuthentication(LoginContext loginContext, HttpServletRequest httpRequest,
182             HttpServletResponse httpResponse) {
183         LOG.debug("Beginning user authentication process");
184         try {
185             Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
186             Map<String, LoginHandler> possibleLoginHandlers = determinePossibleLoginHandlers(loginContext);
187
188             // Filter out possible candidate login handlers by forced and passive authentication requirements
189             if (loginContext.isForceAuthRequired()) {
190                 filterByForceAuthentication(idpSession, loginContext, possibleLoginHandlers);
191             }
192
193             if (loginContext.isPassiveAuthRequired()) {
194                 filterByPassiveAuthentication(loginContext, possibleLoginHandlers);
195             }
196
197             // If the user already has a session and its usage is acceptable than use it
198             // otherwise just use the first candidate login handler
199             if (idpSession != null
200                     && possibleLoginHandlers.containsKey(PreviousSessionLoginHandler.PREVIOUS_SESSION_AUTHN_METHOD)) {
201                 authenticateUserWithPreviousSession(loginContext, possibleLoginHandlers, httpRequest, httpResponse);
202             } else {
203                 Entry<String, LoginHandler> chosenLoginHandler = possibleLoginHandlers.entrySet().iterator().next();
204                 authenticateUser(chosenLoginHandler.getKey(), chosenLoginHandler.getValue(), loginContext, httpRequest,
205                         httpResponse);
206             }
207         } catch (AuthenticationException e) {
208             loginContext.setAuthenticationFailure(e);
209             returnToProfileHandler(loginContext, httpRequest, httpResponse);
210         }
211
212     }
213
214     /**
215      * Determines which configured login handlers will support the requested authentication methods.
216      * 
217      * @param loginContext current login context
218      * 
219      * @return login methods that may be used to authenticate the user
220      * 
221      * @throws AuthenticationException thrown if no login handler meets the given requirements
222      */
223     protected Map<String, LoginHandler> determinePossibleLoginHandlers(LoginContext loginContext)
224             throws AuthenticationException {
225         Map<String, LoginHandler> supportedLoginHandlers = new HashMap<String, LoginHandler>(handlerManager
226                 .getLoginHandlers());
227         LOG.trace("Supported login handlers: {}", supportedLoginHandlers);
228         LOG.trace("Requested authentication methods: {}", loginContext.getRequestedAuthenticationMethods());
229
230         Iterator<Entry<String, LoginHandler>> supportedLoginHandlerItr = supportedLoginHandlers.entrySet().iterator();
231         Entry<String, LoginHandler> supportedLoginHandler;
232         while (supportedLoginHandlerItr.hasNext()) {
233             supportedLoginHandler = supportedLoginHandlerItr.next();
234             if (supportedLoginHandler.getKey().equals(PreviousSessionLoginHandler.PREVIOUS_SESSION_AUTHN_METHOD)
235                     || !loginContext.getRequestedAuthenticationMethods().contains(supportedLoginHandler.getKey())) {
236                 supportedLoginHandlerItr.remove();
237                 continue;
238             }
239         }
240
241         if (supportedLoginHandlers.isEmpty()) {
242             LOG.error("No authentication method, requested by the service provider, is supported");
243             throw new AuthenticationException(
244                     "No authentication method, requested by the service provider, is supported");
245         }
246
247         return supportedLoginHandlers;
248     }
249
250     /**
251      * Filters out any login handler based on the requirement for forced authentication.
252      * 
253      * During forced authentication any handler that has not previously been used to authenticate the user or any
254      * handlers that have been and support force re-authentication may be used. Filter out any of the other ones.
255      * 
256      * @param idpSession user's current IdP session
257      * @param loginContext current login context
258      * @param loginHandlers login handlers to filter
259      * 
260      * @throws ForceAuthenticationException thrown if no handlers remain after filtering
261      */
262     protected void filterByForceAuthentication(Session idpSession, LoginContext loginContext,
263             Map<String, LoginHandler> loginHandlers) throws ForceAuthenticationException {
264         LOG.debug("Forced authentication is required, filtering possible login handlers accordingly");
265
266         ArrayList<AuthenticationMethodInformation> activeMethods = new ArrayList<AuthenticationMethodInformation>();
267         if (idpSession != null) {
268             activeMethods.addAll(idpSession.getAuthenticationMethods().values());
269         }
270
271         LoginHandler loginHandler;
272         for (AuthenticationMethodInformation activeMethod : activeMethods) {
273             loginHandler = loginHandlers.get(activeMethod.getAuthenticationMethod());
274             if (loginHandler != null && !loginHandler.supportsForceAuthentication()) {
275                 for (String handlerSupportedMethods : loginHandler.getSupportedAuthenticationMethods()) {
276                     loginHandlers.remove(handlerSupportedMethods);
277                 }
278             }
279         }
280
281         if (loginHandlers.isEmpty()) {
282             LOG.error("Force authentication required but no login handlers available to support it");
283             throw new ForceAuthenticationException();
284         }
285     }
286
287     /**
288      * Filters out any login handler that doesn't support passive authentication if the login context indicates passive
289      * authentication is required.
290      * 
291      * @param loginContext current login context
292      * @param loginHandlers login handlers to filter
293      * 
294      * @throws PassiveAuthenticationException thrown if no handlers remain after filtering
295      */
296     protected void filterByPassiveAuthentication(LoginContext loginContext, Map<String, LoginHandler> loginHandlers)
297             throws PassiveAuthenticationException {
298         LOG.debug("Passive authentication is required, filtering poassible login handlers accordingly.");
299
300         LoginHandler loginHandler;
301         Iterator<Entry<String, LoginHandler>> authnMethodItr = loginHandlers.entrySet().iterator();
302         while (authnMethodItr.hasNext()) {
303             loginHandler = authnMethodItr.next().getValue();
304             if (!loginHandler.supportsPassive()) {
305                 authnMethodItr.remove();
306             }
307         }
308
309         if (loginHandlers.isEmpty()) {
310             LOG.error("Passive authentication required but no login handlers available to support it");
311             throw new PassiveAuthenticationException();
312         }
313     }
314
315     /**
316      * Completes the authentication request using an existing, active, authentication method for the current user.
317      * 
318      * @param loginContext current login context
319      * @param possibleLoginHandlers login handlers that meet the peers authentication requirements
320      * @param httpRequest current HTTP request
321      * @param httpResponse current HTTP response
322      */
323     protected void authenticateUserWithPreviousSession(LoginContext loginContext,
324             Map<String, LoginHandler> possibleLoginHandlers, HttpServletRequest httpRequest,
325             HttpServletResponse httpResponse) {
326         LOG.debug("Authenticating user by way of existing session.");
327
328         Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
329         PreviousSessionLoginHandler loginHandler = (PreviousSessionLoginHandler) handlerManager.getLoginHandlers().get(
330                 PreviousSessionLoginHandler.PREVIOUS_SESSION_AUTHN_METHOD);
331
332         AuthenticationMethodInformation authenticationMethod = null;
333         for (String possibleAuthnMethod : possibleLoginHandlers.keySet()) {
334             authenticationMethod = idpSession.getAuthenticationMethods().get(possibleAuthnMethod);
335             if (authenticationMethod != null) {
336                 break;
337             }
338         }
339
340         if (loginHandler.reportPreviousSessionAuthnMethod()) {
341             loginContext.setAuthenticationDuration(loginHandler.getAuthenticationDuration());
342             loginContext.setAuthenticationInstant(new DateTime());
343             loginContext.setAuthenticationMethod(PreviousSessionLoginHandler.PREVIOUS_SESSION_AUTHN_METHOD);
344         } else {
345             loginContext.setAuthenticationDuration(authenticationMethod.getAuthenticationDuration());
346             loginContext.setAuthenticationInstant(authenticationMethod.getAuthenticationInstant());
347             loginContext.setAuthenticationMethod(authenticationMethod.getAuthenticationMethod());
348         }
349         loginContext.setPrincipalName(idpSession.getPrincipalName());
350
351         httpRequest.getSession().setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
352         loginHandler.login(httpRequest, httpResponse);
353     }
354
355     /**
356      * Authenticates the user with the given authentication method provided by the given login handler.
357      * 
358      * @param authnMethod the authentication method that will be used to authenticate the user
359      * @param loginHandler login handler that will authenticate user
360      * @param loginContext current login context
361      * @param httpRequest current HTTP request
362      * @param httpResponse current HTTP response
363      */
364     protected void authenticateUser(String authnMethod, LoginHandler loginHandler, LoginContext loginContext,
365             HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
366         LOG.debug("Authenticating user with login handler of type {}", loginHandler.getClass().getName());
367
368         loginContext.setAuthenticationAttempted();
369         loginContext.setAuthenticationInstant(new DateTime());
370         loginContext.setAuthenticationDuration(loginHandler.getAuthenticationDuration());
371         loginContext.setAuthenticationMethod(authnMethod);
372         loginContext.setAuthenticationEngineURL(HttpHelper.getRequestUriWithoutContext(httpRequest));
373         httpRequest.getSession().setAttribute(LoginContext.LOGIN_CONTEXT_KEY, loginContext);
374         loginHandler.login(httpRequest, httpResponse);
375     }
376
377     /**
378      * Completes the authentication process.
379      * 
380      * The principal name set by the authentication handler is retrieved and pushed in to the login context, a
381      * Shibboleth session is created if needed, information indicating that the user has logged into the service is
382      * recorded and finally control is returned back to the profile handler.
383      * 
384      * @param loginContext current login context
385      * @param httpRequest current HTTP request
386      * @param httpResponse current HTTP response
387      */
388     protected void completeAuthentication(LoginContext loginContext, HttpServletRequest httpRequest,
389             HttpServletResponse httpResponse) {
390
391         // We check if the principal name was already set in the login context
392         // if not attempt to pull it from where login handlers are supposed to provide it
393         String principalName = loginContext.getPrincipalName();
394         if (principalName == null) {
395             DatatypeHelper.safeTrimOrNullString((String) httpRequest.getAttribute(LoginHandler.PRINCIPAL_NAME_KEY));
396             if (principalName != null) {
397                 loginContext.setPrincipalName(principalName);
398             }else{
399                 loginContext.setPrincipalAuthenticated(false);
400                 loginContext.setAuthenticationFailure(new AuthenticationException(
401                         "No principal name returned from authentication handler."));
402                 LOG.error("No principal name returned from authentication method: "
403                         + loginContext.getAuthenticationMethod());
404                 returnToProfileHandler(loginContext, httpRequest, httpResponse);
405                 return;
406             }
407         }
408         loginContext.setPrincipalAuthenticated(true);
409         
410         // We allow a login handler to override the authentication method in the event that it supports multiple methods
411         String actualAuthnMethod = DatatypeHelper.safeTrimOrNullString((String) httpRequest
412                 .getAttribute(LoginHandler.AUTHENTICATION_METHOD_KEY));
413         if (actualAuthnMethod != null) {
414             loginContext.setAuthenticationMethod(actualAuthnMethod);
415         }
416
417         LOG.debug("User {} authenticated with method {}", loginContext.getPrincipalName(), loginContext
418                 .getAuthenticationMethod());
419         updateUserSession(loginContext, httpRequest, httpResponse);
420         returnToProfileHandler(loginContext, httpRequest, httpResponse);
421     }
422
423     /**
424      * Updates the user's Shibboleth session with authentication information. If no session exists a new one will be
425      * created.
426      * 
427      * @param loginContext current login context
428      * @param httpRequest current HTTP request
429      * @param httpResponse current HTTP response
430      */
431     protected void updateUserSession(LoginContext loginContext, HttpServletRequest httpRequest,
432             HttpServletResponse httpResponse) {
433         Session idpSession = (Session) httpRequest.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
434         if (idpSession == null) {
435             LOG.debug("Creating shibboleth session for principal {}", loginContext.getPrincipalName());
436             idpSession = (Session) sessionManager.createSession(loginContext.getPrincipalName());
437             loginContext.setSessionID(idpSession.getSessionID());
438             addSessionCookie(httpRequest, httpResponse, idpSession);
439         }
440
441         LOG.debug("Recording authentication and service information in Shibboleth session for principal: {}",
442                 loginContext.getPrincipalName());
443         Subject subject = (Subject) httpRequest.getAttribute(LoginHandler.SUBJECT_KEY);
444         String authnMethod = (String) httpRequest.getAttribute(LoginHandler.AUTHENTICATION_METHOD_KEY);
445         if (DatatypeHelper.isEmpty(authnMethod)) {
446             authnMethod = loginContext.getAuthenticationMethod();
447         }
448
449         AuthenticationMethodInformation authnMethodInfo = new AuthenticationMethodInformationImpl(subject, authnMethod,
450                 loginContext.getAuthenticationInstant(), loginContext.getAuthenticationDuration());
451
452         idpSession.getAuthenticationMethods().put(authnMethodInfo.getAuthenticationMethod(), authnMethodInfo);
453
454         ServiceInformation serviceInfo = new ServiceInformationImpl(loginContext.getRelyingPartyId(), new DateTime(),
455                 authnMethodInfo);
456         idpSession.getServicesInformation().put(serviceInfo.getEntityID(), serviceInfo);
457     }
458
459     /**
460      * Adds an IdP session cookie to the outbound response.
461      * 
462      * @param httpRequest current request
463      * @param httpResponse current response
464      * @param userSession user's session
465      */
466     protected void addSessionCookie(HttpServletRequest httpRequest, HttpServletResponse httpResponse,
467             Session userSession) {
468         httpRequest.setAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE, userSession);
469
470         LOG.debug("Adding IdP session cookie to HTTP response");
471         Cookie sessionCookie = new Cookie(IDP_SESSION_COOKIE_NAME, userSession.getSessionID());
472         sessionCookie.setPath(httpRequest.getContextPath());
473         sessionCookie.setSecure(false);
474         sessionCookie.setMaxAge(-1);
475
476         httpResponse.addCookie(sessionCookie);
477     }
478 }