tailcfg: add Endpoint, EndpointType, MapRequest.EndpointType

Track endpoints internally with a new tailcfg.Endpoint type that
includes a typed netaddr.IPPort (instead of just a string) and
includes a type for how that endpoint was discovered (STUN, local,
etc).

Use []tailcfg.Endpoint instead of []string internally.

At the last second, send it to the control server as the existing
[]string for endpoints, but also include a new parallel
MapRequest.EndpointType []tailcfg.EndpointType, so the control server
can start filtering out less-important endpoint changes from
new-enough clients. Notably, STUN-discovered endpoints can be filtered
out from 1.6+ clients, as they can discover them amongst each other
via CallMeMaybe disco exchanges started over DERP. And STUN endpoints
change a lot, causing a lot of MapResposne updates. But portmapped
endpoints are worth keeping for now, as they they work right away
without requiring the firewall traversal extra RTT dance.

End result will be less control->client bandwidth. (despite negligible
increase in client->control bandwidth)

Updates tailscale/corp#1543

Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
This commit is contained in:
Brad Fitzpatrick 2021-04-12 13:24:29 -07:00 committed by Brad Fitzpatrick
parent b91f3c4191
commit 34d2f5a3d9
11 changed files with 186 additions and 94 deletions

View File

@ -738,7 +738,7 @@ func (c *Client) Logout(ctx context.Context) error {
// //
// The localPort field is unused except for integration tests in // The localPort field is unused except for integration tests in
// another repo. // another repo.
func (c *Client) UpdateEndpoints(localPort uint16, endpoints []string) { func (c *Client) UpdateEndpoints(localPort uint16, endpoints []tailcfg.Endpoint) {
changed := c.direct.SetEndpoints(localPort, endpoints) changed := c.direct.SetEndpoints(localPort, endpoints)
if changed { if changed {
c.sendNewMapRequest() c.sendNewMapRequest()

View File

@ -76,7 +76,7 @@ type Direct struct {
expiry *time.Time expiry *time.Time
// hostinfo is mutated in-place while mu is held. // hostinfo is mutated in-place while mu is held.
hostinfo *tailcfg.Hostinfo // always non-nil hostinfo *tailcfg.Hostinfo // always non-nil
endpoints []string endpoints []tailcfg.Endpoint
everEndpoints bool // whether we've ever had non-empty endpoints everEndpoints bool // whether we've ever had non-empty endpoints
localPort uint16 // or zero to mean auto localPort uint16 // or zero to mean auto
} }
@ -506,7 +506,7 @@ func (c *Direct) doLogin(ctx context.Context, opt loginOpt) (mustRegen bool, new
return false, resp.AuthURL, nil return false, resp.AuthURL, nil
} }
func sameStrings(a, b []string) bool { func sameEndpoints(a, b []tailcfg.Endpoint) bool {
if len(a) != len(b) { if len(a) != len(b) {
return false return false
} }
@ -522,15 +522,19 @@ func sameStrings(a, b []string) bool {
// whether they've changed. // whether they've changed.
// //
// It does not retain the provided slice. // It does not retain the provided slice.
func (c *Direct) newEndpoints(localPort uint16, endpoints []string) (changed bool) { func (c *Direct) newEndpoints(localPort uint16, endpoints []tailcfg.Endpoint) (changed bool) {
c.mu.Lock() c.mu.Lock()
defer c.mu.Unlock() defer c.mu.Unlock()
// Nothing new? // Nothing new?
if c.localPort == localPort && sameStrings(c.endpoints, endpoints) { if c.localPort == localPort && sameEndpoints(c.endpoints, endpoints) {
return false // unchanged return false // unchanged
} }
c.logf("client.newEndpoints(%v, %v)", localPort, endpoints) var epStrs []string
for _, ep := range endpoints {
epStrs = append(epStrs, ep.Addr.String())
}
c.logf("client.newEndpoints(%v, %v)", localPort, epStrs)
c.localPort = localPort c.localPort = localPort
c.endpoints = append(c.endpoints[:0], endpoints...) c.endpoints = append(c.endpoints[:0], endpoints...)
if len(endpoints) > 0 { if len(endpoints) > 0 {
@ -542,7 +546,7 @@ func (c *Direct) newEndpoints(localPort uint16, endpoints []string) (changed boo
// SetEndpoints updates the list of locally advertised endpoints. // SetEndpoints updates the list of locally advertised endpoints.
// It won't be replicated to the server until a *fresh* call to PollNetMap(). // It won't be replicated to the server until a *fresh* call to PollNetMap().
// You don't need to restart PollNetMap if we return changed==false. // You don't need to restart PollNetMap if we return changed==false.
func (c *Direct) SetEndpoints(localPort uint16, endpoints []string) (changed bool) { func (c *Direct) SetEndpoints(localPort uint16, endpoints []tailcfg.Endpoint) (changed bool) {
// (no log message on function entry, because it clutters the logs // (no log message on function entry, because it clutters the logs
// if endpoints haven't changed. newEndpoints() will log it.) // if endpoints haven't changed. newEndpoints() will log it.)
return c.newEndpoints(localPort, endpoints) return c.newEndpoints(localPort, endpoints)
@ -575,7 +579,12 @@ func (c *Direct) sendMapRequest(ctx context.Context, maxPolls int, cb func(*netm
hostinfo := c.hostinfo.Clone() hostinfo := c.hostinfo.Clone()
backendLogID := hostinfo.BackendLogID backendLogID := hostinfo.BackendLogID
localPort := c.localPort localPort := c.localPort
ep := append([]string(nil), c.endpoints...) var epStrs []string
var epTypes []tailcfg.EndpointType
for _, ep := range c.endpoints {
epStrs = append(epStrs, ep.Addr.String())
epTypes = append(epTypes, ep.Type)
}
everEndpoints := c.everEndpoints everEndpoints := c.everEndpoints
c.mu.Unlock() c.mu.Unlock()
@ -595,7 +604,7 @@ func (c *Direct) sendMapRequest(ctx context.Context, maxPolls int, cb func(*netm
} }
allowStream := maxPolls != 1 allowStream := maxPolls != 1
c.logf("[v1] PollNetMap: stream=%v :%v ep=%v", allowStream, localPort, ep) c.logf("[v1] PollNetMap: stream=%v :%v ep=%v", allowStream, localPort, epStrs)
vlogf := logger.Discard vlogf := logger.Discard
if Debug.NetMap { if Debug.NetMap {
@ -605,15 +614,16 @@ func (c *Direct) sendMapRequest(ctx context.Context, maxPolls int, cb func(*netm
} }
request := &tailcfg.MapRequest{ request := &tailcfg.MapRequest{
Version: tailcfg.CurrentMapRequestVersion, Version: tailcfg.CurrentMapRequestVersion,
KeepAlive: c.keepAlive, KeepAlive: c.keepAlive,
NodeKey: tailcfg.NodeKey(persist.PrivateNodeKey.Public()), NodeKey: tailcfg.NodeKey(persist.PrivateNodeKey.Public()),
DiscoKey: c.discoPubKey, DiscoKey: c.discoPubKey,
Endpoints: ep, Endpoints: epStrs,
Stream: allowStream, EndpointTypes: epTypes,
Hostinfo: hostinfo, Stream: allowStream,
DebugFlags: c.debugFlags, Hostinfo: hostinfo,
OmitPeers: cb == nil, DebugFlags: c.debugFlags,
OmitPeers: cb == nil,
} }
var extraDebugFlags []string var extraDebugFlags []string
if hostinfo != nil && c.linkMon != nil && !c.skipIPForwardingCheck && if hostinfo != nil && c.linkMon != nil && !c.skipIPForwardingCheck &&
@ -641,7 +651,7 @@ func (c *Direct) sendMapRequest(ctx context.Context, maxPolls int, cb func(*netm
// TODO(bradfitz): we skip this optimization in tests, though, // TODO(bradfitz): we skip this optimization in tests, though,
// because the e2e tests are currently hyperspecific about the // because the e2e tests are currently hyperspecific about the
// ordering of things. The e2e tests need love. // ordering of things. The e2e tests need love.
if len(ep) == 0 && !everEndpoints && !inTest() { if len(epStrs) == 0 && !everEndpoints && !inTest() {
request.ReadOnly = true request.ReadOnly = true
} }

View File

@ -11,6 +11,7 @@
"strings" "strings"
"testing" "testing"
"inet.af/netaddr"
"tailscale.com/tailcfg" "tailscale.com/tailcfg"
"tailscale.com/types/wgkey" "tailscale.com/types/wgkey"
) )
@ -144,7 +145,7 @@ func TestNewDirect(t *testing.T) {
t.Errorf("c.SetHostinfo(hi) want true got %v", changed) t.Errorf("c.SetHostinfo(hi) want true got %v", changed)
} }
endpoints := []string{"1", "2", "3"} endpoints := fakeEndpoints(1, 2, 3)
changed = c.newEndpoints(12, endpoints) changed = c.newEndpoints(12, endpoints)
if !changed { if !changed {
t.Errorf("c.newEndpoints(12) want true got %v", changed) t.Errorf("c.newEndpoints(12) want true got %v", changed)
@ -157,13 +158,22 @@ func TestNewDirect(t *testing.T) {
if !changed { if !changed {
t.Errorf("c.newEndpoints(13) want true got %v", changed) t.Errorf("c.newEndpoints(13) want true got %v", changed)
} }
endpoints = []string{"4", "5", "6"} endpoints = fakeEndpoints(4, 5, 6)
changed = c.newEndpoints(13, endpoints) changed = c.newEndpoints(13, endpoints)
if !changed { if !changed {
t.Errorf("c.newEndpoints(13) want true got %v", changed) t.Errorf("c.newEndpoints(13) want true got %v", changed)
} }
} }
func fakeEndpoints(ports ...uint16) (ret []tailcfg.Endpoint) {
for _, port := range ports {
ret = append(ret, tailcfg.Endpoint{
Addr: netaddr.IPPort{Port: port},
})
}
return
}
func TestNewHostinfo(t *testing.T) { func TestNewHostinfo(t *testing.T) {
hi := NewHostinfo() hi := NewHostinfo()
if hi == nil { if hi == nil {

View File

@ -111,7 +111,7 @@ type LocalBackend struct {
nodeByAddr map[netaddr.IP]*tailcfg.Node nodeByAddr map[netaddr.IP]*tailcfg.Node
activeLogin string // last logged LoginName from netMap activeLogin string // last logged LoginName from netMap
engineStatus ipn.EngineStatus engineStatus ipn.EngineStatus
endpoints []string endpoints []tailcfg.Endpoint
blocked bool blocked bool
authURL string authURL string
interact bool interact bool
@ -544,7 +544,7 @@ func (b *LocalBackend) setWgengineStatus(s *wgengine.Status, err error) {
es := b.parseWgStatusLocked(s) es := b.parseWgStatusLocked(s)
cc := b.cc cc := b.cc
b.engineStatus = es b.engineStatus = es
b.endpoints = append([]string{}, s.LocalAddrs...) b.endpoints = append([]tailcfg.Endpoint{}, s.LocalAddrs...)
b.mu.Unlock() b.mu.Unlock()
if cc != nil { if cc != nil {

View File

@ -82,7 +82,6 @@ func TestLocalLogLines(t *testing.T) {
LastHandshake: time.Now(), LastHandshake: time.Now(),
NodeKey: tailcfg.NodeKey(key.NewPrivate()), NodeKey: tailcfg.NodeKey(key.NewPrivate()),
}}, }},
LocalAddrs: []string{"idk an address"},
} }
lb.mu.Lock() lb.mu.Lock()
lb.parseWgStatusLocked(status) lb.parseWgStatusLocked(status)

View File

@ -636,6 +636,42 @@ type RegisterResponse struct {
AuthURL string // if set, authorization pending AuthURL string // if set, authorization pending
} }
// EndpointType distinguishes different sources of MapRequest.Endpoint values.
type EndpointType int
const (
EndpointUnknownType = EndpointType(0)
EndpointLocal = EndpointType(1)
EndpointSTUN = EndpointType(2)
EndpointPortmapped = EndpointType(3)
EndpointSTUN4LocalPort = EndpointType(4) // hard NAT: STUN'ed IPv4 address + local fixed port
)
func (et EndpointType) String() string {
switch et {
case EndpointUnknownType:
return "?"
case EndpointLocal:
return "local"
case EndpointSTUN:
return "stun"
case EndpointPortmapped:
return "portmap"
case EndpointSTUN4LocalPort:
return "stun4localport"
}
return "other"
}
// Endpoint is an endpoint IPPort and an associated type.
// It doesn't currently go over the wire as is but is instead
// broken up into two parallel slices in MapReqeust, for compatibility
// reasons. But this type is used in the codebase.
type Endpoint struct {
Addr netaddr.IPPort
Type EndpointType
}
// MapRequest is sent by a client to start a long-poll network map updates. // MapRequest is sent by a client to start a long-poll network map updates.
// The request includes a copy of the client's current set of WireGuard // The request includes a copy of the client's current set of WireGuard
// endpoints and general host information. // endpoints and general host information.
@ -655,11 +691,15 @@ type MapRequest struct {
KeepAlive bool // whether server should send keep-alives back to us KeepAlive bool // whether server should send keep-alives back to us
NodeKey NodeKey NodeKey NodeKey
DiscoKey DiscoKey DiscoKey DiscoKey
Endpoints []string // caller's endpoints (IPv4 or IPv6) IncludeIPv6 bool `json:",omitempty"` // include IPv6 endpoints in returned Node Endpoints (for Version 4 clients)
IncludeIPv6 bool `json:",omitempty"` // include IPv6 endpoints in returned Node Endpoints (for Version 4 clients) Stream bool // if true, multiple MapResponse objects are returned
Stream bool // if true, multiple MapResponse objects are returned
Hostinfo *Hostinfo Hostinfo *Hostinfo
// Endpoints are the client's magicsock UDP ip:port endpoints (IPv4 or IPv6).
Endpoints []string
// EndpointTypes are the types of the corresponding endpoints in Endpoints.
EndpointTypes []EndpointType `json:",omitempty"`
// ReadOnly is whether the client just wants to fetch the // ReadOnly is whether the client just wants to fetch the
// MapResponse, without updating their Endpoints. The // MapResponse, without updating their Endpoints. The
// Endpoints field will be ignored and LastSeen will not be // Endpoints field will be ignored and LastSeen will not be

View File

@ -500,3 +500,21 @@ func TestUserProfileJSONMarshalForMac(t *testing.T) {
t.Fatalf("Unmarshal: %v", err) t.Fatalf("Unmarshal: %v", err)
} }
} }
func TestEndpointTypeMarshal(t *testing.T) {
eps := []EndpointType{
EndpointUnknownType,
EndpointLocal,
EndpointSTUN,
EndpointPortmapped,
EndpointSTUN4LocalPort,
}
got, err := json.Marshal(eps)
if err != nil {
t.Fatal(err)
}
const want = `[0,1,2,3,4]`
if string(got) != want {
t.Errorf("got %s; want %s", got, want)
}
}

View File

@ -116,7 +116,7 @@ type Conn struct {
logf logger.Logf logf logger.Logf
port uint16 // the preferred port from opts.Port; 0 means auto port uint16 // the preferred port from opts.Port; 0 means auto
epFunc func(endpoints []string) epFunc func([]tailcfg.Endpoint)
derpActiveFunc func() derpActiveFunc func()
idleFunc func() time.Duration // nil means unknown idleFunc func() time.Duration // nil means unknown
packetListener nettype.PacketListener packetListener nettype.PacketListener
@ -201,7 +201,7 @@ type Conn struct {
// lastEndpoints records the endpoints found during the previous // lastEndpoints records the endpoints found during the previous
// endpoint discovery. It's used to avoid duplicate endpoint // endpoint discovery. It's used to avoid duplicate endpoint
// change notifications. // change notifications.
lastEndpoints []string lastEndpoints []tailcfg.Endpoint
// lastEndpointsTime is the last time the endpoints were updated, // lastEndpointsTime is the last time the endpoints were updated,
// even if there was no change. // even if there was no change.
@ -381,7 +381,7 @@ type Options struct {
// EndpointsFunc optionally provides a func to be called when // EndpointsFunc optionally provides a func to be called when
// endpoints change. The called func does not own the slice. // endpoints change. The called func does not own the slice.
EndpointsFunc func(endpoint []string) EndpointsFunc func([]tailcfg.Endpoint)
// DERPActiveFunc optionally provides a func to be called when // DERPActiveFunc optionally provides a func to be called when
// a connection is made to a DERP server. // a connection is made to a DERP server.
@ -432,9 +432,9 @@ func (o *Options) logf() logger.Logf {
return o.Logf return o.Logf
} }
func (o *Options) endpointsFunc() func([]string) { func (o *Options) endpointsFunc() func([]tailcfg.Endpoint) {
if o == nil || o.EndpointsFunc == nil { if o == nil || o.EndpointsFunc == nil {
return func([]string) {} return func([]tailcfg.Endpoint) {}
} }
return o.EndpointsFunc return o.EndpointsFunc
} }
@ -578,7 +578,7 @@ func (c *Conn) updateEndpoints(why string) {
}() }()
c.logf("[v1] magicsock: starting endpoint update (%s)", why) c.logf("[v1] magicsock: starting endpoint update (%s)", why)
endpoints, reasons, err := c.determineEndpoints(c.connCtx) endpoints, err := c.determineEndpoints(c.connCtx)
if err != nil { if err != nil {
c.logf("magicsock: endpoint update (%s) failed: %v", why, err) c.logf("magicsock: endpoint update (%s) failed: %v", why, err)
// TODO(crawshaw): are there any conditions under which // TODO(crawshaw): are there any conditions under which
@ -586,18 +586,18 @@ func (c *Conn) updateEndpoints(why string) {
return return
} }
if c.setEndpoints(endpoints, reasons) { if c.setEndpoints(endpoints) {
c.logEndpointChange(endpoints, reasons) c.logEndpointChange(endpoints)
c.epFunc(endpoints) c.epFunc(endpoints)
} }
} }
// setEndpoints records the new endpoints, reporting whether they're changed. // setEndpoints records the new endpoints, reporting whether they're changed.
// It takes ownership of the slice. // It takes ownership of the slice.
func (c *Conn) setEndpoints(endpoints []string, reasons map[string]string) (changed bool) { func (c *Conn) setEndpoints(endpoints []tailcfg.Endpoint) (changed bool) {
anySTUN := false anySTUN := false
for _, reason := range reasons { for _, ep := range endpoints {
if reason == "stun" { if ep.Type == tailcfg.EndpointSTUN {
anySTUN = true anySTUN = true
} }
} }
@ -625,7 +625,7 @@ func (c *Conn) setEndpoints(endpoints []string, reasons map[string]string) (chan
delete(c.onEndpointRefreshed, de) delete(c.onEndpointRefreshed, de)
} }
if stringSetsEqual(endpoints, c.lastEndpoints) { if endpointSetsEqual(endpoints, c.lastEndpoints) {
return false return false
} }
c.lastEndpoints = endpoints c.lastEndpoints = endpoints
@ -975,35 +975,39 @@ func (c *Conn) goDerpConnect(node int) {
// does a STUN lookup (via netcheck) to determine its public address. // does a STUN lookup (via netcheck) to determine its public address.
// //
// c.mu must NOT be held. // c.mu must NOT be held.
func (c *Conn) determineEndpoints(ctx context.Context) (ipPorts []string, reasons map[string]string, err error) { func (c *Conn) determineEndpoints(ctx context.Context) ([]tailcfg.Endpoint, error) {
nr, err := c.updateNetInfo(ctx) nr, err := c.updateNetInfo(ctx)
if err != nil { if err != nil {
c.logf("magicsock.Conn.determineEndpoints: updateNetInfo: %v", err) c.logf("magicsock.Conn.determineEndpoints: updateNetInfo: %v", err)
return nil, nil, err return nil, err
} }
already := make(map[string]string) // endpoint -> how it was found already := make(map[netaddr.IPPort]tailcfg.EndpointType) // endpoint -> how it was found
var eps []string // unique endpoints var eps []tailcfg.Endpoint // unique endpoints
addAddr := func(s, reason string) { ipp := func(s string) (ipp netaddr.IPPort) {
if debugOmitLocalAddresses && (reason == "localAddresses" || reason == "socket") { ipp, _ = netaddr.ParseIPPort(s)
return
}
addAddr := func(ipp netaddr.IPPort, et tailcfg.EndpointType) {
if ipp.IsZero() || (debugOmitLocalAddresses && et == tailcfg.EndpointLocal) {
return return
} }
if _, ok := already[s]; !ok { if _, ok := already[ipp]; !ok {
already[s] = reason already[ipp] = et
eps = append(eps, s) eps = append(eps, tailcfg.Endpoint{Addr: ipp, Type: et})
} }
} }
if ext, err := c.portMapper.CreateOrGetMapping(ctx); err == nil { if ext, err := c.portMapper.CreateOrGetMapping(ctx); err == nil {
addAddr(ext.String(), "portmap") addAddr(ext, tailcfg.EndpointPortmapped)
c.setNetInfoHavePortMap() c.setNetInfoHavePortMap()
} else if !portmapper.IsNoMappingError(err) { } else if !portmapper.IsNoMappingError(err) {
c.logf("portmapper: %v", err) c.logf("portmapper: %v", err)
} }
if nr.GlobalV4 != "" { if nr.GlobalV4 != "" {
addAddr(nr.GlobalV4, "stun") addAddr(ipp(nr.GlobalV4), tailcfg.EndpointSTUN)
// If they're behind a hard NAT and are using a fixed // If they're behind a hard NAT and are using a fixed
// port locally, assume they might've added a static // port locally, assume they might've added a static
@ -1012,12 +1016,12 @@ func (c *Conn) determineEndpoints(ctx context.Context) (ipPorts []string, reason
// it's an invalid candidate mapping. // it's an invalid candidate mapping.
if nr.MappingVariesByDestIP.EqualBool(true) && c.port != 0 { if nr.MappingVariesByDestIP.EqualBool(true) && c.port != 0 {
if ip, _, err := net.SplitHostPort(nr.GlobalV4); err == nil { if ip, _, err := net.SplitHostPort(nr.GlobalV4); err == nil {
addAddr(net.JoinHostPort(ip, strconv.Itoa(int(c.port))), "port_in") addAddr(ipp(net.JoinHostPort(ip, strconv.Itoa(int(c.port)))), tailcfg.EndpointSTUN4LocalPort)
} }
} }
} }
if nr.GlobalV6 != "" { if nr.GlobalV6 != "" {
addAddr(nr.GlobalV6, "stun") addAddr(ipp(nr.GlobalV6), tailcfg.EndpointSTUN)
} }
c.ignoreSTUNPackets() c.ignoreSTUNPackets()
@ -1025,9 +1029,8 @@ func (c *Conn) determineEndpoints(ctx context.Context) (ipPorts []string, reason
if localAddr := c.pconn4.LocalAddr(); localAddr.IP.IsUnspecified() { if localAddr := c.pconn4.LocalAddr(); localAddr.IP.IsUnspecified() {
ips, loopback, err := interfaces.LocalAddresses() ips, loopback, err := interfaces.LocalAddresses()
if err != nil { if err != nil {
return nil, nil, err return nil, err
} }
reason := "localAddresses"
if len(ips) == 0 && len(eps) == 0 { if len(ips) == 0 && len(eps) == 0 {
// Only include loopback addresses if we have no // Only include loopback addresses if we have no
// interfaces at all to use as endpoints and don't // interfaces at all to use as endpoints and don't
@ -1035,15 +1038,14 @@ func (c *Conn) determineEndpoints(ctx context.Context) (ipPorts []string, reason
// for localhost testing when you're on a plane and // for localhost testing when you're on a plane and
// offline, for example. // offline, for example.
ips = loopback ips = loopback
reason = "loopback"
} }
for _, ip := range ips { for _, ip := range ips {
addAddr(netaddr.IPPort{IP: ip, Port: uint16(localAddr.Port)}.String(), reason) addAddr(netaddr.IPPort{IP: ip, Port: uint16(localAddr.Port)}, tailcfg.EndpointLocal)
} }
} else { } else {
// Our local endpoint is bound to a particular address. // Our local endpoint is bound to a particular address.
// Do not offer addresses on other local interfaces. // Do not offer addresses on other local interfaces.
addAddr(localAddr.String(), "socket") addAddr(ipp(localAddr.String()), tailcfg.EndpointLocal)
} }
// Note: the endpoints are intentionally returned in priority order, // Note: the endpoints are intentionally returned in priority order,
@ -1056,14 +1058,17 @@ func (c *Conn) determineEndpoints(ctx context.Context) (ipPorts []string, reason
// The STUN address(es) are always first so that legacy wireguard // The STUN address(es) are always first so that legacy wireguard
// can use eps[0] as its only known endpoint address (although that's // can use eps[0] as its only known endpoint address (although that's
// obviously non-ideal). // obviously non-ideal).
return eps, already, nil //
// Despite this sorting, though, clients since 0.100 haven't relied
// on the sorting order for any decisions.
return eps, nil
} }
// stringSetsEqual reports whether x and y represent the same set of // endpointSetsEqual reports whether x and y represent the same set of
// strings. The order doesn't matter. // endpoints. The order doesn't matter.
// //
// It does not mutate the slices. // It does not mutate the slices.
func stringSetsEqual(x, y []string) bool { func endpointSetsEqual(x, y []tailcfg.Endpoint) bool {
if len(x) == len(y) { if len(x) == len(y) {
orderMatches := true orderMatches := true
for i := range x { for i := range x {
@ -1076,7 +1081,7 @@ func stringSetsEqual(x, y []string) bool {
return true return true
} }
} }
m := map[string]int{} m := map[tailcfg.Endpoint]int{}
for _, v := range x { for _, v := range x {
m[v] |= 1 m[v] |= 1
} }
@ -1988,9 +1993,7 @@ func (c *Conn) enqueueCallMeMaybe(derpAddr netaddr.IPPort, de *discoEndpoint) {
eps := make([]netaddr.IPPort, 0, len(c.lastEndpoints)) eps := make([]netaddr.IPPort, 0, len(c.lastEndpoints))
for _, ep := range c.lastEndpoints { for _, ep := range c.lastEndpoints {
if ipp, err := netaddr.ParseIPPort(ep); err == nil { eps = append(eps, ep.Addr)
eps = append(eps, ipp)
}
} }
go de.sendDiscoMessage(derpAddr, &disco.CallMeMaybe{MyNumber: eps}, discoLog) go de.sendDiscoMessage(derpAddr, &disco.CallMeMaybe{MyNumber: eps}, discoLog)
} }
@ -2299,13 +2302,13 @@ func (c *Conn) logActiveDerpLocked() {
})) }))
} }
func (c *Conn) logEndpointChange(endpoints []string, reasons map[string]string) { func (c *Conn) logEndpointChange(endpoints []tailcfg.Endpoint) {
c.logf("magicsock: endpoints changed: %s", logger.ArgWriter(func(buf *bufio.Writer) { c.logf("magicsock: endpoints changed: %s", logger.ArgWriter(func(buf *bufio.Writer) {
for i, ep := range endpoints { for i, ep := range endpoints {
if i > 0 { if i > 0 {
buf.WriteString(", ") buf.WriteString(", ")
} }
fmt.Fprintf(buf, "%s (%s)", ep, reasons[ep]) fmt.Fprintf(buf, "%s (%s)", ep.Addr, ep.Type)
} }
})) }))
} }
@ -2968,7 +2971,10 @@ func (c *Conn) UpdateStatus(sb *ipnstate.StatusBuilder) {
sb.MutateSelfStatus(func(ss *ipnstate.PeerStatus) { sb.MutateSelfStatus(func(ss *ipnstate.PeerStatus) {
ss.PublicKey = c.privateKey.Public() ss.PublicKey = c.privateKey.Public()
ss.Addrs = c.lastEndpoints ss.Addrs = make([]string, 0, len(c.lastEndpoints))
for _, ep := range c.lastEndpoints {
ss.Addrs = append(ss.Addrs, ep.Addr.String())
}
ss.OS = version.OS() ss.OS = version.OS()
if c.netMap != nil { if c.netMap != nil {
ss.HostName = c.netMap.Hostinfo.Hostname ss.HostName = c.netMap.Hostinfo.Hostname

View File

@ -126,12 +126,12 @@ func runDERPAndStun(t *testing.T, logf logger.Logf, l nettype.PacketListener, st
// happiness. // happiness.
type magicStack struct { type magicStack struct {
privateKey wgkey.Private privateKey wgkey.Private
epCh chan []string // endpoint updates produced by this peer epCh chan []tailcfg.Endpoint // endpoint updates produced by this peer
conn *Conn // the magicsock itself conn *Conn // the magicsock itself
tun *tuntest.ChannelTUN // TUN device to send/receive packets tun *tuntest.ChannelTUN // TUN device to send/receive packets
tsTun *tstun.Wrapper // wrapped tun that implements filtering and wgengine hooks tsTun *tstun.Wrapper // wrapped tun that implements filtering and wgengine hooks
dev *device.Device // the wireguard-go Device that connects the previous things dev *device.Device // the wireguard-go Device that connects the previous things
wgLogger *wglog.Logger // wireguard-go log wrapper wgLogger *wglog.Logger // wireguard-go log wrapper
} }
// newMagicStack builds and initializes an idle magicsock and // newMagicStack builds and initializes an idle magicsock and
@ -145,11 +145,11 @@ func newMagicStack(t testing.TB, logf logger.Logf, l nettype.PacketListener, der
t.Fatalf("generating private key: %v", err) t.Fatalf("generating private key: %v", err)
} }
epCh := make(chan []string, 100) // arbitrary epCh := make(chan []tailcfg.Endpoint, 100) // arbitrary
conn, err := NewConn(Options{ conn, err := NewConn(Options{
Logf: logf, Logf: logf,
PacketListener: l, PacketListener: l,
EndpointsFunc: func(eps []string) { EndpointsFunc: func(eps []tailcfg.Endpoint) {
epCh <- eps epCh <- eps
}, },
SimulatedNetwork: l != nettype.Std{}, SimulatedNetwork: l != nettype.Std{},
@ -245,7 +245,7 @@ func meshStacks(logf logger.Logf, ms []*magicStack) (cleanup func()) {
// simpler. // simpler.
var ( var (
mu sync.Mutex mu sync.Mutex
eps = make([][]string, len(ms)) eps = make([][]tailcfg.Endpoint, len(ms))
) )
buildNetmapLocked := func(myIdx int) *netmap.NetworkMap { buildNetmapLocked := func(myIdx int) *netmap.NetworkMap {
@ -267,7 +267,7 @@ func meshStacks(logf logger.Logf, ms []*magicStack) (cleanup func()) {
DiscoKey: peer.conn.DiscoPublicKey(), DiscoKey: peer.conn.DiscoPublicKey(),
Addresses: addrs, Addresses: addrs,
AllowedIPs: addrs, AllowedIPs: addrs,
Endpoints: eps[i], Endpoints: epStrings(eps[i]),
DERP: "127.3.3.40:1", DERP: "127.3.3.40:1",
} }
nm.Peers = append(nm.Peers, peer) nm.Peers = append(nm.Peers, peer)
@ -276,7 +276,7 @@ func meshStacks(logf logger.Logf, ms []*magicStack) (cleanup func()) {
return nm return nm
} }
updateEps := func(idx int, newEps []string) { updateEps := func(idx int, newEps []tailcfg.Endpoint) {
mu.Lock() mu.Lock()
defer mu.Unlock() defer mu.Unlock()
@ -331,9 +331,9 @@ func TestNewConn(t *testing.T) {
tstest.ResourceCheck(t) tstest.ResourceCheck(t)
epCh := make(chan string, 16) epCh := make(chan string, 16)
epFunc := func(endpoints []string) { epFunc := func(endpoints []tailcfg.Endpoint) {
for _, ep := range endpoints { for _, ep := range endpoints {
epCh <- ep epCh <- ep.Addr.String()
} }
} }
@ -503,7 +503,7 @@ func TestDeviceStartStop(t *testing.T) {
tstest.ResourceCheck(t) tstest.ResourceCheck(t)
conn, err := NewConn(Options{ conn, err := NewConn(Options{
EndpointsFunc: func(eps []string) {}, EndpointsFunc: func(eps []tailcfg.Endpoint) {},
Logf: t.Logf, Logf: t.Logf,
DisableLegacyNetworking: true, DisableLegacyNetworking: true,
}) })
@ -1392,7 +1392,7 @@ func newNonLegacyTestConn(t testing.TB) *Conn {
conn, err := NewConn(Options{ conn, err := NewConn(Options{
Logf: t.Logf, Logf: t.Logf,
Port: port, Port: port,
EndpointsFunc: func(eps []string) { EndpointsFunc: func(eps []tailcfg.Endpoint) {
t.Logf("endpoints: %q", eps) t.Logf("endpoints: %q", eps)
}, },
DisableLegacyNetworking: true, DisableLegacyNetworking: true,
@ -1694,15 +1694,17 @@ func TestRebindStress(t *testing.T) {
} }
} }
func TestStringSetsEqual(t *testing.T) { func TestEndpointSetsEqual(t *testing.T) {
s := func(nn ...int) (ret []string) { s := func(ports ...uint16) (ret []tailcfg.Endpoint) {
for _, n := range nn { for _, port := range ports {
ret = append(ret, strconv.Itoa(n)) ret = append(ret, tailcfg.Endpoint{
Addr: netaddr.IPPort{Port: port},
})
} }
return return
} }
tests := []struct { tests := []struct {
a, b []string a, b []tailcfg.Endpoint
want bool want bool
}{ }{
{ {
@ -1745,7 +1747,7 @@ func TestStringSetsEqual(t *testing.T) {
}, },
} }
for _, tt := range tests { for _, tt := range tests {
if got := stringSetsEqual(tt.a, tt.b); got != tt.want { if got := endpointSetsEqual(tt.a, tt.b); got != tt.want {
t.Errorf("%q vs %q = %v; want %v", tt.a, tt.b, got, tt.want) t.Errorf("%q vs %q = %v; want %v", tt.a, tt.b, got, tt.want)
} }
} }
@ -1804,3 +1806,10 @@ func TestBetterAddr(t *testing.T) {
} }
} }
func epStrings(eps []tailcfg.Endpoint) (ret []string) {
for _, ep := range eps {
ret = append(ret, ep.Addr.String())
}
return
}

View File

@ -114,7 +114,7 @@ type userspaceEngine struct {
closing bool // Close was called (even if we're still closing) closing bool // Close was called (even if we're still closing)
statusCallback StatusCallback statusCallback StatusCallback
peerSequence []wgkey.Key peerSequence []wgkey.Key
endpoints []string endpoints []tailcfg.Endpoint
pingers map[wgkey.Key]*pinger // legacy pingers for pre-discovery peers pingers map[wgkey.Key]*pinger // legacy pingers for pre-discovery peers
pendOpen map[flowtrack.Tuple]*pendingOpenFlow // see pendopen.go pendOpen map[flowtrack.Tuple]*pendingOpenFlow // see pendopen.go
networkMapCallbacks map[*someHandle]NetworkMapCallback networkMapCallbacks map[*someHandle]NetworkMapCallback
@ -263,7 +263,7 @@ func NewUserspaceEngine(logf logger.Logf, conf Config) (_ Engine, reterr error)
closePool.addFunc(unregisterMonWatch) closePool.addFunc(unregisterMonWatch)
e.linkMonUnregister = unregisterMonWatch e.linkMonUnregister = unregisterMonWatch
endpointsFn := func(endpoints []string) { endpointsFn := func(endpoints []tailcfg.Endpoint) {
e.mu.Lock() e.mu.Lock()
e.endpoints = append(e.endpoints[:0], endpoints...) e.endpoints = append(e.endpoints[:0], endpoints...)
e.mu.Unlock() e.mu.Unlock()
@ -1181,7 +1181,7 @@ func (e *userspaceEngine) getStatus() (*Status, error) {
} }
return &Status{ return &Status{
LocalAddrs: append([]string(nil), e.endpoints...), LocalAddrs: append([]tailcfg.Endpoint(nil), e.endpoints...),
Peers: peers, Peers: peers,
DERPs: derpConns, DERPs: derpConns,
}, nil }, nil

View File

@ -23,8 +23,8 @@
// TODO(bradfitz): remove this, subset of ipnstate? Need to migrate users. // TODO(bradfitz): remove this, subset of ipnstate? Need to migrate users.
type Status struct { type Status struct {
Peers []ipnstate.PeerStatusLite Peers []ipnstate.PeerStatusLite
LocalAddrs []string // the set of possible endpoints for the magic conn LocalAddrs []tailcfg.Endpoint // the set of possible endpoints for the magic conn
DERPs int // number of active DERP connections DERPs int // number of active DERP connections
} }
// StatusCallback is the type of status callbacks used by // StatusCallback is the type of status callbacks used by