
The OWASP Java Encoder è una classe encoder ad alte prestazioni, semplice da usare e integrabile direttamente, compatibile con Java 1.5+, senza dipendenze e con un ingombro minimo. Questo progetto aiuterà gli sviluppatori web Java a difendersi dal Cross Site Scripting!
Codifica contestuale dell'output per Java 8+. Scegli un encoder per il contesto del parser che riceve testo non attendibile: HTML, JavaScript, CSS, XML o un componente di URL. Il core non ha dipendenze a runtime; gli adattatori opzionali JSP e Jakarta forniscono binding per il livello di vista. La codifica è una parte della [prevenzione XSS][xss], insieme a template sicuri, validazione degli URL e altri controlli applicativi.
La versione 1.6.0 è disponibile su Maven Central. Questa release minore riduce l'escaping non necessario delle lettere JavaScript preservando la protezione riconosciuta dei token HTML attraverso frammenti attendibili. I byte codificati e il comportamento dello streaming cambiano; consulta le note di rilascio e la verifica della pubblicazione.
Le correzioni di sicurezza relative ai confini del parser introdotte nella 1.5.0 restano in vigore; le versioni fino alla 1.4.1 non contengono tali correzioni. Consulta l'avviso di sicurezza e VERIFYING.md.
Seleziona la dipendenza di cui hai bisogno.
I tre artefatti supportati usano il group ID org.owasp.encoder:
| Artifact ID | Scopo e dipendenze a runtime |
|---|---|
encoder | API core String/Writer; nessuna dipendenza a runtime |
encoder-jsp | Tag JSP/EL function legacy javax; core più API JSP fornita dal container |
encoder-jakarta-jsp | Tag JSP/EL function Jakarta; core più API JSP Jakarta fornita dal container |
<dependency>
<groupId>org.owasp.encoder</groupId>
<artifactId>encoder</artifactId>
<version>1.6.0</version>
</dependency>
Sostituisci encoder con l'ID artefatto di un adattatore tag quando necessario; ogni adattatore include il core. Mantieni allineate le versioni di core/adattatore gestite separatamente. Usa uno dei JAR taglib javax o Jakarta: condividono org.owasp.encoder.tag e non devono coesistere sullo stesso classpath o module path. Vedi la matrice di runtime e l'inventario delle dipendenze/licenze.
encoder-esapi è stato ritirato dopo la 1.4.1 e non è incluso né supportato nella 1.5.x o nella 1.6.0. Le applicazioni che lo utilizzano devono migrare lontano dall'adattatore.
Documentazione API pubblicata della 1.6.0 (l'indicizzazione ospitata potrebbe essere in ritardo rispetto alla pubblicazione): core, javax JSP e Jakarta JSP.
import org.owasp.encoder.Encode;
out.write("<p>");
Encode.forHtmlContent(out, userText); // Writer overload; no intermediate String
out.write("</p>");
La chiamata String equivalente è Encode.forHtmlContent(userText). I chiamanti forniscono
la sintassi circostante attendibile e le virgolette degli attributi. Codifica i dati grezzi una sola volta, al
confine dell'output; tieni conto di qualsiasi escaping già eseguito dal tuo motore di template.
| Destinazione | API e limiti |
|---|---|
| Testo HTML, incluso il contenuto di textarea | forHtmlContent; forHtml copre anche gli attributi di testo ordinari tra virgolette |
| Attributo di testo HTML tra virgolette | forHtmlAttribute; non è un validatore di espressioni event-handler o di URL |
| Un singolo componente URL grezzo | forUriComponent; assembla con delimitatori attendibili, valida l'URL, poi codifica per l'attributo HTML che lo racchiude |
| Stringa JavaScript | forJavaScript; fornisci virgolette singole/doppie. Il testo ordinario di un template literal non taggato richiede la 1.5. Non usare mai nei template taggati, nei corpi di espressione, in JSON o negli URL di script |
| Contenuto di stringa JSON | forJson (1.5); fornisci virgolette doppie. Preferisci un serializzatore per un documento completo |
Stringa CSS tra virgolette / valore CSS url(...) | forCssString / forCssUrl; valida gli URL e rispetta le regole del contesto circostante del metodo |
| Testo XML 1.0 / attributo tra virgolette | forXmlContent / forXmlAttribute; forXml copre entrambi |
| Testo XML 1.1 / attributo tra virgolette | forXml11Content / forXml11Attribute (core 1.4+); richiede un documento/parser XML 1.1, non HTML |
| CDATA / commento XML | forCDATA / forXmlComment; non per i commenti HTML |
| String literal del codice sorgente Java | forJava; il chiamante fornisce le virgolette; i surrogati non appaiati potrebbero non compilare |
Ogni metodo facade elencato ha overload String e Writer. La guida ai contesti spiega l'annidamento, il comportamento di null/Unicode, le varianti JavaScript, i confini dei template, JSON e i contesti non sicuri. Gli esempi Java/JSP mostrano la sintassi circostante completa.
La codifica non sanifica l'HTML, non valida input/URL, non serializza documenti JSON, non esegue la parametrizzazione SQL e non decodifica/canonicalizza i dati. Usa un sanitizer HTML quando il markup deve essere consentito; usa query parametrizzate per SQL. Consulta la [guida alla libreria di sicurezza Java OWASP][java-libraries] per questi ruoli distinti.
Gli URI delle taglib sono identificatori, non URL che devono aprirsi in un browser:
| Adapter | Identificatore base | Identificatore avanzato |
|---|---|---|
| Jakarta | owasp.encoder.jakarta | owasp.encoder.jakarta.advanced |
| javax JSP | https://www.owasp.org/index.php/OWASP_Java_Encoder_Project | Stesso identificatore con #advanced aggiunto |
<%@ 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>
Usa l'identificatore javax per un container javax. I tag usano un corpo vuoto e un attributo value obbligatorio, ad esempio <e:forHtmlContent value="${param.message}" />.
Vedi bindings and EL evaluation per
i metodi di base rispetto a quelli avanzati e le impostazioni di deployment sensibili alla versione. In 1.5,
le taglib avanzate espongono ogni contesto Encode.forX(String) tranne forJava;
la generazione di sorgenti Java non è un contesto JSP. I binding XML 1.1 sono nuovi in 1.5.