Brak opisu

Arlo Breault e5d57647f0 [WIP] Split broker into components 3 lat temu
broker e5d57647f0 [WIP] Split broker into components 3 lat temu
client 270eb21803 Encode client-broker messages as json in HTTP body 3 lat temu
common 0ef2250280 Get rid of legacy version 3 lat temu
doc c5ca41f138 Add man pages for proxy and client commands 3 lat temu
probetest ef4d0a1da5 Stop timers before expiration 3 lat temu
proxy 7187f1009e Log a throughput summary for each connection 3 lat temu
server 7c9005bed3 Ensure turbotunnel read and write loop terminate 3 lat temu
.gitignore e5d57647f0 [WIP] Split broker into components 3 lat temu
.gitlab-ci.yml 0054cb2dec Update .gitlab-ci.yml after refactor of client 3 lat temu
.gitmodules 6f89fc14f6 Remove proxy/translation submodule 4 lat temu
.travis.yml 3ff04c3c65 Update .travis.yml for proxy/ code removal 4 lat temu
CONTRIBUTING.md d3080e2566 Remove mentions of coffeescript from docs 5 lat temu
LICENSE e521a7217a Update license 4 lat temu
README.md 850d2f0683 Update required Go version to 1.13 in README. 3 lat temu
go.mod 92bd900bc5 Implement binned counts for polling metrics 3 lat temu
go.sum 83ef0b6f6d Export snowflake broker metrics for prometheus 3 lat temu

README.md

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