archives/snowflake
2
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git synced 2025-10-13 11:11:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
Pluggable Transport using WebRTC, inspired by Flashproxy.
1515 commits 18 branches 42 tags 3.8 MiB
Find a file
Cecylia Bocovich b9e7865c50
Fix data race in queuepacketconn_test.go 
Use mutex when checking the length of a TranscriptPacketConn.
2025-09-09 09:54:33 -04:00
broker Add failing concurrency test 2025-08-20 16:37:31 -04:00
client Delete stray space. 2025-06-19 15:26:39 +00:00
common Fix data race in queuepacketconn_test.go 2025-09-09 09:54:33 -04:00
doc Add clarification to broker-spec on client-*-ips 2025-07-10 10:34:26 -04:00
probetest Update probetest container images to build binary and reduce final image size with multiple stages 2025-08-20 11:44:35 +01:00
proxy improvement: less scary failed conn logs & metrics 2025-03-15 11:15:22 -04:00
server fix: potential race conditions with non-local err 2025-03-12 00:47:07 +04:00
.gitignore stripped down Android build process for gitlab-ci and Vagrant 2021-12-01 11:48:03 +01:00
.gitlab-ci.yml Bump minimum supported go version to 1.23.0 2025-08-20 09:35:32 -04: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 Bump verison of Snowflake to 2.11.0 2025-03-18 14:37:02 -04:00
CONTRIBUTING.md Remove mentions of coffeescript from docs 2019-07-10 10:49:53 +02:00
docker-compose.yml Add updated docker compose file 2025-04-17 16:41:22 +01:00
Dockerfile Update snowflake proxy image to use most recent golang and geodb 2025-07-31 15:01:07 +01:00
go.mod Bump kcp-go to v5.6.24 2025-09-09 09:54:33 -04:00
go.sum Bump kcp-go to v5.6.24 2025-09-09 09:54:33 -04:00
LICENSE Update license 2020-03-19 15:40:11 -04:00
README.md Update README to reflect project usecase 2025-03-12 13:58:30 +00:00
renovate.json Use go 1.21 in renovate 2023-10-16 20:48:47 +02:00
Vagrantfile Move the development to gitlab 2023-05-31 10:01:47 +02:00

README.md

Snowflake

Snowflake is a censorship-evasion 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 that host the 'snowflake' proxy, run a snowflake web extension, or use a standalone proxy.
  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.

uTLS Settings

Snowflake communicate with broker that serves as signaling server with TLS based domain fronting connection, which may be identified by its usage of Go language TLS stack.

uTLS is a software library designed to initiate the TLS Client Hello fingerprint of browsers or other popular software's TLS stack to evade censorship based on TLS client hello fingerprint with -utls-imitate . You can use -version to see a list of supported values.

Depending on client and server configuration, it may not always work as expected as not all extensions are correctly implemented.

You can also remove SNI (Server Name Indication) from client hello to evade censorship with -utls-nosni, not all servers supports this.