naiveproxy/README.md

80 lines
4.7 KiB
Markdown
Raw Normal View History

2019-01-15 10:29:06 +03:00
# NaiveProxy [![Build Status](https://travis-ci.com/klzgrad/naiveproxy.svg?branch=master)](https://travis-ci.com/klzgrad/naiveproxy) [![Build status](https://ci.appveyor.com/api/projects/status/ohpyaf49baihmxa9?svg=true)](https://ci.appveyor.com/project/klzgrad/naiveproxy)
2019-01-14 11:24:16 +03:00
2019-01-16 08:28:05 +03:00
A secure, censorship-resistent proxy.
2019-01-14 11:24:16 +03:00
2019-01-16 08:28:05 +03:00
NaiveProxy resists censorship by obfuscating as common HTTP/2 traffic with minimal distinguishable features. Privacy and integrity are simultaneously achieved through implementations of TLS best practices.
2019-01-14 11:24:16 +03:00
2019-01-15 10:29:06 +03:00
The following attacks are mitigated:
2019-01-14 11:24:16 +03:00
* Website fingerprinting / traffic classification: [mitigated](https://arxiv.org/abs/1707.00641) by traffic multiplexing in HTTP/2.
* [TLS parameter fingerprinting](https://arxiv.org/abs/1607.01639): defeated by using identical behaviors from [Chromium's network stack](https://www.chromium.org/developers/design-documents/network-stack).
2019-01-16 08:28:05 +03:00
* [Active probing](https://ensa.fi/active-probing/): defeated by *application fronting*, i.e. hiding proxy servers behind a commonly used frontend with application-layer routing.
2019-01-14 11:24:16 +03:00
* Length-based traffic analysis: mitigated by length padding.
2019-01-16 08:28:05 +03:00
## Architecture
<p align="center">[Browser → Naive (client)] ⟶ Censor ⟶ [Frontend → Naive (server)] ⟶ Internet</p>
NaiveProxy uses Chromium's network stack. What the censor can see is exactly regular HTTP/2 traffic between Chrome and Frontend (e.g. HAProxy), two of the most commonly used browsers and servers. Being as common as possible reduces the viability of traffic classification censorship.
Frontend also reroutes unauthenticated users and active probes to a backend HTTP server, making it impossible to detect the existence of a proxy:
<p align="center">Probe ⟶ [Frontend → Nginx] ⟶ index.html</p>
2019-01-15 10:29:06 +03:00
## Download
2019-01-14 11:24:16 +03:00
2019-01-15 10:29:06 +03:00
See [latest release](https://github.com/klzgrad/naiveproxy/releases/latest).
2019-01-14 11:24:16 +03:00
2019-01-15 10:29:06 +03:00
Note: On Linux libnss3 must be installed before using the prebuilt binary.
## Build
If you don't like to use downloaded binaries, you can build it.
2019-01-16 08:28:05 +03:00
Prerequisites:
* Ubuntu (apt-get install): git, python2, ninja-build (>= 1.7), pkg-config, libnss3-dev, ccache (optional)
* MacOS (brew install): git, ninja, ccache (optional)
* Windows ([choco install](https://chocolatey.org/)): git, python2, ninja, visualstudio2017community. See [Chromium's page](https://chromium.googlesource.com/chromium/src/+/master/docs/windows_build_instructions.md#Visual-Studio) for detail on Visual Studio setup requirements.
2019-01-15 10:29:06 +03:00
Build it:
```
git clone https://github.com/klzgrad/naiveproxy.git
cd naiveproxy/src
./get-clang.sh
./build.sh
```
2019-01-16 08:28:05 +03:00
The build scripts download tools from Google servers with curl. If there is trouble try to set a proxy environment variable for curl, e.g. `export ALL_PROXY=socks5h://127.0.0.1:1080`.
2019-01-15 10:29:06 +03:00
Verify:
```
./out/Release/naive --log &
curl -v --proxy socks5h://127.0.0.1:1080 google.com
```
## Setup
2019-01-16 08:28:05 +03:00
The `naive` binary functions as both the client and the server. Naive client can be run as `./naive --proxy=https://user:pass@domain.example`, which accepts SOCKS5 traffic at port 1080 and proxies it via `domain.example` as HTTP/2 traffic. Naive server can be run as `./naive --listen=http://127.0.0.1:8080` behind the frontend as a regular HTTP proxy. You can also store the parameters in `config.json` and `./naive` will detect it automatically.
2019-01-15 10:29:06 +03:00
2019-01-16 08:28:05 +03:00
For details on setting up the server part [Frontend → Naive (server)], see [Server Setup](https://github.com/klzgrad/naiveproxy/wiki/Server-Setup).
2019-01-15 10:29:06 +03:00
2019-01-16 08:28:05 +03:00
For more information on parameter usage, see [USAGE.txt](https://github.com/klzgrad/naiveproxy/blob/master/USAGE.txt). See also [Parameter Tuning](https://github.com/klzgrad/naiveproxy/wiki/Parameter-Tuning) to improve client-side performance.
2019-01-15 10:29:06 +03:00
2019-01-16 08:28:05 +03:00
### Portable setup
<p align="center">Browser ⟶ [HAProxy → Tinyproxy] ⟶ Internet</p>
This mode is clientless: point your browser directly to the server as an HTTPS proxy. You don't need to download, build, or run anything client-side.
But this setup is prone to traffic analysis due to lack of obfuscation. Also, the browser will introduce an extra 1RTT delay during connection setup.
Tinyproxy is used in place of Naive server in this mode, so you only need to `apt-get install tinyproxy` without downloading anything manually.
## FAQ
### Why not use Go, Node, etc.?
2019-01-15 10:29:06 +03:00
2019-01-16 08:28:05 +03:00
Their TLS stacks have distinct features that can be [easily detected](https://arxiv.org/abs/1607.01639) and generally TLS parameters are very distinguishable.
2019-01-15 10:29:06 +03:00
2019-01-16 08:28:05 +03:00
Previously, Tor tried to mimic Firefox's TLS signature and still got [identified and blocked by firewalls](https://groups.google.com/d/msg/traffic-obf/BpFSCVgi5rs/nCqNwoeRKQAJ), because that signature was of an outdated version of Firefox and the firewall determined the rate of collateral damage would be acceptable. It would be unacceptable to block the most commonly used browsers.