OWASP Stinger Manual

=Overview=

The purpose of the OWASP Stinger manual is to provide users a comprehensive guide to developing upon and deploying the OWASP J2EE Stinger filter. If you have any comments or suggestions concerning the Stinger manual, please to not hesitate to email me at [mailto:eric.sheridan@owasp.org eric.sheridan@owasp.org].

=Development=

=Deployment=

Fetch the Latest Files
The latest Stinger release can be downloaded [TBD here]. The user implementing Stinger should download the jar file into a directory accessible by the Java container. For example, deploying Stinger in Tomcat would require downloading the files in the WEB-INF/lib/ directory.

Configure Deployment Descriptor
There are two major pieces of information necessary to deploy Stinger in your J2EE environment. First, the Java container must be told to implement the Stinger J2EE filter. This is specified in the web.xml file via the following:

StingerFilter org.owasp.stinger.StingerFilter  config C:\stinger.xml   errmsg A serious error has occurred   reload</param-name> true</param-value> </init-param>

Stinger 2.0 accepts three filter parameters: config, errmsg, and reload. The config parameter tells the Stinger filter the location of the SVDL file. The errmsg parameter is actually the result of a new feature in Stinger 2.0. All exceptions that are thrown from the web application are now caught in Stinger. This prevents sending exceptions to the client and potentially revealing sensitive information (think database exceptions). Instead of leaking sensitive information, Stinger simply writes a message to the client upon catching an exception. The errmsg parameter specifies the message that will be displayed to the user. The third parameter, reload, tells Stinger whether to dynamically load the SVDL file for each incoming HTTP request. As a rule of thumb, set reload to true in testing environments and false for production environments.

The second major piece of information dictates which requests should pass the Stinger J2EE filter. This is specified in the web.xml file via the following:

<filter-mapping> StingerFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>

This entry tells the J2EE container that every request handled by the container should pass through the Stinger filter.

Configure Your SVDL File
A template SVDL file for the latest Stinger release can be found [TBD here]. The SVDL file is broken down into three sections.


 * The Regular Expression Section
 * The Cookie Rule Section
 * The Parameter Rule Section

The Regular Expression Section
All regular expressions to be used in Stinger are defined in this section. Essentially, a regular expression entry is comprised of a name, a regular expression, and a description. The description element is for user readability and is not used within Stinger. The regular expressions equiped with Stinger were taken from the OWASP RegEx Repository. If you have custom regular expressions and would like to donate them to the Stinger project, please email me at [mailto:eric.sheridan@owasp.org eric.sheridan@owasp.org].

The following is a sample entry in the regular expression section:

JSESSIONID ^[A-F0-9]{32}$ JSESSIONID character and length enforcement

The Cookie Rule Section
This section contains definitions for all of the cookies for which we are assigning a rule. A cookie rule is comprised of a name, a regular expression, the URI in which it is created, the URI's which it is enforced, and the actions taken if the cookie is missing or malformed. For most web applications, we wish to create and enforce a cookie for a particular URI. In this case, we have an entry similar to the one found below. In this case the following rule applies: ''if a cookie is missing from the request sent to the created/enforced URI, then no violation occurs. However, if a cookis is malformed in the request sent to the created/enforced URI, then a violation occurs.''

The missing and malformed sections simply specify the severity of the violation as well as the actions to be executed. There exists three possible severities: FATAL, CONTINUE, and IGNORE.


 * If a severity is FATAL, then Stinger stops processing the packet and immediately executes the associated actions.
 * If a severity is CONTINUE, then Stinger appends the violation a list and continues to process the packet.
 * If a severity is IGNORE, no violation is appended to the list of violation and Stinger continues its request validation.

Several actions accept parameters which are designated by the tag.

The following is a sample entry in the cookie rule section:

JSESSIONID JSESSIONID /Stinger-2.0-Lite /Stinger-2.0-Lite /Stinger-2.0-Lite/ /Stinger-2.0-Lite/index.html FATAL <action class="org.owasp.stinger.actions.Log"> log default.log level SEVERE message The required JSESSIONID cookie is missing <action class="org.owasp.stinger.actions.Invalidate" /> <action class="org.owasp.stinger.actions.ClearCookies" /> <action class="org.owasp.stinger.actions.Redirect"> page error.html FATAL <action class="org.owasp.stinger.actions.Log"> log default.log level SEVERE message The JSESSIONID cookie is malformed <action class="org.owasp.stinger.actions.Invalidate" /> <action class="org.owasp.stinger.actions.ClearCookies" /> <action class="org.owasp.stinger.actions.Redirect"> page error.html

