de.hybris.platform.servicelayer.web

Class XSSRequestWrapper

java.lang.Object

HttpServletRequestWrapper

de.hybris.platform.servicelayer.web.XSSRequestWrapper

public class XSSRequestWrapper
extends HttpServletRequestWrapper

HttpServletRequestWrapper that sanitize requests inputs to mitigate risks of XSS scripts being passed over. This code is based on free and non-restricted code found at: http://ricardozuasti.com/2012/stronger-anti-cross-site-scripting-xss-filter-for-java-web-apps/ Some notes on performance: in order to avoid re-scanning of parameter and header values we're caching sanitized results as soon as a single call to getParameterMap() or getHeaders(String) has occurred. Also note that we try to avoid the creation of new string arrays or enumerations in case of no pattern matches.

Constructor Summary

Constructors

Constructor and Description
XSSRequestWrapper(HttpServletRequest servletRequest, java.util.Map<java.lang.String,java.lang.String[]> strippedHeadersMap, java.util.Map<java.lang.String,java.lang.String[]> strippedParametersMap) Constructor for creating a request wrapper using already processed parameter and header values.
XSSRequestWrapper(HttpServletRequest servletRequest, XSSFilter.XSSValueTranslator translator) Constructor for creating a lazy-translating request wrapper.

Method Summary

Modifier and Type	Method and Description
protected void	ensureHeadersTranslated()
protected void	ensureParametersTranslated()
java.lang.String	getHeader(java.lang.String name)
java.util.Enumeration	getHeaders(java.lang.String name)
java.lang.String	getParameter(java.lang.String parameter)
java.util.Map	getParameterMap()
java.lang.String[]	getParameterValues(java.lang.String parameter)
protected boolean	headersAlreadyTranslated()
protected boolean	headersAreClean()
protected boolean	parametersAreClean()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XSSRequestWrapper

public XSSRequestWrapper(HttpServletRequest servletRequest,
                         XSSFilter.XSSValueTranslator translator)

Constructor for creating a lazy-translating request wrapper. Note that parameter or header values are stripped on first read access.

XSSRequestWrapper

public XSSRequestWrapper(HttpServletRequest servletRequest,
                         java.util.Map<java.lang.String,java.lang.String[]> strippedHeadersMap,
                         java.util.Map<java.lang.String,java.lang.String[]> strippedParametersMap)

Constructor for creating a request wrapper using already processed parameter and header values.

Method Detail

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String parameter)

getParameter

public java.lang.String getParameter(java.lang.String parameter)

getParameterMap

public java.util.Map getParameterMap()

parametersAreClean

protected boolean parametersAreClean()

ensureParametersTranslated

protected void ensureParametersTranslated()

getHeader

public java.lang.String getHeader(java.lang.String name)

getHeaders

public java.util.Enumeration getHeaders(java.lang.String name)

ensureHeadersTranslated

protected void ensureHeadersTranslated()

headersAlreadyTranslated

protected boolean headersAlreadyTranslated()

headersAreClean

protected boolean headersAreClean()