1 /**
2 * This file Copyright (c) 2003-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.security;
35
36 import info.magnolia.cms.filters.AbstractMgnlFilter;
37
38 import java.io.IOException;
39
40 import javax.servlet.FilterChain;
41 import javax.servlet.ServletException;
42 import javax.servlet.http.HttpServletRequest;
43 import javax.servlet.http.HttpServletResponse;
44
45 /**
46 * Provides basic infrastructure for filters which check if a request is authorized.
47 */
48 public abstract class BaseSecurityFilter extends AbstractMgnlFilter {
49
50 /**
51 * Continue with the Magnolia defined filter chain if {@link #isAllowed} returns true. Else subclasses
52 * should set the appropriate http response code 401 (or 403).
53 */
54 @Override
55 public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException {
56 if (isAllowed(request, response)) {
57 chain.doFilter(request, response);
58 } else {
59 doAuthenticate(request, response);
60 }
61 }
62
63 /**
64 * Implementations need to return false if the request can not be proceeded with, but also need to set an appropriate error code.
65 */
66 protected abstract boolean isAllowed(HttpServletRequest request, HttpServletResponse response) throws IOException;
67
68 /**
69 * TODO : verify we do have a correct http status code?.
70 *
71 * @deprecated since 4.5, should not be needed, and does nothing.
72 */
73 @Deprecated
74 protected void doAuthenticate(HttpServletRequest request, HttpServletResponse response) {
75 /*
76 HttpSession httpsession = request.getSession(false);
77 if (httpsession != null) {
78 httpsession.invalidate();
79 }
80 */
81 }
82
83 }