base.jee.AuthorisationFilter Maven / Gradle / Ivy

/*
 This is free and unencumbered software released into the public domain.

 Anyone is free to copy, modify, publish, use, compile, sell, or
 distribute this software, either in source code form or as a compiled
 binary, for any purpose, commercial or non-commercial, and by any
 means.

 In jurisdictions that recognize copyright laws, the author or authors
 of this software dedicate any and all copyright interest in the
 software to the public domain. We make this dedication for the benefit
 of the public at large and to the detriment of our heirs and
 successors. We intend this dedication to be an overt act of
 relinquishment in perpetuity of all present and future rights to this
 software under copyright law.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 */
package base.jee;

import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Date;
import java.util.List;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import base.KeyValue;
import base.jee.servlet.BaseServlet;
import org.stringtemplate.v4.ST;

import base.json.Json;
import base.security.PermissionException;
import base.security.ThrottledException;
import base.security.User;
import base.text.StringHelper;

import static base.jee.servlet.BaseServlet.getSite;

public class AuthorisationFilter implements Filter {

	private String authFailUrl;
	private String authSuccessUrl;
	private boolean blockFrames;
	private JeeBase jee;

	public AuthorisationFilter(JeeBase jee, String authSuccessUrl, String authFailUrl) throws IOException {

		if(jee.getSettings().get("cookie.domain", null) == null) {
			jee.getSettings().set("cookie.domain", "");
		}

		this.jee = jee;
		this.authFailUrl = authFailUrl;
		this.authSuccessUrl = authSuccessUrl;
		this.blockFrames = jee.getSettings().get("frame.protection", "").equalsIgnoreCase("true")||jee.getSettings().get("frame.protection", "").equalsIgnoreCase("y")||jee.getSettings().get("frame.protection", "").equalsIgnoreCase("yes");

		if(jee.getSettings().get("base.url", "").toLowerCase().contains("localhost")) {
			// The sign in process ivolves setting a user cookie and doing a 302 redirect
			// to send the user to the main/front page. In some browsers, this does not
			// work if the url contains the domain name "localhost". Warn the user in
			// the best way possible, aka print to STDERR.
			System.err.println("WARNING: base.url system setting references localhost. Sign-in will not work on some browsers!!!!");
		}
	}

	public void init(FilterConfig config) throws ServletException {
	}

	@Override
	public void destroy() {
	}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
		String url = ((HttpServletRequest)request).getRequestURI();
		String ip = BaseServlet.getIp((HttpServletRequest)request);
		String token = null;
		String originalToken = null;

		// Fetch users session token.
		Cookie[] cookies = ((HttpServletRequest)request).getCookies();
		if(cookies != null) {
			for (Cookie cookie : cookies) {
				if (cookie.getName().equalsIgnoreCase(jee.cookieName)) {
					token = cookie.getValue();
					originalToken = cookie.getValue();
					break;
				}
			}
		}

		if(blockFrames) {
			((HttpServletResponse)response).setHeader("X-Frame-Options", "deny");
		}

