snowflake

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

History

David Fifield bdc1798adb Exit immediately after SIGTERM is there are no signals running. Cf. https://bugs.torproject.org/24875		2018-03-21 00:51:04 -07:00
..
client_test.go	defer snowflake.Reset to fix handler recovery when localhost SOCKS occassionally fails first	2016-07-29 10:59:51 -07:00
interfaces.go	pull copyLoop out of goroutine, better pop and reset	2016-06-14 17:07:21 -07:00
peers.go	client multiplexes AND recovers correctly! (close #31 )	2016-06-15 21:57:56 -07:00
README.md	begin client sub-readme	2016-03-27 09:08:54 -07:00
rendezvous.go	Use ResolveReference to construct the /client URL.	2018-03-13 15:37:50 -04:00
snowflake.go	Exit immediately after SIGTERM is there are no signals running.	2018-03-21 00:51:04 -07:00
torrc	initial client roundtrip estimate on broker	2016-09-20 06:28:11 -07:00
torrc-localhost	Add context to HTTP handlers, attempt to support localhost Broker.	2016-02-12 18:00:36 -08:00
torrc-manual	torrc-manuel deserves a -log	2017-10-18 11:21:57 -04:00
util.go	Add missing import removed in `0c02af3`	2017-10-12 17:26:32 -04:00
webrtc.go	Add synchronization around destroying DataChannels and PeerConnections	2018-03-20 15:08:36 -04: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.