Add pf_invalid arg to std::string DecodeBase{32,64}

gwillen · gwillen · commit 162ffefd2f56 · 2019-02-11T12:23:14.000-08:00
Add support for the optional "pf_invalid" out parameter (which allows the caller
to detect decoding failures) to the std::string versions of DecodeBase32 and
DecodeBase64. The char* versions already have this feature.

Also, rename all uses of pfInvalid to pf_invalid to match style guidelines.
diff --git a/src/util/strencodings.cpp b/src/util/strencodings.cpp
@@ -141,7 +141,7 @@ std::string EncodeBase64(const std::string& str)
     return EncodeBase64((const unsigned char*)str.c_str(), str.size());
 }
 
-std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid)
+std::vector<unsigned char> DecodeBase64(const char* p, bool* pf_invalid)
 {
     static const int decode64_table[256] =
     {
@@ -183,14 +183,14 @@ std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid)
         ++p;
     }
     valid = valid && (p - e) % 4 == 0 && p - q < 4;
-    if (pfInvalid) *pfInvalid = !valid;
+    if (pf_invalid) *pf_invalid = !valid;
 
     return ret;
 }
 
-std::string DecodeBase64(const std::string& str)
+std::string DecodeBase64(const std::string& str, bool* pf_invalid)
 {
-    std::vector<unsigned char> vchRet = DecodeBase64(str.c_str());
+    std::vector<unsigned char> vchRet = DecodeBase64(str.c_str(), pf_invalid);
     return std::string((const char*)vchRet.data(), vchRet.size());
 }
 
@@ -210,7 +210,7 @@ std::string EncodeBase32(const std::string& str)
     return EncodeBase32((const unsigned char*)str.c_str(), str.size());
 }
 
-std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid)
+std::vector<unsigned char> DecodeBase32(const char* p, bool* pf_invalid)
 {
     static const int decode32_table[256] =
     {
@@ -252,14 +252,14 @@ std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid)
         ++p;
     }
     valid = valid && (p - e) % 8 == 0 && p - q < 8;
-    if (pfInvalid) *pfInvalid = !valid;
+    if (pf_invalid) *pf_invalid = !valid;
 
     return ret;
 }
 
-std::string DecodeBase32(const std::string& str)
+std::string DecodeBase32(const std::string& str, bool* pf_invalid)
 {
-    std::vector<unsigned char> vchRet = DecodeBase32(str.c_str());
+    std::vector<unsigned char> vchRet = DecodeBase32(str.c_str(), pf_invalid);
     return std::string((const char*)vchRet.data(), vchRet.size());
 }
 
diff --git a/src/util/strencodings.h b/src/util/strencodings.h
@@ -44,12 +44,12 @@ bool IsHex(const std::string& str);
 * Return true if the string is a hex number, optionally prefixed with "0x"
 */
 bool IsHexNumber(const std::string& str);
-std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = nullptr);
-std::string DecodeBase64(const std::string& str);
+std::vector<unsigned char> DecodeBase64(const char* p, bool* pf_invalid = nullptr);
+std::string DecodeBase64(const std::string& str, bool* pf_invalid = nullptr);
 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::vector<unsigned char> DecodeBase32(const char* p, bool* pf_invalid = nullptr);
+std::string DecodeBase32(const std::string& str, bool* pf_invalid = nullptr);
 std::string EncodeBase32(const unsigned char* pch, size_t len);
 std::string EncodeBase32(const std::string& str);
 

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ std::string EncodeBase64(const std::string& str)`
`141`	`141`	`return EncodeBase64((const unsigned char*)str.c_str(), str.size());`
`142`	`142`	`}`
`143`	`143`
`144`		`-std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid)`
	`144`	`+std::vector<unsigned char> DecodeBase64(const char* p, bool* pf_invalid)`
`145`	`145`	`{`
`146`	`146`	`static const int decode64_table[256] =`
`147`	`147`	`{`
`@@ -183,14 +183,14 @@ std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid)`
`183`	`183`	`++p;`
`184`	`184`	`}`
`185`	`185`	`valid = valid && (p - e) % 4 == 0 && p - q < 4;`
`186`		`- if (pfInvalid) *pfInvalid = !valid;`
	`186`	`+ if (pf_invalid) *pf_invalid = !valid;`
`187`	`187`
`188`	`188`	`return ret;`
`189`	`189`	`}`
`190`	`190`
`191`		`-std::string DecodeBase64(const std::string& str)`
	`191`	`+std::string DecodeBase64(const std::string& str, bool* pf_invalid)`
`192`	`192`	`{`
`193`		`- std::vector<unsigned char> vchRet = DecodeBase64(str.c_str());`
	`193`	`+ std::vector<unsigned char> vchRet = DecodeBase64(str.c_str(), pf_invalid);`
`194`	`194`	`return std::string((const char*)vchRet.data(), vchRet.size());`
`195`	`195`	`}`
`196`	`196`
`@@ -210,7 +210,7 @@ std::string EncodeBase32(const std::string& str)`
`210`	`210`	`return EncodeBase32((const unsigned char*)str.c_str(), str.size());`
`211`	`211`	`}`
`212`	`212`
`213`		`-std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid)`
	`213`	`+std::vector<unsigned char> DecodeBase32(const char* p, bool* pf_invalid)`
`214`	`214`	`{`
`215`	`215`	`static const int decode32_table[256] =`
`216`	`216`	`{`
`@@ -252,14 +252,14 @@ std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid)`
`252`	`252`	`++p;`
`253`	`253`	`}`
`254`	`254`	`valid = valid && (p - e) % 8 == 0 && p - q < 8;`
`255`		`- if (pfInvalid) *pfInvalid = !valid;`
	`255`	`+ if (pf_invalid) *pf_invalid = !valid;`
`256`	`256`
`257`	`257`	`return ret;`
`258`	`258`	`}`
`259`	`259`
`260`		`-std::string DecodeBase32(const std::string& str)`
	`260`	`+std::string DecodeBase32(const std::string& str, bool* pf_invalid)`
`261`	`261`	`{`
`262`		`- std::vector<unsigned char> vchRet = DecodeBase32(str.c_str());`
	`262`	`+ std::vector<unsigned char> vchRet = DecodeBase32(str.c_str(), pf_invalid);`
`263`	`263`	`return std::string((const char*)vchRet.data(), vchRet.size());`
`264`	`264`	`}`
`265`	`265`