Allow login handlers to indicate which authentication method they used
[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.net.InetAddress;
21 import java.net.UnknownHostException;
22 import java.util.List;
23
24 import javax.security.auth.Subject;
25 import javax.servlet.RequestDispatcher;
26 import javax.servlet.ServletException;
27 import javax.servlet.http.HttpServlet;
28 import javax.servlet.http.HttpServletRequest;
29 import javax.servlet.http.HttpServletResponse;
30 import javax.servlet.http.HttpSession;
31
32 import org.joda.time.DateTime;
33 import org.opensaml.xml.util.DatatypeHelper;
34 import org.opensaml.xml.util.Pair;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
37
38 import edu.internet2.middleware.shibboleth.common.session.SessionManager;
39 import edu.internet2.middleware.shibboleth.common.util.HttpHelper;
40 import edu.internet2.middleware.shibboleth.idp.profile.IdPProfileHandlerManager;
41 import edu.internet2.middleware.shibboleth.idp.session.AuthenticationMethodInformation;
42 import edu.internet2.middleware.shibboleth.idp.session.ServiceInformation;
43 import edu.internet2.middleware.shibboleth.idp.session.Session;
44 import edu.internet2.middleware.shibboleth.idp.session.impl.AuthenticationMethodInformationImpl;
45 import edu.internet2.middleware.shibboleth.idp.session.impl.ServiceInformationImpl;
46
47 /**
48  * Manager responsible for handling authentication requests.
49  */
50 public class AuthenticationEngine extends HttpServlet {
51
52     /** Serial version UID. */
53     private static final long serialVersionUID = 8494202791991613148L;
54
55     /** Class logger. */
56     private static final Logger LOG = LoggerFactory.getLogger(AuthenticationEngine.class);
57
58     /**
59      * Gets the manager used to retrieve handlers for requests.
60      * 
61      * @return manager used to retrieve handlers for requests
62      */
63     public IdPProfileHandlerManager getProfileHandlerManager() {
64         return (IdPProfileHandlerManager) getServletContext().getAttribute("handlerManager");
65     }
66
67     /**
68      * Gets the session manager to be used.
69      * 
70      * @return session manager to be used
71      */
72     @SuppressWarnings("unchecked")
73     public SessionManager<Session> getSessionManager() {
74         return (SessionManager<Session>) getServletContext().getAttribute("sessionManager");
75     }
76
77     /**
78      * Returns control back to the authentication engine.
79      * 
80      * @param httpRequest current http request
81      * @param httpResponse current http response
82      */
83     public static void returnToAuthenticationEngine(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
84         LOG.debug("Returning control to authentication engine");
85         HttpSession httpSession = httpRequest.getSession();
86         LoginContext loginContext = (LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
87         if (loginContext == null) {
88             LOG.error("User HttpSession did not contain a login context.  Unable to return to authentication engine");
89         }
90         forwardRequest(loginContext.getAuthenticationEngineURL(), httpRequest, httpResponse);
91     }
92
93     /**
94      * Returns control back to the profile handler that invoked the authentication engine.
95      * 
96      * @param loginContext current login context
97      * @param httpRequest current http request
98      * @param httpResponse current http response
99      */
100     public static void returnToProfileHandler(LoginContext loginContext, HttpServletRequest httpRequest,
101             HttpServletResponse httpResponse) {
102         LOG.debug("Returning control to profile handler at: {}", loginContext.getProfileHandlerURL());
103         forwardRequest(loginContext.getProfileHandlerURL(), httpRequest, httpResponse);
104     }
105
106     /**
107      * Forwards a request to the given path.
108      * 
109      * @param forwardPath path to forward the request to
110      * @param httpRequest current HTTP request
111      * @param httpResponse current HTTP response
112      */
113     protected static void forwardRequest(String forwardPath, HttpServletRequest httpRequest,
114             HttpServletResponse httpResponse) {
115         try {
116             RequestDispatcher dispatcher = httpRequest.getRequestDispatcher(forwardPath);
117             dispatcher.forward(httpRequest, httpResponse);
118             return;
119         } catch (IOException e) {
120             LOG.error("Unable to return control back to authentication engine", e);
121         } catch (ServletException e) {
122             LOG.error("Unable to return control back to authentication engine", e);
123         }
124     }
125
126     /** {@inheritDoc} */
127     @SuppressWarnings("unchecked")
128     protected void service(HttpServletRequest httpRequest, HttpServletResponse httpResponse) throws ServletException,
129             IOException {
130         LOG.debug("Processing incoming request");
131
132         if (httpResponse.isCommitted()) {
133             LOG.error("HTTP Response already committed");
134         }
135
136         HttpSession httpSession = httpRequest.getSession();
137         LoginContext loginContext = (LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
138         if (loginContext == null) {
139             LOG.error("Incoming request does not have attached login context");
140             throw new ServletException("Incoming request does not have attached login context");
141         }
142
143         if (!loginContext.getAuthenticationAttempted()) {
144             String shibSessionId = (String) httpSession.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
145             Session shibSession = getSessionManager().getSession(shibSessionId);
146
147             if (shibSession != null) {
148                 AuthenticationMethodInformation authenticationMethod = getUsableExistingAuthenticationMethod(
149                         loginContext, shibSession);
150                 if (authenticationMethod != null) {
151                     LOG.debug("An active authentication method is applicable for relying party.  Using authentication "
152                             + "method {} as authentication method to relying party without re-authenticating user.",
153                             authenticationMethod.getAuthenticationMethod());
154                     authenticateUserWithActiveMethod(httpRequest, httpResponse, authenticationMethod);
155                     return;
156                 }
157             }
158
159             LOG.debug("No active authentication method is applicable for relying party.  "
160                     + "Authenticating user with to be determined method.");
161             authenticateUserWithoutActiveMethod1(httpRequest, httpResponse);
162         } else {
163             LOG.debug("Request returned from authentication handler, completing authentication process.");
164             authenticateUserWithoutActiveMethod2(httpRequest, httpResponse);
165         }
166
167         return;
168     }
169
170     /**
171      * Completes the authentication request using an existing, active, authentication method for the current user.
172      * 
173      * @param httpRequest current HTTP request
174      * @param httpResponse current HTTP response
175      * @param authenticationMethod authentication method to use to complete the request
176      */
177     protected void authenticateUserWithActiveMethod(HttpServletRequest httpRequest, HttpServletResponse httpResponse,
178             AuthenticationMethodInformation authenticationMethod) {
179         HttpSession httpSession = httpRequest.getSession();
180
181         String shibSessionId = (String) httpSession.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
182         Session shibSession = getSessionManager().getSession(shibSessionId);
183
184         LOG.debug("Populating login context with existing session and authentication method information.");
185         LoginContext loginContext = (LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
186         loginContext.setAuthenticationDuration(authenticationMethod.getAuthenticationDuration());
187         loginContext.setAuthenticationInstant(authenticationMethod.getAuthenticationInstant());
188         loginContext.setAuthenticationMethod(authenticationMethod.getAuthenticationMethod());
189         loginContext.setPrincipalAuthenticated(true);
190         loginContext.setPrincipalName(shibSession.getPrincipalName());
191
192         ServiceInformation serviceInfo = new ServiceInformationImpl(loginContext.getRelyingPartyId(), new DateTime(),
193                 authenticationMethod);
194         shibSession.getServicesInformation().put(serviceInfo.getEntityID(), serviceInfo);
195
196         returnToProfileHandler(loginContext, httpRequest, httpResponse);
197     }
198
199     /**
200      * Performs the first part of user authentication. An authentication handler is determined, the login context is
201      * populated with some initial information, and control is forward to the selected handler so that it may
202      * authenticate the user.
203      * 
204      * @param httpRequest current HTTP request
205      * @param httpResponse current HTTP response
206      */
207     protected void authenticateUserWithoutActiveMethod1(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
208         HttpSession httpSession = httpRequest.getSession();
209         LoginContext loginContext = (LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
210         LOG.debug("Selecting appropriate authentication method for request.");
211         Pair<String, LoginHandler> handler = getProfileHandlerManager().getAuthenticationHandler(loginContext);
212
213         if (handler == null) {
214             loginContext.setPrincipalAuthenticated(false);
215             loginContext.setAuthenticationFailureMessage("No AuthenticationHandler satisfys the request from: "
216                     + loginContext.getRelyingPartyId());
217             LOG.error("No AuthenticationHandler satisfies the request from relying party: "
218                     + loginContext.getRelyingPartyId());
219             returnToProfileHandler(loginContext, httpRequest, httpResponse);
220             return;
221         }
222
223         LOG.debug("Authentication method {} will be used to authenticate user.", handler.getFirst());
224         loginContext.setAuthenticationAttempted();
225         loginContext.setAuthenticationDuration(handler.getSecond().getAuthenticationDuration());
226         loginContext.setAuthenticationMethod(handler.getFirst());
227         loginContext.setAuthenticationEngineURL(HttpHelper.getRequestUriWithoutContext(httpRequest));
228
229         LOG.debug("Transferring control to authentication handler of type: {}", handler.getSecond().getClass()
230                 .getName());
231         handler.getSecond().login(httpRequest, httpResponse);
232     }
233
234     /**
235      * Performs the second part of user authentication. The principal name set by the authentication handler is
236      * retrieved and pushed in to the login context, a Shibboleth session is created if needed, information indicating
237      * that the user has logged into the service is recorded and finally control is returned back to the profile
238      * handler.
239      * 
240      * @param httpRequest current HTTP request
241      * @param httpResponse current HTTP response
242      */
243     protected void authenticateUserWithoutActiveMethod2(HttpServletRequest httpRequest, HttpServletResponse httpResponse) {
244         HttpSession httpSession = httpRequest.getSession();
245
246         String principalName = (String) httpRequest.getAttribute(LoginHandler.PRINCIPAL_NAME_KEY);
247         LoginContext loginContext = (LoginContext) httpSession.getAttribute(LoginContext.LOGIN_CONTEXT_KEY);
248         if (DatatypeHelper.isEmpty(principalName)) {
249             loginContext.setPrincipalAuthenticated(false);
250             loginContext.setAuthenticationFailureMessage("No principal name returned from authentication handler.");
251             LOG.error("No principal name returned from authentication method: "
252                     + loginContext.getAuthenticationMethod());
253             returnToProfileHandler(loginContext, httpRequest, httpResponse);
254             return;
255         }
256         loginContext.setPrincipalAuthenticated(true);
257         loginContext.setPrincipalName(principalName);
258         loginContext.setAuthenticationInstant(new DateTime());
259
260         String shibSessionId = (String) httpSession.getAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE);
261         Session shibSession = getSessionManager().getSession(shibSessionId);
262
263         if (shibSession == null) {
264             LOG.debug("Creating shibboleth session for principal {}", principalName);
265
266             InetAddress addr;
267             try {
268                 addr = InetAddress.getByName(httpRequest.getRemoteAddr());
269             } catch (UnknownHostException ex) {
270                 addr = null;
271             }
272
273             shibSession = (Session) getSessionManager().createSession(addr, loginContext.getPrincipalName());
274             loginContext.setSessionID(shibSession.getSessionID());
275             httpSession.setAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE, shibSession.getSessionID());
276         }
277
278         LOG.debug("Recording authentication and service information in Shibboleth session for principal: {}",
279                 principalName);
280         Subject subject = (Subject) httpRequest.getAttribute(LoginHandler.SUBJECT_KEY);
281         String authnMethod = (String) httpRequest.getAttribute(LoginHandler.AUTHENTICATION_METHOD_KEY);
282         if (DatatypeHelper.isEmpty(authnMethod)) {
283             authnMethod = loginContext.getAuthenticationMethod();
284         }
285
286         AuthenticationMethodInformation authnMethodInfo = new AuthenticationMethodInformationImpl(subject, authnMethod,
287                 new DateTime(), loginContext.getAuthenticationDuration());
288
289         shibSession.getAuthenticationMethods().put(authnMethodInfo.getAuthenticationMethod(), authnMethodInfo);
290
291         ServiceInformation serviceInfo = new ServiceInformationImpl(loginContext.getRelyingPartyId(), new DateTime(),
292                 authnMethodInfo);
293         shibSession.getServicesInformation().put(serviceInfo.getEntityID(), serviceInfo);
294
295         shibSession.setLastActivityInstant(new DateTime());
296
297         returnToProfileHandler(loginContext, httpRequest, httpResponse);
298     }
299
300     /**
301      * Gets the authentication method, currently active for the user, that also meets the requirements expressed by the
302      * login context. If a method is returned the user does not need to authenticate again, if null is returned then the
303      * user must be authenticated.
304      * 
305      * @param loginContext user login context
306      * @param shibSession user's shibboleth session
307      * 
308      * @return active authentication method that meets authentication requirements or null
309      */
310     protected AuthenticationMethodInformation getUsableExistingAuthenticationMethod(LoginContext loginContext,
311             Session shibSession) {
312         if (loginContext.getForceAuth() || shibSession == null) {
313             return null;
314         }
315
316         List<String> preferredAuthnMethods = loginContext.getRequestedAuthenticationMethods();
317
318         if (preferredAuthnMethods == null || preferredAuthnMethods.size() == 0) {
319             for (AuthenticationMethodInformation authnMethod : shibSession.getAuthenticationMethods().values()) {
320                 if (!authnMethod.isExpired()) {
321                     return authnMethod;
322                 }
323             }
324         } else {
325             for (String preferredAuthnMethod : preferredAuthnMethods) {
326                 if (shibSession.getAuthenticationMethods().containsKey(preferredAuthnMethod)) {
327                     AuthenticationMethodInformation authnMethodInfo = shibSession.getAuthenticationMethods().get(
328                             preferredAuthnMethod);
329                     if (!authnMethodInfo.isExpired()) {
330                         return authnMethodInfo;
331                     }
332                 }
333             }
334         }
335
336         return null;
337     }
338 }