src/base58.cpp

   1 // Copyright (c) 2014 The Bitcoin Core developers
   2 // Distributed under the MIT software license, see the accompanying
   3 // file COPYING or https://www.opensource.org/licenses/mit-license.php .
   4
   5 #include "base58.h"
   6
   7 #include <hash.h>
   8 #include <uint256.h>
   9
  10 #include "pbaas/identity.h"
  11
  12 #include <assert.h>
  13 #include <string.h>
  14 #include <stdint.h>
  15 #include <vector>
  16 #include <string>
  17 #include <boost/variant/apply_visitor.hpp>
  18 #include <boost/variant/static_visitor.hpp>
  19
  20 /** All alphanumeric characters except for "0", "I", "O", and "l" */
  21 static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
  22 extern uint160 VERUS_CHAINID;
  23
  24 bool DecodeBase58(const char* psz, std::vector<unsigned char>& vch)
  25 {
  26     // Skip leading spaces.
  27     while (*psz && isspace(*psz))
  28         psz++;
  29     // Skip and count leading '1's.
  30     int zeroes = 0;
  31     while (*psz == '1') {
  32         zeroes++;
  33         psz++;
  34     }
  35     // Allocate enough space in big-endian base256 representation.
  36     std::vector<unsigned char> b256(strlen(psz) * 733 / 1000 + 1); // log(58) / log(256), rounded up.
  37     // Process the characters.
  38     while (*psz && !isspace(*psz)) {
  39         // Decode base58 character
  40         const char* ch = strchr(pszBase58, *psz);
  41         if (ch == NULL)
  42             return false;
  43         // Apply "b256 = b256 * 58 + ch".
  44         int carry = ch - pszBase58;
  45         for (std::vector<unsigned char>::reverse_iterator it = b256.rbegin(); it != b256.rend(); it++) {
  46             carry += 58 * (*it);
  47             *it = carry % 256;
  48             carry /= 256;
  49         }
  50         assert(carry == 0);
  51         psz++;
  52     }
  53     // Skip trailing spaces.
  54     while (isspace(*psz))
  55         psz++;
  56     if (*psz != 0)
  57         return false;
  58     // Skip leading zeroes in b256.
  59     std::vector<unsigned char>::iterator it = b256.begin();
  60     while (it != b256.end() && *it == 0)
  61         it++;
  62     // Copy result into output vector.
  63     vch.reserve(zeroes + (b256.end() - it));
  64     vch.assign(zeroes, 0x00);
  65     while (it != b256.end())
  66         vch.push_back(*(it++));
  67     return true;
  68 }
  69
  70 std::string EncodeBase58(const unsigned char* pbegin, const unsigned char* pend)
  71 {
  72     // Skip & count leading zeroes.
  73     int zeroes = 0;
  74     while (pbegin != pend && *pbegin == 0) {
  75         pbegin++;
  76         zeroes++;
  77     }
  78     // Allocate enough space in big-endian base58 representation.
  79     std::vector<unsigned char> b58((pend - pbegin) * 138 / 100 + 1); // log(256) / log(58), rounded up.
  80     // Process the bytes.
  81     while (pbegin != pend) {
  82         int carry = *pbegin;
  83         // Apply "b58 = b58 * 256 + ch".
  84         for (std::vector<unsigned char>::reverse_iterator it = b58.rbegin(); it != b58.rend(); it++) {
  85             carry += 256 * (*it);
  86             *it = carry % 58;
  87             carry /= 58;
  88         }
  89         assert(carry == 0);
  90         pbegin++;
  91     }
  92     // Skip leading zeroes in base58 result.
  93     std::vector<unsigned char>::iterator it = b58.begin();
  94     while (it != b58.end() && *it == 0)
  95         it++;
  96     // Translate the result into a string.
  97     std::string str;
  98     str.reserve(zeroes + (b58.end() - it));
  99     str.assign(zeroes, '1');
 100     while (it != b58.end())
 101         str += pszBase58[*(it++)];
 102     return str;
 103 }
 104
 105 std::string EncodeBase58(const std::vector<unsigned char>& vch)
 106 {
 107     return EncodeBase58(vch.data(), vch.data() + vch.size());
 108 }
 109
 110 bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet)
 111 {
 112     return DecodeBase58(str.c_str(), vchRet);
 113 }
 114
 115 std::string EncodeBase58Check(const std::vector<unsigned char>& vchIn)
 116 {
 117     // add 4-byte hash check to the end
 118     std::vector<unsigned char> vch(vchIn);
 119     uint256 hash = Hash(vch.begin(), vch.end());
 120     vch.insert(vch.end(), (unsigned char*)&hash, (unsigned char*)&hash + 4);
 121     return EncodeBase58(vch);
 122 }
 123
 124 bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet)
 125 {
 126     if (!DecodeBase58(psz, vchRet) ||
 127         (vchRet.size() < 4)) {
 128         vchRet.clear();
 129         return false;
 130     }
 131     // re-calculate the checksum, insure it matches the included 4-byte checksum
 132     uint256 hash = Hash(vchRet.begin(), vchRet.end() - 4);
 133     if (memcmp(&hash, &vchRet.end()[-4], 4) != 0) {
 134         vchRet.clear();
 135         return false;
 136     }
 137     vchRet.resize(vchRet.size() - 4);
 138     return true;
 139 }
 140
 141 bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet)
 142 {
 143     return DecodeBase58Check(str.c_str(), vchRet);
 144 }
 145
 146
 147 CBase58Data::CBase58Data()
 148 {
 149     vchVersion.clear();
 150     vchData.clear();
 151 }
 152
 153 void CBase58Data::SetData(const std::vector<unsigned char>& vchVersionIn, const void* pdata, size_t nSize)
 154 {
 155     vchVersion = vchVersionIn;
 156     vchData.resize(nSize);
 157     if (!vchData.empty())
 158         memcpy(&vchData[0], pdata, nSize);
 159 }
 160
 161 void CBase58Data::SetData(const std::vector<unsigned char>& vchVersionIn, const unsigned char* pbegin, const unsigned char* pend)
 162 {
 163     SetData(vchVersionIn, (void*)pbegin, pend - pbegin);
 164 }
 165
 166 bool CBase58Data::SetString(const char* psz, unsigned int nVersionBytes)
 167 {
 168     std::vector<unsigned char> vchTemp;
 169     bool rc58 = DecodeBase58Check(psz, vchTemp);
 170     if ((!rc58) || (vchTemp.size() < nVersionBytes)) {
 171         vchData.clear();
 172         vchVersion.clear();
 173         return false;
 174     }
 175     vchVersion.assign(vchTemp.begin(), vchTemp.begin() + nVersionBytes);
 176     vchData.resize(vchTemp.size() - nVersionBytes);
 177     if (!vchData.empty())
 178         memcpy(&vchData[0], &vchTemp[nVersionBytes], vchData.size());
 179     memory_cleanse(&vchTemp[0], vchData.size());
 180     return true;
 181 }
 182
 183 bool CBase58Data::SetString(const std::string& str, unsigned int nVersionBytes)
 184 {
 185     return SetString(str.c_str(), nVersionBytes);
 186 }
 187
 188 std::string CBase58Data::ToString() const
 189 {
 190     std::vector<unsigned char> vch = vchVersion;
 191     vch.insert(vch.end(), vchData.begin(), vchData.end());
 192     return EncodeBase58Check(vch);
 193 }
 194
 195 int CBase58Data::CompareTo(const CBase58Data& b58) const
 196 {
 197     if (vchVersion < b58.vchVersion)
 198         return -1;
 199     if (vchVersion > b58.vchVersion)
 200         return 1;
 201     if (vchData < b58.vchData)
 202         return -1;
 203     if (vchData > b58.vchData)
 204         return 1;
 205     return 0;
 206 }
 207
 208 namespace
 209 {
 210 class CBitcoinAddressVisitor : public boost::static_visitor<bool>
 211 {
 212 private:
 213     CBitcoinAddress* addr;
 214
 215 public:
 216     CBitcoinAddressVisitor(CBitcoinAddress* addrIn) : addr(addrIn) {}
 217
 218     bool operator()(const CKeyID& id) const { return addr->Set(id); }
 219     bool operator()(const CPubKey& key) const { return addr->Set(key); }
 220     bool operator()(const CScriptID& id) const { return addr->Set(id); }
 221     bool operator()(const CIdentityID& id) const { return addr->Set(id); }
 222     bool operator()(const CIndexID& idx) const { return addr->Set(idx); }
 223     bool operator()(const CQuantumID& id) const { return addr->Set(id); }
 224     bool operator()(const CNoDestination& no) const { return false; }
 225 };
 226
 227 } // anon namespace
 228
 229 bool CBitcoinAddress::Set(const CKeyID& id)
 230 {
 231     SetData(Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS), &id, 20);
 232     return true;
 233 }
 234
 235 bool CBitcoinAddress::Set(const CPubKey& key)
 236 {
 237     CKeyID id = key.GetID();
 238     SetData(Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS), &id, 20);
 239     return true;
 240 }
 241
 242 bool CBitcoinAddress::Set(const CScriptID& id)
 243 {
 244     SetData(Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS), &id, 20);
 245     return true;
 246 }
 247
 248 bool CBitcoinAddress::Set(const CIdentityID& id)
 249 {
 250     SetData(Params().Base58Prefix(CChainParams::IDENTITY_ADDRESS), &id, 20);
 251     return true;
 252 }
 253
 254 bool CBitcoinAddress::Set(const CIndexID& id)
 255 {
 256     SetData(Params().Base58Prefix(CChainParams::INDEX_ADDRESS), &id, 20);
 257     return true;
 258 }
 259
 260 bool CBitcoinAddress::Set(const CQuantumID& id)
 261 {
 262     SetData(Params().Base58Prefix(CChainParams::QUANTUM_ADDRESS), &id, 20);
 263     return true;
 264 }
 265
 266 bool CBitcoinAddress::Set(const CTxDestination& dest)
 267 {
 268     return boost::apply_visitor(CBitcoinAddressVisitor(this), dest);
 269 }
 270
 271 bool CBitcoinAddress::IsValid() const
 272 {
 273     return IsValid(Params());
 274 }
 275
 276 bool CBitcoinAddress::IsValid(const CChainParams& params) const
 277 {
 278     bool fCorrectSize = vchData.size() == 20;
 279     bool fKnownVersion = vchVersion == params.Base58Prefix(CChainParams::PUBKEY_ADDRESS) ||
 280                          vchVersion == params.Base58Prefix(CChainParams::SCRIPT_ADDRESS) ||
 281                          vchVersion == params.Base58Prefix(CChainParams::IDENTITY_ADDRESS) ||
 282                          vchVersion == params.Base58Prefix(CChainParams::INDEX_ADDRESS) ||
 283                          vchVersion == params.Base58Prefix(CChainParams::QUANTUM_ADDRESS);
 284     return fCorrectSize && fKnownVersion;
 285 }
 286
 287 bool CBitcoinAddress::SetString(const char* pszAddress)
 288 {
 289
 290     if (std::count(pszAddress, pszAddress + strlen(pszAddress), '@') == 1)
 291     {
 292         if (std::count(pszAddress, pszAddress + strlen(pszAddress), '.') == 0)
 293         {
 294             return Set(CIdentity::GetID(std::string(pszAddress), VERUS_CHAINID));
 295         }
 296         else
 297         {
 298             uint160 parent;
 299             return Set(CIdentity::GetID(std::string(pszAddress), parent));
 300         }
 301     }
 302     else
 303     {
 304         return CBase58Data::SetString(pszAddress, 1);//2);
 305     }
 306 }
 307
 308 bool CBitcoinAddress::SetString(const std::string& strAddress)
 309 {
 310     return SetString(strAddress.c_str());
 311 }
 312
 313 CTxDestination CBitcoinAddress::Get() const
 314 {
 315     if (!IsValid())
 316         return CNoDestination();
 317     uint160 id;
 318     memcpy(&id, &vchData[0], 20);
 319     if (vchVersion == Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS))
 320         return CKeyID(id);
 321     else if (vchVersion == Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS))
 322         return CScriptID(id);
 323     else if (vchVersion == Params().Base58Prefix(CChainParams::IDENTITY_ADDRESS))
 324         return CIdentityID(id);
 325     else if (vchVersion == Params().Base58Prefix(CChainParams::INDEX_ADDRESS))
 326         return CIndexID(id);
 327     else if (vchVersion == Params().Base58Prefix(CChainParams::QUANTUM_ADDRESS))
 328         return CQuantumID(id);
 329     else
 330         return CNoDestination();
 331 }
 332
 333 bool CBitcoinAddress::GetIndexKey(uint160& hashBytes, int& type) const
 334 {
 335     if (!IsValid()) {
 336         return false;
 337     } else if (vchVersion == Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS)) {
 338         memcpy(&hashBytes, &vchData[0], 20);
 339         type = CScript::P2PKH;
 340         return true;
 341     } else if (vchVersion == Params().Base58Prefix(CChainParams::IDENTITY_ADDRESS)) {
 342         memcpy(&hashBytes, &vchData[0], 20);
 343         type = CScript::P2ID;
 344         return true;
 345     } else if (vchVersion == Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS)) {
 346         memcpy(&hashBytes, &vchData[0], 20);
 347         type = CScript::P2SH;
 348         return true;
 349     } else if (vchVersion == Params().Base58Prefix(CChainParams::INDEX_ADDRESS)) {
 350         memcpy(&hashBytes, &vchData[0], 20);
 351         type = CScript::P2IDX;
 352         return true;
 353     } else if (vchVersion == Params().Base58Prefix(CChainParams::QUANTUM_ADDRESS)) {
 354         memcpy(&hashBytes, &vchData[0], 20);
 355         type = CScript::P2QRK;
 356         return true;
 357     }
 358
 359     return false;
 360 }
 361
 362 bool CBitcoinAddress::GetKeyID(CKeyID& keyID) const
 363 {
 364     if (!IsValid() || vchVersion != Params().Base58Prefix(CChainParams::PUBKEY_ADDRESS))
 365         return false;
 366     uint160 id;
 367     memcpy(&id, &vchData[0], 20);
 368     keyID = CKeyID(id);
 369     return true;
 370 }
 371
 372 bool CBitcoinAddress::GetKeyID_NoCheck(CKeyID& keyID) const
 373 {
 374     uint160 id;
 375     memcpy(&id, &vchData[0], 20);
 376     keyID = CKeyID(id);
 377     return true;
 378 }
 379
 380 bool CBitcoinAddress::GetIdentityID(CIdentityID& idID) const
 381 {
 382     if (!IsValid() || vchVersion != Params().Base58Prefix(CChainParams::IDENTITY_ADDRESS))
 383         return false;
 384     uint160 id;
 385     memcpy(&id, &vchData[0], 20);
 386     idID = CIdentityID(id);
 387     return true;
 388 }
 389
 390 bool CBitcoinAddress::IsScript() const
 391 {
 392     return IsValid() && vchVersion == Params().Base58Prefix(CChainParams::SCRIPT_ADDRESS);
 393 }
 394
 395 bool CBitcoinAddress::IsIdentity() const
 396 {
 397     return IsValid() && vchVersion == Params().Base58Prefix(CChainParams::IDENTITY_ADDRESS);
 398 }
 399
 400 void CBitcoinSecret::SetKey(const CKey& vchSecret)
 401 {
 402     assert(vchSecret.IsValid());
 403     SetData(Params().Base58Prefix(CChainParams::SECRET_KEY), vchSecret.begin(), vchSecret.size());
 404     if (vchSecret.IsCompressed())
 405         vchData.push_back(1);
 406 }
 407
 408 CKey CBitcoinSecret::GetKey()
 409 {
 410     CKey ret;
 411     assert(vchData.size() >= 32);
 412     ret.Set(vchData.begin(), vchData.begin() + 32, vchData.size() > 32 && vchData[32] == 1);
 413     return ret;
 414 }
 415
 416 bool CBitcoinSecret::IsValid() const
 417 {
 418     bool fExpectedFormat = vchData.size() == 32 || (vchData.size() == 33 && vchData[32] == 1);
 419     bool fCorrectVersion = vchVersion == Params().Base58Prefix(CChainParams::SECRET_KEY);
 420     return fExpectedFormat && fCorrectVersion;
 421 }
 422
 423 bool CBitcoinSecret::SetString(const char* pszSecret)
 424 {
 425     return CBase58Data::SetString(pszSecret, 1) && IsValid();
 426 }
 427
 428 bool CBitcoinSecret::SetString(const std::string& strSecret)
 429 {
 430     return SetString(strSecret.c_str());
 431 }
 432
 433 template<class DATA_TYPE, CChainParams::Base58Type PREFIX, size_t SER_SIZE>
 434 bool CZCEncoding<DATA_TYPE, PREFIX, SER_SIZE>::Set(const DATA_TYPE& addr)
 435 {
 436     CDataStream ss(SER_NETWORK, PROTOCOL_VERSION);
 437     ss << addr;
 438     std::vector<unsigned char> addrSerialized(ss.begin(), ss.end());
 439     assert(addrSerialized.size() == SER_SIZE);
 440     SetData(Params().Base58Prefix(PREFIX), &addrSerialized[0], SER_SIZE);
 441     return true;
 442 }
 443
 444 template<class DATA_TYPE, CChainParams::Base58Type PREFIX, size_t SER_SIZE>
 445 DATA_TYPE CZCEncoding<DATA_TYPE, PREFIX, SER_SIZE>::Get() const
 446 {
 447     if (vchData.size() != SER_SIZE) {
 448         throw std::runtime_error(
 449             PrependName(" is invalid")
 450         );
 451     }
 452
 453     if (vchVersion != Params().Base58Prefix(PREFIX)) {
 454         throw std::runtime_error(
 455             PrependName(" is for wrong network type")
 456         );
 457     }
 458
 459     std::vector<unsigned char> serialized(vchData.begin(), vchData.end());
 460
 461     CDataStream ss(serialized, SER_NETWORK, PROTOCOL_VERSION);
 462     DATA_TYPE ret;
 463     ss >> ret;
 464     return ret;
 465 }