Pluggable Transport using WebRTC, inspired by Flashproxy.
Find a file
Cecylia Bocovich e521a7217a Update license
2020-03-19 15:40:11 -04:00
broker Added another lock to protect broker stats 2019-12-05 10:17:20 -05:00
client Refactor (De)SerializeSessionDescription as common utils 2020-03-17 20:16:58 -04:00
common Refactor (De)SerializeSessionDescription as common utils 2020-03-17 20:16:58 -04:00
doc Updated broker specification and comments 2019-11-28 13:52:58 -05:00
proxy bump version to 0.2.2 2020-03-04 16:20:34 -05:00
proxy-go Refactor (De)SerializeSessionDescription as common utils 2020-03-17 20:16:58 -04:00
server In server, treat a client IP address of 0.0.0.0 as missing. 2020-02-22 16:13:17 -07:00
.gitignore Add a build step / documentation for code reuse 2019-12-06 17:19:46 -05:00
.gitlab-ci.yml first stab at gitlab CI build 2018-05-08 10:10:07 +02:00
.gitmodules Add branch to .gitmodule + bump to bbf11bb 2019-08-26 15:14:17 -04:00
.travis.yml Remove go get commands from travis.yml 2020-03-05 09:21:17 -05:00
CONTRIBUTING.md Remove mentions of coffeescript from docs 2019-07-10 10:49:53 +02:00
go.mod Update go.mod and go.sum 2020-03-17 14:22:20 -04:00
go.sum Update go.mod and go.sum 2020-03-17 14:22:20 -04:00
LICENSE Update license 2020-03-19 15:40:11 -04:00
README.md Remove the abandoned server-webrtc test code 2020-03-17 14:16:57 -04: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:

Proxy:

  • JavaScript

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

Building

This describes how to build the in-browser snowflake. For the client, see Usage, above.

The client will only work if there are browser snowflakes available. To run your own:

cd proxy/
npm run build

Then, start a local http server in the proxy/build/ in any way you like. For instance:

cd build/
python -m http.server

Then, open a browser tab to http://127.0.0.1:8000/embed.html to view the debug-console of the snowflake., So long as that tab is open, you are an ephemeral Tor bridge.

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
go build
./proxy-go

More documentation on the way.

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