jp.terasoluna.fw.web.thin.patch

クラス ExtensionFilter

java.lang.Object

jp.terasoluna.fw.web.thin.patch.ExtensionFilter

すべての実装されたインタフェース:

javax.servlet.Filter

public class ExtensionFilter
extends Object
implements javax.servlet.Filter

拡張子チェックを行う。

Filterの初期化パラメータaccess.control.prohibited.extensionで指定された、 禁止拡張子をもつパスへのアクセス要求に対しSC_NOT_FOUND(404)エラーを返す。
これにより、当該拡張子を持つファイルへの直接アクセスを禁止する。
禁止拡張子へのアクセス制限を行う場合でそのチェック対象から外したい 特別なパスがあれば、Filterの初期化パラメータrestrictionEscape の値として定義することで、チェック非対象のパスを定義できる。
直接アクセス禁止対象の拡張子、およびアクセス禁止対象から外したいパスが 複数ある場合、改行区切りで指定すること。

使用方法

この機能を使用するには デプロイメントディスクリプタ（web.xml）に 以下のように設定する。

 <filter>
   <filter-name>extensionFilter</filter-name>
   <filter-class>jp.terasoluna.fw.web.thin.patch.ExtensionFilter</filter-class>
   <!-- (1) アクセス禁止となる拡張子の一覧 -->
   <init-param>
     <param-name>access.control.prohibited.extension</param-name>
     <param-value>
       .jsp
       .csv
       .pdf
     </param-value>
   </init-param>
   <!-- (2) チェック対象外となるリクエストパスの一覧 -->
   <init-param>
     <param-name>restrictionEscape</param-name>
     <param-value>
       /sample/logon/index.jsp
       /sample/error/error.jsp
     </param-value>
   </init-param>
 </filter>

 <filter-mapping>
   <filter-name>extensionFilter</filter-name>
   <url-pattern>/*</url-pattern>
 </filter-mapping>
 

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	EXTENSION_THRU_KEY リクエストがフィルタを通過したことを示すリクエスト属性のキー。
private static org.apache.commons.logging.Log	log ログクラス。
private static String	PROHIBITED_EXTENSION_KEY Filterの初期化パラメータから取得する、直接アクセスを禁止する拡張子のキー。
private List	prohibitedExtensionList Webブラウザからの直接アクセスを禁止する拡張子のリスト。
static String	RESTRICTION_ESCAPE_KEY Filterの初期化パラメータから取得する、拡張子制限チェックを対象外にするパスのキー。
private List	restrictionEscapePaths 拡張子制限チェックの対象外となるパスのリスト。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ExtensionFilter()

メソッドのサマリー

メソッド

修飾子とタイプ	メソッドと説明
void	destroy() フィルタ処理時に呼び出される。
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain) 拡張子チェックを行う。
protected String	getExtension(String name) 指定された文字列から末尾の拡張子を取得する。
void	init(javax.servlet.FilterConfig config) フィルタがサービス開始状態になる際に、コンテナによって呼び出される。
protected Set	resolveAccessControlPath(javax.servlet.ServletRequest request) リクエストから、アクセス制御用のパスを解決する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

EXTENSION_THRU_KEY

public static final String EXTENSION_THRU_KEY

リクエストがフィルタを通過したことを示すリクエスト属性のキー。

関連項目:

定数フィールド値

RESTRICTION_ESCAPE_KEY

public static final String RESTRICTION_ESCAPE_KEY

Filterの初期化パラメータから取得する、拡張子制限チェックを対象外にするパスのキー。

関連項目:

定数フィールド値

log

private static org.apache.commons.logging.Log log

ログクラス。

PROHIBITED_EXTENSION_KEY

private static final String PROHIBITED_EXTENSION_KEY

Filterの初期化パラメータから取得する、直接アクセスを禁止する拡張子のキー。

関連項目:

定数フィールド値

prohibitedExtensionList

private List prohibitedExtensionList

Webブラウザからの直接アクセスを禁止する拡張子のリスト。

restrictionEscapePaths

private List restrictionEscapePaths

拡張子制限チェックの対象外となるパスのリスト。

コンストラクタの詳細

ExtensionFilter

public ExtensionFilter()

メソッドの詳細

init

public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException

フィルタがサービス開始状態になる際に、コンテナによって呼び出される。 コンテナは、Filterをインスタンス化した後に、init メソッドを 1 回だけ呼び出す。
Filterにフィルタ処理作業を実行するように要求するには、 init メソッドが正常に 終了していなければならない。 initメソッドが 次のいずれかの状態の場合、コンテナは Filterをサービス状態にできない。

• ServletException をスローした。
• コンテナによって定義された時間内に、復帰しない。

定義:

init インタフェース内 javax.servlet.Filter

パラメータ:

config - FilterConfigインスタンス。

例外:

javax.servlet.ServletException - 初期化異常時にスローされる例外。

関連項目:

Filter.init(javax.servlet.FilterConfig)

doFilter

public void doFilter(javax.servlet.ServletRequest req,
            javax.servlet.ServletResponse res,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

拡張子チェックを行う。

定義:

doFilter インタフェース内 javax.servlet.Filter

パラメータ:

req - HTTPリクエスト

res - HTTPレスポンス

chain - フィルタチェーン

例外:

IOException - I/Oエラー

javax.servlet.ServletException - サーブレット例外

関連項目:

Filter.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)

destroy

public void destroy()

フィルタ処理時に呼び出される。
このクラスでは処理は行なわない。

定義:

destroy インタフェース内 javax.servlet.Filter

関連項目:

Filter.destroy()

getExtension

protected String getExtension(String name)

指定された文字列から末尾の拡張子を取得する。 拡張子がない場合は空文字列を返す。 nameがnullの場合はnullを返す。

パラメータ:

name - 拡張子つきの名前

戻り値:

拡張子

resolveAccessControlPath

protected Set resolveAccessControlPath(javax.servlet.ServletRequest request)

リクエストから、アクセス制御用のパスを解決する。 このメソッドから返却されるSetに格納されたパスが、拡張子チェックの対象となる。

以下の方法でパスを解決する。
1. HttpServletRequest.getServletPath()
2. HttpServletRequest.getServletPath() + HttpServletRequest.getPathInfo()
※HttpServletRequest.getPathInfo()がnullの場合は、1のみを戻り値のSetに含む。
※HttpServletRequest.getPathInfo()がnullでない場合は、1と2の両方を戻り値のSetに含む。

※本メソッド拡張時の注意点： 本メソッドから返却されるSetはnot nullであること。

パラメータ:

request - HTTPリクエスト

戻り値:

アクセス制御用のパスのSet (not null)