Skip to content

Improve HTML and attribute escaping, update CSP config #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shgysk8zer0 merged 1 commit into from
Jan 5, 2026
Merged

Improve HTML and attribute escaping, update CSP config #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [v0.2.30] - 2026-01-05

### Added
- Add `escapeAttrName()`

### Changed
- Refactor HTML escaping

### Deprecated
- Mark `escapeAttrValue()` as deprecated with warning to use `escape()`

## [v0.2.29] - 2025-12-23

### Changed
Expand Down
41 changes: 27 additions & 14 deletions dom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,30 @@
import { attachListeners } from '@aegisjsproject/callback-registry/events.js';

const ESCAPED_PATTERN = /&(?![a-zA-Z\d]{2,5};|#\d{1,3};)/g;

export const escapeAttrVal = str => str.toString()
// Do not double-escape
.replaceAll(ESCAPED_PATTERN, '&')
.replaceAll('"', '"');
export const HTML_UNSAFE_PATTERN = /[<>"']|&(?![a-zA-Z\d]{2,5};|#\d{1,3};)/g;
/*eslint no-control-regex: "off"*/
export const ATTR_NAME_UNSAFE_PATTERN = /[\u0000-\u001f\u007f-\u009f\s"'\\/=><&]/g;
export const HTML_REPLACEMENTS = Object.freeze({
'&': '&amp;',
'"': '&quot;',
'\'': '&apos;',
'<': '&lt;',
'>': '&gt;',
});

export const escape = str => (str?.toString?.() ?? '')
.replaceAll(HTML_UNSAFE_PATTERN, char => HTML_REPLACEMENTS[char]);

/**
*
* @param {@deprecated} str
* @returns {string}
*/
export const escapeAttrVal = str => {
console.warn('`escapeAttrVal()` is deprecated. Please use `escape()` instead.');
return escape(str);
};

export const escapeAttrName = str => (str?.toString?.() ?? '')
.replace(ATTR_NAME_UNSAFE_PATTERN, char => '_' + char.charCodeAt(0).toString(16).padStart(4, '0') + '_');

export function createAttribute(name, value = '', namespace) {
const attr = typeof namespace === 'string'
Expand All @@ -17,13 +36,7 @@ export function createAttribute(name, value = '', namespace) {
return attr;
}

export const stringifyAttr = attr => `${attr.name}="${escapeAttrVal(attr.value)}"`;

export const escape = str => str.toString()
.replaceAll(ESCAPED_PATTERN, '&amp;')
.replaceAll('<', '&lt;')
.replaceAll('>', '&gt;')
.replaceAll('"', '&quot;');
export const stringifyAttr = attr => `${escapeAttrName(attr?.name)}="${escape(attr?.value)}"`;

export const getUniqueSelector = (prefix = '_aegis-scope') => `${prefix}-${crypto.randomUUID()}`;

Expand Down
6 changes: 3 additions & 3 deletions http.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { useDefaultCSP, addConnectSrc, addTrustedTypePolicy, lockCSP } from '@aegisjsproject/http-utils/csp.js';

import { useDefaultCSP, addScriptSrc, addConnectSrc, addTrustedTypePolicy, lockCSP } from '@aegisjsproject/http-utils/csp.js';
addScriptSrc('https://unpkg.com/@shgysk8zer0/', 'https://unpkg.com/@aegisjsproject/');
addConnectSrc('https://icanhazdadjoke.com/');
addTrustedTypePolicy('aegis-router#html', 'default');
addTrustedTypePolicy('aegis-router#html', 'aegis-sanitizer#html', 'default');
lockCSP();

export default {
Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<template id="tmp">
<div class="container">
<dad-joke></dad-joke>
<p>Lorem Ipsum and all that...</p>
<p>Lorem Ipsum &amp; all that...</p>
Free text...
</div>
</template>
Expand Down
12 changes: 9 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@aegisjsproject/core",
"version": "0.2.29",
"version": "0.2.30",
"description": "A fast, secure, modern, light-weight, and simple JS library for creating web components and more!",
"keywords": [
"aegis",
Expand Down
Loading