visor/pkg/tcpip/header/checksum_test.go

// Copyright 2019 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 header provides the implementation of the encoding and decoding of
// network protocol headers.
package header_test

import (
	"bytes"
	"fmt"
	"math/rand"
	"sync"
	"testing"

	"gvisor.dev/gvisor/pkg/buffer"
	"gvisor.dev/gvisor/pkg/tcpip"
	"gvisor.dev/gvisor/pkg/tcpip/checksum"
	"gvisor.dev/gvisor/pkg/tcpip/header"
)

func testICMPChecksum(t *testing.T, headerChecksum func() uint16, icmpChecksum func() uint16, want uint16, pktStr string) {
	// icmpChecksum should not do any modifications of the header to
	// calculate its checksum. Let's call it from a few go-routines and the
	// race detector will trigger a warning if there are any concurrent
	// read/write accesses.

	const concurrency = 5
	start := make(chan int)
	ready := make(chan bool, concurrency)
	var wg sync.WaitGroup
	wg.Add(concurrency)
	defer wg.Wait()

	for i := 0; i < concurrency; i++ {
		go func() {
			defer wg.Done()

			ready <- true
			<-start

			if got := headerChecksum(); want != got {
				t.Errorf("new checksum for %s does not match old got: %x, want: %x", pktStr, got, want)
			}
			if got := icmpChecksum(); want != got {
				t.Errorf("new checksum for %s does not match old got: %x, want: %x", pktStr, got, want)
			}
		}()
	}
	for i := 0; i < concurrency; i++ {
		<-ready
	}
	close(start)
}

// TODO(b/239732156): Replace magic constants with names corresponding to what
// they represent ICMP.
func TestICMPv4Checksum(t *testing.T) {
	rnd := rand.New(rand.NewSource(42))

	h := header.ICMPv4(make([]byte, header.ICMPv4MinimumSize))
	if _, err := rnd.Read(h); err != nil {
		t.Fatalf("rnd.Read failed: %v", err)
	}
	h.SetChecksum(0)

	buf := make([]byte, 13)
	if _, err := rnd.Read(buf); err != nil {
		t.Fatalf("rnd.Read failed: %v", err)
	}
	b := buffer.MakeWithData(buf[:5])
	b.Append(buffer.NewViewWithData(buf[5:]))

	want := checksum.Checksum(b.Flatten(), 0)
	want = ^checksum.Checksum(h, want)
	h.SetChecksum(want)

	testICMPChecksum(t, h.Checksum, func() uint16 {
		return header.ICMPv4Checksum(h, b.Checksum(0))
	}, want, fmt.Sprintf("header: {% x} data {% x}", h, b.Flatten()))
}

func TestICMPv4ChecksumUpdate(t *testing.T) {
	const icmpIdent = 0

	data := make([]byte, header.ICMPv4MinimumSize)
	h := header.ICMPv4(data)
	h.SetType(header.ICMPv4EchoReply)
	h.SetCode(header.ICMPv4UnusedCode)
	h.SetIdent(icmpIdent)
	h.SetChecksum(^checksum.Checksum(data, 0))

	updated := header.ICMPv4(bytes.Clone(data))
	// Perform an incremental checksum update where we aren't actually changing the ID.
	updated.SetIdentWithChecksumUpdate(icmpIdent)
	if updated.Checksum() != h.Checksum() {
		t.Errorf("got updated.Checksum() = %x, want = %x", updated.Checksum(), h.Checksum())
	}
}

func TestICMPv6Checksum(t *testing.T) {
	rnd := rand.New(rand.NewSource(42))

	h := header.ICMPv6(make([]byte, header.ICMPv6MinimumSize))
	if _, err := rnd.Read(h); err != nil {
		t.Fatalf("rnd.Read failed: %v", err)
	}
	h.SetChecksum(0)

	buf := make([]byte, 13)
	if _, err := rnd.Read(buf); err != nil {
		t.Fatalf("rnd.Read failed: %v", err)
	}
	b := buffer.MakeWithData(buf[:7])
	b.Append(buffer.NewViewWithData(buf[7:10]))
	b.Append(buffer.NewViewWithData(buf[10:]))

	dst := header.IPv6Loopback
	src := header.IPv6Loopback

	want := header.PseudoHeaderChecksum(header.ICMPv6ProtocolNumber, src, dst, uint16(len(h)+int(b.Size())))
	want = checksum.Checksum(b.Flatten(), want)
	want = ^checksum.Checksum(h, want)
	h.SetChecksum(want)

	testICMPChecksum(t, h.Checksum, func() uint16 {
		return header.ICMPv6Checksum(header.ICMPv6ChecksumParams{
			Header:      h,
			Src:         src,
			Dst:         dst,
			PayloadCsum: b.Checksum(0),
			PayloadLen:  int(b.Size()),
		})
	}, want, fmt.Sprintf("header: {% x} data {% x}", h, b.Flatten()))
}

