
El OWASP Java Encoder es una clase codificadora de alto rendimiento, fácil de usar y de integración directa, compatible con Java 1.5+, sin dependencias y con poco peso. ¡Este proyecto ayudará a los desarrolladores web de Java a defenderse contra Cross Site Scripting!
Codificación de salida contextual para Java 8+. Elija un codificador para el contexto del analizador que recibe texto no confiable: HTML, JavaScript, CSS, XML o un componente de URL. El núcleo no tiene dependencias en tiempo de ejecución; los adaptadores opcionales para JSP y Jakarta proporcionan enlaces para la capa de vista. La codificación es una parte de la [prevención de XSS][xss], junto con plantillas seguras, validación de URL y otros controles de la aplicación.
1.6.0 está disponible en Maven Central. Esta versión menor reduce el escape innecesario de letras en JavaScript mientras preserva la protección reconocida de tokens HTML en fragmentos confiables. Los bytes codificados y el comportamiento de streaming cambian; consulte las notas de la versión y la verificación de publicación.
Las correcciones de seguridad en los límites del analizador introducidas en 1.5.0 siguen vigentes; las versiones hasta la 1.4.1 no contienen esas correcciones. Consulte el aviso de seguridad y VERIFYING.md.
Seleccione la dependencia que necesita.
Los tres artefactos compatibles usan el group ID org.owasp.encoder:
| Artifact ID | Propósito y dependencias en tiempo de ejecución |
|---|---|
encoder | API principal String/Writer; sin dependencias en tiempo de ejecución |
encoder-jsp | Etiquetas JSP y funciones EL heredadas de javax; núcleo más la API JSP proporcionada por el contenedor |
encoder-jakarta-jsp | Etiquetas JSP y funciones EL de Jakarta; núcleo más la API JSP de Jakarta proporcionada por el contenedor |
<dependency>
<groupId>org.owasp.encoder</groupId>
<artifactId>encoder</artifactId>
<version>1.6.0</version>
</dependency>
Reemplace encoder por el ID de artefacto de un adaptador de etiquetas cuando sea necesario; cada adaptador incorpora el core. Mantenga alineadas las versiones de core/adaptador gestionadas por separado. Use uno de los JAR de taglib de javax o Jakarta: comparten org.owasp.encoder.tag y no deben coexistir en el mismo classpath o module path. Consulte la matriz de tiempo de ejecución y el inventario de dependencias/licencias.
encoder-esapi fue retirado después de 1.4.1 y no está incluido ni soportado en 1.5.x ni en 1.6.0. Las aplicaciones que lo usan deben migrar fuera del adaptador.
Documentación de la API publicada de 1.6.0 (la indexación alojada puede retrasarse respecto a la publicación): core, javax JSP y Jakarta JSP.
import org.owasp.encoder.Encode;
out.write("<p>");
Encode.forHtmlContent(out, userText); // Writer overload; no intermediate String
out.write("</p>");
La llamada String equivalente es Encode.forHtmlContent(userText). Los llamadores proporcionan la sintaxis circundante de confianza y las comillas de los atributos. Codifique los datos sin procesar una sola vez, en el límite de salida; tenga en cuenta cualquier escape que su motor de plantillas ya realice.
| Destino | API y límites |
|---|---|
| Texto HTML, incluido el contenido de textarea | forHtmlContent; forHtml también cubre atributos de texto ordinarios entre comillas |
| Atributo de texto HTML entre comillas | forHtmlAttribute; no es un validador de expresiones de controladores de eventos ni de URL |
| Un componente de URL sin procesar | forUriComponent; ensamble con delimitadores de confianza, valide la URL y luego codifique para el atributo HTML contenedor |
| Cadena JavaScript | forJavaScript; proporcione comillas simples/dobles. El texto ordinario de plantillas literales sin etiquetar requiere 1.5. Nunca lo use en plantillas etiquetadas, cuerpos de expresiones, JSON ni URL de scripts |
| Contenido de cadena JSON | forJson (1.5); proporcione comillas dobles. Prefiera un serializador para un documento completo |
Cadena CSS entre comillas / valor CSS url(...) | forCssString / forCssUrl; valide las URL y cumpla las reglas de contexto circundante del método |
| Texto XML 1.0 / atributo entre comillas | forXmlContent / forXmlAttribute; forXml cubre ambos |
| Texto XML 1.1 / atributo entre comillas | forXml11Content / forXml11Attribute (núcleo 1.4+); requiere un documento/analizador XML 1.1, no HTML |
| CDATA / comentario XML | forCDATA / forXmlComment; no para comentarios HTML |
| Literal de cadena de código fuente Java | forJava; el llamador proporciona las comillas; los sustitutos no emparejados pueden no compilar |
Cada método de fachada listado tiene sobrecargas String y Writer. La guía de contextos explica el anidamiento, el comportamiento de null/Unicode, las variantes de JavaScript, los límites de plantillas, JSON y los contextos no seguros. Los ejemplos de Java/JSP muestran la sintaxis circundante completa.
La codificación no sanitiza HTML, no valida entradas/URL, no serializa documentos JSON, no realiza parametrización SQL ni decodifica/canonicaliza datos. Use un sanitizador de HTML cuando deba permitirse el marcado; use consultas parametrizadas para SQL. Consulte la [guía de la biblioteca de seguridad de Java de OWASP][java-libraries] para estos roles distintos.
Los URI de Taglib son identificadores, no URL que deban abrirse en un navegador:
| Adaptador | Identificador básico | Identificador avanzado |
|---|---|---|
| Jakarta | owasp.encoder.jakarta | owasp.encoder.jakarta.advanced |
| javax JSP | https://www.owasp.org/index.php/OWASP_Java_Encoder_Project | El mismo identificador con #advanced añadido |
<%@ 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>
Utilice el identificador javax para un contenedor javax. Las etiquetas usan un cuerpo vacío y un atributo value obligatorio, por ejemplo <e:forHtmlContent value="${param.message}" />.
Consulte bindings and EL evaluation para
los métodos básicos frente a los avanzados y la configuración de despliegue sensible a la versión. En 1.5,
los taglibs avanzados exponen todos los contextos Encode.forX(String) excepto forJava;
la generación de código fuente Java no es un contexto JSP. Los bindings XML 1.1 son nuevos en 1.5.
Descubre las herramientas más usadas por nuestra comunidad.
Sin datos de popularidad aún.