mirror of
https://github.com/btcsuite/btcd.git
synced 2026-08-13 12:32:51 +02:00
4a4e2d2495
In this commit, we fix `IsRoutable` to correctly reject IPv6 addresses whose first 16-bit group is zero (i.e., in the `0000::/16` reserved block per RFC 4291). Differential fuzzing between btcd and Bitcoin Core revealed that addresses like `0:9881:8181:8181:fe00🅰️9e:9801` were slipping through as routable when they shouldn't be. We add a new `zero6Net` (`0000::/16`) definition alongside the existing `zero4Net`, and introduce an `IsZero` helper that checks both. The /16 prefix width is intentional: the broader /8 reservation would incorrectly catch allocated sub-ranges like `0064:ff9b::/96` (RFC 6052, NAT64). We also carve out an exception for RFC 6145 translated IPv4 addresses (`::ffff:0:0:0/96`), which live within `0000::/16` but are valid for routing. Test coverage includes the original bug report address, various zero-prefix IPv6 addresses, the RFC 6145 exclusion, and corresponding `GroupKey` entries to confirm they land in the "unroutable" bucket. Fixes #2431
308 lines
12 KiB
Go
308 lines
12 KiB
Go
// Copyright (c) 2013-2014 The btcsuite developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package addrmgr_test
|
|
|
|
import (
|
|
"net"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/btcsuite/btcd/addrmgr"
|
|
"github.com/btcsuite/btcd/wire"
|
|
)
|
|
|
|
// TestIPTypes ensures the various functions which determine the type of an IP
|
|
// address based on RFCs work as intended.
|
|
func TestIPTypes(t *testing.T) {
|
|
type ipTest struct {
|
|
in wire.NetAddress
|
|
rfc1918 bool
|
|
rfc2544 bool
|
|
rfc3849 bool
|
|
rfc3927 bool
|
|
rfc3964 bool
|
|
rfc4193 bool
|
|
rfc4380 bool
|
|
rfc4843 bool
|
|
rfc4862 bool
|
|
rfc5737 bool
|
|
rfc6052 bool
|
|
rfc6145 bool
|
|
rfc6598 bool
|
|
rfc7343 bool
|
|
local bool
|
|
valid bool
|
|
routable bool
|
|
}
|
|
|
|
newIPTest := func(ip string, rfc1918, rfc2544, rfc3849, rfc3927, rfc3964,
|
|
rfc4193, rfc4380, rfc4843, rfc4862, rfc5737, rfc6052, rfc6145, rfc6598,
|
|
rfc7343, local, valid, routable bool) ipTest {
|
|
nip := net.ParseIP(ip)
|
|
na := *wire.NewNetAddressIPPort(nip, 8333, wire.SFNodeNetwork)
|
|
test := ipTest{na, rfc1918, rfc2544, rfc3849, rfc3927, rfc3964, rfc4193, rfc4380,
|
|
rfc4843, rfc4862, rfc5737, rfc6052, rfc6145, rfc6598, rfc7343, local, valid, routable}
|
|
return test
|
|
}
|
|
|
|
tests := []ipTest{
|
|
newIPTest("10.255.255.255", true, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("192.168.0.1", true, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("172.31.255.1", true, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("172.32.1.1", false, false, false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, true, true),
|
|
newIPTest("169.254.250.120", false, false, false, true, false, false,
|
|
false, false, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("0.0.0.0", false, false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, true, false, false),
|
|
newIPTest("255.255.255.255", false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, false, false, false),
|
|
newIPTest("127.0.0.1", false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, true, true, false),
|
|
newIPTest("fd00:dead::1", false, false, false, false, false, true,
|
|
false, false, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("2001::1", false, false, false, false, false, false,
|
|
true, false, false, false, false, false, false, false, false, true, true),
|
|
newIPTest("2001:10:abcd::1:1", false, false, false, false, false, false,
|
|
false, true, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("2001:20:abcd::1:1", false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, true, false, true, false),
|
|
newIPTest("fe80::1", false, false, false, false, false, false,
|
|
false, false, true, false, false, false, false, false, false, true, false),
|
|
newIPTest("fe80:1::1", false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, false, true, true),
|
|
newIPTest("64:ff9b::1", false, false, false, false, false, false,
|
|
false, false, false, false, true, false, false, false, false, true, true),
|
|
newIPTest("::ffff:abcd:ef12:1", false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("::1", false, false, false, false, false, false, false, false,
|
|
false, false, false, false, false, false, true, true, false),
|
|
newIPTest("198.18.0.1", false, true, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, true, false),
|
|
newIPTest("100.127.255.1", false, false, false, false, false, false, false,
|
|
false, false, false, false, false, true, false, false, true, false),
|
|
newIPTest("203.0.113.1", false, false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false, true, false),
|
|
|
|
// IPv6 zero-prefix addresses (0000::/16 reserved range).
|
|
// These should NOT be routable per RFC 4291.
|
|
newIPTest("0:9881:8181:8181:fe00:a:9e:9801", false, false, false,
|
|
false, false, false, false, false, false, false, false,
|
|
false, false, false, false, true, false),
|
|
newIPTest("0::1", false, false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, true,
|
|
true, false),
|
|
newIPTest("0:1::1", false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false,
|
|
false, true, false),
|
|
newIPTest("0:ffff::1", false, false, false, false, false, false,
|
|
false, false, false, false, false, false, false, false,
|
|
false, true, false),
|
|
|
|
// RFC 6145 translated IPv4 addresses (::ffff:0:0:0/96) are
|
|
// within 0000::/16 but should still be routable.
|
|
newIPTest("::ffff:0:0c01:0203", false, false, false, false,
|
|
false, false, false, false, false, false, false, true,
|
|
false, false, false, true, true),
|
|
}
|
|
|
|
t.Logf("Running %d tests", len(tests))
|
|
for _, test := range tests {
|
|
if rv := addrmgr.IsRFC1918(&test.in); rv != test.rfc1918 {
|
|
t.Errorf("IsRFC1918 %s\n got: %v want: %v", test.in.IP, rv, test.rfc1918)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC3849(&test.in); rv != test.rfc3849 {
|
|
t.Errorf("IsRFC3849 %s\n got: %v want: %v", test.in.IP, rv, test.rfc3849)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC3927(&test.in); rv != test.rfc3927 {
|
|
t.Errorf("IsRFC3927 %s\n got: %v want: %v", test.in.IP, rv, test.rfc3927)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC3964(&test.in); rv != test.rfc3964 {
|
|
t.Errorf("IsRFC3964 %s\n got: %v want: %v", test.in.IP, rv, test.rfc3964)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC4193(&test.in); rv != test.rfc4193 {
|
|
t.Errorf("IsRFC4193 %s\n got: %v want: %v", test.in.IP, rv, test.rfc4193)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC4380(&test.in); rv != test.rfc4380 {
|
|
t.Errorf("IsRFC4380 %s\n got: %v want: %v", test.in.IP, rv, test.rfc4380)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC4843(&test.in); rv != test.rfc4843 {
|
|
t.Errorf("IsRFC4843 %s\n got: %v want: %v", test.in.IP, rv, test.rfc4843)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC4862(&test.in); rv != test.rfc4862 {
|
|
t.Errorf("IsRFC4862 %s\n got: %v want: %v", test.in.IP, rv, test.rfc4862)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC6052(&test.in); rv != test.rfc6052 {
|
|
t.Errorf("isRFC6052 %s\n got: %v want: %v", test.in.IP, rv, test.rfc6052)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC6145(&test.in); rv != test.rfc6145 {
|
|
t.Errorf("IsRFC6145 %s\n got: %v want: %v", test.in.IP, rv, test.rfc6145)
|
|
}
|
|
|
|
if rv := addrmgr.IsRFC7343(&test.in); rv != test.rfc7343 {
|
|
t.Errorf("IsRFC7343 %s\n got: %v want: %v", test.in.IP, rv, test.rfc7343)
|
|
}
|
|
|
|
if rv := addrmgr.IsLocal(&test.in); rv != test.local {
|
|
t.Errorf("IsLocal %s\n got: %v want: %v", test.in.IP, rv, test.local)
|
|
}
|
|
|
|
if rv := addrmgr.IsValid(&test.in); rv != test.valid {
|
|
t.Errorf("IsValid %s\n got: %v want: %v", test.in.IP, rv, test.valid)
|
|
}
|
|
|
|
currentNa := wire.NetAddressV2FromBytes(
|
|
time.Now(), test.in.Services, test.in.IP, test.in.Port,
|
|
)
|
|
if rv := addrmgr.IsRoutable(currentNa); rv != test.routable {
|
|
t.Errorf("IsRoutable %s\n got: %v want: %v", test.in.IP, rv, test.routable)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestIsZero ensures the IsZero function correctly identifies addresses in the
|
|
// reserved zero address blocks while excluding allocated sub-ranges.
|
|
func TestIsZero(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
ip string
|
|
want bool
|
|
}{
|
|
// IPv4 zero addresses (0.0.0.0/8).
|
|
{name: "ipv4 zero", ip: "0.0.0.0", want: true},
|
|
{name: "ipv4 zero prefix", ip: "0.1.2.3", want: true},
|
|
{name: "ipv4 zero 0.255.255.255", ip: "0.255.255.255", want: true},
|
|
|
|
// IPv4 non-zero addresses.
|
|
{name: "ipv4 normal", ip: "1.2.3.4", want: false},
|
|
{name: "ipv4 loopback", ip: "127.0.0.1", want: false},
|
|
{name: "ipv4 private", ip: "192.168.1.1", want: false},
|
|
|
|
// IPv6 zero-prefix addresses (0000::/16 reserved).
|
|
{name: "ipv6 zero all", ip: "::", want: true},
|
|
{name: "ipv6 loopback", ip: "::1", want: true},
|
|
{name: "ipv6 zero prefix 0::2", ip: "0::2", want: true},
|
|
{name: "ipv6 zero prefix 0:1::1", ip: "0:1::1", want: true},
|
|
{name: "ipv6 zero prefix 0:ffff::1", ip: "0:ffff::1", want: true},
|
|
{
|
|
name: "ipv6 zero prefix from bug report",
|
|
ip: "0:9881:8181:8181:fe00:a:9e:9801",
|
|
want: true,
|
|
},
|
|
{
|
|
name: "ipv6 zero prefix unallocated",
|
|
ip: "::ffff:abcd:ef12:1",
|
|
want: true,
|
|
},
|
|
|
|
// RFC 6145 addresses (::ffff:0:0:0/96) — allocated sub-range
|
|
// of 0000::/16 that should NOT be flagged as zero.
|
|
{
|
|
name: "ipv6 rfc6145 translated ipv4",
|
|
ip: "::ffff:0:0c01:0203",
|
|
want: false,
|
|
},
|
|
{
|
|
name: "ipv6 rfc6145 another",
|
|
ip: "::ffff:0:1.2.3.4",
|
|
want: false,
|
|
},
|
|
|
|
// IPv6 non-zero-prefix addresses.
|
|
{name: "ipv6 normal", ip: "2602:100::1", want: false},
|
|
{name: "ipv6 rfc6052", ip: "64:ff9b::1", want: false},
|
|
{name: "ipv6 private", ip: "fd00:dead::1", want: false},
|
|
{name: "ipv6 teredo", ip: "2001::1", want: false},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
nip := net.ParseIP(test.ip)
|
|
na := wire.NewNetAddressIPPort(
|
|
nip, 8333, wire.SFNodeNetwork,
|
|
)
|
|
if got := addrmgr.IsZero(na); got != test.want {
|
|
t.Errorf("IsZero(%s) = %v, want %v",
|
|
test.ip, got, test.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// TestGroupKey tests the GroupKey function to ensure it properly groups various
|
|
// IP addresses.
|
|
func TestGroupKey(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
ip string
|
|
expected string
|
|
}{
|
|
// Local addresses.
|
|
{name: "ipv4 localhost", ip: "127.0.0.1", expected: "local"},
|
|
{name: "ipv6 localhost", ip: "::1", expected: "local"},
|
|
{name: "ipv4 zero", ip: "0.0.0.0", expected: "local"},
|
|
{name: "ipv4 first octet zero", ip: "0.1.2.3", expected: "local"},
|
|
|
|
// Unroutable addresses.
|
|
{name: "ipv4 invalid bcast", ip: "255.255.255.255", expected: "unroutable"},
|
|
{name: "ipv4 rfc1918 10/8", ip: "10.1.2.3", expected: "unroutable"},
|
|
{name: "ipv4 rfc1918 172.16/12", ip: "172.16.1.2", expected: "unroutable"},
|
|
{name: "ipv4 rfc1918 192.168/16", ip: "192.168.1.2", expected: "unroutable"},
|
|
{name: "ipv6 rfc3849 2001:db8::/32", ip: "2001:db8::1234", expected: "unroutable"},
|
|
{name: "ipv4 rfc3927 169.254/16", ip: "169.254.1.2", expected: "unroutable"},
|
|
{name: "ipv6 rfc4193 fc00::/7", ip: "fc00::1234", expected: "unroutable"},
|
|
{name: "ipv6 rfc4843 2001:10::/28", ip: "2001:10::1234", expected: "unroutable"},
|
|
{name: "ipv6 rfc7343 2001:20::/28", ip: "2001:20::1234", expected: "unroutable"},
|
|
{name: "ipv6 rfc4862 fe80::/64", ip: "fe80::1234", expected: "unroutable"},
|
|
{name: "ipv6 zero prefix 0::/16", ip: "0:9881:8181:8181:fe00:a:9e:9801", expected: "unroutable"},
|
|
{name: "ipv6 zero prefix 0:1::1", ip: "0:1::1", expected: "unroutable"},
|
|
|
|
// IPv4 normal.
|
|
{name: "ipv4 normal class a", ip: "12.1.2.3", expected: "12.1.0.0"},
|
|
{name: "ipv4 normal class b", ip: "173.1.2.3", expected: "173.1.0.0"},
|
|
{name: "ipv4 normal class c", ip: "196.1.2.3", expected: "196.1.0.0"},
|
|
|
|
// IPv6/IPv4 translations.
|
|
{name: "ipv6 rfc3964 with ipv4 encap", ip: "2002:0c01:0203::", expected: "12.1.0.0"},
|
|
{name: "ipv6 rfc4380 toredo ipv4", ip: "2001:0:1234::f3fe:fdfc", expected: "12.1.0.0"},
|
|
{name: "ipv6 rfc6052 well-known prefix with ipv4", ip: "64:ff9b::0c01:0203", expected: "12.1.0.0"},
|
|
{name: "ipv6 rfc6145 translated ipv4", ip: "::ffff:0:0c01:0203", expected: "12.1.0.0"},
|
|
|
|
// Tor.
|
|
{name: "ipv6 tor onioncat", ip: "fd87:d87e:eb43:1234::5678", expected: "tor:2"},
|
|
{name: "ipv6 tor onioncat 2", ip: "fd87:d87e:eb43:1245::6789", expected: "tor:2"},
|
|
{name: "ipv6 tor onioncat 3", ip: "fd87:d87e:eb43:1345::6789", expected: "tor:3"},
|
|
|
|
// IPv6 normal.
|
|
{name: "ipv6 normal", ip: "2602:100::1", expected: "2602:100::"},
|
|
{name: "ipv6 normal 2", ip: "2602:0100::1234", expected: "2602:100::"},
|
|
{name: "ipv6 hurricane electric", ip: "2001:470:1f10:a1::2", expected: "2001:470:1000::"},
|
|
{name: "ipv6 hurricane electric 2", ip: "2001:0470:1f10:a1::2", expected: "2001:470:1000::"},
|
|
}
|
|
|
|
for i, test := range tests {
|
|
nip := net.ParseIP(test.ip)
|
|
na := wire.NetAddressV2FromBytes(
|
|
time.Now(), wire.SFNodeNetwork, nip, 8333,
|
|
)
|
|
if key := addrmgr.GroupKey(na); key != test.expected {
|
|
t.Errorf("TestGroupKey #%d (%s): unexpected group key "+
|
|
"- got '%s', want '%s'", i, test.name,
|
|
key, test.expected)
|
|
}
|
|
}
|
|
}
|