ehco

ehco is a network relay tool and a typo :)

安装

go get

go get -u "github.com/Ehco1996/ehco/cmd/ehco"

从release下载编译好的文件

ehco 的可执行文件可以从项目的release页面下载

docker image

docker pull ehco1996/ehco

主要功能

tcp/udp relay
tcp relay over wss
从配置文件启动支持多端口转发
从远程启动
benchmark
grafana 监控报警
热重载配置
内嵌了完整版本的 xray 后端

中转使用说明

使用隧道需要至少两台主机, 并且在两台主机上都安装了ehco

中转机器 A 假设机器A的IP是 1.1.1.1
落地机器 B 假设机器B的IP是 2.2.2.2 并且落地机器B的5555端口跑着一个SS/v2ray/任意tcp/udp服务

案例一不用隧道直接通过中转机器中转用户流量

直接在中转机器A上输入: ehco -l 0.0.0.0:1234 -r 2.2.2.2:5555

该命令表示将所有从中转机器A的1234端口进入的流量直接转发到落地机器B的5555端口

用户即可通过中转机器A的1234端口访问到落地机器B的5555端口的SS/v2ray服务了

案例二用mwss隧道中转用户流量

在落地机器B上输入: ehco -l 0.0.0.0:443 -lt mwss -r 127.0.0.1:5555

该命令表示将所有从落地机器B的443端口进入的wss流量解密后转发到落地机器B的5555端口

在中转机器A上输入: ehco -l 0.0.0.0:1234 -r wss://2.2.2.2:443 -tt mwss

该命令表示将所有从A的1234端口进入的流量通过wss加密后转发到落地机器B的443端口

用户即可通过中转机器A的1234端口访问到落地机器B的5555端口的SS/v2ray服务了

Xray 功能使用说明

内置 xray 后端

从 v1.1.2 开始，ehco 内置了完整版本的 xray 后端，可以通过标准的 xray 配置文件来启动内置的 xray server, 配置的 key 为 xray_config：

单端口多用户的 ss xray_ss.json
单端口多用户的 trojan xray_trojan.json

用户流量同步

从 v1.1.2 开始，ehco 支持通过 api 下方用户配置和上报用户流量，配置的 key 为 sync_traffic_endpoint：

ehco 会每隔 60s 发送一次 GET 请求，从 sync_traffic_endpoint 同步一次用户配置，到 xray server 里，期望的 API 返回格式如下：

{
    "users": [
        {
            "user_id": 1,
            "method": "user1",
            "password": 1024,
            "level": 1024,
            "upload_traffic": 1024,
            "download_traffic": 1024,
            "protocol": "trojan/ss"
        },
        {
            "user_id": 2,
            "method": "user1",
            "password": 1024,
            "level": 1024,
            "upload_traffic": 1024,
            "download_traffic": 1024,
            "protocol": "trojan/ss"
        },
    ]
}

ehco 会每隔 60s 发送一次 POST 请求至 sync_traffic_endpoint ，上报当前 xray server 所有用户的流量使用情况，发送的请求格式如下：

{
    "data": [
        {
            "user_id": 1,
            "upload_traffic": 1024,
            "download_traffic": 1024,
        },
        {
            "user_id": 2,
            "upload_traffic": 1024,
            "download_traffic": 1024,
        },
    ]
}

需要注意的是，如果想使用此功能，对 xray 的完整配置文件有如下限制

的配置文件必须包开启 stats 和 api 功能
ss inbound 的 tag 必须为 ss_proxy
trojan inbound 的 tag 必须为 trojan_proxy

一个完整的例子可以参考 xray_ss.json 和 xray_trojan.json

配置文件

ehco支持从 配置文件 / http接口 里读取 json 格式的配置并启动

配置文件格式要求如下(更多例子可以参考项目里的 config.json 文件):

