AppScan トラフィック・レコーダー
AppScan トラフィック・レコーダーを使用すると、セキュリティー・スキャンのトラフィックを記録できます。
バージョン: 1.0
アクセス
[ モデルにジャンプ ]目次
上へ get /automation/Certificate
(getcertificate)
自己署名ルート認証局をダウンロードします。これは、記録プロキシーで PEM ファイルとして使用されます。
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
証明書ファイルを PEM 形式で返します
デフォルト
内部サーバー・エラー
#/components/schemas/Error
上へ get /automation/DownloadEncryptedDastConfig/{uuid}
(getdownloadencrypteddastconfig)
暗号化された .DAST.CONFIG ファイル (EncryptDastConfig API を使用してアップロードされたファイル) をダウンロードします。注: ファイルがダウンロードされたら、暗号化された DAST.CONFIG ファイルと暗号化されていない DAST.CONFIG ファイルの両方がトラフィック・レコーダーから削除されます。
パス・パラメーター
uuid (必須)
パス・パラメーター: EncryptDastConfig API 応答で受信した一意の ID
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
暗号化された .dast.config ファイルを返します
デフォルト
内部サーバー・エラー
#/components/schemas/Error
上へ post /automation/EncryptDastConfig
(postencryptdastconfig)
DAST.CONFIG ファイルをアップロードして暗号化します。応答で uuid が返されるため、その uuid を /DownloadEncryptedDastConfig/<uuid> GET Rest API で使用して、暗号化されたファイルをダウンロードできます。
フォーム・パラメーター
dastFile (必須)
フォーム・パラメーター: 暗号化される .DAST.CONFIG ファイルです。要求に必要な Content-Type は multipart/form-data です。要求には、「dastFile"」という単一のファイル・パラメーターを含める必要があります。例: Content-Type: multipart/form-data; Content-Disposition: form-data; name="dastFile"; filename="<dast.config>"
戻り値の型
#/components/schemas/EncryptTrafficSuccessResponse
データの例
Content-Type: application/json
""
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
成功応答
#/components/schemas/EncryptTrafficSuccessResponse 400
エラー応答
#/components/schemas/EncryptTrafficErrorResponse デフォルト
内部サーバー・エラー
#/components/schemas/Error
(getinfo)
AppScan トラフィック・レコーダーのバージョンに関する戻り情報
戻り値の型
#/components/schemas/InfoResponse200
データの例
Content-Type: application/json
""
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
AppScan トラフィック・レコーダーのコンポーネント・バージョンとともに JSON を返します
#/components/schemas/InfoResponse200 デフォルト
内部サーバー・エラー
#/components/schemas/Error
上へ get /automation/StartProxy/{recordingPort},{upperBound}
(getstartproxy)
指定された recordingPort で listen するプロキシーを開始します。recordingPort =「0」の場合、ランダム・ポートが選択されます。upperBound が設定されている場合、recordingPort から upperBound までの範囲のポートが使用されます。ポート番号が応答で返されます。upperBound が設定されている場合、recordingPort は 0 にできません。chainedProxy、proxyCertificate、および/または clientCertificate を使用するには、POST バージョンの StartProxy を使用します。
パス・パラメーター
recordingPort (必須)
パス・パラメーター: listen しているプロキシーを記録するポート
upperBound (必須)
パス・パラメーター: listen しているプロキシーを記録するポートの上限境界
照会パラメーター
暗号化 (オプション)
照会パラメーター: トラフィックを暗号化します。照会パラメーターの例: /StartProxy/<recordingPort>,<upperBound>?encrypted=true
戻り値の型
#/components/schemas/StartProxySuccessResponse
データの例
Content-Type: application/json
""
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
成功応答
#/components/schemas/StartProxySuccessResponse 403
エラー応答
#/components/schemas/StartProxyErrorResponse デフォルト
内部サーバー・エラー
#/components/schemas/Error
上へ post /automation/StartProxy/{recordingPort},{upperBound}
(poststartproxy)
指定された recordingPort で listen するプロキシーを開始します。recordingPort =「0」の場合、ランダム・ポートが選択されます。upperBound が設定されている場合、recordingPort から upperBound までの範囲のポートが使用されます。ポート番号が応答で返されます。upperBound が設定されている場合、recordingPort は 0 にできません。要求本体は JSON 形式でなければなりません。
パス・パラメーター
recordingPort (必須)
パス・パラメーター: listen しているプロキシーを記録するポート
upperBound (必須)
パス・パラメーター: listen しているプロキシーを記録するポートの上限境界
要求本文
照会パラメーター
暗号化 (オプション)
照会パラメーター: トラフィックを暗号化します。照会パラメーターの例: /StartProxy/<recordingPort>,<upperBound>?encrypted=true
戻り値の型
#/components/schemas/StartProxySuccessResponse
データの例
Content-Type: application/json
""
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
成功応答
#/components/schemas/StartProxySuccessResponse 403
エラー応答
#/components/schemas/StartProxyErrorResponse デフォルト
内部サーバー・エラー
#/components/schemas/Error
上へ get /automation/StopProxy/{recordingPort}
(getstopproxy)
指定された recordingPort ポートで listen している記録プロキシーを停止します。recordingPort を「0」に設定しても、開かれているすべてのプロキシーが停止するわけではありません。これを行うには、「StopAllProxies」を使用します。
パス・パラメーター
recordingPort (必須)
パス・パラメーター: listen しているプロキシーを記録するポート
戻り値の型
#/components/schemas/StopProxySuccessResponse
データの例
Content-Type: application/json
""
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
成功応答
#/components/schemas/StopProxySuccessResponse 403
エラー応答
#/components/schemas/StopProxyErrorResponse デフォルト
内部サーバー・エラー
#/components/schemas/Error
上へ post /automation/StopAllProxies
(poststopallproxies)
実行中のすべての記録プロキシーを停止します。このコマンドは、他のユーザーが開始したものを含め、すべてのポート上のすべての記録プロキシーを停止します。このコマンドの実行後に特定の記録プロキシーを停止しようとすると、例外が発生するため、注意して使用してください。
戻り値の型
#/components/schemas/StopAllProxiesSuccessResponse
データの例
Content-Type: application/json
""
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
成功応答
#/components/schemas/StopAllProxiesSuccessResponse デフォルト
内部サーバー・エラー
#/components/schemas/Error
上へ get /automation/Traffic/{recordingPort}
(gettraffic)
recordingPort で特定された記録プロキシーから、記録されたデータを .DAST.CONFIG ファイルとしてダウンロードします。
パス・パラメーター
recordingPort (必須)
パス・パラメーター: listen しているプロキシーを記録するポート
生成
この API 呼び出しは、 要求ヘッダーに従って以下のメディア・タイプを生成します。メディア・タイプは 応答ヘッダーによって伝達されます。
回答
2xx
.dast.config ファイルを返します
デフォルト
内部サーバー・エラー
#/components/schemas/Error
[ メソッドへジャンプ ] 目次
オプション - automationStartProxyrecordingPortupperBound_clientCertificate - automationStartProxyrecordingPortupperBound_proxyCertificate -
chainedProxy (オプション)
ストリング 形式 [ip]:[port] を使用し、アップストリーム (チェーン) プロキシーを構成します。これは、チェーン・プロキシー・ルール・ファイル (proxy.chain) を上書きします。
例: 1.2.3.4:8080
proxyCertificate (オプション)
clientCertificate (オプション)
プロキシーで使用されるクライアント側の証明書を構成します。証明書には、X509 証明書を備えた秘密鍵が含まれている必要があります。この証明書は、次の 2 つのフィールドが含まれる JSON オブジェクトでなければなりません。証明書ファイルを base64 でエンコードしたコンテンツが入った「コンテンツ」フィールドと、証明書ファイルのパスワードが入った「パスワード」
content (オプション)
例: MIISLAIBAzCCEfMGC... ...viIECGajitRJIOdWAgEB
password (オプション)
例: password
ドメインごとに異なる証明書を作成する代わりに、プロキシーの固定証明書を構成します。証明書には、X509 証明書を備えた秘密鍵が含まれている必要があります。この証明書は、次の 2 つのフィールドが含まれる JSON オブジェクトでなければなりません。証明書ファイルを base64 でエンコードしたコンテンツが入った「コンテンツ」フィールドと、証明書ファイルのパスワードが入った「パスワード」
content (オプション)
例: MIIQ2gIBAzCCEKAGC... ...CD4pScngW2pdAgIIAA==
password (オプション)
例: password