Bitcoin Core 32.99.0
P2P Digital Currency
netaddress.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#include <netaddress.h>
7
8#include <crypto/common.h>
9#include <crypto/sha3.h>
10#include <hash.h>
11#include <prevector.h>
12#include <tinyformat.h>
13#include <util/strencodings.h>
14#include <util/string.h>
15
16#include <algorithm>
17#include <array>
18#include <cstdint>
19#include <ios>
20#include <iterator>
21#include <string_view>
22#include <tuple>
23
25using util::HasPrefix;
26
28{
29 switch (m_net) {
30 case NET_IPV4:
32 case NET_IPV6:
34 case NET_ONION:
35 return BIP155Network::TORV3;
36 case NET_I2P:
37 return BIP155Network::I2P;
38 case NET_CJDNS:
39 return BIP155Network::CJDNS;
40 case NET_INTERNAL: // should have been handled before calling this function
41 case NET_UNROUTABLE: // m_net is never and should not be set to NET_UNROUTABLE
42 case NET_MAX: // m_net is never and should not be set to NET_MAX
43 assert(false);
44 } // no default case, so the compiler can warn about missing cases
45
46 assert(false);
47}
48
49bool CNetAddr::SetNetFromBIP155Network(uint8_t possible_bip155_net, size_t address_size)
50{
51 switch (possible_bip155_net) {
53 if (address_size == ADDR_IPV4_SIZE) {
55 return true;
56 }
57 throw std::ios_base::failure(
58 strprintf("BIP155 IPv4 address with length %u (should be %u)", address_size,
61 if (address_size == ADDR_IPV6_SIZE) {
63 return true;
64 }
65 throw std::ios_base::failure(
66 strprintf("BIP155 IPv6 address with length %u (should be %u)", address_size,
68 case BIP155Network::TORV3:
69 if (address_size == ADDR_TORV3_SIZE) {
71 return true;
72 }
73 throw std::ios_base::failure(
74 strprintf("BIP155 TORv3 address with length %u (should be %u)", address_size,
77 if (address_size == ADDR_I2P_SIZE) {
78 m_net = NET_I2P;
79 return true;
80 }
81 throw std::ios_base::failure(
82 strprintf("BIP155 I2P address with length %u (should be %u)", address_size,
84 case BIP155Network::CJDNS:
85 if (address_size == ADDR_CJDNS_SIZE) {
87 return true;
88 }
89 throw std::ios_base::failure(
90 strprintf("BIP155 CJDNS address with length %u (should be %u)", address_size,
92 }
93
94 // Don't throw on addresses with unknown network ids (maybe from the future).
95 // Instead silently drop them and have the unserialization code consume
96 // subsequent ones which may be known to us.
97 return false;
98}
99
105CNetAddr::CNetAddr() = default;
106
107void CNetAddr::SetIP(const CNetAddr& ipIn)
108{
109 // Size check.
110 switch (ipIn.m_net) {
111 case NET_IPV4:
112 assert(ipIn.m_addr.size() == ADDR_IPV4_SIZE);
113 break;
114 case NET_IPV6:
115 assert(ipIn.m_addr.size() == ADDR_IPV6_SIZE);
116 break;
117 case NET_ONION:
119 break;
120 case NET_I2P:
121 assert(ipIn.m_addr.size() == ADDR_I2P_SIZE);
122 break;
123 case NET_CJDNS:
125 break;
126 case NET_INTERNAL:
128 break;
129 case NET_UNROUTABLE:
130 case NET_MAX:
131 assert(false);
132 } // no default case, so the compiler can warn about missing cases
133
134 m_net = ipIn.m_net;
135 m_addr = ipIn.m_addr;
136}
137
138void CNetAddr::SetLegacyIPv6(std::span<const uint8_t> ipv6)
139{
140 assert(ipv6.size() == ADDR_IPV6_SIZE);
141
142 size_t skip{0};
143
144 if (HasPrefix(ipv6, IPV4_IN_IPV6_PREFIX)) {
145 // IPv4-in-IPv6
146 m_net = NET_IPV4;
147 skip = sizeof(IPV4_IN_IPV6_PREFIX);
148 } else if (HasPrefix(ipv6, TORV2_IN_IPV6_PREFIX)) {
149 // TORv2-in-IPv6 (unsupported). Unserialize as !IsValid(), thus ignoring them.
150 // Mimic a default-constructed CNetAddr object which is !IsValid() and thus
151 // will not be gossiped, but continue reading next addresses from the stream.
152 m_net = NET_IPV6;
154 return;
155 } else if (HasPrefix(ipv6, INTERNAL_IN_IPV6_PREFIX)) {
156 // Internal-in-IPv6
158 skip = sizeof(INTERNAL_IN_IPV6_PREFIX);
159 } else {
160 // IPv6
161 m_net = NET_IPV6;
162 }
163
164 m_addr.assign(ipv6.begin() + skip, ipv6.end());
165}
166
173bool CNetAddr::SetInternal(const std::string &name)
174{
175 if (name.empty()) {
176 return false;
177 }
179 unsigned char hash[32] = {};
180 CSHA256().Write((const unsigned char*)name.data(), name.size()).Finalize(hash);
181 m_addr.assign(hash, hash + ADDR_INTERNAL_SIZE);
182 return true;
183}
184
185namespace torv3 {
186// https://gitlab.torproject.org/tpo/core/torspec/-/tree/main/spec/rend-spec
187static constexpr size_t CHECKSUM_LEN = 2;
188static const unsigned char VERSION[] = {3};
189static constexpr size_t TOTAL_LEN = ADDR_TORV3_SIZE + CHECKSUM_LEN + sizeof(VERSION);
190
191static void Checksum(std::span<const uint8_t> addr_pubkey, uint8_t (&checksum)[CHECKSUM_LEN])
192{
193 // TORv3 CHECKSUM = H(".onion checksum" | PUBKEY | VERSION)[:2]
194 static const unsigned char prefix[] = ".onion checksum";
195 static constexpr size_t prefix_len = 15;
196
197 SHA3_256 hasher;
198
199 hasher.Write(std::span{prefix}.first(prefix_len));
200 hasher.Write(addr_pubkey);
201 hasher.Write(VERSION);
202
203 uint8_t checksum_full[SHA3_256::OUTPUT_SIZE];
204
205 hasher.Finalize(checksum_full);
206
207 memcpy(checksum, checksum_full, sizeof(checksum));
208}
209
210}; // namespace torv3
211
212bool CNetAddr::SetSpecial(std::string_view addr)
213{
214 if (ContainsNUL(addr)) {
215 return false;
216 }
217
218 if (SetTor(addr)) {
219 return true;
220 }
221
222 if (SetI2P(addr)) {
223 return true;
224 }
225
226 return false;
227}
228
229bool CNetAddr::SetTor(std::string_view addr)
230{
231 if (!addr.ends_with(".onion")) return false;
232 addr.remove_suffix(6);
233 auto input = DecodeBase32(addr);
234
235 if (!input) {
236 return false;
237 }
238
239 if (input->size() == torv3::TOTAL_LEN) {
240 std::span<const uint8_t> input_pubkey{input->data(), ADDR_TORV3_SIZE};
241 std::span<const uint8_t> input_checksum{input->data() + ADDR_TORV3_SIZE, torv3::CHECKSUM_LEN};
242 std::span<const uint8_t> input_version{input->data() + ADDR_TORV3_SIZE + torv3::CHECKSUM_LEN, sizeof(torv3::VERSION)};
243
244 if (!std::ranges::equal(input_version, torv3::VERSION)) {
245 return false;
246 }
247
248 uint8_t calculated_checksum[torv3::CHECKSUM_LEN];
249 torv3::Checksum(input_pubkey, calculated_checksum);
250
251 if (!std::ranges::equal(input_checksum, calculated_checksum)) {
252 return false;
253 }
254
256 m_addr.assign(input_pubkey.begin(), input_pubkey.end());
257 return true;
258 }
259
260 return false;
261}
262
263bool CNetAddr::SetI2P(std::string_view addr)
264{
265 // I2P addresses that we support consist of 52 base32 characters + ".b32.i2p".
266 static constexpr size_t b32_len{52};
267 static const char* suffix{".b32.i2p"};
268 static constexpr size_t suffix_len{8};
269
270 if (addr.size() != b32_len + suffix_len || ToLower(addr.substr(b32_len)) != suffix) {
271 return false;
272 }
273
274 // Remove the ".b32.i2p" suffix and pad to a multiple of 8 chars, so DecodeBase32()
275 // can decode it.
276 const std::string b32_padded{tfm::format("%s====", addr.substr(0, b32_len))};
277
278 auto address_bytes = DecodeBase32(b32_padded);
279
280 if (!address_bytes || address_bytes->size() != ADDR_I2P_SIZE) {
281 return false;
282 }
283
284 m_net = NET_I2P;
285 m_addr.assign(address_bytes->begin(), address_bytes->end());
286
287 return true;
288}
289
290CNetAddr::CNetAddr(const struct in_addr& ipv4Addr)
291{
292 m_net = NET_IPV4;
293 const uint8_t* ptr = reinterpret_cast<const uint8_t*>(&ipv4Addr);
294 m_addr.assign(ptr, ptr + ADDR_IPV4_SIZE);
295}
296
297CNetAddr::CNetAddr(const struct in6_addr& ipv6Addr, const uint32_t scope)
298{
299 SetLegacyIPv6({reinterpret_cast<const uint8_t*>(&ipv6Addr), sizeof(ipv6Addr)});
300 m_scope_id = scope;
301}
302
304{
305 if (!IsIPv4() && !IsIPv6()) {
306 return false;
307 }
308 return std::all_of(m_addr.begin(), m_addr.end(), [](uint8_t b) { return b == 0; });
309}
310
312{
313 return IsIPv4() && (
314 m_addr[0] == 10 ||
315 (m_addr[0] == 192 && m_addr[1] == 168) ||
316 (m_addr[0] == 172 && m_addr[1] >= 16 && m_addr[1] <= 31));
317}
318
320{
321 return IsIPv4() && m_addr[0] == 198 && (m_addr[1] == 18 || m_addr[1] == 19);
322}
323
325{
326 return IsIPv4() && HasPrefix(m_addr, std::array<uint8_t, 2>{169, 254});
327}
328
330{
331 return IsIPv4() && m_addr[0] == 100 && m_addr[1] >= 64 && m_addr[1] <= 127;
332}
333
335{
336 return IsIPv4() && (HasPrefix(m_addr, std::array<uint8_t, 3>{192, 0, 2}) ||
337 HasPrefix(m_addr, std::array<uint8_t, 3>{198, 51, 100}) ||
338 HasPrefix(m_addr, std::array<uint8_t, 3>{203, 0, 113}));
339}
340
342{
343 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 4>{0x20, 0x01, 0x0D, 0xB8});
344}
345
347{
348 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 2>{0x3F, 0xFF}) &&
349 (m_addr[2] & 0xF0) == 0x00;
350}
351
353{
354 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 2>{0x20, 0x02});
355}
356
358{
359 return IsIPv6() &&
360 HasPrefix(m_addr, std::array<uint8_t, 12>{0x00, 0x64, 0xFF, 0x9B, 0x00, 0x00,
361 0x00, 0x00, 0x00, 0x00, 0x00, 0x00});
362}
363
365{
366 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 4>{0x20, 0x01, 0x00, 0x00});
367}
368
370{
371 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 8>{0xFE, 0x80, 0x00, 0x00,
372 0x00, 0x00, 0x00, 0x00});
373}
374
376{
377 return IsIPv6() && (m_addr[0] & 0xFE) == 0xFC;
378}
379
381{
382 return IsIPv6() &&
383 HasPrefix(m_addr, std::array<uint8_t, 12>{0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
384 0x00, 0x00, 0xFF, 0xFF, 0x00, 0x00});
385}
386
388{
389 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 3>{0x20, 0x01, 0x00}) &&
390 (m_addr[3] & 0xF0) == 0x10;
391}
392
394{
395 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 3>{0x20, 0x01, 0x00}) &&
396 (m_addr[3] & 0xF0) == 0x20;
397}
398
400{
401 return IsIPv6() && HasPrefix(m_addr, std::array<uint8_t, 4>{0x20, 0x01, 0x04, 0x70});
402}
403
405{
406 // IPv4 loopback (127.0.0.0/8 or 0.0.0.0/8)
407 if (IsIPv4() && (m_addr[0] == 127 || m_addr[0] == 0)) {
408 return true;
409 }
410
411 // IPv6 loopback (::1/128)
412 static const unsigned char pchLocal[16] = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1};
413 if (IsIPv6() && memcmp(m_addr.data(), pchLocal, sizeof(pchLocal)) == 0) {
414 return true;
415 }
416
417 return false;
418}
419
431{
432 // unspecified IPv6 address (::/128)
433 unsigned char ipNone6[16] = {};
434 if (IsIPv6() && memcmp(m_addr.data(), ipNone6, sizeof(ipNone6)) == 0) {
435 return false;
436 }
437
438 if (IsCJDNS() && !HasCJDNSPrefix()) {
439 return false;
440 }
441
442 // documentation IPv6 address
443 if (IsRFC3849() || IsRFC9637())
444 return false;
445
446 if (IsInternal())
447 return false;
448
449 if (IsIPv4()) {
450 const uint32_t addr = ReadBE32(m_addr.data());
451 if (addr == INADDR_ANY || addr == INADDR_NONE) {
452 return false;
453 }
454 }
455
456 return true;
457}
458
469{
470 return IsValid() && !(IsRFC1918() || IsRFC2544() || IsRFC3927() || IsRFC4862() || IsRFC6598() || IsRFC5737() || IsRFC4193() || IsRFC4843() || IsRFC7343() || IsLocal() || IsInternal());
471}
472
479{
480 return m_net == NET_INTERNAL;
481}
482
484{
485 switch (m_net) {
486 case NET_IPV4:
487 case NET_IPV6:
488 case NET_INTERNAL:
489 return true;
490 case NET_ONION:
491 case NET_I2P:
492 case NET_CJDNS:
493 return false;
494 case NET_UNROUTABLE: // m_net is never and should not be set to NET_UNROUTABLE
495 case NET_MAX: // m_net is never and should not be set to NET_MAX
496 assert(false);
497 } // no default case, so the compiler can warn about missing cases
498
499 assert(false);
500}
501
503{
504 if (IsInternal())
505 return NET_INTERNAL;
506
507 if (!IsRoutable())
508 return NET_UNROUTABLE;
509
510 return m_net;
511}
512
513static std::string IPv4ToString(std::span<const uint8_t> a)
514{
515 return strprintf("%u.%u.%u.%u", a[0], a[1], a[2], a[3]);
516}
517
518// Return an IPv6 address text representation with zero compression as described in RFC 5952
519// ("A Recommendation for IPv6 Address Text Representation").
520static std::string IPv6ToString(std::span<const uint8_t> a, uint32_t scope_id)
521{
522 assert(a.size() == ADDR_IPV6_SIZE);
523 const std::array groups{
524 ReadBE16(&a[0]),
525 ReadBE16(&a[2]),
526 ReadBE16(&a[4]),
527 ReadBE16(&a[6]),
528 ReadBE16(&a[8]),
529 ReadBE16(&a[10]),
530 ReadBE16(&a[12]),
531 ReadBE16(&a[14]),
532 };
533
534 // The zero compression implementation is inspired by Rust's std::net::Ipv6Addr, see
535 // https://github.com/rust-lang/rust/blob/cc4103089f40a163f6d143f06359cba7043da29b/library/std/src/net/ip.rs#L1635-L1683
536 struct ZeroSpan {
537 size_t start_index{0};
538 size_t len{0};
539 };
540
541 // Find longest sequence of consecutive all-zero fields. Use first zero sequence if two or more
542 // zero sequences of equal length are found.
543 ZeroSpan longest, current;
544 for (size_t i{0}; i < groups.size(); ++i) {
545 if (groups[i] != 0) {
546 current = {i + 1, 0};
547 continue;
548 }
549 current.len += 1;
550 if (current.len > longest.len) {
551 longest = current;
552 }
553 }
554
555 std::string r;
556 r.reserve(39);
557 for (size_t i{0}; i < groups.size(); ++i) {
558 // Replace the longest sequence of consecutive all-zero fields with two colons ("::").
559 if (longest.len >= 2 && i >= longest.start_index && i < longest.start_index + longest.len) {
560 if (i == longest.start_index) {
561 r += "::";
562 }
563 continue;
564 }
565 r += strprintf("%s%x", ((!r.empty() && r.back() != ':') ? ":" : ""), groups[i]);
566 }
567
568 if (scope_id != 0) {
569 r += strprintf("%%%u", scope_id);
570 }
571
572 return r;
573}
574
575std::string OnionToString(std::span<const uint8_t> addr)
576{
577 uint8_t checksum[torv3::CHECKSUM_LEN];
578 torv3::Checksum(addr, checksum);
579 // TORv3 onion_address = base32(PUBKEY | CHECKSUM | VERSION) + ".onion"
580 prevector<torv3::TOTAL_LEN, uint8_t> address{addr.begin(), addr.end()};
581 address.insert(address.end(), checksum, checksum + torv3::CHECKSUM_LEN);
582 address.insert(address.end(), torv3::VERSION, torv3::VERSION + sizeof(torv3::VERSION));
583 return EncodeBase32(address) + ".onion";
584}
585
586std::string CNetAddr::ToStringAddr() const
587{
588 switch (m_net) {
589 case NET_IPV4:
590 return IPv4ToString(m_addr);
591 case NET_IPV6:
593 case NET_ONION:
594 return OnionToString(m_addr);
595 case NET_I2P:
596 return EncodeBase32(m_addr, false /* don't pad with = */) + ".b32.i2p";
597 case NET_CJDNS:
598 return IPv6ToString(m_addr, 0);
599 case NET_INTERNAL:
600 return EncodeBase32(m_addr) + ".internal";
601 case NET_UNROUTABLE: // m_net is never and should not be set to NET_UNROUTABLE
602 case NET_MAX: // m_net is never and should not be set to NET_MAX
603 assert(false);
604 } // no default case, so the compiler can warn about missing cases
605
606 assert(false);
607}
608
609bool operator==(const CNetAddr& a, const CNetAddr& b)
610{
611 return a.m_net == b.m_net && a.m_addr == b.m_addr;
612}
613
614bool operator<(const CNetAddr& a, const CNetAddr& b)
615{
616 return std::tie(a.m_net, a.m_addr) < std::tie(b.m_net, b.m_addr);
617}
618
629bool CNetAddr::GetInAddr(struct in_addr* pipv4Addr) const
630{
631 if (!IsIPv4())
632 return false;
633 assert(sizeof(*pipv4Addr) == m_addr.size());
634 memcpy(pipv4Addr, m_addr.data(), m_addr.size());
635 return true;
636}
637
648bool CNetAddr::GetIn6Addr(struct in6_addr* pipv6Addr) const
649{
650 if (!IsIPv6() && !IsCJDNS()) {
651 return false;
652 }
653 assert(sizeof(*pipv6Addr) == m_addr.size());
654 memcpy(pipv6Addr, m_addr.data(), m_addr.size());
655 return true;
656}
657
659{
660 return IsRoutable() && (IsIPv4() || IsRFC6145() || IsRFC6052() || IsRFC3964() || IsRFC4380());
661}
662
664{
665 if (IsIPv4()) {
666 return ReadBE32(m_addr.data());
667 } else if (IsRFC6052() || IsRFC6145()) {
668 // mapped IPv4, SIIT translated IPv4: the IPv4 address is the last 4 bytes of the address
669 return ReadBE32(std::span{m_addr}.last(ADDR_IPV4_SIZE).data());
670 } else if (IsRFC3964()) {
671 // 6to4 tunneled IPv4: the IPv4 address is in bytes 2-6
672 return ReadBE32(std::span{m_addr}.subspan(2, ADDR_IPV4_SIZE).data());
673 } else if (IsRFC4380()) {
674 // Teredo tunneled IPv4: the IPv4 address is in the last 4 bytes of the address, but bitflipped
675 return ~ReadBE32(std::span{m_addr}.last(ADDR_IPV4_SIZE).data());
676 }
677 assert(false);
678}
679
681{
682 // Make sure that if we return NET_IPV6, then IsIPv6() is true. The callers expect that.
683
684 // Check for "internal" first because such addresses are also !IsRoutable()
685 // and we don't want to return NET_UNROUTABLE in that case.
686 if (IsInternal()) {
687 return NET_INTERNAL;
688 }
689 if (!IsRoutable()) {
690 return NET_UNROUTABLE;
691 }
692 if (HasLinkedIPv4()) {
693 return NET_IPV4;
694 }
695 return m_net;
696}
697
698std::vector<unsigned char> CNetAddr::GetAddrBytes() const
699{
700 if (IsAddrV1Compatible()) {
701 uint8_t serialized[V1_SERIALIZATION_SIZE];
702 SerializeV1Array(serialized);
703 return {std::begin(serialized), std::end(serialized)};
704 }
705 return std::vector<unsigned char>(m_addr.begin(), m_addr.end());
706}
707
708// private extensions to enum Network, only returned by GetExtNetwork,
709// and only used in GetReachabilityFrom
710static const int NET_TEREDO = NET_MAX;
711int static GetExtNetwork(const CNetAddr& addr)
712{
713 if (addr.IsRFC4380())
714 return NET_TEREDO;
715 return addr.GetNetwork();
716}
717
719int CNetAddr::GetReachabilityFrom(const CNetAddr& paddrPartner) const
720{
721 enum Reachability {
722 REACH_UNREACHABLE,
723 REACH_DEFAULT,
724 REACH_TEREDO,
725 REACH_IPV6_WEAK,
726 REACH_IPV4,
727 REACH_IPV6_STRONG,
728 REACH_PRIVATE
729 };
730
731 if (!IsRoutable() || IsInternal())
732 return REACH_UNREACHABLE;
733
734 int ourNet = GetExtNetwork(*this);
735 int theirNet = GetExtNetwork(paddrPartner);
736 bool fTunnel = IsRFC3964() || IsRFC6052() || IsRFC6145();
737
738 switch(theirNet) {
739 case NET_IPV4:
740 switch(ourNet) {
741 default: return REACH_DEFAULT;
742 case NET_IPV4: return REACH_IPV4;
743 }
744 case NET_IPV6:
745 switch(ourNet) {
746 default: return REACH_DEFAULT;
747 case NET_TEREDO: return REACH_TEREDO;
748 case NET_IPV4: return REACH_IPV4;
749 case NET_IPV6: return fTunnel ? REACH_IPV6_WEAK : REACH_IPV6_STRONG; // only prefer giving our IPv6 address if it's not tunnelled
750 }
751 case NET_ONION:
752 switch(ourNet) {
753 default: return REACH_DEFAULT;
754 case NET_IPV4: return REACH_IPV4; // Tor users can connect to IPv4 as well
755 case NET_ONION: return REACH_PRIVATE;
756 }
757 case NET_I2P:
758 switch (ourNet) {
759 case NET_I2P: return REACH_PRIVATE;
760 default: return REACH_DEFAULT;
761 }
762 case NET_CJDNS:
763 switch (ourNet) {
764 case NET_CJDNS: return REACH_PRIVATE;
765 default: return REACH_DEFAULT;
766 }
767 case NET_TEREDO:
768 switch(ourNet) {
769 default: return REACH_DEFAULT;
770 case NET_TEREDO: return REACH_TEREDO;
771 case NET_IPV6: return REACH_IPV6_WEAK;
772 case NET_IPV4: return REACH_IPV4;
773 }
774 case NET_UNROUTABLE:
775 default:
776 switch(ourNet) {
777 default: return REACH_DEFAULT;
778 case NET_TEREDO: return REACH_TEREDO;
779 case NET_IPV6: return REACH_IPV6_WEAK;
780 case NET_IPV4: return REACH_IPV4;
781 case NET_ONION: return REACH_PRIVATE; // either from Tor, or don't care about our address
782 }
783 }
784}
785
787{
788}
789
790CService::CService(const CNetAddr& cip, uint16_t portIn) : CNetAddr(cip), port(portIn)
791{
792}
793
794CService::CService(const struct in_addr& ipv4Addr, uint16_t portIn) : CNetAddr(ipv4Addr), port(portIn)
795{
796}
797
798CService::CService(const struct in6_addr& ipv6Addr, uint16_t portIn) : CNetAddr(ipv6Addr), port(portIn)
799{
800}
801
802CService::CService(const struct sockaddr_in& addr) : CNetAddr(addr.sin_addr), port(ntohs(addr.sin_port))
803{
804 assert(addr.sin_family == AF_INET);
805}
806
807CService::CService(const struct sockaddr_in6 &addr) : CNetAddr(addr.sin6_addr, addr.sin6_scope_id), port(ntohs(addr.sin6_port))
808{
809 assert(addr.sin6_family == AF_INET6);
810}
811
812bool CService::SetSockAddr(const struct sockaddr *paddr, socklen_t addrlen)
813{
814 switch (paddr->sa_family) {
815 case AF_INET:
816 if (addrlen != sizeof(struct sockaddr_in)) return false;
817 *this = CService(*(const struct sockaddr_in*)paddr);
818 return true;
819 case AF_INET6:
820 if (addrlen != sizeof(struct sockaddr_in6)) return false;
821 *this = CService(*(const struct sockaddr_in6*)paddr);
822 return true;
823 default:
824 return false;
825 }
826}
827
828sa_family_t CService::GetSAFamily() const
829{
830 switch (m_net) {
831 case NET_IPV4:
832 return AF_INET;
833 case NET_IPV6:
834 case NET_CJDNS:
835 return AF_INET6;
836 default:
837 return AF_UNSPEC;
838 }
839}
840
841uint16_t CService::GetPort() const
842{
843 return port;
844}
845
846bool operator==(const CService& a, const CService& b)
847{
848 return static_cast<CNetAddr>(a) == static_cast<CNetAddr>(b) && a.port == b.port;
849}
850
851bool operator<(const CService& a, const CService& b)
852{
853 return static_cast<CNetAddr>(a) < static_cast<CNetAddr>(b) || (static_cast<CNetAddr>(a) == static_cast<CNetAddr>(b) && a.port < b.port);
854}
855
868bool CService::GetSockAddr(struct sockaddr* paddr, socklen_t *addrlen) const
869{
870 if (IsIPv4()) {
871 if (*addrlen < (socklen_t)sizeof(struct sockaddr_in))
872 return false;
873 *addrlen = sizeof(struct sockaddr_in);
874 struct sockaddr_in *paddrin = (struct sockaddr_in*)paddr;
875 memset(paddrin, 0, *addrlen);
876 if (!GetInAddr(&paddrin->sin_addr))
877 return false;
878 paddrin->sin_family = AF_INET;
879 paddrin->sin_port = htons(port);
880 return true;
881 }
882 if (IsIPv6() || IsCJDNS()) {
883 if (*addrlen < (socklen_t)sizeof(struct sockaddr_in6))
884 return false;
885 *addrlen = sizeof(struct sockaddr_in6);
886 struct sockaddr_in6 *paddrin6 = (struct sockaddr_in6*)paddr;
887 memset(paddrin6, 0, *addrlen);
888 if (!GetIn6Addr(&paddrin6->sin6_addr))
889 return false;
890 paddrin6->sin6_scope_id = m_scope_id;
891 paddrin6->sin6_family = AF_INET6;
892 paddrin6->sin6_port = htons(port);
893 return true;
894 }
895 return false;
896}
897
901std::vector<unsigned char> CService::GetKey() const
902{
903 auto key = GetAddrBytes();
904 key.push_back(port / 0x100); // most significant byte of our port
905 key.push_back(port & 0x0FF); // least significant byte of our port
906 return key;
907}
908
909std::string CService::ToStringAddrPort() const
910{
911 const auto port_str = strprintf("%u", port);
912
913 if (IsIPv4() || IsTor() || IsI2P() || IsInternal()) {
914 return ToStringAddr() + ":" + port_str;
915 } else {
916 return "[" + ToStringAddr() + "]:" + port_str;
917 }
918}
919
921 valid(false)
922{
923 memset(netmask, 0, sizeof(netmask));
924}
925
926CSubNet::CSubNet(const CNetAddr& addr, uint8_t mask) : CSubNet()
927{
928 valid = (addr.IsIPv4() && mask <= ADDR_IPV4_SIZE * 8) ||
929 (addr.IsIPv6() && mask <= ADDR_IPV6_SIZE * 8);
930 if (!valid) {
931 return;
932 }
933
934 assert(mask <= sizeof(netmask) * 8);
935
936 network = addr;
937
938 uint8_t n = mask;
939 for (size_t i = 0; i < network.m_addr.size(); ++i) {
940 const uint8_t bits = n < 8 ? n : 8;
941 netmask[i] = (uint8_t)((uint8_t)0xFF << (8 - bits)); // Set first bits.
942 network.m_addr[i] &= netmask[i]; // Normalize network according to netmask.
943 n -= bits;
944 }
945}
946
951static inline int NetmaskBits(uint8_t x)
952{
953 switch(x) {
954 case 0x00: return 0;
955 case 0x80: return 1;
956 case 0xc0: return 2;
957 case 0xe0: return 3;
958 case 0xf0: return 4;
959 case 0xf8: return 5;
960 case 0xfc: return 6;
961 case 0xfe: return 7;
962 case 0xff: return 8;
963 default: return -1;
964 }
965}
966
967CSubNet::CSubNet(const CNetAddr& addr, const CNetAddr& mask) : CSubNet()
968{
969 valid = (addr.IsIPv4() || addr.IsIPv6()) && addr.m_net == mask.m_net;
970 if (!valid) {
971 return;
972 }
973 // Check if `mask` contains 1-bits after 0-bits (which is an invalid netmask).
974 bool zeros_found = false;
975 for (auto b : mask.m_addr) {
976 const int num_bits = NetmaskBits(b);
977 if (num_bits == -1 || (zeros_found && num_bits != 0)) {
978 valid = false;
979 return;
980 }
981 if (num_bits < 8) {
982 zeros_found = true;
983 }
984 }
985
986 assert(mask.m_addr.size() <= sizeof(netmask));
987
988 memcpy(netmask, mask.m_addr.data(), mask.m_addr.size());
989
990 network = addr;
991
992 // Normalize network according to netmask
993 for (size_t x = 0; x < network.m_addr.size(); ++x) {
994 network.m_addr[x] &= netmask[x];
995 }
996}
997
999{
1000 switch (addr.m_net) {
1001 case NET_IPV4:
1002 case NET_IPV6:
1003 valid = true;
1004 assert(addr.m_addr.size() <= sizeof(netmask));
1005 memset(netmask, 0xFF, addr.m_addr.size());
1006 break;
1007 case NET_ONION:
1008 case NET_I2P:
1009 case NET_CJDNS:
1010 valid = true;
1011 break;
1012 case NET_INTERNAL:
1013 case NET_UNROUTABLE:
1014 case NET_MAX:
1015 return;
1016 }
1017
1018 network = addr;
1019}
1020
1025bool CSubNet::Match(const CNetAddr &addr) const
1026{
1027 if (!valid || !addr.IsValid() || network.m_net != addr.m_net)
1028 return false;
1029
1030 switch (network.m_net) {
1031 case NET_IPV4:
1032 case NET_IPV6:
1033 break;
1034 case NET_ONION:
1035 case NET_I2P:
1036 case NET_CJDNS:
1037 case NET_INTERNAL:
1038 return addr == network;
1039 case NET_UNROUTABLE:
1040 case NET_MAX:
1041 return false;
1042 }
1043
1044 assert(network.m_addr.size() == addr.m_addr.size());
1045 for (size_t x = 0; x < addr.m_addr.size(); ++x) {
1046 if ((addr.m_addr[x] & netmask[x]) != network.m_addr[x]) {
1047 return false;
1048 }
1049 }
1050 return true;
1051}
1052
1053std::string CSubNet::ToString() const
1054{
1055 std::string suffix;
1056
1057 switch (network.m_net) {
1058 case NET_IPV4:
1059 case NET_IPV6: {
1060 assert(network.m_addr.size() <= sizeof(netmask));
1061
1062 uint8_t cidr = 0;
1063
1064 for (size_t i = 0; i < network.m_addr.size(); ++i) {
1065 if (netmask[i] == 0x00) {
1066 break;
1067 }
1068 cidr += NetmaskBits(netmask[i]);
1069 }
1070
1071 suffix = strprintf("/%u", cidr);
1072 break;
1073 }
1074 case NET_ONION:
1075 case NET_I2P:
1076 case NET_CJDNS:
1077 case NET_INTERNAL:
1078 case NET_UNROUTABLE:
1079 case NET_MAX:
1080 break;
1081 }
1082
1083 return network.ToStringAddr() + suffix;
1084}
1085
1087{
1088 return valid;
1089}
1090
1091bool operator==(const CSubNet& a, const CSubNet& b)
1092{
1093 return a.valid == b.valid && a.network == b.network && !memcmp(a.netmask, b.netmask, 16);
1094}
1095
1096bool operator<(const CSubNet& a, const CSubNet& b)
1097{
1098 return (a.network < b.network || (a.network == b.network && memcmp(a.netmask, b.netmask, 16) < 0));
1099}
if(!SetupNetworking())
Network address.
Definition: netaddress.h:113
Network GetNetClass() const
Definition: netaddress.cpp:680
void SerializeV1Array(uint8_t(&arr)[V1_SERIALIZATION_SIZE]) const
Serialize in pre-ADDRv2/BIP155 format to an array.
Definition: netaddress.h:325
std::string ToStringAddr() const
Definition: netaddress.cpp:586
prevector< ADDR_IPV6_SIZE, uint8_t > m_addr
Raw representation of the network address.
Definition: netaddress.h:119
bool IsBindAny() const
Definition: netaddress.cpp:303
bool IsRFC6052() const
Definition: netaddress.cpp:357
void SetIP(const CNetAddr &ip)
Definition: netaddress.cpp:107
bool IsRFC7343() const
Definition: netaddress.cpp:393
bool GetIn6Addr(struct in6_addr *pipv6Addr) const
Try to get our IPv6 (or CJDNS) address.
Definition: netaddress.cpp:648
std::vector< unsigned char > GetAddrBytes() const
Definition: netaddress.cpp:698
bool IsCJDNS() const
Definition: netaddress.h:178
bool IsTor() const
Definition: netaddress.h:176
bool IsRoutable() const
Definition: netaddress.cpp:468
bool GetInAddr(struct in_addr *pipv4Addr) const
Try to get our IPv4 address.
Definition: netaddress.cpp:629
bool HasLinkedIPv4() const
Whether this address has a linked IPv4 address (see GetLinkedIPv4()).
Definition: netaddress.cpp:658
bool HasCJDNSPrefix() const
Definition: netaddress.h:179
Network m_net
Network to which this address belongs.
Definition: netaddress.h:124
bool IsRFC5737() const
Definition: netaddress.cpp:334
bool SetSpecial(std::string_view addr)
Parse a Tor or I2P address and set this object to it.
Definition: netaddress.cpp:212
bool IsRFC6598() const
Definition: netaddress.cpp:329
bool IsRFC1918() const
Definition: netaddress.cpp:311
bool IsValid() const
Definition: netaddress.cpp:430
bool IsIPv4() const
Definition: netaddress.h:158
BIP155Network GetBIP155Network() const
Get the BIP155 network id of this address.
Definition: netaddress.cpp:27
void SetLegacyIPv6(std::span< const uint8_t > ipv6)
Set from a legacy IPv6 address.
Definition: netaddress.cpp:138
uint32_t GetLinkedIPv4() const
For IPv4, mapped IPv4, SIIT translated IPv4, Teredo, 6to4 tunneled addresses, return the relevant IPv...
Definition: netaddress.cpp:663
uint32_t m_scope_id
Scope id if scoped/link-local IPV6 address.
Definition: netaddress.h:130
bool IsRFC3849() const
Definition: netaddress.cpp:341
bool IsHeNet() const
Definition: netaddress.cpp:399
bool IsLocal() const
Definition: netaddress.cpp:404
bool SetI2P(std::string_view addr)
Parse an I2P address and set this object to it.
Definition: netaddress.cpp:263
static constexpr size_t V1_SERIALIZATION_SIZE
Size of CNetAddr when serialized as ADDRv1 (pre-BIP155) (in bytes).
Definition: netaddress.h:297
bool IsIPv6() const
Definition: netaddress.h:159
bool IsInternal() const
Definition: netaddress.cpp:478
bool SetNetFromBIP155Network(uint8_t possible_bip155_net, size_t address_size)
Set m_net from the provided BIP155 network id and size after validation.
Definition: netaddress.cpp:49
bool SetInternal(const std::string &name)
Create an "internal" address that represents a name or FQDN.
Definition: netaddress.cpp:173
bool IsRFC4193() const
Definition: netaddress.cpp:375
bool IsRFC2544() const
Definition: netaddress.cpp:319
enum Network GetNetwork() const
Definition: netaddress.cpp:502
bool IsRFC6145() const
Definition: netaddress.cpp:380
int GetReachabilityFrom(const CNetAddr &paddrPartner) const
Calculates a metric for how reachable (*this) is from a given partner.
Definition: netaddress.cpp:719
bool IsRFC9637() const
Definition: netaddress.cpp:346
CNetAddr()
Construct an unspecified IPv6 network address (::/128).
bool IsRFC3964() const
Definition: netaddress.cpp:352
bool SetTor(std::string_view addr)
Parse a Tor address and set this object to it.
Definition: netaddress.cpp:229
bool IsRFC4380() const
Definition: netaddress.cpp:364
bool IsAddrV1Compatible() const
Check if the current object can be serialized in pre-ADDRv2/BIP155 format.
Definition: netaddress.cpp:483
BIP155Network
BIP155 network ids recognized by this software.
Definition: netaddress.h:264
bool IsRFC3927() const
Definition: netaddress.cpp:324
bool IsRFC4862() const
Definition: netaddress.cpp:369
bool IsRFC4843() const
Definition: netaddress.cpp:387
bool IsI2P() const
Definition: netaddress.h:177
A hasher class for SHA-256.
Definition: sha256.h:14
void Finalize(unsigned char hash[OUTPUT_SIZE])
Definition: sha256.cpp:725
CSHA256 & Write(const unsigned char *data, size_t len)
Definition: sha256.cpp:699
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:531
bool SetSockAddr(const struct sockaddr *paddr, socklen_t addrlen)
Set CService from a network sockaddr.
Definition: netaddress.cpp:812
uint16_t GetPort() const
Definition: netaddress.cpp:841
sa_family_t GetSAFamily() const
Get the address family.
Definition: netaddress.cpp:828
uint16_t port
Definition: netaddress.h:533
bool GetSockAddr(struct sockaddr *paddr, socklen_t *addrlen) const
Obtain the IPv4/6 socket address this represents.
Definition: netaddress.cpp:868
std::string ToStringAddrPort() const
Definition: netaddress.cpp:909
std::vector< unsigned char > GetKey() const
Definition: netaddress.cpp:901
bool valid
Is this value valid? (only used to signal parse errors)
Definition: netaddress.h:488
CNetAddr network
Network (base) address.
Definition: netaddress.h:484
uint8_t netmask[16]
Netmask, in network byte order.
Definition: netaddress.h:486
std::string ToString() const
bool IsValid() const
CSubNet()
Construct an invalid subnet (empty, Match() always returns false).
Definition: netaddress.cpp:920
bool Match(const CNetAddr &addr) const
Definition: sha3.h:16
SHA3_256 & Write(std::span< const unsigned char > data)
Definition: sha3.cpp:105
SHA3_256 & Finalize(std::span< unsigned char > output)
Definition: sha3.cpp:135
static constexpr size_t OUTPUT_SIZE
Definition: sha3.h:32
Implements a drop-in replacement for std::vector<T> which stores up to N elements directly (without h...
Definition: prevector.h:37
size_type size() const
Definition: prevector.h:247
value_type * data()
Definition: prevector.h:464
iterator begin()
Definition: prevector.h:255
iterator end()
Definition: prevector.h:257
void assign(size_type n, const T &val)
Definition: prevector.h:176
static const PrecomputedData data
Precomputed COutPoint and CCoins values.
uint16_t ReadBE16(const B *ptr)
Definition: common.h:64
uint32_t ReadBE32(const B *ptr)
Definition: common.h:72
@ I2P
Definition: categories.h:37
void format(std::ostream &out, FormatStringCheck< sizeof...(Args)> fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1079
static const unsigned char VERSION[]
Definition: netaddress.cpp:188
static void Checksum(std::span< const uint8_t > addr_pubkey, uint8_t(&checksum)[CHECKSUM_LEN])
Definition: netaddress.cpp:191
static constexpr size_t CHECKSUM_LEN
Definition: netaddress.cpp:187
static constexpr size_t TOTAL_LEN
Definition: netaddress.cpp:189
bool HasPrefix(const T1 &obj, const std::array< uint8_t, PREFIX_LEN > &prefix)
Check whether a container begins with the given prefix.
Definition: string.h:262
bool ContainsNUL(std::string_view str) noexcept
Check if a string contains any embedded NUL (\0) characters.
Definition: string.h:238
static std::string IPv6ToString(std::span< const uint8_t > a, uint32_t scope_id)
Definition: netaddress.cpp:520
static const int NET_TEREDO
Definition: netaddress.cpp:710
static int NetmaskBits(uint8_t x)
Definition: netaddress.cpp:951
bool operator==(const CNetAddr &a, const CNetAddr &b)
Definition: netaddress.cpp:609
static std::string IPv4ToString(std::span< const uint8_t > a)
Definition: netaddress.cpp:513
bool operator<(const CNetAddr &a, const CNetAddr &b)
Definition: netaddress.cpp:614
std::string OnionToString(std::span< const uint8_t > addr)
Definition: netaddress.cpp:575
static int GetExtNetwork(const CNetAddr &addr)
Definition: netaddress.cpp:711
constexpr size_t ADDR_CJDNS_SIZE
Size of CJDNS address (in bytes).
Definition: netaddress.h:99
constexpr std::array< uint8_t, 6 > INTERNAL_IN_IPV6_PREFIX
Prefix of an IPv6 address when it contains an embedded "internal" address.
Definition: netaddress.h:77
constexpr size_t ADDR_TORV3_SIZE
Size of TORv3 address (in bytes).
Definition: netaddress.h:93
constexpr size_t ADDR_I2P_SIZE
Size of I2P address (in bytes).
Definition: netaddress.h:96
constexpr size_t ADDR_INTERNAL_SIZE
Size of "internal" (NET_INTERNAL) address (in bytes).
Definition: netaddress.h:102
constexpr size_t ADDR_IPV4_SIZE
Size of IPv4 address (in bytes).
Definition: netaddress.h:86
Network
A network type.
Definition: netaddress.h:33
@ NET_I2P
I2P.
Definition: netaddress.h:47
@ NET_CJDNS
CJDNS.
Definition: netaddress.h:50
@ NET_MAX
Dummy value to indicate the number of NET_* constants.
Definition: netaddress.h:57
@ NET_ONION
TOR (v2 or v3)
Definition: netaddress.h:44
@ NET_IPV6
IPv6.
Definition: netaddress.h:41
@ NET_IPV4
IPv4.
Definition: netaddress.h:38
@ NET_UNROUTABLE
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:35
@ NET_INTERNAL
A set of addresses that represent the hash of a string or FQDN.
Definition: netaddress.h:54
constexpr size_t ADDR_IPV6_SIZE
Size of IPv6 address (in bytes).
Definition: netaddress.h:89
constexpr std::array< uint8_t, 12 > IPV4_IN_IPV6_PREFIX
Prefix of an IPv6 address when it contains an embedded IPv4 address.
Definition: netaddress.h:62
constexpr std::array< uint8_t, 6 > TORV2_IN_IPV6_PREFIX
Prefix of an IPv6 address when it contains an embedded TORv2 address.
Definition: netaddress.h:69
@ IPV4
Definition: netbase.cpp:288
@ IPV6
Definition: netbase.cpp:290
const char * prefix
Definition: rest.cpp:1197
const char * name
Definition: rest.cpp:71
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
std::optional< std::vector< unsigned char > > DecodeBase32(std::string_view str)
std::string EncodeBase32(std::span< const unsigned char > input, bool pad)
Base32 encode.
std::string ToLower(std::string_view str)
Returns the lowercase equivalent of the given string.
assert(!tx.IsCoinBase())