The Parameter Section
The parameter section describes the parameter rules associated with a particular URI. A URI and its associated rules constitute a rule set. Every SVDL implementation must contain a default rule set similar to the following:

STINGER_DEFAULT STINGER_DEFAULT STINGER_ALL safetext ignore continue <action class="org.owasp.stinger.actions.Log"> log default.log level info message parameter %name with value %value from %ip has been sanitized <action class="org.owasp.stinger.actions.Sanitize" />

A default Stinger rule set must have the path (the URI) set to STINGER_DEFAULT and the rule name set to STINGER_ALL. When a request to a URI without an associated rule set is submitted, the default rule set is utilized. When a parameter without an associated rule is sent to the application, then the default rules are utilized.

The following is a sample rule set entry for a fictitious web application:

Main /Stinger-2.0-Lite /Stinger-2.0-Lite/ /Stinger-2.0-Lite/index.jsp username safetext continue <action class="org.owasp.stinger.actions.DisplayMessage"> message The required username parameter is missing bgcolor yellow continue <action class="org.owasp.stinger.actions.Log"> log default.log level info message The username parameter from %ip is malformed <action class="org.owasp.stinger.actions.Sanitize" /> hidden1 safetext fatal <action class="org.owasp.stinger.actions.Log"> log default.log level info message The hidden1 parameter is missing <action class="org.owasp.stinger.actions.Invalidate" /> <action class="org.owasp.stinger.actions.Redirect"> page error.html fatal <action class="org.owasp.stinger.actions.Log"> log default.log level SEVERE message hidden1 parameter from %ip is malformed <action class="org.owasp.stinger.actions.Invalidate" /> <action class="org.owasp.stinger.actions.Redirect"> page error.html

Although this entry is quite large, there are only a few new entries which must be noted. As we see, this rule set applies to several paths:


 * /Stinger-2.0-Lite
 * /Stinger-2.0-Lite/
 * /Stinger-2.0-Lite/index.jsp.

For this rule set, we have specified two rules, each describing a parameter accepted by the web application. These two parameters, username and hidden1, have very similar entries to that of the cookie rules. Each parameter has an associated regular expression, a missing section, and a malformed section.

Important SVDL Rules/Guidelines
When creating your own SVDL file, please remember the following rules/guidelines:

Defaults:
 * 1) Stinger assumes there will always exist a default rule set
 * 2) Requested URI's without a rule set will use the default rule set
 * 3) Parameters without an associated rule will use the default rule

Cookies:
 * 1) You must specify a created page for a cookie rule
 * 2) If a cookie is missing on the created page, then no vioaltion
 * 3) If a cookie is malformed on the created page, then violation
 * 4) You must specify at least one enforced uri per cookie rule
 * 5) You can specify more than one enforced uri per cookie rule

Rule Sets:
 * 1) There must exist at least one path per rule set.
 * 2) There can exist multiple paths for a single rule set.

Actions:
 * 1) Order actions carefully and appropriately. Ex. You cannot drop a packet and then display a message.
 * 2) Several actions accept parameters. They must be defined

SVDL Generator
Obviously, generating a SVDL file for your application can be quite tedious. In an effort to reduce this overhead, Stinger 2.0 is equipped with an SVDL Generator file. Essentially, this filter will allow you to manually browser your web application and specify rules for every parameter. The SVDL Generator filter is designed to modify the HTML of every response coming from your web application. When the filter notices a parameter without an associated rule, then it colors the parameter red and applies an AJAX style javascript menu. This menu contains all of the possible regular expressions specified in the template SVDL file for Stinger. When a user notices the red parameter, they can right click the parameter and specify a regular expression. The parameter color is changed back to normal to signify that a rule now exists and the request is sent to the SVDL Generator filter via an XMLHttpRequest object.

To deploy the SVDL Generator Filter, insert the following in your web.xml file:

SVDLGeneratorFilter</filter-name> org.owasp.stinger.SVDLGeneratorFilter</filter-class>  config</param-name> stinger.xml</param-value> </init-param> <filter-mapping> SVDLGeneratorFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>

The SVDL Generator filter accepts a config parameter which points to the location of a template SVDL file. A template SVDL file is considered an SVDL file with a regular expression section and a default rule set entry. A template SVDL file can be downloaded [TBD here].

When the SVDL Generator is successfully loaded, you will see the parameters in your web application turn red.

[TBD RED PARAMETER IMAGE]

To select a regular expression to be associated with the parameter, simply right click and select.

[TBD RIGHT CLICK IMAGE]

After selecting a regular expression for the parameter, the color changes from red to the default color.

[TBD CHANGE COLOR IMAGE]

The SVDL Generator is still under development. Check back soon for more information!

SVDL Learner Filter
A project is underway to create a J2EE filter which generates an SVDL file based on captured HTTP traffic. The learner filter will behave similar to that of the SVDL Generator filter whereby parameters without an associated rule will be colored red. The learner filter will then look for a user-submitted value for that parameter and build an appropriate rule with default missing and malformed actions. When the user is finished crawling the site, the J2EE container is shut down and the Learner filter writes the rules to disk. The learner filter is currently under development. Stay tuned for more information.

Deployment Checklist

 * Download the latest Stinger jar files into the appropriate container directory
 * Configure your web.xml file to:
 * Load Stinger with the appropriate parameters:
 * config - the location of the SVDL file
 * errmsg - the error message displayed if any exception is caught
 * reload - specifies whether the SVDL should be dynamically loaded at runtime
 * Apply Stinger to a URI Pattern


 * Configure the SVDL for your application

=Actions=

Stinger is an action based input validation engine. The user can specify actions to be taken place upon violations found in an HTTP request. The following section describes how the actions are implemented as well as the parameters they accept. One major goal of this section is to illustrate the simplicity of creating Stinger actions. If you have created a custom action and are interested in submitting it to the Stinger project, please email me at [mailto:eric.sheridan@owasp.org eric.sheridan@owasp.org].

Description
Developing your own action is relatively straight forward within Stinger. To implement a custom class, simply extend the AbstractAction class and implement the abstract doAction method. For more information related to building custom actions, please refer to the development section.

Source Code
public abstract class AbstractAction { private HashMap<String, String> parameters = new HashMap<String, String>; public String getParameter(String name) { return parameters.get(name); } 	public void setParameter(String name, String value) { parameters.remove(name); parameters.put(name, value); } 	public abstract void doAction(Violation violation, MutableHttpRequest request,                                      MutableHttpResponse response) throws  BreakChainException; }

Description
When a violation occurs, the DisplayMessage action can be configured to display a custom message to the user. This message currently resides at the top of the response in an HTML table format.

Parameters
The DisplayMessage action currently accepts two parameters.

message - the message to be displayed back to the user upon finding a violation

bgcolor - the background color of the HTML table

Source Code
public class DisplayMessage extends AbstractAction { public String formatMessage(String message, String bgcolor) { StringBuffer buffer = new StringBuffer; buffer.append(" \n"); return buffer.toString; } 	public void displayMessage(MutableHttpResponse response, String message, String bgcolor) { PrintWriter out = null; String formatedMessage = formatMessage(message, bgcolor); out = response.getWriter; out.write(formatedMessage); } 	public void doAction(Violation violation, MutableHttpRequest request, MutableHttpResponse response) { String message = getParameter("message"); String bgcolor = getParameter("bgcolor"); displayMessage(response, message, bgcolor); } }

Description
The Drop action simply throws the BreakChainException when called. This effectively prevents the HTTP request from ever reaching the web application.

Parameters
The Drop action currently accepts one parameter:

message - the message to be displayed in the exception stack trace. This message is never displayed to the user.

Source Code
public class Drop extends AbstractAction { public void doAction(Violation violation, MutableHttpRequest request,                            MutableHttpResponse response) throws  BreakChainException { String message = getParameter("message"); /** Let the user define the message to be displayed in the exception **/ throw new BreakChainException(message); } }

Description
If the session object exists, then it will be invalidated by this action. This action is considered more severe and should be deployed only when an obvious attack occurs. For example, cookie values are rarely tampered with by the client side code (i.e. javascript). Therefore, we can (safely?) assume that any cookie modification is considered a deliberate attack.

Parameters
The Invalidate action currently accepts no parameters.

Source Code
public class Invalidate extends AbstractAction { public void doAction(Violation violation, MutableHttpRequest request, MutableHttpResponse response) { HttpSession session = null; session = request.getSession(false); if(session != null) { session.invalidate; } 	} }

Description
As the name implies, we can log any and every request sent to the web application. The Log action is an essential action and should be heavily implemented in Stinger deployment.

Parameters
The Log action currently accepts 3 parameters:

log - the log file where the message should be recorded

level - the level of the log message (i.e. INFO, SEVERE, etc.)

message - the message which shall be logged. The message parameter itself accepts 3 format parameters. These include the offender's ip address, the offender's remote port, the parameter/cookie name, the parameter/cookie value, an entity encoded version of the parameter/cookie value, and the JSESSIONID. The format strings are %ip, %port, %name, %value, %encoded_value, and %js respectively.

