hgap

�HGAP是一个Http反向代理，支持以文件同步、单向UDP、单向TCP作为中间的传输方式。HGAP主要用于网闸设备的Http协议穿透，或用于其它只支持单向数据传输的场景。HGAP的单个执行文件包含了隔离设备两端的服务程序。程序采用 Go 语言编写。

基本概念

• InBound入站端：是Http请求代理的入口，用于在隔离设备的一侧接收Http请求。接收到请求后，InBound将请求交给Transfer传输至Outbound端。

• OutBound出站端：用于在隔离设备的另一侧执行Http请求。请求处理完成后，OutBound将响应数据交给Transfer传输到InBound端。

• Transfer传输对象：用于在隔离设备的两侧传输数据。目前支持的传输方式有file、udp、tcp。

• Monitor数据监控对象：用于监控Transfer对象传输过来的数据帧，当请求或响应数据收集完整后，通知InBound和Outbound进行处理。

基本使用

  Usage: hgap [command]
  Commands:
    inbound - run as inbound server mode
    outbound - run as outbound server mode

配置说明

HGAP的配置文件为config.json，其格式如下：

{
    "timeout": 30000,
    "port": 9090,
    "fileCheckInterval": 20,
    "fileScanInterval": 200,
    "keepFiles": false,
    "encrpt": false,
    "inDirectory": "in/req",
    "outDirectory": "out/resp",
    "inTextTransfer": false,
    "outTextTransfer": false,
    "inTransferType": "tcp",
    "outTransferType": "tcp",
    "inMonitorHost":  "0.0.0.0",
	"inMonitorPort":  9091,
	"outMonitorHost": "0.0.0.0",
    "outMonitorPort": 9092,
    "log":{
        "level": "debug"
    },
    "urlMapping": {
        "/test": "http://localhost:3005/index.html",
        "/": "https://cn.bing.com/"
    }
}

• timeout 超时时间，InBound端的Http超时时间，OutBound端的Http请求超时时间都由timeout参数设置。

• port Http反向代理服务端口。

• fileCheckInterval 当使用file类型的Transfer时，检查单个请求或响应文件是否写入完成的时间间隔，单位为毫秒。

• fileScanInterval 当使用file类型的Transfer时，Monitor扫描文件目录的时间间隔，单位为毫秒。

• keepFiles file传输模式下，是否删除传输的文件（仅供调试）。

• encrypt 对传输的数据进行加密（未处理）。

• inDirectory file传输模式下，InBound端文件写入目录。

• outDirectory file传输模式下，OutBound端文件写入目录。

• inTextTransfer InBound端采用纯文本(Base64)方式向OutBound端发送数据。

• outTextTransfer OutBound端采用纯文本(Base64)方式向InBound端发送数据。

• inTransferType InBound端向OutBound端发送数据采用的传输方式：支持file、udp、tcp。

• outTransferType OutBound端向InBound端发送数据采用的传输方式：支持file、udp、tcp。

• inMonitorHost InBound端使用udp或tcp等网络传输方式时，InBound端的Monitor对象的监听主机。

• outMonitorHost OutBound端使用udp或tcp等网络传输方式时，OutBound端的Monitor对象的监听主机。

• inMonitorPort InBound端使用udp或tcp等网络传输方式时，InBound端的Monitor对象的监听端口。

• outMonitorHost OutBound端使用udp或tcp等网络传输方式时，OutBound端的Monitor对象的监听端口。

• urlMapping OutBound端执行请求时的URL映射规则，请求URI中匹配urlMapping左侧的内容将被替换成urlMapping中右侧的内容。

• log 日志配置

  • output 支持stdout,file的形式，表示同时输出至标准输出和文件。

  • rotate 是否启用日志文件滚动输出。

  • file 日志文件名前缀，可包含路径。

  • maxAge 日志文件保存时长，单位为分钟。

  • rotationTime 日志滚动时间间隔，单位为分钟。

  • level 日志输出级别。