func randomAddress(size int) tcpip.Address {
	s := make([]byte, size)
	for i := 0; i < size; i++ {
		s[i] = byte(rand.Uint32())
	}
	return tcpip.AddrFromSlice(s)
}

func TestChecksummableNetworkUpdateAddress(t *testing.T) {
	tests := []struct {
		name   string
		update func(header.IPv4, tcpip.Address)
	}{
		{
			name:   "SetSourceAddressWithChecksumUpdate",
			update: header.IPv4.SetSourceAddressWithChecksumUpdate,
		},
		{
			name:   "SetDestinationAddressWithChecksumUpdate",
			update: header.IPv4.SetDestinationAddressWithChecksumUpdate,
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			for i := 0; i < 1000; i++ {
				var origBytes [header.IPv4MinimumSize]byte
				header.IPv4(origBytes[:]).Encode(&header.IPv4Fields{
					TOS:            1,
					TotalLength:    header.IPv4MinimumSize,
					ID:             2,
					Flags:          3,
					FragmentOffset: 4,
					TTL:            5,
					Protocol:       6,
					Checksum:       0,
					SrcAddr:        randomAddress(header.IPv4AddressSize),
					DstAddr:        randomAddress(header.IPv4AddressSize),
				})

				addr := randomAddress(header.IPv4AddressSize)

				bytesCopy := origBytes
				h := header.IPv4(bytesCopy[:])
				origXSum := h.CalculateChecksum()
				h.SetChecksum(^origXSum)

				test.update(h, addr)
				got := ^h.Checksum()
				h.SetChecksum(0)
				want := h.CalculateChecksum()
				if got != want {
					t.Errorf("got h.Checksum() = 0x%x, want = 0x%x; originalBytes = 0x%x, new addr = %s", got, want, origBytes, addr)
				}
			}
		})
	}
}

func TestChecksummableTransportUpdatePort(t *testing.T) {
	// The fields in the pseudo header is not tested here so we just use 0.
	const pseudoHeaderXSum = 0

	tests := []struct {
		name         string
		transportHdr func(_, _ uint16) (header.ChecksummableTransport, func(uint16) uint16)
		proto        tcpip.TransportProtocolNumber
	}{
		{
			name: "TCP",
			transportHdr: func(src, dst uint16) (header.ChecksummableTransport, func(uint16) uint16) {
				h := header.TCP(make([]byte, header.TCPMinimumSize))
				h.Encode(&header.TCPFields{
					SrcPort:       src,
					DstPort:       dst,
					SeqNum:        1,
					AckNum:        2,
					DataOffset:    header.TCPMinimumSize,
					Flags:         3,
					WindowSize:    4,
					Checksum:      0,
					UrgentPointer: 5,
				})
				h.SetChecksum(^h.CalculateChecksum(pseudoHeaderXSum))
				return h, h.CalculateChecksum
			},
			proto: header.TCPProtocolNumber,
		},
		{
			name: "UDP",
			transportHdr: func(src, dst uint16) (header.ChecksummableTransport, func(uint16) uint16) {
				h := header.UDP(make([]byte, header.UDPMinimumSize))
				h.Encode(&header.UDPFields{
					SrcPort:  src,
					DstPort:  dst,
					Length:   0,
					Checksum: 0,
				})
				h.SetChecksum(^h.CalculateChecksum(pseudoHeaderXSum))
				return h, h.CalculateChecksum
			},
			proto: header.UDPProtocolNumber,
		},
	}

	for i := 0; i < 1000; i++ {
		origSrcPort := uint16(rand.Uint32())
		origDstPort := uint16(rand.Uint32())
		newPort := uint16(rand.Uint32())

		t.Run(fmt.Sprintf("OrigSrcPort=%d,OrigDstPort=%d,NewPort=%d", origSrcPort, origDstPort, newPort), func(t *testing.T) {
			for _, test := range tests {
				t.Run(test.name, func(t *testing.T) {
					for _, subTest := range []struct {
						name   string
						update func(header.ChecksummableTransport)
					}{
						{
							name:   "Source port",
							update: func(h header.ChecksummableTransport) { h.SetSourcePortWithChecksumUpdate(newPort) },
						},
						{
							name:   "Destination port",
							update: func(h header.ChecksummableTransport) { h.SetDestinationPortWithChecksumUpdate(newPort) },
						},
					} {
						t.Run(subTest.name, func(t *testing.T) {
							h, calcXSum := test.transportHdr(origSrcPort, origDstPort)
							subTest.update(h)
							// TCP and UDP hold the 1s complement of the fully calculated
							// checksum.
							got := ^h.Checksum()
							h.SetChecksum(0)

							if want := calcXSum(pseudoHeaderXSum); got != want {
								h, _ := test.transportHdr(origSrcPort, origDstPort)
								t.Errorf("got Checksum() = 0x%x, want = 0x%x; originalBytes = %#v, new port = %d", got, want, h, newPort)
							}
						})
					}
				})
			}
		})
	}
}

