utilstrencodings.h File Reference

#include <stdint.h>
#include <string>
#include <vector>

Include dependency graph for utilstrencodings.h:

Go to the source code of this file.

Macros
#define	BEGIN(a)   ((char*)&(a))
	Utilities for converting data from/to strings. More...
#define	END(a)   ((char*)&((&(a))[1]))
#define	UBEGIN(a)   ((unsigned char*)&(a))
#define	UEND(a)   ((unsigned char*)&((&(a))[1]))
#define	ARRAYLEN(array)   (sizeof(array)/sizeof((array)[0]))

Enumerations
enum	SafeChars { SAFE_CHARS_DEFAULT, SAFE_CHARS_UA_COMMENT, SAFE_CHARS_FILENAME }
	Used by SanitizeString() More...

Functions
std::string	SanitizeString (const std::string &str, int rule=SAFE_CHARS_DEFAULT)
	Remove unsafe chars. More...
std::vector< unsigned char >	ParseHex (const char *psz)
std::vector< unsigned char >	ParseHex (const std::string &str)
signed char	HexDigit (char c)
bool	IsHex (const std::string &str)
bool	IsHexNumber (const std::string &str)
	Return true if the string is a hex number, optionally prefixed with "0x". More...
std::vector< unsigned char >	DecodeBase64 (const char *p, bool *pfInvalid=nullptr)
std::string	DecodeBase64 (const std::string &str)
std::string	EncodeBase64 (const unsigned char *pch, size_t len)
std::string	EncodeBase64 (const std::string &str)
std::vector< unsigned char >	DecodeBase32 (const char *p, bool *pfInvalid=nullptr)
std::string	DecodeBase32 (const std::string &str)
std::string	EncodeBase32 (const unsigned char *pch, size_t len)
std::string	EncodeBase32 (const std::string &str)
void	SplitHostPort (std::string in, int &portOut, std::string &hostOut)
std::string	i64tostr (int64_t n)
std::string	itostr (int n)
int64_t	atoi64 (const char *psz)
int64_t	atoi64 (const std::string &str)
int	atoi (const std::string &str)
bool	ParseInt32 (const std::string &str, int32_t *out)
	Convert string to signed 32-bit integer with strict parse error feedback. More...
bool	ParseInt64 (const std::string &str, int64_t *out)
	Convert string to signed 64-bit integer with strict parse error feedback. More...
bool	ParseUInt32 (const std::string &str, uint32_t *out)
	Convert decimal string to unsigned 32-bit integer with strict parse error feedback. More...
bool	ParseUInt64 (const std::string &str, uint64_t *out)
	Convert decimal string to unsigned 64-bit integer with strict parse error feedback. More...
bool	ParseDouble (const std::string &str, double *out)
	Convert string to double with strict parse error feedback. More...
template<typename T >
std::string	HexStr (const T itbegin, const T itend, bool fSpaces=false)
template<typename T >
std::string	HexStr (const T &vch, bool fSpaces=false)
std::string	FormatParagraph (const std::string &in, size_t width=79, size_t indent=0)
	Format a paragraph of text to a fixed width, adding spaces for indentation to any added line. More...
template<typename T >
bool	TimingResistantEqual (const T &a, const T &b)
	Timing-attack-resistant comparison. More...
bool	ParseFixedPoint (const std::string &val, int decimals, int64_t *amount_out)
	Parse number as fixed point according to JSON number syntax. More...

Macro Definition Documentation

ARRAYLEN

#define ARRAYLEN

(

array

)

(sizeof(array)/sizeof((array)[0]))

Definition at line 20 of file utilstrencodings.h.

Referenced by AvailableDataFormatsString(), CMainParams::CMainParams(), CTestNetParams::CTestNetParams(), GetLogCategory(), GetOSRand(), ListActiveLogCategories(), ListActiveLogCategoriesString(), ListLogCategories(), ParseDataFormat(), RegisterBlockchainRPCCommands(), RegisterEvoRPCCommands(), RegisterGovernanceRPCCommands(), RegisterMasternodeRPCCommands(), RegisterMiningRPCCommands(), RegisterMiscRPCCommands(), RegisterNetRPCCommands(), RegisterPrivateSendRPCCommands(), RegisterQuorumsRPCCommands(), RegisterRawTransactionRPCCommands(), RegisterWalletRPCCommands(), StartREST(), and StopREST().

BEGIN

#define BEGIN

(

a

)

((char*)&(a))

