Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.32 KB

getting_started.md

File metadata and controls

47 lines (33 loc) · 2.32 KB

Getting Started

Getting the JARs

If you are using Maven then follow the maven directions to add a dependency. Otherwise, download prebuilt jars or git clone [email protected]:OWASP/java-html-sanitizer.git and build the latest source.

Unless maven is managing your CLASSPATH for you, you need to add owasp-java-html-sanitizer.jar.

Once you have your CLASSPATH set up correctly with the relevant JARs you should be able to add

import org.owasp.html.HtmlPolicyBuilder;

to one of your project's .java files and compile it.

Using the APIs

The examples include source code which defines a sanitization policy, and applies it to HTML.

The javadoc covers more detailed topics, including customization.

Important classes are:

For advanced use, see:

Asking Questions

Feel free to post questions at the discussion group and we'll do our best to help.