Pete Freitag Pete Freitag

Using AntiSamy with ColdFusion


How do you protect your code from Cross Site Scripting (XSS) when your business requirements state that the user must be able to input HTML? This can be a difficult problem to solve and XSS is very difficult to filter against because there are hundreds of attack vectors.

Remember that social networking site MySpace? They allow anyone to create profile pages with lots of CSS, and HTML markup. They were concerned about XSS and they had pretty extensive blacklist filters in place to prevent it.

One clever hacker named Samy figured out a way to embed JavaScript in his MySpace profile page, that would automatically add you as a friend when you viewed his profile. After about 5 hours Samy had roughly 1 million friends! After 6 hours MySpace was shut down for "maintenance"

Back to the problem at hand, how to we prevent this sort of thing? One way is to use a Java Library called AntiSamy. AntiSamy uses a XML policy file that defines what HTML tags and attributes are allowed in your application.

Invoking AntiSamy from ColdFusion

AntiSamy requires a couple jar files to run, in order to use the code in a jar file in ColdFusion you need to add the Jar files to your java classpath. Mark Mandel wrote an awesome utility called JavaLoader which allows us to dynamically load jar files, without modifying the java classpath variables, or copying files to particular locations. I am going to use JavaLoader in my example because it makes things very easy.

<cfset policyFile = ExpandPath("./antisamy-slashdot-1.4.1.xml")>
<cfset jarArray = [ExpandPath("lib/antisamy-bin.1.4.1.jar"), 
<!--- using Java Loader to avoid adding jar files to classpath --->
<cfset classLoader = CreateObject("component", "lib.javaloader.JavaLoader").init(jarArray)>
<cfset antiSamy = classLoader.create("org.owasp.validator.html.AntiSamy").init()>
<cfset cleanResults = antiSamy.scan(form.html, policyFile)>
	<h3>AntiSamy Result:</h3>

Download complete working version - Includes all Jar files, JavaLoader (Requires CF8+ due to array notation, could be modified to work on CF7)

Using AntiSamy in ColdFusion is actually quite simple, you just need to create an instance of the Java object org.owasp.validator.html.AntiSamy and then invoke the scan(htmlContent, policyFileLocation) method. It returns a CleanResults object which has a bunch of nifty methods, such as getCleanHTML() which returns sanitized HTML based on your policy.

Using AntiSamy with ESAPI

Another great Java security API is the OWASP Enterprise Security API (ESAPI), it actually makes use of AntiSamy under the hood as well. One example is in the ESAPI.validatior().isValidSafeHTML(htmlContent) method. I recommend you checkout ESAPI for it's collection of Encoders to protect you against XSS (for outputting variables that should not contain HTML). See my Writing Secure CFML presentation slides from CFUnited 2010 for more on ESAPI.

Like this? Follow me ↯

Using AntiSamy with ColdFusion was first published on August 05, 2010.

If you like reading about antisamy, coldfusion, security, java, esapi, owasp, or xss then you might also like:

FuseGuard Web App Firewall for ColdFusion

The FuseGuard Web Application Firewall for ColdFusion & CFML is a high performance, customizable engine that blocks various attacks against your ColdFusion applications.


Thanks Pete! Can antiSammy live in the application scope safely?
by Brook on 08/05/2010 at 3:31:19 PM UTC
@Brook that's a good question, I looked at the source code for the AntiSamy object, when you call scan(html, policyFileName) it does not use any instance variables so it should be thread safe to put in the application scope. If you go that way, you can also create a org.owasp.validator.html.Policy object and call antisamy.setPolicy(policyObj) just once, then just run antisamy.scan(html).
by Pete Freitag on 08/05/2010 at 3:43:21 PM UTC
I take exception to you defaming this way. Just kidding. Nice work - I didn't think it would be this easy. I wonder how this compares to Portcullis which also works with XSS attacks.
by Sami Hoda on 08/05/2010 at 4:27:53 PM UTC
Cool, I am going to try it tonight/tomorrow. I've been looking for something to sanitize user input for a while. Is it possible to allow exceptions? For example, I want users to be able to embed google tracking/script code, but not there own scripts..
by Brook on 08/05/2010 at 6:35:57 PM UTC
Seen this?
by denny on 08/05/2010 at 8:19:20 PM UTC
@Denny - Yes I've seen the ColdFusion ESAPI project, it doesn't seem to be active, and is really just a wrapper for the Java Code from what I have seen.

@Brook - Yes you can configure exceptions in the xml antisami config file.

@Sami - Sorry, I didn't choose the name :) - The difference between using something like this, and portcullis or fuseguard to protect against XSS attacks is that something like AntiSami can give you much better protection, Portcullis and Fuseguard rely on input filtering to find XSS, which isn't going to cover as many cases. Ideally you should have both types of protections in place.
by Pete Freitag on 08/16/2010 at 10:07:32 AM UTC
What is the performance like if you have 10-15 form fields.
by Dmitriy on 08/19/2010 at 2:40:53 PM UTC
@Anonymous - The Java version of AntiSamy can't be used on ASP classic on Windows 2003. You need to install something that runs Java, and have your ASP page invoke it.

If you have the ability to run .NET there is a .NET version of antisamy as well. There is also a Microsoft library called AntiXSS that you can also look into.
by Pete Freitag on 08/20/2010 at 11:44:32 AM UTC
Thanks for example. I am having a difficult time making it work with inline CSS and in between HTML Style Tags. Do you have any examples of using it with CSS in that way? I have reviewed the documentation and I am not clear on what I need to do. Thanks
by Jason on 11/30/2010 at 9:07:46 AM UTC
@James - The AntiSamy jars are only included in CF8, and I don't know if all the dependencies are included, so for that reason I would recommend using javaloader.
by Pete Freitag on 05/19/2011 at 10:37:15 AM UTC
Thanks Pete, exactly what i needed and works like a charm! I appreciate all that you do for the CFML community.
by Jace on 04/30/2014 at 11:40:17 AM UTC
Quick question while I'm here: Do you know if the antiSamy instance in your example code is thread safe, or should I be creating a new instance per thread/request?
by Steve Sommers on 04/01/2015 at 4:43:34 PM UTC