Files
netbird/client/internal/peer/handshaker_pq_test.go
T
riccardom 3a6e634130 [client] pqkem: resend the in-flight KEM offer during an offer glare
The offer exchange is installed before the Signal send, so a failed send
leaves it in flight with nothing delivered. Ignoring the responder's offer
then stalled the connection until the exchange timed out. Resending the
same offer delivers it; the responder answers a duplicate from its cache.
2026-10-22 13:26:21 +02:00

93 lines
3.6 KiB
Go

package peer
import (
"sync"
"testing"
log "github.com/sirupsen/logrus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"golang.zx2c4.com/wireguard/wgctrl/wgtypes"
relayClient "github.com/netbirdio/netbird/shared/relay/client"
signal "github.com/netbirdio/netbird/shared/signal/client"
sProto "github.com/netbirdio/netbird/shared/signal/proto"
)
// bootstrapPQ is a fakePQ whose controller decisions are set by the test.
type bootstrapPQ struct {
fakePQ
bootstrap bool
inFlight bool
}
func (b bootstrapPQ) ShouldSendBootstrapOffer(string) bool { return b.bootstrap }
func (b bootstrapPQ) SignalOfferInFlight(string) bool { return b.inFlight }
// newControllerHandshaker builds a handshaker for the controller side of a peer pair and
// records the type of every signalling message it sends.
func newControllerHandshaker(t *testing.T, pq PQHandshaker) (*Handshaker, func() []sProto.Body_Type) {
t.Helper()
var mu sync.Mutex
var sent []sProto.Body_Type
client := &signal.MockClient{
ReadyFunc: func() bool { return true },
SendFunc: func(msg *sProto.Message) error {
mu.Lock()
defer mu.Unlock()
sent = append(sent, msg.GetBody().GetType())
return nil
},
}
key, err := wgtypes.GeneratePrivateKey()
require.NoError(t, err)
config := ConnConfig{Key: "aaaa", LocalKey: "bbbb", PQ: pq} // LocalKey > Key: controller
relay := &WorkerRelay{relayManager: &relayClient.Manager{}}
h := NewHandshaker(log.WithField("test", t.Name()), config, NewSignaler(client, key), nil, relay, nil)
return h, func() []sProto.Body_Type {
mu.Lock()
defer mu.Unlock()
return append([]sProto.Body_Type(nil), sent...)
}
}
// TestHandshaker_ControllerReoffersOnResponderOffer drives the responder-originated
// reconnect through the handshaker: when the KEM manager asks for a fresh bootstrap, the
// controller replies to the responder's KEM-less offer with its own offer and sends no
// answer, so the reconnect re-derives one PSK on both sides.
func TestHandshaker_ControllerReoffersOnResponderOffer(t *testing.T) {
h, sent := newControllerHandshaker(t, bootstrapPQ{bootstrap: true})
h.handleRemoteOffer(OfferAnswer{})
assert.Equal(t, []sProto.Body_Type{sProto.Body_OFFER}, sent(),
"the controller must reply with its own offer, not an answer")
}
// TestHandshaker_ControllerResendsOfferInGlare covers an offer glare: the controller's KEM
// offer and the responder's KEM-less offer cross. The controller must not answer: a
// KEM-less answer could reach the responder before the KEM offer and let it bring WireGuard
// up with no PSK. It sends its in-flight offer again instead, in case the first send failed.
func TestHandshaker_ControllerResendsOfferInGlare(t *testing.T) {
h, sent := newControllerHandshaker(t, bootstrapPQ{inFlight: true})
notified := false
h.AddICEListener(func(*OfferAnswer) { notified = true }) // called synchronously
h.handleRemoteOffer(OfferAnswer{IceCredentials: IceCredentials{UFrag: "ufrag", Pwd: "pwd"}})
assert.Equal(t, []sProto.Body_Type{sProto.Body_OFFER}, sent(),
"in a glare the controller must resend its offer, not answer")
assert.False(t, notified, "in a glare the controller must not bring the connection up from the responder's offer")
}
// TestHandshaker_ControllerAnswersNonCapablePeer keeps the normal answer when there is no
// KEM to run with the peer: its offer is then the only copy of its connection details.
func TestHandshaker_ControllerAnswersNonCapablePeer(t *testing.T) {
h, sent := newControllerHandshaker(t, bootstrapPQ{})
h.handleRemoteOffer(OfferAnswer{})
assert.Equal(t, []sProto.Body_Type{sProto.Body_ANSWER}, sent(),
"without a KEM to run the controller must answer normally")
}