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.
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.
18 #include <openssl/crypto.h> // for OPENSSL_cleanse()
24 static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
26 // Encode a byte sequence as a base58-encoded string
27 std::string EncodeBase58(const unsigned char* pbegin, const unsigned char* pend)
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());
38 // Convert little endian data to bignum
42 // Convert bignum to std::string
44 // Expected size increase from base58 conversion is approximately 137%
45 // use 138% to be safe
46 str.reserve((pend - pbegin) * 138 / 100 + 1);
51 if (!BN_div(&dv, &rem, &bn, &bn58, pctx))
52 throw bignum_error("EncodeBase58 : BN_div failed");
54 unsigned int c = rem.getuint32();
58 // Leading zeroes encoded as base58 zeros
59 for (const unsigned char* p = pbegin; p < pend && *p == 0; p++)
62 // Convert little endian std::string to big endian
63 reverse(str.begin(), str.end());
67 // Encode a byte vector as a base58-encoded string
68 std::string EncodeBase58(const std::vector<unsigned char>& vch)
70 return EncodeBase58(&vch[0], &vch[0] + vch.size());
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)
85 // Convert big endian string to bignum
86 for (const char* p = psz; *p; p++)
88 const char* p1 = strchr(pszBase58, *p);
97 bnChar.setuint32((uint32_t)(p1 - pszBase58));
98 if (!BN_mul(&bn, &bn, &bn58, pctx))
99 throw bignum_error("DecodeBase58 : BN_mul failed");
103 // Get bignum as little endian data
104 std::vector<unsigned char> vchTmp = bn.getvch();
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);
110 // Restore leading zeros
111 int nLeadingZeros = 0;
112 for (const char* p = psz; *p == pszBase58[0]; p++)
114 vchRet.assign(nLeadingZeros + vchTmp.size(), 0);
116 // Convert little endian data to big endian
117 reverse_copy(vchTmp.begin(), vchTmp.end(), vchRet.end() - vchTmp.size());
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)
125 return DecodeBase58(str.c_str(), vchRet);
128 // Encode a byte vector to a base58-encoded string, including checksum
129 std::string EncodeBase58Check(const std::vector<unsigned char>& vchIn)
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);
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)
142 if (!DecodeBase58(psz, vchRet))
144 if (vchRet.size() < 4)
149 uint256 hash = Hash(vchRet.begin(), vchRet.end()-4);
150 if (memcmp(&hash, &vchRet.end()[-4], 4) != 0)
155 vchRet.resize(vchRet.size()-4);
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)
163 return DecodeBase58Check(str.c_str(), vchRet);
166 CBase58Data::CBase58Data()
172 CBase58Data::~CBase58Data()
174 // zero the memory, as it may contain sensitive data
175 if (!vchData.empty())
176 OPENSSL_cleanse(&vchData[0], vchData.size());
179 void CBase58Data::SetData(int nVersionIn, const void* pdata, size_t nSize)
181 nVersion = nVersionIn;
182 vchData.resize(nSize);
183 if (!vchData.empty())
184 memcpy(&vchData[0], pdata, nSize);
187 const std::vector<unsigned char> &CBase58Data::GetData() const
192 void CBase58Data::SetData(int nVersionIn, const unsigned char *pbegin, const unsigned char *pend)
194 SetData(nVersionIn, (void*)pbegin, pend - pbegin);
197 bool CBase58Data::SetString(const char* psz)
199 std::vector<unsigned char> vchTemp;
200 DecodeBase58Check(psz, vchTemp);
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());
215 bool CBase58Data::SetString(const std::string& str)
217 return SetString(str.c_str());
220 std::string CBase58Data::ToString() const
222 std::vector<unsigned char> vch(1, nVersion);
223 vch.insert(vch.end(), vchData.begin(), vchData.end());
224 return EncodeBase58Check(vch);
227 int CBase58Data::CompareTo(const CBase58Data& b58) const
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;
236 bool CBitcoinAddress::Set(const CKeyID &id) {
237 SetData(fTestNet ? PUBKEY_ADDRESS_TEST : PUBKEY_ADDRESS, &id, 20);
241 bool CBitcoinAddress::Set(const CScriptID &id) {
242 SetData(fTestNet ? SCRIPT_ADDRESS_TEST : SCRIPT_ADDRESS, &id, 20);
246 bool CBitcoinAddress::Set(const CTxDestination &dest)
248 return boost::apply_visitor(CBitcoinAddressVisitor(this), dest);
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);
257 bool CBitcoinAddress::IsValid() const
259 unsigned int nExpectedSize = 20;
260 bool fExpectTestNet = false;
264 case PUBKEY_PAIR_ADDRESS:
265 nExpectedSize = 68; // Serialized pair of public keys
266 fExpectTestNet = false;
270 nExpectedSize = 20; // Hash of public key
271 fExpectTestNet = false;
274 nExpectedSize = 20; // Hash of CScript
275 fExpectTestNet = false;
278 case PUBKEY_PAIR_ADDRESS_TEST:
280 fExpectTestNet = true;
283 case PUBKEY_ADDRESS_TEST:
285 fExpectTestNet = true;
287 case SCRIPT_ADDRESS_TEST:
289 fExpectTestNet = true;
296 // Basic format sanity check
297 bool fSeemsSane = (fExpectTestNet == fTestNet && vchData.size() == nExpectedSize);
299 if (fSeemsSane && !fSimple)
301 // Perform dditional checking
302 // for pubkey pair addresses
303 CMalleablePubKey mpk;
305 return mpk.IsValid();
311 CTxDestination CBitcoinAddress::Get() const {
313 return CNoDestination();
316 case PUBKEY_ADDRESS_TEST: {
318 memcpy(&id, &vchData[0], 20);
322 case SCRIPT_ADDRESS_TEST: {
324 memcpy(&id, &vchData[0], 20);
325 return CScriptID(id);
328 return CNoDestination();
331 bool CBitcoinAddress::GetKeyID(CKeyID &keyID) const {
336 case PUBKEY_ADDRESS_TEST: {
338 memcpy(&id, &vchData[0], 20);
342 case PUBKEY_PAIR_ADDRESS:
343 case PUBKEY_PAIR_ADDRESS_TEST:
345 CMalleablePubKey mPubKey;
346 mPubKey.setvch(vchData);
347 keyID = mPubKey.GetID();
349 default: return false;
353 bool CBitcoinAddress::IsScript() const {
358 case SCRIPT_ADDRESS_TEST: {
361 default: return false;
365 bool CBitcoinAddress::IsPubKey() const {
370 case PUBKEY_ADDRESS_TEST: {
373 default: return false;
377 bool CBitcoinAddress::IsPair() const {
381 case PUBKEY_PAIR_ADDRESS:
382 case PUBKEY_PAIR_ADDRESS_TEST: {
385 default: return false;
389 void CBitcoinSecret::SetSecret(const CSecret& vchSecret, bool fCompressed)
391 assert(vchSecret.size() == 32);
392 SetData(128 + (fTestNet ? CBitcoinAddress::PUBKEY_ADDRESS_TEST : CBitcoinAddress::PUBKEY_ADDRESS), &vchSecret[0], vchSecret.size());
394 vchData.push_back(1);
397 CSecret CBitcoinSecret::GetSecret(bool &fCompressedOut)
400 vchSecret.resize(32);
401 memcpy(&vchSecret[0], &vchData[0], 32);
402 fCompressedOut = vchData.size() == 33;
406 bool CBitcoinSecret::IsValid() const
408 bool fExpectTestNet = false;
411 case (128 + CBitcoinAddress::PUBKEY_ADDRESS):
414 case (128 + CBitcoinAddress::PUBKEY_ADDRESS_TEST):
415 fExpectTestNet = true;
421 return fExpectTestNet == fTestNet && (vchData.size() == 32 || (vchData.size() == 33 && vchData[32] == 1));
424 bool CBitcoinSecret::SetString(const char* pszSecret)
426 return CBase58Data::SetString(pszSecret) && IsValid();
429 bool CBitcoinSecret::SetString(const std::string& strSecret)
431 return SetString(strSecret.c_str());
434 CBitcoinSecret::CBitcoinSecret(const CSecret& vchSecret, bool fCompressed)
436 SetSecret(vchSecret, fCompressed);