Utilities for converting data from/to strings.

Definition at line 16 of file utilstrencodings.h.

Referenced by CPartialMerkleTree::CalcHash(), and CPartialMerkleTree::TraverseAndExtract().

END

#define END

(

a

)

((char*)&((&(a))[1]))

Definition at line 17 of file utilstrencodings.h.

Referenced by CPartialMerkleTree::CalcHash(), and CPartialMerkleTree::TraverseAndExtract().

UBEGIN

#define UBEGIN

(

a

)

((unsigned char*)&(a))

Definition at line 18 of file utilstrencodings.h.

UEND

#define UEND

(

a

)

((unsigned char*)&((&(a))[1]))

Definition at line 19 of file utilstrencodings.h.

Enumeration Type Documentation

SafeChars

enum SafeChars

Used by SanitizeString()

Enumerator
SAFE_CHARS_DEFAULT	The full set of allowed chars.
SAFE_CHARS_UA_COMMENT	BIP-0014 subset.
SAFE_CHARS_FILENAME	Chars allowed in filenames.

Definition at line 23 of file utilstrencodings.h.

Function Documentation

atoi()

int atoi

(

const std::string &

str

)

Definition at line 612 of file utilstrencodings.cpp.

References atoi().

Referenced by atoi(), CleanupBlockRevFiles(), CWallet::GetMasternodeOutpointAndKeys(), gobject_getcurrentvotes(), gobject_submit(), int_atoi(), InterpretBool(), masternode_winners(), MutateTxAddInput(), MutateTxDelInput(), MutateTxDelOutput(), MutateTxSign(), TorControlConnection::readcb(), and RPCConsole::RPCParseCommandLine().

atoi64() [1/2]

int64_t atoi64

(

const char *

psz

)

Definition at line 594 of file utilstrencodings.cpp.

Referenced by ArgsManager::GetArg(), getblocktemplate(), gobject_submit(), MutateTxLocktime(), MutateTxVersion(), ParseMoney(), ParseScript(), ReadOrderPos(), and CWalletTx::SerializationOp().

atoi64() [2/2]

int64_t atoi64

(

const std::string &

str

)

Definition at line 603 of file utilstrencodings.cpp.

DecodeBase32() [1/2]

std::vector<unsigned char> DecodeBase32	(	const char *	p,
		bool *	pfInvalid = nullptr
	)

Definition at line 330 of file utilstrencodings.cpp.

Referenced by DecodeBase32(), GetCrashInfoStrFromSerializedStr(), and CNetAddr::SetSpecial().

DecodeBase32() [2/2]

std::string DecodeBase32

(

const std::string &

str

)

Definition at line 447 of file utilstrencodings.cpp.

References DecodeBase32().

DecodeBase64() [1/2]

std::vector<unsigned char> DecodeBase64	(	const char *	p,
		bool *	pfInvalid = nullptr
	)

Definition at line 177 of file utilstrencodings.cpp.

Referenced by DecodeBase64(), CKeePassIntegrator::CKeePassResponse::decrypt(), SignVerifyMessageDialog::on_verifyMessageButton_VM_clicked(), CKeePassIntegrator::CKeePassResponse::parseResponse(), RPCAuthorized(), verifymessage(), and voteraw().

DecodeBase64() [2/2]

std::string DecodeBase64

(

const std::string &

str

)

Definition at line 260 of file utilstrencodings.cpp.

References DecodeBase64().

EncodeBase32() [1/2]

std::string EncodeBase32	(	const unsigned char *	pch,
		size_t	len
	)

Definition at line 266 of file utilstrencodings.cpp.

Referenced by EncodeBase32(), GetCrashInfoStrNoDebugInfo(), and CNetAddr::ToStringIP().

EncodeBase32() [2/2]

std::string EncodeBase32

(

const std::string &

str

)

Definition at line 325 of file utilstrencodings.cpp.

References EncodeBase32().

EncodeBase64() [1/2]

std::string EncodeBase64	(	const unsigned char *	pch,
		size_t	len
	)

Definition at line 126 of file utilstrencodings.cpp.

Referenced by CKeePassIntegrator::CKeePassRequest::addStrParameter(), CallRPC(), EncodeBase64(), SignVerifyMessageDialog::on_signMessageButton_SM_clicked(), signmessage(), signmessagewithprivkey(), and CHashSigner::VerifyHash().

EncodeBase64() [2/2]

std::string EncodeBase64

(

const std::string &

str

)

