Projects/OWASP Java Encoder Project

Revision as of 14:59, 30 March 2012 by Jmanico (talk | contribs)

Jump to: navigation, search

Welcome to the OWASP Java Encoder Project

What does this OWASP project offer you?
What releases are available for this project?
what is this project?
Name: OWASP Java Encoder Project (home page)
  • This project is a simple-to-use drop-in encoder class with little baggage.
  • This code was designed for high-availability/high-performance encoding functionality.
  • The key motivation for the separate project was:
  1. Simple drop-in encoding functionality
  2. Redesigned for performance
  3. More complete API (uri and uri component encoding, etc) in some regards.
  • This is a Java 1.5 project.
License: New BSD License
who is working on this project?
Project Leader(s):
Project Contributor(s):
how can you learn more?
Project Pamphlet: Not Yet Created
Project Presentation:
Mailing list: Mailing List Archives
Project Roadmap: View
Main links:
Key Contacts
  • Contact the GPC to report a problem or concern about this project or to update information.
current release
OWASP Java Encoder Project 1.1.1 - January 30, 2014 - (download)
Release description: Critical fix of bug described here
Rating: Not Rated
last reviewed release
Not Yet Reviewed

other releases

To build: checkout and run "mvn package" (using maven 2.0 or 3.0)<b>

to use, the general API pattern is "Encode.forContextName(untrustedData)", where "ContextName" is the name of the target context.

e.g. in a JSP

<input type="text" name="data" value="<%= Encode.forHtmlAttribute(dataValue) %>" />

<textarea name="text"><%= Encode.forHtmlContent(textValue) %>" />

Generally Encode.forHtml(...) is safe but slightly less efficient for the above two contexts (since it encodes more characters than necessary).

For JavaScript string data, here's some more examples:

<button onclick="alert('<%= Encode.forJavaScriptAttribute(alertMsg) %>');">click me</button>

<script type="text/javascript"> var msg = "<%= Encode.forJavaScriptBlock(message) %>"; alert(msg); </script>

Again generally Encode.forJavaScript is safe for the above two context, but slightly less efficient since it encodes more characters.

Other contexts can be found in the org.owasp.Encode class methods, including CSS strings, CSS urls, XML contexts, URIs and URI components. Additional contexts can be added before rel 1.0 if you have any ideas.