func TestChecksummableTransportUpdatePseudoHeaderAddress(t *testing.T) {
	const addressSize = 16

	tests := []struct {
		name         string
		transportHdr func() header.ChecksummableTransport
		proto        tcpip.TransportProtocolNumber
	}{
		{
			name:         "TCP",
			transportHdr: func() header.ChecksummableTransport { return header.TCP(make([]byte, header.TCPMinimumSize)) },
			proto:        header.TCPProtocolNumber,
		},
		{
			name:         "UDP",
			transportHdr: func() header.ChecksummableTransport { return header.UDP(make([]byte, header.UDPMinimumSize)) },
			proto:        header.UDPProtocolNumber,
		},
	}

	for i := 0; i < 1000; i++ {
		permanent := randomAddress(addressSize)
		old := randomAddress(addressSize)
		new := randomAddress(addressSize)

		t.Run(fmt.Sprintf("Permanent=%q,Old=%q,New=%q", permanent, old, new), func(t *testing.T) {
			for _, test := range tests {
				t.Run(test.name, func(t *testing.T) {
					for _, fullChecksum := range []bool{true, false} {
						t.Run(fmt.Sprintf("FullChecksum=%t", fullChecksum), func(t *testing.T) {
							initialXSum := header.PseudoHeaderChecksum(test.proto, permanent, old, 0)
							if fullChecksum {
								// TCP and UDP hold the 1s complement of the fully calculated
								// checksum.
								initialXSum = ^initialXSum
							}

							h := test.transportHdr()
							h.SetChecksum(initialXSum)
							h.UpdateChecksumPseudoHeaderAddress(old, new, fullChecksum)

							got := h.Checksum()
							if fullChecksum {
								got = ^got
							}
							if want := header.PseudoHeaderChecksum(test.proto, permanent, new, 0); got != want {
								t.Errorf("got Checksum() = 0x%x, want = 0x%x; h = %#v", got, want, h)
							}
						})
					}
				})
			}
		})
	}
}

// TestUDPChecksumIncrementalUpdate tests that the UDP checksum is handled
// correctly during incremental updates.
func TestUDPChecksumIncrementalUpdate(t *testing.T) {
	tests := []struct {
		name            string
		initialChecksum uint16
		newPort         uint16
		oldAddr         tcpip.Address
		newAddr         tcpip.Address
		wantChecksum    uint16
	}{
		{
			name:            "ChecksumIncrementalUpdate",
			initialChecksum: 0x1234,
			newPort:         0x5678,
			oldAddr:         tcpip.AddrFromSlice([]byte{0, 0, 0, 0}),
			newAddr:         tcpip.AddrFromSlice([]byte{0x56, 0x78, 0, 0}),
			wantChecksum:    0xBBBB,
		},
		{
			name:            "ChecksumNoUpdate",
			initialChecksum: 0x1234,
			newPort:         0,
			oldAddr:         tcpip.AddrFromSlice([]byte{0, 0, 0, 0}),
			newAddr:         tcpip.AddrFromSlice([]byte{0, 0, 0, 0}),
			wantChecksum:    0x1234,
		},
		{
			name:            "ChecksumZero",
			initialChecksum: 0xEFFF,
			newPort:         0xEFFF,
			oldAddr:         tcpip.AddrFromSlice([]byte{0, 0, 0, 0}),
			newAddr:         tcpip.AddrFromSlice([]byte{0xEF, 0xFF, 0, 0}),
			wantChecksum:    0xFFFF,
		},
		{
			name:            "ChecksumDisabled",
			initialChecksum: 0,
			newPort:         0xEFFF,
			oldAddr:         tcpip.AddrFromSlice([]byte{0, 0, 0, 0}),
			newAddr:         tcpip.AddrFromSlice([]byte{0xEF, 0xFF, 0, 0}),
			wantChecksum:    0,
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			newHeader := func() header.UDP {
				h := header.UDP(make([]byte, header.UDPMinimumSize))
				h.Encode(&header.UDPFields{
					SrcPort:  0,
					DstPort:  0,
					Length:   0,
					Checksum: test.initialChecksum,
				})
				return h
			}

			// Incremental CSUM:
			// new_csum = ^(^old_csum - old_data + new_data)

			h := newHeader()
			h.SetSourcePortWithChecksumUpdate(test.newPort)
			if got := h.Checksum(); got != test.wantChecksum {
				t.Errorf("SetSourcePortWithChecksumUpdate: got = 0x%x, want = 0x%x", got, test.wantChecksum)
			}

			h = newHeader()
			h.SetDestinationPortWithChecksumUpdate(test.newPort)
			if got := h.Checksum(); got != test.wantChecksum {
				t.Errorf("SetDestinationPortWithChecksumUpdate: got = 0x%x, want = 0x%x", got, test.wantChecksum)
			}

			h = newHeader()
			h.UpdateChecksumPseudoHeaderAddress(test.oldAddr, test.newAddr, true)
			if got := h.Checksum(); got != test.wantChecksum {
				t.Errorf("UpdateChecksumPseudoHeaderAddress: got = 0x%x, want = 0x%x", got, test.wantChecksum)
			}
		})
	}
}