AppScan 流量记录器

AppScan 流量记录器可用于记录安全扫描的流量
版本:1.0

访问权限

方法

[ 跳转至模型 ]

目录

证书

加密

信息

StartProxy

StopProxy

流量

证书

向上
get /automation/Certificate
(getcertificate)
下载由记录代理使用的自签名根证书认证中心作为 PEM 文件。

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

返回 PEM 格式的证书文件

缺省值

Internal Server Error #/components/schemas/Error

加密

向上
get /automation/DownloadEncryptedDastConfig/{uuid}
(getdownloadencrypteddastconfig)
下载已使用 EncryptDastConfig API 上载的加密 .DAST.CONFIG 文件。注:下载文件后,将从流量记录器中删除已加密和未加密的 DAST.CONFIG 文件。

路径参数

uuid(必需)
路径参数 — 在 EncryptDastConfig API 响应中接收的唯一的标识

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

返回加密的 .dast.config 文件

缺省值

Internal Server Error #/components/schemas/Error

向上
post /automation/EncryptDastConfig
(postencryptdastconfig)
上载 .DAST.CONFIG 文件以供加密。响应中将返回一个 UUID,您可以使用此 UUID 通过 /DownloadEncryptedDastConfig/<uuid> GET Rest API 下载加密后的文件。

表单参数

dastFile(必需)
表单参数 — 要加密的 .DAST.CONFIG 文件。此请求的预期内容类型为多部分/形式数据。此请求应包含名为“dastFile”的单个文件参数。示例:内容类型:multipart/form-data; Content-Disposition: form-data; name="dastFile"; filename="<dast.config>"

返回类型

#/components/schemas/EncryptTrafficSuccessResponse

示例数据

内容类型:application/json
“”

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

Success-Response #/components/schemas/EncryptTrafficSuccessResponse

400

Error-Response #/components/schemas/EncryptTrafficErrorResponse

缺省值

Internal Server Error #/components/schemas/Error

信息

向上
get /automation/Info
(getinfo)
返回有关 AppScan 流量记录器版本的信息

返回类型

#/components/schemas/InfoResponse200

示例数据

内容类型:application/json
“”

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

返回包含 AppScan 流量记录器组件版本的 JSON #/components/schemas/InfoResponse200

缺省值

Internal Server Error #/components/schemas/Error

StartProxy

向上
get /automation/StartProxy/{recordingPort},{upperBound}
(getstartproxy)
启动在指定 recordingPort 上进行侦听的代理。如果 recordingPort = “0”,将选择一个随机端口;如果设置了 upperBound,则使用从 recordingPort 到 upperBound 范围内的端口。响应中将返回端口号。如果设置了 upperBound,recordingPort 不得为 0。要使用 chainedProxy、proxyCertificate 和/或 clientCertificate,请使用 POST 版本的 StartProxy。

路径参数

recordingPort(必需)
路径参数 — 侦听端口的记录代理
upperBound(必需)
路径参数 — 侦听端口的记录代理的上限

查询参数

encrypted(可选)
查询参数 — 对流量加密。查询参数示例:/StartProxy/<recordingPort>,<upperBound>?encrypted=true

返回类型

#/components/schemas/StartProxySuccessResponse

示例数据

内容类型:application/json
“”

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

Success-Response #/components/schemas/StartProxySuccessResponse

403

Error-Response #/components/schemas/StartProxyErrorResponse

缺省值

Internal Server Error #/components/schemas/Error

向上
post /automation/StartProxy/{recordingPort},{upperBound}
(poststartproxy)
启动在指定 recordingPort 上进行侦听的代理。如果 recordingPort = “0”,将选择一个随机端口;如果设置了 upperBound,则使用从 recordingPort 到 upperBound 范围内的端口。响应中将返回端口号。如果设置了 upperBound,recordingPort 不得为 0。请求主体必须采用 JSON 格式。

路径参数

recordingPort(必需)
路径参数 — 侦听端口的记录代理
upperBound(必需)
路径参数 — 侦听端口的记录代理的上限

请求主体

可选可选(可选)
主体参数

查询参数

encrypted(可选)
查询参数 — 对流量加密。查询参数示例:/StartProxy/<recordingPort>,<upperBound>?encrypted=true

返回类型

#/components/schemas/StartProxySuccessResponse

示例数据

内容类型:application/json
“”

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

Success-Response #/components/schemas/StartProxySuccessResponse

403

Error-Response #/components/schemas/StartProxyErrorResponse

缺省值

Internal Server Error #/components/schemas/Error

StopProxy

向上
get /automation/StopProxy/{recordingPort}
(getstopproxy)
停止正在指定 recordingPort 上进行侦听的记录代理。将 recordingPort 设置为“0”不会停止所有打开的代理。请使用“StopAllProxies”执行此操作。

路径参数

recordingPort(必需)
路径参数 — 侦听端口的记录代理

返回类型

#/components/schemas/StopProxySuccessResponse

示例数据

内容类型:application/json
“”

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

Success-Response #/components/schemas/StopProxySuccessResponse

403

Error-Response #/components/schemas/StopProxyErrorResponse

缺省值

Internal Server Error #/components/schemas/Error

向上
post /automation/StopAllProxies
(poststopallproxies)
停止所有正在运行的记录代理。此命令将停止所有端口上的所有记录代理,包括其他用户启动的记录代理。在运行此命令后尝试停止特定记录代理将导致异常,因此请谨慎使用。

返回类型

#/components/schemas/StopAllProxiesSuccessResponse

示例数据

内容类型:application/json
“”

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

Success-Response #/components/schemas/StopAllProxiesSuccessResponse

缺省值

Internal Server Error #/components/schemas/Error

流量

向上
get /automation/Traffic/{recordingPort}
(gettraffic)
从以 recordingPort 标识的记录代理下载记录的数据作为 .DAST.CONFIG 文件。

路径参数

recordingPort(必需)
路径参数 — 侦听端口的记录代理

生成

此 API 调用根据 Accept 请求头生成以下媒体类型;媒体类型将由 Content-Type 响应头传达。

响应

2xx

返回 .dast.config 文件

缺省值

Internal Server Error #/components/schemas/Error

模型

[ 跳转至方法 ]

目录

  1. 可选 -
  2. automationStartProxyrecordingPortupperBound_clientCertificate -
  3. automationStartProxyrecordingPortupperBound_proxyCertificate -

可选 - 向上

chainedProxy(可选)
字符串 使用格式 [ip]:[port] 配置上游(链接)代理。这将覆盖链接代理规则文件 (proxy.chain)。
示例: 1.2.3.4:8080
proxyCertificate(可选)
clientCertificate(可选)

automationStartProxyrecordingPortupperBound_clientCertificate - 向上

配置要由代理使用的客户机端证书。证书必须包含专用密钥及其 X509 证书。证书必须是具有两个字段的 JSON 对象:“内容”,带有证书文件的 base64 编码的内容;“密码”,带有文件的密码。
content(可选)
字符串格式:base64
示例: MIISLAIBAzCCEfMGC... ...viIECGajitRJIOdWAgEB
password(可选)
示例: password

automationStartProxyrecordingPortupperBound_proxyCertificate - 向上

为代理配置固定证书,而不是为每个域创建一个不同的证书。证书必须包含专用密钥及其 X509 证书。证书必须是具有两个字段的 JSON 对象:“内容”,带有证书文件的 base64 编码的内容;“密码”,带有文件的密码。
content(可选)
字符串格式:base64
示例: MIIQ2gIBAzCCEKAGC... ...CD4pScngW2pdAgIIAA==
password(可选)
示例: password