1  // Copyright (c) 2011-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 <test/data/base58_encode_decode.json.h>
  6  
  7  #include <base58.h>
  8  #include <test/util/json.h>
  9  #include <test/util/random.h>
 10  #include <test/util/setup_common.h>
 11  #include <util/strencodings.h>
 12  #include <util/vector.h>
 13  
 14  #include <univalue.h>
 15  
 16  #include <boost/test/unit_test.hpp>
 17  #include <string>
 18  
 19  using namespace std::literals;
 20  
 21  BOOST_FIXTURE_TEST_SUITE(base58_tests, BasicTestingSetup)
 22  
 23  // Goal: test low-level base58 encoding functionality
 24  BOOST_AUTO_TEST_CASE(base58_EncodeBase58)
 25  {
 26      UniValue tests = read_json(json_tests::base58_encode_decode);
 27      for (unsigned int idx = 0; idx < tests.size(); idx++) {
 28          const UniValue& test = tests[idx];
 29          std::string strTest = test.write();
 30          if (test.size() < 2) // Allow for extra stuff (useful for comments)
 31          {
 32              BOOST_ERROR("Bad test: " << strTest);
 33              continue;
 34          }
 35          std::vector<unsigned char> sourcedata = ParseHex(test[0].get_str());
 36          std::string base58string = test[1].get_str();
 37          BOOST_CHECK_MESSAGE(
 38                      EncodeBase58(sourcedata) == base58string,
 39                      strTest);
 40      }
 41  }
 42  
 43  // Goal: test low-level base58 decoding functionality
 44  BOOST_AUTO_TEST_CASE(base58_DecodeBase58)
 45  {
 46      UniValue tests = read_json(json_tests::base58_encode_decode);
 47      std::vector<unsigned char> result;
 48  
 49      for (unsigned int idx = 0; idx < tests.size(); idx++) {
 50          const UniValue& test = tests[idx];
 51          std::string strTest = test.write();
 52          if (test.size() < 2) // Allow for extra stuff (useful for comments)
 53          {
 54              BOOST_ERROR("Bad test: " << strTest);
 55              continue;
 56          }
 57          std::vector<unsigned char> expected = ParseHex(test[0].get_str());
 58          std::string base58string = test[1].get_str();
 59          BOOST_CHECK_MESSAGE(DecodeBase58(base58string, result, 256), strTest);
 60          BOOST_CHECK_MESSAGE(result.size() == expected.size() && std::equal(result.begin(), result.end(), expected.begin()), strTest);
 61      }
 62  
 63      BOOST_CHECK(!DecodeBase58("invalid"s, result, 100));
 64      BOOST_CHECK(!DecodeBase58("invalid\0"s, result, 100));
 65      BOOST_CHECK(!DecodeBase58("\0invalid"s, result, 100));
 66  
 67      BOOST_CHECK(DecodeBase58("good"s, result, 100));
 68      BOOST_CHECK(!DecodeBase58("bad0IOl"s, result, 100));
 69      BOOST_CHECK(!DecodeBase58("goodbad0IOl"s, result, 100));
 70      BOOST_CHECK(!DecodeBase58("good\0bad0IOl"s, result, 100));
 71  
 72      // check that DecodeBase58 skips whitespace, but still fails with unexpected non-whitespace at the end.
 73      BOOST_CHECK(!DecodeBase58(" \t\n\v\f\r skip \r\f\v\n\t a", result, 3));
 74      BOOST_CHECK( DecodeBase58(" \t\n\v\f\r skip \r\f\v\n\t ", result, 3));
 75      std::vector<unsigned char> expected = ParseHex("971a55");
 76      BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
 77  
 78      BOOST_CHECK(DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oh"s, result, 100));
 79      BOOST_CHECK(!DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oi"s, result, 100));
 80      BOOST_CHECK(!DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oh0IOl"s, result, 100));
 81      BOOST_CHECK(!DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oh\0" "0IOl"s, result, 100));
 82  }
 83  
 84  BOOST_AUTO_TEST_CASE(base58_random_encode_decode)
 85  {
 86      for (int n = 0; n < 1000; ++n) {
 87          unsigned int len = 1 + InsecureRandBits(8);
 88          unsigned int zeroes = InsecureRandBool() ? InsecureRandRange(len + 1) : 0;
 89          auto data = Cat(std::vector<unsigned char>(zeroes, '\000'), g_insecure_rand_ctx.randbytes(len - zeroes));
 90          auto encoded = EncodeBase58Check(data);
 91          std::vector<unsigned char> decoded;
 92          auto ok_too_small = DecodeBase58Check(encoded, decoded, InsecureRandRange(len));
 93          BOOST_CHECK(!ok_too_small);
 94          auto ok = DecodeBase58Check(encoded, decoded, len + InsecureRandRange(257 - len));
 95          BOOST_CHECK(ok);
 96          BOOST_CHECK(data == decoded);
 97      }
 98  }
 99  
100  BOOST_AUTO_TEST_SUITE_END()