Definition at line 172 of file utilstrencodings.cpp.

References EncodeBase64().

FormatParagraph()

std::string FormatParagraph	(	const std::string &	in,
		size_t	width = 79,
		size_t	indent = 0
	)

Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.

Definition at line 543 of file utilstrencodings.cpp.

Referenced by AppInit(), and HelpMessageOpt().

HexDigit()

signed char HexDigit

(

char

c

)

Definition at line 53 of file utilstrencodings.cpp.

References p_util_hexdigit.

Referenced by IsHex(), IsHexNumber(), ParseHex(), and base_blob< 512 >::SetHex().

HexStr() [1/2]

template<typename T >

std::string HexStr	(	const T	itbegin,
		const T	itend,
		bool	fSpaces = false
	)

Definition at line 100 of file utilstrencodings.h.

Referenced by addmultisigaddress(), TorController::authchallenge_cb(), BOOST_FIXTURE_TEST_CASE(), CDBWrapper::CDBWrapper(), createmultisig(), CHDChain::Debug(), dumphdinfo(), dumpwallet(), EncodeDumpString(), EncodeHexTx(), CWallet::EncryptWallet(), FormatScript(), GenerateAuthCookie(), getaddressutxos(), getblock(), getblockheader(), getblockheaders(), getblocktemplate(), CGovernanceObject::GetDataAsHexString(), base_blob< 512 >::GetHex(), getmerkleblocks(), gettxoutproof(), HexStr(), listunspent(), CProRegTx::MakeSignString(), multiUserAuthorized(), PeerLogicValidation::ProcessMessages(), TorController::protocolinfo_cb(), rest_block(), rest_getutxos(), rest_headers(), rest_tx(), ScriptPubKeyToUniv(), ScriptToAsmStr(), TestAES256CBC(), TestCrypter::TestPassphraseSingle(), llmq::CLLMQUtils::ToHexStr(), CSimplifiedMNListDiff::ToJson(), CTxIn::ToString(), CTxOut::ToString(), CBLSWrapper< bls::InsecureSignature, BLS_CURVE_SIG_SIZE, CBLSSignature >::ToString(), TxInErrorToJSON(), TxToUniv(), and validateaddress().

HexStr() [2/2]

template<typename T >

std::string HexStr ( const T &  vch, bool  fSpaces = false  )

inline

Definition at line 119 of file utilstrencodings.h.

References HexStr().

i64tostr()

std::string i64tostr

(

int64_t

n

)

Definition at line 584 of file utilstrencodings.cpp.

References strprintf.

Referenced by getblocktemplate(), and WriteOrderPos().

IsHex()

bool IsHex

(

const std::string &

str

)

Definition at line 58 of file utilstrencodings.cpp.

References HexDigit().

Referenced by addmultisigaddress(), createmultisig(), DecodeHexBlk(), DecodeHexTx(), CWallet::GenerateNewHDChain(), gettxoutproof(), HexToPubKey(), importaddress(), importpubkey(), importwallet(), lockunspent(), MutateTxAddInput(), MutateTxAddOutData(), WalletInit::ParameterInteraction(), ParseHashStr(), ParseHashV(), ParseHexUV(), ParseHexV(), ParseScript(), ProcessImport(), rest_getutxos(), and CBLSWrapper< bls::InsecureSignature, BLS_CURVE_SIG_SIZE, CBLSSignature >::SetHexStr().

IsHexNumber()

bool IsHexNumber

(

const std::string &

str

)

Return true if the string is a hex number, optionally prefixed with "0x".

Definition at line 68 of file utilstrencodings.cpp.

References HexDigit().

Referenced by AppInitParameterInteraction().

itostr()

std::string itostr

(

int

n

)

Definition at line 589 of file utilstrencodings.cpp.

References strprintf.

Referenced by keypoolrefill(), WalletInit::ParameterInteraction(), ParseBoolV(), ProcessMessage(), CKeePassIntegrator::rpcAssociate(), CKeePassIntegrator::rpcGetLogins(), CKeePassIntegrator::rpcSetLogin(), strings_1_itostr(), and strings_2_multi_itostr().

ParseDouble()

bool ParseDouble	(	const std::string &	str,
		double *	out
	)

Convert string to double with strict parse error feedback.

Returns

true if the entire string could be parsed as valid double, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 529 of file utilstrencodings.cpp.

References ParsePrechecks().

Referenced by UniValue::get_real(), and ParseDoubleV().

ParseFixedPoint()

bool ParseFixedPoint	(	const std::string &	val,
		int	decimals,
		int64_t *	amount_out
	)

Parse number as fixed point according to JSON number syntax.

See http://json.org/number.gif

Returns

true on success, false on error.

Note

The result must be in the range (-10^18,10^18), otherwise an overflow error will trigger.

Definition at line 644 of file utilstrencodings.cpp.

References ProcessMantissaDigit(), and UPPER_BOUND.

Referenced by AmountFromValue(), and ParsePaymentAmount().

ParseHex() [1/2]

std::vector<unsigned char> ParseHex

(

const char *

psz

)

Definition at line 81 of file utilstrencodings.cpp.

References HexDigit().

Referenced by AppInitMain(), TorController::authchallenge_cb(), BOOST_AUTO_TEST_CASE(), CreateGenesisBlock(), DecodeHexBlk(), DecodeHexTx(), CWallet::GenerateNewHDChain(), getmerkleblocks(), gobject_deserialize(), HexToPubKey(), importaddress(), importpubkey(), importwallet(), MutateTxAddOutData(), MutateTxAddOutMultiSig(), MutateTxAddOutPubKey(), ParseHex(), ParseHexUV(), ParseHexV(), ParseScript(), CProposalValidator::ParseStrHexData(), ProcessImport(), rest_getutxos(), BerkeleyEnvironment::Salvage(), CBLSWrapper< bls::InsecureSignature, BLS_CURVE_SIG_SIZE, CBLSSignature >::SetHexStr(), and TestAES256CBC().

ParseHex() [2/2]

std::vector<unsigned char> ParseHex

(

const std::string &

str

)

Definition at line 102 of file utilstrencodings.cpp.

References ParseHex().

ParseInt32()

bool ParseInt32	(	const std::string &	str,
		int32_t *	out
	)

Convert string to signed 32-bit integer with strict parse error feedback.

Returns

true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 464 of file utilstrencodings.cpp.

References ParsePrechecks().

Referenced by AppInitParameterInteraction(), UniValue::get_int(), LookupSubNet(), ParseInt32V(), rest_getutxos(), and SplitHostPort().

ParseInt64()

bool ParseInt64	(	const std::string &	str,
		int64_t *	out
	)

Convert string to signed 64-bit integer with strict parse error feedback.

Returns

true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 480 of file utilstrencodings.cpp.

References ParsePrechecks().

Referenced by AppInitParameterInteraction(), UniValue::get_int64(), and ParseInt64V().

ParseUInt32()

bool ParseUInt32	(	const std::string &	str,
		uint32_t *	out
	)

Convert decimal string to unsigned 32-bit integer with strict parse error feedback.

Returns

true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 495 of file utilstrencodings.cpp.

References ParsePrechecks().

ParseUInt64()

bool ParseUInt64	(	const std::string &	str,
		uint64_t *	out
	)

Convert decimal string to unsigned 64-bit integer with strict parse error feedback.

Returns

true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 512 of file utilstrencodings.cpp.

References ParsePrechecks().

SanitizeString()

std::string SanitizeString	(	const std::string &	str,
		int	rule = SAFE_CHARS_DEFAULT
	)

Remove unsafe chars.

Safe chars chosen to allow simple messages/URLs/email addresses, but avoid anything even possibly remotely dangerous like & or >

Parameters

[in]	str	The string to sanitize
[in]	rule	The set of safe chars to choose (default: least restrictive)

Returns

A new string without unsafe chars

Definition at line 24 of file utilstrencodings.cpp.

References SAFE_CHARS.

Referenced by TorController::add_onion_cb(), AlertNotify(), AppInitMain(), TorController::authchallenge_cb(), JSONRPCRequest::parse(), ProcessMessage(), PeerLogicValidation::ProcessMessages(), and CConnman::PushMessage().

SplitHostPort()

void SplitHostPort	(	std::string	in,
		int &	portOut,
		std::string &	hostOut
	)

Definition at line 107 of file utilstrencodings.cpp.

References ParseInt32().

Referenced by CallRPC(), CConnman::ConnectNode(), HTTPBindAddresses(), and Lookup().

TimingResistantEqual()

template<typename T >

bool TimingResistantEqual	(	const T &	a,
		const T &	b
	)

Timing-attack-resistant comparison.

Takes time proportional to length of first argument.

Definition at line 136 of file utilstrencodings.h.

Referenced by multiUserAuthorized(), and RPCAuthorized().