December 2013 - tor-commits - lists.torproject.org

[goptlib/master] Use implicit return values in ClientSetup and ServerSetup.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit 90ae129445f2b847ba3f51b4db805585e990a4dd Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 02:44:24 2013 -0800 Use implicit return values in ClientSetup and ServerSetup. --- pt.go | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/pt.go b/pt.go index f389794..78892a8 100644 --- a/pt.go +++ b/pt.go @@ -319,18 +319,16 @@ type ClientInfo struct { // Check the client pluggable transports environments, emitting an error message // and returning a non-nil error if any error is encountered. Returns a // ClientInfo struct. -func ClientSetup(methodNames []string) (ClientInfo, error) { - var info ClientInfo - +func ClientSetup(methodNames []string) (info ClientInfo, err error) { ver, err := getManagedTransportVer() if err != nil { - return info, err + return } line("VERSION", ver) info.MethodNames, err = getClientTransports(methodNames) if err != nil { - return info, err + return } return info, nil @@ -500,34 +498,34 @@ type ServerInfo struct { // and returning a non-nil error if any error is encountered. Resolves the // various requested bind addresses, the server ORPort and extended ORPort, and // reads the auth cookie file. Returns a ServerInfo struct. -func ServerSetup(methodNames []string) (ServerInfo, error) { - var info ServerInfo - +func ServerSetup(methodNames []string) (info ServerInfo, err error) { ver, err := getManagedTransportVer() if err != nil { - return info, err + return } line("VERSION", ver) orPort, err := getenvRequired("TOR_PT_ORPORT") if err != nil { - return info, err + return } info.OrAddr, err = resolveAddr(orPort) if err != nil { - return info, envError(fmt.Sprintf("cannot resolve TOR_PT_ORPORT %q: %s", orPort, err.Error())) + err = envError(fmt.Sprintf("cannot resolve TOR_PT_ORPORT %q: %s", orPort, err.Error())) + return } info.Bindaddrs, err = getServerBindaddrs(methodNames) if err != nil { - return info, err + return } var extendedOrPort = getenv("TOR_PT_EXTENDED_SERVER_PORT") if extendedOrPort != "" { info.ExtendedOrAddr, err = resolveAddr(extendedOrPort) if err != nil { - return info, envError(fmt.Sprintf("cannot resolve TOR_PT_EXTENDED_SERVER_PORT %q: %s", extendedOrPort, err.Error())) + err = envError(fmt.Sprintf("cannot resolve TOR_PT_EXTENDED_SERVER_PORT %q: %s", extendedOrPort, err.Error())) + return } } @@ -535,7 +533,8 @@ func ServerSetup(methodNames []string) (ServerInfo, error) { if authCookieFilename != "" { info.AuthCookie, err = readAuthCookieFile(authCookieFilename) if err != nil { - return info, envError(fmt.Sprintf("error reading TOR_PT_AUTH_COOKIE_FILE %q: %s", authCookieFilename, err.Error())) + err = envError(fmt.Sprintf("error reading TOR_PT_AUTH_COOKIE_FILE %q: %s", authCookieFilename, err.Error())) + return } }

1 0

[goptlib/master] Add SmethodArgs to emit SMETHOD with ARGS.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit af41f2c1074ad73bde5b326083d2511b30924793 Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 03:03:12 2013 -0800 Add SmethodArgs to emit SMETHOD with ARGS. --- pt.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pt.go b/pt.go index 18c3b73..4f7f167 100644 --- a/pt.go +++ b/pt.go @@ -259,6 +259,12 @@ func Smethod(name string, addr net.Addr) { line("SMETHOD", name, addr.String()) } +// Emit an SMETHOD line with an ARGS option. args is a name–value mapping that +// will be added to the server's extrainfo document. +func SmethodArgs(name string, addr net.Addr, args Args) { + line("SMETHOD", name, addr.String(), "ARGS:"+encodeSmethodArgs(args)) +} + // Emit an SMETHODS DONE line. Call this after opening all server listeners. func SmethodsDone() { line("SMETHODS", "DONE")

1 0

[goptlib/master] Add TOR_PT_SERVER_TRANSPORT_OPTIONS to TestGetServerBindaddrs.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit 5eeb899e3aaaca4cff2548aafaa0bf5314d3407b Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 10:54:45 2013 -0800 Add TOR_PT_SERVER_TRANSPORT_OPTIONS to TestGetServerBindaddrs. --- pt_test.go | 55 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 36 insertions(+), 19 deletions(-) diff --git a/pt_test.go b/pt_test.go index 1602fa8..f3d9bc1 100644 --- a/pt_test.go +++ b/pt_test.go @@ -254,64 +254,79 @@ func bindaddrSetsEqual(a, b []Bindaddr) bool { func TestGetServerBindaddrs(t *testing.T) { badTests := [...]struct { - ptServerBindaddr string - ptServerTransports string - methodNames []string + ptServerBindaddr string + ptServerTransports string + ptServerTransportOptions string + methodNames []string }{ { "xxx", "xxx", + "", []string{}, }, { "alpha-1.2.3.4", "alpha", + "", []string{"alpha", "beta", "gamma"}, }, + { + "alpha-1.2.3.4:1111", + "alpha", + "key=value", + []string{"alpha"}, + }, } goodTests := [...]struct { - ptServerBindaddr string - ptServerTransports string - methodNames []string - expected []Bindaddr + ptServerBindaddr string + ptServerTransports string + ptServerTransportOptions string + methodNames []string + expected []Bindaddr }{ { "alpha-1.2.3.4:1111,beta-[1:2::3:4]:2222", "alpha,beta,gamma", + "alpha:k1=v1,beta:k2=v2,gamma:k3=v3", []string{"alpha", "beta"}, []Bindaddr{ - {MethodName: "alpha", Addr: &net.TCPAddr{IP: net.ParseIP("1.2.3.4"), Port: 1111}}, - {MethodName: "beta", Addr: &net.TCPAddr{IP: net.ParseIP("1:2::3:4"), Port: 2222}}, + {"alpha", &net.TCPAddr{IP: net.ParseIP("1.2.3.4"), Port: 1111}, Args{"k1": []string{"v1"}}}, + {"beta", &net.TCPAddr{IP: net.ParseIP("1:2::3:4"), Port: 2222}, Args{"k2": []string{"v2"}}}, }, }, { "alpha-1.2.3.4:1111", "xxx", + "", []string{"alpha", "beta", "gamma"}, []Bindaddr{}, }, { "alpha-1.2.3.4:1111", "alpha,beta,gamma", + "", []string{}, []Bindaddr{}, }, { "alpha-1.2.3.4:1111,beta-[1:2::3:4]:2222", "*", + "", []string{"alpha", "beta"}, []Bindaddr{ - {MethodName: "alpha", Addr: &net.TCPAddr{IP: net.ParseIP("1.2.3.4"), Port: 1111}}, - {MethodName: "beta", Addr: &net.TCPAddr{IP: net.ParseIP("1:2::3:4"), Port: 2222}}, + {"alpha", &net.TCPAddr{IP: net.ParseIP("1.2.3.4"), Port: 1111}, Args{}}, + {"beta", &net.TCPAddr{IP: net.ParseIP("1:2::3:4"), Port: 2222}, Args{}}, }, }, { "trebuchet-127.0.0.1:1984,ballista-127.0.0.1:4891", "trebuchet,ballista", + "trebuchet:secret=nou;trebuchet:cache=/tmp/cache;ballista:secret=yes", []string{"trebuchet", "ballista"}, []Bindaddr{ - {MethodName: "trebuchet", Addr: &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 1984}}, - {MethodName: "ballista", Addr: &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 4891}}, + {"trebuchet", &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 1984}, Args{"secret": []string{"nou"}, "cache": []string{"/tmp/cache"}}}, + {"ballista", &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 4891}, Args{"secret": []string{"yes"}}}, }, }, } @@ -327,24 +342,26 @@ func TestGetServerBindaddrs(t *testing.T) { for _, test := range badTests { os.Setenv("TOR_PT_SERVER_BINDADDR", test.ptServerBindaddr) os.Setenv("TOR_PT_SERVER_TRANSPORTS", test.ptServerTransports) + os.Setenv("TOR_PT_SERVER_TRANSPORT_OPTIONS", test.ptServerTransportOptions) _, err := getServerBindaddrs(test.methodNames) if err == nil { - t.Errorf("TOR_PT_SERVER_BINDADDR=%q TOR_PT_SERVER_TRANSPORTS=%q %q unexpectedly succeeded", - test.ptServerBindaddr, test.ptServerTransports, test.methodNames) + t.Errorf("TOR_PT_SERVER_BINDADDR=%q TOR_PT_SERVER_TRANSPORTS=%q TOR_PT_SERVER_TRANSPORT_OPTIONS=%q %q unexpectedly succeeded", + test.ptServerBindaddr, test.ptServerTransports, test.ptServerTransportOptions, test.methodNames) } } for _, test := range goodTests { os.Setenv("TOR_PT_SERVER_BINDADDR", test.ptServerBindaddr) os.Setenv("TOR_PT_SERVER_TRANSPORTS", test.ptServerTransports) + os.Setenv("TOR_PT_SERVER_TRANSPORT_OPTIONS", test.ptServerTransportOptions) output, err := getServerBindaddrs(test.methodNames) if err != nil { - t.Errorf("TOR_PT_SERVER_BINDADDR=%q TOR_PT_SERVER_TRANSPORTS=%q %q unexpectedly returned an error: %s", - test.ptServerBindaddr, test.ptServerTransports, test.methodNames, err) + t.Errorf("TOR_PT_SERVER_BINDADDR=%q TOR_PT_SERVER_TRANSPORTS=%q TOR_PT_SERVER_TRANSPORT_OPTIONS=%q %q unexpectedly returned an error: %s", + test.ptServerBindaddr, test.ptServerTransports, test.ptServerTransportOptions, test.methodNames, err) } if !bindaddrSetsEqual(output, test.expected) { - t.Errorf("TOR_PT_SERVER_BINDADDR=%q TOR_PT_SERVER_TRANSPORTS=%q %q → %q (expected %q)", - test.ptServerBindaddr, test.ptServerTransports, test.methodNames, output, test.expected) + t.Errorf("TOR_PT_SERVER_BINDADDR=%q TOR_PT_SERVER_TRANSPORTS=%q TOR_PT_SERVER_TRANSPORT_OPTIONS=%q %q → %q (expected %q)", + test.ptServerBindaddr, test.ptServerTransports, test.ptServerTransportOptions, test.methodNames, output, test.expected) } } }

1 0

[goptlib/master] More consistent terminology.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit f615dc7090f825869c8b8f887808bdddde6eeb07 Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 03:48:28 2013 -0800 More consistent terminology. --- pt.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pt.go b/pt.go index 78892a8..b8b88ce 100644 --- a/pt.go +++ b/pt.go @@ -136,11 +136,11 @@ func (w syncWriter) Write(p []byte) (n int, err error) { return } -// Writer to which pluggable-transport negotiation messages are written. It +// Writer to which pluggable transports negotiation messages are written. It // defaults to a Writer that writes to os.Stdout and calls Sync after each // write. // -// You may, for example, log pluggable-transport messages by defining a Writer +// You may, for example, log pluggable transports messages by defining a Writer // that logs what is written to it: // type logWriteWrapper struct { // io.Writer @@ -316,7 +316,7 @@ type ClientInfo struct { MethodNames []string } -// Check the client pluggable transports environments, emitting an error message +// Check the client pluggable transports environment, emitting an error message // and returning a non-nil error if any error is encountered. Returns a // ClientInfo struct. func ClientSetup(methodNames []string) (info ClientInfo, err error) { @@ -494,7 +494,7 @@ type ServerInfo struct { AuthCookie []byte } -// Check the server pluggable transports environments, emitting an error message +// Check the server pluggable transports environment, emitting an error message // and returning a non-nil error if any error is encountered. Resolves the // various requested bind addresses, the server ORPort and extended ORPort, and // reads the auth cookie file. Returns a ServerInfo struct.

1 0

[goptlib/master] encodeSmethodArgs.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit 9a9f9cb455d17bf82d02292953b945dcbb4a5029 Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 02:53:38 2013 -0800 encodeSmethodArgs. --- args.go | 44 ++++++++++++++++++++++++++++++++++++++++++++ args_test.go | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) diff --git a/args.go b/args.go index a0a3bd5..9eacee5 100644 --- a/args.go +++ b/args.go @@ -4,6 +4,8 @@ import ( "bytes" "errors" "fmt" + "sort" + "strings" ) // Key–value mappings for the representation of client and server options. @@ -173,3 +175,45 @@ func parseServerTransportOptions(s string) (opts map[string]Args, err error) { } return opts, nil } + +// Escape backslashes and all the bytes that are in set. +func backslashEscape(s string, set []byte) string { + var buf bytes.Buffer + for _, b := range []byte(s) { + if b == '\\' || bytes.IndexByte(set, b) != -1 { + buf.WriteByte('\\') + } + buf.WriteByte(b) + } + return buf.String() +} + +// Encode a name–value mapping so that it is suitable to go in the ARGS option +// of an SMETHOD line. The output is sorted by key. The "ARGS:" prefix is not +// added. +// +// "Equal signs and commas [and backslashes] must be escaped with a backslash." +func encodeSmethodArgs(args Args) string { + if args == nil { + return "" + } + + keys := make([]string, 0, len(args)) + for key, _ := range args { + keys = append(keys, key) + } + sort.Strings(keys) + + escape := func(s string) string { + return backslashEscape(s, []byte{'=', ','}) + } + + var pairs []string + for _, key := range keys { + for _, value := range args[key] { + pairs = append(pairs, escape(key)+"="+escape(value)) + } + } + + return strings.Join(pairs, ",") +} diff --git a/args_test.go b/args_test.go index ece7a50..d62968c 100644 --- a/args_test.go +++ b/args_test.go @@ -299,3 +299,38 @@ func TestParseServerTransportOptions(t *testing.T) { } } } + +func TestEncodeSmethodArgs(t *testing.T) { + tests := [...]struct { + args Args + expected string + }{ + { + Args{}, + "", + }, + { + Args{"j": []string{"v1", "v2", "v3"}, "k": []string{"v1", "v2", "v3"}}, + "j=v1,j=v2,j=v3,k=v1,k=v2,k=v3", + }, + { + Args{"=,\\": []string{"=", ",", "\\"}}, + "\\=\\,\\\\=\\=,\\=\\,\\\\=\\,,\\=\\,\\\\=\\\\", + }, + { + Args{"secret": []string{"yes"}}, + "secret=yes", + }, + { + Args{"secret": []string{"nou"}, "cache": []string{"/tmp/cache"}}, + "cache=/tmp/cache,secret=nou", + }, + } + + for _, test := range tests { + encoded := encodeSmethodArgs(test.args) + if encoded != test.expected { + t.Errorf("%q → %q (expected %q)", test.args, encoded, test.expected) + } + } +}

1 0

[goptlib/master] Put the non-IPv4 zero bytes comment on an exposed function too.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit 6f5f941eaaac295edab1ab158aa825087cba46ba Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 11:01:50 2013 -0800 Put the non-IPv4 zero bytes comment on an exposed function too. --- socks.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/socks.go b/socks.go index 583b999..d33afce 100644 --- a/socks.go +++ b/socks.go @@ -33,7 +33,8 @@ type SocksConn struct { } // Send a message to the proxy client that access to the given address is -// granted. +// granted. If the IP field inside addr is not an IPv4 address, the IP portion +// of the response will be four zero bytes. func (conn *SocksConn) Grant(addr *net.TCPAddr) error { return sendSocks4aResponseGranted(conn, addr) }

1 0

[goptlib/master] Move SocksListener.Version.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit e0af87951d81eb67f706f104cb3a2b2af99a881c Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 11:04:48 2013 -0800 Move SocksListener.Version. --- socks.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/socks.go b/socks.go index d33afce..500a1fa 100644 --- a/socks.go +++ b/socks.go @@ -100,11 +100,6 @@ func (ln *SocksListener) Accept() (net.Conn, error) { return ln.AcceptSocks() } -// Returns "socks4", suitable to be included in a call to pt.Cmethod. -func (ln *SocksListener) Version() string { - return "socks4" -} - // Call Accept on the wrapped net.Listener, do SOCKS negotiation, and return a // SocksConn. After accepting, you must call either conn.Grant or conn.Reject // (presumably after trying to connect to conn.Req.Target). @@ -123,6 +118,11 @@ func (ln *SocksListener) AcceptSocks() (*SocksConn, error) { return conn, nil } +// Returns "socks4", suitable to be included in a call to pt.Cmethod. +func (ln *SocksListener) Version() string { + return "socks4" +} + // Read a SOCKS4a connect request. Returns a SocksRequest. func readSocks4aConnect(s io.Reader) (req SocksRequest, err error) { r := bufio.NewReader(s)

1 0

[goptlib/master] Return a generic net.Conn from ConnectOr.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit ee5deba3d72bbde1cfd42547066519321be88bff Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 11:21:13 2013 -0800 Return a generic net.Conn from ConnectOr. --- pt.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pt.go b/pt.go index b8b88ce..f926ee9 100644 --- a/pt.go +++ b/pt.go @@ -743,10 +743,10 @@ func extOrPortSetup(s io.ReadWriter, addr net.Addr, methodName string) error { } // Connect to info.ExtendedOrAddr if defined, or else info.OrAddr, and return an -// open *net.TCPConn. If connecting to the extended OR port, extended OR port +// open net.Conn. If connecting to the extended OR port, extended OR port // authentication à la 217-ext-orport-auth.txt is done before returning; an // error is returned if authentication fails. -func ConnectOr(info *ServerInfo, addr net.Addr, methodName string) (*net.TCPConn, error) { +func ConnectOr(info *ServerInfo, addr net.Addr, methodName string) (net.Conn, error) { if info.ExtendedOrAddr == nil { return net.DialTCP("tcp", nil, info.OrAddr) }

1 0

[goptlib/master] Add tests for weird port numbers.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit 14ddb9b88bfddc897e3deb7fe02967afbe0090c7 Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 11:32:12 2013 -0800 Add tests for weird port numbers. --- FAIL: TestResolveAddr (0.00 seconds) pt_test.go:221: "1.2.3.4:http" unexpectedly succeeded: "1.2.3.4:80" pt_test.go:221: "1.2.3.4:65536" unexpectedly succeeded: "1.2.3.4:0" --- pt_test.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pt_test.go b/pt_test.go index f3d9bc1..e75bb02 100644 --- a/pt_test.go +++ b/pt_test.go @@ -201,6 +201,10 @@ func TestResolveAddr(t *testing.T) { "1:2:3:4::9999", "localhost:9999", "[localhost]:9999", + "1.2.3.4:http", + "1.2.3.4:0x50", + "1.2.3.4:-65456", + "1.2.3.4:65536", } goodTests := [...]struct { input string

1 0

[goptlib/master] Fix TestResolveAddr.
by dcf＠torproject.org 08 Dec '13

08 Dec '13

commit f78c529302ea34027039336fee08991ebc367ce9 Author: David Fifield <david(a)bamsoftware.com> Date: Sun Dec 8 11:41:35 2013 -0800 Fix TestResolveAddr. We try reading the address from the Buffer with a size one greater than its expected length, to ensure that it's not too long. But we didn't trim that extra byte before trying to resolve it again, so there was an extra '\x00' at the end. Previously it was ignored by net.LookupPort. --- pt_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pt_test.go b/pt_test.go index 653d64d..856b23c 100644 --- a/pt_test.go +++ b/pt_test.go @@ -496,7 +496,7 @@ func TestExtOrSendUserAddr(t *testing.T) { } // test that parsing the address gives something equivalent to // the original. - outputAddr, err := resolveAddr(string(p)) + outputAddr, err := resolveAddr(string(p[:n])) if err != nil { t.Fatal(err) }

1 0