#svg #security #filter #sanitizer #xss #purify

bin+lib svg-hush

Strip scripting and other abusable features from SVG files

5 releases

0.9.4 Aug 29, 2023
0.9.3 Aug 21, 2023
0.9.2 May 11, 2023
0.9.1 Sep 22, 2022
0.9.0 Jul 27, 2022

#579 in Images

Download history 93/week @ 2024-03-13 18/week @ 2024-03-20 103/week @ 2024-03-27 58/week @ 2024-04-03 77/week @ 2024-04-10 25/week @ 2024-04-17 31/week @ 2024-04-24 77/week @ 2024-05-01 137/week @ 2024-05-08 113/week @ 2024-05-15 134/week @ 2024-05-22 62/week @ 2024-05-29 83/week @ 2024-06-05 67/week @ 2024-06-12 38/week @ 2024-06-19 104/week @ 2024-06-26

292 downloads per month
Used in machin

Apache-2.0 OR MIT

47KB
875 lines

svg-hush

The goal of this tool is to make arbitrary SVG files as benign and safe to serve as images in other common Web file formats. SVG files aren't just images, they're documents with full access to all HTML and JavaScript features. This tool filters SVG files to remove use of any potentially risky features.

  • Removes scripting. Prevents SVG files from being used for cross-site scripting attacks. Although browsers don't allow scripts in <img>, they do allow scripting when SVG files are opened directly as a top-level document.

  • Removes hyperlinks to documents on other domains. Makes SVG files less attractive for SEO spam and phishing.

  • Removes references to cross-origin resources. Stops 3rd parties from tracking who is viewing the image.

This tool removes any elements and attributes that aren't in its allowlist and filters all URLs to be same-origin only (paths without a host name). It may break some SVG images. Please file a bug when you find an image that is filtered too harshly!

This tool might make SVG files smaller by removing unnecessary junk from them, but it's not meant to be an SVG optimizer. It's safe to combine svg-hush with SVG optimization tools.

Sanitization vs CSP

Regardless of this filtering, it's best to serve SVG images with a restrictive Content-Security-Policy. This tool is a defense-in-depth for cases where the CSP header may be unsupported, lost, or bypassed (e.g. due to server/CMS misconfiguration or a ServiceWorker that doesn't forward headers).

Known limitations

  • Legacy text encodings are not supported. UTF-8, UTF-16, and latin1 are supported.
  • DOCTYPEs referencing external DTD files are not allowed. Internal subset is supported.
  • The lax SVG-in-HTML syntax dialect is not supported. SVG documents must be well-formed XML and use the SVG namespace.

Dependencies

~2MB
~59K SLoC