src/test/netbase_tests.cpp

// Copyright (c) 2012-2016 The Bitcoin Core developers
// Copyright (c) 2017-2019 The Raven Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include "netbase.h"
#include "test/test_raven.h"
#include "utilstrencodings.h"

#include <string>

#include <boost/test/unit_test.hpp>

BOOST_FIXTURE_TEST_SUITE(netbase_tests, BasicTestingSetup)

    static CNetAddr ResolveIP(const char *ip)
    {
        CNetAddr addr;
        LookupHost(ip, addr, false);
        return addr;
    }

    static CSubNet ResolveSubNet(const char *subnet)
    {
        CSubNet ret;
        LookupSubNet(subnet, ret);
        return ret;
    }

    static CNetAddr CreateInternal(const char *host)
    {
        CNetAddr addr;
        addr.SetInternal(host);
        return addr;
    }

    BOOST_AUTO_TEST_CASE(netbase_networks_test)
    {
        BOOST_TEST_MESSAGE("Running NetBase Networks Test");

        BOOST_CHECK(ResolveIP("127.0.0.1").GetNetwork() == NET_UNROUTABLE);
        BOOST_CHECK(ResolveIP("::1").GetNetwork() == NET_UNROUTABLE);
        BOOST_CHECK(ResolveIP("8.8.8.8").GetNetwork() == NET_IPV4);
        BOOST_CHECK(ResolveIP("2001::8888").GetNetwork() == NET_IPV6);
        BOOST_CHECK(ResolveIP("FD87:D87E:EB43:edb1:8e4:3588:e546:35ca").GetNetwork() == NET_TOR);
        BOOST_CHECK(CreateInternal("foo.com").GetNetwork() == NET_INTERNAL);

    }

    BOOST_AUTO_TEST_CASE(netbase_properties_test)
    {
        BOOST_TEST_MESSAGE("Running NetBase Properties Test");


        BOOST_CHECK(ResolveIP("127.0.0.1").IsIPv4());
        BOOST_CHECK(ResolveIP("::FFFF:192.168.1.1").IsIPv4());
        BOOST_CHECK(ResolveIP("::1").IsIPv6());
        BOOST_CHECK(ResolveIP("10.0.0.1").IsRFC1918());
        BOOST_CHECK(ResolveIP("192.168.1.1").IsRFC1918());
        BOOST_CHECK(ResolveIP("172.31.255.255").IsRFC1918());
        BOOST_CHECK(ResolveIP("2001:0DB8::").IsRFC3849());
        BOOST_CHECK(ResolveIP("169.254.1.1").IsRFC3927());
        BOOST_CHECK(ResolveIP("2002::1").IsRFC3964());
        BOOST_CHECK(ResolveIP("FC00::").IsRFC4193());
        BOOST_CHECK(ResolveIP("2001::2").IsRFC4380());
        BOOST_CHECK(ResolveIP("2001:10::").IsRFC4843());
        BOOST_CHECK(ResolveIP("FE80::").IsRFC4862());
        BOOST_CHECK(ResolveIP("64:FF9B::").IsRFC6052());
        BOOST_CHECK(ResolveIP("FD87:D87E:EB43:edb1:8e4:3588:e546:35ca").IsTor());
        BOOST_CHECK(ResolveIP("127.0.0.1").IsLocal());
        BOOST_CHECK(ResolveIP("::1").IsLocal());
        BOOST_CHECK(ResolveIP("8.8.8.8").IsRoutable());
        BOOST_CHECK(ResolveIP("2001::1").IsRoutable());
        BOOST_CHECK(ResolveIP("127.0.0.1").IsValid());
        BOOST_CHECK(CreateInternal("FD6B:88C0:8724:edb1:8e4:3588:e546:35ca").IsInternal());
        BOOST_CHECK(CreateInternal("bar.com").IsInternal());

    }

    bool static TestSplitHost(std::string test, std::string host, int port)
    {
        std::string hostOut;
        int portOut = -1;
        SplitHostPort(test, portOut, hostOut);
        return hostOut == host && port == portOut;
    }

    BOOST_AUTO_TEST_CASE(netbase_splithost_test)
    {
        BOOST_TEST_MESSAGE("Running NetBase SplitHost Test");

        BOOST_CHECK(TestSplitHost("www.raven.org", "www.raven.org", -1));
        BOOST_CHECK(TestSplitHost("[www.raven.org]", "www.raven.org", -1));
        BOOST_CHECK(TestSplitHost("www.raven.org:80", "www.raven.org", 80));
        BOOST_CHECK(TestSplitHost("[www.raven.org]:80", "www.raven.org", 80));
        BOOST_CHECK(TestSplitHost("127.0.0.1", "127.0.0.1", -1));
        BOOST_CHECK(TestSplitHost("127.0.0.1:8767", "127.0.0.1", 8767));
        BOOST_CHECK(TestSplitHost("[127.0.0.1]", "127.0.0.1", -1));
        BOOST_CHECK(TestSplitHost("[127.0.0.1]:8767", "127.0.0.1", 8767));
        BOOST_CHECK(TestSplitHost("::ffff:127.0.0.1", "::ffff:127.0.0.1", -1));
        BOOST_CHECK(TestSplitHost("[::ffff:127.0.0.1]:8767", "::ffff:127.0.0.1", 8767));
        BOOST_CHECK(TestSplitHost("[::]:8767", "::", 8767));
        BOOST_CHECK(TestSplitHost("::8767", "::8767", -1));
        BOOST_CHECK(TestSplitHost(":8767", "", 8767));
        BOOST_CHECK(TestSplitHost("[]:8767", "", 8767));
        BOOST_CHECK(TestSplitHost("", "", -1));
    }

    bool static TestParse(std::string src, std::string canon)
    {
        CService addr(LookupNumeric(src.c_str(), 65535));
        return canon == addr.ToString();
    }

    BOOST_AUTO_TEST_CASE(netbase_lookupnumeric_test)
    {
        BOOST_TEST_MESSAGE("Running NetBase LookUpNumeric Test");

        BOOST_CHECK(TestParse("127.0.0.1", "127.0.0.1:65535"));
        BOOST_CHECK(TestParse("127.0.0.1:8767", "127.0.0.1:8767"));
        BOOST_CHECK(TestParse("::ffff:127.0.0.1", "127.0.0.1:65535"));
        BOOST_CHECK(TestParse("::", "[::]:65535"));
        BOOST_CHECK(TestParse("[::]:8767", "[::]:8767"));
        BOOST_CHECK(TestParse("[127.0.0.1]", "127.0.0.1:65535"));
        BOOST_CHECK(TestParse(":::", "[::]:0"));

        // verify that an internal address fails to resolve
        BOOST_CHECK(TestParse("[fd6b:88c0:8724:1:2:3:4:5]", "[::]:0"));
        // and that a one-off resolves correctly
        BOOST_CHECK(TestParse("[fd6c:88c0:8724:1:2:3:4:5]", "[fd6c:88c0:8724:1:2:3:4:5]:65535"));
    }

    BOOST_AUTO_TEST_CASE(onioncat_test)
    {
        BOOST_TEST_MESSAGE("Running OnionCat Test");

        // values from https://web.archive.org/web/20121122003543/http://www.cypherpunk.at/onioncat/wiki/OnionCat
        CNetAddr addr1(ResolveIP("5wyqrzbvrdsumnok.onion"));
        CNetAddr addr2(ResolveIP("FD87:D87E:EB43:edb1:8e4:3588:e546:35ca"));
        BOOST_CHECK(addr1 == addr2);
        BOOST_CHECK(addr1.IsTor());
        BOOST_CHECK(addr1.ToStringIP() == "5wyqrzbvrdsumnok.onion");
        BOOST_CHECK(addr1.IsRoutable());

    }

    BOOST_AUTO_TEST_CASE(subnet_test)
    {
        BOOST_TEST_MESSAGE("Running Subnet Test");

        BOOST_CHECK(ResolveSubNet("1.2.3.0/24") == ResolveSubNet("1.2.3.0/255.255.255.0"));
        BOOST_CHECK(ResolveSubNet("1.2.3.0/24") != ResolveSubNet("1.2.4.0/255.255.255.0"));
        BOOST_CHECK(ResolveSubNet("1.2.3.0/24").Match(ResolveIP("1.2.3.4")));
        BOOST_CHECK(!ResolveSubNet("1.2.2.0/24").Match(ResolveIP("1.2.3.4")));
        BOOST_CHECK(ResolveSubNet("1.2.3.4").Match(ResolveIP("1.2.3.4")));
        BOOST_CHECK(ResolveSubNet("1.2.3.4/32").Match(ResolveIP("1.2.3.4")));
        BOOST_CHECK(!ResolveSubNet("1.2.3.4").Match(ResolveIP("5.6.7.8")));
        BOOST_CHECK(!ResolveSubNet("1.2.3.4/32").Match(ResolveIP("5.6.7.8")));
        BOOST_CHECK(ResolveSubNet("::ffff:127.0.0.1").Match(ResolveIP("127.0.0.1")));
        BOOST_CHECK(ResolveSubNet("1:2:3:4:5:6:7:8").Match(ResolveIP("1:2:3:4:5:6:7:8")));
        BOOST_CHECK(!ResolveSubNet("1:2:3:4:5:6:7:8").Match(ResolveIP("1:2:3:4:5:6:7:9")));
        BOOST_CHECK(ResolveSubNet("1:2:3:4:5:6:7:0/112").Match(ResolveIP("1:2:3:4:5:6:7:1234")));
        BOOST_CHECK(ResolveSubNet("192.168.0.1/24").Match(ResolveIP("192.168.0.2")));
        BOOST_CHECK(ResolveSubNet("192.168.0.20/29").Match(ResolveIP("192.168.0.18")));
        BOOST_CHECK(ResolveSubNet("1.2.2.1/24").Match(ResolveIP("1.2.2.4")));
        BOOST_CHECK(ResolveSubNet("1.2.2.110/31").Match(ResolveIP("1.2.2.111")));
        BOOST_CHECK(ResolveSubNet("1.2.2.20/26").Match(ResolveIP("1.2.2.63")));
        // All-Matching IPv6 Matches arbitrary IPv4 and IPv6
        BOOST_CHECK(ResolveSubNet("::/0").Match(ResolveIP("1:2:3:4:5:6:7:1234")));
        BOOST_CHECK(ResolveSubNet("::/0").Match(ResolveIP("1.2.3.4")));
        // All-Matching IPv4 does not Match IPv6
        BOOST_CHECK(!ResolveSubNet("0.0.0.0/0").Match(ResolveIP("1:2:3:4:5:6:7:1234")));
        // Invalid subnets Match nothing (not even invalid addresses)
        BOOST_CHECK(!CSubNet().Match(ResolveIP("1.2.3.4")));
        BOOST_CHECK(!ResolveSubNet("").Match(ResolveIP("4.5.6.7")));
        BOOST_CHECK(!ResolveSubNet("bloop").Match(ResolveIP("0.0.0.0")));
        BOOST_CHECK(!ResolveSubNet("bloop").Match(ResolveIP("hab")));
        // Check valid/invalid
        BOOST_CHECK(ResolveSubNet("1.2.3.0/0").IsValid());
        BOOST_CHECK(!ResolveSubNet("1.2.3.0/-1").IsValid());
        BOOST_CHECK(ResolveSubNet("1.2.3.0/32").IsValid());
        BOOST_CHECK(!ResolveSubNet("1.2.3.0/33").IsValid());
        BOOST_CHECK(ResolveSubNet("1:2:3:4:5:6:7:8/0").IsValid());
        BOOST_CHECK(ResolveSubNet("1:2:3:4:5:6:7:8/33").IsValid());
        BOOST_CHECK(!ResolveSubNet("1:2:3:4:5:6:7:8/-1").IsValid());
        BOOST_CHECK(ResolveSubNet("1:2:3:4:5:6:7:8/128").IsValid());
        BOOST_CHECK(!ResolveSubNet("1:2:3:4:5:6:7:8/129").IsValid());
        BOOST_CHECK(!ResolveSubNet("fuzzy").IsValid());

        //CNetAddr constructor test
        BOOST_CHECK(CSubNet(ResolveIP("127.0.0.1")).IsValid());
        BOOST_CHECK(CSubNet(ResolveIP("127.0.0.1")).Match(ResolveIP("127.0.0.1")));
        BOOST_CHECK(!CSubNet(ResolveIP("127.0.0.1")).Match(ResolveIP("127.0.0.2")));
        BOOST_CHECK(CSubNet(ResolveIP("127.0.0.1")).ToString() == "127.0.0.1/32");

        CSubNet subnet = CSubNet(ResolveIP("1.2.3.4"), 32);
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.4/32");
        subnet = CSubNet(ResolveIP("1.2.3.4"), 8);
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/8");
        subnet = CSubNet(ResolveIP("1.2.3.4"), 0);
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/0");

        subnet = CSubNet(ResolveIP("1.2.3.4"), ResolveIP("255.255.255.255"));
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.4/32");
        subnet = CSubNet(ResolveIP("1.2.3.4"), ResolveIP("255.0.0.0"));
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/8");
        subnet = CSubNet(ResolveIP("1.2.3.4"), ResolveIP("0.0.0.0"));
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/0");

        BOOST_CHECK(CSubNet(ResolveIP("1:2:3:4:5:6:7:8")).IsValid());
        BOOST_CHECK(CSubNet(ResolveIP("1:2:3:4:5:6:7:8")).Match(ResolveIP("1:2:3:4:5:6:7:8")));
        BOOST_CHECK(!CSubNet(ResolveIP("1:2:3:4:5:6:7:8")).Match(ResolveIP("1:2:3:4:5:6:7:9")));
        BOOST_CHECK(CSubNet(ResolveIP("1:2:3:4:5:6:7:8")).ToString() == "1:2:3:4:5:6:7:8/128");

        subnet = ResolveSubNet("1.2.3.4/255.255.255.255");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.4/32");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.254");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.4/31");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.252");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.4/30");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.248");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.0/29");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.240");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.0/28");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.224");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.0/27");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.192");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.0/26");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.128");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.0/25");
        subnet = ResolveSubNet("1.2.3.4/255.255.255.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.3.0/24");
        subnet = ResolveSubNet("1.2.3.4/255.255.254.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.2.0/23");
        subnet = ResolveSubNet("1.2.3.4/255.255.252.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/22");
        subnet = ResolveSubNet("1.2.3.4/255.255.248.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/21");
        subnet = ResolveSubNet("1.2.3.4/255.255.240.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/20");
        subnet = ResolveSubNet("1.2.3.4/255.255.224.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/19");
        subnet = ResolveSubNet("1.2.3.4/255.255.192.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/18");
        subnet = ResolveSubNet("1.2.3.4/255.255.128.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/17");
        subnet = ResolveSubNet("1.2.3.4/255.255.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/16");
        subnet = ResolveSubNet("1.2.3.4/255.254.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/15");
        subnet = ResolveSubNet("1.2.3.4/255.252.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/14");
        subnet = ResolveSubNet("1.2.3.4/255.248.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/13");
        subnet = ResolveSubNet("1.2.3.4/255.240.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/12");
        subnet = ResolveSubNet("1.2.3.4/255.224.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/11");
        subnet = ResolveSubNet("1.2.3.4/255.192.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/10");
        subnet = ResolveSubNet("1.2.3.4/255.128.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/9");
        subnet = ResolveSubNet("1.2.3.4/255.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.0.0.0/8");
        subnet = ResolveSubNet("1.2.3.4/254.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/7");
        subnet = ResolveSubNet("1.2.3.4/252.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/6");
        subnet = ResolveSubNet("1.2.3.4/248.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/5");
        subnet = ResolveSubNet("1.2.3.4/240.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/4");
        subnet = ResolveSubNet("1.2.3.4/224.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/3");
        subnet = ResolveSubNet("1.2.3.4/192.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/2");
        subnet = ResolveSubNet("1.2.3.4/128.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/1");
        subnet = ResolveSubNet("1.2.3.4/0.0.0.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "0.0.0.0/0");

        subnet = ResolveSubNet("1:2:3:4:5:6:7:8/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1:2:3:4:5:6:7:8/128");
        subnet = ResolveSubNet("1:2:3:4:5:6:7:8/ffff:0000:0000:0000:0000:0000:0000:0000");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1::/16");
        subnet = ResolveSubNet("1:2:3:4:5:6:7:8/0000:0000:0000:0000:0000:0000:0000:0000");
        BOOST_CHECK_EQUAL(subnet.ToString(), "::/0");
        subnet = ResolveSubNet("1.2.3.4/255.255.232.0");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1.2.0.0/255.255.232.0");
        subnet = ResolveSubNet("1:2:3:4:5:6:7:8/ffff:ffff:ffff:fffe:ffff:ffff:ffff:ff0f");
        BOOST_CHECK_EQUAL(subnet.ToString(), "1:2:3:4:5:6:7:8/ffff:ffff:ffff:fffe:ffff:ffff:ffff:ff0f");

    }

    BOOST_AUTO_TEST_CASE(netbase_getgroup_test)
    {
        BOOST_TEST_MESSAGE("Running NetBase GetGroup Test");

        BOOST_CHECK(ResolveIP("127.0.0.1").GetGroup() == std::vector<unsigned char>({0})); // Local -> !Routable()
        BOOST_CHECK(ResolveIP("257.0.0.1").GetGroup() == std::vector<unsigned char>({0})); // !Valid -> !Routable()
        BOOST_CHECK(ResolveIP("10.0.0.1").GetGroup() == std::vector<unsigned char>({0})); // RFC1918 -> !Routable()
        BOOST_CHECK(ResolveIP("169.254.1.1").GetGroup() == std::vector<unsigned char>({0})); // RFC3927 -> !Routable()
        BOOST_CHECK(ResolveIP("1.2.3.4").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_IPV4, 1, 2})); // IPv4
        BOOST_CHECK(ResolveIP("::FFFF:0:102:304").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_IPV4, 1, 2})); // RFC6145
        BOOST_CHECK(ResolveIP("64:FF9B::102:304").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_IPV4, 1, 2})); // RFC6052
        BOOST_CHECK(ResolveIP("2002:102:304:9999:9999:9999:9999:9999").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_IPV4, 1, 2})); // RFC3964
        BOOST_CHECK(ResolveIP("2001:0:9999:9999:9999:9999:FEFD:FCFB").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_IPV4, 1, 2})); // RFC4380
        BOOST_CHECK(ResolveIP("FD87:D87E:EB43:edb1:8e4:3588:e546:35ca").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_TOR, 239})); // Tor
        BOOST_CHECK(ResolveIP("2001:470:abcd:9999:9999:9999:9999:9999").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_IPV6, 32, 1, 4, 112, 175})); //he.net
        BOOST_CHECK(ResolveIP("2001:2001:9999:9999:9999:9999:9999:9999").GetGroup() == std::vector<unsigned char>({(unsigned char) NET_IPV6, 32, 1, 32, 1})); //IPv6

        // baz.net sha256 hash: 12929400eb4607c4ac075f087167e75286b179c693eb059a01774b864e8fe505
        std::vector<unsigned char> internal_group = {NET_INTERNAL, 0x12, 0x92, 0x94, 0x00, 0xeb, 0x46, 0x07, 0xc4, 0xac, 0x07};
        BOOST_CHECK(CreateInternal("baz.net").GetGroup() == internal_group);
    }

BOOST_AUTO_TEST_SUITE_END()