ESAPI
ESAPI & Antisamy Module
This module provides ESAPI functionality for stronger, more secure applications in BoxLang based on the OWASP ESAPI project: https://owasp.org/www-project-enterprise-security-api and OWASP AntiSamy project: https://owasp.org/www-project-antisamy/
It includes encoding, decoding, and sanitization functions to help protect your application from common security vulnerabilities. It also includes the AntiSamy library for cleaning up HTML content.
Once installed, several built-in-functions and components will be available for use in your BoxLang code. Here are the built-in-functions (BIFs) that are available in this module. You can also check out the module API documentation for more details: https://apidocs.ortussolutions.com/boxlang-modules/bx-esapi/1.1.0/ortus/boxlang/modules/esapi/bifs/package-summary.html
Encoding
This module contributes the following ESAPI encoding BIFs:
encodeFor( context, value )
- Encode for a specific context: HTML, XML, URL, etc.encodeForCSS( value, [canonicalize=false] )
- Encode for CSS contextsencodeForDN( value, [canonicalize=false] )
- Encode for Distinguished Name contextsencodeForHTML( value, [canonicalize=false] )
- Encode for HTML contextsencodeForHTMLAttribute( value, [canonicalize=false] )
- Encode for HTML attribute contextsencodeForJavaScript( value, [canonicalize=false] )
- Encode for JavaScript contextsencodeForLDAP( value, [canonicalize=false] )
- Encode for LDAP contextsencodeForSQL( string, dialect, [canonicalize=false] )
- Encode for SQL contextsencodeForURL( value, [canonicalize=false])
- Encode for URL contextsencodeForXML( value, [canonicalize=false])
- Encode for XML contextsencodeForXMLAttribute( value, [canonicalize=false] )
- Encode for XML attribute contextsencodeForXPath( value, [canonicalize=false])
- Encode for XPath contexts
The available contexts for encoding are:
CSS
DN
HTML
HTMLAttribute
JavaScript
LDAP
SQL
URL
XML
XMLAttribute
XPath
Canonicalize: If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false.
Examples
Decoding
This module contributes the following ESAPI decoding BIFs:
canonicalize( input, restrictMultiple, restrictMixed, [throwOnError=false])
- Canonicalize or decode the input string. Canonicalization is simply the operation of reducing a possibly encoded string down to its simplest form. This is important, as attackers frequently use encoding to change their input in a way that will bypass validation filters.input
- The input string to canonicalizerestrictMultiple
- If true, multiple encoding is restricted. This argument can be set to true to restrict the input if multiple or nested encoding is detected. If this argument is set to true, and the given input is multiple or nested encoded using one encoding scheme an error will be thrownrestrictMixed
- If true, mixed encoding is restricted. This argument can be set to true to restrict the input if mixed encoding is detected. If this argument is set to true, and the given input is mixed encoded using multiple encoding schemes an error will be thrownthrowOnError
- If true, an error will be thrown if the input is invalid. If this argument is set to true, and the given input is invalid, an error will be thrown. Default is false.
decodeFor( type, value )
- Decode for a specific context: HTML, XML, URL, etc.decodeForBase64( string )
- Decodes a Base64 stringdecodeForHTML( string )
- Decodes an HTML stringdecodeForJSON( string )
- Decodes a JSON stringdecodeFromURL( string )
- Decodes a URL-encoded string
Examples
Antisamy + Sanitization
This module contributes these remaining ESAPI BIFs:
getSafeHTML( string, [policy='ebay'] )
- Sanitize HTML content using the AntiSamy librarystring
- The HTML string to sanitizepolicy
- The policy to use for sanitization. The default is 'ebay', which is the most restrictive policy. The available policies are:anythingoes,ebay,myspace,slashdot,tinymce
. However you can pass a custom policy by using an absolute path to the policy file.
isSafeHTML( string, [policy='ebay'] )
- Validate HTML content using the AntiSamy librarystring
- The HTML string to sanitizepolicy
- The policy to use for sanitization. The default is 'ebay', which is the most restrictive policy. The available policies are:anythingoes,ebay,myspace,slashdot,tinymce
. However you can pass a custom policy by using an absolute path to the policy file.
sanitizeHTML( string, [policy='ALL'] )
- Sanitizes unsafe HTML to protect against XSS attacksstring
- The HTML string to sanitizepolicy
- The policy to use for sanitization. The default is 'ALL', which is the most restrictive policy. The available policies are:BLOCKS, FORMATTING, IMAGES, LINKS, STYLES, TABLES
. You can also pass aPolicyFactory
object to use a custom policy (https://javadoc.io/static/com.googlecode.owasp-java-html-sanitizer/owasp-java-html-sanitizer/20191001.1/org/owasp/html/PolicyFactory.html)
Examples
Last updated
Was this helpful?