January 2022 - tor-commits - lists.torproject.org

[snowflake/main] Add Event Bus Test
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit b5ef18803f08364db15ba66b0189371d5e79d821 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Fri Nov 26 16:24:21 2021 +0000 Add Event Bus Test --- common/event/bus_test.go | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/common/event/bus_test.go b/common/event/bus_test.go new file mode 100644 index 0000000..df40d3d --- /dev/null +++ b/common/event/bus_test.go @@ -0,0 +1,32 @@ +package event + +import ( + "github.com/stretchr/testify/assert" + "testing" +) + +type stubReceiver struct { + counter int +} + +func (s *stubReceiver) OnNewSnowflakeEvent(event SnowflakeEvent) { + s.counter++ +} + +func TestBusDispatch(t *testing.T) { + EventBus := NewSnowflakeEventDispatcher() + StubReceiverA := &stubReceiver{} + StubReceiverB := &stubReceiver{} + EventBus.AddSnowflakeEventListener(StubReceiverA) + EventBus.AddSnowflakeEventListener(StubReceiverB) + assert.Equal(t, 0, StubReceiverA.counter) + assert.Equal(t, 0, StubReceiverB.counter) + EventBus.OnNewSnowflakeEvent(EventOnSnowflakeConnected{}) + assert.Equal(t, 1, StubReceiverA.counter) + assert.Equal(t, 1, StubReceiverB.counter) + EventBus.RemoveSnowflakeEventListener(StubReceiverB) + EventBus.OnNewSnowflakeEvent(EventOnSnowflakeConnected{}) + assert.Equal(t, 2, StubReceiverA.counter) + assert.Equal(t, 1, StubReceiverB.counter) + +}

1 0

