use null safe equality checks
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / session / IdPSessionFilter.java
1 /*
2  * Copyright 2008 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.session;
18
19 import java.io.IOException;
20
21 import javax.servlet.Filter;
22 import javax.servlet.FilterChain;
23 import javax.servlet.FilterConfig;
24 import javax.servlet.ServletException;
25 import javax.servlet.ServletRequest;
26 import javax.servlet.ServletResponse;
27 import javax.servlet.http.Cookie;
28 import javax.servlet.http.HttpServletRequest;
29 import javax.servlet.http.HttpServletResponse;
30
31 import org.joda.time.DateTime;
32 import org.opensaml.xml.util.DatatypeHelper;
33
34 import edu.internet2.middleware.shibboleth.common.session.SessionManager;
35
36 /**
37  * A filter that adds the current users {@link Session} the request, if the user has a session.
38  */
39 public class IdPSessionFilter implements Filter {
40
41     /** Name of the IdP Cookie containing the IdP session ID. */
42     public static final String IDP_SESSION_COOKIE_NAME = "_idp_session";
43
44     /** IdP session manager. */
45     private SessionManager<Session> sessionManager;
46
47     /** {@inheritDoc} */
48     public void destroy() {
49
50     }
51
52     /** {@inheritDoc} */
53     public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException,
54             ServletException {
55         HttpServletRequest httpRequest = (HttpServletRequest) request;
56         HttpServletResponse httpResponse = (HttpServletResponse) response;
57
58         Session idpSession = null;
59         Cookie idpSessionCookie = getIdPSessionCookie(httpRequest);
60         if (idpSessionCookie != null) {
61             idpSession = sessionManager.getSession(idpSessionCookie.getValue());
62             if (idpSession != null) {
63                 idpSession.setLastActivityInstant(new DateTime());
64                 httpRequest.setAttribute(Session.HTTP_SESSION_BINDING_ATTRIBUTE, idpSession);
65             }
66         }
67
68         addIdPSessionCookieToResponse(httpRequest, httpResponse, idpSession);
69
70         filterChain.doFilter(request, response);
71     }
72
73     /** {@inheritDoc} */
74     public void init(FilterConfig filterConfig) throws ServletException {
75         sessionManager = (SessionManager<Session>) filterConfig.getServletContext().getAttribute("sessionManager");
76     }
77
78     /**
79      * Gets the IdP session cookie from the current request, if the user currently has a session.
80      * 
81      * @param request current HTTP request
82      * 
83      * @return the user's current IdP session cookie, if they have a current session, otherwise null
84      */
85     protected Cookie getIdPSessionCookie(HttpServletRequest request) {
86         Cookie[] requestCookies = request.getCookies();
87
88         if (requestCookies != null) {
89             for (Cookie requestCookie : requestCookies) {
90                 if (DatatypeHelper.safeEquals(requestCookie.getDomain(), request.getLocalName())
91                         && DatatypeHelper.safeEquals(requestCookie.getPath(), request.getContextPath())
92                         && DatatypeHelper.safeEquals(requestCookie.getName(), IDP_SESSION_COOKIE_NAME)) {
93                     return requestCookie;
94                 }
95             }
96         }
97
98         return null;
99     }
100
101     /**
102      * Adds a cookie, containing the user's IdP session ID, to the response.
103      * 
104      * @param request current HTTP request
105      * @param response current HTTP response
106      * @param userSession user's currentSession
107      */
108     protected void addIdPSessionCookieToResponse(HttpServletRequest request, HttpServletResponse response,
109             Session userSession) {
110         Cookie sessionCookie = new Cookie(IDP_SESSION_COOKIE_NAME, userSession.getSessionID());
111         sessionCookie.setDomain(request.getLocalName());
112         sessionCookie.setPath(request.getContextPath());
113         sessionCookie.setSecure(false);
114
115         int maxAge = (int) (userSession.getInactivityTimeout() / 1000);
116         sessionCookie.setMaxAge(maxAge);
117
118         response.addCookie(sessionCookie);
119     }
120 }