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