Skip to content
/ brook Public
forked from txthinking/brook

Brook is a cross-platform(Linux/MacOS/Windows/Android/iOS) proxy/vpn software

License

GPL-3.0 license
0 stars 2.4k forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

XGZepto/brook

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

815 Commits
.github
.github
 
 
cli/brook
cli/brook
 
 
docs
docs
 
 
limits
limits
 
 
ping
ping
 
 
plugins
plugins
 
 
programmable
programmable
 
 
protocol
protocol
 
 
.gitignore
.gitignore
 
 
.travis.yml
.travis.yml
 
 
LICENSE
LICENSE
 
 
OPENSOURCELICENSES
OPENSOURCELICENSES
 
 
README.md
README.md
 
 
SECURITY.md
SECURITY.md
 
 
brooklink.go
brooklink.go
 
 
cac.go
cac.go
 
 
client.go
client.go
 
 
dhcpserver.go
dhcpserver.go
 
 
dhcpserver_linux.go
dhcpserver_linux.go
 
 
dhcpserver_notlinux.go
dhcpserver_notlinux.go
 
 
dial.go
dial.go
 
 
dnsclient.go
dnsclient.go
 
 
dnsserver.go
dnsserver.go
 
 
dohclient.go
dohclient.go
 
 
dohserver.go
dohserver.go
 
 
echoclient.go
echoclient.go
 
 
echoserver.go
echoserver.go
 
 
error.go
error.go
 
 
exchanger.go
exchanger.go
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 
init.go
init.go
 
 
link.go
link.go
 
 
list.go
list.go
 
 
log.go
log.go
 
 
nat.go
nat.go
 
 
nonce.go
nonce.go
 
 
pac.go
pac.go
 
 
packetclient.go
packetclient.go
 
 
packetconn.go
packetconn.go
 
 
packetserver.go
packetserver.go
 
 
packetserverconn.go
packetserverconn.go
 
 
quic.go
quic.go
 
 
quicclient.go
quicclient.go
 
 
quicserver.go
quicserver.go
 
 
relay.go
relay.go
 
 
relayoverbrook.go
relayoverbrook.go
 
 
resolve.go
resolve.go
 
 
server.go
server.go
 
 
simplepacketclient.go
simplepacketclient.go
 
 
simplepacketserver.go
simplepacketserver.go
 
 
simplepacketserverconn.go
simplepacketserverconn.go
 
 
simplestreamclient.go
simplestreamclient.go
 
 
simplestreamserver.go
simplestreamserver.go
 
 
socks5.go
socks5.go
 
 
socks5test.go
socks5test.go
 
 
socks5tohttp.go
socks5tohttp.go
 
 
streamclient.go
streamclient.go
 
 
streamserver.go
streamserver.go
 
 
test_test.go
test_test.go
 
 
util.go
util.go
 
 
waitreaderr.go
waitreaderr.go
 
 
websocket.go
websocket.go
 
 
wsclient.go
wsclient.go
 
 
wsserver.go
wsserver.go
 
 

Repository files navigation

Brook

A cross-platform programmable network tool.

Sponsor

❤️ Shiliew - A network app designed for those who value their time

Getting Started

Server

