G3 Project

中文版 README

About

This is the project we used to build enterprise-oriented generic proxy solutions, including but not limited to proxy / reverse proxy (WIP) / load balancer (TBD) / nat traversal (TBD).

Components

G3 Project is made up of many components.

The project-level documents resides in the doc subdirectory, and you should see the links below for the important ones. Each component will have its own documents in its doc subdirectory.

g3proxy

A generic forward proxy solution, but you can also use it as tcp streaming / transparent proxy / reverse proxy as we have basic support built in.

Feature highlights

• Async Rust: fast and reliable
• Http1 / Socks4 / Socks5 forward proxy protocol, SNI Proxy and TCP TPROXY
• TLS over OpenSSL or BoringSSL or AWS-LC or Tongsuo, and even rustls
• TLS MITM interception, decrypted traffic dump, HTTP1 and HTTP2 interception
• ICAP audit protocol
• Graceful reload
• Customizable load balancing and failover strategies
• Support for a variety of observability tools

See g3proxy for detailed introduction.

g3tiles

A work in progress reverse proxy solution.

g3bench

A benchmark tool that supports HTTP 1.x, HTTP 2, HTTP 3, TLS Handshake, DNS and Cloudflare Keyless.

See g3bench for detailed introduction.

g3mkcert

A tool to make root CA / intermediate CA / TLS server / TLS client certificates.

g3fcgen

Fake certificate generator for g3proxy.

g3iploc

IP location lookup service for g3proxy GeoIP support.

g3keymess

A simple implementation of Cloudflare keyless server.

Target Platform

Only Linux is fully supported yet. The code will compile on FreeBSD, NetBSD, macOS and Windows, but we haven't tested it there.

Feel free to open PRs to add support for other platforms.

Dev-env Setup Guide

Follow Dev-Setup.

Standards

Follow Standards.

Release and Packaging

We will set tags for each release of each component in the form <name>-v<version>. You can use these tags to generate source tarballs. And we have added deb and rpm package files for each component that is ready for distribution.

If you want to do a release build:

1. generate a release tarball

   # if we have a tag <name>-v<version>
   ./scripts/release/build_tarball.sh <name>-v<version>
   # if no tags usable, you need to specify the git revision (e.g. HEAD)
   ./scripts/release/build_tarball.sh <name> <rev>
   

   All vendor sources will be added to the source tarball, so you can save the source tarball and build it offline at anywhere that has the compiler and dependencies installed.

2. build the package

   For deb package:

   tar xf <name>-<version>.tar.xz
   cd <name>-<version>
   ./build_deb_from_tar.sh
   

   For rpm package:

   rpmbuild -ta ./<name>-<version>.tar.xz
   # if failed, you can run the following commands manually:
   tar xvf <name>-<version>.tar.xz ./<name>-<version>/<name>.spec
   cp <name>-<version>.tar.xz ~/rpmbuild/SOURCES/
   rpmbuild -ba ./<name>-<version>/<name>.spec
   

If you want to build a package directly from the git repo:

• For deb package:

  ./build_deb_from_git.sh <name>
  

• For rpm package:

  ./build_rpm_from_git.sh <name>
  

Pre-Built Packages

It is recommended to build packages yourself if you want to install them in a production environment.

For testing purpose, we have built and uploaded some packages to cloudsmith, you can find installation instructions there.

Static Linking

See Static Linking.

Build with different OpenSSL variants

See OpenSSL Variants.

LTS Version

See Long-Term Support.

Contribution

Please check Contributing for more details.

Code of Conduct

Please check Code of Conduct 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 or vulnerability reporting email.

Please do not create a public GitHub issue.

License

This project is licensed under the Apache-2.0 License.