OWASP Java Encoder 프로젝트

컨텍스트 기반 출력 인코딩(Contextual Output Encoding)은 크로스 사이트 스크립팅(Cross-Site Scripting)을 차단하기 위해 필요한 컴퓨터 프로그래밍 기법입니다. 이 프로젝트는 Java 1.8 이상에서 사용할 수 있는, 간단하게 바로 적용 가능한 고성능 인코더 클래스로, 부가적인 요소가 거의 없습니다.

OWASP Java Encoder에 대한 더 자세한 문서는 https://owasp.org/www-project-java-encoder/ 에서 확인하세요.

OWASP Java Encoder 사용 시작하기

Maven Central 에서 JAR을 다운로드할 수 있습니다.

JSP 태그와 EL 함수는 encoder-jsp에서 제공되며, 다음 항목도 사용할 수 있습니다.

encoder-jakarta-jsp - Servlet Spec 5.0
encoder-jsp - Servlet Spec 3.0

JAR은 Central에서도 사용할 수 있습니다.

<dependency>
    <groupId>org.owasp.encoder</groupId>
    <artifactId>encoder</artifactId>
    <version>1.4.0</version>
</dependency>

<!-- jakarta.servlet 패키지의 Servlet Spec 5를 사용하는 경우: -->
<dependency>
    <groupId>org.owasp.encoder</groupId>
    <artifactId>encoder-jakarta-jsp</artifactId>
    <version>1.4.0</version>
</dependency>

<!-- javax.servlet 패키지의 레거시 Servlet Spec을 사용하는 경우: -->
<dependency>
    <groupId>org.owasp.encoder</groupId>
    <artifactId>encoder-jsp</artifactId>
    <version>1.4.0</version>
</dependency>

빠른 개요

OWASP Java Encoder 라이브러리는 성능이나 사용 측면에서 오버헤드가 거의 없이 빠른 컨텍스트 기반 인코딩을 제공하기 위한 것입니다. 시작하려면 encoder-1.2.3.jar을 추가하고, org.owasp.encoder.Encode를 임포트한 뒤 사용하면 됩니다.

사용 예시:

    PrintWriter out = ....;
    out.println("<textarea>"+Encode.forHtml(userData)+"</textarea>");

인코딩할 수 있는 다양한 컨텍스트를 보려면 Encode의 javadoc을 확인하세요.

즐거운 인코딩 되세요!

빌드

encoder-jakarta-jsp 프로젝트의 테스트 케이스 때문에 프로젝트를 패키징하고 테스트하려면 Java 17이 필요합니다. 다음 명령만 실행하면 됩니다.

mvn package

Jakarta JSP 통합 테스트를 실행하여 JSP 태그와 EL이 올바르게 동작하는지 검증하려면 다음을 실행하세요.

mvn verify -PtestJakarta

위 테스트는 최신 Apple 실리콘에서는 실패할 수 있습니다.

Java 9+ 모듈 이름

JAR	Module Name
encoder	owasp.encoder
encoder-jakarta-jsp	owasp.encoder.jakarta
encoder-jsp	owasp.encoder.jsp
encoder-espai	owasp.encoder.esapi

TagLib

Lib	TagLib
encoder-jakarta-jsp	<%@taglib prefix="e" uri="owasp.encoder.jakarta"%>
encoder-jsp	<%@taglib prefix="e" uri="https://www.owasp.org/index.php/OWASP_Java_Encoder_Project"%>

개발

OWASP Java Encoder 프로젝트는 멀티 모듈 Maven 프로젝트입니다.

$ mvn package

벤치마크(현재 개선이 필요함)는 다음 명령으로 실행할 수 있습니다.

$ mvn verify -Pbenchmarks

릴리스는 central-publishing-maven-plugin을 통해 수행됩니다.

$ mvn mvn clean package deploy -DperformRelease=true

소식

2025-11-17 - 1.4.0 릴리스

팀은 버전 1.4.0이 릴리스되었음을 알리게 되어 기쁩니다!

feat: XML 1.1 인코딩 지원 추가 #88.

2024-08-20 - 1.3.1 릴리스

팀은 버전 1.3.1이 릴리스되었음을 알리게 되어 기쁩니다!

fix: MANIFEST.MF 파일에 OSGi 관련 항목 추가 #82.
fix: Java 8에서 실행 시 발생하는 java.lang.NoSuchMethodError 수정 #80.

2024-08-02 - 1.3.0 릴리스

팀은 버전 1.3.0이 릴리스되었음을 알리게 되어 기쁩니다!

최소 JDK 요구 사항이 이제 Java 8입니다.
- 테스트 케이스 의존성 때문에 빌드에는 Java 17이 필요합니다.
Multi-Release Jars를 통한 Java 9 모듈 이름 추가 #77.
ESAPI Thunk의 컴파일 오류 수정 #76.
jakarta.servlet.*를 사용한 Servlet Spec 5 지원 추가 #75.
- taglib : <%@taglib prefix="e" uri="owasp.encoder.jakarta"%>

2020-11-08 - 1.2.3 릴리스

팀은 버전 1.2.3이 릴리스되었음을 알리게 되어 기쁩니다!

매니페스트가 OSGi를 준수하도록 업데이트 #39.
ESAPI 2.2 이상을 지원하도록 업데이트 #37.

2018-09-14 - 1.2.2 릴리스

팀은 버전 1.2.2가 릴리스되었음을 알리게 되어 기쁩니다!

문서와 라이선스 문제를 수정하는 마이너 릴리스입니다.

2017-02-19 - 1.2.1 릴리스

팀은 버전 1.2.1이 릴리스되었음을 알리게 되어 기쁩니다!

CDATA 인코더는 인접한 CDATA 섹션 사이에 중간 문자를 출력하지 않도록 수정되었습니다.
gh-pages 의 문서가 개선되었습니다.

2015-04-12 - GitHub에서 1.2 릴리스

OWASP Java Encoder가 GitHub로 이동했습니다. 버전 1.2도 릴리스되었습니다!

2014-03-31 - 문서 업데이트

각 API 사용에 대한 자세한 문서와 예제는 https://www.owasp.org/index.php/OWASP_Java_Encoder_Project#tab=Use_the_Java_Encoder_Project 에서 확인하세요!

2014-01-30 - 버전 1.1.1 릴리스

버전 1.1.1이 릴리스되었음을 알리게 되어 기쁩니다. 중요한 버그 수정과 함께, 레거시 ESAPI 인코더를 OWASP Java Encoder로 대체하는 ESAPI 통합 기능이 추가되었습니다.

2013-02-14 - 버전 1.1 릴리스

버전 1.1이 릴리스되었음을 알리게 되어 기쁩니다. 몇 가지 사소한 인코딩 개선과 함께 성능이 향상되었고, JSP 태그 및 함수 라이브러리가 추가되었습니다.

owasp-java-encoder

인기