AppScan 資料流量記錄器
AppScan 資料流量記錄器可讓您記錄安全掃描的資料流量
版本:1.0
存取
[ Jump to Models ] 目錄
Up get /automation/Certificate
(getcertificate)
將記錄 Proxy 所使用的自簽「主要憑證管理中心」下載為 PEM 檔案。
產生
此 API 呼叫會根據 要求標頭,產生下列媒體類型;媒體類型將由 回應標頭傳送。
回應
2xx
傳回 PEM 格式的憑證檔案
預設值
內部伺服器錯誤
#/components/schemas/Error
Up get /automation/DownloadEncryptedDastConfig/{uuid}
(getdownloadencrypteddastconfig)
下載加密的 .DAST.CONFIG 檔案(已使用 EncryptDastConfig API 上傳)。附註:下載檔案時,會從「資料流量記錄器」中刪除經過加密和未加密的 DAST.CONFIG 檔案。
路徑參數
uuid(必要)
路徑參數 — 在 EncryptDastConfig API 回應中接收到的唯一 ID
產生
此 API 呼叫會根據 要求標頭,產生下列媒體類型;媒體類型將由 回應標頭傳送。
回應
2xx
傳回加密的 .dast.config 檔案
預設值
內部伺服器錯誤
#/components/schemas/Error
Up post /automation/EncryptDastConfig
(postencryptdastconfig)
上傳 DAST.CONFIG 檔案以進行加密。回應中會傳回 uuid,您可以藉此透過 /DownloadEncryptedDastConfig/<uuid> GET Rest API 來下載加密的檔案。
表單參數
dastFile(必要)
表單參數 — 要加密的 .DAST.CONFIG 檔案。要求的預期內容-類型是多組件/表單資料。要求應該包含名為「dastFile」的單一檔案參數。範例:Content-Type:multipart/form-data; Content-Disposition: form-data; name="dastFile"; filename="<dast.config>"
傳回類型
#/components/schemas/EncryptTrafficSuccessResponse
範例資料
Content-Type:application/json
""
產生
此 API 呼叫會根據 要求標頭,產生下列媒體類型;媒體類型將由 回應標頭傳送。
回應
2xx
Success-Response
#/components/schemas/EncryptTrafficSuccessResponse 400
Error-Response
#/components/schemas/EncryptTrafficErrorResponse 預設值
內部伺服器錯誤
#/components/schemas/Error
Up get /automation/StartProxy/{recordingPort},{upperBound}
(getstartproxy)
啟動在指定埠上接聽的 Proxy。如果 recordingPort = "0" 將選擇隨機埠,如果設定了 upperBound,則會使用從 recordingPort 到 upperBound 範圍內的埠。回應中會傳回埠號。如果設定了 upperBound,則 recordingPort 不應為 0。若要使用 chainedProxy、proxyCertificate 及/或 clientCertificate,請使用 POST 版本的 StartProxy。
路徑參數
recordingPort(必要)
路徑參數 — 記錄 Proxy 接聽埠
upperBound(必要)
路徑參數 — 記錄 Proxy 接聽埠的上限
查詢參數
已加密(選用)
查詢參數 — 加密資料流量。查詢參數範例:/StartProxy/<recordingPort>,<upperBound>?encrypted=true
傳回類型
#/components/schemas/StartProxySuccessResponse
範例資料
Content-Type:application/json
""
產生
此 API 呼叫會根據 要求標頭,產生下列媒體類型;媒體類型將由 回應標頭傳送。
回應
2xx
Success-Response
#/components/schemas/StartProxySuccessResponse 403
Error-Response
#/components/schemas/StartProxyErrorResponse 預設值
內部伺服器錯誤
#/components/schemas/Error
Up post /automation/StartProxy/{recordingPort},{upperBound}
(poststartproxy)
啟動在指定埠上接聽的 Proxy。如果 recordingPort = "0" 將選擇隨機埠,如果設定了 upperBound,則會使用從 recordingPort 到 upperBound 範圍內的埠。回應中會傳回埠號。如果設定了 upperBound,則 recordingPort 不應為 0。要求內文必須是 JSON 格式。
路徑參數
recordingPort(必要)
路徑參數 — 記錄 Proxy 接聽埠
upperBound(必要)
路徑參數 — 記錄 Proxy 接聽埠的上限
要求內文
查詢參數
已加密(選用)
查詢參數 — 加密資料流量。查詢參數範例:/StartProxy/<recordingPort>,<upperBound>?encrypted=true
傳回類型
#/components/schemas/StartProxySuccessResponse
範例資料
Content-Type:application/json
""
產生
此 API 呼叫會根據 要求標頭,產生下列媒體類型;媒體類型將由 回應標頭傳送。
回應
2xx
Success-Response
#/components/schemas/StartProxySuccessResponse 403
Error-Response
#/components/schemas/StartProxyErrorResponse 預設值
內部伺服器錯誤
#/components/schemas/Error
Up post /automation/StopAllProxies
(poststopallproxies)
停止所有執行中的記錄 Proxy。這個指令會停止所有埠上的所有記錄 Proxy,包含其他使用者所啟動的記錄 Proxy。嘗試在執行這個指令之後停止特定 recording Proxy 會造成異常狀況,因此使用時請小心謹慎。
傳回類型
#/components/schemas/StopAllProxiesSuccessResponse
範例資料
Content-Type:application/json
""
產生
此 API 呼叫會根據 要求標頭,產生下列媒體類型;媒體類型將由 回應標頭傳送。
回應
2xx
Success-Response
#/components/schemas/StopAllProxiesSuccessResponse 預設值
內部伺服器錯誤
#/components/schemas/Error
Up get /automation/Traffic/{recordingPort}
(gettraffic)
將來自依 recordingPort 所識別之記錄 Proxy 中的已記錄資料下載為 .DAST.CONFIG 檔案。
路徑參數
recordingPort(必要)
路徑參數 — 記錄 Proxy 接聽埠
產生
此 API 呼叫會根據 要求標頭,產生下列媒體類型;媒體類型將由 回應標頭傳送。
回應
2xx
傳回 .dast.config 檔案
預設值
內部伺服器錯誤
#/components/schemas/Error
[ Jump to Methods ] 目錄
選用
-
automationStartProxyrecordingPortupperBound_clientCertificate
-
automationStartProxyrecordingPortupperBound_proxyCertificate
-
chainedProxy(選用)
字串 使用以下格式配置上游(已鏈結) Proxy:[ip]:[port]。這會置換已鏈結的 Proxy 規則檔案 (proxy.chain)。
範例: 1.2.3.4:8080
proxyCertificate(選用)
clientCertificate(選用)
配置 Proxy 要使用的用戶端憑證。憑證必須包含私密金鑰及其 X509 憑證。憑證必須是 JSON 物件,具有兩個欄位:"content" 具有 base64 編碼的憑證檔案內容,"password" 具有檔案的密碼。
內容(選用)
範例: MIISLAIBAzCCEfMGC... ...viIECGajitRJIOdWAgEB
密碼(選用)
範例: 密碼
配置 Proxy 的固定憑證,而不是為每一個網域建立不同的憑證。憑證必須包含私密金鑰及其 X509 憑證。憑證必須是 JSON 物件,具有兩個欄位:"content" 具有 base64 編碼的憑證檔案內容,"password" 具有檔案的密碼。
內容(選用)
範例: MIIQ2gIBAzCCEKAGC... ...CD4pScngW2pdAgIIAA==
密碼(選用)
範例: 密碼