[snowflake/main] Add Snowflake Event Reporter for Broker Communication
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit c3f09994daa5a512a6d6cea026aeb15162d5d866 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 14:10:06 2021 +0000 Add Snowflake Event Reporter for Broker Communication --- client/lib/webrtc.go | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/client/lib/webrtc.go b/client/lib/webrtc.go index f4b775c..3b496d0 100644 --- a/client/lib/webrtc.go +++ b/client/lib/webrtc.go @@ -9,6 +9,7 @@ import ( "sync" "time" + "git.torproject.org/pluggable-transports/snowflake.git/v2/common/event" "github.com/pion/webrtc/v3" ) @@ -31,7 +32,8 @@ type WebRTCPeer struct { once sync.Once // Synchronization for PeerConnection destruction - bytesLogger bytesLogger + bytesLogger bytesLogger + eventsLogger event.SnowflakeEventReceiver } // NewWebRTCPeer constructs a WebRTC PeerConnection to a snowflake proxy. @@ -131,10 +133,21 @@ func (c *WebRTCPeer) connect(config *webrtc.Configuration, broker *BrokerChannel log.Println(c.id, " connecting...") // TODO: When go-webrtc is more stable, it's possible that a new // PeerConnection won't need to be re-prepared each time. - if err := c.preparePeerConnection(config); err != nil { + err := c.preparePeerConnection(config) + localDescription := c.pc.LocalDescription() + c.eventsLogger.OnNewSnowflakeEvent(event.EventOnOfferCreated{ + WebRTCLocalDescription: localDescription, + Error: err, + }) + if err != nil { return err } - answer, err := broker.Negotiate(c.pc.LocalDescription()) + + answer, err := broker.Negotiate(localDescription) + c.eventsLogger.OnNewSnowflakeEvent(event.EventOnBrokerRendezvous{ + WebRTCRemoteDescription: answer, + Error: err, + }) if err != nil { return err }

1 0

[snowflake/main] Add snowflake event handler to client config
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit cd6d837d85bb915d77bf122a82bb161c9d68cf20 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Nov 29 12:46:51 2021 +0000 Add snowflake event handler to client config --- client/lib/snowflake.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/client/lib/snowflake.go b/client/lib/snowflake.go index 56dd312..fdcb457 100644 --- a/client/lib/snowflake.go +++ b/client/lib/snowflake.go @@ -35,6 +35,7 @@ import ( "strings" "time" + "git.torproject.org/pluggable-transports/snowflake.git/v2/common/event" "git.torproject.org/pluggable-transports/snowflake.git/v2/common/nat" "git.torproject.org/pluggable-transports/snowflake.git/v2/common/turbotunnel" "github.com/pion/webrtc/v3" @@ -92,6 +93,9 @@ type ClientConfig struct { // Max is the maximum number of snowflake proxy peers that the client should attempt to // connect to. Defaults to 1. Max int + // EventDispatcher is the event bus for snowflake events. + // When an important event happens, it will be distributed here. + EventDispatcher event.SnowflakeEventDispatcher } // NewSnowflakeClient creates a new Snowflake transport client that can spawn multiple

1 0

[snowflake/main] Add NewWebRTCPeer3E Initializer
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 36ca610d6bf399a1cf6e6d35cec8e57e6eddf6b4 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 15:05:38 2021 +0000 Add NewWebRTCPeer3E Initializer This name includes [E]vent to reduce merge conflict with forward proxy change set. --- client/lib/webrtc.go | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/client/lib/webrtc.go b/client/lib/webrtc.go index 4068eb8..01b85f5 100644 --- a/client/lib/webrtc.go +++ b/client/lib/webrtc.go @@ -36,13 +36,22 @@ type WebRTCPeer struct { eventsLogger event.SnowflakeEventReceiver } -// NewWebRTCPeer constructs a WebRTC PeerConnection to a snowflake proxy. +func NewWebRTCPeer(config *webrtc.Configuration, + broker *BrokerChannel) (*WebRTCPeer, error) { + return NewWebRTCPeer3E(config, broker, nil) +} + +// NewWebRTCPeer3E constructs a WebRTC PeerConnection to a snowflake proxy. // // The creation of the peer handles the signaling to the Snowflake broker, including // the exchange of SDP information, the creation of a PeerConnection, and the establishment // of a DataChannel to the Snowflake proxy. -func NewWebRTCPeer(config *webrtc.Configuration, - broker *BrokerChannel) (*WebRTCPeer, error) { +func NewWebRTCPeer3E(config *webrtc.Configuration, + broker *BrokerChannel, eventsLogger event.SnowflakeEventReceiver) (*WebRTCPeer, error) { + if eventsLogger == nil { + eventsLogger = event.NewSnowflakeEventDispatcher() + } + connection := new(WebRTCPeer) { var buf [8]byte @@ -59,6 +68,8 @@ func NewWebRTCPeer(config *webrtc.Configuration, // Pipes remain the same even when DataChannel gets switched. connection.recvPipe, connection.writePipe = io.Pipe() + connection.eventsLogger = eventsLogger + err := connection.connect(config, broker) if err != nil { connection.Close()

1 0

[snowflake/main] Add PT Event Logger
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit ac64d17705a48cb6ace310503e14b62c629655d6 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 15:39:59 2021 +0000 Add PT Event Logger --- client/lib/pt_event_logger.go | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/client/lib/pt_event_logger.go b/client/lib/pt_event_logger.go new file mode 100644 index 0000000..b183005 --- /dev/null +++ b/client/lib/pt_event_logger.go @@ -0,0 +1,43 @@ +package snowflake_client + +import ( + "fmt" + + pt "git.torproject.org/pluggable-transports/goptlib.git" + "git.torproject.org/pluggable-transports/snowflake.git/v2/common/event" +) + +func NewPTEventLogger() event.SnowflakeEventReceiver { + return &ptEventLogger{} +} + +type ptEventLogger struct { +} + +func (p ptEventLogger) OnNewSnowflakeEvent(e event.SnowflakeEvent) { + switch e.(type) { + case event.EventOnOfferCreated: + e := e.(event.EventOnOfferCreated) + if e.Error != nil { + pt.Log(pt.LogSeverityError, fmt.Sprintf("offer creation failure %v", e.Error.Error())) + } else { + pt.Log(pt.LogSeverityNotice, fmt.Sprintf("offer created %v", e.WebRTCLocalDescription)) + } + + case event.EventOnBrokerRendezvous: + e := e.(event.EventOnBrokerRendezvous) + if e.Error != nil { + pt.Log(pt.LogSeverityError, fmt.Sprintf("broker failure %v", e.Error.Error())) + } else { + pt.Log(pt.LogSeverityNotice, fmt.Sprintf("broker rendezvous peer %v", e.WebRTCRemoteDescription)) + } + + case event.EventOnSnowflakeConnected: + pt.Log(pt.LogSeverityNotice, fmt.Sprintf("connected")) + + case event.EventOnSnowflakeConnectionFailed: + e := e.(event.EventOnSnowflakeConnectionFailed) + pt.Log(pt.LogSeverityError, fmt.Sprintf("connection failed %v", e.Error.Error())) + } + +}

1 0

[snowflake/main] Add Snowflake Event Reporter for Peer Communication
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 9a7fcdec03b3bda87a4f1269558816513ce79f66 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 14:25:41 2021 +0000 Add Snowflake Event Reporter for Peer Communication --- client/lib/webrtc.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/client/lib/webrtc.go b/client/lib/webrtc.go index 3b496d0..4068eb8 100644 --- a/client/lib/webrtc.go +++ b/client/lib/webrtc.go @@ -191,6 +191,7 @@ func (c *WebRTCPeer) preparePeerConnection(config *webrtc.Configuration) error { return err } dc.OnOpen(func() { + c.eventsLogger.OnNewSnowflakeEvent(&event.EventOnSnowflakeConnected{}) log.Println("WebRTC: DataChannel.OnOpen") close(c.open) }) @@ -198,6 +199,9 @@ func (c *WebRTCPeer) preparePeerConnection(config *webrtc.Configuration) error { log.Println("WebRTC: DataChannel.OnClose") c.Close() }) + dc.OnError(func(err error) { + c.eventsLogger.OnNewSnowflakeEvent(&event.EventOnSnowflakeConnectionFailed{Error: err}) + }) dc.OnMessage(func(msg webrtc.DataChannelMessage) { if len(msg.Data) <= 0 { log.Println("0 length message---")

1 0

[snowflake/main] Enable PT Event Logger
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 128936c82514f4c5511e3861a220e57b11a90cc6 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 15:45:04 2021 +0000 Enable PT Event Logger --- client/snowflake.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/client/snowflake.go b/client/snowflake.go index d76efbf..0ab71a7 100644 --- a/client/snowflake.go +++ b/client/snowflake.go @@ -17,6 +17,7 @@ import ( pt "git.torproject.org/pluggable-transports/goptlib.git" sf "git.torproject.org/pluggable-transports/snowflake.git/v2/client/lib" + "git.torproject.org/pluggable-transports/snowflake.git/v2/common/event" "git.torproject.org/pluggable-transports/snowflake.git/v2/common/safelog" ) @@ -170,6 +171,10 @@ func main() { iceAddresses := strings.Split(strings.TrimSpace(*iceServersCommas), ",") + eventLogger := event.NewSnowflakeEventDispatcher() + + eventLogger.AddSnowflakeEventListener(sf.NewPTEventLogger()) + config := sf.ClientConfig{ BrokerURL: *brokerURL, AmpCacheURL: *ampCacheURL, @@ -177,6 +182,7 @@ func main() { ICEAddresses: iceAddresses, KeepLocalAddresses: *keepLocalAddresses || *oldKeepLocalAddresses, Max: *max, + EventDispatcher: eventLogger, } // Begin goptlib client process.

1 0

[snowflake/main] Emit non-pointer type event
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 8d2f662c8c04b1e7e6abc626ac9bd3677055d1f8 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 16:28:09 2021 +0000 Emit non-pointer type event --- client/lib/webrtc.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/lib/webrtc.go b/client/lib/webrtc.go index 01b85f5..328c3a9 100644 --- a/client/lib/webrtc.go +++ b/client/lib/webrtc.go @@ -202,7 +202,7 @@ func (c *WebRTCPeer) preparePeerConnection(config *webrtc.Configuration) error { return err } dc.OnOpen(func() { - c.eventsLogger.OnNewSnowflakeEvent(&event.EventOnSnowflakeConnected{}) + c.eventsLogger.OnNewSnowflakeEvent(event.EventOnSnowflakeConnected{}) log.Println("WebRTC: DataChannel.OnOpen") close(c.open) }) @@ -211,7 +211,7 @@ func (c *WebRTCPeer) preparePeerConnection(config *webrtc.Configuration) error { c.Close() }) dc.OnError(func(err error) { - c.eventsLogger.OnNewSnowflakeEvent(&event.EventOnSnowflakeConnectionFailed{Error: err}) + c.eventsLogger.OnNewSnowflakeEvent(event.EventOnSnowflakeConnectionFailed{Error: err}) }) dc.OnMessage(func(msg webrtc.DataChannelMessage) { if len(msg.Data) <= 0 {

1 0

[snowflake/main] Add Propagate EventLogger Setting
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 7536dd6fb75697bdc85c10e0be6ed0829a338155 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 16:29:10 2021 +0000 Add Propagate EventLogger Setting --- client/lib/rendezvous.go | 13 +++++++++++-- client/lib/snowflake.go | 2 +- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/client/lib/rendezvous.go b/client/lib/rendezvous.go index c3f0d7a..4c2b240 100644 --- a/client/lib/rendezvous.go +++ b/client/lib/rendezvous.go @@ -10,6 +10,7 @@ import ( "sync" "time" + "git.torproject.org/pluggable-transports/snowflake.git/v2/common/event" "git.torproject.org/pluggable-transports/snowflake.git/v2/common/messages" "git.torproject.org/pluggable-transports/snowflake.git/v2/common/nat" "git.torproject.org/pluggable-transports/snowflake.git/v2/common/util" @@ -141,10 +142,16 @@ type WebRTCDialer struct { *BrokerChannel webrtcConfig *webrtc.Configuration max int + + eventLogger event.SnowflakeEventReceiver } -// NewWebRTCDialer constructs a new WebRTCDialer. func NewWebRTCDialer(broker *BrokerChannel, iceServers []webrtc.ICEServer, max int) *WebRTCDialer { + return NewWebRTCDialer4E(broker, iceServers, max, nil) +} + +// NewWebRTCDialer4E constructs a new WebRTCDialer. +func NewWebRTCDialer4E(broker *BrokerChannel, iceServers []webrtc.ICEServer, max int, eventLogger event.SnowflakeEventReceiver) *WebRTCDialer { config := webrtc.Configuration{ ICEServers: iceServers, } @@ -153,6 +160,8 @@ func NewWebRTCDialer(broker *BrokerChannel, iceServers []webrtc.ICEServer, max i BrokerChannel: broker, webrtcConfig: &config, max: max, + + eventLogger: eventLogger, } } @@ -160,7 +169,7 @@ func NewWebRTCDialer(broker *BrokerChannel, iceServers []webrtc.ICEServer, max i func (w WebRTCDialer) Catch() (*WebRTCPeer, error) { // TODO: [#25591] Fetch ICE server information from Broker. // TODO: [#25596] Consider TURN servers here too. - return NewWebRTCPeer(w.webrtcConfig, w.BrokerChannel) + return NewWebRTCPeer3E(w.webrtcConfig, w.BrokerChannel, w.eventLogger) } // GetMax returns the maximum number of snowflakes to collect. diff --git a/client/lib/snowflake.go b/client/lib/snowflake.go index fdcb457..4f9e663 100644 --- a/client/lib/snowflake.go +++ b/client/lib/snowflake.go @@ -135,7 +135,7 @@ func NewSnowflakeClient(config ClientConfig) (*Transport, error) { if config.Max > max { max = config.Max } - transport := &Transport{dialer: NewWebRTCDialer(broker, iceServers, max)} + transport := &Transport{dialer: NewWebRTCDialer4E(broker, iceServers, max, config.EventDispatcher)} return transport, nil }

1 0

[snowflake/main] Reduce PT Event Logger Verbosity
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 55bf117d1ae5b362e4d4fc7dc3ff9a1788b84830 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Dec 13 16:47:23 2021 +0000 Reduce PT Event Logger Verbosity --- client/lib/pt_event_logger.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/lib/pt_event_logger.go b/client/lib/pt_event_logger.go index b183005..46b4e05 100644 --- a/client/lib/pt_event_logger.go +++ b/client/lib/pt_event_logger.go @@ -21,7 +21,7 @@ func (p ptEventLogger) OnNewSnowflakeEvent(e event.SnowflakeEvent) { if e.Error != nil { pt.Log(pt.LogSeverityError, fmt.Sprintf("offer creation failure %v", e.Error.Error())) } else { - pt.Log(pt.LogSeverityNotice, fmt.Sprintf("offer created %v", e.WebRTCLocalDescription)) + pt.Log(pt.LogSeverityNotice, fmt.Sprintf("offer created")) } case event.EventOnBrokerRendezvous: @@ -29,7 +29,7 @@ func (p ptEventLogger) OnNewSnowflakeEvent(e event.SnowflakeEvent) { if e.Error != nil { pt.Log(pt.LogSeverityError, fmt.Sprintf("broker failure %v", e.Error.Error())) } else { - pt.Log(pt.LogSeverityNotice, fmt.Sprintf("broker rendezvous peer %v", e.WebRTCRemoteDescription)) + pt.Log(pt.LogSeverityNotice, fmt.Sprintf("broker rendezvous peer received")) } case event.EventOnSnowflakeConnected:

1 0