base58.cpp File Reference

#include <string>
#include <vector>
#include <limits>
#include <algorithm>
#include <fc/crypto/base58.hpp>
#include <fc/log/logger.hpp>
#include <fc/string.hpp>
#include <fc/exception/exception.hpp>
#include <stdexcept>
#include <openssl/bn.h>

Include dependency graph for base58.cpp:

Go to the source code of this file.

Classes
class	bignum_error
class	CAutoBN_CTX
class	CBigNum

Namespaces
namespace	fc
	namespace sysio::chain

Macros
#define	BITCOIN_BASE58_H

Functions
const CBigNum	operator+ (const CBigNum &a, const CBigNum &b)
const CBigNum	operator- (const CBigNum &a, const CBigNum &b)
const CBigNum	operator- (const CBigNum &a)
const CBigNum	operator* (const CBigNum &a, const CBigNum &b)
const CBigNum	operator/ (const CBigNum &a, const CBigNum &b)
const CBigNum	operator% (const CBigNum &a, const CBigNum &b)
const CBigNum	operator<< (const CBigNum &a, unsigned int shift)
const CBigNum	operator>> (const CBigNum &a, unsigned int shift)
bool	operator== (const CBigNum &a, const CBigNum &b)
bool	operator!= (const CBigNum &a, const CBigNum &b)
bool	operator<= (const CBigNum &a, const CBigNum &b)
bool	operator>= (const CBigNum &a, const CBigNum &b)
bool	operator< (const CBigNum &a, const CBigNum &b)
bool	operator> (const CBigNum &a, const CBigNum &b)
std::string	EncodeBase58 (const unsigned char *pbegin, const unsigned char *pend, const fc::yield_function_t &yield)
std::string	EncodeBase58 (const std::vector< unsigned char > &vch, const fc::yield_function_t &yield)
bool	DecodeBase58 (const char *psz, std::vector< unsigned char > &vchRet)
bool	DecodeBase58 (const std::string &str, std::vector< unsigned char > &vchRet)
std::string	fc::to_base58 (const char *d, size_t s, const fc::yield_function_t &yield)
std::string	fc::to_base58 (const std::vector< char > &data, const fc::yield_function_t &yield)
std::vector< char >	fc::from_base58 (const std::string &base58_str)
size_t	fc::from_base58 (const std::string &base58_str, char *out_data, size_t out_data_len)

Macro Definition Documentation

BITCOIN_BASE58_H

#define BITCOIN_BASE58_H

Definition at line 16 of file base58.cpp.

Function Documentation

DecodeBase58() [1/2]

bool DecodeBase58 ( const char * psz, std::vector< unsigned char > & vchRet )

inline

Definition at line 560 of file base58.cpp.

