
Ruby-HTML- und CSS-Sanitizer.
Sanitize ist ein allowlist-basierter HTML- und CSS-Sanitizer. Er entfernt sämtliches HTML und/oder CSS aus einer Zeichenkette, mit Ausnahme der Elemente, Attribute und Eigenschaften, die Sie zulassen möchten.
Mit einer einfachen Konfigurationssyntax können Sie Sanitize anweisen, bestimmte HTML-Elemente, bestimmte Attribute innerhalb dieser Elemente und sogar bestimmte URL-Protokolle innerhalb von Attributen, die URLs enthalten, zuzulassen. Sie können auch bestimmte CSS-Eigenschaften, @-Regeln und URL-Protokolle in Elementen oder Attributen, die CSS enthalten, zulassen. Jegliches HTML oder CSS, das Sie nicht ausdrücklich zulassen, wird entfernt.
Sanitize basiert auf dem Nokogiri HTML5-Parser, der HTML auf dieselbe Weise parst wie moderne Browser, und auf Crass, das CSS auf dieselbe Weise parst wie moderne Browser.
[!WARNING]
Sanitize kann den Inhalt von
<math>- oder<svg>-Elementen nicht vollständig bereinigen. MathML- und SVG-Elemente sind Fremdelemente, die nicht den normalen HTML-Parsing-Regeln folgen.Standardmäßig entfernt Sanitize alle MathML- und SVG-Elemente. Wenn Sie MathML- oder SVG-Elemente zu einer benutzerdefinierten Element-Allowlist hinzufügen, können Sie eine Sicherheitslücke in Ihrer Anwendung erzeugen.
gem install sanitize
require 'sanitize'
# Clean up an HTML fragment using Sanitize's permissive but safe Relaxed config.
# This also sanitizes any CSS in `<style>` elements or `style` attributes.
Sanitize.fragment(html, Sanitize::Config::RELAXED)
# Clean up an HTML document using the Relaxed config.
Sanitize.document(html, Sanitize::Config::RELAXED)
# Clean up a standalone CSS stylesheet using the Relaxed config.
Sanitize::CSS.stylesheet(css, Sanitize::Config::RELAXED)
# Clean up some CSS properties using the Relaxed config.
Sanitize::CSS.properties(css, Sanitize::Config::RELAXED)
[!IMPORTANT] Eingaben, die nicht als HTML oder CSS geparst werden können, können eine Ausnahme auslösen. Wie Sie Ausnahmen behandeln (oder ob Sie zulassen, dass sie Ihre Anwendung zum Absturz bringen), bleibt Ihnen überlassen, aber denken Sie daran, wenn Sie nicht vertrauenswürdige Inhalte an Sanitize übergeben.
Sanitize kann die folgenden Arten von Eingaben bereinigen:
<style>-Elementenstyle-Attributen[!WARNING]
Sanitize kann den Inhalt von
<math>- oder<svg>-Elementen nicht vollständig bereinigen. MathML- und SVG-Elemente sind Fremdelemente, die nicht den normalen HTML-Parsing-Regeln folgen.Standardmäßig entfernt Sanitize alle MathML- und SVG-Elemente. Wenn Sie MathML- oder SVG-Elemente zu einer benutzerdefinierten Element-Allowlist hinzufügen, können Sie eine Sicherheitslücke in Ihrer Anwendung erzeugen.
Ein Fragment ist ein HTML-Schnipsel, der kein <html>-Element auf Root-Ebene enthält.
Wenn Sie keine Konfigurationsoptionen angeben, verwendet Sanitize standardmäßig seine strengsten Einstellungen, was bedeutet, dass es sämtliches HTML entfernt und nur sicheren Text zurücklässt.
html = '<b><a href="http://foo.com/">foo</a></b><img src="https://raw.githubusercontent.com/rgrove/sanitize/main/bar.jpg">'
Sanitize.fragment(html)
# => "foo"
Um bestimmte Elemente beizubehalten, füge sie der Element-Allowlist hinzu.
Sanitize.fragment(html, elements: ['b'])
# => "<b>foo</b>"
Beim Bereinigen eines Dokuments muss das <html>-Element auf der Allowlist stehen. Sie können außerdem :allow_doctype auf true setzen, um wohlgeformte Dokumenttypdefinitionen zuzulassen.
html = %[
<!DOCTYPE html>
<html>
<b><a href="http://foo.com/">foo</a></b><img src="https://raw.githubusercontent.com/rgrove/sanitize/main/bar.jpg">
</html>
]
Sanitize.document(html,
allow_doctype: true,
elements: ['html']
)
# => "<!DOCTYPE html><html>foo\n \n</html>"
Um CSS in einem HTML-Fragment oder -Dokument zu bereinigen, erlauben Sie zunächst das <style>-Element und/oder das style-Attribut über eine Allowlist. Erlauben Sie dann die CSS-Eigenschaften, @-Regeln und URL-Protokolle, die Sie zulassen möchten, über eine Allowlist. Sie können außerdem wählen, ob CSS-Kommentare oder Browser-Kompatibilitäts-Hacks zugelassen werden sollen.
html = %[
<style>
div { color: green; width: 1024px; }
</style>
<div style="height: 100px; width: 100px;"></div>
<p>hello!</p>
]
Sanitize.fragment(html,
elements: ['div', 'style'],
attributes: {'div' => ['style']},
css: {
properties: ['width']
}
)
#=> %[
# <style>
# div { width: 1024px; }
# </style>
#
# <div style=" width: 100px;"></div>
# hello!
# ]
Sanitize bereinigt problemlos ein eigenständiges CSS-Stylesheet oder einen Property-String, ohne den HTML-Parser aufrufen zu müssen.
[!WARNING] Dies sollte nur verwendet werden, um CSS für die Verwendung in einer eigenständigen CSS-Datei zu bereinigen. Um CSS für die Verwendung in einem HTML-Kontext sicher zu bereinigen, etwa in einem
<style>-Element oder einemstyle-Attribut, müssen SieSanitize.document()oderSanitize.fragment()mit einer geeigneten Allowlist verwenden, wie in den vorherigen Abschnitten beschrieben. Andernfalls können HTML-Injection-Angriffe ermöglicht werden.
css = %[
@import url(evil.css);
a { text-decoration: none; }
a:hover {
left: expression(alert('xss!'));
text-decoration: underline;
}
]
Sanitize::CSS.stylesheet(css, Sanitize::Config::RELAXED)
# => %[
#
#
# a { text-decoration: none; }
#
# a:hover {
#
# text-decoration: underline;
# }
# ]
Sanitize::CSS.properties(%[
left: expression(alert('xss!'));
text-decoration: underline;
], Sanitize::Config::RELAXED)
# => %[
#
# text-decoration: underline;
# ]
Zusätzlich zu den ultra-sicheren Standardeinstellungen bringt Sanitize drei weitere integrierte Konfigurationen mit, die Sie direkt verwenden oder an Ihre Bedürfnisse anpassen können.
Erlaubt nur sehr einfaches Inline-Markup. Keine Links, Bilder oder Blockelemente.
Sanitize.fragment(html, Sanitize::Config::RESTRICTED)
# => "<b>foo</b>"
Erlaubt eine Vielzahl von Markup-Elementen, einschließlich Formatierungselementen, Links und Listen.
Bilder und Tabellen sind nicht erlaubt, Links sind auf die Protokolle FTP, HTTP, HTTPS und mailto beschränkt, und allen Links wird ein rel="nofollow"-Attribut hinzugefügt, um SEO-Spam zu mindern.
Sanitize.fragment(html, Sanitize::Config::BASIC)
# => '<b><a href="http://foo.com/" rel="nofollow">foo</a></b>'
Ermöglicht eine noch größere Vielfalt an Markup, einschließlich Bildern und Tabellen sowie sicherem CSS. Links sind weiterhin auf die Protokolle FTP, HTTP, HTTPS und mailto beschränkt, während Bilder auf HTTP und HTTPS beschränkt sind. In diesem Modus wird rel="nofollow" nicht zu Links hinzugefügt.