Pluggable Transport using WebRTC, inspired by Flashproxy.
Find a file
2021-07-13 17:50:44 -04:00
broker Remove and restore some comments, after review 2021-07-08 15:35:04 -04:00
client Update example torrc file for client 2021-06-24 13:46:11 -04:00
common Use variables for string matching 2021-07-08 12:47:23 -04:00
doc Make the proxy to report the number of clients to the broker 2021-07-07 19:36:20 +02:00
probetest Stop timers before expiration 2021-05-21 10:09:00 +02:00
proxy Refactor webRTCConn to its own file 2021-07-07 19:36:24 +02:00
server Fix leak in server acceptLoop 2021-06-24 13:32:55 -04:00
.gitignore Add a remote service to test NAT compatability 2020-10-29 11:03:51 -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
ChangeLog Version bump to v1.1.0 2021-07-13 17:50:44 -04:00
CONTRIBUTING.md Remove mentions of coffeescript from docs 2019-07-10 10:49:53 +02:00
go.mod Bump version of kcp and smux libraries 2021-06-23 19:41:03 -04:00
go.sum Bump version of kcp and smux libraries 2021-06-23 19:41:03 -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

Snowflake

Build Status

Pluggable Transport using WebRTC, inspired by Flashproxy.

Table of Contents

Usage

cd client/
go get
go build
tor -f torrc

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

Dependencies

Client:


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:

  1. Volunteers visit websites which host the "snowflake" proxy. (just like flashproxy)
  2. Tor clients automatically find available browser proxies via the Broker (the domain fronted signaling channel).
  3. Tor client and browser proxy establish a WebRTC peer connection.
  4. Proxy connects to some relay.
  5. 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

More documentation on the way.

Also available at: torproject.org/pluggable-transports/snowflake