{
    CAutoBN_CTX pctx;
    vchRet.clear();
    CBigNum bn58 = 58;
    CBigNum bn = 0;
    CBigNum bnChar;
    while (isspace(*psz))
        psz++;
 
    // Convert big endian string to bignum
    for (const char* p = psz; *p; p++)
    {
        const char* p1 = strchr(pszBase58, *p);
        if (p1 == NULL)
        {
            while (isspace(*p))
                p++;
            if (*p != '\0') {
                //slog( "%s  '%c'", pszBase58,*p );
                return false;
            }
            break;
        }
        bnChar.setulong(p1 - pszBase58);
        if (!BN_mul(bn.to_bignum(), bn.to_bignum(), bn58.to_bignum(), pctx))
            throw bignum_error("DecodeBase58 : BN_mul failed");
        bn += bnChar;
    }
 
    // Get bignum as little endian data
    std::vector<unsigned char> vchTmp = bn.getvch();
 
    // Trim off sign byte if present
    if (vchTmp.size() >= 2 && vchTmp.end()[-1] == 0 && vchTmp.end()[-2] >= 0x80)
        vchTmp.erase(vchTmp.end()-1);
 
    // Restore leading zeros
    int nLeadingZeros = 0;
    for (const char* p = psz; *p == pszBase58[0]; p++)
        nLeadingZeros++;
    vchRet.assign(nLeadingZeros + vchTmp.size(), 0);
 
    // Convert little endian data to big endian
    reverse_copy(vchTmp.begin(), vchTmp.end(), vchRet.end() - vchTmp.size());
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

DecodeBase58() [2/2]

bool DecodeBase58 ( const std::string & str, std::vector< unsigned char > & vchRet )

inline

Definition at line 610 of file base58.cpp.

{
    return DecodeBase58(str.c_str(), vchRet);
}

Here is the call graph for this function:

EncodeBase58() [1/2]

std::string EncodeBase58 ( const std::vector< unsigned char > & vch, const fc::yield_function_t & yield )

inline

Definition at line 553 of file base58.cpp.

{
    return EncodeBase58(&vch[0], &vch[0] + vch.size(), yield);
}

Here is the call graph for this function:

EncodeBase58() [2/2]

std::string EncodeBase58 ( const unsigned char * pbegin, const unsigned char * pend, const fc::yield_function_t & yield )

inline

Definition at line 505 of file base58.cpp.

{
    CAutoBN_CTX pctx;
    CBigNum bn58 = 58;
    CBigNum bn0 = 0;
 
    // Convert big endian data to little endian
    // Extra zero at the end make sure bignum will interpret as a positive number
    std::vector<unsigned char> vchTmp(pend-pbegin+1, 0);
    yield();
    reverse_copy(pbegin, pend, vchTmp.begin());
    yield();
 
    // Convert little endian data to bignum
    CBigNum bn;
    bn.setvch(vchTmp);
 
    // Convert bignum to std::string
    std::string str;
    // Expected size increase from base58 conversion is approximately 137%
    // use 138% to be safe
    str.reserve((pend - pbegin) * 138 / 100 + 1);
    CBigNum dv;
    CBigNum rem;
    while (bn > bn0)
    {
        yield();
        if (!BN_div(dv.to_bignum(), rem.to_bignum(), bn.to_bignum(), bn58.to_bignum(), pctx))
            throw bignum_error("EncodeBase58 : BN_div failed");
        bn = dv;
        unsigned int c = rem.getulong();
        str += pszBase58[c];
    }
 
    // Leading zeroes encoded as base58 zeros
    for (const unsigned char* p = pbegin; p < pend && *p == 0; p++)
        str += pszBase58[0];
 
    yield();
    // Convert little endian std::string to big endian
    reverse(str.begin(), str.end());
//    slog( "Encode '%s'", str.c_str() );
    yield();
 
    return str;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool operator!= ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 495 of file base58.cpp.

{ return (BN_cmp(a.to_bignum(), b.to_bignum()) != 0); }

Here is the call graph for this function:

operator%()

const CBigNum operator% ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 470 of file base58.cpp.

{
    CAutoBN_CTX pctx;
    CBigNum r;
    if (!BN_mod(r.to_bignum(), a.to_bignum(), b.to_bignum(), pctx))
        throw bignum_error("CBigNum::operator% : BN_div failed");
    return r;
}

Here is the call graph for this function:

operator*()

const CBigNum operator* ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 452 of file base58.cpp.

{
    CAutoBN_CTX pctx;
    CBigNum r;
    if (!BN_mul(r.to_bignum(), a.to_bignum(), b.to_bignum(), pctx))
        throw bignum_error("CBigNum::operator* : BN_mul failed");
    return r;
}

Here is the call graph for this function:

operator+()

const CBigNum operator+ ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 429 of file base58.cpp.

{
    CBigNum r;
    if (!BN_add(r.to_bignum(), a.to_bignum(), b.to_bignum()))
        throw bignum_error("CBigNum::operator+ : BN_add failed");
    return r;
}

Here is the call graph for this function:

operator-() [1/2]

const CBigNum operator- ( const CBigNum & a )

inline

Definition at line 445 of file base58.cpp.

{
    CBigNum r(a);
    BN_set_negative(r.to_bignum(), !BN_is_negative(r.to_bignum()));
    return r;
}

operator-() [2/2]

const CBigNum operator- ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 437 of file base58.cpp.

{
    CBigNum r;
    if (!BN_sub(r.to_bignum(), a.to_bignum(), b.to_bignum()))
        throw bignum_error("CBigNum::operator- : BN_sub failed");
    return r;
}

Here is the call graph for this function:

operator/()

const CBigNum operator/ ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 461 of file base58.cpp.

{
    CAutoBN_CTX pctx;
    CBigNum r;
    if (!BN_div(r.to_bignum(), NULL, a.to_bignum(), b.to_bignum(), pctx))
        throw bignum_error("CBigNum::operator/ : BN_div failed");
    return r;
}

Here is the call graph for this function:

operator<()

bool operator< ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 498 of file base58.cpp.

{ return (BN_cmp(a.to_bignum(), b.to_bignum()) < 0); }

Here is the call graph for this function:

operator<<()

const CBigNum operator<< ( const CBigNum & a, unsigned int shift )

inline

Definition at line 479 of file base58.cpp.

{
    CBigNum r;
    if (!BN_lshift(r.to_bignum(), a.to_bignum(), shift))
        throw bignum_error("CBigNum:operator<< : BN_lshift failed");
    return r;
}

operator<=()

bool operator<= ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 496 of file base58.cpp.

{ return (BN_cmp(a.to_bignum(), b.to_bignum()) <= 0); }

Here is the call graph for this function:

operator==()

bool operator== ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 494 of file base58.cpp.

{ return (BN_cmp(a.to_bignum(), b.to_bignum()) == 0); }

Here is the call graph for this function:

operator>()

bool operator> ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 499 of file base58.cpp.

{ return (BN_cmp(a.to_bignum(), b.to_bignum()) > 0); }

Here is the call graph for this function:

operator>=()

bool operator>= ( const CBigNum & a, const CBigNum & b )

inline

Definition at line 497 of file base58.cpp.

{ return (BN_cmp(a.to_bignum(), b.to_bignum()) >= 0); }

Here is the call graph for this function:

operator>>()

const CBigNum operator>> ( const CBigNum & a, unsigned int shift )

inline

Definition at line 487 of file base58.cpp.

{
    CBigNum r = a;
    r >>= shift;
    return r;
}