- tor-commits - lists.torproject.org

[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

[snowflake/main] Refactor event logger setting into function call
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 657aaa6ba8b5baadc0d34d9bd0df0914cbc813e3 Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Thu Jan 20 13:17:34 2022 +0000 Refactor event logger setting into function call See also: https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snow… --- client/lib/snowflake.go | 17 +++++++++++++---- client/snowflake.go | 7 +------ 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/client/lib/snowflake.go b/client/lib/snowflake.go index 4f9e663..0f637f2 100644 --- a/client/lib/snowflake.go +++ b/client/lib/snowflake.go @@ -71,6 +71,10 @@ func (addr dummyAddr) String() string { return "dummy" } // https://github.com/Pluggable-Transports/Pluggable-Transports-spec/blob/mast… type Transport struct { dialer *WebRTCDialer + + // EventDispatcher is the event bus for snowflake events. + // When an important event happens, it will be distributed here. + eventDispatcher event.SnowflakeEventDispatcher } // ClientConfig defines how the SnowflakeClient will connect to the broker and Snowflake proxies. @@ -93,9 +97,6 @@ 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 @@ -135,7 +136,8 @@ func NewSnowflakeClient(config ClientConfig) (*Transport, error) { if config.Max > max { max = config.Max } - transport := &Transport{dialer: NewWebRTCDialer4E(broker, iceServers, max, config.EventDispatcher)} + eventsLogger := event.NewSnowflakeEventDispatcher() + transport := &Transport{dialer: NewWebRTCDialer4E(broker, iceServers, max, eventsLogger), eventDispatcher: eventsLogger} return transport, nil } @@ -191,6 +193,13 @@ func (t *Transport) Dial() (net.Conn, error) { cleanup = nil return &SnowflakeConn{Stream: stream, sess: sess, pconn: pconn, snowflakes: snowflakes}, nil } +func (t *Transport) AddSnowflakeEventListener(receiver event.SnowflakeEventReceiver) { + t.eventDispatcher.AddSnowflakeEventListener(receiver) +} + +func (t *Transport) RemoveSnowflakeEventListener(receiver event.SnowflakeEventReceiver) { + t.eventDispatcher.RemoveSnowflakeEventListener(receiver) +} // SetRendezvousMethod sets the rendezvous method to the Snowflake broker. func (t *Transport) SetRendezvousMethod(r RendezvousMethod) { diff --git a/client/snowflake.go b/client/snowflake.go index 0ab71a7..5a00206 100644 --- a/client/snowflake.go +++ b/client/snowflake.go @@ -17,7 +17,6 @@ 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" ) @@ -91,6 +90,7 @@ func socksAcceptLoop(ln *pt.SocksListener, config sf.ClientConfig, shutdown chan log.Println("Failed to start snowflake transport: ", err) return } + transport.AddSnowflakeEventListener(sf.NewPTEventLogger()) err = conn.Grant(&net.TCPAddr{IP: net.IPv4zero, Port: 0}) if err != nil { log.Printf("conn.Grant error: %s", err) @@ -171,10 +171,6 @@ func main() { iceAddresses := strings.Split(strings.TrimSpace(*iceServersCommas), ",") - eventLogger := event.NewSnowflakeEventDispatcher() - - eventLogger.AddSnowflakeEventListener(sf.NewPTEventLogger()) - config := sf.ClientConfig{ BrokerURL: *brokerURL, AmpCacheURL: *ampCacheURL, @@ -182,7 +178,6 @@ func main() { ICEAddresses: iceAddresses, KeepLocalAddresses: *keepLocalAddresses || *oldKeepLocalAddresses, Max: *max, - EventDispatcher: eventLogger, } // Begin goptlib client process.

1 0

[snowflake/main] Refactor WebRTC Peer, Dialer's name to be readable
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 6cb82618a0f82a15dda617957af8bf08780a482b Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Mon Jan 24 11:51:49 2022 +0000 Refactor WebRTC Peer,Dialer's name to be readable See also: https://gitlab.torproject.org/tpo/anti-censorship/pluggable-transports/snow… --- client/lib/rendezvous.go | 8 ++++---- client/lib/snowflake.go | 2 +- client/lib/webrtc.go | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/client/lib/rendezvous.go b/client/lib/rendezvous.go index 4c2b240..98cd4d6 100644 --- a/client/lib/rendezvous.go +++ b/client/lib/rendezvous.go @@ -147,11 +147,11 @@ type WebRTCDialer struct { } func NewWebRTCDialer(broker *BrokerChannel, iceServers []webrtc.ICEServer, max int) *WebRTCDialer { - return NewWebRTCDialer4E(broker, iceServers, max, nil) + return NewWebRTCDialerWithEvents(broker, iceServers, max, nil) } -// NewWebRTCDialer4E constructs a new WebRTCDialer. -func NewWebRTCDialer4E(broker *BrokerChannel, iceServers []webrtc.ICEServer, max int, eventLogger event.SnowflakeEventReceiver) *WebRTCDialer { +// NewWebRTCDialerWithEvents constructs a new WebRTCDialer. +func NewWebRTCDialerWithEvents(broker *BrokerChannel, iceServers []webrtc.ICEServer, max int, eventLogger event.SnowflakeEventReceiver) *WebRTCDialer { config := webrtc.Configuration{ ICEServers: iceServers, } @@ -169,7 +169,7 @@ func NewWebRTCDialer4E(broker *BrokerChannel, iceServers []webrtc.ICEServer, max func (w WebRTCDialer) Catch() (*WebRTCPeer, error) { // TODO: [#25591] Fetch ICE server information from Broker. // TODO: [#25596] Consider TURN servers here too. - return NewWebRTCPeer3E(w.webrtcConfig, w.BrokerChannel, w.eventLogger) + return NewWebRTCPeerWithEvents(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 0f637f2..594c62c 100644 --- a/client/lib/snowflake.go +++ b/client/lib/snowflake.go @@ -137,7 +137,7 @@ func NewSnowflakeClient(config ClientConfig) (*Transport, error) { max = config.Max } eventsLogger := event.NewSnowflakeEventDispatcher() - transport := &Transport{dialer: NewWebRTCDialer4E(broker, iceServers, max, eventsLogger), eventDispatcher: eventsLogger} + transport := &Transport{dialer: NewWebRTCDialerWithEvents(broker, iceServers, max, eventsLogger), eventDispatcher: eventsLogger} return transport, nil } diff --git a/client/lib/webrtc.go b/client/lib/webrtc.go index 328c3a9..282b54d 100644 --- a/client/lib/webrtc.go +++ b/client/lib/webrtc.go @@ -38,15 +38,15 @@ type WebRTCPeer struct { func NewWebRTCPeer(config *webrtc.Configuration, broker *BrokerChannel) (*WebRTCPeer, error) { - return NewWebRTCPeer3E(config, broker, nil) + return NewWebRTCPeerWithEvents(config, broker, nil) } -// NewWebRTCPeer3E constructs a WebRTC PeerConnection to a snowflake proxy. +// NewWebRTCPeerWithEvents 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 NewWebRTCPeer3E(config *webrtc.Configuration, +func NewWebRTCPeerWithEvents(config *webrtc.Configuration, broker *BrokerChannel, eventsLogger event.SnowflakeEventReceiver) (*WebRTCPeer, error) { if eventsLogger == nil { eventsLogger = event.NewSnowflakeEventDispatcher()

1 0

[snowflake/main] Add Snowflake Event API interface
by shelikhoo＠torproject.org 25 Jan '22

25 Jan '22

commit 75f770150d6c9943231cb6b8bde0b867137ea26f Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Fri Nov 26 15:12:46 2021 +0000 Add Snowflake Event API interface --- common/event/interface.go | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/common/event/interface.go b/common/event/interface.go new file mode 100644 index 0000000..697f2b7 --- /dev/null +++ b/common/event/interface.go @@ -0,0 +1,45 @@ +package event + +import "github.com/pion/webrtc/v3" + +type SnowflakeEvent interface { + IsSnowflakeEvent() + String() string +} + +type EventOnOfferCreated struct { + SnowflakeEvent + WebRTCLocalDescription *webrtc.SessionDescription + Error error +} + +type EventOnBrokerRendezvous struct { + SnowflakeEvent + WebRTCRemoteDescription *webrtc.SessionDescription + Error error +} + +type EventOnSnowflakeConnected struct { + SnowflakeEvent +} + +type EventOnSnowflakeConnectionFailed struct { + SnowflakeEvent + Error error +} + +type SnowflakeEventReceiver interface { + // OnNewSnowflakeEvent notify receiver about a new event + // This method MUST not block + OnNewSnowflakeEvent(event SnowflakeEvent) +} + +type SnowflakeEventDispatcher interface { + SnowflakeEventReceiver + // AddSnowflakeEventListener allow receiver(s) to receive event notification + // when OnNewSnowflakeEvent is called on the dispatcher. + // Every event listener added will be called when an event is received by the dispatcher. + // The order each listener is called is undefined. + AddSnowflakeEventListener(receiver SnowflakeEventReceiver) + RemoveSnowflakeEventListener(receiver SnowflakeEventReceiver) +}

1 0

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

25 Jan '22

commit 5f03f88d730c4b1c298c4c3eeceeba8023f056ff Author: Shelikhoo <xiaokangwang(a)outlook.com> Date: Fri Nov 26 16:00:30 2021 +0000 Add Event Bus Implementation This event bus implementation favours simplicity over efficiency and is not suitable for frequent addition and removal of listeners. --- common/event/bus.go | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/common/event/bus.go b/common/event/bus.go new file mode 100644 index 0000000..7e45779 --- /dev/null +++ b/common/event/bus.go @@ -0,0 +1,39 @@ +package event + +import "sync" + +func NewSnowflakeEventDispatcher() SnowflakeEventDispatcher { + return &eventBus{lock: &sync.Mutex{}} +} + +type eventBus struct { + lock *sync.Mutex + listeners []SnowflakeEventReceiver +} + +func (e *eventBus) OnNewSnowflakeEvent(event SnowflakeEvent) { + e.lock.Lock() + defer e.lock.Unlock() + for _, v := range e.listeners { + v.OnNewSnowflakeEvent(event) + } +} + +func (e *eventBus) AddSnowflakeEventListener(receiver SnowflakeEventReceiver) { + e.lock.Lock() + defer e.lock.Unlock() + e.listeners = append(e.listeners, receiver) +} + +func (e *eventBus) RemoveSnowflakeEventListener(receiver SnowflakeEventReceiver) { + e.lock.Lock() + defer e.lock.Unlock() + var newListeners []SnowflakeEventReceiver + for _, v := range e.listeners { + if v != receiver { + newListeners = append(newListeners, v) + } + } + e.listeners = newListeners + return +}

1 0