sanitized

sanitized

A recursive sanitizer for JSON inputs. Traverses nested arrays and objects, sanitizing every string value against XSS attacks using DOMPurify and decoding HTML entities with he. Ideal for sanitizing form data before submission to the back-end.

Installation

npm install sanitized
# or
yarn add sanitized

Node v16 Support

npm install sanitized@1.2.1
# or
yarn add sanitized@1.2.1

Usage

const sanitized = require("sanitized").default; // commonjs
// or
import sanitized from "sanitized"; // esm

Strings

sanitized("<img src=x onerror=alert(1)//>");
// '<img src="x">'

Arrays

sanitized(["<svg><g/onload=alert(2)//<p>"]);
// ['<svg><g></g></svg>']

Objects

sanitized({
  test: '<math><mi//xlink:href="data:x,<script>alert(4)</script>">',
});
// { test: '<math><mi></mi></math>' }

Nested

sanitized([
  "<svg><g/onload=alert(2)//<p>",
  {
    name1: [
      '<math><mi//xlink:href="data:x,<script>alert(4)</script>">',
      { name2: "<p>abc<iframe//src=jAva&Tab;script:alert(3)>def" },
    ],
  },
]);
// [
//   "<svg><g></g></svg>",
//   { name1: ["<math><mi></mi></math>", { name2: "<p>abc</p>" }] }
// ]

Non-string primitives

Non-string values (number, boolean, null, undefined) are returned as-is.

sanitized(42); // 42
sanitized(null); // null
sanitized(undefined); // undefined

DOMPurify options

The second parameter accepts any DOMPurify config options.

sanitized("<b>hello</b>", { ALLOWED_TAGS: ["b"] }); // "<b>hello</b>"

License

MIT