HarGeneratorPlugin

インターセプトされた要求と応答から HTTP アーカイブ (HAR) ファイルを生成します。

構成の例

{
  "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/rc.schema.json",
  "plugins": [
    {
      "name": "HarGeneratorPlugin",
      "enabled": true,
      "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
      "configSection": "harGeneratorPlugin"
    }
  ],
  "harGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v4.0.0/hargeneratorplugin.schema.json",
    "includeSensitiveInformation": false,
    "includeResponse": true
  }
}

構成プロパティ

プロパティ Description 既定値
includeSensitiveInformation 生成された HAR ファイルに機密情報 (承認ヘッダー、Cookie など) を含めるかどうかを決定します。 falseに設定すると、機密性の高いヘッダー、Cookie、機密性の高いクエリ パラメーターの値が値で編集されますREDACTED false
includeResponse 生成された HAR ファイルに応答本文の内容を含めるかどうかを決定します false

コマンドライン オプション

None

注釈

HAR (HTTP アーカイブ) 形式は、HTTP トランザクションをログに記録するための JSON ベースの形式です。 さまざまなツールで広くサポートされ、次の用途に使用されています。

  • ネットワーク トラフィックとパフォーマンスを分析する
  • API の対話をデバッグする
  • HTTP セッション データを共有する
  • ブラウザー開発者ツールとその他の分析ツールにインポートする

includeSensitiveInformationがfalseに設定されている場合、プラグインは次の機密性の高いヘッダーを自動的に編集します。

  • authorization
  • cookie
  • from
  • proxy-authenticate
  • proxy-authorization
  • set-cookie
  • www-authenticate
  • x-api-key
  • x-auth-token
  • x-csrf-token
  • x-forwarded-for
  • x-real-ip
  • x-session-token
  • x-xsrf-token

また、このプラグインは、すべての要求および応答 Cookie (request.cookies および response.cookies) の値を cookie 名を保持しながら、 REDACTEDに置き換えます。

さらに、プラグインは、要求 URL (request.url) とクエリ文字列 (request.queryString) の両方で、次の機密性の高いクエリ パラメーター (大文字と小文字を区別しない) の値を編集します。 その他のクエリ パラメーターは、元の値を保持します。

  • access_token
  • api_key
  • api-key
  • apikey
  • auth
  • client_secret
  • code
  • id_token
  • key
  • password
  • refresh_token
  • secret
  • sig
  • signature
  • token
  • x-amz-credential
  • x-amz-security-token
  • x-amz-signature
  • x-goog-credential
  • x-goog-signature

たとえば、要求 URL https://api.contoso.com/users?access_token=abc123&page=2 は https://api.contoso.com/users?access_token=REDACTED&page=2として記録されます。

生成された HAR ファイルには、次のものが含まれます。

  • HTTP 要求の詳細 (メソッド、URL、ヘッダー、クエリ パラメーター、Cookie)
  • HTTP 応答の詳細 (状態、ヘッダー、Cookie)
  • 要求本文と応答本文データ (該当する場合)
  • コンテンツの種類とサイズ
  • HTTP バージョン情報

プラグインは、記録が停止した後、現在のディレクトリに devproxy-{timestamp}.har という名前の HAR ファイルを作成します。

参照

  • 最終更新: