代理服务器 API 命令

代理服务器启动后，您可以启动代理实例，并将流量发送到应用程序。
如果站点是安全的 (HTTPS)，通过执行以下操作之一来避免 SSL 警告：
  • 下载证书并将其安装在浏览器上。
  • 使用 CLI 选项 -importRootCertificate 安装自己的根证书
  • 执行 StartProxy 命令时，使用 proxyCertificate 参数提供服务器证书。
共有四个命令，如下所述。
注： 支持 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 地址。（缺省值为 localhost）

    port = 代理服务器侦听的端口

    recordingPort = 记录代理侦听端口（如果设置为“0”，则选择随机端口，并在 HTTP 响应中返回端口号）

可选参数 类型 描述
chainedProxy 字符串 使用格式 [ip]:[port] 配置上游（链接）代理。这将覆盖链接代理规则文件 (proxy.chain)。
proxyCertificate 证书 证书必须是具有两个字段的 JSON 对象：“内容”，带有证书文件的 base64 编码的内容；“密码”，带有文件的密码。
clientCertificate 证书 证书必须是具有两个字段的 JSON 对象：“内容”，带有证书文件的 base64 编码的内容；“密码”，带有文件的密码。
encrypted 布尔值 加密所有流量。示例：

/StartProxy /<recordingPort>?encrypted=true

"StopProxy"

停止在指定端口上侦听的代理。
  • URL：http://[server]:[port]/automation/StopProxy/<recordingPort>
  • 请求类型：GET
提示： 将端口设置为“0”不会停止所有打开的代理服务器。使用 "StopAllProxies" 执行此项操作。

"StopAllProxies"

此命令将停止所有端口上的所有记录代理，包括其他用户启动的记录代理。
  • URL：http://[server]:[port]/automation/StopAllProxies
  • 请求类型：发布

"EncryptDastConfig"

上载 DAST.CONFIG 文件以供加密。
  • URL：http://[server]:[port]/automation/EncryptDastConfig
  • 请求类型：发布
    dastFile = 要加密的 DAST.CONFIG 文件。此请求的预期内容类型为多部分/形式数据。此请求应包含名为“dastFile”的单个文件参数。示例： 
    Content-Type: multipart/form-data; Content-Disposition: form-data; name="<dast.config>"

    在响应中返回唯一的标识，您可以使用它来下载加密后的文件

"DownloadEncryptedDast"

下载加密后的 DAST.CONFIG 文件（使用 EncryptDastConfig API 上载）。
注： 下载文件后，将从代理服务器中删除已加密和未加密的 DAST.CONFIG 文件。
  • URL：http://[server]:[port]/automation/DownloadEncryptedDastConfig/<uuid>
  • 请求类型：GET

    uuid = 在 EncryptDastConfig API 响应中接收的唯一的标识

"Traffic"

从端口标识为 DAST.CONFIG 文件的代理下载记录的数据。
  • URL：http://[server]:[port]/automation/Traffic/<recordingPort>
  • 请求类型：GET

    port = 代理服务器侦听的端口

    recordingPort = 记录代理侦听端口

"Certificate"

下载由代理服务器使用的自签名根证书认证中心作为 PEM 文件。
  • URL：http://[server]:[port]/automation/Certificate
  • 请求类型：GET
  • server = 安装了代理服务器的计算机的 IP 地址。（缺省值为 localhost）
  • port = 代理服务器侦听的端口