Branch data Line data Source code
1 : : // Copyright (c) 2014-2022 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <base58.h>
6 : :
7 : : #include <hash.h>
8 : : #include <uint256.h>
9 : : #include <util/strencodings.h>
10 : : #include <util/string.h>
11 : :
12 : : #include <assert.h>
13 : : #include <string.h>
14 : :
15 : : #include <limits>
16 : :
17 : : /** All alphanumeric characters except for "0", "I", "O", and "l" */
18 : : static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
19 : : static const int8_t mapBase58[256] = {
20 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
21 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
22 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
23 : : -1, 0, 1, 2, 3, 4, 5, 6, 7, 8,-1,-1,-1,-1,-1,-1,
24 : : -1, 9,10,11,12,13,14,15, 16,-1,17,18,19,20,21,-1,
25 : : 22,23,24,25,26,27,28,29, 30,31,32,-1,-1,-1,-1,-1,
26 : : -1,33,34,35,36,37,38,39, 40,41,42,43,-1,44,45,46,
27 : : 47,48,49,50,51,52,53,54, 55,56,57,-1,-1,-1,-1,-1,
28 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
29 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
30 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
31 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
32 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
33 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
34 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
35 : : -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
36 : : };
37 : :
38 : 0 : [[nodiscard]] static bool DecodeBase58(const char* psz, std::vector<unsigned char>& vch, int max_ret_len)
39 : : {
40 : : // Skip leading spaces.
41 [ # # # # ]: 0 : while (*psz && IsSpace(*psz))
42 : 0 : psz++;
43 : : // Skip and count leading '1's.
44 : 0 : int zeroes = 0;
45 : 0 : int length = 0;
46 [ # # ]: 0 : while (*psz == '1') {
47 : 0 : zeroes++;
48 [ # # ]: 0 : if (zeroes > max_ret_len) return false;
49 : 0 : psz++;
50 : : }
51 : : // Allocate enough space in big-endian base256 representation.
52 : 0 : int size = strlen(psz) * 733 /1000 + 1; // log(58) / log(256), rounded up.
53 [ # # ]: 0 : std::vector<unsigned char> b256(size);
54 : : // Process the characters.
55 : : static_assert(std::size(mapBase58) == 256, "mapBase58.size() should be 256"); // guarantee not out of range
56 [ # # # # ]: 0 : while (*psz && !IsSpace(*psz)) {
57 : : // Decode base58 character
58 : 0 : int carry = mapBase58[(uint8_t)*psz];
59 [ # # ]: 0 : if (carry == -1) // Invalid b58 character
60 : 0 : return false;
61 : 0 : int i = 0;
62 [ # # # # : 0 : for (std::vector<unsigned char>::reverse_iterator it = b256.rbegin(); (carry != 0 || i < length) && (it != b256.rend()); ++it, ++i) {
# # # # #
# ]
63 : 0 : carry += 58 * (*it);
64 : 0 : *it = carry % 256;
65 : 0 : carry /= 256;
66 : 0 : }
67 [ # # ]: 0 : assert(carry == 0);
68 : 0 : length = i;
69 [ # # ]: 0 : if (length + zeroes > max_ret_len) return false;
70 : 0 : psz++;
71 : : }
72 : : // Skip trailing spaces.
73 [ # # ]: 0 : while (IsSpace(*psz))
74 : 0 : psz++;
75 [ # # ]: 0 : if (*psz != 0)
76 : 0 : return false;
77 : : // Skip leading zeroes in b256.
78 : 0 : std::vector<unsigned char>::iterator it = b256.begin() + (size - length);
79 : : // Copy result into output vector.
80 [ # # ]: 0 : vch.reserve(zeroes + (b256.end() - it));
81 [ # # ]: 0 : vch.assign(zeroes, 0x00);
82 [ # # ]: 0 : while (it != b256.end())
83 [ # # ]: 0 : vch.push_back(*(it++));
84 : 0 : return true;
85 : 0 : }
86 : :
87 : 0 : std::string EncodeBase58(Span<const unsigned char> input)
88 : : {
89 : : // Skip & count leading zeroes.
90 : 0 : int zeroes = 0;
91 : 0 : int length = 0;
92 [ # # # # ]: 0 : while (input.size() > 0 && input[0] == 0) {
93 : 0 : input = input.subspan(1);
94 : 0 : zeroes++;
95 : : }
96 : : // Allocate enough space in big-endian base58 representation.
97 : 0 : int size = input.size() * 138 / 100 + 1; // log(256) / log(58), rounded up.
98 [ # # ]: 0 : std::vector<unsigned char> b58(size);
99 : : // Process the bytes.
100 [ # # ]: 0 : while (input.size() > 0) {
101 : 0 : int carry = input[0];
102 : 0 : int i = 0;
103 : : // Apply "b58 = b58 * 256 + ch".
104 [ # # # # : 0 : for (std::vector<unsigned char>::reverse_iterator it = b58.rbegin(); (carry != 0 || i < length) && (it != b58.rend()); it++, i++) {
# # # # #
# ]
105 [ # # ]: 0 : carry += 256 * (*it);
106 [ # # ]: 0 : *it = carry % 58;
107 : 0 : carry /= 58;
108 : 0 : }
109 : :
110 [ # # ]: 0 : assert(carry == 0);
111 : 0 : length = i;
112 : 0 : input = input.subspan(1);
113 : : }
114 : : // Skip leading zeroes in base58 result.
115 : 0 : std::vector<unsigned char>::iterator it = b58.begin() + (size - length);
116 [ # # # # ]: 0 : while (it != b58.end() && *it == 0)
117 : 0 : it++;
118 : : // Translate the result into a string.
119 : 0 : std::string str;
120 [ # # ]: 0 : str.reserve(zeroes + (b58.end() - it));
121 [ # # ]: 0 : str.assign(zeroes, '1');
122 [ # # ]: 0 : while (it != b58.end())
123 [ # # ]: 0 : str += pszBase58[*(it++)];
124 : 0 : return str;
125 [ # # ]: 0 : }
126 : :
127 : 0 : bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret_len)
128 : : {
129 [ # # ]: 0 : if (!ContainsNoNUL(str)) {
130 : 0 : return false;
131 : : }
132 : 0 : return DecodeBase58(str.c_str(), vchRet, max_ret_len);
133 : 0 : }
134 : :
135 : 0 : std::string EncodeBase58Check(Span<const unsigned char> input)
136 : : {
137 : : // add 4-byte hash check to the end
138 [ # # ]: 0 : std::vector<unsigned char> vch(input.begin(), input.end());
139 [ # # ]: 0 : uint256 hash = Hash(vch);
140 [ # # ]: 0 : vch.insert(vch.end(), (unsigned char*)&hash, (unsigned char*)&hash + 4);
141 [ # # # # ]: 0 : return EncodeBase58(vch);
142 : 0 : }
143 : :
144 : 0 : [[nodiscard]] static bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet, int max_ret_len)
145 : : {
146 [ # # # # : 0 : if (!DecodeBase58(psz, vchRet, max_ret_len > std::numeric_limits<int>::max() - 4 ? std::numeric_limits<int>::max() : max_ret_len + 4) ||
# # ]
147 : 0 : (vchRet.size() < 4)) {
148 : 0 : vchRet.clear();
149 : 0 : return false;
150 : : }
151 : : // re-calculate the checksum, ensure it matches the included 4-byte checksum
152 : 0 : uint256 hash = Hash(Span{vchRet}.first(vchRet.size() - 4));
153 [ # # ]: 0 : if (memcmp(&hash, &vchRet[vchRet.size() - 4], 4) != 0) {
154 : 0 : vchRet.clear();
155 : 0 : return false;
156 : : }
157 : 0 : vchRet.resize(vchRet.size() - 4);
158 : 0 : return true;
159 : 0 : }
160 : :
161 : 0 : bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret)
162 : : {
163 [ # # ]: 0 : if (!ContainsNoNUL(str)) {
164 : 0 : return false;
165 : : }
166 : 0 : return DecodeBase58Check(str.c_str(), vchRet, max_ret);
167 : 0 : }
|
