Prefix Transport debugging fixes (#183)

* enusre that relevant transport params are logged and prefix regs ingested properly

* Randomizing prefixes, destination port randomization and config for client iface

* making prefix transport instantiation easier

* prefix transport default value mistake

Author: jmwample

application/lib/proxies.go

@@ -223,6 +223,11 @@ func Proxy(reg *DecoyRegistration, clientConn net.Conn, logger *log.Logger) {
 		Gen:         uint(reg.DecoyListVersion),
 	}
 
+	paramStrs := (*reg.TransportPtr).ParamStrings(reg.TransportParams)
+	if paramStrs != nil {
+		tunStats.TransportOpts = paramStrs
+	}
+
 	covertConn, err := net.Dial("tcp", reg.Covert)
 	if e := generalizeErr(err); e != nil {
 		tunStats.CovertDialErr = e.Error()

application/lib/registration.go

@@ -272,6 +272,7 @@ type DecoyRegistration struct {
 	Covert, Mask       string
 	Flags              *pb.RegistrationFlags
 	Transport          pb.TransportType
+	TransportPtr       *Transport
 	TransportParams    any
 	RegistrationTime   time.Time
 	RegistrationSource *pb.RegistrationSource

application/lib/registration_ingest.go

@@ -348,6 +348,11 @@ func (rm *RegistrationManager) NewRegistration(c2s *pb.ClientToStation, conjureK
 			err)
 	}
 
+	var transport, ok = rm.registeredDecoys.transports[c2s.GetTransport()]
+	if !ok {
+		return nil, fmt.Errorf("unknown transport")
+	}
+
 	transportParams, err := rm.getTransportParams(c2s.GetTransport(), c2s.GetTransportParams(), clientLibVer)
 	if err != nil {
 		return nil, fmt.Errorf("error handling transport params: %s", err)
@@ -368,6 +373,7 @@ func (rm *RegistrationManager) NewRegistration(c2s *pb.ClientToStation, conjureK
 		Keys:             conjureKeys,
 		Covert:           c2s.GetCovertAddress(),
 		Transport:        c2s.GetTransport(),
+		TransportPtr:     &transport,
 		TransportParams:  transportParams,
 		Flags:            c2s.Flags,
 

application/lib/transports.go

@@ -38,6 +38,10 @@ type Transport interface {
 	// provided by the client during registration. The libVersion is provided incase of version
 	// dependent changes in the transport params or param parsing.
 	ParseParams(libVersion uint, data *anypb.Any) (any, error)
+
+	// ParamStrings returns an array of tag string that will be added to tunStats when a proxy
+	// session is closed.
+	ParamStrings(p any) []string
 }
 
 // WrappingTransport describes any transport that is able to passively

application/lib/transports_mock.go

@@ -56,6 +56,12 @@ func (*mockTransport) ParseParams(libVersion uint, data *anypb.Any) (any, error)
 	return m, err
 }
 
+// ParamStrings returns an array of tag string that will be added to tunStats when a proxy
+// session is closed. For now, no params of interest.
+func (m *mockTransport) ParamStrings(p any) []string {
+	return nil
+}
+
 // GetDstPort Given the library version, a seed, and a generic object
 // containing parameters the transport should be able to return the
 // destination port that a clients phantom connection will attempt to reach

application/transports/wrapping/internal/tests/tests.go

@@ -9,6 +9,8 @@ import (
 	dd "github.com/refraction-networking/conjure/application/lib"
 	pb "github.com/refraction-networking/gotapdance/protobuf"
 	"google.golang.org/grpc/test/bufconn"
+	"google.golang.org/protobuf/reflect/protoreflect"
+	"google.golang.org/protobuf/types/known/anypb"
 )
 
 type Transport struct {
@@ -20,13 +22,14 @@ var SharedSecret = []byte(`6a328b8ec2024dd92dd64332164cc0425ddbde40cb7b81e055bf7
 
 // SetupPhantomConnections registers one session with the provided transport and
 // registration manager using a pre-determined kay and phantom subnet file.
-func SetupPhantomConnections(manager *dd.RegistrationManager, transport pb.TransportType, libver uint) (clientToPhantom net.Conn, serverFromPhantom net.Conn, reg *dd.DecoyRegistration) {
+func SetupPhantomConnections(manager *dd.RegistrationManager, transport pb.TransportType, params protoreflect.ProtoMessage, libver uint) (clientToPhantom net.Conn, serverFromPhantom net.Conn, reg *dd.DecoyRegistration) {
 	cwd, _ := os.Getwd()
 	testSubnetPath := cwd + "/../internal/tests/phantom_subnets.toml"
-	return SetupPhantomConnectionsSecret(manager, transport, SharedSecret, libver, testSubnetPath)
+
+	return SetupPhantomConnectionsSecret(manager, transport, params, SharedSecret, libver, testSubnetPath)
 }
 
-func SetupPhantomConnectionsSecret(manager *dd.RegistrationManager, transport pb.TransportType, sharedSecret []byte, libver uint, testSubnetPath string) (clientToPhantom net.Conn, serverFromPhantom net.Conn, reg *dd.DecoyRegistration) {
+func SetupPhantomConnectionsSecret(manager *dd.RegistrationManager, transport pb.TransportType, params protoreflect.ProtoMessage, sharedSecret []byte, libver uint, testSubnetPath string) (clientToPhantom net.Conn, serverFromPhantom net.Conn, reg *dd.DecoyRegistration) {
 	os.Setenv("PHANTOM_SUBNET_LOCATION", testSubnetPath)
 
 	phantom := bufconn.Listen(65535)
@@ -66,6 +69,14 @@ func SetupPhantomConnectionsSecret(manager *dd.RegistrationManager, transport pb
 		CovertAddress:       &covert,
 		DecoyListGeneration: &gen,
 	}
+	if params != nil {
+		p, err := anypb.New(params)
+		if err != nil {
+			log.Fatalln("failed to make params", err)
+		}
+		c2s.TransportParams = p
+	}
+
 	reg, err = manager.NewRegistration(c2s, &keys, false, &regType)
 	if err != nil {
 		log.Fatalln("failed to create new Registration:", err)

application/transports/wrapping/min/client.go

@@ -39,8 +39,8 @@ func (*ClientTransport) ID() pb.TransportType {
 
 // GetParams returns a generic protobuf with any parameters from both the registration and the
 // transport.
-func (t *ClientTransport) GetParams() proto.Message {
-	return t.Parameters
+func (t *ClientTransport) GetParams() (proto.Message, error) {
+	return t.Parameters, nil
 }
 
 // SetParams allows the caller to set parameters associated with the transport, returning an
@@ -56,7 +56,7 @@ func (t *ClientTransport) SetParams(p any) error {
 }
 
 // GetDstPort returns the destination port that the client should open the phantom connection to
-func (t *ClientTransport) GetDstPort(seed []byte, params any) (uint16, error) {
+func (t *ClientTransport) GetDstPort(seed []byte) (uint16, error) {
 	if t.Parameters == nil || !t.Parameters.GetRandomizeDstPort() {
 		return 443, nil
 	}

application/transports/wrapping/min/min.go

@@ -69,6 +69,12 @@ func (Transport) ParseParams(libVersion uint, data *anypb.Any) (any, error) {
 	return m, err
 }
 
+// ParamStrings returns an array of tag string that will be added to tunStats when a proxy
+// session is closed. For now, no params of interest.
+func (t Transport) ParamStrings(p any) []string {
+	return nil
+}
+
 // WrapConnection attempts to wrap the given connection in the transport. It
 // takes the information gathered so far on the connection in data, attempts to
 // identify itself, and if it positively identifies itself wraps the connection

application/transports/wrapping/min/min_test.go

@@ -24,7 +24,7 @@ func TestSuccessfulWrap(t *testing.T) {
 
 	var transport Transport
 	manager := tests.SetupRegistrationManager(tests.Transport{Index: pb.TransportType_Min, Transport: transport})
-	c2p, sfp, reg := tests.SetupPhantomConnections(manager, pb.TransportType_Min, 0)
+	c2p, sfp, reg := tests.SetupPhantomConnections(manager, pb.TransportType_Min, nil, 0)
 	defer c2p.Close()
 	defer sfp.Close()
 	require.NotNil(t, reg)
@@ -52,7 +52,7 @@ func TestSuccessfulWrap(t *testing.T) {
 func TestUnsuccessfulWrap(t *testing.T) {
 	var transport Transport
 	manager := tests.SetupRegistrationManager(tests.Transport{Index: pb.TransportType_Min, Transport: transport})
-	c2p, sfp, reg := tests.SetupPhantomConnections(manager, pb.TransportType_Min, 0)
+	c2p, sfp, reg := tests.SetupPhantomConnections(manager, pb.TransportType_Min, nil, 0)
 	defer c2p.Close()
 	defer sfp.Close()
 
@@ -76,7 +76,7 @@ func TestTryAgain(t *testing.T) {
 	var transport Transport
 	var err error
 	manager := tests.SetupRegistrationManager(tests.Transport{Index: pb.TransportType_Min, Transport: transport})
-	c2p, sfp, reg := tests.SetupPhantomConnections(manager, pb.TransportType_Min, 0)
+	c2p, sfp, reg := tests.SetupPhantomConnections(manager, pb.TransportType_Min, nil, 0)
 	defer c2p.Close()
 	defer sfp.Close()
 
@@ -119,13 +119,15 @@ func TestTryParamsToDstPort(t *testing.T) {
 		ct := ClientTransport{Parameters: &pb.GenericTransportParams{RandomizeDstPort: &testCase.r}}
 		var transport Transport
 
-		rawParams, err := anypb.New(ct.GetParams())
+		params, err := ct.GetParams()
+		require.Nil(t, err)
+		rawParams, err := anypb.New(params)
 		require.Nil(t, err)
 
-		params, err := transport.ParseParams(clv, rawParams)
+		newParams, err := transport.ParseParams(clv, rawParams)
 		require.Nil(t, err)
 
-		port, err := transport.GetDstPort(clv, seed, params)
+		port, err := transport.GetDstPort(clv, seed, newParams)
 		require.Nil(t, err)
 		require.Equal(t, testCase.p, port)
 	}

application/transports/wrapping/obfs4/client.go

@@ -39,8 +39,8 @@ func (*ClientTransport) ID() pb.TransportType {
 
 // GetParams returns a generic protobuf with any parameters from both the registration and the
 // transport.
-func (t *ClientTransport) GetParams() proto.Message {
-	return t.Parameters
+func (t *ClientTransport) GetParams() (proto.Message, error) {
+	return t.Parameters, nil
 }
 
 // SetParams allows the caller to set parameters associated with the transport, returning an
@@ -56,7 +56,7 @@ func (t *ClientTransport) SetParams(p any) error {
 }
 
 // GetDstPort returns the destination port that the client should open the phantom connection to
-func (t *ClientTransport) GetDstPort(seed []byte, params any) (uint16, error) {
+func (t *ClientTransport) GetDstPort(seed []byte) (uint16, error) {
 	if t.Parameters == nil || !t.Parameters.GetRandomizeDstPort() {
 		return 443, nil
 	}