October 2021 - tor-commits - lists.torproject.org

[translation/support-portal] https://gitweb.torproject.org/translation.git/commit/?h=support-portal
by translation＠torproject.org 28 Oct '21

28 Oct '21

commit 88e4af7be8f6e63d4a94f698c20274cd06ac2a67 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Oct 28 14:18:17 2021 +0000 https://gitweb.torproject.org/translation.git/commit/?h=support-portal --- contents+id.po | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/contents+id.po b/contents+id.po index bc4d81020b..7b60a08da3 100644 --- a/contents+id.po +++ b/contents+id.po @@ -12,8 +12,8 @@ # raz <razmawardhana(a)gmail.com>, 2021 # Khairul Agasta <khairuldroids(a)gmail.com>, 2021 # ical, 2021 -# hadymaggot <9hs(a)tuta.io>, 2021 # Emma Peel, 2021 +# hadymaggot <9hs(a)tuta.io>, 2021 # msgid "" msgstr "" @@ -21,7 +21,7 @@ msgstr "" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-10-26 15:31+CET\n" "PO-Revision-Date: 2018-10-02 22:41+0000\n" -"Last-Translator: Emma Peel, 2021\n" +"Last-Translator: hadymaggot <9hs(a)tuta.io>, 2021\n" "Language-Team: Indonesian (https://www.transifex.com/otf/teams/1519/id/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -15023,7 +15023,7 @@ msgstr "Donasi Anda akan dicocokkan oleh Friends of Tor hingga $100,000." #: lego/templates/banner.html:31 lego/templates/banner.html:33 #: templates/banner.html:31 templates/banner.html:33 msgid "Donate now" -msgstr "" +msgstr "Donasi Sekarang" #: lego/templates/footer.html:13 lego/templates/footer.html:22 #: lego/templates/navbar.html:96 templates/footer.html:13

1 0

[translation/tpo-web] https://gitweb.torproject.org/translation.git/commit/?h=tpo-web
by translation＠torproject.org 28 Oct '21

28 Oct '21

commit e54ebacaa94730c45290d947b47435ef7a533956 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Oct 28 14:18:10 2021 +0000 https://gitweb.torproject.org/translation.git/commit/?h=tpo-web --- contents+fr.po | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/contents+fr.po b/contents+fr.po index b38a714675..82f1531d3d 100644 --- a/contents+fr.po +++ b/contents+fr.po @@ -5,11 +5,11 @@ # Curtis Baltimore <curtisbaltimore(a)protonmail.com>, 2019 # walking <walking(a)i2pmail.org>, 2021 # erinm, 2021 -# Matburnx <matboury(a)gmail.com>, 2021 # Yann Forget <yannfo(a)gmail.com>, 2021 # PoorPockets McNewHold <poorpocketsmcnewhold(a)protonmail.ch>, 2021 # AO <ao(a)localizationlab.org>, 2021 # Emma Peel, 2021 +# Matburnx <matboury(a)gmail.com>, 2021 # msgid "" msgstr "" @@ -17,7 +17,7 @@ msgstr "" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-10-28 13:28+CET\n" "PO-Revision-Date: 2019-03-09 10:41+0000\n" -"Last-Translator: Emma Peel, 2021\n" +"Last-Translator: Matburnx <matboury(a)gmail.com>, 2021\n" "Language-Team: French (https://www.transifex.com/otf/teams/1519/fr/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -753,12 +753,12 @@ msgstr "" #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.title) msgid "Tor Browser 10.5" -msgstr "" +msgstr "Navigateur Tor 10.5" #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.body) msgid "## New Release: Tor Browser 10.5" -msgstr "" +msgstr "## Nouvelle version : Navigateur Tor 10.5" #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.body) @@ -796,12 +796,12 @@ msgstr "" #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.body) msgid "### What's new?" -msgstr "" +msgstr "### Quelles sont les nouveautés ?" #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.body) msgid "#### V2 Onion Services Deprecation" -msgstr "" +msgstr "#### L'abandon des services oignon V2" #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.body) @@ -810,6 +810,9 @@ msgid "" "timeline), v2 onion services will be completely unreachable once Tor Browser" " moves to Tor 0.4.6.x in October 2021." msgstr "" +"Comme [annoncé l'an dernier](https://blog.torproject.org/v2-deprecation-" +"timeline), les services oignon v2 seront complétement inaccessibles une fois" +" que le Navigateur Tor utilisera Tor 0.4.6.x en octobre 2021." #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.body) @@ -817,6 +820,8 @@ msgid "" "From now until then, Tor Browser will warn you when visiting a v2 onion site" " of its upcoming deprecation." msgstr "" +"D'ici là, le Navigateur Tor vous avertira de son futur abandon lorsque vous " +"visiterez un site oignon v2." #: https//www.torproject.org/releases/tor-browser-10-5/ #: (content/releases/tor-browser-10-5/contents+en.lrpage.body)