{
    "web_port": 9000,
    "web_token": "",
    "enable_ping": false,
    "relay_configs": [
        {
            "listen": "127.0.0.1:1234",
            "listen_type": "raw",
            "transport_type": "raw",
            "tcp_remotes": [
                "0.0.0.0:5201"
            ],
            "udp_remotes": [
                "0.0.0.0:5201"
            ]
        },
    ]
}

热重载配置

大于 1.1.0 版本的 ehco 支持热重载配置

# 使用配置文件启动 ehco
ehco  -c config.json

# 更新配置文件后可以使用 kill -HUP pid 命令来重新加载配置
kill -HUP pid

# 重载成功可以看到如下信息
[cfg-reload] Got A HUP Signal! Now Reloading Conf ...
Load Config From File:config.json
[cfg-reload] starr new relay name=[At=127.0.0.1:12342 Over=raw TCP-To=[0.0.0.0:5201] UDP-To=[0.0.0.0:5201] Through=raw]
[relay] Close relay [At=127.0.0.1:1234 Over=raw TCP-To=[0.0.0.0:5201] UDP-To=[0.0.0.0:5201] Through=raw]
[relay] Start UDP relay [At=127.0.0.1:12342 Over=raw TCP-To=[0.0.0.0:5201] UDP-To=[0.0.0.0:5201] Through=raw]
[relay] Start TCP relay [At=127.0.0.1:12342 Over=raw TCP-To=[0.0.0.0:5201] UDP-To=[0.0.0.0:5201] Through=raw]

监控报警

dashboard 和 prometheus 规则可以从monitor文件夹下找到，可以自行导入
类似 Smokeing Ping 的延迟监控

流量监控

Benchmark(Apple m1)

iperf:

# run iperf server on 5201
iperf3 -s

# 直接转发
# run relay server listen 1234 to 9001 (raw)
go run cmd/ehco/main.go -l 0.0.0.0:1234 -r 0.0.0.0:5201

# 直接转发END

# 通过ws隧道转发
# listen 1235 relay over ws to 1236
go run cmd/ehco/main.go -l 0.0.0.0:1235  -r ws://0.0.0.0:1236 -tt ws

# listen 1236 through ws relay to 5201
go run cmd/ehco/main.go -l 0.0.0.0:1236 -lt ws -r 0.0.0.0:5201
# 通过ws隧道转发END

# 通过wss隧道转发
# listen 1234 relay over wss to 1236
go run cmd/ehco/main.go -l 0.0.0.0:1235  -r wss://0.0.0.0:1236 -tt wss

# listen 1236 through wss relay to 5201
go run cmd/ehco/main.go -l 0.0.0.0:1236 -lt wss -r 0.0.0.0:5201
# 通过wss隧道转发END

# 通过mwss隧道转发 和wss相比 速度会慢，但是能减少延迟
# listen 1237 relay over mwss to 1238
go run cmd/ehco/main.go -l 0.0.0.0:1237  -r wss://0.0.0.0:1238 -tt mwss

# listen 1238 through mwss relay to 5201
go run cmd/ehco/main.go -l 0.0.0.0:1238 -lt mwss -r 0.0.0.0:5201
# 通过mwss隧道转发END

# run through file
go run cmd/ehco/main.go -c config.json

# benchmark tcp
iperf3 -c 0.0.0.0 -p 1234

# benchmark tcp through wss
iperf3 -c 0.0.0.0 -p 1235

# benchmark upd
iperf3 -c 0.0.0.0 -p 1234 -u -b 1G --length 1024

iperf	raw	relay(raw)	relay(ws)	relay(wss)	relay(mwss)	relay(mtcp)
tcp	123 Gbits/sec	55 Gbits/sec	41 Gbits/sec	10 Gbits/sec	5.78 Gbits/sec	22.2 Gbits/sec
udp	14.5 Gbits/sec	3.3 Gbits/sec	直接转发	直接转发	直接转发	直接转发

dumpmemory/ehco