Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pkg/tcpip/transport/tcp/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ go_library(
"pending_processing_mutex.go",
"protocol.go",
"protocol_mutex.go",
"protocol_state.go",
"rack.go",
"rcv.go",
"rcv_queue_mutex.go",
Expand Down Expand Up @@ -217,6 +218,7 @@ go_test(
srcs = [
"cubic_test.go",
"main_test.go",
"protocol_state_test.go",
"sack_scoreboard_test.go",
"segment_test.go",
"timer_test.go",
Expand Down
8 changes: 5 additions & 3 deletions pkg/tcpip/transport/tcp/protocol.go
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,11 @@ type protocol struct {
// This is immutable after creation.
probe TCPProbeFunc `state:"nosave"`

// The following secrets are initialized once and stay unchanged after.
seqnumSecret [16]byte
tsOffsetSecret [16]byte
// The following secrets are used for ISN and timestamp-offset
// generation. They are not serialized into checkpoint state and are
// freshly drawn from the secure RNG on restore (see afterLoad).
seqnumSecret [16]byte `state:"nosave"`
tsOffsetSecret [16]byte `state:"nosave"`
}

// Number returns the tcp protocol number.
Expand Down
36 changes: 36 additions & 0 deletions pkg/tcpip/transport/tcp/protocol_state.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Copyright 2026 The gVisor 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 tcp

import (
"context"
"fmt"
)

// afterLoad is invoked by stateify after the protocol struct is restored
// from a checkpoint. seqnumSecret and tsOffsetSecret are tagged
// state:"nosave" and therefore arrive zero-valued on restore; this hook
// draws fresh 16-byte secrets from the stack secure RNG so that the
// restored protocol does not reuse secret material that could have been
// read out of the checkpoint file.
func (p *protocol) afterLoad(ctx context.Context) {
rng := p.stack.SecureRNG()
if n, err := rng.Reader.Read(p.seqnumSecret[:]); err != nil || n != len(p.seqnumSecret) {
panic(fmt.Sprintf("rng.Reader.Read(seqnumSecret) failed: n=%d err=%v", n, err))
}
if n, err := rng.Reader.Read(p.tsOffsetSecret[:]); err != nil || n != len(p.tsOffsetSecret) {
panic(fmt.Sprintf("rng.Reader.Read(tsOffsetSecret) failed: n=%d err=%v", n, err))
}
}
90 changes: 90 additions & 0 deletions pkg/tcpip/transport/tcp/protocol_state_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
// Copyright 2026 The gVisor 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 tcp

import (
"bytes"
"context"
"reflect"
"testing"

"gvisor.dev/gvisor/pkg/tcpip/stack"
)

// TestProtocolSecretsHaveNosaveTag is a structural assertion that the
// seqnumSecret and tsOffsetSecret fields on the protocol struct carry the
// state:"nosave" tag. Removing the tag would silently restore stale
// secrets across checkpoint, defeating afterLoad re-seeding.
func TestProtocolSecretsHaveNosaveTag(t *testing.T) {
var p protocol
typ := reflect.TypeOf(p)
for _, name := range []string{"seqnumSecret", "tsOffsetSecret"} {
f, ok := typ.FieldByName(name)
if !ok {
t.Fatalf("field %s not found on protocol", name)
}
if got, want := f.Tag.Get("state"), "nosave"; got != want {
t.Errorf("field %s state-tag = %q, want %q", name, got, want)
}
}
}

// TestProtocolAfterLoadRegeneratesSecrets verifies that calling afterLoad on
// a protocol whose secret fields are zero-valued (the post-restore state for
// nosave fields) repopulates them with fresh, non-zero bytes drawn from the
// stack secure RNG.
func TestProtocolAfterLoadRegeneratesSecrets(t *testing.T) {
s := stack.New(stack.Options{
TransportProtocols: []stack.TransportProtocolFactory{NewProtocol},
})
defer s.Destroy()

tp := s.TransportProtocolInstance(ProtocolNumber)
p, ok := tp.(*protocol)
if !ok {
t.Fatalf("transport protocol instance = %T, want *protocol", tp)
}

var initialSeq, initialTS [16]byte
copy(initialSeq[:], p.seqnumSecret[:])
copy(initialTS[:], p.tsOffsetSecret[:])

var zero [16]byte
if bytes.Equal(initialSeq[:], zero[:]) {
t.Fatalf("seqnumSecret was zero before afterLoad call (RNG init failed)")
}
if bytes.Equal(initialTS[:], zero[:]) {
t.Fatalf("tsOffsetSecret was zero before afterLoad call (RNG init failed)")
}

// Simulate post-restore: stateify gives nosave fields their zero value.
p.seqnumSecret = [16]byte{}
p.tsOffsetSecret = [16]byte{}

p.afterLoad(context.Background())

if bytes.Equal(p.seqnumSecret[:], zero[:]) {
t.Errorf("seqnumSecret zero after afterLoad: %x", p.seqnumSecret)
}
if bytes.Equal(p.tsOffsetSecret[:], zero[:]) {
t.Errorf("tsOffsetSecret zero after afterLoad: %x", p.tsOffsetSecret)
}
if bytes.Equal(p.seqnumSecret[:], initialSeq[:]) {
t.Errorf("seqnumSecret unchanged after afterLoad (collision unlikely with 16-byte secret): %x", p.seqnumSecret)
}
if bytes.Equal(p.tsOffsetSecret[:], initialTS[:]) {
t.Errorf("tsOffsetSecret unchanged after afterLoad (collision unlikely with 16-byte secret): %x", p.tsOffsetSecret)
}
}