		try {
			// If the URL references a static resource, the resource contents are returned, no authentication logic required.
			if(ResourceManager.loadResource(jee, (HttpServletRequest)request, (HttpServletResponse)response)) {
				return;
			}

			if(url.endsWith("/signout")) {
				if(token != null) {
					jee.getAPI().invalidateSession(getSite((HttpServletRequest) request), token, ip);
				}
				((HttpServletResponse)response).setHeader("Location", jee.getSettings().get("base.url", "") + "/");
				((HttpServletResponse)response).setStatus(302);
				token = StringHelper.randomString(Constants.SESSION_TOKEN_LENGTH);
				attachCookieToResponse(jee, response, token);
				return;
			}

			if(request.getParameter("signin_username") != null && request.getParameter("signin_password") != null) {
				String site = getSite((HttpServletRequest)request);

				String newToken = null;
				List r = jee.getAPI().authenticate(site, token, request.getParameter("signin_username"), request.getParameter("signin_password"), ip);
				if(r != null && r.size() > 0 && r.get(0).getKey().equals("token")) {
					newToken = r.get(0).getValue();
				}
				if(newToken == null) {
					jee.log("DEBUG", "Authentication request failed for user " + request.getParameter("signin_username"));
					String includedTarget = "";
					if(request.getParameter("target") != null) {
						try {
							URL target = new URL(request.getParameter("target"));
							URL base = new URL(jee.getSettings().get("base.url", ""));
							if(target.getHost().equalsIgnoreCase(base.getHost())) {
								includedTarget = "&target=" + StringHelper.urlEscape(target.toString());
							}
						} catch(MalformedURLException e) {
						}
					}
					String suspended = "";
					if(r != null && r.size() > 0 && r.get(0).getValue().toLowerCase().contains("temporarily disabled")) {
						suspended = "&suspended=";
					}
					((HttpServletResponse)response).setHeader("Location", jee.getSettings().get("base.url", "") + authFailUrl + "&u=" + StringHelper.urlEscape(request.getParameter("signin_username")) + suspended + includedTarget);
					((HttpServletResponse)response).setStatus(302);
					token = StringHelper.randomString(Constants.SESSION_TOKEN_LENGTH); // Authentication failure includes new cookie token
					attachCookieToResponse(jee, response, token);
					return;
				}
				if(token == null || !newToken.equals(token)) {
					// Only output half of the token, to prevent extraction of token in string templates
					String tkn = newToken.substring(0, newToken.length()/2) + "...";

					if(token == null) {
						// Sign in from user that has not loaded the sign in page, ie potential script access
						jee.log("DEBUG", "Authentication from browser that did not have a cookie \"" + tkn + "\".");
					} else {
						// Sign in from a user while a different user is already signed in using this browser
						String oldTkn = token.substring(0, token.length()/2) + "...";
						jee.log("DEBUG", "User credentials switched from token \"" + oldTkn + "\" to \"" + tkn + "\"");
					}
					token = newToken;
				}
				attachCookieToResponse(jee, response, token);
				request.setAttribute("token", token);

				// If signin succeeds, target URL parameter may be used to do a custom redirect to a specific page within the same domain
				if(request.getParameter("target") != null) {
					try {
						URL target = new URL(request.getParameter("target"));
						URL base = new URL(jee.getSettings().get("base.url", ""));
						if(target.getHost().equalsIgnoreCase(base.getHost())) {
							jee.log("DEBUG", "Signin redirects to target url: " + target.toString());
							((HttpServletResponse)response).setHeader("Location", target.toString());
							((HttpServletResponse)response).setStatus(302);
							return;
						} else {
							jee.log("WARN", "Signin request contains external target url: " + request.getParameter("target"));
						}
					} catch(MalformedURLException e) {
						jee.log("FINEST", "Signin request contains malformed target or base url: [\"" + Json.escape(request.getParameter("target")) + "\",\"" + Json.escape(jee.getSettings().get("base.url", "")) + "\"]");
					}
				}

				// Signin succeeded, go to the "authSuccessUrl" as the starting page.
				((HttpServletResponse)response).setHeader("Location", jee.getSettings().get("base.url", "") + authSuccessUrl);
				((HttpServletResponse)response).setStatus(302);
				return;
			}

			// No token found in either a cookie, or as a result of a sign in
			// request.
			if(token == null) {
				token = StringHelper.randomString(Constants.SESSION_TOKEN_LENGTH);
				attachCookieToResponse(jee, response, token);
			}
			request.setAttribute("token", token);

			((HttpServletResponse)response).setHeader("Pragma", "nocache");
			((HttpServletResponse)response).setHeader("Cache-Control", "no-cache, no-store, max-age=0");
			((HttpServletResponse)response).setDateHeader("Expires", 0);

			chain.doFilter(request, response);
		} catch(Exception e) {
			if(!response.isCommitted()) {
				String site = getSite((HttpServletRequest)request);
				User u = jee.getAPI().getUserSession(site, (String)request.getAttribute("token"), BaseServlet.getIp((HttpServletRequest)request));
				response.setContentType("text/html; charset=UTF-8");
				response.setCharacterEncoding("UTF-8");

				if(e instanceof PermissionException) {
					PermissionException pe = (PermissionException)e;
					String eurl = getFullURL((HttpServletRequest)request);
					String referer = ((HttpServletRequest)request).getHeader("Referer");
					StringBuilder currentRoles = new StringBuilder();

					ST page = jee.getPage(u, "permission_denied");
					if(jee.getSettings().get("support_team.name", "").length() > 0) {
						page.add("support_name", jee.getSettings().get("support_team.name", null));
						if(jee.getSettings().get("support_team.url", "").length() > 0) {
							page.add("support_url", jee.getSettings().get("support_team.url", null));
						} else {
							page.add("support_url", "mailto:" + jee.getSettings().get("support_team.email", null));
						}
					}

					page.remove("user");
					page.add("url", eurl);
					page.add("breadcrumbs", new Breadcrumb("Authorisation failure", null));
					page.add("time", new Date());
					page.add("referer", referer);
					if(pe.getUser() != null) {
						page.add("user", pe.getUser());
						if(pe.getUser().getRoles().length > 0) {
							page.add("user_roles", pe.getUser().getRoles());
							for(String r : pe.getUser().getRoles()) {
								if(currentRoles.length() > 0) {
									currentRoles.append(",");
								}
								currentRoles.append(r);
							}
						} else {
							page.add("user_roles", null);
						}
					} else {
						page.add("user", null);
						page.add("user_roles", null);
					}

					page.add("permission", e);
					page.add("details", jee.getSettings().get("stacktrace.show", "").equalsIgnoreCase("true") || jee.getSettings().get("stacktrace.show", "").equalsIgnoreCase("y") || jee.getSettings().get("stacktrace.show", "").equalsIgnoreCase("yes"));

					// Pull cookie that was sent with page request out of request headers.
					page.add("token", originalToken);

					response.getWriter().write(page.render());

					jee.log("FINE", "Permission denied: Command \"" + pe.getCommand() + "\" required role \"" + pe.getRole() + "\" but user had roles \"" + currentRoles + "\". Referer: " + referer + " URL: " + eurl, u);
				} else if(e instanceof ThrottledException) {
					ST page = jee.getPage(u, "throttled");
					page.remove("user");
					page.add("breadcrumbs", new Breadcrumb("Access temporarily suspended", null));
					page.add("time", new Date());
					if(((HttpServletRequest)request).getHeader("Referer") != null){
						page.add("referer", ((HttpServletRequest)request).getHeader("Referer"));
					}
					page.add("exception", e);

					// Pull cookie that was sent with page request out of request headers.
					page.add("token", originalToken);

					response.getWriter().write(page.render());

					jee.log("FINE", "Throttled: " + e.getMessage(), u);
				} else {
					ST page = jee.getPage(u, "exception");
					page.add("breadcrumbs", new Breadcrumb("System error", null));
					page.add("time", new Date());
					page.add("referer", ((HttpServletRequest)request).getHeader("Referer"));
					if(jee.getSettings().get("stacktrace.show", "").equalsIgnoreCase("true") || jee.getSettings().get("stacktrace.show", "").equalsIgnoreCase("y") || jee.getSettings().get("stacktrace.show", "").equalsIgnoreCase("yes")) {
						page.add("stacktrace", StringHelper.exceptionToString(e, "\n"));
					}
					page.add("url", getFullURL((HttpServletRequest)request));
					response.getWriter().write(page.render());

					jee.log("FINE", "Unhandled exception: " + StringHelper.exceptionToString(e, "\n"), u);
				}

			}
		}
	}

	public static String getFullURL(HttpServletRequest request) {
		StringBuffer requestURL = request.getRequestURL();
		String queryString = request.getQueryString();

		if (queryString == null) {
			return requestURL.toString();
		} else {
			return requestURL.append('?').append(queryString).toString();
		}
	}

	public static void attachCookieToResponse(JeeBase jee, ServletResponse response, String token) throws IOException {
		Cookie cookie = new Cookie(jee.cookieName, token);
		cookie.setHttpOnly(true);
		cookie.setMaxAge(60*60*24*365);
		String base = jee.getSettings().get("base.url", "");
		if(base.length() > 0) {
			try {
				URL u = new URL(base);
				String path = u.getPath();
				if(path.length() == 0) {
					path = "/";
				}
				if(path.length() > 0 && !path.endsWith("/")) {
					path = path + "/";
				}
				String domain = jee.getSettings().get("cookie.domain", "");
				if(domain != null && domain.length() > 0) {
					cookie.setDomain(domain);
				}
				cookie.setPath(path);
			} catch(MalformedURLException e) {
				// No action required if URL can't be read.
			}
		}
		String s = jee.getSettings().get("cookies.secure", "");
		if(s.equalsIgnoreCase("true") || s.equalsIgnoreCase("yes") || s.equalsIgnoreCase("y")) {
			cookie.setSecure(true);
		}
		((HttpServletResponse)response).addCookie(cookie);
	}

}