No Description

Micah Anderson c109efc9ab CI: tag containers in a meaningful way (Fixes #40345). 8 months ago
broker b512e242e8 Implement better client IP per rendezvous method tracking for clients 8 months ago
client 9fe2ca58a0 Switch to sqscreds param for passing in SQS credentials 8 months ago
common f502eca67d Merge remote-tracking branch 'origin/mr/258' 8 months ago
doc f502eca67d Merge remote-tracking branch 'origin/mr/258' 8 months ago
probetest d1175dac82 chore(deps): update golang docker tag to v1.22 8 months ago
proxy acce1f1fd9 refactor: change deprecated "io/ioutil" package to recommended "io" package 9 months ago
server acce1f1fd9 refactor: change deprecated "io/ioutil" package to recommended "io" package 9 months ago
.gitignore 1318b6a9ec stripped down Android build process for gitlab-ci and Vagrant 3 years ago
.gitlab-ci.yml c109efc9ab CI: tag containers in a meaningful way (Fixes #40345). 8 months ago
.gitmodules 6f89fc14f6 Remove proxy/translation submodule 4 years ago
.travis.yml ead5a960d7 Bump snowflake library imports and go.mod to v2 3 years ago
CONTRIBUTING.md d3080e2566 Remove mentions of coffeescript from docs 5 years ago
ChangeLog b130151b24 Bump version to v2.9.1 8 months ago
Dockerfile 52fcd3d58a chore(deps): update docker.io/library/golang docker tag to v1.22 8 months ago
LICENSE e521a7217a Update license 4 years ago
README.md 473cc45987 Add utls-imitate, utls-nosni doc to README: fix style 1 year ago
Vagrantfile 82cc0f38f7 Move the development to gitlab 1 year ago
go.mod e7dfbebf56 chore(deps): update module github.com/prometheus/client_model to v0.6.0 8 months ago
go.sum e7dfbebf56 chore(deps): update module github.com/prometheus/client_model to v0.6.0 8 months ago
renovate.json b11a41482c Use go 1.21 in renovate 1 year ago

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.

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.