gotosocial/internal/netutil/validate.go

/*
   GoToSocial
   Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package netutil

import (
	"net/netip"
)

var (
	// IPv6Reserved contains IPv6 reserved IP prefixes.
	// https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
	IPv6Reserved = [...]netip.Prefix{
		netip.MustParsePrefix("::1/128"),           // Loopback
		netip.MustParsePrefix("::/128"),            // Unspecified address
		netip.MustParsePrefix("::ffff:0:0/96"),     // IPv4-mapped address
		netip.MustParsePrefix("64:ff9b::/96"),      // IPv4/IPv6 translation, RFC 6052
		netip.MustParsePrefix("64:ff9b:1::/48"),    // IPv4/IPv6 translation, RFC 8215
		netip.MustParsePrefix("100::/64"),          // Discard prefix, RFC 6666
		netip.MustParsePrefix("2001::/23"),         // IETF Protocol Assignments, RFC 2928
		netip.MustParsePrefix("2001::/32"),         // Teredo
		netip.MustParsePrefix("2001:1::1/128"),     // Port Control Protocol Anycast, RFC 7723
		netip.MustParsePrefix("2001:1::2/128"),     // Traversal Using Relays around NAT Anycast, RFC 8155
		netip.MustParsePrefix("2001:2::/48"),       // Benchmarking, RFC 5180
		netip.MustParsePrefix("2001:3::/32"),       // AMT, RFC 7450
		netip.MustParsePrefix("2001:4:112::/48"),   // AS112-v6, RFC 7535
		netip.MustParsePrefix("2001:10::/28"),      // ORCHID, deprecated
		netip.MustParsePrefix("2001:20::/28"),      // ORCHIDv2
		netip.MustParsePrefix("2001:db8::/32"),     // Test, doc, examples
		netip.MustParsePrefix("2002::/16"),         // 6to4
		netip.MustParsePrefix("2620:4f:8000::/48"), // Direct Delegation AS112 Service, RFC 7534
		netip.MustParsePrefix("fc00::/7"),          // Unique Local
		netip.MustParsePrefix("fe80::/10"),         // Link-local
		netip.MustParsePrefix("fec0::/10"),         // Site-local, deprecated
		netip.MustParsePrefix("ff00::/8"),          // Multicast
	}

	// IPv4Reserved contains IPv4 reserved IP prefixes.
	// https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
	IPv4Reserved = [...]netip.Prefix{
		netip.MustParsePrefix("0.0.0.0/8"),       // Current network
		netip.MustParsePrefix("10.0.0.0/8"),      // Private
		netip.MustParsePrefix("100.64.0.0/10"),   // RFC6598
		netip.MustParsePrefix("127.0.0.0/8"),     // Loopback
		netip.MustParsePrefix("169.254.0.0/16"),  // Link-local
		netip.MustParsePrefix("172.16.0.0/12"),   // Private
		netip.MustParsePrefix("192.0.0.0/24"),    // RFC6890
		netip.MustParsePrefix("192.0.0.0/29"),    // IPv4 Service Continuity Prefix, RFC 7335
		netip.MustParsePrefix("192.0.2.0/24"),    // Test, doc, examples
		netip.MustParsePrefix("192.31.196.0/24"), // AS112-v4, RFC 7535
		netip.MustParsePrefix("192.52.193.0/24"), // AMT, RFC 7450
		netip.MustParsePrefix("192.88.99.0/24"),  // IPv6 to IPv4 relay
		netip.MustParsePrefix("192.168.0.0/16"),  // Private
		netip.MustParsePrefix("192.175.48.0/24"), // Direct Delegation AS112 Service, RFC 7534
		netip.MustParsePrefix("198.18.0.0/15"),   // Benchmarking tests
		netip.MustParsePrefix("198.51.100.0/24"), // Test, doc, examples
		netip.MustParsePrefix("203.0.113.0/24"),  // Test, doc, examples
		netip.MustParsePrefix("224.0.0.0/4"),     // Multicast
		netip.MustParsePrefix("240.0.0.0/4"),     // Reserved (includes broadcast / 255.255.255.255)
	}
)

// ValidateAddr will parse a netip.AddrPort from string, and return the result of ValidateIP() on addr.
func ValidateAddr(s string) bool {
	ipport, err := netip.ParseAddrPort(s)
	if err != nil {
		return false
	}
	return ValidateIP(ipport.Addr())
}

// ValidateIP returns whether IP is an IPv4/6 address in non-reserved, public ranges.
func ValidateIP(ip netip.Addr) bool {
	switch {
	// IPv4: check if IPv4 in reserved nets
	case ip.Is4():
		for _, reserved := range IPv4Reserved {
			if reserved.Contains(ip) {
				return false
			}
		}
		return true

	// IPv6: check if IP in IPv6 reserved nets
	case ip.Is6():
		for _, reserved := range IPv6Reserved {
			if reserved.Contains(ip) {
				return false
			}
		}
		return true

	// Assume malicious by default
	default:
		return false
	}
}