プロキシー・サーバー API コマンド

プロキシー・サーバーを開始したら、プロキシー・インスタンスを開始して、アプリケーションにトラフィックを送信することができます。
サイトが保護されている場合 (HTTPS) は、以下のいずれかの操作を行い、SSL 警告を回避します。
  • 証明書をダウンロードしてブラウザーにインストールする。
  • CLI オプション -importRootCertificate を使用し、独自のルート証明書をインストールします。
  • StartProxy コマンドを実行する場合は、proxyCertificate パラメーターを使用してサーバー証明書を提供します。
以下で説明しているように、4 つのコマンドが存在します。
注: Node.js バージョン 12 以上がサポートされます。

資料

完全な REST API 資料を表示できます。
  • Swagger で、ブラウザー内で結合します。
    http(s)://<server>:<port>
  • ASoC 資料で、ここから表示します。

「StartProxy」

指定されたポートでリスンするプロキシーを開始します。
  • URL:http://[server]:[port]/automation/StartProxy/<recordingPort>
  • 要求タイプ:POST または GET (chainedProxy、proxyCertificate、および clientCertificate を使用している場合、要求は POST、それ以外の場合は GET)

    要求本体は JSON 形式でなければなりません

    server = プロキシー・サーバーがインストールされているマシンの IP アドレス。(デフォルトはローカル・ホスト)。

    port = プロキシー・サーバーがリスンするポート。

    recordingPort = リスンしているプロキシーを記録するポート (「0」に設定されると、ランダム・ポートが選択され、そのポート番号が HTTP 応答で返されます)。

オプション・パラメーター タイプ 説明
chainedProxy ストリング 形式 [ip]:[port] を使用し、アップストリーム (チェーン) プロキシーを設定します。これは、チェーン・プロキシー・ルール・ファイル (proxy.chain) を上書きします。
proxyCertificate 証明書 この証明書は、証明書ファイルを base64 でエンコードしたコンテンツが入った「コンテンツ」フィールドと、証明書ファイルのパスワードが入った「パスワード」フィールドの 2 つが含まれる JSON オブジェクトでなければなりません。
clientCertificate 証明書 この証明書は、証明書ファイルを base64 でエンコードしたコンテンツが入った「コンテンツ」フィールドと、証明書ファイルのパスワードが入った「パスワード」フィールドの 2 つが含まれる JSON オブジェクトでなければなりません。
暗号化 ブール値 すべてのトラフィックを暗号化します。例:

/StartProxy /<recordingPort>?encrypted=true

「StopProxy」

指定されたポートでリスンしているプロキシーを停止します。
  • URL:http://[server]:[port]/automation/StopProxy/<recordingPort>
  • 要求タイプ:GET
ヒント: ポートを「0」に設定しても、開かれているすべてのプロキシーは停止しません。これを行うには、"StopAllProxies" を使用します。

"StopAllProxies"

このコマンドは、他のユーザーが開始したものを含め、すべてのポート上のすべての記録プロキシーを停止します。
  • URL:http://[server]:[port]/automation/StopAllProxies
  • 要求タイプ:POST

"EncryptDastConfig"

DAST.CONFIG ファイルをアップロードして暗号化します。
  • URL:http://[server]:[port]/automation/EncryptDastConfig
  • 要求タイプ:POST
    dastFile = 暗号化する DAST.CONFIG ファイル。要求に必要な Content-Type は multipart/form-data です。要求には、"dastFile" という単一のファイル・パラメーターを含める必要があります。例: 
    Content-Type: multipart/form-data; Content-Disposition: form-data; name="<dast.config>"

    応答で返された一意の ID を使用して、暗号化されたファイルをダウンロードします。

"DownloadEncryptedDast"

暗号化された DAST.CONFIG ファイル (EncryptDastConfig API を使用してアップロードされた) をダウンロードします。
注: ファイルがダウンロードされたら、暗号化された DAST.CONFIG ファイルと暗号化されていない DAST.CONFIG ファイルの両方がプロキシー・サーバーから削除されます。
  • URL:http://[server]:[port]/automation/DownloadEncryptedDastConfig/<uuid>
  • 要求タイプ:GET

    uuid = EncryptDastConfig API 応答で受信した一意の ID

「Traffic」

ポートによって特定されたプロキシーから、記録されたデータを DAST.CONFIG ファイルとしてダウンロードします。
  • URL:http://[server]:[port]/automation/Traffic/<recordingPort>
  • 要求タイプ:GET

    port = プロキシー・サーバーがリスンするポート。

    recordingPort = リスンしているプロキシーを記録するポート。

「Certificate」

自己署名ルート認証局をダウンロードします。これは、プロキシー・サーバーで PEM ファイルとして使用されます。
  • URL:http://[server]:[port]/automation/Certificate
  • 要求タイプ:GET
  • server = プロキシー・サーバーがインストールされているマシンの IP アドレス。(デフォルトはローカル・ホスト)。
  • port = プロキシー・サーバーがリスンするポート。