archives/snowflake

Fork 0

mirror of https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git synced 2025-10-13 11:11:30 -04:00

Pluggable Transport using WebRTC, inspired by Flashproxy.

Find a file

Arlo Breault e5d57647f0 [WIP] Split broker into components Exploring #26092		2021-06-03 17:13:43 -04:00
broker	[WIP] Split broker into components	2021-06-03 17:13:43 -04:00
client	Encode client-broker messages as json in HTTP body	2021-06-02 09:52:42 -04:00
common	Get rid of legacy version	2021-06-03 17:12:21 -04:00
doc	Add man pages for proxy and client commands	2021-06-02 16:47:50 +02:00
probetest	Stop timers before expiration	2021-05-21 10:09:00 +02:00
proxy	Log a throughput summary for each connection	2021-02-02 11:21:16 -05:00
server	Ensure turbotunnel read and write loop terminate	2021-05-12 09:32:07 -04:00
.gitignore	[WIP] Split broker into components	2021-06-03 17:13:43 -04:00
.gitlab-ci.yml	Update .gitlab-ci.yml after refactor of client	2021-05-12 10:50:06 -04:00
.gitmodules	Remove proxy/translation submodule	2020-04-16 10:01:18 -04:00
.travis.yml	Update .travis.yml for proxy/ code removal	2020-04-22 11:07:57 -04:00
CONTRIBUTING.md	Remove mentions of coffeescript from docs	2019-07-10 10:49:53 +02:00
go.mod	Implement binned counts for polling metrics	2021-04-26 14:07:55 -04:00
go.sum	Export snowflake broker metrics for prometheus	2021-04-22 10:39:35 -04:00
LICENSE	Update license	2020-03-19 15:40:11 -04:00
README.md	Update required Go version to 1.13 in README.	2021-03-05 23:26:35 -07:00

README.md

Snowflake

Pluggable Transport using WebRTC, inspired by Flashproxy.

Table of Contents

Usage
FAQ
Appendix
- -- Testing with Standalone Proxy --

Usage

cd client/
go get
go build
tor -f torrc

This should start the client plugin, bootstrapping to 100% using WebRTC.

Dependencies

Client:

pion/webrtc
Go 1.13+

More Info

Tor can plug in the Snowflake client via a correctly configured torrc. For example:

ClientTransportPlugin snowflake exec ./client \
-url https://snowflake-broker.azureedge.net/ \
-front ajax.aspnetcdn.com \
-ice stun:stun.l.google.com:19302
-max 3

The flags -url and -front allow the Snowflake client to speak to the Broker, in order to get connected with some volunteer's browser proxy. -ice is a comma-separated list of ICE servers, which are required for NAT traversal.

For logging, run tail -F snowflake.log in a second terminal.

You can modify the torrc to use your own broker:

ClientTransportPlugin snowflake exec ./client --meek

Test Environment

There is a Docker-based test environment at https://github.com/cohosh/snowbox.

FAQ

Q: How does it work?

In the Tor use-case:

Volunteers visit websites which host the "snowflake" proxy. (just like flashproxy)
Tor clients automatically find available browser proxies via the Broker (the domain fronted signaling channel).
Tor client and browser proxy establish a WebRTC peer connection.
Proxy connects to some relay.
Tor occurs.

More detailed information about how clients, snowflake proxies, and the Broker fit together on the way...

Q: What are the benefits of this PT compared with other PTs?

Snowflake combines the advantages of flashproxy and meek. Primarily:

It has the convenience of Meek, but can support magnitudes more users with negligible CDN costs. (Domain fronting is only used for brief signalling / NAT-piercing to setup the P2P WebRTC DataChannels which handle the actual traffic.)
Arbitrarily high numbers of volunteer proxies are possible like in flashproxy, but NATs are no longer a usability barrier - no need for manual port forwarding!

Q: Why is this called Snowflake?

It utilizes the "ICE" negotiation via WebRTC, and also involves a great abundance of ephemeral and short-lived (and special!) volunteer proxies...

Appendix

-- Testing with Standalone Proxy --

cd proxy
go build
./proxy