You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

base58.h 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  1. // Copyright (c) 2009-2010 Satoshi Nakamoto
  2. // Copyright (c) 2009-2012 The Bitcoin Developers
  3. // Distributed under the MIT/X11 software license, see the accompanying
  4. // file COPYING or http://www.opensource.org/licenses/mit-license.php.
  5. //
  6. // Why base-58 instead of standard base-64 encoding?
  7. // - Don't want 0OIl characters that look the same in some fonts and
  8. // could be used to create visually identical looking account numbers.
  9. // - A string with non-alphanumeric characters is not as easily accepted as an account number.
  10. // - E-mail usually won't line-break if there's no punctuation to break at.
  11. // - Double-clicking selects the whole number as one word if it's all alphanumeric.
  12. //
  13. #ifndef BITCOIN_BASE58_H
  14. #define BITCOIN_BASE58_H
  15. #include <string>
  16. #include <vector>
  17. #include "chainparams.h"
  18. #include "bignum.h"
  19. #include "key.h"
  20. #include "script.h"
  21. #include "allocators.h"
  22. static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
  23. // Encode a byte sequence as a base58-encoded string
  24. inline std::string EncodeBase58(const unsigned char* pbegin, const unsigned char* pend)
  25. {
  26. CAutoBN_CTX pctx;
  27. CBigNum bn58 = 58;
  28. CBigNum bn0 = 0;
  29. // Convert big endian data to little endian
  30. // Extra zero at the end make sure bignum will interpret as a positive number
  31. std::vector<unsigned char> vchTmp(pend-pbegin+1, 0);
  32. reverse_copy(pbegin, pend, vchTmp.begin());
  33. // Convert little endian data to bignum
  34. CBigNum bn;
  35. bn.setvch(vchTmp);
  36. // Convert bignum to std::string
  37. std::string str;
  38. // Expected size increase from base58 conversion is approximately 137%
  39. // use 138% to be safe
  40. str.reserve((pend - pbegin) * 138 / 100 + 1);
  41. CBigNum dv;
  42. CBigNum rem;
  43. while (bn > bn0)
  44. {
  45. if (!BN_div(&dv, &rem, &bn, &bn58, pctx))
  46. throw bignum_error("EncodeBase58 : BN_div failed");
  47. bn = dv;
  48. unsigned int c = rem.getulong();
  49. str += pszBase58[c];
  50. }
  51. // Leading zeroes encoded as base58 zeros
  52. for (const unsigned char* p = pbegin; p < pend && *p == 0; p++)
  53. str += pszBase58[0];
  54. // Convert little endian std::string to big endian
  55. reverse(str.begin(), str.end());
  56. return str;
  57. }
  58. // Encode a byte vector as a base58-encoded string
  59. inline std::string EncodeBase58(const std::vector<unsigned char>& vch)
  60. {
  61. return EncodeBase58(&vch[0], &vch[0] + vch.size());
  62. }
  63. // Decode a base58-encoded string psz into byte vector vchRet
  64. // returns true if decoding is successful
  65. inline bool DecodeBase58(const char* psz, std::vector<unsigned char>& vchRet)
  66. {
  67. CAutoBN_CTX pctx;
  68. vchRet.clear();
  69. CBigNum bn58 = 58;
  70. CBigNum bn = 0;
  71. CBigNum bnChar;
  72. while (isspace(*psz))
  73. psz++;
  74. // Convert big endian string to bignum
  75. for (const char* p = psz; *p; p++)
  76. {
  77. const char* p1 = strchr(pszBase58, *p);
  78. if (p1 == NULL)
  79. {
  80. while (isspace(*p))
  81. p++;
  82. if (*p != '\0')
  83. return false;
  84. break;
  85. }
  86. bnChar.setulong(p1 - pszBase58);
  87. if (!BN_mul(&bn, &bn, &bn58, pctx))
  88. throw bignum_error("DecodeBase58 : BN_mul failed");
  89. bn += bnChar;
  90. }
  91. // Get bignum as little endian data
  92. std::vector<unsigned char> vchTmp = bn.getvch();
  93. // Trim off sign byte if present
  94. if (vchTmp.size() >= 2 && vchTmp.end()[-1] == 0 && vchTmp.end()[-2] >= 0x80)
  95. vchTmp.erase(vchTmp.end()-1);
  96. // Restore leading zeros
  97. int nLeadingZeros = 0;
  98. for (const char* p = psz; *p == pszBase58[0]; p++)
  99. nLeadingZeros++;
  100. vchRet.assign(nLeadingZeros + vchTmp.size(), 0);
  101. // Convert little endian data to big endian
  102. reverse_copy(vchTmp.begin(), vchTmp.end(), vchRet.end() - vchTmp.size());
  103. return true;
  104. }
  105. // Decode a base58-encoded string str into byte vector vchRet
  106. // returns true if decoding is successful
  107. inline bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet)
  108. {
  109. return DecodeBase58(str.c_str(), vchRet);
  110. }
  111. // Encode a byte vector to a base58-encoded string, including checksum
  112. inline std::string EncodeBase58Check(const std::vector<unsigned char>& vchIn)
  113. {
  114. // add 4-byte hash check to the end
  115. std::vector<unsigned char> vch(vchIn);
  116. uint256 hash = Hash(vch.begin(), vch.end());
  117. vch.insert(vch.end(), (unsigned char*)&hash, (unsigned char*)&hash + 4);
  118. return EncodeBase58(vch);
  119. }
  120. // Decode a base58-encoded string psz that includes a checksum, into byte vector vchRet
  121. // returns true if decoding is successful
  122. inline bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet)
  123. {
  124. if (!DecodeBase58(psz, vchRet))
  125. return false;
  126. if (vchRet.size() < 4)
  127. {
  128. vchRet.clear();
  129. return false;
  130. }
  131. uint256 hash = Hash(vchRet.begin(), vchRet.end()-4);
  132. if (memcmp(&hash, &vchRet.end()[-4], 4) != 0)
  133. {
  134. vchRet.clear();
  135. return false;
  136. }
  137. vchRet.resize(vchRet.size()-4);
  138. return true;
  139. }
  140. // Decode a base58-encoded string str that includes a checksum, into byte vector vchRet
  141. // returns true if decoding is successful
  142. inline bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet)
  143. {
  144. return DecodeBase58Check(str.c_str(), vchRet);
  145. }
  146. /** Base class for all base58-encoded data */
  147. class CBase58Data
  148. {
  149. protected:
  150. // the version byte(s)
  151. std::vector<unsigned char> vchVersion;
  152. // the actually encoded data
  153. typedef std::vector<unsigned char, zero_after_free_allocator<unsigned char> > vector_uchar;
  154. vector_uchar vchData;
  155. CBase58Data()
  156. {
  157. vchVersion.clear();
  158. vchData.clear();
  159. }
  160. void SetData(const std::vector<unsigned char> &vchVersionIn, const void* pdata, size_t nSize)
  161. {
  162. vchVersion = vchVersionIn;
  163. vchData.resize(nSize);
  164. if (!vchData.empty())
  165. memcpy(&vchData[0], pdata, nSize);
  166. }
  167. void SetData(const std::vector<unsigned char> &vchVersionIn, const unsigned char *pbegin, const unsigned char *pend)
  168. {
  169. SetData(vchVersionIn, (void*)pbegin, pend - pbegin);
  170. }
  171. public:
  172. bool SetString(const char* psz, unsigned int nVersionBytes = 1)
  173. {
  174. std::vector<unsigned char> vchTemp;
  175. DecodeBase58Check(psz, vchTemp);
  176. if (vchTemp.size() < nVersionBytes)
  177. {
  178. vchData.clear();
  179. vchVersion.clear();
  180. return false;
  181. }
  182. vchVersion.assign(vchTemp.begin(), vchTemp.begin() + nVersionBytes);
  183. vchData.resize(vchTemp.size() - nVersionBytes);
  184. if (!vchData.empty())
  185. memcpy(&vchData[0], &vchTemp[nVersionBytes], vchData.size());
  186. OPENSSL_cleanse(&vchTemp[0], vchData.size());
  187. return true;
  188. }
  189. bool SetString(const std::string& str)
  190. {
  191. return SetString(str.c_str());
  192. }
  193. std::string ToString() const
  194. {
  195. std::vector<unsigned char> vch = vchVersion;
  196. vch.insert(vch.end(), vchData.begin(), vchData.end());
  197. return EncodeBase58Check(vch);
  198. }
  199. int CompareTo(const CBase58Data& b58) const
  200. {
  201. if (vchVersion < b58.vchVersion) return -1;
  202. if (vchVersion > b58.vchVersion) return 1;
  203. if (vchData < b58.vchData) return -1;
  204. if (vchData > b58.vchData) return 1;
  205. return 0;
  206. }
  207. bool operator==(const CBase58Data& b58) const { return CompareTo(b58) == 0; }
  208. bool operator<=(const CBase58Data& b58) const { return CompareTo(b58) <= 0; }
  209. bool operator>=(const CBase58Data& b58) const { return CompareTo(b58) >= 0; }
  210. bool operator< (const CBase58Data& b58) const { return CompareTo(b58) < 0; }
  211. bool operator> (const CBase58Data& b58) const { return CompareTo(b58) > 0; }
  212. };
  213. /** base58-encoded Bitcoin addresses.
  214. * Public-key-hash-addresses have version 0 (or 111 testnet).
  215. * The data vector contains RIPEMD160(SHA256(pubkey)), where pubkey is the serialized public key.
  216. * Script-hash-addresses have version 5 (or 196 testnet).
  217. * The data vector contains RIPEMD160(SHA256(cscript)), where cscript is the serialized redemption script.
  218. */
  219. class CBitcoinAddress;
  220. class CBitcoinAddressVisitor : public boost::static_visitor<bool>
  221. {
  222. private:
  223. CBitcoinAddress *addr;
  224. public:
  225. CBitcoinAddressVisitor(CBitcoinAddress *addrIn) : addr(addrIn) { }
  226. bool operator()(const CKeyID &id) const;
  227. bool operator()(const CScriptID &id) const;
  228. bool operator()(const CNoDestination &no) const;
  229. };
  230. class CBitcoinAddress : public CBase58Data
  231. {
  232. public:
  233. bool Set(const CKeyID &id) {
  234. SetData(Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS), &id, 20);
  235. return true;
  236. }
  237. bool Set(const CScriptID &id) {
  238. SetData(Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS), &id, 20);
  239. return true;
  240. }
  241. bool Set(const CTxDestination &dest)
  242. {
  243. return boost::apply_visitor(CBitcoinAddressVisitor(this), dest);
  244. }
  245. bool IsValid() const
  246. {
  247. bool fCorrectSize = vchData.size() == 20;
  248. bool fKnownVersion = vchVersion == Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS) ||
  249. vchVersion == Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS);
  250. return fCorrectSize && fKnownVersion;
  251. }
  252. CBitcoinAddress()
  253. {
  254. }
  255. CBitcoinAddress(const CTxDestination &dest)
  256. {
  257. Set(dest);
  258. }
  259. CBitcoinAddress(const std::string& strAddress)
  260. {
  261. SetString(strAddress);
  262. }
  263. CBitcoinAddress(const char* pszAddress)
  264. {
  265. SetString(pszAddress);
  266. }
  267. CTxDestination Get() const {
  268. if (!IsValid())
  269. return CNoDestination();
  270. uint160 id;
  271. memcpy(&id, &vchData[0], 20);
  272. if (vchVersion == Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS))
  273. return CKeyID(id);
  274. else if (vchVersion == Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS))
  275. return CScriptID(id);
  276. else
  277. return CNoDestination();
  278. }
  279. bool GetKeyID(CKeyID &keyID) const {
  280. if (!IsValid() || vchVersion != Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS))
  281. return false;
  282. uint160 id;
  283. memcpy(&id, &vchData[0], 20);
  284. keyID = CKeyID(id);
  285. return true;
  286. }
  287. bool IsScript() const {
  288. return IsValid() && vchVersion == Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS);
  289. }
  290. };
  291. bool inline CBitcoinAddressVisitor::operator()(const CKeyID &id) const { return addr->Set(id); }
  292. bool inline CBitcoinAddressVisitor::operator()(const CScriptID &id) const { return addr->Set(id); }
  293. bool inline CBitcoinAddressVisitor::operator()(const CNoDestination &id) const { return false; }
  294. /** A base58-encoded secret key */
  295. class CBitcoinSecret : public CBase58Data
  296. {
  297. public:
  298. void SetKey(const CKey& vchSecret)
  299. {
  300. assert(vchSecret.IsValid());
  301. SetData(Params().Base58Prefix(CChainParams::SECRET_KEY), vchSecret.begin(), vchSecret.size());
  302. if (vchSecret.IsCompressed())
  303. vchData.push_back(1);
  304. }
  305. CKey GetKey()
  306. {
  307. CKey ret;
  308. ret.Set(&vchData[0], &vchData[32], vchData.size() > 32 && vchData[32] == 1);
  309. return ret;
  310. }
  311. bool IsValid() const
  312. {
  313. bool fExpectedFormat = vchData.size() == 32 || (vchData.size() == 33 && vchData[32] == 1);
  314. bool fCorrectVersion = vchVersion == Params().Base58Prefix(CChainParams::SECRET_KEY);
  315. return fExpectedFormat && fCorrectVersion;
  316. }
  317. bool SetString(const char* pszSecret)
  318. {
  319. return CBase58Data::SetString(pszSecret) && IsValid();
  320. }
  321. bool SetString(const std::string& strSecret)
  322. {
  323. return SetString(strSecret.c_str());
  324. }
  325. CBitcoinSecret(const CKey& vchSecret)
  326. {
  327. SetKey(vchSecret);
  328. }
  329. CBitcoinSecret()
  330. {
  331. }
  332. };
  333. #endif // BITCOIN_BASE58_H