snowflake

mirror of https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snowflake.git synced 2025-10-14 05:11:19 -04:00

History

Serene Han c63f5cfc0a Separate peers.go file with improved documentation and more solid interfaces		2016-06-11 19:58:08 -07:00
..
client_test.go	Separate peers.go file with improved documentation and more solid interfaces	2016-06-11 19:58:08 -07:00
interfaces.go	Separate peers.go file with improved documentation and more solid interfaces	2016-06-11 19:58:08 -07:00
peers.go	Separate peers.go file with improved documentation and more solid interfaces	2016-06-11 19:58:08 -07:00
README.md	begin client sub-readme	2016-03-27 09:08:54 -07:00
rendezvous.go	more complete and improved client rendezvous tests	2016-05-18 13:21:01 -07:00
snowflake.go	Separate peers.go file with improved documentation and more solid interfaces	2016-06-11 19:58:08 -07:00
torrc	keep readme up to date	2016-03-08 18:23:41 -08:00
torrc-localhost	Add context to HTTP handlers, attempt to support localhost Broker.	2016-02-12 18:00:36 -08:00
torrc-manual	Automatic 100% bootstrap using meek-signaling broker works.	2016-01-21 14:00:39 -08:00
util.go	webRTCConn has better seam with BytesLogger interface	2016-05-24 12:56:09 -07:00
webrtc.go	Separate peers.go file with improved documentation and more solid interfaces	2016-06-11 19:58:08 -07:00

README.md

This is the Tor client component of Snowflake.

It is based on goptlib.

Flags

The client uses these following torrc options by default:

ClientTransportPlugin snowflake exec ./client \
-url https://snowflake-reg.appspot.com/ \
-front www.google.com \
-ice stun:stun.l.google.com:19302

-url should be the URL of a Broker instance. This is required to have automated signalling (which is desired in most use cases). When omitted, the client uses copy-paste signalling instead.

-front is an optional front domain for the Broker request.

-ice is a comma-separated list of ICE servers. These can be STUN or TURN servers.