Difference between revisions of "OWASP JSON Sanitizer"

From OWASP
Jump to: navigation, search
m (Reverted edits by Jmanico (talk) to last revision by Mike Samuel)
Line 1: Line 1:
= Main =  
+
=Main=
<div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:OWASP_Project_Header.jpg|link=]]</div>
+
Given JSON-like content, converts it to valid JSON.
  
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
+
This can be attached at either end of a data-pipeline to help satisfy Postel's principle:
| valign="top"  style="border-right: 1px dotted gray;padding-right:25px;" |
+
  
== OWASP JSON Sanitizer Project ==
+
be conservative in what you do, be liberal in what you accept from others
 +
Applied to JSON-like content from others, it will produce well-formed JSON that should satisfy any parser you use.
  
Our Mission: Given JSON-like content, convert it to valid JSON! The OWASP JSON Sanitizer Project is a simple to use Java library that can be attached at either end of a data-pipeline to help satisfy Postel's principle: <i>be conservative in what you do, be liberal in what you accept from others</i><br/>
 
Applied to JSON-like content from others, it will produce well-formed JSON that should satisfy any parser you use.<br/>
 
 
Applied to your output before you send, it will coerce minor mistakes in encoding and make it easier to embed your JSON in HTML and XML.
 
Applied to your output before you send, it will coerce minor mistakes in encoding and make it easier to embed your JSON in HTML and XML.
  
==Licensing==
 
