
O OWASP Java Encoder é uma classe de codificador de alto desempenho, simples de usar e plugável para Java 1.5+, sem dependências e com pouco peso. Este projeto ajudará desenvolvedores web Java a se defenderem contra Cross Site Scripting!
Codificação de saída contextual para Java 8+. Escolha um codificador para o contexto do parser que recebe texto não confiável: HTML, JavaScript, CSS, XML ou um componente de URL. O núcleo não possui dependências de tempo de execução; adaptadores opcionais para JSP e Jakarta fornecem vinculações na camada de visualização. A codificação é uma parte da [prevenção de XSS][xss], ao lado de templates seguros, validação de URL e outros controles da aplicação.
A versão 1.6.0 está disponível no Maven Central. Esta versão menor reduz a fuga desnecessária de letras em JavaScript, preservando a proteção reconhecida de tokens HTML em fragmentos confiáveis. Os bytes codificados e o comportamento de streaming mudam; consulte as notas de versão e a verificação de publicação.
As correções de segurança de limite de parser introduzidas na 1.5.0 permanecem em vigor; as versões até a 1.4.1 não contêm essas correções. Consulte o aviso de segurança e VERIFYING.md.
Selecione a dependência de que você precisa.
Os três artefatos suportados usam o group ID org.owasp.encoder:
| Artifact ID | Finalidade e dependências de tempo de execução |
|---|---|
encoder | API principal String/Writer; sem dependências de tempo de execução |
encoder-jsp | Tags/EL functions JSP legadas javax; núcleo mais API JSP fornecida pelo contêiner |
encoder-jakarta-jsp | Tags/EL functions JSP Jakarta; núcleo mais API JSP Jakarta fornecida pelo contêiner |
<dependency>
<groupId>org.owasp.encoder</groupId>
<artifactId>encoder</artifactId>
<version>1.6.0</version>
</dependency>
Substitua encoder por um ID de artefato de adaptador de tag quando necessário; cada adaptador traz
o core. Mantenha as versões de core/adaptador gerenciadas separadamente alinhadas. Use um dos
JARs de taglib javax ou Jakarta: eles compartilham org.owasp.encoder.tag e não devem coexistir
no mesmo classpath ou module path. Consulte a matriz de runtime e o
inventário de dependências/licenças.
O encoder-esapi foi descontinuado após a 1.4.1 e não está incluído nem é suportado na
1.5.x ou 1.6.0. Aplicações que o utilizam devem migrar para fora do adaptador.
Documentação da API 1.6.0 publicada (a indexação hospedada pode estar atrasada em relação à publicação): 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>");
A chamada String equivalente é Encode.forHtmlContent(userText). Os chamadores fornecem
a sintaxe envolvente confiável e as aspas dos atributos. Codifique os dados brutos uma vez, no
limite de saída; considere qualquer escape que o seu motor de templates já realize.
| Destino | API e limites |
|---|---|
| Texto HTML, incluindo conteúdo de textarea | forHtmlContent; forHtml também cobre atributos de texto comuns entre aspas |
| Atributo de texto HTML entre aspas | forHtmlAttribute; não é um validador de expressões de event-handler nem de URLs |
| Um componente de URL bruto | forUriComponent; monte com delimitadores confiáveis, valide a URL e depois codifique para o atributo HTML envolvente |
| String JavaScript | forJavaScript; forneça aspas simples/duplas. Texto comum de template literal não marcado requer a versão 1.5. Nunca use em templates marcados, corpos de expressão, JSON ou URLs de script |
| Conteúdo de string JSON | forJson (1.5); forneça aspas duplas. Prefira um serializador para um documento completo |
String CSS entre aspas / valor url(...) de CSS | forCssString / forCssUrl; valide as URLs e respeite as regras de contexto envolvente do método |
| Texto XML 1.0 / atributo entre aspas | forXmlContent / forXmlAttribute; forXml cobre ambos |
| Texto XML 1.1 / atributo entre aspas | forXml11Content / forXml11Attribute (core 1.4+); requer um documento/parser XML 1.1, não HTML |
| CDATA / comentário XML | forCDATA / forXmlComment; não são comentários HTML |
| Literal de string de código-fonte Java | forJava; o chamador fornece as aspas; surrogates não emparelhados podem não compilar |
Todos os métodos de fachada listados têm sobrecargas String e Writer. O guia de contextos explica aninhamento, comportamento de null/Unicode, variantes de JavaScript, limites de templates, JSON e contextos inseguros. Os exemplos Java/JSP mostram a sintaxe envolvente completa.
A codificação não sanitiza HTML, não valida entrada/URLs, não serializa documentos JSON, não realiza parametrização SQL nem descodifica/canonicaliza dados. Use um sanitizador HTML quando a marcação tiver de ser permitida; use consultas parametrizadas para SQL. Consulte o [guia da biblioteca de segurança Java da OWASP][java-libraries] para estes papéis distintos.
Os URIs de Taglib são identificadores, não URLs que tenham de abrir num navegador:
| Adaptador | Identificador básico | Identificador avançado |
|---|---|---|
| Jakarta | owasp.encoder.jakarta | owasp.encoder.jakarta.advanced |
| javax JSP | https://www.owasp.org/index.php/OWASP_Java_Encoder_Project | O mesmo identificador com #advanced acrescentado |
<%@ 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>
Use o identificador javax para um contêiner javax. As tags usam um corpo vazio e um atributo value obrigatório, por exemplo <e:forHtmlContent value="${param.message}" />.
Consulte bindings e avaliação EL para
métodos básicos versus avançados e configurações de implantação sensíveis à versão. Na 1.5,
as taglibs avançadas expõem todos os contextos Encode.forX(String) exceto forJava;
a geração de código-fonte Java não é um contexto JSP. Os bindings XML 1.1 são novos na 1.5.
Encode.forUri está obsoleto na API lançada. A versão 1.5.0 estende
essa obsolescência para Encoders.URI, ambas as classes ForUriTag e a documentação
da tag/função forUri. Todos esses pontos de entrada são mantidos durante o 1.x. Codificar uma URI inteira não a valida:
forUri("javascript:alert(1)") a retorna inalterada. Sinais % existentes são codificados
novamente. Use forUriComponent para um nome/valor de parâmetro bruto, segmento de caminho ou
fragmento; valide URLs completas separadamente e, em seguida, use forHtmlAttribute ao
colocar uma em um atributo HTML entre aspas. Analisar apenas com java.net.URI não
estabelece segurança. Consulte o exemplo de URL completo.
Descubra as ferramentas mais usadas pela nossa comunidade.
Sem dados de popularidade ainda.