relaybaton

A pluggable transport to circumvent Internet censorship

Getting Started

Prerequisites

For supporting ESNI features, the pwu/esni branch of cloudflare/tls-tris should be used in building instead of the default go build

See tls-tris/README.md for instructions of building tls-tris.

Install

go get github.com/iyouport-org/relaybaton

Build

CGO_ENABLED=1 should be set in cross-compiling

tls-tris/_dev/go.sh build -o relaybaton github.com/iyouport-org/relaybaton/main

Deployment

For supporting ESNI features and hiding the IP address of the server from interception, the server should have a valid domain name and behind Cloudflare CDN.

Cloudflare CDN will provide TLS encryption with ESNI extension.

A MaxMind GeoLite2 Country database should be provided for GeoIP-based routing.

Server

sudo is required for listening on port 80

sudo relaybation server

Client

relaybaton client

A local SOCKS5 proxy server will listen on the local port which is given in the configuration file.

Configuration

config.toml is the default configuration file, it should be located in the same path of the excutable binary file.

Example

[log]
file="./log.xml"
level="error"

[dns]
type="dot"
server="cloudflare-dns.com"
addr="1.0.0.1:853"
local_resolve=true

[clients]
port=1081

    [[clients.client]]
    id="1"
    server="example.com"
    username="username"
    password="password"
    esni=true
    timeout=15

    [[clients.client]]
    id="2"
    server="example2.com"
    username="username"
    password="password"
    esni=true
    timeout=15

[routes]
geoip_file="GeoLite2-Country.mmdb"

    [[routes.route]]
    type="geoip"
    cond="CN"
    target="1"

    [[routes.route]]
    type="domain"
    cond="www/.example/.com"
    target="2"

    [[routes.route]]
    type="ipv4"
    cond="1.1.1.1
    target="2"

    [[routes.route]]
    type="ipv6"
    cond="2001:DB8:2de:0:0:0:0:e13"
    target="2"

    [[routes.route]]
    type="ipv4subnet"
    cond="1.1.1.1/4"
    target="2"

    [[routes.route]]
    type="ipv6subnet"
    cond="2001:DB8:2de:0:0:0:0:e13/4"
    target="2"

    [[routes.route]]
    type="default"
    cond=""
    target="1"

[server]
port=80
pretend="https://www.kernel.org"
timeout=15
secure=false
cert_file=""
key_file=""

[db]
type="sqlite3"
username="root"
password="password"
host="localhost"
port=1433
database="relaybaton.db"

Description of the fields

Field	TOML Type	Go Type	Description
log.file	String	os.File	filename of log file
log.level	String	github.com/sirupsen/logrus logrus.Level	minimum log level to write
dns.type	String	github.com/iyouport-org/relaybaton config.DNSType	type of DNS resolver
dns.server	String	string	server name of the DNS server
dns.addr	String	net.Addr	IP address of the DNS server
dns.local_resolve	Boolean	bool	if domain names resolved locally
clients.port	Integer	uint16	local port that client listen to
client.id	Integer	string	ID of the client
client.server	String	string	domain name of the server
client.username	String	string	username of the client
client.password	String	string	password of the client
client.esni	Boolean	bool	if ESNI enabled
client.timeout	Integer	time.Duration	timeout for no response
routes.geoip_file	String	github.com/oschwald/geoip2-golang geoip.Reader	filename of GeoIP database
route.type	String	github.com/iyouport-org/relaybaton config.routeType	type of routing condition
route.cond	String	[]string \|\| regexp.Regexp \|\| net.IP \|\| net.IPNet	condition of routing
route.target	String	string	target client if condition met
server.port	Integer	uint16	port that server listen to
server.pretend	String	url.URL	domain name of the website that the server pretend to be
server.timeout	Integer	time.Duration	timeout for no response
server.secure	Boolean	bool	if the server running with TLS
server.cert_file	String	os.FileInfo	cert file of a TLS server
server.key_file	String	os.FileInfo	key file of a TLS server
db.type	String	github.com/iyouport-org/relaybaton config.dbType	type of the database
db.username	String	string	username for database connection
db.password	String	string	password for database connection
db.host	String	string	hostname for database connection
db.port	Integer	uint16	port for database connection
db.database	String	string	name of database

See wiki for detailed explanation.

Built With

github.com/sirupsen/logrus - Structured, pluggable logging for Go.
github.com/gorilla/websocket - A fast, well-tested and widely used WebSocket implementation for Go.
github.com/spf13/viper - Go configuration with fangs.
github.com/jinzhu/gorm - The fantastic ORM library for Golang, aims to be developer friendly.
github.com/oschwald/geoip2-golang - Unofficial MaxMind GeoIP2 Reader for Go.
github.com/miekg/dns - DNS library in Go.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

onoketa

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

github.com/txthinking/socks5 - SOCKS Protocol Version 5 Library in Go
Cloudflare

niubaoshu / relaybaton