archives/snowflake
2
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git synced 2025-10-14 05:11:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
Pluggable Transport using WebRTC, inspired by Flashproxy.
879 commits 18 branches 42 tags 3.8 MiB
Find a file
Cecylia Bocovich 3547b284a9
Make all snowflake events LogSeverityNotice 
Let's reserve Tor error logs for more severe events that indicate
a client-side bug or absolute failure. By default, tor logs at severity
level notice (and above).
2022-02-14 14:09:16 -05:00
broker Bump snowflake library imports and go.mod to v2 2021-11-11 10:14:49 -05:00
client Make all snowflake events LogSeverityNotice 2022-02-14 14:09:16 -05:00
common Add EventOnProxyConnectionOver Event 2022-01-25 13:03:18 +00:00
doc Bump snowflake library imports and go.mod to v2 2021-11-11 10:14:49 -05:00
probetest Bump snowflake library imports and go.mod to v2 2021-11-11 10:14:49 -05:00
proxy Add verbosity switch to suppress diagnostic output 2022-02-03 13:38:48 +00:00
server Initialize SnowflakeListener.closed 2022-02-08 13:00:43 -05:00
.gitignore stripped down Android build process for gitlab-ci and Vagrant 2021-12-01 11:48:03 +01:00
.gitlab-ci.yml Update go versions in CI tests 2021-12-10 10:43:47 -05:00
.gitmodules Remove proxy/translation submodule 2020-04-16 10:01:18 -04:00
.travis.yml Bump snowflake library imports and go.mod to v2 2021-11-11 10:14:49 -05:00
ChangeLog Update ChangeLog for v2.1.0 release 2022-02-08 10:56:19 -05:00
CONTRIBUTING.md Remove mentions of coffeescript from docs 2019-07-10 10:49:53 +02:00
go.mod Fix build break in Go 1.16 for missing import 2022-01-26 13:39:12 +00:00
go.sum Update version of DTLS library 2021-12-10 10:39:44 -05:00
LICENSE Update license 2020-03-19 15:40:11 -04:00
README.md stripped down Android build process for gitlab-ci and Vagrant 2021-12-01 11:48:03 +01:00
Vagrantfile gitlab-ci: include flags to make reproducible builds 2021-12-01 11:48:06 +01:00

README.md

Snowflake

Build Status

Pluggable Transport using WebRTC, inspired by Flashproxy.

Table of Contents

Structure of this Repository

  • broker/ contains code for the Snowflake broker
  • doc/ contains Snowflake documentation and manpages
  • client/ contains the Tor pluggable transport client and client library code
  • common/ contains generic libraries used by multiple pieces of Snowflake
  • proxy/ contains code for the Go standalone Snowflake proxy
  • probetest/ contains code for a NAT probetesting service
  • server/ contains the Tor pluggable transport server and server library code

Usage

Snowflake is currently deployed as a pluggable transport for Tor.

Using Snowflake with Tor

To use the Snowflake client with Tor, you will need to add the appropriate Bridge and ClientTransportPlugin lines to your torrc file. See the client README for more information on building and running the Snowflake client.

Running a Snowflake Proxy

You can contribute to Snowflake by running a Snowflake proxy. We have the option to run a proxy in your browser or as a standalone Go program. See our community documentation for more details.

Using the Snowflake Library with Other Applications

Snowflake can be used as a Go API, and adheres to the v2.1 pluggable transports specification. For more information on using the Snowflake Go library, see the Snowflake library documentation.

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...

More info and links

We have more documentation in the Snowflake wiki and at https://snowflake.torproject.org/.

-- Android AAR Reproducible Build Setup --

Using gomobile it is possible to build snowflake as shared libraries for all the architectures supported by Android. This is in the .gitlab-ci.yml, which runs in GitLab CI. It is also possible to run this setup in a Virtual Machine using vagrant. Just run vagrant up and it will create and provision the VM. vagrant ssh to get into the VM to use it as a development environment.