Source Code
public class Log extends AbstractAction { private static Logger logger = Logger.getLogger("org.owasp.stinger.actions.Log"); private static HashMap<String, FileHandler> handlers = new HashMap<String, FileHandler>; public Log { } 	public void doAction(Violation violation, MutableHttpRequest request, MutableHttpResponse response) { FileHandler handler = null; String log = getParameter("log"); String level = getParameter("level"); String message = getParameter("message"); /** Offender's IP **/ message = message.replace("%ip", request.getRemoteAddr); /** Offender's Port **/ message = message.replace("%port", String.valueOf(request.getRemotePort)); /** Offending parameter name **/ if(violation.getName != null) { message = message.replace("%name", violation.getName); } else { message = message.replace("%name", "NULL"); } 		/** Offending parameter value **/ if(violation.getValue != null) { message = message.replace("%value", violation.getValue); } else { message = message.replace("%value", "NULL"); } 		/** Offending parameter value HTML Encoded **/ if(violation.getValue != null) { message = message.replace("%encoded_value", violation.getValue); } else { message = message.replace("%encoded_value", "NULL"); } 		/** Offender's JSESSIONID **/ if(request.getCookie("JSESSIONID") != null) { message = message.replace("%js", request.getCookie("JSESSIONID").getValue); } else { message = message.replace("%js", "NULL"); } 		handler = getHandler(log); logger.addHandler(handler); logger.log(Level.parse(level.toUpperCase), message); handler.flush; logger.removeHandler(handler); } 	private synchronized FileHandler getHandler(String log) { FileHandler handler = null; handler = handlers.get(log); if(handler == null) { try { handler = new FileHandler(log); } catch (IOException ioe) { ioe.printStackTrace; } 			handlers.put(log, handler); } 		return handler; } }

Description
The Redirect action redirects a user to a specific page. This action is often used to send a user to an error message upon finding a violation.

Parameters
The Redirect action currently accepts 1 parameter:

page - the page to redirect the user to

Source Code
public class Redirect extends AbstractAction { public void doAction(Violation violation, MutableHttpRequest request,                            MutableHttpResponse response) throws  BreakChainException { String page = getParameter("page"); try { response.sendRedirect(page); } catch (IOException ioe) { ioe.printStackTrace; } 	} }

Description
The encode action will HTML Entity Encode the violating value. This effectively prevents cross site scripting from the violating input value.

Source Code
public class Encode extends AbstractAction { private void entityEncode(MutableHttpRequest request, String name, String value) { String result = null; if(value != null) { result = EntityEncoder.htmlEntityEncode(value); request.addParameter(name, result); } 	} 	public void doAction(Violation violation, MutableHttpRequest request, HttpServletResponse response) { String name = null; String value = null; name = violation.getName; value = request.getParameter(name); entityEncode(request, name, value); } }

=Example SVDL Configuration Files=

The following are example SVDL configuration files. With the introduction of the global rules concept, configuring Stinger becomes significantly less cumbersome for even the most complex apps.

Template SVDL File
This configuration should be used as a template for creating your own SVDL files. It contains a basic regular expression section, a basic cookie section, and no parameter rules.

Click here to download this template SVDL file.

Encode all Input
This SVDL configuration sanitizes all parameters in the HTTP request. By entity encoding all parameter-based user input, we significantly reduce the likelihood of certain forms of Cross Site Scripting and SQL Injection attacks.

Click here to download this sample SVDL file.

Encode all Input and Log All Violations
This SVDL configuration sanitizes all parameters in the HTTP request and logs all violations that may occur. As a result, we significantly reduce the likelihood of certain input validation attacks and we have a logging mechanism to detect and verifies these attacks.

Click here to download this sample SVDL file.

Encode all Input for a Particular URI
This SVDL configuration sanitizes all parameters in the HTTP request that are sent to a specific set of URI's. If a malformed parameter is sent to another URI not listed in our rule, then the global rule handles the packet. Since the global rule does nothing, the malformed data will be accepted.

Click here to download this sample SVDL file.

=Feedback and Participation =

We hope you find Stinger useful. Please contribute back to the project by sending your comments, questions, and suggestions to the Stinger mailing list. Thanks!

To join the OWASP Stinger mailing list or view the archives, please visit the subscription page.

=Project Sponsors=

The Stinger project is sponsored by http://www.owasp.org/docroot/owasp/img/members/aspect_logo.gif.