
The OWASP Java Encoder ist eine einfach zu verwendende, leistungsstarke Java-1.5+-Encoder-Klasse, die direkt einsetzbar ist, keine Abhängigkeiten und nur wenig Ballast mit sich bringt. Dieses Projekt hilft Java-Webentwicklern, sich gegen Cross-Site-Scripting zu verteidigen!
Kontextbezogene Ausgabekodierung für Java 8+. Wählen Sie einen Encoder für den Parser-Kontext, der nicht vertrauenswürdigen Text empfängt: HTML, JavaScript, CSS, XML oder eine URL-Komponente. Der Kern hat keine Laufzeitabhängigkeiten; optionale JSP- und Jakarta-Adapter bieten Bindungen für die View-Ebene. Kodierung ist ein Teil der [XSS-Prävention][xss], zusammen mit sicheren Templates, URL-Validierung und anderen Anwendungskontrollen.
1.6.0 ist über Maven Central verfügbar. Dieses Minor-Release reduziert unnötiges JavaScript-Buchstaben-Escaping, während der Schutz erkannter HTML-Token über vertrauenswürdige Fragmente hinweg erhalten bleibt. Kodierte Bytes und Streaming-Verhalten ändern sich; siehe die Release Notes und die Veröffentlichungsverifizierung.
Die in 1.5.0 eingeführten Sicherheitskorrekturen an der Parser-Grenze bleiben in Kraft; Versionen bis einschließlich 1.4.1 enthalten diese Korrekturen nicht. Siehe den Sicherheitshinweis und VERIFYING.md.
Wählen Sie die benötigte Abhängigkeit.
Die drei unterstützten Artefakte verwenden die Gruppen-ID org.owasp.encoder:
| Artefakt-ID | Zweck und Laufzeitabhängigkeiten |
|---|---|
encoder | Kern-String/Writer-API; keine Laufzeitabhängigkeiten |
encoder-jsp | Legacy-javax-JSP-Tags/EL-Funktionen; Kern plus containerbereitgestellte JSP-API |
encoder-jakarta-jsp | Jakarta-JSP-Tags/EL-Funktionen; Kern plus containerbereitgestellte Jakarta-JSP-API |
<dependency>
<groupId>org.owasp.encoder</groupId>
<artifactId>encoder</artifactId>
<version>1.6.0</version>
</dependency>
Ersetze encoder bei Bedarf durch eine Tag-Adapter-Artefakt-ID; jeder Adapter bringt
den Core mit. Halte separat verwaltete Core-/Adapter-Versionen aufeinander abgestimmt. Verwende eines der
javax- oder Jakarta-Taglib-JARs: Sie teilen org.owasp.encoder.tag und dürfen nicht gemeinsam
im selben Classpath oder Modulpfad vorhanden sein. Siehe die Laufzeitmatrix und
das Abhängigkeits-/Lizenzinventar.
encoder-esapi wurde nach 1.4.1 eingestellt und ist in
1.5.x oder 1.6.0 weder enthalten noch unterstützt. Anwendungen, die es verwenden, müssen vom Adapter migrieren.
Veröffentlichte API-Dokumentation zu 1.6.0 (gehostete Indexierung kann der Veröffentlichung hinterherhinken): core, javax JSP und Jakarta JSP.
import org.owasp.encoder.Encode;
out.write("<p>");
Encode.forHtmlContent(out, userText); // Writer overload; no intermediate String
out.write("</p>");
Der entsprechende String-Aufruf ist Encode.forHtmlContent(userText). Aufrufer liefern
vertrauenswürdige umgebende Syntax und Attribut-Anführungszeichen. Kodieren Sie Rohdaten einmal, an der
Ausgabegrenze; berücksichtigen Sie jede Maskierung, die Ihre Template-Engine bereits durchführt.
| Ziel | API und Einschränkungen |
|---|---|
| HTML-Text, einschließlich textarea-Inhalt | forHtmlContent; forHtml deckt auch in Anführungszeichen gesetzte gewöhnliche Textattribute ab |
| In Anführungszeichen gesetztes HTML-Textattribut | forHtmlAttribute; kein Event-Handler-Ausdruck und kein URL-Validator |
| Eine rohe URL-Komponente | forUriComponent; mit vertrauenswürdigen Trennzeichen zusammensetzen, die URL validieren, dann für das umschließende HTML-Attribut kodieren |
| JavaScript-String | forJavaScript; einfache/doppelte Anführungszeichen bereitstellen. Gewöhnlicher nicht-getaggter Template-Literal-Text erfordert 1.5. Niemals in getaggten Templates, Ausdruckskörpern, JSON oder Script-URLs verwenden |
| JSON-String-Inhalt | forJson (1.5); doppelte Anführungszeichen bereitstellen. Für ein vollständiges Dokument einen Serializer bevorzugen |
In Anführungszeichen gesetzter CSS-String / CSS-url(...)-Wert | forCssString / forCssUrl; URLs validieren und die Kontextregeln der Methode befolgen |
| XML 1.0-Text / in Anführungszeichen gesetztes Attribut | forXmlContent / forXmlAttribute; forXml deckt beides ab |
| XML 1.1-Text / in Anführungszeichen gesetztes Attribut | forXml11Content / forXml11Attribute (Kern 1.4+); erfordert ein XML 1.1-Dokument/einen XML 1.1-Parser, nicht HTML |
| XML CDATA / Kommentar | forCDATA / forXmlComment; keine HTML-Kommentare |
| Java-Quelltext-String-Literal | forJava; Aufrufer liefern Anführungszeichen; nicht gepaarte Surrogate kompilieren möglicherweise nicht |
Jede aufgeführte Facade-Methode hat String- und Writer-Überladungen. Der Kontextleitfaden erklärt Verschachtelung, Null-/Unicode-Verhalten, JavaScript-Varianten, Template-Grenzen, JSON und unsichere Kontexte. Die Java/JSP-Beispiele zeigen vollständige umgebende Syntax.
Kodierung bereinigt kein HTML, validiert keine Eingaben/URLs, serialisiert keine JSON-Dokumente, führt keine SQL-Parametrisierung durch und dekodiert/kanonisiert keine Daten. Verwenden Sie einen HTML-Sanitizer, wenn Markup erlaubt sein muss; verwenden Sie parametrisierte Abfragen für SQL. Siehe den [OWASP Java security-library guide][java-libraries] für diese unterschiedlichen Rollen.
Taglib-URIs sind Bezeichner, keine URLs, die in einem Browser geöffnet werden müssen:
| Adapter | Basis-Bezeichner | Erweiterter Bezeichner |
|---|---|---|
| Jakarta | owasp.encoder.jakarta | owasp.encoder.jakarta.advanced |
| javax JSP | https://www.owasp.org/index.php/OWASP_Java_Encoder_Project | Derselbe Bezeichner mit angehängtem #advanced |
<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" isELIgnored="false" %>
<%@ taglib prefix="e" uri="owasp.encoder.jakarta" %>
<p>${e:forHtmlContent(param.message)}</p>
Verwenden Sie den javax-Bezeichner für einen javax-Container. Tags verwenden einen leeren Body und ein
erforderliches value-Attribut, zum Beispiel <e:forHtmlContent value="${param.message}" />.
Siehe Bindings und EL-Auswertung für
grundlegende versus fortgeschrittene Methoden und versionsabhängige Deployment-Einstellungen. In 1.5
stellen fortgeschrittene Taglibs jeden Encode.forX(String)-Kontext außer forJava bereit;
die Java-Quellcodegenerierung ist kein JSP-Kontext. XML-1.1-Bindings sind neu in 1.5.