1 0

[translation/tbmanual-contentspot] https://gitweb.torproject.org/translation.git/commit/?h=tbmanual-contentspot
by translation＠torproject.org 28 Oct '21

28 Oct '21

commit 79820111b6b0d6601506fe28541cea7665a8887e Author: Translation commit bot <translation(a)torproject.org> Date: Thu Oct 28 14:17:21 2021 +0000 https://gitweb.torproject.org/translation.git/commit/?h=tbmanual-contentspot --- contents+fr.po | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents+fr.po b/contents+fr.po index 4cf259a131..eece0071a1 100644 --- a/contents+fr.po +++ b/contents+fr.po @@ -827,7 +827,7 @@ msgstr "" #: https//tb-manual.torproject.org/installation/ #: (content/installation/contents+en.lrtopic.body) msgid "See here on how to [update Tor Browser](../updating/)." -msgstr "" +msgstr "Voir ici comment [mettre à jour le Navigateur Tor](../fr/updating/)." #: https//tb-manual.torproject.org/running-tor-browser/ #: (content/running-tor-browser/contents+en.lrtopic.title)

1 0

[translation/communitytpo-contentspot] https://gitweb.torproject.org/translation.git/commit/?h=communitytpo-contentspot
by translation＠torproject.org 28 Oct '21

28 Oct '21

commit 7825853204019554f9342df593761099e6b8e98b Author: Translation commit bot <translation(a)torproject.org> Date: Thu Oct 28 14:15:17 2021 +0000 https://gitweb.torproject.org/translation.git/commit/?h=communitytpo-conten… --- contents+id.po | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/contents+id.po b/contents+id.po index e6a8405fa1..3aa2677c9d 100644 --- a/contents+id.po +++ b/contents+id.po @@ -16,8 +16,8 @@ # raz <razmawardhana(a)gmail.com>, 2021 # erinm, 2021 # ical, 2021 -# hadymaggot <9hs(a)tuta.io>, 2021 # Emma Peel, 2021 +# hadymaggot <9hs(a)tuta.io>, 2021 # msgid "" msgstr "" @@ -25,7 +25,7 @@ msgstr "" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-10-26 18:39+CET\n" "PO-Revision-Date: 2019-12-11 10:50+0000\n" -"Last-Translator: Emma Peel, 2021\n" +"Last-Translator: hadymaggot <9hs(a)tuta.io>, 2021\n" "Language-Team: Indonesian (https://www.transifex.com/otf/teams/1519/id/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -18898,7 +18898,7 @@ msgstr "Donasi Anda akan dicocokkan oleh Friends of Tor hingga $100,000." #: lego/templates/banner.html:31 lego/templates/banner.html:33 #: templates/banner.html:31 templates/banner.html:33 msgid "Donate now" -msgstr "" +msgstr "Donasi Sekarang" #: lego/templates/footer.html:13 lego/templates/footer.html:22 #: lego/templates/navbar.html:96 templates/footer.html:13

1 0

[translation/abouttor-homepage] https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage
by translation＠torproject.org 28 Oct '21

28 Oct '21

