//------------------------------------------------------------------------------ /* This file is part of rippled: https://github.com/ripple/rippled Copyright (c) 2012, 2013 Ripple Labs Inc. Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ //============================================================================== #include #include #include #include #include #include #include #include #include #include namespace ripple { static constexpr char const* alphabetForward = "rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz"; static constexpr std::array const alphabetReverse = []() { std::array map{}; for (auto& m : map) m = -1; for (int i = 0, j = 0; alphabetForward[i] != 0; ++i) map[static_cast(alphabetForward[i])] = j++; return map; }(); template static typename Hasher::result_type digest(void const* data, std::size_t size) noexcept { Hasher h; h(data, size); return static_cast(h); } template < class Hasher, class T, std::size_t N, class = std::enable_if_t> static typename Hasher::result_type digest(std::array const& v) { return digest(v.data(), v.size()); } // Computes a double digest (e.g. digest of the digest) template static typename Hasher::result_type digest2(Args const&... args) { return digest(digest(args...)); } /** Calculate a 4-byte checksum of the data The checksum is calculated as the first 4 bytes of the SHA256 digest of the message. This is added to the base58 encoding of identifiers to detect user error in data entry. @note This checksum algorithm is part of the client API */ static void checksum(void* out, void const* message, std::size_t size) { auto const h = digest2(message, size); std::memcpy(out, h.data(), 4); } namespace detail { /* The base58 encoding & decoding routines in this namespace are taken from * Bitcoin but have been modified from the original. * * Copyright (c) 2014 The Bitcoin Core developers * Distributed under the MIT software license, see the accompanying * file COPYING or http://www.opensource.org/licenses/mit-license.php. */ static std::string encodeBase58( void const* message, std::size_t size, void* temp, std::size_t temp_size) { auto pbegin = reinterpret_cast(message); auto const pend = pbegin + size; // Skip & count leading zeroes. int zeroes = 0; while (pbegin != pend && *pbegin == 0) { pbegin++; zeroes++; } auto const b58begin = reinterpret_cast(temp); auto const b58end = b58begin + temp_size; std::fill(b58begin, b58end, 0); while (pbegin != pend) { int carry = *pbegin; // Apply "b58 = b58 * 256 + ch". for (auto iter = b58end; iter != b58begin; --iter) { carry += 256 * (iter[-1]); iter[-1] = carry % 58; carry /= 58; } assert(carry == 0); pbegin++; } // Skip leading zeroes in base58 result. auto iter = b58begin; while (iter != b58end && *iter == 0) ++iter; // Translate the result into a string. std::string str; str.reserve(zeroes + (b58end - iter)); str.assign(zeroes, alphabetForward[0]); while (iter != b58end) str += alphabetForward[*(iter++)]; return str; } static std::string decodeBase58(std::string const& s) { auto psz = reinterpret_cast(s.c_str()); auto remain = s.size(); // Skip and count leading zeroes int zeroes = 0; while (remain > 0 && alphabetReverse[*psz] == 0) { ++zeroes; ++psz; --remain; } if (remain > 64) return {}; // Allocate enough space in big-endian base256 representation. // log(58) / log(256), rounded up. std::vector b256(remain * 733 / 1000 + 1); while (remain > 0) { auto carry = alphabetReverse[*psz]; if (carry == -1) return {}; // Apply "b256 = b256 * 58 + carry". for (auto iter = b256.rbegin(); iter != b256.rend(); ++iter) { carry += 58 * *iter; *iter = carry % 256; carry /= 256; } assert(carry == 0); ++psz; --remain; } // Skip leading zeroes in b256. auto iter = std::find_if( b256.begin(), b256.end(), [](unsigned char c) { return c != 0; }); std::string result; result.reserve(zeroes + (b256.end() - iter)); result.assign(zeroes, 0x00); while (iter != b256.end()) result.push_back(*(iter++)); return result; } } // namespace detail std::string encodeBase58Token(TokenType type, void const* token, std::size_t size) { // expanded token includes type + 4 byte checksum auto const expanded = 1 + size + 4; // We need expanded + expanded * (log(256) / log(58)) which is // bounded by expanded + expanded * (138 / 100 + 1) which works // out to expanded * 3: auto const bufsize = expanded * 3; boost::container::small_vector buf(bufsize); // Lay the data out as // buf[0] = safe_cast>(type); if (size) std::memcpy(buf.data() + 1, token, size); checksum(buf.data() + 1 + size, buf.data(), 1 + size); return detail::encodeBase58( buf.data(), expanded, buf.data() + expanded, bufsize - expanded); } std::string decodeBase58Token(std::string const& s, TokenType type) { std::string const ret = detail::decodeBase58(s); // Reject zero length tokens if (ret.size() < 6) return {}; // The type must match. if (type != safe_cast(static_cast(ret[0]))) return {}; // And the checksum must as well. std::array guard; checksum(guard.data(), ret.data(), ret.size() - guard.size()); if (!std::equal(guard.rbegin(), guard.rend(), ret.rbegin())) return {}; // Skip the leading type byte and the trailing checksum. return ret.substr(1, ret.size() - 1 - guard.size()); } } // namespace ripple