Skip to content

Commit

Permalink
ipn/ipnstate, wgengine/wgint: add handshake attempts accessors
Browse files Browse the repository at this point in the history
Not yet used. This is being made available so magicsock/wgengine can
use it to ignore certain sends (UDP + DERP) later on at least mobile,
letting wireguard-go think it's doing its full attempt schedule, but
we can cut it short conditionally based on what we know from the
control plane.

Updates tailscale#7617

Signed-off-by: Brad Fitzpatrick <bradfitz@tailscale.com>
Change-Id: Ia367cf6bd87b2aeedd3c6f4989528acdb6773ca7
  • Loading branch information
bradfitz committed Feb 27, 2024
1 parent eb28818 commit 1cf8582
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 1 deletion.
4 changes: 4 additions & 0 deletions ipn/ipnstate/ipnstate.go
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,10 @@ type PeerStatusLite struct {
LastHandshake time.Time
// NodeKey is this peer's public node key.
NodeKey key.NodePublic
// HandshakeAttempts is how many failed attempts there have been at
// completing the current WireGuard handshake. This resets to zero on every
// successful handshake.
HandshakeAttempts uint32
}

// PeerStatus describes a peer node and its current state.
Expand Down
1 change: 1 addition & 0 deletions wgengine/userspace.go
Original file line number Diff line number Diff line change
Expand Up @@ -1026,6 +1026,7 @@ func (e *userspaceEngine) getPeerStatusLite(pk key.NodePublic) (status ipnstate.
status.RxBytes = int64(wgint.PeerRxBytes(peer))
status.TxBytes = int64(wgint.PeerTxBytes(peer))
status.LastHandshake = time.Unix(0, wgint.PeerLastHandshakeNano(peer))
status.HandshakeAttempts = wgint.PeerHandshakeAttempts(peer)
return status, true
}

Expand Down
24 changes: 24 additions & 0 deletions wgengine/wgint/wgint.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ var (
offHandshake = getPeerStatsOffset("lastHandshakeNano")
offRxBytes = getPeerStatsOffset("rxBytes")
offTxBytes = getPeerStatsOffset("txBytes")

offHandshakeAttempts = getPeerHandshakeAttemptsOffset()
)

func getPeerStatsOffset(name string) uintptr {
Expand All @@ -31,6 +33,22 @@ func getPeerStatsOffset(name string) uintptr {
return field.Offset
}

func getPeerHandshakeAttemptsOffset() uintptr {
peerType := reflect.TypeFor[device.Peer]()
field, ok := peerType.FieldByName("timers")
if !ok {
panic("no timers field in device.Peer")
}
field2, ok := field.Type.FieldByName("handshakeAttempts")
if !ok {
panic("no handshakeAttempts field in device.Peer.timers")
}
if g, w := field2.Type.String(), "atomic.Uint32"; g != w {
panic("unexpected type " + g + " of field handshakeAttempts in device.Peer.timers; want " + w)
}
return field.Offset + field2.Offset
}

// PeerLastHandshakeNano returns the last handshake time in nanoseconds since the
// unix epoch.
func PeerLastHandshakeNano(peer *device.Peer) int64 {
Expand All @@ -46,3 +64,9 @@ func PeerRxBytes(peer *device.Peer) uint64 {
func PeerTxBytes(peer *device.Peer) uint64 {
return (*atomic.Uint64)(unsafe.Add(unsafe.Pointer(peer), offTxBytes)).Load()
}

// PeerHandshakeAttempts returns the number of WireGuard handshake attempts
// made for the current handshake. It resets to zero before every new handshake.
func PeerHandshakeAttempts(peer *device.Peer) uint32 {
return (*atomic.Uint32)(unsafe.Add(unsafe.Pointer(peer), offHandshakeAttempts)).Load()
}
5 changes: 4 additions & 1 deletion wgengine/wgint/wgint_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"github.com/tailscale/wireguard-go/device"
)

func TestPeerStats(t *testing.T) {
func TestInternalOffsets(t *testing.T) {
peer := new(device.Peer)
if got := PeerLastHandshakeNano(peer); got != 0 {
t.Errorf("PeerLastHandshakeNano = %v, want 0", got)
Expand All @@ -20,4 +20,7 @@ func TestPeerStats(t *testing.T) {
if got := PeerTxBytes(peer); got != 0 {
t.Errorf("PeerTxBytes = %v, want 0", got)
}
if got := PeerHandshakeAttempts(peer); got != 0 {
t.Errorf("PeerHandshakeAttempts = %v, want 0", got)
}
}

0 comments on commit 1cf8582

Please sign in to comment.