commit 85739e307950a32092d05af0549c42f61f8592ac Author: Translation commit bot <translation(a)torproject.org> Date: Thu Oct 28 14:15:02 2021 +0000 https://gitweb.torproject.org/translation.git/commit/?h=abouttor-homepage --- pl/aboutTor.dtd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pl/aboutTor.dtd b/pl/aboutTor.dtd index af33f2e077..6750b26001 100644 --- a/pl/aboutTor.dtd +++ b/pl/aboutTor.dtd @@ -47,7 +47,7 @@ Thank you! --> -<!ENTITY aboutTor.yec.slogan "HANDS\nOFF\nMY\nDATA"> +<!ENTITY aboutTor.yec.slogan "RĘCE\nPRECZ\nOD\nMOICH\nDANYCH"> <!ENTITY aboutTor.yec.motto "Prawo do prywatności jest prawem człowieka. "> <!-- LOCALIZATION NOTE (aboutTor.yec.donationMatch): Please translate the 'Friends of Tor' phrase, but also format it like the name of an organization in whichever way that is appropriate for your locale.

1 0

[snowflake/main] Comment package and minor changes exports
by cohosh＠torproject.org 28 Oct '21

28 Oct '21

commit 84e8a183e59d0e4cea3dd572e87a221379d968f9 Author: Cecylia Bocovich <cohosh(a)torproject.org> Date: Tue Oct 26 15:10:59 2021 -0400 Comment package and minor changes exports --- proxy/lib/proxy-go_test.go | 2 +- proxy/lib/snowflake.go | 36 +++++++++++++++++++++++++++++------- proxy/lib/tokens.go | 2 +- proxy/lib/tokens_test.go | 2 +- proxy/lib/util.go | 2 +- proxy/lib/webrtcconn.go | 2 +- proxy/main.go | 26 ++++++++++++++------------ 7 files changed, 48 insertions(+), 24 deletions(-) diff --git a/proxy/lib/proxy-go_test.go b/proxy/lib/proxy-go_test.go index af71648..3a81a1b 100644 --- a/proxy/lib/proxy-go_test.go +++ b/proxy/lib/proxy-go_test.go @@ -1,4 +1,4 @@ -package snowflake +package snowflake_proxy import ( "bytes" diff --git a/proxy/lib/snowflake.go b/proxy/lib/snowflake.go index 793fa2b..85f86b2 100644 --- a/proxy/lib/snowflake.go +++ b/proxy/lib/snowflake.go @@ -1,4 +1,27 @@ -package snowflake +/* +Package snowflake_proxy provides functionality for creating, starting, and stopping a snowflake +proxy. + +To run a proxy, you must first create a proxy configuration + + proxy := snowflake_proxy.SnowflakeProxy{ + BrokerURL: "https://snowflake-broker.example.com", + STUNURL: "stun:stun.stunprotocol.org:3478", + // ... + } + +You may then start and stop the proxy. Stopping the proxy will close existing connections and +the proxy will not poll for more clients. + + go func() { + proxy.Start() + } + + // ... + + proxy.Stop() +*/ +package snowflake_proxy import ( "bytes" @@ -76,11 +99,10 @@ var ( // Snowflake in another Go application. type SnowflakeProxy struct { Capacity uint - StunURL string - RawBrokerURL string + STUNURL string + BrokerURL string KeepLocalAddresses bool RelayURL string - LogOutput io.Writer shutdown chan struct{} } @@ -475,12 +497,12 @@ func (sf *SnowflakeProxy) Start() { log.Println("starting") var err error - broker, err = newSignalingServer(sf.RawBrokerURL, sf.KeepLocalAddresses) + broker, err = newSignalingServer(sf.BrokerURL, sf.KeepLocalAddresses) if err != nil { log.Fatal(err) } - _, err = url.Parse(sf.StunURL) + _, err = url.Parse(sf.STUNURL) if err != nil { log.Fatalf("invalid stun url: %s", err) } @@ -492,7 +514,7 @@ func (sf *SnowflakeProxy) Start() { config = webrtc.Configuration{ ICEServers: []webrtc.ICEServer{ { - URLs: []string{sf.StunURL}, + URLs: []string{sf.STUNURL}, }, }, } diff --git a/proxy/lib/tokens.go b/proxy/lib/tokens.go index 1331778..d312ecf 100644 --- a/proxy/lib/tokens.go +++ b/proxy/lib/tokens.go @@ -1,4 +1,4 @@ -package snowflake +package snowflake_proxy import ( "sync/atomic" diff --git a/proxy/lib/tokens_test.go b/proxy/lib/tokens_test.go index 702a887..4393a21 100644 --- a/proxy/lib/tokens_test.go +++ b/proxy/lib/tokens_test.go @@ -1,4 +1,4 @@ -package snowflake +package snowflake_proxy import ( "testing" diff --git a/proxy/lib/util.go b/proxy/lib/util.go index 2df23eb..5055187 100644 --- a/proxy/lib/util.go +++ b/proxy/lib/util.go @@ -1,4 +1,4 @@ -package snowflake +package snowflake_proxy import ( "fmt" diff --git a/proxy/lib/webrtcconn.go b/proxy/lib/webrtcconn.go index 20b1172..6e16bec 100644 --- a/proxy/lib/webrtcconn.go +++ b/proxy/lib/webrtcconn.go @@ -1,4 +1,4 @@ -package snowflake +package snowflake_proxy import ( "fmt" diff --git a/proxy/main.go b/proxy/main.go index 12b3752..aabac51 100644 --- a/proxy/main.go +++ b/proxy/main.go @@ -7,42 +7,44 @@ import ( "os" "git.torproject.org/pluggable-transports/snowflake.git/common/safelog" - "git.torproject.org/pluggable-transports/snowflake.git/proxy/lib" + sf "git.torproject.org/pluggable-transports/snowflake.git/proxy/lib" ) func main() { capacity := flag.Int("capacity", 10, "maximum concurrent clients") - stunURL := flag.String("stun", snowflake.DefaultSTUNURL, "broker URL") + stunURL := flag.String("stun", sf.DefaultSTUNURL, "broker URL") logFilename := flag.String("log", "", "log filename") - rawBrokerURL := flag.String("broker", snowflake.DefaultBrokerURL, "broker URL") + rawBrokerURL := flag.String("broker", sf.DefaultBrokerURL, "broker URL") unsafeLogging := flag.Bool("unsafe-logging", false, "prevent logs from being scrubbed") keepLocalAddresses := flag.Bool("keep-local-addresses", false, "keep local LAN address ICE candidates") - relayURL := flag.String("relay", snowflake.DefaultRelayURL, "websocket relay URL") + relayURL := flag.String("relay", sf.DefaultRelayURL, "websocket relay URL") flag.Parse() - sf := snowflake.SnowflakeProxy{ + proxy := sf.SnowflakeProxy{ Capacity: uint(*capacity), - StunURL: *stunURL, - RawBrokerURL: *rawBrokerURL, + STUNURL: *stunURL, + BrokerURL: *rawBrokerURL, KeepLocalAddresses: *keepLocalAddresses, RelayURL: *relayURL, - LogOutput: os.Stderr, } + var logOutput io.Writer = os.Stderr + log.SetFlags(log.LstdFlags | log.LUTC) + if *logFilename != "" { f, err := os.OpenFile(*logFilename, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600) if err != nil { log.Fatal(err) } defer f.Close() - sf.LogOutput = io.MultiWriter(os.Stderr, f) + logOutput = io.MultiWriter(os.Stderr, f) } if *unsafeLogging { - log.SetOutput(sf.LogOutput) + log.SetOutput(logOutput) } else { - log.SetOutput(&safelog.LogScrubber{Output: sf.LogOutput}) + log.SetOutput(&safelog.LogScrubber{Output: logOutput}) } - sf.Start() + proxy.Start() }

1 0

[snowflake/main] Export ability to change the URL of NAT probe
by cohosh＠torproject.org 28 Oct '21

28 Oct '21

commit 0a2598a1e854243b2f69dae05d713260b4816098 Author: Cecylia Bocovich <cohosh(a)torproject.org> Date: Tue Oct 26 15:43:36 2021 -0400 Export ability to change the URL of NAT probe --- proxy/lib/snowflake.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/proxy/lib/snowflake.go b/proxy/lib/snowflake.go index 734657a..5f7bfd4 100644 --- a/proxy/lib/snowflake.go +++ b/proxy/lib/snowflake.go @@ -49,7 +49,7 @@ import ( const DefaultBrokerURL = "https://snowflake-broker.torproject.net/" -const DefaultProbeURL = "https://snowflake-broker.torproject.net:8443/probe" +const DefaultNATProbeURL = "https://snowflake-broker.torproject.net:8443/probe" const DefaultRelayURL = "wss://snowflake.bamsoftware.com/" @@ -99,7 +99,9 @@ type SnowflakeProxy struct { KeepLocalAddresses bool // RelayURL is the URL of the Snowflake server that all traffic will be relayed to RelayURL string - shutdown chan struct{} + // NATProbeURL is the URL of the probe service we use for NAT checks + NATProbeURL string + shutdown chan struct{} } // Checks whether an IP address is a remote address for the client @@ -499,6 +501,9 @@ func (sf *SnowflakeProxy) Start() error { if sf.STUNURL == "" { sf.STUNURL = DefaultSTUNURL } + if sf.NATProbeURL == "" { + sf.NATProbeURL = DefaultNATProbeURL + } broker, err = newSignalingServer(sf.BrokerURL, sf.KeepLocalAddresses) if err != nil { @@ -524,7 +529,7 @@ func (sf *SnowflakeProxy) Start() error { tokens = newTokens(sf.Capacity) // use probetest to determine NAT compatability - sf.checkNATType(config, DefaultProbeURL) + sf.checkNATType(config, sf.NATProbeURL) log.Printf("NAT type: %s", currentNATType) ticker := time.NewTicker(pollInterval)

1 0

[snowflake/main] Modify handling of misconfigurations and defaults
by cohosh＠torproject.org 28 Oct '21

28 Oct '21

commit 3caa83d84de681b3cd38f4c61cfef2e9bd091176 Author: Cecylia Bocovich <cohosh(a)torproject.org> Date: Tue Oct 26 15:40:32 2021 -0400 Modify handling of misconfigurations and defaults --- proxy/lib/snowflake.go | 34 ++++++++++++++++++++-------------- proxy/main.go | 8 ++++++-- 2 files changed, 26 insertions(+), 16 deletions(-) diff --git a/proxy/lib/snowflake.go b/proxy/lib/snowflake.go index bd50dc8..734657a 100644 --- a/proxy/lib/snowflake.go +++ b/proxy/lib/snowflake.go @@ -15,7 +15,8 @@ You may then start and stop the proxy. Stopping the proxy will close existing co the proxy will not poll for more clients. go func() { - proxy.Start() + err := proxy.Start() + // handle error } // ... @@ -46,16 +47,12 @@ import ( "github.com/pion/webrtc/v3" ) -// DefaultBrokerURL is the snowflake broker run at https://snowflake-broker.torproject.net const DefaultBrokerURL = "https://snowflake-broker.torproject.net/" -// DefaultProbeURL is run at https://snowflake-broker.torproject.net:8443/probe const DefaultProbeURL = "https://snowflake-broker.torproject.net:8443/probe" -// DefaultRelayURL is run at wss://snowflake.torproject.net const DefaultRelayURL = "wss://snowflake.bamsoftware.com/" -// DefaultSTUNURL is run at stun:stun.stunprotocol.org:3478 const DefaultSTUNURL = "stun:stun.stunprotocol.org:3478" const pollInterval = 5 * time.Second @@ -486,27 +483,35 @@ func (sf *SnowflakeProxy) runSession(sid string) { // Start configures and starts a Snowflake, fully formed and special. Configuration // values that are unset will default to their corresponding default values. -func (sf *SnowflakeProxy) Start() { +func (sf *SnowflakeProxy) Start() error { + var err error + log.Println("starting") sf.shutdown = make(chan struct{}) - log.SetFlags(log.LstdFlags | log.LUTC) - - log.Println("starting") + // blank configurations revert to default + if sf.BrokerURL == "" { + sf.BrokerURL = DefaultBrokerURL + } + if sf.RelayURL == "" { + sf.RelayURL = DefaultRelayURL + } + if sf.STUNURL == "" { + sf.STUNURL = DefaultSTUNURL + } - var err error broker, err = newSignalingServer(sf.BrokerURL, sf.KeepLocalAddresses) if err != nil { - log.Fatal(err) + return fmt.Errorf("error configuring broker: %s", err) } _, err = url.Parse(sf.STUNURL) if err != nil { - log.Fatalf("invalid stun url: %s", err) + return fmt.Errorf("invalid stun url: %s", err) } _, err = url.Parse(sf.RelayURL) if err != nil { - log.Fatalf("invalid relay url: %s", err) + return fmt.Errorf("invalid relay url: %s", err) } config = webrtc.Configuration{ @@ -528,13 +533,14 @@ func (sf *SnowflakeProxy) Start() { for ; true; <-ticker.C { select { case <-sf.shutdown: - return + return nil default: tokens.get() sessionID := genSessionID() sf.runSession(sessionID) } } + return nil } // Stop closes all existing connections and shuts down the Snowflake. diff --git a/proxy/main.go b/proxy/main.go index aabac51..368589c 100644 --- a/proxy/main.go +++ b/proxy/main.go @@ -11,7 +11,7 @@ import ( ) func main() { - capacity := flag.Int("capacity", 10, "maximum concurrent clients") + capacity := flag.Uint("capacity", 0, "maximum concurrent clients") stunURL := flag.String("stun", sf.DefaultSTUNURL, "broker URL") logFilename := flag.String("log", "", "log filename") rawBrokerURL := flag.String("broker", sf.DefaultBrokerURL, "broker URL") @@ -32,6 +32,7 @@ func main() { var logOutput io.Writer = os.Stderr log.SetFlags(log.LstdFlags | log.LUTC) + log.SetFlags(log.LstdFlags | log.LUTC) if *logFilename != "" { f, err := os.OpenFile(*logFilename, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600) if err != nil { @@ -46,5 +47,8 @@ func main() { log.SetOutput(&safelog.LogScrubber{Output: logOutput}) } - proxy.Start() + err := proxy.Start() + if err != nil { + log.Fatal(err) + } }

1 0

[snowflake/main] Remove BytesLoggers from exported functions
by cohosh＠torproject.org 28 Oct '21

28 Oct '21

commit b2edf948e21c2420d3b3696c680856f106dae9f4 Author: Cecylia Bocovich <cohosh(a)torproject.org> Date: Tue Oct 26 14:52:17 2021 -0400 Remove BytesLoggers from exported functions --- proxy/lib/snowflake.go | 2 +- proxy/lib/util.go | 40 ++++++++++++++++++++-------------------- proxy/lib/webrtcconn.go | 2 +- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/proxy/lib/snowflake.go b/proxy/lib/snowflake.go index e35eabd..793fa2b 100644 --- a/proxy/lib/snowflake.go +++ b/proxy/lib/snowflake.go @@ -306,7 +306,7 @@ func (sf *SnowflakeProxy) makePeerConnectionFromOffer(sdp *webrtc.SessionDescrip pr, pw := io.Pipe() conn := &webRTCConn{pc: pc, dc: dc, pr: pr} - conn.bytesLogger = NewBytesSyncLogger() + conn.bytesLogger = newBytesSyncLogger() dc.OnOpen(func() { log.Println("OnOpen channel") diff --git a/proxy/lib/util.go b/proxy/lib/util.go index c6613d9..2df23eb 100644 --- a/proxy/lib/util.go +++ b/proxy/lib/util.go @@ -5,37 +5,37 @@ import ( "time" ) -// BytesLogger is an interface which is used to allow logging the throughput -// of the Snowflake. A default BytesLogger(BytesNullLogger) does nothing. -type BytesLogger interface { +// bytesLogger is an interface which is used to allow logging the throughput +// of the Snowflake. A default bytesLogger(bytesNullLogger) does nothing. +type bytesLogger interface { AddOutbound(int) AddInbound(int) ThroughputSummary() string } -// BytesNullLogger Default BytesLogger does nothing. -type BytesNullLogger struct{} +// bytesNullLogger Default bytesLogger does nothing. +type bytesNullLogger struct{} -// AddOutbound in BytesNullLogger does nothing -func (b BytesNullLogger) AddOutbound(amount int) {} +// AddOutbound in bytesNullLogger does nothing +func (b bytesNullLogger) AddOutbound(amount int) {} -// AddInbound in BytesNullLogger does nothing -func (b BytesNullLogger) AddInbound(amount int) {} +// AddInbound in bytesNullLogger does nothing +func (b bytesNullLogger) AddInbound(amount int) {} -// ThroughputSummary in BytesNullLogger does nothing -func (b BytesNullLogger) ThroughputSummary() string { return "" } +// ThroughputSummary in bytesNullLogger does nothing +func (b bytesNullLogger) ThroughputSummary() string { return "" } -// BytesSyncLogger uses channels to safely log from multiple sources with output +// bytesSyncLogger uses channels to safely log from multiple sources with output // occuring at reasonable intervals. -type BytesSyncLogger struct { +type bytesSyncLogger struct { outboundChan, inboundChan chan int outbound, inbound, outEvents, inEvents int start time.Time } -// NewBytesSyncLogger returns a new BytesSyncLogger and starts it loggin. -func NewBytesSyncLogger() *BytesSyncLogger { - b := &BytesSyncLogger{ +// newBytesSyncLogger returns a new bytesSyncLogger and starts it loggin. +func newBytesSyncLogger() *bytesSyncLogger { + b := &bytesSyncLogger{ outboundChan: make(chan int, 5), inboundChan: make(chan int, 5), } @@ -44,7 +44,7 @@ func NewBytesSyncLogger() *BytesSyncLogger { return b } -func (b *BytesSyncLogger) log() { +func (b *bytesSyncLogger) log() { for { select { case amount := <-b.outboundChan: @@ -58,17 +58,17 @@ func (b *BytesSyncLogger) log() { } // AddOutbound add a number of bytes to the outbound total reported by the logger -func (b *BytesSyncLogger) AddOutbound(amount int) { +func (b *bytesSyncLogger) AddOutbound(amount int) { b.outboundChan <- amount } // AddInbound add a number of bytes to the inbound total reported by the logger -func (b *BytesSyncLogger) AddInbound(amount int) { +func (b *bytesSyncLogger) AddInbound(amount int) { b.inboundChan <- amount } // ThroughputSummary view a formatted summary of the throughput totals -func (b *BytesSyncLogger) ThroughputSummary() string { +func (b *bytesSyncLogger) ThroughputSummary() string { var inUnit, outUnit string units := []string{"B", "KB", "MB", "GB"} diff --git a/proxy/lib/webrtcconn.go b/proxy/lib/webrtcconn.go index 5c6192b..20b1172 100644 --- a/proxy/lib/webrtcconn.go +++ b/proxy/lib/webrtcconn.go @@ -29,7 +29,7 @@ type webRTCConn struct { lock sync.Mutex // Synchronization for DataChannel destruction once sync.Once // Synchronization for PeerConnection destruction - bytesLogger BytesLogger + bytesLogger bytesLogger } func (c *webRTCConn) Read(b []byte) (int, error) {

1 0

[snowflake/main] Update comments for exported items
by cohosh＠torproject.org 28 Oct '21

28 Oct '21

commit 0e8d41ba4b694b334775fcd9f4330d9b5b31e85c Author: Cecylia Bocovich <cohosh(a)torproject.org> Date: Tue Oct 26 15:28:27 2021 -0400 Update comments for exported items --- proxy/lib/snowflake.go | 46 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/proxy/lib/snowflake.go b/proxy/lib/snowflake.go index 85f86b2..bd50dc8 100644 --- a/proxy/lib/snowflake.go +++ b/proxy/lib/snowflake.go @@ -2,7 +2,8 @@ Package snowflake_proxy provides functionality for creating, starting, and stopping a snowflake proxy. -To run a proxy, you must first create a proxy configuration +To run a proxy, you must first create a proxy configuration. Unconfigured fields +will be set to the defined defaults. proxy := snowflake_proxy.SnowflakeProxy{ BrokerURL: "https://snowflake-broker.example.com", @@ -45,24 +46,16 @@ import ( "github.com/pion/webrtc/v3" ) -// DefaultBrokerURL is the bamsoftware.com broker, https://snowflake-broker.bamsoftware.com -// Changing this will change the default broker. The recommended way of changing -// the broker that gets used is by passing an argument to Main. -const DefaultBrokerURL = "https://snowflake-broker.bamsoftware.com/" +// DefaultBrokerURL is the snowflake broker run at https://snowflake-broker.torproject.net +const DefaultBrokerURL = "https://snowflake-broker.torproject.net/" -// DefaultProbeURL is the torproject.org ProbeURL, https://snowflake-broker.torproject.net:8443/probe -// Changing this will change the default Probe URL. The recommended way of changing -// the probe that gets used is by passing an argument to Main. +// DefaultProbeURL is run at https://snowflake-broker.torproject.net:8443/probe const DefaultProbeURL = "https://snowflake-broker.torproject.net:8443/probe" -// DefaultRelayURL is the bamsoftware.com Websocket Relay, wss://snowflake.bamsoftware.com/ -// Changing this will change the default Relay URL. The recommended way of changing -// the relay that gets used is by passing an argument to Main. +// DefaultRelayURL is run at wss://snowflake.torproject.net const DefaultRelayURL = "wss://snowflake.bamsoftware.com/" -// DefaultSTUNURL is a stunprotocol.org STUN URL. stun:stun.stunprotocol.org:3478 -// Changing this will change the default STUN URL. The recommended way of changing -// the STUN Server that gets used is by passing an argument to Main. +// DefaultSTUNURL is run at stun:stun.stunprotocol.org:3478 const DefaultSTUNURL = "stun:stun.stunprotocol.org:3478" const pollInterval = 5 * time.Second @@ -95,15 +88,21 @@ var ( client http.Client ) -// SnowflakeProxy is a structure which is used to configure an embedded +// SnowflakeProxy is used to configure an embedded // Snowflake in another Go application. type SnowflakeProxy struct { - Capacity uint - STUNURL string - BrokerURL string + // Capacity is the maximum number of clients a Snowflake will serve. + // Proxies with a capacity of 0 will accept an unlimited number of clients. + Capacity uint + // STUNURL is the URL of the STUN server the proxy will use + STUNURL string + // BrokerURL is the URL of the Snowflake broker + BrokerURL string + // KeepLocalAddresses indicates whether local SDP candidates will be sent to the broker KeepLocalAddresses bool - RelayURL string - shutdown chan struct{} + // RelayURL is the URL of the Snowflake server that all traffic will be relayed to + RelayURL string + shutdown chan struct{} } // Checks whether an IP address is a remote address for the client @@ -485,9 +484,8 @@ func (sf *SnowflakeProxy) runSession(sid string) { } } -// Start configures and starts a Snowflake, fully formed and special. In the -// case of an empty map, defaults are configured automatically and can be -// found in the GoDoc and in main.go +// Start configures and starts a Snowflake, fully formed and special. Configuration +// values that are unset will default to their corresponding default values. func (sf *SnowflakeProxy) Start() { sf.shutdown = make(chan struct{}) @@ -539,7 +537,7 @@ func (sf *SnowflakeProxy) Start() { } } -// Stop calls close on the sf.shutdown channel shutting down the Snowflake. +// Stop closes all existing connections and shuts down the Snowflake. func (sf *SnowflakeProxy) Stop() { close(sf.shutdown) }

1 0