The OWASP Java Encoder is free to use under the [http://www.apache.org/licenses/LICENSE-2.0 Apache 2 License].
 
  
| valign="top"  style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
+
=== Motivation ===
  
== What is this? ==
+
[[Image:http://json-sanitizer.googlecode.com/git/docs/JSON-Sanitizer-Arch.png|frameless|architecture]]
  
The OWASP JSON Sanitizer Projects provides:
+
Many applications have large amounts of code that uses ad-hoc methods to generate JSON outputs. Frequently these outputs all pass through a small amount of framework code before being sent over the network. This small amount of framework code can use this library to make sure that the ad-hoc outputs are standards compliant and safe to pass to (overly) powerful deserializers like Javascript's eval operator.
  
* Java based JSON outbound or inbound sanitization library
+
Applications also often have web service APIs that receive JSON from a variety of sources. When this JSON is created using ad-hoc methods, this library can massage it into a form that is easy to parse.
  
== Code Repo ==
+
By hooking this library into the code that sends and receives requests and responses, this library can help software architects ensure system-wide security and well-formedness guarantees.
  
[https://code.google.com/p/json-sanitizer/ OWASP JSON Sanitizer at Google Code]
+
=== Input ===
 
+
== Email List ==
+
 
+
[https://lists.owasp.org/mailman/listinfo/owasp_json_sanitizer Project Email List ]
+
 
+
== Project Leader ==
+
 
+
Project Leader:<br/>Mike Samuel
+
<br/><br/>
+
Contributors: <br/>
+
Jim Manico<br/>
+
 
+
== Related Projects ==
+
 
+
* [[XSS (Cross Site Scripting) Prevention Cheat Sheet]]
+
* [[OWASP Java HTML Sanitizer]]
+
* [[OWASP Java Encoder]]
+
 
+
| valign="top"  style="padding-left:25px;width:200px;" |
+
 
+
== Quick Download ==
+
 
+
* [https://code.google.com/p/json-sanitizer/downloads/detail?name=json-sanitizer-2012-10-17.jar https://code.google.com/p/json-sanitizer/downloads/detail?name=json-sanitizer-2012-10-17.jar]
+
 
+
== News and Events ==
+
* [Oct 17, 2012] 1.0 Released!
+
 
+
 
+
==Classifications==
+
 
+
  {| width="200" cellpadding="2"
+
  |-
+
  | align="center" valign="top" width="50%" rowspan="2"| [[File:Owasp-incubator-trans-85.png|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Incubator_Projects]]
+
  | align="center" valign="top" width="50%"| [[File:Owasp-builders-small.png|link=]] 
+
  |-
+
  | align="center" valign="top" width="50%"| [[File:Owasp-defenders-small.png|link=]]
+
  |-
+
  | colspan="2" align="center"  | [http://www.apache.org/licenses/LICENSE-2.0 Apache 2 License]
+
  |-
+
  | colspan="2" align="center"  | [[File:Project_Type_Files_CODE.jpg|link=]]
+
  |}
+
 
+
|}
+
 
+
= Motivation =
+
 
+
Many applications have large amounts of code that uses ad-hoc methods to generate JSON outputs. Frequently these outputs all pass through a small amount of framework code before being sent over the network. This small amount of framework code can use this library to make sure that the ad-hoc outputs are standards compliant and safe to pass to (overly) powerful deserializers like Javascript's eval operator. Applications also often have web service APIs that receive JSON from a variety of sources. When this JSON is created using ad-hoc methods, this library can massage it into a form that is easy to parse. By hooking this library into the code that sends and receives requests and responses, this library can help software architects ensure system-wide security and well-formedness guarantees.
+
 
+
[[Image:JSON-Sanitizer-Arch.png|500px|frameless|architecture]]
+
 
+
= Input =
+
  
 
The sanitizer takes JSON like content, and interprets it as JS eval would. Specifically, it deals with these non-standard constructs.
 
The sanitizer takes JSON like content, and interprets it as JS eval would. Specifically, it deals with these non-standard constructs.
Line 117: Line 62:
 
The sanitizer fixes missing punctuation, end quotes, and mismatched or missing close brackets.  If an input contains only white-space then the valid JSON string <tt>null</tt> is substituted.
 
The sanitizer fixes missing punctuation, end quotes, and mismatched or missing close brackets.  If an input contains only white-space then the valid JSON string <tt>null</tt> is substituted.
  
= Output =
+
 
 +
=== Output ===
  
 
The output is well-formed JSON as defined by
 
The output is well-formed JSON as defined by
Line 128: Line 74:
 
# The output contains only valid Unicode [http://www.unicode.org/glossary/#unicode_scalar_value scalar values] (no isolated [http://www.unicode.org/glossary/#surrogate_pair UTF-16 surrogates]) that are [http://www.w3.org/TR/xml/#charsets allowed in XML] unescaped.
 
# The output contains only valid Unicode [http://www.unicode.org/glossary/#unicode_scalar_value scalar values] (no isolated [http://www.unicode.org/glossary/#surrogate_pair UTF-16 surrogates]) that are [http://www.w3.org/TR/xml/#charsets allowed in XML] unescaped.
  
= Security =
+
 
 +
=== Security ===
  
 
Since the output is well-formed JSON, passing it to <tt>eval</tt> will
 
Since the output is well-formed JSON, passing it to <tt>eval</tt> will
Line 136: Line 83:
 
This library only ensures that the JSON string → Javascript object phase has no side effects and resolves no free variables, and cannot control how other client side code later interprets the resulting Javascript object.  So if client-side code takes a part of the parsed data that is controlled by an attacker and passes it back through a powerful interpreter like <tt>eval</tt> or <tt>innerHTML</tt> then that client-side code might suffer unintended side-effects.
 
This library only ensures that the JSON string → Javascript object phase has no side effects and resolves no free variables, and cannot control how other client side code later interprets the resulting Javascript object.  So if client-side code takes a part of the parsed data that is controlled by an attacker and passes it back through a powerful interpreter like <tt>eval</tt> or <tt>innerHTML</tt> then that client-side code might suffer unintended side-effects.
  
= Performance =
+
 
 +
=== Performance ===
  
 
The sanitize method will return the input string without allocating a new
 
The sanitize method will return the input string without allocating a new
Line 146: Line 94:
 
code-units.
 
code-units.
  
= Analogy =
+
=Project About=
 
+
{{:Projects/OWASP_JSON_Sanitizer}}  
The JSON Sanitizer is similar to a [http://en.wikipedia.org/wiki/Decoupling_capacitor decoupling capacitor].
+
 
+
Any module that takes noisy input in and puts out clean output helps *decouple* the security properties of one piece of code (that uses eval) from the security properties of another (that concatenates untrusted strings to produce JSON) so that a failure in one does not necessitate a failure in the other.
+
 
+
= About =
+
 
+
{{:Projects/OWASP JSON Sanitizer | Project About}}
+
 
+
__NOTOC__ <headertabs />
+
  
[[Category:OWASP_Tool]]
+
[[Category:OWASP Project]]
[[Category:OWASP_Alpha_Quality_Tool]]
+
[[Category:OWASP_Project|OWASP JSON Sanitizer Project]]
+

Revision as of 03:29, 5 February 2014

Contents

Main

Given JSON-like content, converts it to valid JSON.

This can be attached at either end of a data-pipeline to help satisfy Postel's principle:

be conservative in what you do, be liberal in what you accept from others Applied to JSON-like content from others, it will produce well-formed JSON that should satisfy any parser you use.

Applied to your output before you send, it will coerce minor mistakes in encoding and make it easier to embed your JSON in HTML and XML.


Motivation

architecture

Many applications have large amounts of code that uses ad-hoc methods to generate JSON outputs. Frequently these outputs all pass through a small amount of framework code before being sent over the network. This small amount of framework code can use this library to make sure that the ad-hoc outputs are standards compliant and safe to pass to (overly) powerful deserializers like Javascript's eval operator.

Applications also often have web service APIs that receive JSON from a variety of sources. When this JSON is created using ad-hoc methods, this library can massage it into a form that is easy to parse.

By hooking this library into the code that sends and receives requests and responses, this library can help software architects ensure system-wide security and well-formedness guarantees.

Input

The sanitizer takes JSON like content, and interprets it as JS eval would. Specifically, it deals with these non-standard constructs.

'...' Single quoted strings are converted to JSON strings.
\xAB Hex escapes are converted to JSON unicode escapes.
\012 Octal escapes are converted to JSON unicode escapes.
0xAB Hex integer literals are converted to JSON decimal numbers.
012 Octal integer literals are converted to JSON decimal numbers.
+.5 Decimal numbers are coerced to JSON's stricter format.
[0,,2] Elisions in arrays are filled with null.
[1,2,3,] Trailing commas are removed.
{foo:"bar"} Unquoted property names are quoted.
//comments JS style line and block comments are removed.
(...) Grouping parentheses are removed.

The sanitizer fixes missing punctuation, end quotes, and mismatched or missing close brackets. If an input contains only white-space then the valid JSON string null is substituted.


Output

The output is well-formed JSON as defined by RFC 4627. The output satisfies three additional properties:

  1. The output will not contain the substring (case-insensitively) "</script" so can be embedded inside an HTML script element without further encoding.
  2. The output will not contain the substring "]]>" so can be embedded inside an XML CDATA section without further encoding.
  3. The output is a valid Javascript expression, so can be parsed by Javascript's eval builtin (after being wrapped in parentheses) or by JSON.parse. Specifically, the output will not contain any string literals with embedded JS newlines (U+2028 Paragraph separator or U+2029 Line separator).
  4. The output contains only valid Unicode scalar values (no isolated UTF-16 surrogates) that are allowed in XML unescaped.


Security

Since the output is well-formed JSON, passing it to eval will have no side-effects and no free variables, so is neither a code-injection vector, nor a vector for exfiltration of secrets.

This library only ensures that the JSON string → Javascript object phase has no side effects and resolves no free variables, and cannot control how other client side code later interprets the resulting Javascript object. So if client-side code takes a part of the parsed data that is controlled by an attacker and passes it back through a powerful interpreter like eval or innerHTML then that client-side code might suffer unintended side-effects.


Performance

The sanitize method will return the input string without allocating a new buffer when the input is already valid JSON that satisfies the properties above. Thus, if used on input that is usually well formed, it has minimal memory overhead.

The sanitize method takes O(n) time where n is the length in UTF-16 code-units.

Project About

PROJECT INFO
What does this OWASP project offer you?
RELEASE(S) INFO
What releases are available for this project?
what is this project?
Name: OWASP_JSON_Sanitizer (home page)
Purpose: As described at http://code.google.com/p/json-sanitizer/

Given JSON-like content, converts it to valid JSON.

This can be attached at either end of a data-pipeline to help satisfy Postel's principle:

Be conservative in what you do, be liberal in what you accept from others, applied to JSON-like content from others, it will produce well-formed JSON that should satisfy any parser you use.

Applied to your output before you send, it will coerce minor mistakes in encoding and make it easier to embed your JSON in HTML and XML.

License: Apache 2.0 License (fewest restrictions, even allowing proprietary modifications and proprietary forks of your project)
who is working on this project?
Project Leader(s):
  • Mike Samuel @
how can you learn more?
Project Pamphlet: Not Yet Created
Project Presentation:
Mailing list: Mailing List Archives
Project Roadmap: View
Key Contacts
  • Contact Mike Samuel @ to contribute to this project
  • Contact Mike Samuel @ to review or sponsor this project
  • Contact the GPC to report a problem or concern about this project or to update information.
current release
Not Yet Published
last reviewed release
Not Yet Reviewed


other releases