bash <(curl https://bash.ooo/nami.sh)

nami install brook

brook server -l :9999 -p hello

GUI Client

iOS Android Mac Windows Linux OpenWrt
Windows OpenWrt
/ / App Mode How How How

You may want to use brook link to customize some parameters

GUI Documentation

Software for which this article applies

Programmable

Brook GUI will pass different global variables to the script at different times, and the script only needs to assign the processing result to the global variable out

  • address: We call it address which includes both host and port. For example, an ip address contains an ip and a port; a domain address contains a domain and a port.
  • Fake DNS: Fake DNS can allow you to obtain domain address on in_address step. How Fake DNS works

Variables

variable type condition timing description out type
in_brooklinks map / Before connecting Predefine multiple brook links, and then programmatically specify which one to connect to map
in_dnsquery map FakeDNS: On When a DNS query occurs Script can decide how to handle this request map
in_address map / When connecting to an address script can decide how to connect map
in_httprequest map / When an HTTP(S) request comes in the script can decide how to handle this request map
in_httprequest,in_httpresponse map / when an HTTP(S) response comes in the script can decide how to handle this response map

in_brooklinks

Key Type Description Example
_ bool meaningless true

out, ignored if not of type map

Key Type Description Example
... ... ... ...
custom name string brook link brook://...
... ... ... ...

in_dnsquery

Key Type Description Example
domain string domain name google.com
type string query type A
appid string App ID or path com.google.Chrome.helper
interface string network interface. Mac only en0

out, if it is error type will be recorded in the log. Ignored if not of type map

Key Type Description Example
block bool Whether Block, default false false
ip string Specify IP directly, only valid when type is A/AAAA 1.2.3.4
system bool Resolve by System DNS, default false false
bypass bool Resolve by Bypass DNS, default false false
brooklinkkey string When need to connect the Server，instead, connect to the Server specified by the key in_brooklinks custom name

in_address

Key Type Description Example
network string Network type, the value tcp/udp tcp
ipaddress string IP type address. There is only of ipaddress and domainaddress. Note that there is no relationship between these two 1.2.3.4:443
domainaddress string Domain type address, because of FakeDNS we can get the domain name address here google.com:443
appid string App ID or path com.google.Chrome.helper
interface string network interface. Mac only en0

out, if it is error type will be recorded in the log. Ignored if not of type map

Key Type Description Example
block bool Whether Block, default false false
ipaddress string IP type address, rewrite destination 1.2.3.4:443
ipaddressfrombypassdns string Use Bypass DNS to obtain A or AAAA IP and rewrite the destination, only valid when domainaddress exists, the value A/AAAA A
bypass bool Bypass, default false. If true and domainaddress, then ipaddress or ipaddressfrombypassdns must be specified false
mitm bool Whether to perform MITM, default false. Only valid when network is tcp. Need to install CA, see below false
mitmprotocol string MITM protocol needs to be specified explicitly, the value is http/https https
mitmcertdomain string The MITM certificate domain name, which is taken from domainaddress by default. If ipaddress and mitm is true and mitmprotocol is https then must be must be specified explicitly example.com
mitmwithbody bool Whether to manipulate the http body, default false. will read the body of the request and response into the memory and interact with the script. iOS 50M total memory limit may kill process false
mitmautohandlecompress bool Whether to automatically decompress the http body when interacting with the script, default false false
mitmclienttimeout int Timeout for MITM talk to server, second, default 0 0
mitmserverreadtimeout int Timeout for MITM read from client, second, default 0 0
mitmserverwritetimeout int Timeout for MITM write to client, second, default 0 0
brooklinkkey string When need to connect the Server，instead, connect to the Server specified by the key in_brooklinks custom name

in_httprequest

Key Type Description Example
URL string URL https://example.com/hello
Method string HTTP method GET
Body bytes HTTP request body /
... string other fields are HTTP headers /

out, must be set to a request or response

in_httpresponse

Key Type Description Example
StatusCode int HTTP status code 200
Body bytes HTTP response body /
... string other fields are HTTP headers /

out, must be set to a response

Module

There are already some modules: https://github.com/txthinking/brook/blob/master/programmable/modules/

Brook GUI

In Brook GUI, scripts are abstracted into modules, and it will automatically combine _header.tengo and _footer.tengo, so you only need to write the module itself.

modules = append(modules, {
    // If you want to predefine multiple brook links, and then programmatically specify which one to connect to, then define `brooklinks` key a function
    brooklinks: func(m) {
        // Please refer to the example in `brooklinks.tengo`
    },
    // If you want to intercept and handle a DNS query, then define `dnsquery` key a function, `m` is the `in_dnsquery`
    dnsquery: func(m) {
        // Please refer to the example in `block_aaaa.tengo`
    },
    // If you want to intercept and handle an address, then define `address` key a function, `m` is the `in_address`
    address: func(m) {
        // Please refer to the example in `block_google_secure_dns.tengo`
    },
    // If you want to intercept and handle a http request, then define `httprequest` key a function, `request` is the `in_httprequest`
    httprequest: func(request) {
        // Please refer to the example in `ios_app_downgrade.tengo` or `redirect_google_cn.tengo`
    },
    // If you want to intercept and handle a http response, then define `httpresponse` key a function, `request` is the `in_httprequest`, `response` is the `in_httpresponse`
    httpresponse: func(request, response) {
        // Please refer to the example in `response_sample.tengo`
    }
})

tun2brook

If you are using tun2brook, you can combine multiple modules into a complete script in the following way. For example:

cat _header.tengo > my.tengo

cat block_google_secure_dns.tengo >> my.tengo
cat block_aaaa.tengo >> my.tengo

cat _footer.tengo >> my.tengo

Syntax

Tengo Language Syntax

Library

  • text: regular expressions, string conversion, and manipulation

  • math: mathematical constants and functions

  • times: time-related functions

  • rand: random functions

  • fmt: formatting functions

  • json: JSON functions

  • enum: Enumeration functions

  • hex: hex encoding and decoding functions

  • base64: base64 encoding and decoding functions

  • brook: brook module

    Constants

* os: string, linux/darwin/windows/ios/android

Functions

* splithostport(address string) => map/error: splits a network address of the form "host:port" to { "host": "xxx", "port": "xxx" }
* country(ip string) => string/error: get country code from ip
* cidrcontainsip(cidr string, ip string) => bool/error: reports whether the network includes ip
* parseurl(url string) => map/error: parses a raw url into a map, keys: scheme/host/path/rawpath/rawquery
* parsequery(query string) => map/error: parses a raw query into a kv map
* map2query(kv map) => string/error: convert map{string:string} into a query string
* bytes2ints(b bytes) => array/error: convert bytes into [int]
* ints2bytes(ints array) => bytes/error: convert [int] into bytes
* bytescompare(a bytes, b bytes) => int/error: returns an integer comparing two bytes lexicographically. The result will be 0 if a == b, -1 if a < b, and +1 if a > b
* bytescontains(b bytes, sub bytes) => bool/error: reports whether sub is within b
* byteshasprefix(s bytes, prefix bytes) => bool/error: tests whether the bytes s begins with prefix
* byteshassuffix(s bytes, suffix bytes) => bool/error: tests whether the bytes s ends with suffix
* bytesindex(s bytes, sep bytes) => int/error: returns the index of the first instance of sep in s, or -1 if sep is not present in s
* byteslastindex(s bytes, sep bytes) => int/error: returns the index of the last instance of sep in s, or -1 if sep is not present in s
* bytesreplace(s bytes, old bytes, new bytes, n int) => bytes/error: returns a copy of the s with the first n non-overlapping instances of old replaced by new. If n < 0, there is no limit on the number of replacements
* pathescape(s string) => string/error: escapes the string so it can be safely placed inside a URL path segment, replacing special characters (including /) with %XX sequences as needed
* pathunescape(s string) => string/error: does the inverse transformation of pathescape
* queryescape(s string) => string/error: escapes the string so it can be safely placed inside a URL query
* queryunescape(s string) => string/error: does the inverse transformation of queryescape
* hexdecode(s string) => bytes/error: returns the bytes represented by the hexadecimal string s
* hexencode(s string) => string/error: returns the hexadecimal encoding of src

Debug

If you are writing complex scripts, the GUI may not be convenient for debugging. It is recommended to use tun2brook on desktop to debug with fmt.println

Install CA

https://txthinking.github.io/ca/ca.pem

OS How
iOS https://www.youtube.com/watch?v=HSGPC2vpDGk
Android Android has user CA and system CA, must be installed in the system CA after ROOT
macOS nami install mad ca.txthinking, sudo mad install --ca ~/.nami/bin/ca.pem
Windows nami install mad ca.txthinking, Admin: mad install --ca ~/.nami/bin/ca.pem

Some software may not read the system CA，you can use curl --cacert ~/.nami/bin/ca.pem to debug

Resources

CLI Description
nami A clean and tidy decentralized package manager
joker Joker can turn process into daemon. Zero-Configuration
nico Nico can work with brook wsserver together
zhen zhen - process and cron manager
tun2brook Proxy all traffic just one line command
mad Generate root CA and derivative certificate for any domains and any IPs
hancock Manage multiple remote servers and execute commands remotely
sshexec A command-line tool to execute remote command through ssh
jb write script in an easier way than bash
bash Many one-click scripts
pacman pacman -S brook
brew brew install brook
docker docker run txthinking/brook
Resources Description
Protocol Brook Protocol
Blog Some articles you should read
YouTube Some videos you should watch
Telegram Ask questions here
Announce All news you should care
GitHub Other useful repos
Socks5 Configurator If you prefer CLI brook client
IPvBar See domain, IP and country in browser
TxThinking SSH A SSH Terminal
brook-user-system A Brook User System
TxThinking Everything

CLI Documentation

NAME

Brook - A cross-platform programmable network tool

SYNOPSIS

Brook

brook --help

Usage:

Brook [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

GLOBAL OPTIONS

  • --blockCIDR4List="": One CIDR per line, https://, http:// or local file absolute path, like: https://raw.githubusercontent.com/txthinking/brook/master/programmable/list/example_cidr4.txt. Works with server/wsserver/wssserver/quicserver

  • --blockCIDR6List="": One CIDR per line, https://, http:// or local file absolute path, like: https://raw.githubusercontent.com/txthinking/brook/master/programmable/list/example_cidr6.txt. Works with server/wsserver/wssserver/quicserver

  • --blockDomainList="": One domain per line, suffix match mode. https://, http:// or local file absolute path. Like: https://raw.githubusercontent.com/txthinking/brook/master/programmable/list/example_domain.txt. Works with server/wsserver/wssserver/quicserver

  • --blockGeoIP="": Block IP by Geo country code, such as US. Works with server/wsserver/wssserver/quicserver

  • --blockListUpdateInterval="": Update list --blockDomainList,--blockCIDR4List,--blockCIDR6List interval, second. default 0, only read one time on start (default: 0)

  • --clientHKDFInfo="": client HKDF info, most time you don't need to change this, if changed, all and each brook links in client side must be same, I mean each (default: "brook")

  • --dialWithDNS="": When a domain name needs to be resolved, use the specified DNS. Such as 8.8.8.8:53 or https://dns.google/dns-query?address=8.8.8.8%3A443, the address is required. Note that for client-side commands, this does not affect the client passing the domain address to the server

  • --dialWithDNSPrefer="": This is used with the dialWithDNS parameter. Prefer A record or AAAA record. Value is A or AAAA

  • --dialWithIP4="": When the current machine establishes a network connection to the outside IPv4, both TCP and UDP, it is used to specify the IPv4 used

  • --dialWithIP6="": When the current machine establishes a network connection to the outside IPv6, both TCP and UDP, it is used to specify the IPv6 used

  • --dialWithNIC="": When the current machine establishes a network connection to the outside, both TCP and UDP, it is used to specify the NIC used

  • --dialWithSocks5="": When the current machine establishes a network connection to the outside, both TCP and UDP, with your socks5 proxy, such as 127.0.0.1:1081

  • --dialWithSocks5Password="": If there is

  • --dialWithSocks5TCPTimeout="": time (s) (default: 0)

  • --dialWithSocks5UDPTimeout="": time (s) (default: 60)

  • --dialWithSocks5Username="": If there is

  • --help, -h: show help

  • --ipLimitInterval="": Interval (s) for ipLimitMax (default: 0)

  • --ipLimitMax="": Limit the number of client IP addresses, be careful when using this parameter, as the client may have dynamic IP. Works with server/wsserver/wssserver/quicserver (default: 0)

  • --ipLimitWait="": How long (s) to wait for recovery after exceeding ipLimitMax (default: 0)

  • --log="": Enable log. A valid value is file path or 'console'. Send SIGUSR1 to me to reset the log file on unix system. If you want to debug SOCKS5 lib, set env SOCKS5_DEBUG=true

  • --pid="": A file path used to store pid. Send SIGUSR1 to me to reset the --serverLog file on unix system

  • --pprof="": go http pprof listen addr, such as :6060

  • --prometheus="": prometheus http listen addr, such as :7070. If it is transmitted on the public network, it is recommended to use it with nico

  • --prometheusPath="": prometheus http path, such as /xxx. If it is transmitted on the public network, a hard-to-guess value is recommended

  • --serverHKDFInfo="": server HKDF info, most time you don't need to change this, if changed, all and each brook links in client side must be same, I mean each (default: "brook")

  • --serverLog="": Enable server log, traffic and more. A valid value is file path or 'console'. Send SIGUSR1 to me to reset the log file on unix system. Mutually exclusive with the --log parameter. Works with server/wsserver/wssserver/quicserver with brook protocol

  • --speedLimit="": Limit speed (b), 500kb/s such as: 500000, works with server/wsserver/wssserver/quicserver (default: 0)

  • --tag="": Tag can be used to the process, will be append into log or serverLog, such as: 'key1:value1'. All tags will also be appended as query parameters one by one to the userAPI

  • --userAPI="": When you build your own user system, Brook Server will send GET request to your userAPI to check if token is valid, for example: https://your-api-server.com/a_unpredictable_path. Yes, it is recommended to add an unpredictable path to your https API, of course, you can also use the http api for internal network communication. The request format is https://your-api-server.com/a_unpredictable_path?token=xxx. When the response is 200, the body should be the user's unique identifier, such as user ID; all other status codes are considered to represent an illegitimate user, and in these cases, the body should be a string describing the error. It should be used with --serverLog and server/wsserver/wssserver/quicserver with brook protocol. For more information, please read https://github.com/txthinking/brook/blob/master/protocol/user.md

  • --userAPIInvalidCacheTime="": Once a token is checked and invalid, the userAPI will not be requested to validate again for a certain period (s). A reasonable value must be set, otherwise it will affect the performance of each incoming connection. Note that this may affect the user experience, when you change the user status from invalid to valid in your user system (default: 1800)

  • --userAPIValidCacheTime="": Once a token is checked and valid, the userAPI will not be requested to validate again for a certain period (s). A reasonable value must be set, otherwise it will affect the performance of each incoming connection (default: 3600)

  • --version, -v: print the version

COMMANDS

server

Start a brook server that supports tcp and udp

  • --blockCIDR4List="": This option will be removed in a future version, please use the global option instead

  • --blockCIDR6List="": This option will be removed in a future version, please use the global option instead

  • --blockDomainList="": This option will be removed in a future version, please use the global option instead

  • --blockGeoIP="": This option will be removed in a future version, please use the global option instead

  • --example: Show a minimal example of usage

  • --listen, -l="": Listen address, like: ':9999'

  • --password, -p="": Server password

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

  • --updateListInterval="": This option will be removed in a future version, please use the global option instead (default: 0)

client

Start a brook client that supports tcp and udp. It can open a socks5 proxy, [src <-> socks5 <-> $ brook client <-> $ brook server <-> dst]

  • --example: Show a minimal example of usage

  • --http="": Where to listen for HTTP proxy connections

  • --link="": brook link, you can get it via $ brook link. The wssserver and password parameters will be ignored

  • --password, -p="": Brook server password

  • --server, -s="": Brook server address, like: 1.2.3.4:9999

  • --socks5="": Where to listen for SOCKS5 connections (default: 127.0.0.1:1080)

  • --socks5ServerIP="": Only if your socks5 server IP is different from listen IP

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

wsserver

Start a brook wsserver that supports tcp and udp. It opens a standard http server and a websocket server

  • --blockCIDR4List="": This option will be removed in a future version, please use the global option instead

  • --blockCIDR6List="": This option will be removed in a future version, please use the global option instead

  • --blockDomainList="": This option will be removed in a future version, please use the global option instead

  • --blockGeoIP="": This option will be removed in a future version, please use the global option instead

  • --example: Show a minimal example of usage

  • --listen, -l="": Listen address, like: ':80'

  • --password, -p="": Server password

  • --path="": URL path (default: /ws)

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

  • --updateListInterval="": This option will be removed in a future version, please use the global option instead (default: 0)

  • --withoutBrookProtocol: The data will not be encrypted with brook protocol

  • --xForwardedFor: Replace the from field in --log, note that this may be forged

wsclient

Start a brook wsclient that supports tcp and udp. It can open a socks5 proxy, [src <-> socks5 <-> $ brook wsclient <-> $ brook wsserver <-> dst]

  • --example: Show a minimal example of usage

  • --http="": Where to listen for HTTP proxy connections

  • --link="": brook link, you can get it via $ brook link. The wssserver and password parameters will be ignored

  • --password, -p="": Brook wsserver password

  • --socks5="": Where to listen for SOCKS5 connections (default: 127.0.0.1:1080)

  • --socks5ServerIP="": Only if your socks5 server IP is different from listen IP

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

  • --wsserver, -s="": Brook wsserver address, like: ws://1.2.3.4:80, if no path then /ws will be used. Do not omit the port under any circumstances

wssserver

Start a brook wssserver that supports tcp and udp. It opens a standard https server and a websocket server

  • --blockCIDR4List="": This option will be removed in a future version, please use the global option instead

  • --blockCIDR6List="": This option will be removed in a future version, please use the global option instead

  • --blockDomainList="": This option will be removed in a future version, please use the global option instead

  • --blockGeoIP="": This option will be removed in a future version, please use the global option instead

  • --cert="": The cert file absolute path for the domain, such as /path/to/cert.pem. If cert or certkey is empty, a certificate will be issued automatically

  • --certkey="": The cert key file absolute path for the domain, such as /path/to/certkey.pem. If cert or certkey is empty, a certificate will be issued automatically

  • --domainaddress="": Such as: domain.com:443. If you choose to automatically issue certificates, the domain must have been resolved to the server IP and 80 port also will be used

  • --example: Show a minimal example of usage

  • --password, -p="": Server password

  • --path="": URL path (default: /ws)

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

  • --updateListInterval="": This option will be removed in a future version, please use the global option instead (default: 0)

  • --withoutBrookProtocol: The data will not be encrypted with brook protocol

wssclient

Start a brook wssclient that supports tcp and udp. It can open a socks5 proxy, [src <-> socks5 <-> $ brook wssclient <-> $ brook wssserver <-> dst]

  • --example: Show a minimal example of usage

  • --http="": Where to listen for HTTP proxy connections

  • --link="": brook link, you can get it via $ brook link. The wssserver and password parameters will be ignored

  • --password, -p="": Brook wssserver password

  • --socks5="": Where to listen for SOCKS5 connections (default: 127.0.0.1:1080)

  • --socks5ServerIP="": Only if your socks5 server IP is different from listen IP

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

  • --wssserver, -s="": Brook wssserver address, like: wss://google.com:443, if no path then /ws will be used. Do not omit the port under any circumstances

quicserver

Start a brook quicserver that supports tcp and udp.

  • --blockCIDR4List="": This option will be removed in a future version, please use the global option instead

  • --blockCIDR6List="": This option will be removed in a future version, please use the global option instead

  • --blockDomainList="": This option will be removed in a future version, please use the global option instead

  • --blockGeoIP="": This option will be removed in a future version, please use the global option instead

  • --cert="": The cert file absolute path for the domain, such as /path/to/cert.pem. If cert or certkey is empty, a certificate will be issued automatically

  • --certkey="": The cert key file absolute path for the domain, such as /path/to/certkey.pem. If cert or certkey is empty, a certificate will be issued automatically

  • --domainaddress="": Such as: domain.com:443. If you choose to automatically issue certificates, the domain must have been resolved to the server IP and 80 port also will be used

  • --example: Show a minimal example of usage

  • --password, -p="": Server password

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

  • --updateListInterval="": This option will be removed in a future version, please use the global option instead (default: 0)

  • --withoutBrookProtocol: The data will not be encrypted with brook protocol

quicclient

Start a brook quicclient that supports tcp and udp. It can open a socks5 proxy, [src <-> socks5 <-> $ brook quicclient <-> $ brook quicserver <-> dst]. (The global-dial-parameter is ignored)

  • --example: Show a minimal example of usage

  • --http="": Where to listen for HTTP proxy connections

  • --link="": brook link, you can get it via $ brook link. The wssserver and password parameters will be ignored

  • --socks5="": Where to listen for SOCKS5 connections (default: 127.0.0.1:1080)

  • --socks5ServerIP="": Only if your socks5 server IP is different from listen IP

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

relayoverbrook

Relay network traffic over brook, which supports TCP and UDP. Accessing [from address] is equal to accessing [to address], [src <-> from address <-> $ brook server/wsserver/wssserver/quicserver <-> to address]

  • --example: Show a minimal example of usage

  • --from, -f, -l="": Listen address: like ':9999'

  • --link="": brook link, you can get it via $ brook link. The server and password parameters will be ignored

  • --password, -p="": Password

  • --server, -s="": brook server or brook wsserver or brook wssserver or brook quicserver, like: 1.2.3.4:9999, ws://1.2.3.4:9999, wss://domain:443/ws, quic://domain.com:443

  • --tcpTimeout="": time (s) (default: 0)

  • --to, -t="": Address which relay to, like: 1.2.3.4:9999

  • --udpTimeout="": time (s) (default: 0)

dnsserveroverbrook

Run a dns server over brook, which supports TCP and UDP, [src <-> $ brook dnserversoverbrook <-> $ brook server/wsserver/wssserver/quicserver <-> dns] or [src <-> $ brook dnsserveroverbrook <-> dnsForBypass]

link

Generate a brook link

  • --address="": When server is brook wsserver or brook wssserver or brook quicserver, specify address instead of resolving addresses from host, such as 1.2.3.4:443

  • --ca="": When server is brook wssserver or brook quicserver, specify ca for untrusted cert, such as /path/to/ca.pem

  • --clientHKDFInfo="": client HKDF info, most time you don't need to change this, read brook protocol if you don't know what this is

  • --example: Show a minimal example of usage

  • --fragment="": When server is brook wssserver, split the ClientHello into multiple fragments and then send them one by one with delays (millisecond). The format is min_length:max_length:min_delay:max_delay, cannot be zero, such as 50:100:10:50

  • --insecure: When server is brook wssserver or brook quicserver, client do not verify the server's certificate chain and host name

  • --name="": Give this server a name

  • --password, -p="": Password

  • --server, -s="": Support brook server, brook wsserver, brook wssserver, socks5 server, brook quicserver. Like: 1.2.3.4:9999, ws://1.2.3.4:9999, wss://google.com:443/ws, socks5://1.2.3.4:1080, quic://google.com:443

  • --serverHKDFInfo="": server HKDF info, most time you don't need to change this, read brook protocol if you don't know what this is

  • --tlsfingerprint="": When server is brook wssserver, select tls fingerprint, value can be: chrome

  • --token="": A token represents a user's identity. A string encoded in hexadecimal. Server needs to have --userAPI enabled. Note that: Only supported by the brook GUI(except for OpenWrt) and tun2brook

  • --udpoverstream: When server is brook quicserver, UDP over Stream. Under normal circumstances, you need this parameter because the max datagram size for QUIC is very small. Note: only brook CLI and tun2brook suppport for now

  • --udpovertcp: When server is brook server, UDP over TCP

  • --username, -u="": Username, when server is socks5 server

  • --withoutBrookProtocol: When server is brook wsserver or brook wssserver or brook quicserver, the data will not be encrypted with brook protocol

connect

Run a client and connect with a brook link, which supports TCP and UDP. It can start a socks5 proxy, [src <-> socks5 <-> $ brook connect <-> $ brook server/wsserver/wssserver/quicserver <-> dst]

  • --example: Show a minimal example of usage

  • --http="": Where to listen for HTTP proxy connections

  • --link, -l="": brook link, you can get it via $ brook link

  • --socks5="": Where to listen for SOCKS5 connections (default: 127.0.0.1:1080)

  • --socks5ServerIP="": Only if your socks5 server IP is different from listen IP

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

relay

Run a standalone relay, which supports TCP and UDP. Accessing [from address] is equal to accessing [to address], [src <-> from address <-> to address]

  • --example: Show a minimal example of usage

  • --from, -f, -l="": Listen address: like ':9999'

  • --tcpTimeout="": time (s) (default: 0)

  • --to, -t="": Address which relay to, like: 1.2.3.4:9999

  • --udpTimeout="": time (s) (default: 0)

dnsserver

Run a standalone dns server

dnsclient

Send a dns query

  • --dns, -s="": DNS server, such as 8.8.8.8:53 (default: 8.8.8.8:53)

  • --domain, -d="": Domain

  • --example: Show a minimal example of usage

  • --short: Short for A/AAAA

  • --type, -t="": Type, such as A (default: A)

dohserver

Run a standalone doh server

  • --blockDomainList="": One domain per line, suffix match mode. https://, http:// or local absolute file path. Like: https://raw.githubusercontent.com/txthinking/brook/master/programmable/list/example_domain.txt

  • --cert="": The cert file absolute path for the domain, such as /path/to/cert.pem. If cert or certkey is empty, a certificate will be issued automatically

  • --certkey="": The cert key file absolute path for the domain, such as /path/to/certkey.pem. If cert or certkey is empty, a certificate will be issued automatically

  • --disableA: Disable A query

  • --disableAAAA: Disable AAAA query

  • --dns="": DNS server which forward to. Such as 8.8.8.8:53 or https://dns.google/dns-query?address=8.8.8.8%3A443, the address is required (default: 8.8.8.8:53)

  • --domainaddress="": Such as: domain.com:443, if you want to create a https server. If you choose to automatically issue certificates, the domain must have been resolved to the server IP and 80 port also will be used

  • --example: Show a minimal example of usage

  • --listen="": listen address, if you want to create a http server behind nico

  • --path="": URL path (default: /dns-query)

  • --tcpTimeout="": time (s) (default: 0)

  • --udpTimeout="": time (s) (default: 0)

dohclient

Send a dns query

dhcpserver

Run a standalone dhcp server. Other running dhcp servers need to be stopped.

  • --cache="": Cache file, local absolute file path, default is $HOME/.brook.dhcpserver

  • --count="": IP range from the start, which you want to assign to clients (default: 0)

  • --dnsserver="": The dns server which you want to assign to clients, such as: 192.168.1.1 or 8.8.8.8

  • --example: Show a minimal example of usage

  • --gateway="": The router gateway which you want to assign to clients, such as: 192.168.1.1

  • --interface="": Select interface on multi interface device. Linux only

  • --netmask="": Subnet netmask which you want to assign to clients (default: 255.255.255.0)

  • --serverip="": DHCP server IP, the IP of the this machine, you shoud set a static IP to this machine before doing this, such as: 192.168.1.10

  • --start="": Start IP which you want to assign to clients, such as: 192.168.1.100

socks5

Run a standalone standard socks5 server, which supports TCP and UDP

  • --example: Show a minimal example of usage

  • --limitUDP: The server MAY use this information to limit access to the UDP association. This usually causes connection failures in a NAT environment, where most clients are.

  • --listen, -l="": Socks5 server listen address, like: :1080 or 1.2.3.4:1080

  • --password="": Password, optional

  • --socks5ServerIP="": Only if your socks5 server IP is different from listen IP

  • --tcpTimeout="": Connection deadline time (s) (default: 0)

  • --udpTimeout="": Connection deadline time (s) (default: 0)

  • --username="": User name, optional

socks5tohttp

Convert a socks5 proxy to a http proxy, [src <-> listen address(http proxy) <-> socks5 address <-> dst]

  • --example: Show a minimal example of usage

  • --listen, -l="": HTTP proxy which will be create: like: 127.0.0.1:8010

  • --socks5, -s="": Socks5 server address, like: 127.0.0.1:1080

  • --socks5password="": Socks5 password, optional

  • --socks5username="": Socks5 username, optional

  • --tcpTimeout="": Connection tcp timeout (s) (default: 0)

pac

Run a PAC server or save PAC to a file

  • --bypassDomainList, -b="": One domain per line, suffix match mode. http(s):// or local absolute file path. Like: https://raw.githubusercontent.com/txthinking/brook/master/programmable/list/example_domain.txt

  • --example: Show a minimal example of usage

  • --file, -f="": Save PAC to file, this will ignore listen address

  • --listen, -l="": Listen address, like: 127.0.0.1:1980

  • --proxy, -p="": Proxy, like: 'SOCKS5 127.0.0.1:1080; SOCKS 127.0.0.1:1080; DIRECT' (default: SOCKS5 127.0.0.1:1080; SOCKS 127.0.0.1:1080; DIRECT)

testsocks5

Test a socks5 server to see if it works properly

  • --dns="": DNS server for connecting (default: 8.8.8.8:53)

  • --domain="": Domain for query (default: http3.ooo)

  • --example: Show a minimal example of usage

  • --password, -p="": Socks5 password

  • --socks5, -s="": Like: 127.0.0.1:1080

  • --username, -u="": Socks5 username

  • -a="": The A record of domain (default: 137.184.237.95)

testbrook

Test UDP and TCP of a brook server/wsserver/wssserver/quicserver connection. (The global-dial-parameter is ignored)

  • --dns="": DNS server for connecting (default: 8.8.8.8:53)

  • --domain="": Domain for query (default: http3.ooo)

  • --example: Show a minimal example of usage

  • --link, -l="": brook link. Get it via $ brook link

  • --socks5="": Temporarily listening socks5 (default: 127.0.0.1:11080)

  • -a="": The A record of domain (default: 137.184.237.95)

echoserver

Echo server, echo UDP and TCP address of routes

  • --example: Show a minimal example of usage

  • --listen, -l="": Listen address, like: ':7777'

echoclient

Connect to echoserver, echo UDP and TCP address of routes

  • --example: Show a minimal example of usage

  • --server, -s="": Echo server address, such as 1.2.3.4:7777

  • --times="": Times of interactions (default: 0)

ipcountry

Get country of IP

  • --example: Show a minimal example of usage

  • --ip="": 1.1.1.1

completion

Generate shell completions

  • --example: Show a minimal example of usage

  • --file, -f="": Write to file (default: brook_autocomplete)

mdpage

Generate markdown page

  • --example: Show a minimal example of usage

  • --file, -f="": Write to file, default print to stdout

  • --help, -h: show help

help, h

Shows a list of commands or help for one command

manpage

Generate man.1 page

  • --example: Show a minimal example of usage

  • --file, -f="": Write to file, default print to stdout. You should put to /path/to/man/man1/brook.1 on linux or /usr/local/share/man/man1/brook.1 on macos

help, h

Shows a list of commands or help for one command

Examples

List some examples of common scene commands, pay attention to replace the parameters such as IP, port, password, domain name, certificate path, etc. in the example by yourself

Run brook server

brook server --listen :9999 --password hello

then

  • server: 1.2.3.4:9999
  • password: hello

or get brook link

brook link --server 1.2.3.4:9999 --password hello --name 'my brook server'

or get brook link with --udpovertcp

brook link --server 1.2.3.4:9999 --password hello --udpovertcp --name 'my brook server'

Run brook wsserver

brook wsserver --listen :9999 --password hello

then

  • server: ws://1.2.3.4:9999
  • password: hello

or get brook link

brook link --server ws://1.2.3.4:9999 --password hello --name 'my brook wsserver'

or get brook link with domain, even if that's not your domain

brook link --server ws://hello.com:9999 --password hello --address 1.2.3.4:9999 --name 'my brook wsserver'

Run brook wssserver: automatically certificate

Make sure your domain has been resolved to your server IP successfully. Automatic certificate issuance requires the use of port 80

brook wssserver --domainaddress domain.com:443 --password hello

then

  • server: wss://domain.com:443
  • password: hello

or get brook link

brook link --server wss://domain.com:443 --password hello --name 'my brook wssserver'

Run brook wssserver Use a certificate issued by an existing trust authority

Make sure your domain has been resolved to your server IP successfully

brook wssserver --domainaddress domain.com:443 --password hello --cert /root/cert.pem --certkey /root/certkey.pem

then

  • server: wss://domain.com:443
  • password: hello

or get brook link

brook link --server wss://domain.com:443 --password hello --name 'my brook wssserver'

Run brook wssserver issue untrusted certificates yourself, any domain

Install mad

nami install mad

Generate root ca

mad ca --ca /root/ca.pem --key /root/cakey.pem

Generate domain cert by root ca

mad cert --ca /root/ca.pem --ca_key /root/cakey.pem --cert /root/cert.pem --key /root/certkey.pem --domain domain.com

Run brook

brook wssserver --domainaddress domain.com:443 --password hello --cert /root/cert.pem --certkey /root/certkey.pem

get brook link with --insecure

brook link --server wss://domain.com:443 --password hello --name 'my brook wssserver' --address 1.2.3.4:443 --insecure

or get brook link with --ca

brook link --server wss://domain.com:443 --password hello --name 'my brook wssserver' --address 1.2.3.4:443 --ca /root/ca.pem

withoutBrookProtocol

Better performance, but data is not strongly encrypted using Brook protocol. So please use certificate encryption, and it is not recommended to use --withoutBrookProtocol and --insecure together

withoutBrookProtocol automatically certificate

Make sure your domain has been resolved to your server IP successfully. Automatic certificate issuance requires the use of port 80

brook wssserver --domainaddress domain.com:443 --password hello --withoutBrookProtocol

get brook link

brook link --server wss://domain.com:443 --password hello --withoutBrookProtocol

withoutBrookProtocol Use a certificate issued by an existing trust authority

Make sure your domain has been resolved to your server IP successfully

brook wssserver --domainaddress domain.com:443 --password hello --cert /root/cert.pem --certkey /root/certkey.pem --withoutBrookProtocol

get brook link

brook link --server wss://domain.com:443 --password hello --name 'my brook wssserver' --withoutBrookProtocol

withoutBrookProtocol issue untrusted certificates yourself, any domain

Install mad

nami install mad

Generate root ca

mad ca --ca /root/ca.pem --key /root/cakey.pem

Generate domain cert by root ca

mad cert --ca /root/ca.pem --ca_key /root/cakey.pem --cert /root/cert.pem --key /root/certkey.pem --domain domain.com

Run brook wssserver

brook wssserver --domainaddress domain.com:443 --password hello --cert /root/cert.pem --certkey /root/certkey.pem --withoutBrookProtocol

Get brook link

brook link --server wss://domain.com:443 --password hello --withoutBrookProtocol --address 1.2.3.4:443 --ca /root/ca.pem

Run brook socks5, A stand-alone standard socks5 server

brook socks5 --listen :1080 --socks5ServerIP 1.2.3.4

then

  • server: 1.2.3.4:1080

or get brook link

brook link --server socks5://1.2.3.4:1080

Run brook socks5 with username and password. A stand-alone standard socks5 server

brook socks5 --listen :1080 --socks5ServerIP 1.2.3.4 --username hello --password world

then

  • server: 1.2.3.4:1080
  • username: hello
  • password: world

or get brook link

brook link --server socks5://1.2.3.4:1080 --username hello --password world

brook relayoverbrook can relay a local address to a remote address over brook, both TCP and UDP, it works with brook server wsserver wssserver.

brook relayoverbrook ... --from 127.0.0.1:5353 --to 8.8.8.8:53

brook dnsserveroverbrook can create a encrypted DNS server, both TCP and UDP, it works with brook server wsserver wssserver.

brook dnsserveroverbrook ... --listen 127.0.0.1:53

Brook OpenWRT Router: Perfectly supports IPv4/IPv6/TCP/UDP. Native IPv6

https://www.txthinking.com/talks/articles/brook-openwrt-en.article

Turn macOS into a Gateway with Brook

https://www.txthinking.com/talks/articles/brook-macos-gateway-en.article

Turn Windows into a Gateway with Brook

https://www.txthinking.com/talks/articles/brook-windows-gateway-en.article

Turn Linux into a Gateway with Brook

https://www.txthinking.com/talks/articles/brook-linux-gateway-en.article

brook relay can relay a address to a remote address. It can relay any tcp and udp server

brook relay --from :9999 --to 1.2.3.4:9999

brook socks5tohttp can convert a socks5 to a http proxy

brook socks5tohttp --socks5 127.0.0.1:1080 --listen 127.0.0.1:8010

brook pac creates pac server

brook pac --listen 127.0.0.1:8080 --proxy 'SOCKS5 127.0.0.1:1080; SOCKS 127.0.0.1:1080; DIRECT' --bypassDomainList ...

brook pac creates pac file

brook pac --file proxy.pac --proxy 'SOCKS5 127.0.0.1:1080; SOCKS 127.0.0.1:1080; DIRECT' --bypassDomainList ...

There are countless examples; for more feature suggestions, it's best to look at the commands and parameters in the CLI documentation one by one, and blog, YouTube...

About

Brook is a cross-platform(Linux/MacOS/Windows/Android/iOS) proxy/vpn software

Resources

Readme

License

GPL-3.0 license

Security policy

Security policy
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

18 tags

Packages

No packages published

Languages

  • Go 99.8%
  • JavaScript 0.2%