Skip to content

Latest commit

 

History

History
274 lines (181 loc) · 5.71 KB

README.md

File metadata and controls

274 lines (181 loc) · 5.71 KB
Raw

Build & Release Build & Test codecov

bp

bp is a set of advanced and efficient proxy tools written in pure Rust.

Features

  • Cross-platform, of course. Linux/Windows/macOS and others.
  • Support Socks5/HTTP/HTTPS Proxy Protocols.
  • Support proxy non-proxy protocols, e.g, HTTP/HTTPS/DNS.
  • Support multiple transport protocols, e.g, TLS/QUIC.
  • Support Access Control List (ACL) and Proxy Auto Config (PAC) service.
  • Work with Linux Firewall(via iptables).

2.0 Roadmap

  • Refine CLI to multiple subcommands
  • TLS transport layer
  • Configuration generators
  • HTTP Proxy Basic Authorization
  • PAC Service based on access control list
  • Enhance acl, support for bp server
  • Gracefully shutting down
  • Web GUI
  • Improve performance of I/O reader

Planned Features

  • HTTPS Client Proxy with Authorization
  • Deploy to iOS/Android

Web GUI (experimental)

Start bp client gui via:

$ bp web --client

Then open the link printed on the console.

Basic Usages (CLI)

Please check -h/--help first, or see USAGE.

$ bp -h

Generate Configuration

It's easier for newcomers to use configuration file.

Run the following commands to create bp configurations automatically, you can generate YAML or JSON file by changing the file extension.

$ bp generate --config client.json --config-type client
$ bp generate --config server.json --config-type server

Modify configuration items as needed.

Run as Client

$ bp client --config client.json

Run as Server

$ bp server --config server.json

Test with bp-test

You can use bp-test to check if your configuration is correct.

$ bp test --config client.json --http www.google.com:80

Test with Curl

Both Socks5 and HTTP Proxy requests are acceptable by bp client on the same port.

Assume bp client is running at 127.0.0.1:1080:

$ curl --sock5-hostname 127.0.0.1:1080 cn.bing.com
$ curl -x 127.0.0.1:1080 cn.bing.com

Advanced Usages (CLI)

The following guides use CLI options instead of configuration file.

No Proxy

This feature is Client Only.

If not set --server-bind, bp will relay directly.

$ bp client

Proxy Auto Config (PAC)

This feature is Client Only.

$ bp client --acl /path/to/acl.txt --pac-bind <host:port> --pac-proxy <host:port>

Caveats

  • The PAC URL location is http://<host:port>/proxy.pac.
  • The content of proxy.pac is generate from your --acl, you must prepare ACL first.

UDP over TCP

This feature is Client Only.

$ bp client --key key --udp-over-tcp --server-bind <host:port>

Pin Destination Address

This feature is Client Only.

NOTE: this is usually for testing via iperf

$ bp client --pin-dest-addr <host:port>

Access Control List (ACL)

Access Control List works for both client and server side.

Caveats

  • The default strategy is Black List.
  • Higher priority for later rules.
$ bp client --acl /path/to/acl.txt
$ bp server --acl /path/to/acl.txt

Black List Example

example.com
example1.com

White List Example

[Allow]
example.com

Or add [Deny] and [Allow] pair:

[Deny]
*:*

[Allow]
example.com

Mixed Example

You can mix use [Allow] and [Deny].

[Allow]
example.com

[Deny]
example1.com

[Allow]
example1.com # example1.com is allowed again

The format of each rule is [<hostname>]:[<port>], for example:

*:*
example.com
example.com:*
example.com:80

Each rule can add a prefix to change match behavior:

  • ~: fuzzy match, e,g. ~example.com:443 will match *example.com*:443
  • #: comment string, skip matching, e,g. #example.com

Encryption Method

$ bp client --bind 127.0.0.1:9000 --key test --encryption <method>

<method> can be:

  • plain: without encryption.
  • erp: AEAD encryption with random padding. (default)

Enable TLS

First, generate self-signed certificates:

$ bp generate --certificate --hostname localhost

Then, provide bp server with Certificate and Private Key:

$ bp server --tls --tls-cert <cert_path> --tls-key <key_path>

Finally, provide bp client with Certificate only:

$ bp client --tls --tls-cert <cert_path>

Enable QUIC

QUIC is a transport protocol based on UDP and TLS, it force use TLS, so we should first generate TLS Certificate and Private Key. The steps are almost the same as Enable TLS, just need replace --tls to --quic.

Enable Monitor

First, start monitor service at <host:port>:

$ bp client --monitor <host:port>

Then, connect to the port via UDP:

$ nc -u <host> <port>
<enter>

Then you can keep receiving monitor messages. Each message is sent in JSON format within one UDP packet.

Linux Router

In order to proxy the traffic of all devices access to a router, you can add iptables rules on router to redirect all http/https traffic to bp, bp will identify the destination address in the traffic and then proxy it.

Add the following rules:

iptables -t nat -N BP
iptables -t nat -A BP -d 192.168.0.0/16 -j RETURN
iptables -t nat -A BP -p tcp -j RETURN -m mark --mark 0xff
iptables -t nat -A BP -p tcp -m multiport --dports 80,443 -j REDIRECT --to-ports 1080
iptables -t nat -A PREROUTING -p tcp -j BP
iptables -t nat -A OUTPUT -p tcp -j BP