sanitize()

Membuat plugin sanitasi yang menghapus tag HTML, atribut, dan protokol URL berbahaya dari output yang dihasilkan.

import { sanitize } from "@unifast/node";

Signature

function sanitize(options?: SanitizePluginOptions): UnifastPlugin

Parameter

options?

Konfigurasi sanitasi

PropertiTipeDefaultDeskripsi
enabledbooleantrueMengaktifkan atau menonaktifkan sanitasi
schemaSanitizeSchemaSchema sanitasi kustom

SanitizeSchema

PropertiTipeDeskripsi
allowedTagsstring[]Nama tag HTML yang diizinkan (semua yang lain akan dihapus)
allowedAttributesRecord<string, string[]>Pemetaan dari nama tag ke nama atribut yang diizinkan
allowedProtocolsRecord<string, string[]>Pemetaan dari nama atribut ke protokol URL yang diizinkan

Penggunaan

import { compile, sanitize } from "@unifast/node";

const result = compile(md, {
  plugins: [
    sanitize({
      enabled: true,
      schema: {
        allowedTags: ["h1", "h2", "h3", "p", "a", "strong", "em", "code", "pre", "img", "ul", "ol", "li", "blockquote", "table", "thead", "tbody", "tr", "th", "td"],
        allowedAttributes: {
          a: ["href", "title", "target"],
          img: ["src", "alt", "width", "height"],
          code: ["class"],
          pre: ["class"],
        },
        allowedProtocols: {
          href: ["https", "http", "mailto"],
          src: ["https", "http"],
        },
      },
    }),
  ],
});

Contoh

Menghapus HTML berbahaya

import { compile, sanitize } from "@unifast/node";

const untrustedMd = `
# Hello

<script>alert("xss")</script>

<img src="x" onerror="alert('xss')">

[Click me](javascript:alert('xss'))
`;

const result = compile(untrustedMd, {
  plugins: [sanitize()],
});

console.log(result.output);
// <script> tags, onerror attributes, and javascript: URLs are removed

Tag yang diizinkan secara kustom

import { compile, sanitize } from "@unifast/node";

const result = compile(md, {
  plugins: [
    sanitize({
      schema: {
        allowedTags: ["p", "a", "strong", "em", "code", "pre"],
      },
    }),
  ],
});

console.log(result.output);
// Only the specified tags are kept; all others are stripped

Membatasi protokol URL

import { compile, sanitize } from "@unifast/node";

const result = compile(md, {
  plugins: [
    sanitize({
      schema: {
        allowedProtocols: {
          href: ["https", "mailto"],
          src: ["https"],
        },
      },
    }),
  ],
});

console.log(result.output);
// Only https: and mailto: links are allowed

Menonaktifkan sanitasi

import { compile, sanitize } from "@unifast/node";

const result = compile(md, {
  plugins: [sanitize({ enabled: false })],
});

console.log(result.output);
// No sanitization applied — use only with trusted input