src/base58.cpp

   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
   7 //
   8 // Why base-58 instead of standard base-64 encoding?
   9 // - Don't want 0OIl characters that look the same in some fonts and
  10 //      could be used to create visually identical looking account numbers.
  11 // - A string with non-alphanumeric characters is not as easily accepted as an account number.
  12 // - E-mail usually won't line-break if there's no punctuation to break at.
  13 // - Double-clicking selects the whole number as one word if it's all alphanumeric.
  14 //
  15
  16 #include <string>
  17 #include <vector>
  18 #include <openssl/crypto.h> // for OPENSSL_cleanse()
  19 #include "bignum.h"
  20 #include "key.h"
  21 #include "script.h"
  22 #include "base58.h"
  23
  24 static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
  25
  26 // Encode a byte sequence as a base58-encoded string
  27 std::string EncodeBase58(const unsigned char* pbegin, const unsigned char* pend)
  28 {
  29     CAutoBN_CTX pctx;
  30     CBigNum bn58 = 58;
  31     CBigNum bn0 = 0;
  32
  33     // Convert big endian data to little endian
  34     // Extra zero at the end make sure bignum will interpret as a positive number
  35     std::vector<unsigned char> vchTmp(pend-pbegin+1, 0);
  36     reverse_copy(pbegin, pend, vchTmp.begin());
  37
  38     // Convert little endian data to bignum
  39     CBigNum bn;
  40     bn.setvch(vchTmp);
  41
  42     // Convert bignum to std::string
  43     std::string str;
  44     // Expected size increase from base58 conversion is approximately 137%
  45     // use 138% to be safe
  46     str.reserve((pend - pbegin) * 138 / 100 + 1);
  47     CBigNum dv;
  48     CBigNum rem;
  49     while (bn > bn0)
  50     {
  51         if (!BN_div(&dv, &rem, &bn, &bn58, pctx))
  52             throw bignum_error("EncodeBase58 : BN_div failed");
  53         bn = dv;
  54         unsigned int c = rem.getuint32();
  55         str += pszBase58[c];
  56     }
  57
  58     // Leading zeroes encoded as base58 zeros
  59     for (const unsigned char* p = pbegin; p < pend && *p == 0; p++)
  60         str += pszBase58[0];
  61
  62     // Convert little endian std::string to big endian
  63     reverse(str.begin(), str.end());
  64     return str;
  65 }
  66
  67 // Encode a byte vector as a base58-encoded string
  68 std::string EncodeBase58(const std::vector<unsigned char>& vch)
  69 {
  70     return EncodeBase58(&vch[0], &vch[0] + vch.size());
  71 }
  72
  73 // Decode a base58-encoded string psz into byte vector vchRet
  74 // returns true if decoding is successful
  75 bool DecodeBase58(const char* psz, std::vector<unsigned char>& vchRet)
  76 {
  77     CAutoBN_CTX pctx;
  78     vchRet.clear();
  79     CBigNum bn58 = 58;
  80     CBigNum bn = 0;
  81     CBigNum bnChar;
  82     while (isspace(*psz))
  83         psz++;
  84
  85     // Convert big endian string to bignum
  86     for (const char* p = psz; *p; p++)
  87     {
  88         const char* p1 = strchr(pszBase58, *p);
  89         if (p1 == NULL)
  90         {
  91             while (isspace(*p))
  92                 p++;
  93             if (*p != '\0')
  94                 return false;
  95             break;
  96         }
  97         bnChar.setuint32((uint32_t)(p1 - pszBase58));
  98         if (!BN_mul(&bn, &bn, &bn58, pctx))
  99             throw bignum_error("DecodeBase58 : BN_mul failed");
 100         bn += bnChar;
 101     }
 102
 103     // Get bignum as little endian data
 104     std::vector<unsigned char> vchTmp = bn.getvch();
 105
 106     // Trim off sign byte if present
 107     if (vchTmp.size() >= 2 && vchTmp.end()[-1] == 0 && vchTmp.end()[-2] >= 0x80)
 108         vchTmp.erase(vchTmp.end()-1);
 109
 110     // Restore leading zeros
 111     int nLeadingZeros = 0;
 112     for (const char* p = psz; *p == pszBase58[0]; p++)
 113         nLeadingZeros++;
 114     vchRet.assign(nLeadingZeros + vchTmp.size(), 0);
 115
 116     // Convert little endian data to big endian
 117     reverse_copy(vchTmp.begin(), vchTmp.end(), vchRet.end() - vchTmp.size());
 118     return true;
 119 }
 120
 121 // Decode a base58-encoded string str into byte vector vchRet
 122 // returns true if decoding is successful
 123 bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet)
 124 {
 125     return DecodeBase58(str.c_str(), vchRet);
 126 }
 127
 128 // Encode a byte vector to a base58-encoded string, including checksum
 129 std::string EncodeBase58Check(const std::vector<unsigned char>& vchIn)
 130 {
 131     // add 4-byte hash check to the end
 132     std::vector<unsigned char> vch(vchIn);
 133     uint256 hash = Hash(vch.begin(), vch.end());
 134     vch.insert(vch.end(), (unsigned char*)&hash, (unsigned char*)&hash + 4);
 135     return EncodeBase58(vch);
 136 }
 137
 138 // Decode a base58-encoded string psz that includes a checksum, into byte vector vchRet
 139 // returns true if decoding is successful
 140 bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet)
 141 {
 142     if (!DecodeBase58(psz, vchRet))
 143         return false;
 144     if (vchRet.size() < 4)
 145     {
 146         vchRet.clear();
 147         return false;
 148     }
 149     uint256 hash = Hash(vchRet.begin(), vchRet.end()-4);
 150     if (memcmp(&hash, &vchRet.end()[-4], 4) != 0)
 151     {
 152         vchRet.clear();
 153         return false;
 154     }
 155     vchRet.resize(vchRet.size()-4);
 156     return true;
 157 }
 158
 159 // Decode a base58-encoded string str that includes a checksum, into byte vector vchRet
 160 // returns true if decoding is successful
 161 bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet)
 162 {
 163     return DecodeBase58Check(str.c_str(), vchRet);
 164 }
 165
 166     CBase58Data::CBase58Data()
 167     {
 168         nVersion = 0;
 169         vchData.clear();
 170     }
 171
 172     CBase58Data::~CBase58Data()
 173     {
 174         // zero the memory, as it may contain sensitive data
 175         if (!vchData.empty())
 176             OPENSSL_cleanse(&vchData[0], vchData.size());
 177     }
 178
 179     void CBase58Data::SetData(int nVersionIn, const void* pdata, size_t nSize)
 180     {
 181         nVersion = nVersionIn;
 182         vchData.resize(nSize);
 183         if (!vchData.empty())
 184             memcpy(&vchData[0], pdata, nSize);
 185     }
 186
 187     const std::vector<unsigned char> &CBase58Data::GetData() const
 188     {
 189         return vchData;
 190     }
 191
 192     void CBase58Data::SetData(int nVersionIn, const unsigned char *pbegin, const unsigned char *pend)
 193     {
 194         SetData(nVersionIn, (void*)pbegin, pend - pbegin);
 195     }
 196
 197     bool CBase58Data::SetString(const char* psz)
 198     {
 199         std::vector<unsigned char> vchTemp;
 200         DecodeBase58Check(psz, vchTemp);
 201         if (vchTemp.empty())
 202         {
 203             vchData.clear();
 204             nVersion = 0;
 205             return false;
 206         }
 207         nVersion = vchTemp[0];
 208         vchData.resize(vchTemp.size() - 1);
 209         if (!vchData.empty())
 210             memcpy(&vchData[0], &vchTemp[1], vchData.size());
 211         OPENSSL_cleanse(&vchTemp[0], vchData.size());
 212         return true;
 213     }
 214
 215     bool CBase58Data::SetString(const std::string& str)
 216     {
 217         return SetString(str.c_str());
 218     }
 219
 220     std::string CBase58Data::ToString() const
 221     {
 222         std::vector<unsigned char> vch(1, nVersion);
 223         vch.insert(vch.end(), vchData.begin(), vchData.end());
 224         return EncodeBase58Check(vch);
 225     }
 226
 227     int CBase58Data::CompareTo(const CBase58Data& b58) const
 228     {
 229         if (nVersion < b58.nVersion) return -1;
 230         if (nVersion > b58.nVersion) return  1;
 231         if (vchData < b58.vchData)   return -1;
 232         if (vchData > b58.vchData)   return  1;
 233         return 0;
 234     }
 235
 236     bool CBitcoinAddress::Set(const CKeyID &id) {
 237         SetData(fTestNet ? PUBKEY_ADDRESS_TEST : PUBKEY_ADDRESS, &id, 20);
 238         return true;
 239     }
 240
 241     bool CBitcoinAddress::Set(const CScriptID &id) {
 242         SetData(fTestNet ? SCRIPT_ADDRESS_TEST : SCRIPT_ADDRESS, &id, 20);
 243         return true;
 244     }
 245
 246     bool CBitcoinAddress::Set(const CTxDestination &dest)
 247     {
 248         return boost::apply_visitor(CBitcoinAddressVisitor(this), dest);
 249     }
 250
 251     bool CBitcoinAddress::Set(const CMalleablePubKey &mpk) {
 252         std::vector<unsigned char> vchPubkeyPair = mpk.Raw();
 253         SetData(fTestNet ? PUBKEY_PAIR_ADDRESS_TEST : PUBKEY_PAIR_ADDRESS, &vchPubkeyPair[0], 68);
 254         return true;
 255     }
 256
 257     bool CBitcoinAddress::IsValid() const
 258     {
 259         unsigned int nExpectedSize = 20;
 260         bool fExpectTestNet = false;
 261         bool fSimple = true;
 262         switch(nVersion)
 263         {
 264             case PUBKEY_PAIR_ADDRESS:
 265                 nExpectedSize = 68; // Serialized pair of public keys
 266                 fExpectTestNet = false;
 267                 fSimple = false;
 268                 break;
 269             case PUBKEY_ADDRESS:
 270                 nExpectedSize = 20; // Hash of public key
 271                 fExpectTestNet = false;
 272                 break;
 273             case SCRIPT_ADDRESS:
 274                 nExpectedSize = 20; // Hash of CScript
 275                 fExpectTestNet = false;
 276                 break;
 277
 278             case PUBKEY_PAIR_ADDRESS_TEST:
 279                 nExpectedSize = 68;
 280                 fExpectTestNet = true;
 281                 fSimple = false;
 282                 break;
 283             case PUBKEY_ADDRESS_TEST:
 284                 nExpectedSize = 20;
 285                 fExpectTestNet = true;
 286                 break;
 287             case SCRIPT_ADDRESS_TEST:
 288                 nExpectedSize = 20;
 289                 fExpectTestNet = true;
 290                 break;
 291
 292             default:
 293                 return false;
 294         }
 295
 296         // Basic format sanity check
 297         bool fSeemsSane = (fExpectTestNet == fTestNet && vchData.size() == nExpectedSize);
 298
 299         if (fSeemsSane && !fSimple)
 300         {
 301             // Perform dditional checking
 302             //    for pubkey pair addresses
 303             CMalleablePubKey mpk;
 304             mpk.setvch(vchData);
 305             return mpk.IsValid();
 306         }
 307         else
 308             return fSeemsSane;
 309     }
 310
 311     CTxDestination CBitcoinAddress::Get() const {
 312         if (!IsValid())
 313             return CNoDestination();
 314         switch (nVersion) {
 315         case PUBKEY_ADDRESS:
 316         case PUBKEY_ADDRESS_TEST: {
 317             uint160 id;
 318             memcpy(&id, &vchData[0], 20);
 319             return CKeyID(id);
 320         }
 321         case SCRIPT_ADDRESS:
 322         case SCRIPT_ADDRESS_TEST: {
 323             uint160 id;
 324             memcpy(&id, &vchData[0], 20);
 325             return CScriptID(id);
 326         }
 327         }
 328         return CNoDestination();
 329     }
 330
 331     bool CBitcoinAddress::GetKeyID(CKeyID &keyID) const {
 332         if (!IsValid())
 333             return false;
 334         switch (nVersion) {
 335         case PUBKEY_ADDRESS:
 336         case PUBKEY_ADDRESS_TEST: {
 337             uint160 id;
 338             memcpy(&id, &vchData[0], 20);
 339             keyID = CKeyID(id);
 340             return true;
 341         }
 342         case PUBKEY_PAIR_ADDRESS:
 343         case PUBKEY_PAIR_ADDRESS_TEST:
 344         {
 345             CMalleablePubKey mPubKey;
 346             mPubKey.setvch(vchData);
 347             keyID = mPubKey.GetID();
 348         }
 349         default: return false;
 350         }
 351     }
 352
 353     bool CBitcoinAddress::IsScript() const {
 354         if (!IsValid())
 355             return false;
 356         switch (nVersion) {
 357         case SCRIPT_ADDRESS:
 358         case SCRIPT_ADDRESS_TEST: {
 359             return true;
 360         }
 361         default: return false;
 362         }
 363     }
 364
 365     bool CBitcoinAddress::IsPubKey() const {
 366         if (!IsValid())
 367             return false;
 368         switch (nVersion) {
 369         case PUBKEY_ADDRESS:
 370         case PUBKEY_ADDRESS_TEST: {
 371             return true;
 372         }
 373         default: return false;
 374         }
 375     }
 376
 377     bool CBitcoinAddress::IsPair() const {
 378         if (!IsValid())
 379             return false;
 380         switch (nVersion) {
 381         case PUBKEY_PAIR_ADDRESS:
 382         case PUBKEY_PAIR_ADDRESS_TEST: {
 383             return true;
 384         }
 385         default: return false;
 386         }
 387     }
 388
 389     void CBitcoinSecret::SetSecret(const CSecret& vchSecret, bool fCompressed)
 390     {
 391         assert(vchSecret.size() == 32);
 392         SetData(128 + (fTestNet ? CBitcoinAddress::PUBKEY_ADDRESS_TEST : CBitcoinAddress::PUBKEY_ADDRESS), &vchSecret[0], vchSecret.size());
 393         if (fCompressed)
 394             vchData.push_back(1);
 395     }
 396
 397     CSecret CBitcoinSecret::GetSecret(bool &fCompressedOut)
 398     {
 399         CSecret vchSecret;
 400         vchSecret.resize(32);
 401         memcpy(&vchSecret[0], &vchData[0], 32);
 402         fCompressedOut = vchData.size() == 33;
 403         return vchSecret;
 404     }
 405
 406     bool CBitcoinSecret::IsValid() const
 407     {
 408         bool fExpectTestNet = false;
 409         switch(nVersion)
 410         {
 411             case (128 + CBitcoinAddress::PUBKEY_ADDRESS):
 412                 break;
 413
 414             case (128 + CBitcoinAddress::PUBKEY_ADDRESS_TEST):
 415                 fExpectTestNet = true;
 416                 break;
 417
 418             default:
 419                 return false;
 420         }
 421         return fExpectTestNet == fTestNet && (vchData.size() == 32 || (vchData.size() == 33 && vchData[32] == 1));
 422     }
 423
 424     bool CBitcoinSecret::SetString(const char* pszSecret)
 425     {
 426         return CBase58Data::SetString(pszSecret) && IsValid();
 427     }
 428
 429     bool CBitcoinSecret::SetString(const std::string& strSecret)
 430     {
 431         return SetString(strSecret.c_str());
 432     }
 433
 434     CBitcoinSecret::CBitcoinSecret(const CSecret& vchSecret, bool fCompressed)
 435     {
 436         SetSecret(vchSecret, fCompressed);
 437     }
 438
 439