README.zh_CN.md
Rama master · réplica de lectura del repositorio original.
[](https://www.whatrustisit.com)
[](LICENSE)
[](https://codecov.io/gh/bytedance/g3)
[](https://g3-project.readthedocs.io/)
# G3 Project
[English README](README.md) | [日本語 README](README.ja_JP.md)
## 关于
本项目用于构建面向企业的通用代理解决方案，包括但不限于代理、反向代理（开发中）、负载均衡（待定）、NAT穿透（开发中）等。
**G3项目现在是维护模式，活跃开发已经转移到[VEY](https://github.com/VEY-OSS/vey)项目。**
## 应用程序
G3项目包含许多应用，每一个应用程序单独一个子目录，包含各自的代码、文档等。
除了应用程序目录，还有一些公共目录：
- [doc](doc) 包含项目级别文档。
- [sphinx](sphinx) 用于为各应用生成HTML参考文档。
- [scripts](scripts) 包含各种辅助脚本，包括覆盖率测试、打包脚本等。
### g3proxy
通用正向代理解决方案，同时带有TCP映射、TLS卸载/封装、透明代理、简单反向代理等功能。
#### 主要特性
- Async Rust: 高效、稳定
- Http1 / Socks5 正向代理协议, SNI Proxy and TCP TPROXY
- 支持 easy-proxy & masque/http Well-Known URI
- 代理串联，动态下一级代理节点选择
- 丰富的出口路由选择方法，支持接入自定义选路Agent
- TCP/TLS反向代理，基础HTTP反向代理
- TLS支持OpenSSL / BoringSSL / AWS-LC / AWS-LC-FIPS / Tongsuo, 部分场景支持rustls
- TLS中间人劫持, 解密流量导出, HTTP1/HTTP2/IMAP/SMTP协议解析
- ICAP审计，支持HTTP1/HTTP2/IMAP/SMTP，无缝集成第三方安全审计/杀毒产品
- 优雅重载 & 热升级
- 灵活的负载均衡&容灾策略
- 用户认证，且支持丰富的配置选项
- 用户配置下可细化进行差异化站点配置
- 丰富的ACL/限流限速策略，包括入口/出口/用户维度
- 丰富的监控指标，包括入口/出口/用户/用户站点维度
- 多种日志 & 监控解决方案集成能力
[详细介绍](g3proxy/README.md) | [用户指南](g3proxy/UserGuide.zh_CN.md) |
[参考文档](https://g3-project.readthedocs.io/projects/g3proxy/en/latest/)
### g3statsd
StatsD兼容的监控打点指标聚合服务。
[详细介绍](g3statsd/README.md) | [参考文档](https://g3-project.readthedocs.io/projects/g3statsd/en/latest/)
### g3tiles
通用反向代理解决方案，开发中。
[参考文档](https://g3-project.readthedocs.io/projects/g3tiles/en/latest/)
### g3bench
压测工具，支持
- HTTP: HTTP/1.1, HTTP/2, HTTP/3
- WebSocket
- TLS Handshake
- DNS: UDP, TCP, DNS over TLS, DNS over HTTP, DNS over QUIC, DNS over HTTP/3
- Thrift RPC
- Cloudflare Keyless
[详细介绍](g3bench/README.md)
### g3mkcert
用来生成 根CA / 中间CA / TLS服务端 / TLS客户端 / 国密服务端 / 国密客户端 证书的工具。
[详细介绍](g3mkcert/README.md)
### g3fcgen
适用于g3proxy TLS劫持功能的伪造证书生成服务应用。
[详细介绍](g3fcgen/README.md)
### g3iploc
适用于g3proxy GeoIP功能的IP Location查找服务应用。
[详细介绍](g3iploc/README.md)
### g3keymess
Cloudflare Keyless Server的简单实现。
[详细介绍](g3keymess/README.md) |
[参考文档](https://g3-project.readthedocs.io/projects/g3keymess/en/latest/)
## 支持平台
目前提供对Linux系统的完整支持。
以下系统也可以编译：
- macOS
- Windows >= 10
- FreeBSD >= 14.3
- NetBSD >= 10.1
- OpenBSD >= 7.8
## 开发环境搭建
参考 [Dev-Setup](doc/dev-setup.md)。
## 标准及约定
参考 [Standards](doc/standards.md)。
## 构建、打包及部署
预编译包可以在 [cloudsmith](https://cloudsmith.io/~g3-oqh/repos/) 找到。
但是仍然建议自行编译打包，具体方法参考 [Build and Package](doc/build_and_package.md)。
### 长期支持版本
参考 [Long-Term Support](doc/long-term_support.md).
## 贡献指南
参考 [Contributing](CONTRIBUTING.md)。
## 交流合作
请使用[飞书](https://www.feishu.cn/download)加群，
[G3代理用户交流群加入链接](https://applink.feishu.cn/client/chat/chatter/add_by_link?link_token=9fah8def-d024-4db5-91cd-522ae09c2b72)，
或使用如下二维码:
<img alt="" src="G3-FEISHU-USER-GROUP.png" width="50%" height="50%">
## Code of Conduct
Please check [Code of Conduct](CODE_OF_CONDUCT.md) for more details.
## Security
If you discover a potential security issue in this project, or think you may
have discovered a security issue, we ask that you notify Bytedance Security via our
[security center](https://security.bytedance.com/src) or [vulnerability reporting email](mailto:sec@bytedance.com).
Please do **not** create a public GitHub issue.
## License
This project is licensed under the [Apache-2.0 License](LICENSE).
## 404星链计划
<img src="https://github.com/knownsec/404StarLink/raw/master/Images/logo.png" width="30%">
[g3proxy](g3proxy) 现已加入 [404星链计划](https://github.com/knownsec/404StarLink)