Skip to content

AegisJSProject/trusted-types

Repository files navigation

@aegisjsproject/trusted-types

A polyfill for the Trusted Types API

CodeQL Node CI Lint Code Base

GitHub license GitHub last commit GitHub release GitHub Sponsors

npm node-current npm bundle size gzipped npm

GitHub followers GitHub forks GitHub stars Twitter Follow

Donate using Liberapay


Client-side, or DOM-based, XSS attacks happen when data controlled by a user (such as that input into a form field) reaches a function that can execute that data. These functions are known as injection sinks. DOM-based XSS attacks happen when a user is able to write arbitrary JavaScript code and have it executed by one of these functions.

The Trusted Types API locks down risky injection sinks, requiring you to process the data before passing it to one of these functions. If you use a string, then the browser will throw a TypeError and prevent the use of the function.

Trusted Types works alongside Content-Security Policy with the trusted-types and require-trusted-types-for directives.

The Trusted Types API locks down injection sinks that can act as a vector for DOM-XSS attacks. An injection sink is any Web API function that should only be called with trusted, validated or sanitized input. Examples of injection sinks include:

  • Functions that insert HTML into the document such as Element.innerHTML, Element.outerHTML, or Document.write.
  • Functions that create a new same-origin Document with caller-controlled markup such as DOMParser.parseFromString.
  • Functions that execute code such as Global_Objects/eval.
  • Setters for Element attributes that accept a URL of code to load or execute.

Trusted Types will force you to process the data before passing it to any injection sink rather than use a string. This ensures that the data is trustworthy.

Important

Since the document cannot directly access HTTP headers, this polyfill requires either <meta http-equiv="Content-Security-Policy"> or a data-trusted-policies attribute to be set on <html>.

The Trusted Types API gives web developers a way to lock down the insecure parts of the DOM API to prevent client-side Cross-site scripting (XSS) attacks.

Included Scripts/Modules

  • trusted-types: Polyfills the globalThis.trustedTypes object
  • harden: Overwrites "injection sink" property & attribute setters
  • bundle: Loads polyfill and conditionally "harden"s