Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   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.net.URL;
 import java.util.Date;
 import java.util.List;
 
 
 import base.KeyValue;
 
 import base.json.Json;
 
 import static base.jee.servlet.BaseServlet.getSite;

Web applications wishing to use the security features of the base library apply this servlet filters to all pages requiring authentication and/or authorisation.
 
 public class AuthorisationFilter implements Filter {
 
 	private String authFailUrl;
 	private String authSuccessUrl;
 	private boolean blockFrames;
 	private JeeBase jee;
 	private boolean disableApiServlet;
 
 	private static final int HTTP_MOVED_TEMPORARILY = 302;
 	private static final int MAX_BROWSER_COOKIE_AGE = 60*60*24*365;
 
 
 	public AuthorisationFilter(JeeBase jeeString authSuccessUrlString authFailUrlthrows IOException {
 		this(jeeauthSuccessUrlauthFailUrlfalse);
	}
	public AuthorisationFilter(JeeBase jeeString authSuccessUrlString authFailUrlboolean disableApiServletthrows IOException {
		if(jee.getSettings().get("cookie.domain"null) == null) {
			jee.getSettings().set("cookie.domain""");
		}
		this. = jee;
		this. = authFailUrl;
		this. = authSuccessUrl;
		this. = 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.
			..println("WARNING: base.url system setting references localhost. Sign-in will not work on some browsers!!!!");
		}
	}
	public void init(FilterConfig configthrows ServletException {
		ServletContext context = config.getServletContext();
		// Register with every servlet provided by the base.jee.servlet package
		context.addServlet("signin"s).addMapping("/signin");
		context.addServlet("setup"s).addMapping("/setup");
			context.addServlet("api"new base.jee.servlet.ApiServlet()).addMapping("/api/*");
		}
		context.addServlet("activate.account"new ActivateAccountServlet()).addMapping("/activate.account");
		context.addServlet("audit"new AuditServlet()).addMapping("/audit");
		context.addServlet("audit.download"new AuditDownloadServlet()).addMapping("/audit.download");
		context.addServlet("group.members"new GroupMembersServlet()).addMapping("/group.members");
		context.addServlet("group.roles"new GroupRolesServlet()).addMapping("/group.roles");
		context.addServlet("groups"new GroupsServlet()).addMapping("/groups");
		context.addServlet("password.reset"new PasswordResetServlet()).addMapping("/password.reset");
		context.addServlet("people"new PeopleServlet()).addMapping("/people");
		context.addServlet("people.export"new PeopleExportCsvServlet()).addMapping("/people.export");
		context.addServlet("person.edit"new PersonEditServlet()).addMapping("/person.edit");
		context.addServlet("person.new"new PersonNewServlet()).addMapping("/person.new");
		context.addServlet("settings"new SettingServlet()).addMapping("/settings");
		context.addServlet("signup"new SignUpServlet()).addMapping("/signup");
		context.addServlet("singup.confirm"new SignupConfirmServlet("/")).addMapping("/signup.confirm");
		context.addServlet("suspended.accounts"new SuspendedAccountsServlet()).addMapping("/suspended.accounts");
		context.addServlet("template"new TemplateServlet()).addMapping("/template");
		context.addServlet("template.download"new TemplateDownloadServlet()).addMapping("/template.download");
		context.addServlet("templates"new TemplatesServlet()).addMapping("/templates");
		context.addServlet("terms_and_conditions"new TermsAndConditionsServlet()).addMapping("/terms_and_conditions");
		context.addServlet("resource"new ResourceServlet()).addMapping("/resource");
		ServletRegistration.Dynamic m = context.addServlet("template.file_upload"new TemplateFileUploadServlet());
		m.addMapping("/template.file_upload");
	}
	public void destroy() {
	}
	public void doFilter(ServletRequest requestServletResponse responseFilterChain chainthrows IOExceptionServletException {
		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) {
					token = cookie.getValue();
					originalToken = cookie.getValue();
					break;
				}
			}
		}
			((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(, (HttpServletRequest)request, (HttpServletResponse)response)) {
				return;
			}
			if(url.endsWith("/signout")) {
				if(token != null) {
				}
				((HttpServletResponse)response).setHeader("Location".getSettings().get("base.url""") + "/");
				attachCookieToResponse(responsetoken);
				return;
			}
			if(request.getParameter("signin_username") != null && request.getParameter("signin_password") != null) {
				String site = getSite((HttpServletRequest)request);
				String newToken = null;
				List<KeyValuer = .getAPI().authenticate(sitetokenrequest.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) {
					.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(.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".getSettings().get("base.url""") +  + "&u=" + StringHelper.urlEscape(request.getParameter("signin_username")) + suspended + includedTarget);
					token = StringHelper.randomString(.); // Authentication failure includes new cookie token
					attachCookieToResponse(responsetoken);
					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
						.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) + "...";
						.log("DEBUG""User credentials switched from token \"" + oldTkn + "\" to \"" + tkn + "\"");
					}
					token = newToken;
				}
				attachCookieToResponse(responsetoken);
				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(.getSettings().get("base.url"""));
						if(target.getHost().equalsIgnoreCase(base.getHost())) {
							.log("DEBUG""Signin redirects to target url: " + target.toString());
							((HttpServletResponse)response).setHeader("Location"target.toString());
							return;
else {
							.log("WARN""Signin request contains external target url: " + request.getParameter("target"));
						}
catch(MalformedURLException e) {
						.log("FINEST""Signin request contains malformed target or base url: [\"" + Json.escape(request.getParameter("target")) + "\",\"" + Json.escape(.getSettings().get("base.url""")) + "\"]");
					}
				}
				// Signin succeeded, go to the "authSuccessUrl" as the starting page.
				((HttpServletResponse)response).setHeader("Location".getSettings().get("base.url""") + );
				return;
			}
			// No token found in either a cookie, or as a result of a sign in
			// request.
			if(token == null) {
				attachCookieToResponse(responsetoken);
			}
			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(requestresponse);
catch(Exception e) {
			if(!response.isCommitted()) {
				returnErrorPage(requestresponseiporiginalTokene);
			}
		}
	}

An exception has been thrown by either the AuthorisationFilter, or the something further down the filter chain. Usually this is caused by an unhandled exception in a servlet.

Parameters:
request
response
ip
originalToken
e
Throws:
java.io.IOException
	private void returnErrorPage(ServletRequest requestServletResponse responseString ipString originalTokenException ethrows IOException {
		String site = getSite((HttpServletRequest)request);
		User u;
		if(e.getClass().getSimpleName().equals("NoHostAvailableException")) {
			u = User.userWithIp(ipsite);
else {
			u = .getAPI().getUserSession(site, (String)request.getAttribute("token"), ip);
		}
		response.setContentType("text/html; charset=UTF-8");
		response.setCharacterEncoding("UTF-8");
		if(e instanceof PermissionException) {
			String referer = ((HttpServletRequest)request).getHeader("Referer");
			StringBuilder currentRoles = new StringBuilder();
			ST page = .getPage(u"permission_denied");
			if(.getSettings().get("support_team.name""").length() > 0) {
				page.add("support_name".getSettings().get("support_team.name"null));
				if(.getSettings().get("support_team.url""").length() > 0) {
					page.add("support_url".getSettings().get("support_team.url"null));
else {
					page.add("support_url""mailto:" + .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".getSettings().get("stacktrace.show""").equalsIgnoreCase("true") || .getSettings().get("stacktrace.show""").equalsIgnoreCase("y") || .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());
			.log("FINE""Permission denied: Command \"" + pe.getCommand() + "\" required role \"" + pe.getRole() + "\" but user had roles \"" + currentRoles + "\". Referer: " + referer + " URL: " + eurlu);
else if(e instanceof ThrottledException) {
			ST page = .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());
			.log("FINE""Throttled: " + e.getMessage(), u);
else {
			ST page = .getPage(u"exception");
			page.add("breadcrumbs"new Breadcrumb("System error"null));
			page.add("time"new Date());
			page.add("referer", ((HttpServletRequest)request).getHeader("Referer"));
			if(.getSettings().get("stacktrace.show""").equalsIgnoreCase("true") || .getSettings().get("stacktrace.show""").equalsIgnoreCase("y") || .getSettings().get("stacktrace.show""").equalsIgnoreCase("yes")) {
				page.add("stacktrace", StringHelper.exceptionToString(e"\n"));
			}
			page.add("url"getFullURL((HttpServletRequest)request));
			response.getWriter().write(page.render());
			.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 jeeServletResponse responseString tokenthrows IOException {
		Cookie cookie = new Cookie(jee.cookieNametoken);
		cookie.setHttpOnly(true);
		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);
	}
New to GrepCode? Check out our FAQ X