From b269bb9dd867219372ef35180bcf3cc5c8a4c85c Mon Sep 17 00:00:00 2001 From: lqqyt2423 <974923609@qq.com> Date: Tue, 28 Sep 2021 15:33:03 +0800 Subject: [PATCH] english readme --- README.md | 54 ++++++++++++++++++++----------------- README_CN.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++ go.mod | 2 +- go.sum | 4 +-- 4 files changed, 108 insertions(+), 28 deletions(-) create mode 100644 README_CN.md diff --git a/README.md b/README.md index 765ad47..6455307 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,44 @@ # go-mitmproxy -[mitmproxy](https://mitmproxy.org/) implemented with golang. +[简体中文](./README_CN.md) -用 Golang 实现的中间人攻击（[Man-in-the-middle](https://en.wikipedia.org/wiki/Man-in-the-middle_attack)），解析、监测、篡改 HTTP/HTTPS 流量。 +[Mitmproxy](https://mitmproxy.org/) implemented with golang. Intercept HTTP & HTTPS requests and responses and modify them. -## 特点 +## Features -- HTTPS 证书相关逻辑参考 [mitmproxy](https://mitmproxy.org/) 且与之兼容，根证书也保存在 `~/.mitmproxy` 文件夹中，如果之前用过 `mitmproxy` 且根证书已经安装信任，则此 `go-mitmproxy` 可以直接使用 -- 支持插件机制，很方便扩展自己需要的功能，可参考 [addon/addon.go](./addon/addon.go) -- 性能优势 - - Golang 天生的性能优势 - - 在进程内存中转发解析 HTTPS 流量，不需通过 tcp端口 或 unix socket 等进程间通信 - - 生成不同域名证书时使用 LRU 缓存，避免重复计算 -- 通过环境变量 `SSLKEYLOGFILE` 支持 `Wireshark` 解析分析流量 -- 上传/下载大文件时支持流式传输 -- Web 界面 +- Intercept HTTP & HTTPS requests and responses and modify them on the fly +- SSL/TLS certificates for interception are generated on the fly +- Certificates logic compatible with [mitmproxy](https://mitmproxy.org/), saved at `~/.mitmproxy`. If you used mitmproxy before and installed certificates, then you can use this go-mitmproxy directly +- Addon mechanism, you can add your functions easily, refer to [addon/addon.go](./addon/addon.go) +- Performance advantages + - Golang's inherent performance advantages + - Forwarding and parsing HTTPS traffic in process memory without inter-process communication such as tcp port or unix socket + - Use LRU cache when generating certificates of different domain names to avoid double counting +- Support `Wireshark` to analyze traffic through the environment variable `SSLKEYLOGFILE` +- Support streaming when uploading/downloading large files +- Web interface -## 安装 +## Install ``` GO111MODULE=on go get -u github.com/lqqyt2423/go-mitmproxy/cmd/go-mitmproxy ``` -## 命令行使用 +## Usage -### 启动 +### Startup ``` go-mitmproxy ``` -启动后，HTTP 代理地址默认为 9080 端口，Web 界面默认在 9081 端口。 +After startup, the HTTP proxy address defaults to port 9080, and the web interface defaults to port 9081. -首次启动后需按照证书以解析 HTTPS 流量，证书会在首次启动命令后自动生成，路径为 `~/.mitmproxy/mitmproxy-ca-cert.pem`。可参考此链接安装：[About Certificates](https://docs.mitmproxy.org/stable/concepts-certificates/)。 +After the first startup, the SSL/TLS certificate will be automatically generated at `~/.mitmproxy/mitmproxy-ca-cert.pem`. You can refer to this link to install: [About Certificates](https://docs.mitmproxy.org/stable/concepts-certificates/). -### 自定义参数 +### Help ``` -go-mitmproxy --help - Usage of go-mitmproxy: -addr string proxy listen addr (default ":9080") @@ -46,15 +46,19 @@ Usage of go-mitmproxy: dump filename -dump_level int dump level: 0 - header, 1 - header + body + -version + show version -web_addr string web interface listen addr (default ":9081") ``` -## 作为包引入 +## Usage as package + +Refer to [cmd/go-mitmproxy/main.go](./cmd/go-mitmproxy/main.go), you can add your own addon by call `AddAddon` method. -参考 [cmd/go-mitmproxy/main.go](./cmd/go-mitmproxy/main.go)，可通过自己实现 `AddAddon` 方法添加自己实现的插件。 +For more examples, please refer to [examples](./examples) -## Web 界面 +## Web interface ![](./assets/web-1.png) @@ -64,8 +68,8 @@ Usage of go-mitmproxy: ## TODO -- [ ] http2 -- [ ] websocket 解析 +- [ ] Support http2 +- [ ] Support parse websocket ## License diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..3dcb752 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,76 @@ +# go-mitmproxy + +[English](./README.md) + +Golang 版本的 [mitmproxy](https://mitmproxy.org/)。 + +用 Golang 实现的中间人攻击（[Man-in-the-middle](https://en.wikipedia.org/wiki/Man-in-the-middle_attack)），解析、监测、篡改 HTTP/HTTPS 流量。 + +## 特点 + +- HTTPS 证书相关逻辑参考 [mitmproxy](https://mitmproxy.org/) 且与之兼容，根证书也保存在 `~/.mitmproxy` 文件夹中，如果之前用过 `mitmproxy` 且根证书已经安装信任，则此 `go-mitmproxy` 可以直接使用 +- 支持插件机制，很方便扩展自己需要的功能，可参考 [addon/addon.go](./addon/addon.go) +- 性能优势 + - Golang 天生的性能优势 + - 在进程内存中转发解析 HTTPS 流量，不需通过 tcp端口 或 unix socket 等进程间通信 + - 生成不同域名证书时使用 LRU 缓存，避免重复计算 +- 通过环境变量 `SSLKEYLOGFILE` 支持 `Wireshark` 解析分析流量 +- 上传/下载大文件时支持流式传输 +- Web 界面 + +## 安装 + +``` +GO111MODULE=on go get -u github.com/lqqyt2423/go-mitmproxy/cmd/go-mitmproxy +``` + +## 命令行使用 + +### 启动 + +``` +go-mitmproxy +``` + +启动后，HTTP 代理地址默认为 9080 端口，Web 界面默认在 9081 端口。 + +首次启动后需按照证书以解析 HTTPS 流量，证书会在首次启动命令后自动生成，路径为 `~/.mitmproxy/mitmproxy-ca-cert.pem`。可参考此链接安装：[About Certificates](https://docs.mitmproxy.org/stable/concepts-certificates/)。 + +### 自定义参数 + +``` +Usage of go-mitmproxy: + -addr string + proxy listen addr (default ":9080") + -dump string + dump filename + -dump_level int + dump level: 0 - header, 1 - header + body + -version + show version + -web_addr string + web interface listen addr (default ":9081") +``` + +## 作为包引入 + +参考 [cmd/go-mitmproxy/main.go](./cmd/go-mitmproxy/main.go)，可通过自己实现 `AddAddon` 方法添加自己实现的插件。 + +更多示例可参考 [examples](./examples) + +## Web 界面 + +![](./assets/web-1.png) + +![](./assets/web-2.png) + +![](./assets/web-3.png) + +## TODO + +- [ ] 支持 http2 协议 +- [ ] 支持解析 websocket + +## License + +[MIT License](./LICENSE) diff --git a/go.mod b/go.mod index 7168d88..cd6d8dc 100644 --- a/go.mod +++ b/go.mod @@ -8,6 +8,6 @@ require ( github.com/gorilla/websocket v1.4.2 github.com/satori/go.uuid v1.2.0 github.com/sirupsen/logrus v1.8.1 - golang.org/x/sys v0.0.0-20210925032602-92d5a993a665 // indirect + golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 // indirect gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect ) diff --git a/go.sum b/go.sum index a825252..a0d65e0 100644 --- a/go.sum +++ b/go.sum @@ -20,7 +20,7 @@ github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210925032602-92d5a993a665 h1:QOQNt6vCjMpXE7JSK5VvAzJC1byuN3FgTNSBwf+CJgI= -golang.org/x/sys v0.0.0-20210925032602-92d5a993a665/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 h1:foEbQz/B0Oz6YIqu/69kfXPYeFQAuuMYFkjaqXzl5Wo= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=