6156416215

Committed 12 Sep 2023 07:44AM UTC coverage: 80.994% (-0.008%) from 81.002%

Build # 6156416215

Build Type

push

github

Committed by

web-flow

Commit Message

refactor(netxlite): use *Netx for creating TLS handshakers (#1252)

This diff is like
https://github.com/ooni/probe-cli/commit/50279a7f6
but uses *Netx to create TLS handshakers.

The general idea of this patchset is to ensure we're not using duplicate
code for constructing netxlite types, which is good to do now, because
we're about to introduce new netxlite types for the network with which
we communicate with the OONI backend.

Reference issue: https://github.com/ooni/probe/issues/2531

Run Details

8 of 8 new or added lines in 1 file covered. (100.0%)

3 existing lines in 2 files now uncovered.

22321 of 27559 relevant lines covered (80.99%)

29.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.21

/internal/ptx/ptx.go

package ptx

/*-
         This file is derived from client/snowflake.go
    in git.torproject.org/pluggable-transports/snowflake.git
                whose license is the following:

================================================================================

Copyright (c) 2016, Serene Han, Arlo Breault
Copyright (c) 2019-2020, The Tor Project, Inc

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

  * Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

  * Neither the names of the copyright owners nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
================================================================================
*/

import (
        "context"
        "errors"
        "fmt"
        "net"
        "strings"
        "sync"

        pt "git.torproject.org/pluggable-transports/goptlib.git"
        "github.com/ooni/probe-cli/v3/internal/bytecounter"
        "github.com/ooni/probe-cli/v3/internal/model"
        "github.com/ooni/probe-cli/v3/internal/netxlite"
)

// PTDialer is a generic pluggable transports dialer.
type PTDialer interface {
        // DialContext establishes a connection to the pluggable
        // transport backend according to PT-specific configuration
        // and returns you such a connection.
        DialContext(ctx context.Context) (net.Conn, error)

        // AsBridgeArgument returns the argument to be passed to
        // the tor command line to declare this bridge.
        AsBridgeArgument() string

        // Name returns the pluggable transport name.
        Name() string
}

// Listener is a generic pluggable transports listener. Make sure
// you fill the mandatory fields before using it. Do not modify public
// fields after you called Start, since this causes data races.
type Listener struct {
        // ExperimentByteCounter is the OPTIONAL byte counter that
        // counts the bytes consumed by the experiment.
        ExperimentByteCounter *bytecounter.Counter

        // ListenSocks is OPTIONAL and allows you to override the
        // function called by default to listen for SOCKS5.
        ListenSocks func(network string, laddr string) (SocksListener, error)

        // Logger is the OPTIONAL logger. When not set, this library
        // will not emit logs. (But the underlying pluggable transport
        // may still emit its own log messages.)
        Logger model.Logger

        // PTDialer is the MANDATORY pluggable transports dialer
        // to use. Both SnowflakeDialer and OBFS4Dialer implement this
        // interface and can be thus safely used here.
        PTDialer PTDialer

        // SessionByteCounter is the OPTIONAL byte counter that
        // counts the bytes consumed by the session.
        SessionByteCounter *bytecounter.Counter

        // mu provides mutual exclusion for accessing internals.
        mu sync.Mutex

        // cancel allows stopping the forwarders.
        cancel context.CancelFunc

        // laddr is the listen address.
        laddr net.Addr

        // listener allows us to stop the listener.
        listener SocksListener
}

// logger returns the Logger, if set, or the defaultLogger.
func (lst *Listener) logger() model.Logger {
        if lst.Logger != nil {
                return lst.Logger
        }
        return model.DiscardLogger
}

// forward forwards the traffic from left to right and from right to left
// and closes the done channel when it is done. This function DOES NOT
// take ownership of the left, right net.Conn arguments.
func (lst *Listener) forward(ctx context.Context, left, right net.Conn, done chan struct{}) {
        defer close(done) // signal termination
        wg := new(sync.WaitGroup)
        wg.Add(2)
        go func() {
                defer wg.Done()
                netxlite.CopyContext(ctx, left, right)
        }()
        go func() {
                defer wg.Done()
                netxlite.CopyContext(ctx, right, left)
        }()
        wg.Wait()
}

// forwardWithContext forwards the traffic from left to right and
// form right to left, interrupting when the context is done. This
// function TAKES OWNERSHIP of the two connections and ensures
// that they are closed when we are done.
func (lst *Listener) forwardWithContext(ctx context.Context, left, right net.Conn) {
        defer left.Close()
        defer right.Close()
        done := make(chan struct{})
        go lst.forward(ctx, left, right, done)
        select {
        case <-ctx.Done():
        case <-done:
        }
}

// handleSocksConn handles a new SocksConn connection by establishing
// the corresponding PT connection and forwarding traffic. This
// function TAKES OWNERSHIP of the socksConn argument.
func (lst *Listener) handleSocksConn(ctx context.Context, socksConn SocksConn) error {
        err := socksConn.Grant(&net.TCPAddr{IP: net.IPv4zero, Port: 0})
        if err != nil {
                lst.logger().Warnf("ptx: socksConn.Grant error: %s", err)
                return err // used for testing
        }
        ptConn, err := lst.PTDialer.DialContext(ctx)
        if err != nil {
                socksConn.Close() // we own it
                lst.logger().Warnf("ptx: ContextDialer.DialContext error: %s", err)
                return err // used for testing
        }
        // We _must_ wrap the ptConn. Wrapping the socks conn leads us to
        // count the sent bytes as received and the received bytes as sent:
        // bytes flow in the opposite direction there for the socks conn.
        ptConn = bytecounter.MaybeWrapConn(ptConn, lst.SessionByteCounter)
        ptConn = bytecounter.MaybeWrapConn(ptConn, lst.ExperimentByteCounter)
        lst.forwardWithContext(ctx, socksConn, ptConn) // transfer ownership
        return nil                                     // used for testing
}

// SocksListener is the listener for socks connections.
type SocksListener interface {
        // AcceptSocks accepts a socks conn
        AcceptSocks() (SocksConn, error)

        // Addr returns the listening address.
        Addr() net.Addr

        // Close closes the listener
        Close() error
}

// SocksConn is a SOCKS connection.
type SocksConn interface {
        // net.Conn is the embedded interface.
        net.Conn

        // Grant grants access to a specific IP address.
        Grant(addr *net.TCPAddr) error
}

// acceptLoop accepts and handles local socks connection. This function
// DOES NOT take ownership of the socks listener.
func (lst *Listener) acceptLoop(ctx context.Context, ln SocksListener) {
        for {
                conn, err := ln.AcceptSocks()
                if err != nil {
                        if err, ok := err.(net.Error); ok && err.Temporary() {
                                continue
                        }
                        if !errors.Is(err, net.ErrClosed) {
                                lst.logger().Warnf("ptx: socks accept error: %s", err)
                        }
                        return
                }
                go lst.handleSocksConn(ctx, conn)
        }
}

// Addr returns the listening address. This function should not
// be called after you have called the Stop method or before the
// Start method has successfully returned. When invoked in such
// conditions, this function may return nil. Otherwise, it will
// return the valid net.Addr where we are listening.
func (lst *Listener) Addr() net.Addr {
        return lst.laddr
}

// Start starts the pluggable transport Listener. The pluggable transport will
// run in a background goroutine until txp.Stop is called. Attempting to
// call Start when the pluggable transport is already running is a
// no-op causing no error and no data races.
func (lst *Listener) Start() error {
        lst.mu.Lock()
        defer lst.mu.Unlock()
        if lst.cancel != nil {
                return nil // already started
        }
        // TODO(bassosimone): be able to recover when SOCKS dies?
        ln, err := lst.listenSocks("tcp", "127.0.0.1:0")
        if err != nil {
                return err
        }
        lst.laddr = ln.Addr()
        ctx, cancel := context.WithCancel(context.Background())
        lst.cancel = cancel
        lst.listener = ln
        go lst.acceptLoop(ctx, ln)
        lst.logger().Infof("ptx: started socks listener at %v", ln.Addr())
        lst.logger().Debugf("ptx: test with `%s`", lst.torCmdLine())
        return nil
}

// listenSocks calles either pt.ListenSocks or lst.overrideListenSocks.
func (lst *Listener) listenSocks(network string, laddr string) (SocksListener, error) {
        if lst.ListenSocks != nil {
                return lst.ListenSocks(network, laddr)
        }
        return lst.castListener(pt.ListenSocks(network, laddr))
}

// castListener casts a pt.SocksListener to ptxSocksListener.
func (lst *Listener) castListener(in *pt.SocksListener, err error) (SocksListener, error) {
        if err != nil {
                return nil, err
        }
        return &ptxSocksListenerAdapter{in}, nil
}

// ptxSocksListenerAdapter adapts pt.SocksListener to ptxSocksListener.
type ptxSocksListenerAdapter struct {
        *pt.SocksListener
}

// AcceptSocks adapts pt.SocksListener.AcceptSocks to ptxSockListener.AcceptSocks.
func (la *ptxSocksListenerAdapter) AcceptSocks() (SocksConn, error) {
        return la.SocksListener.AcceptSocks()
}

// torCmdLine prints the command line for testing this listener. This method is here to
// facilitate debugging with `ptxclient`, so there is no need to be too precise with arguments
// quoting. Remember to improve upon this aspect if you plan on using it beyond testing.
func (lst *Listener) torCmdLine() string {
        return strings.Join([]string{
                "tor",
                "DataDirectory",
                "testdata",
                "UseBridges",
                "1",
                "ClientTransportPlugin",
                "'" + lst.AsClientTransportPluginArgument() + "'",
                "Bridge",
                "'" + lst.PTDialer.AsBridgeArgument() + "'",
        }, " ")
}

// Stop stops the pluggable transport. This method is idempotent
// and asks the background goroutine(s) to stop just once. Also, this
// method is safe to call from any goroutine.
func (lst *Listener) Stop() {
        defer lst.mu.Unlock()
        lst.mu.Lock()
        if lst.cancel != nil {
                lst.cancel() // cancel is idempotent
        }
        if lst.listener != nil {
                lst.listener.Close() // should be idempotent
        }
}

// AsClientTransportPluginArgument converts the current configuration
// of the pluggable transport to a ClientTransportPlugin argument to be
// passed to the tor daemon command line. This function must be
// called after Start and before Stop so that we have a valid Addr.
//
// Assuming that we are listening at 127.0.0.1:12345, then this
// function will return the following string:
//
//        obfs4 socks5 127.0.0.1:12345
//
// The correct configuration line for the `torrc` would be:
//
//        ClientTransportPlugin obfs4 socks5 127.0.0.1:12345
//
// Since we pass configuration to tor using the command line, it
// is more convenient to us to avoid including ClientTransportPlugin
// in the returned string. In fact, ClientTransportPlugin and its
// arguments need to be two consecutive argv strings.
func (lst *Listener) AsClientTransportPluginArgument() string {
        return fmt.Sprintf("%s socks5 %s", lst.PTDialer.Name(), lst.laddr.String())
}

1	package ptx
2
3	/*-
4	This file is derived from client/snowflake.go
5	in git.torproject.org/pluggable-transports/snowflake.git
6	whose license is the following:
7
8	================================================================================
9
10	Copyright (c) 2016, Serene Han, Arlo Breault
11	Copyright (c) 2019-2020, The Tor Project, Inc
12
13	Redistribution and use in source and binary forms, with or without modification,
14	are permitted provided that the following conditions are met:
15
16	* Redistributions of source code must retain the above copyright notice, this
17	list of conditions and the following disclaimer.
18
19	* Redistributions in binary form must reproduce the above copyright notice,
20	this list of conditions and the following disclaimer in the documentation and/or
21	other materials provided with the distribution.
22
23	* Neither the names of the copyright owners nor the names of its
24	contributors may be used to endorse or promote products derived from this
25	software without specific prior written permission.
26
27	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
28	ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29	WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
30	DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
31	ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
32	(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
33	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
34	ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35	(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36	SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37	================================================================================
38	*/
39
40	import (
41	"context"
42	"errors"
43	"fmt"
44	"net"
45	"strings"
46	"sync"
47
48	pt "git.torproject.org/pluggable-transports/goptlib.git"
49	"github.com/ooni/probe-cli/v3/internal/bytecounter"
50	"github.com/ooni/probe-cli/v3/internal/model"
51	"github.com/ooni/probe-cli/v3/internal/netxlite"
52	)
53
54	// PTDialer is a generic pluggable transports dialer.
55	type PTDialer interface {
56	// DialContext establishes a connection to the pluggable
57	// transport backend according to PT-specific configuration
58	// and returns you such a connection.
59	DialContext(ctx context.Context) (net.Conn, error)
60
61	// AsBridgeArgument returns the argument to be passed to
62	// the tor command line to declare this bridge.
63	AsBridgeArgument() string
64
65	// Name returns the pluggable transport name.
66	Name() string
67	}
68
69	// Listener is a generic pluggable transports listener. Make sure
70	// you fill the mandatory fields before using it. Do not modify public
71	// fields after you called Start, since this causes data races.
72	type Listener struct {
73	// ExperimentByteCounter is the OPTIONAL byte counter that
74	// counts the bytes consumed by the experiment.
75	ExperimentByteCounter *bytecounter.Counter
76
77	// ListenSocks is OPTIONAL and allows you to override the
78	// function called by default to listen for SOCKS5.
79	ListenSocks func(network string, laddr string) (SocksListener, error)
80
81	// Logger is the OPTIONAL logger. When not set, this library
82	// will not emit logs. (But the underlying pluggable transport
83	// may still emit its own log messages.)
84	Logger model.Logger
85
86	// PTDialer is the MANDATORY pluggable transports dialer
87	// to use. Both SnowflakeDialer and OBFS4Dialer implement this
88	// interface and can be thus safely used here.
89	PTDialer PTDialer
90
91	// SessionByteCounter is the OPTIONAL byte counter that
92	// counts the bytes consumed by the session.
93	SessionByteCounter *bytecounter.Counter
94
95	// mu provides mutual exclusion for accessing internals.
96	mu sync.Mutex
97
98	// cancel allows stopping the forwarders.
99	cancel context.CancelFunc
100
101	// laddr is the listen address.
102	laddr net.Addr
103
104	// listener allows us to stop the listener.
105	listener SocksListener
106	}
107
108	// logger returns the Logger, if set, or the defaultLogger.
109	func (lst *Listener) logger() model.Logger {	5✔
110	if lst.Logger != nil {	6✔
111	return lst.Logger	1✔
112	}	1✔
113	return model.DiscardLogger	4✔
114	}
115
116	// forward forwards the traffic from left to right and from right to left
117	// and closes the done channel when it is done. This function DOES NOT
118	// take ownership of the left, right net.Conn arguments.
119	func (lst *Listener) forward(ctx context.Context, left, right net.Conn, done chan struct{}) {	3✔
120	defer close(done) // signal termination	3✔
121	wg := new(sync.WaitGroup)	3✔
122	wg.Add(2)	3✔
123	go func() {	6✔
124	defer wg.Done()	3✔
125	netxlite.CopyContext(ctx, left, right)	3✔
126	}()	3✔
127	go func() {	6✔
128	defer wg.Done()	3✔
129	netxlite.CopyContext(ctx, right, left)	3✔
130	}()	3✔
131	wg.Wait()	3✔
132	}
133
134	// forwardWithContext forwards the traffic from left to right and
135	// form right to left, interrupting when the context is done. This
136	// function TAKES OWNERSHIP of the two connections and ensures
137	// that they are closed when we are done.
138	func (lst *Listener) forwardWithContext(ctx context.Context, left, right net.Conn) {	3✔
139	defer left.Close()	3✔
140	defer right.Close()	3✔
141	done := make(chan struct{})	3✔
142	go lst.forward(ctx, left, right, done)	3✔
143	select {	3✔
144	case <-ctx.Done():	2✔
145	case <-done:	1✔
146	}
147	}
148
149	// handleSocksConn handles a new SocksConn connection by establishing
150	// the corresponding PT connection and forwarding traffic. This
151	// function TAKES OWNERSHIP of the socksConn argument.
152	func (lst *Listener) handleSocksConn(ctx context.Context, socksConn SocksConn) error {	3✔
153	err := socksConn.Grant(&net.TCPAddr{IP: net.IPv4zero, Port: 0})	3✔
154	if err != nil {	4✔
155	lst.logger().Warnf("ptx: socksConn.Grant error: %s", err)	1✔
156	return err // used for testing	1✔
157	}	1✔
158	ptConn, err := lst.PTDialer.DialContext(ctx)	2✔
159	if err != nil {	3✔
160	socksConn.Close() // we own it	1✔
161	lst.logger().Warnf("ptx: ContextDialer.DialContext error: %s", err)	1✔
162	return err // used for testing	1✔
163	}	1✔
164	// We _must_ wrap the ptConn. Wrapping the socks conn leads us to
165	// count the sent bytes as received and the received bytes as sent:
166	// bytes flow in the opposite direction there for the socks conn.
167	ptConn = bytecounter.MaybeWrapConn(ptConn, lst.SessionByteCounter)	1✔
168	ptConn = bytecounter.MaybeWrapConn(ptConn, lst.ExperimentByteCounter)	1✔
169	lst.forwardWithContext(ctx, socksConn, ptConn) // transfer ownership	1✔
170	return nil // used for testing	1✔
171	}
172
173	// SocksListener is the listener for socks connections.
174	type SocksListener interface {
175	// AcceptSocks accepts a socks conn
176	AcceptSocks() (SocksConn, error)
177
178	// Addr returns the listening address.
179	Addr() net.Addr
180
181	// Close closes the listener
182	Close() error
183	}
184
185	// SocksConn is a SOCKS connection.
186	type SocksConn interface {
187	// net.Conn is the embedded interface.
188	net.Conn
189
190	// Grant grants access to a specific IP address.
191	Grant(addr *net.TCPAddr) error
192	}
193
194	// acceptLoop accepts and handles local socks connection. This function
195	// DOES NOT take ownership of the socks listener.
196	func (lst *Listener) acceptLoop(ctx context.Context, ln SocksListener) {	2✔
197	for {	4,377✔
198	conn, err := ln.AcceptSocks()	4,375✔
199	if err != nil {	8,748✔
200	if err, ok := err.(net.Error); ok && err.Temporary() {	8,745✔
201	continue	4,372✔
202	}
203	if !errors.Is(err, net.ErrClosed) {	1✔
UNCOV 204	lst.logger().Warnf("ptx: socks accept error: %s", err)	×
UNCOV 205	}	×
206	return	1✔
207	}
208	go lst.handleSocksConn(ctx, conn)	1✔
209	}
210	}
211
212	// Addr returns the listening address. This function should not
213	// be called after you have called the Stop method or before the
214	// Start method has successfully returned. When invoked in such
215	// conditions, this function may return nil. Otherwise, it will
216	// return the valid net.Addr where we are listening.
217	func (lst *Listener) Addr() net.Addr {	1✔
218	return lst.laddr	1✔
219	}	1✔
220
221	// Start starts the pluggable transport Listener. The pluggable transport will
222	// run in a background goroutine until txp.Stop is called. Attempting to
223	// call Start when the pluggable transport is already running is a
224	// no-op causing no error and no data races.
225	func (lst *Listener) Start() error {	3✔
226	lst.mu.Lock()	3✔
227	defer lst.mu.Unlock()	3✔
228	if lst.cancel != nil {	4✔
229	return nil // already started	1✔
230	}	1✔
231	// TODO(bassosimone): be able to recover when SOCKS dies?
232	ln, err := lst.listenSocks("tcp", "127.0.0.1:0")	2✔
233	if err != nil {	3✔
234	return err	1✔
235	}	1✔
236	lst.laddr = ln.Addr()	1✔
237	ctx, cancel := context.WithCancel(context.Background())	1✔
238	lst.cancel = cancel	1✔
239	lst.listener = ln	1✔
240	go lst.acceptLoop(ctx, ln)	1✔
241	lst.logger().Infof("ptx: started socks listener at %v", ln.Addr())	1✔
242	lst.logger().Debugf("ptx: test with `%s`", lst.torCmdLine())	1✔
243	return nil	1✔
244	}
245
246	// listenSocks calles either pt.ListenSocks or lst.overrideListenSocks.
247	func (lst *Listener) listenSocks(network string, laddr string) (SocksListener, error) {	2✔
248	if lst.ListenSocks != nil {	3✔
249	return lst.ListenSocks(network, laddr)	1✔
250	}	1✔
251	return lst.castListener(pt.ListenSocks(network, laddr))	1✔
252	}
253
254	// castListener casts a pt.SocksListener to ptxSocksListener.
255	func (lst Listener) castListener(in pt.SocksListener, err error) (SocksListener, error) {	2✔
256	if err != nil {	3✔
257	return nil, err	1✔
258	}	1✔
259	return &ptxSocksListenerAdapter{in}, nil	1✔
260	}
261
262	// ptxSocksListenerAdapter adapts pt.SocksListener to ptxSocksListener.
263	type ptxSocksListenerAdapter struct {
264	*pt.SocksListener
265	}
266
267	// AcceptSocks adapts pt.SocksListener.AcceptSocks to ptxSockListener.AcceptSocks.
268	func (la *ptxSocksListenerAdapter) AcceptSocks() (SocksConn, error) {	2✔
269	return la.SocksListener.AcceptSocks()	2✔
270	}	2✔
271
272	// torCmdLine prints the command line for testing this listener. This method is here to
273	// facilitate debugging with `ptxclient`, so there is no need to be too precise with arguments
274	// quoting. Remember to improve upon this aspect if you plan on using it beyond testing.
275	func (lst *Listener) torCmdLine() string {	1✔
276	return strings.Join([]string{	1✔
277	"tor",	1✔
278	"DataDirectory",	1✔
279	"testdata",	1✔
280	"UseBridges",	1✔
281	"1",	1✔
282	"ClientTransportPlugin",	1✔
283	"'" + lst.AsClientTransportPluginArgument() + "'",	1✔
284	"Bridge",	1✔
285	"'" + lst.PTDialer.AsBridgeArgument() + "'",	1✔
286	}, " ")	1✔
287	}	1✔
288
289	// Stop stops the pluggable transport. This method is idempotent
290	// and asks the background goroutine(s) to stop just once. Also, this
291	// method is safe to call from any goroutine.
292	func (lst *Listener) Stop() {	3✔
293	defer lst.mu.Unlock()	3✔
294	lst.mu.Lock()	3✔
295	if lst.cancel != nil {	6✔
296	lst.cancel() // cancel is idempotent	3✔
297	}	3✔
298	if lst.listener != nil {	6✔
299	lst.listener.Close() // should be idempotent	3✔
300	}	3✔
301	}
302
303	// AsClientTransportPluginArgument converts the current configuration
304	// of the pluggable transport to a ClientTransportPlugin argument to be
305	// passed to the tor daemon command line. This function must be
306	// called after Start and before Stop so that we have a valid Addr.
307	//
308	// Assuming that we are listening at 127.0.0.1:12345, then this
309	// function will return the following string:
310	//
311	// obfs4 socks5 127.0.0.1:12345
312	//
313	// The correct configuration line for the `torrc` would be:
314	//
315	// ClientTransportPlugin obfs4 socks5 127.0.0.1:12345
316	//
317	// Since we pass configuration to tor using the command line, it
318	// is more convenient to us to avoid including ClientTransportPlugin
319	// in the returned string. In fact, ClientTransportPlugin and its
320	// arguments need to be two consecutive argv strings.
321	func (lst *Listener) AsClientTransportPluginArgument() string {	1✔
322	return fmt.Sprintf("%s socks5 %s", lst.PTDialer.Name(), lst.laddr.String())	1✔
323	}	1✔

ooni / probe-cli / 6156416215

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous