chore: add outline-go-tun2socks, except android

.github/CODEOWNERS

@@ -1,5 +1,6 @@
 *       @Jigsaw-Code/outline-dev
 
+/outline/tun2socks/   @Jigsaw-Code/outline-networking-owners
 /src/cordova/plugin/  @Jigsaw-Code/outline-networking-owners
 /third_party/         @Jigsaw-Code/outline-networking-owners
 /tools/               @Jigsaw-Code/outline-networking-owners

.gitignore

@@ -25,4 +25,32 @@ Outline.apks
 universal.apk
 toc.pb
 coverage
-*.env
+*.env
+/build
+/bin
+
+# General
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# IDEs
+.vscode/

go.mod

@@ -3,21 +3,28 @@ module github.com/Jigsaw-Code/outline-apps
 go 1.20
 
 require (
-	github.com/Jigsaw-Code/outline-sdk v0.0.2
-	github.com/Jigsaw-Code/outline-sdk/x v0.0.0-20230807220427-893de7fdc6b8
+	github.com/Jigsaw-Code/choir v1.0.1
+	github.com/Jigsaw-Code/getsni v1.0.0
+	github.com/Jigsaw-Code/outline-sdk v0.0.7
+	github.com/Jigsaw-Code/outline-sdk/x v0.0.7
+	github.com/crazy-max/xgo v0.26.0
+	github.com/eycorsican/go-tun2socks v1.16.11
 	github.com/stretchr/testify v1.8.4
-	golang.org/x/sys v0.11.0
+	golang.org/x/mobile v0.0.0-20230906132913-2077a3224571
+	golang.org/x/net v0.15.0
+	golang.org/x/sys v0.12.0
+	golang.org/x/sys/windows/registry v0.0.0-20230906132913-2077a3224571
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/eycorsican/go-tun2socks v1.16.11 // indirect
 	github.com/miekg/dns v1.1.54 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/songgao/water v0.0.0-20200317203138-2b4b6d7c09d8 // indirect
 	github.com/shadowsocks/go-shadowsocks2 v0.1.5 // indirect
-	golang.org/x/crypto v0.9.0 // indirect
-	golang.org/x/mod v0.10.0 // indirect
-	golang.org/x/net v0.10.0 // indirect
-	golang.org/x/tools v0.9.1 // indirect
+	golang.org/x/crypto v0.13.0 // indirect
+	golang.org/x/mod v0.12.0 // indirect
+	golang.org/x/sync v0.3.0 // indirect
+	golang.org/x/tools v0.13.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,7 +1,13 @@
-github.com/Jigsaw-Code/outline-sdk v0.0.2 h1:uCuyJMaWj57IYEG/Hdml8YMdk9chU60ZkSxJXBhyGHU=
-github.com/Jigsaw-Code/outline-sdk v0.0.2/go.mod h1:hhlKz0+r9wSDFT8usvN8Zv/BFToCIFAUn1P2Qk8G2CM=
+github.com/Jigsaw-Code/choir v1.0.1 h1:WeRt6aTn5L+MtRNqRJ+J1RKgoO8CyXXt1dtZghy2KjE=
+github.com/Jigsaw-Code/choir v1.0.1/go.mod h1:c4Wd1y1PeCajZbKZV+ZmcFGMDoduyqMCEMHW5iqzWXI=
+github.com/Jigsaw-Code/getsni v1.0.0 h1:OUTIu7wTBi/7DMX+RkZrN7XhU3UDevTEsAWK4gsqSwE=
+github.com/Jigsaw-Code/getsni v1.0.0/go.mod h1:Ps0Ec3fVMKLyAItVbMKoQFq1lDjtFQXZ+G5nRNNh/QE=
+github.com/Jigsaw-Code/outline-sdk v0.0.7 h1:WlFaV1tFpIQ/pflrKwrQuNIP3kJpgh7yJuqiTb54sGA=
+github.com/Jigsaw-Code/outline-sdk v0.0.7/go.mod h1:hhlKz0+r9wSDFT8usvN8Zv/BFToCIFAUn1P2Qk8G2CM=
 github.com/Jigsaw-Code/outline-sdk/x v0.0.0-20230807220427-893de7fdc6b8 h1:BxOHmmuppPM8K0DGUsfvajKF4PKfGxv9boNDhmbszFU=
 github.com/Jigsaw-Code/outline-sdk/x v0.0.0-20230807220427-893de7fdc6b8/go.mod h1:tBqJXpVm+kym+EAUdwNodcFxy872FfjVErfj8Br+gs0=
+github.com/crazy-max/xgo v0.26.0 h1:vK4OfeXJoDGvnjlzdTCgPbeWLKENbzj84DTpU/VRonM=
+github.com/crazy-max/xgo v0.26.0/go.mod h1:m/aqfKaN/cYzfw+Pzk7Mk0tkmShg3/rCS4Zdhdugi4o=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/eycorsican/go-tun2socks v1.16.11 h1:+hJDNgisrYaGEqoSxhdikMgMJ4Ilfwm/IZDrWRrbaH8=
@@ -18,27 +24,34 @@ github.com/riobard/go-bloom v0.0.0-20200614022211-cdc8013cb5b3/go.mod h1:HgjTstv
 github.com/shadowsocks/go-shadowsocks2 v0.1.5 h1:PDSQv9y2S85Fl7VBeOMF9StzeXZyK1HakRm86CUbr28=
 github.com/shadowsocks/go-shadowsocks2 v0.1.5/go.mod h1:AGGpIoek4HRno4xzyFiAtLHkOpcoznZEkAccaI/rplM=
 github.com/songgao/water v0.0.0-20190725173103-fd331bda3f4b/go.mod h1:P5HUIBuIWKbyjl083/loAegFkfbFNx5i2qEP4CNbm7E=
+github.com/songgao/water v0.0.0-20200317203138-2b4b6d7c09d8 h1:TG/diQgUe0pntT/2D9tmUCz4VNwm9MfrtPr0SU2qSX8=
+github.com/songgao/water v0.0.0-20200317203138-2b4b6d7c09d8/go.mod h1:P5HUIBuIWKbyjl083/loAegFkfbFNx5i2qEP4CNbm7E=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20200604202706-70a84ac30bf9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
-golang.org/x/crypto v0.9.0 h1:LF6fAI+IutBocDJ2OT0Q1g8plpYljMZ4+lty+dsqw3g=
-golang.org/x/crypto v0.9.0/go.mod h1:yrmDGqONDYtNj3tH8X9dzUun2m2lzPa9ngI6/RUPGR0=
-golang.org/x/mod v0.10.0 h1:lFO9qtOdlre5W1jxS3r/4szv2/6iXxScdzjoBMXNhYk=
-golang.org/x/mod v0.10.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
+golang.org/x/crypto v0.13.0 h1:mvySKfSWJ+UKUii46M40LOvyWfN0s2U+46/jDd0e6Ck=
+golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc=
+golang.org/x/mobile v0.0.0-20230906132913-2077a3224571 h1:QDvQ2KLFHHQWRID6IkZOBf6uLIh9tZ0G+mw61pFQxuo=
+golang.org/x/mobile v0.0.0-20230906132913-2077a3224571/go.mod h1:wEyOn6VvNW7tcf+bW/wBz1sehi2s2BZ4TimyR7qZen4=
+golang.org/x/mod v0.12.0 h1:rmsUpXtvNzj340zd98LZ4KntptpfRHwpFOHG188oHXc=
+golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20191021144547-ec77196f6094/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
-golang.org/x/net v0.10.0 h1:X2//UzNDwYmtCLn7To6G58Wr6f5ahEAQgKNzv9Y951M=
-golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
-golang.org/x/sync v0.2.0 h1:PUR+T4wwASmuSTYdKjYHI5TD22Wy5ogLU5qZCOLxBrI=
+golang.org/x/net v0.15.0 h1:ugBLEUaxABaB5AJqW9enI0ACdci2RUd4eP51NTBvuJ8=
+golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
+golang.org/x/sync v0.3.0 h1:ftCYgMx6zT/asHUrPw8BLLscYtGznsLAnjq5RH9P66E=
+golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM=
-golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o=
+golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/tools v0.9.1 h1:8WMNJAz3zrtPmnYC7ISf5dEn3MT0gY7jBJfw27yrrLo=
-golang.org/x/tools v0.9.1/go.mod h1:owI94Op576fPu3cIGQeHs3joujW/2Oc6MtlxbF5dfNc=
+golang.org/x/tools v0.13.0 h1:Iey4qkscZuv0VvIt8E0neZjtPVQFSc870HQ448QgEmQ=
+golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

src/tun2socks/build.action.mjs

@@ -0,0 +1 @@
+// TODO

src/tun2socks/outline/client.go

@@ -0,0 +1,27 @@
+// Copyright 2023 The Outline Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package outline
+
+import (
+	"github.com/Jigsaw-Code/outline-sdk/transport"
+)
+
+// Client provides a transparent container for [transport.StreamDialer] and [transport.PacketListener]
+// that is exportable (as an opaque object) via gobind.
+// It's used by the connectivity test and the tun2socks handlers.
+type Client struct {
+	transport.StreamDialer
+	transport.PacketListener
+}

src/tun2socks/outline/connectivity/connectivity.go

@@ -0,0 +1,157 @@
+// Copyright 2023 The Outline Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package connectivity
+
+import (
+	"context"
+	"errors"
+	"net"
+	"net/http"
+	"time"
+
+	"github.com/Jigsaw-Code/outline-apps/src/tun2socks/outline"
+	"github.com/Jigsaw-Code/outline-apps/src/tun2socks/outline/neterrors"
+	"github.com/Jigsaw-Code/outline-sdk/transport"
+)
+
+// TODO: make these values configurable by exposing a struct with the connectivity methods.
+const (
+	tcpTimeout          = 10 * time.Second
+	udpTimeout          = 1 * time.Second
+	udpMaxRetryAttempts = 5
+	bufferLength        = 512
+)
+
+// authenticationError is used to signal failed authentication to the Shadowsocks proxy.
+type authenticationError struct {
+	error
+}
+
+// reachabilityError is used to signal an unreachable proxy.
+type reachabilityError struct {
+	error
+}
+
+// CheckConnectivity determines whether the Shadowsocks proxy can relay TCP and UDP traffic under
+// the current network. Parallelizes the execution of TCP and UDP checks, selects the appropriate
+// error code to return accounting for transient network failures.
+// Returns an error if an unexpected error ocurrs.
+func CheckConnectivity(client *outline.Client) (neterrors.Error, error) {
+	// Start asynchronous UDP support check.
+	udpChan := make(chan error)
+	go func() {
+		resolverAddr := &net.UDPAddr{IP: net.ParseIP("1.1.1.1"), Port: 53}
+		udpChan <- CheckUDPConnectivityWithDNS(client, resolverAddr)
+	}()
+	// Check whether the proxy is reachable and that the client is able to authenticate to the proxy
+	tcpErr := CheckTCPConnectivityWithHTTP(client, "http://example.com")
+	if tcpErr == nil {
+		udpErr := <-udpChan
+		if udpErr == nil {
+			return neterrors.NoError, nil
+		}
+		return neterrors.UDPConnectivity, nil
+	}
+	var authErr *authenticationError
+	var reachabilityErr *reachabilityError
+	if errors.As(tcpErr, &authErr) {
+		return neterrors.AuthenticationFailure, nil
+	} else if errors.As(tcpErr, &reachabilityErr) {
+		return neterrors.Unreachable, nil
+	}
+	// The error is not related to the connectivity checks.
+	return neterrors.Unexpected, tcpErr
+}
+
+// CheckUDPConnectivityWithDNS determines whether the Shadowsocks proxy represented by `client` and
+// the network support UDP traffic by issuing a DNS query though a resolver at `resolverAddr`.
+// Returns nil on success or an error on failure.
+func CheckUDPConnectivityWithDNS(client transport.PacketListener, resolverAddr net.Addr) error {
+	conn, err := client.ListenPacket(context.Background())
+	if err != nil {
+		return err
+	}
+	defer conn.Close()
+	buf := make([]byte, bufferLength)
+	for attempt := 0; attempt < udpMaxRetryAttempts; attempt++ {
+		conn.SetDeadline(time.Now().Add(udpTimeout))
+		_, err := conn.WriteTo(getDNSRequest(), resolverAddr)
+		if err != nil {
+			continue
+		}
+		n, addr, err := conn.ReadFrom(buf)
+		if n == 0 && err != nil {
+			continue
+		}
+		if addr.String() != resolverAddr.String() {
+			continue // Ensure we got a response from the resolver.
+		}
+		return nil
+	}
+	return errors.New("UDP connectivity check timed out")
+}
+
+// CheckTCPConnectivityWithHTTP determines whether the proxy is reachable over TCP and validates the
+// client's authentication credentials by performing an HTTP HEAD request to `targetURL`, which must
+// be of the form: http://[host](:[port])(/[path]). Returns nil on success, error if `targetURL` is
+// invalid, AuthenticationError or ReachabilityError on connectivity failure.
+func CheckTCPConnectivityWithHTTP(dialer transport.StreamDialer, targetURL string) error {
+	deadline := time.Now().Add(tcpTimeout)
+	ctx, cancel := context.WithDeadline(context.Background(), deadline)
+	defer cancel()
+	req, err := http.NewRequest("HEAD", targetURL, nil)
+	if err != nil {
+		return err
+	}
+	targetAddr := req.Host
+	if !hasPort(targetAddr) {
+		targetAddr = net.JoinHostPort(targetAddr, "80")
+	}
+	conn, err := dialer.Dial(ctx, targetAddr)
+	if err != nil {
+		return &reachabilityError{err}
+	}
+	defer conn.Close()
+	conn.SetDeadline(deadline)
+	err = req.Write(conn)
+	if err != nil {
+		return &authenticationError{err}
+	}
+	n, err := conn.Read(make([]byte, bufferLength))
+	if n == 0 && err != nil {
+		return &authenticationError{err}
+	}
+	return nil
+}
+
+func getDNSRequest() []byte {
+	return []byte{
+		0, 0, // [0-1]   query ID
+		1, 0, // [2-3]   flags; byte[2] = 1 for recursion desired (RD).
+		0, 1, // [4-5]   QDCOUNT (number of queries)
+		0, 0, // [6-7]   ANCOUNT (number of answers)
+		0, 0, // [8-9]   NSCOUNT (number of name server records)
+		0, 0, // [10-11] ARCOUNT (number of additional records)
+		3, 'c', 'o', 'm',
+		0,    // null terminator of FQDN (root TLD)
+		0, 1, // QTYPE, set to A
+		0, 1, // QCLASS, set to 1 = IN (Internet)
+	}
+}
+
+func hasPort(hostPort string) bool {
+	_, _, err := net.SplitHostPort(hostPort)
+	return err == nil
+}