Ab Chrome 120 ist in der Async Clipboard API eine neue unsanitized-Option verfügbar. Diese Option kann in speziellen Situationen mit HTML hilfreich sein, wenn Sie den Inhalt der Zwischenablage genau so einfügen müssen, wie er beim Kopieren war.
Das heißt, ohne einen Zwischenschritt zur Bereinigung, den Browser normalerweise – und aus gutem Grund – anwenden. In diesem Leitfaden erfahren Sie, wie Sie die Funktion verwenden.
Bei der Arbeit mit der Async Clipboard API müssen sich Entwickler in den meisten Fällen keine Gedanken über die Integrität des Inhalts in der Zwischenablage machen. Sie können davon ausgehen, dass das, was sie in die Zwischenablage schreiben (kopieren), identisch mit dem ist, was sie beim Lesen der Daten aus der Zwischenablage (einfügen) erhalten.
Das gilt auf jeden Fall für Text. Fügen Sie den folgenden Code in die DevTools-Konsole ein und fokussieren Sie die Seite dann sofort neu. (Die setTimeout() ist erforderlich, damit Sie genügend Zeit haben, die Seite zu fokussieren, was eine Voraussetzung für die Async Clipboard API ist.) Wie Sie sehen, ist die Eingabe genau dieselbe wie die Ausgabe.
setTimeout(async () => {
const input = 'Hello';
await navigator.clipboard.writeText(input);
const output = await navigator.clipboard.readText();
console.log(input, output, input === output);
// Logs "Hello Hello true".
}, 3000);
Bei Bildern ist das etwas anders. Um sogenannte Komprimierungsbomben-Angriffe zu verhindern, codieren Browser Bilder wie PNGs neu. Die Eingabe- und Ausgabebilder sind jedoch visuell genau gleich, Pixel für Pixel.
setTimeout(async () => {
const dataURL =
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=';
const input = await fetch(dataURL).then((response) => response.blob());
await navigator.clipboard.write([
new ClipboardItem({
[input.type]: input,
}),
]);
const [clipboardItem] = await navigator.clipboard.read();
const output = await clipboardItem.getType(input.type);
console.log(input.size, output.size, input.type === output.type);
// Logs "68 161 true".
}, 3000);
Was passiert aber mit HTML-Text? Wie Sie vielleicht vermutet haben, ist die Situation bei HTML anders. Hier bereinigt der Browser den HTML-Code, um zu verhindern, dass schädliche Dinge passieren. Dazu werden beispielsweise <script>-Tags aus dem HTML-Code entfernt (und andere wie <meta>, <head> und <style>) und CSS wird inline eingefügt.
Sehen Sie sich das folgende Beispiel an und probieren Sie es in der DevTools-Konsole aus. Sie werden feststellen, dass sich die Ausgabe erheblich von der Eingabe unterscheidet.
setTimeout(async () => {
const input = `<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="ProgId" content="Excel.Sheet" />
<meta name="Generator" content="Microsoft Excel 15" />
<style>
body {
font-family: HK Grotesk;
background-color: var(--color-bg);
}
</style>
</head>
<body>
<div>hello</div>
</body>
</html>`;
const inputBlob = new Blob([input], { type: 'text/html' });
await navigator.clipboard.write([
new ClipboardItem({
'text/html': inputBlob,
}),
]);
const [clipboardItem] = await navigator.clipboard.read();
const outputBlob = await clipboardItem.getType('text/html');
const output = await outputBlob.text();
console.log(input, output);
}, 3000);
Die HTML-Bereinigung ist im Allgemeinen eine gute Sache. In den meisten Fällen sollten Sie sich nicht durch die Zulassung von nicht bereinigtem HTML-Code Sicherheitsrisiken aussetzen. Es gibt jedoch Szenarien, in denen der Entwickler genau weiß, was er tut, und in denen die Integrität des Eingabe- und Ausgabe-HTML für das korrekte Funktionieren der App entscheidend ist. Unter diesen Umständen haben Sie zwei Möglichkeiten:
- Wenn Sie sowohl das Kopieren als auch das Einfügen steuern, z. B. wenn Sie innerhalb Ihrer App kopieren und dann ebenfalls innerhalb Ihrer App einfügen, sollten Sie benutzerdefinierte Webformate für die Async Clipboard API verwenden. Hören Sie hier auf zu lesen und rufen Sie den verlinkten Artikel auf.
- Wenn Sie nur das Einfügen in Ihrer App, aber nicht das Kopieren steuern, weil der Kopiervorgang beispielsweise in einer systemeigenen App erfolgt, die keine benutzerdefinierten Webformate unterstützt, sollten Sie die Option
unsanitizedverwenden, die im weiteren Verlauf dieses Artikels erläutert wird.
Dazu gehören das Entfernen von script-Tags, das Einfügen von Inline-Stilen und das Sicherstellen, dass der HTML-Code wohlgeformt ist. Diese Liste ist nicht vollständig und es können in Zukunft weitere Schritte hinzugefügt werden.
Kopieren und Einfügen von nicht bereinigtem HTML-Code
Wenn Sie HTML mit der Async Clipboard API in die Zwischenablage write() (kopieren), sorgt der Browser dafür, dass es wohlgeformt ist, indem er es durch einen DOM-Parser laufen lässt und den resultierenden HTML-String serialisiert. In diesem Schritt findet jedoch keine Bereinigung statt. Du musst nichts weiter tun. Wenn du HTML-Inhalte, die von einer anderen Anwendung in die Zwischenablage gelegt wurden, mit read() einfügst und deine Web-App den vollständigen Inhalt erhalten und die Bereinigung in deinem eigenen Code durchführen soll, kannst du der Methode read() ein Optionsobjekt mit dem Attribut unsanitized und dem Wert ['text/html'] übergeben. Isoliert sieht das so aus:
navigator.clipboard.read({ unsanitized: ['text/html'] }). Das folgende Codebeispiel ist fast identisch mit dem vorherigen, aber dieses Mal mit der Option unsanitized. Wenn Sie es in der DevTools-Konsole ausprobieren, werden Sie feststellen, dass die Eingabe und die Ausgabe identisch sind.
setTimeout(async () => {
const input = `<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="ProgId" content="Excel.Sheet" />
<meta name="Generator" content="Microsoft Excel 15" />
<style>
body {
font-family: HK Grotesk;
background-color: var(--color-bg);
}
</style>
</head>
<body>
<div>hello</div>
</body>
</html>`;
const inputBlob = new Blob([input], { type: 'text/html' });
await navigator.clipboard.write([
new ClipboardItem({
'text/html': inputBlob,
}),
]);
const [clipboardItem] = await navigator.clipboard.read({
unsanitized: ['text/html'],
});
const outputBlob = await clipboardItem.getType('text/html');
const output = await outputBlob.text();
console.log(input, output);
}, 3000);
Browserunterstützung und Featureerkennung
Es gibt keine direkte Möglichkeit, zu prüfen, ob die Funktion unterstützt wird. Die Funktionserkennung basiert daher auf der Beobachtung des Verhaltens. Daher wird im folgenden Beispiel geprüft, ob ein <style>-Tag erhalten bleibt, was auf Unterstützung hinweist, oder ob es inline eingefügt wird, was auf fehlende Unterstützung hinweist. Damit dies funktioniert, muss die Seite bereits die Berechtigung für die Zwischenablage erhalten haben.
const supportsUnsanitized = async () => {
const input = `<style>p{color:red}</style><p>a`;
const inputBlob = new Blob([input], { type: 'text/html' });
await navigator.clipboard.write([
new ClipboardItem({
'text/html': inputBlob,
}),
]);
const [clipboardItem] = await navigator.clipboard.read({
unsanitized: ['text/html'],
});
const outputBlob = await clipboardItem.getType('text/html');
const output = await outputBlob.text();
return /<style>/.test(output);
};
Demo
Eine Demo der Option unsanitized und den zugehörigen Quellcode finden Sie hier bzw. hier.
Zusammenfassung
Wie in der Einführung beschrieben, müssen sich die meisten Entwickler keine Gedanken über die Bereinigung der Zwischenablage machen und können einfach die Standardbereinigungsoptionen des Browsers verwenden. Für die seltenen Fälle, in denen Entwickler sich darum kümmern müssen, gibt es die Option unsanitized.
Nützliche Links
Danksagungen
Dieser Artikel wurde von Anupam Snigdha und Rachel Andrew geprüft. Die API wurde vom Microsoft Edge-Team spezifiziert und implementiert.