OWASP Java エンコーダプロジェクト

コンテキスト出力エンコーディングは、クロスサイトスクリプティングを防ぐために必要なコンピュータプログラミング技術です。このプロジェクトは、Java 1.8以上に対応した、シンプルで使いやすく、軽量で高性能なエンコーダクラスです。

OWASP Java エンコーダの詳細なドキュメントについては、https://owasp.org/www-project-java-encoder/ をご覧ください。

OWASP Java エンコーダの使用を開始する

JARはMaven Centralからダウンロードできます。

JSPタグとEL関数はencoder-jspで利用可能です。また、以下も利用できます。

encoder-jakarta-jsp - Servlet仕様 5.0
encoder-jsp - Servlet仕様 3.0

JARはCentralでも入手可能です。

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

<!-- using Servlet Spec 5 in the jakarta.servlet package use: -->
<dependency>
    <groupId>org.owasp.encoder</groupId>
    <artifactId>encoder-jakarta-jsp</artifactId>
    <version>1.4.0</version>
</dependency>

<!-- using the Legacy Servlet Spec in the javax.servlet package use: -->
<dependency>
    <groupId>org.owasp.encoder</groupId>
    <artifactId>encoder-jsp</artifactId>
    <version>1.4.0</version>
</dependency>

クイックオーバービュー

OWASP Java エンコーダライブラリは、パフォーマンス面でも使用面でも非常にオーバーヘッドが少なく、素早いコンテキストエンコーディングを目的としています。使い始めるには、encoder-1.2.3.jar を追加し、import org.owasp.encoder.Encode して使用を開始するだけです。

使用例:

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

エンコード可能なさまざまなコンテキストについては、Encode の javadoc を参照してください。Happy Encoding!

ビルド

encoder-jakarta-jsp プロジェクトのテストケースにより、プロジェクトをパッケージ化してテストするには Java 17 が必要です。以下のように実行します。

mvn package

Jakarta JSPの統合テストを実行し、JSPタグとELが正しく動作することを検証するには、次のコマンドを実行します。

mvn verify -PtestJakarta

上記のテストは、モダンなAppleシリコン上では失敗する可能性があります。

Java 9+ モジュール名

JAR	モジュール名
encoder	owasp.encoder
encoder-jakarta-jsp	owasp.encoder.jakarta
encoder-jsp	owasp.encoder.jsp
encoder-espai	owasp.encoder.esapi

タグライブラリ

ライブラリ	タグライブラリ
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 エンコーダプロジェクトはマルチモジュールの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がリリースされたことをお知らせします！

機能: XML 1.1 エンコーディングサポートを追加 #88.

2024-08-20 - バージョン 1.3.1 リリース

チームはバージョン1.3.1がリリースされたことをお知らせします！

修正: MANIFEST.MFファイルにOSGi関連エントリを追加 #82.
修正: Java 8で実行時にjava.lang.NoSuchMethodErrorが発生する問題を修正 #80.

2024-08-02 - バージョン 1.3.0 リリース

チームはバージョン1.3.0がリリースされたことをお知らせします！

最小JDK要件がJava 8になりました
- テストケースの依存関係のため、ビルドにはJava 17が必要です。
マルチリリースJarによるJava 9モジュール名の追加 #77.
ESAPI Thunkのコンパイルエラーを修正 #76.
jakarta.servlet.* を使用したServlet仕様5のサポートを追加 #75.
- タグライブラリ : <%@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エンコーダが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エンコーダに置き換えるESAPI統合を追加しました。

2013-02-14 - バージョン1.1リリース

バージョン1.1がリリースされたことをお知らせします。いくつかのマイナーなエンコーディングの強化に加えて、パフォーマンスを向上させ、JSPタグと関数ライブラリを追加しました。

owasp-java-encoder

人気