Web API Makerセキュアトークンフィルタ設定¶
概要¶
Web API Makerのセキュアトークンフィルタに関する設定です。
モジュール Web API Maker フォーマットファイル(xsd) WEB-INF/schema/web-api-maker-secure-token-filtering-config.xsd 設定場所 WEB-INF/conf/web-api-maker-secure-token-filtering-config/{任意のファイル名}.xml <?xml version="1.0" encoding="UTF-8"?> <web-api-maker-secure-token-filtering-config xmlns="http://www.intra-mart.jp/web-api-maker/secure-token-filtering-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.intra-mart.jp/web-api-maker/secure-token-filtering-config ../../schema/web-api-maker-secure-token-filtering-config.xsd"> <disable-token-filter> <entry path="/sample/pet-shop/pets" > <method>GET</method> <method>POST</method> </entry> <entry path="/sample/pet-shop/pet/{id}" /> <entry enable-regexp="true" path="/sample/pet-shop/.*" /> </disable-token-filter> </web-api-maker-secure-token-filtering-config>
リファレンス¶
セキュアトークンフィルタ無効化設定¶
タグ名 disable-token-filter セキュアトークンフィルタを無効化するパスを設定します。【設定項目】
<web-api-maker-secure-token-filtering-config> <disable-token-filter> ... </disable-token-filter> </web-api-maker-secure-token-filtering-config>
必須項目 × 複数設定 × 設定値・設定する内容
entry セキュアトークンチェックを無効化するパスを設定します。 単位・型 なし 省略時のデフォルト値 なし 親タグ web-api-maker-secure-token-filtering-config コラム
- 利用用途について
Securedアノテーションが適用されるパスに対して、セキュアトークンのチェックを無効化したい場合に利用できます。公開済みのWeb APIに対して後からセキュアトークンチェックを追加すると、Web APIを利用している側でリクエストヘッダを追加するという対応が必要になり、Web APIの互換性を担保できません。ここで設定したパスに対して、セキュアトークンチェックが行われなくなるため、設定次第で互換性を担保できます。注意
この設定は、本来セキュアトークンチェックが必要なWeb APIに対して、セキュアトークンチェックを行わなくするためのものです。セキュリティ上の観点から、必要な場合にのみ設定していただくことを推奨します。
セキュアトークンチェック無効化対象パス設定¶
タグ名 entry セキュアトークンチェックを無効化するパスを設定します。【設定項目】
<disable-token-filter> <entry enable-regexp="true" path="/sample/pet-shop/.*"> ... </entry> </disable-token-filter>
必須項目 × 複数設定 ○ 設定値・設定する内容
method セキュアトークンチェックを無効化するHTTPメソッドを設定します。 単位・型 なし 省略時のデフォルト値 なし 親タグ disable-token-filter 【属性】
属性名 説明 必須 デフォルト値 enable-regexp パスを正規表現で指定するかどうかを、trueまたはfalseで設定します。 × false path セキュアトークンチェックを無効化するパスを設定します。 ○ なし
セキュアトークンチェック無効化対象メソッド¶
タグ名 method セキュアトークンチェックを無効化するHTTPメソッドを設定します。【設定項目】
<entry enable-regexp="true" path="/sample/pet-shop/.*"> <method>GET</method> <method>PUT</method> <method>POST</method> <method>DELETE</method> </entry>
必須項目 × 複数設定 ○ 設定値・設定する内容 セキュアトークンチェックを無効化するHTTPメソッドを指定します。GET, PUT, POST, DELETEのいずれかを指定してください。単位・型 なし 省略時のデフォルト値 すべてのメソッドを指定したものとして動作します。 親タグ entry