Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : /**
7 : : * Utilities for converting data from/to strings.
8 : : */
9 : : #ifndef BITCOIN_UTIL_STRENCODINGS_H
10 : : #define BITCOIN_UTIL_STRENCODINGS_H
11 : :
12 : : #include <span.h>
13 : : #include <util/string.h>
14 : :
15 : : #include <charconv>
16 : : #include <cstddef>
17 : : #include <cstdint>
18 : : #include <limits>
19 : : #include <optional>
20 : : #include <string> // IWYU pragma: export
21 : : #include <string_view> // IWYU pragma: export
22 : : #include <system_error>
23 : : #include <type_traits>
24 : : #include <vector>
25 : :
26 : : /** Used by SanitizeString() */
27 : : enum SafeChars
28 : : {
29 : : SAFE_CHARS_DEFAULT, //!< The full set of allowed chars
30 : : SAFE_CHARS_UA_COMMENT, //!< BIP-0014 subset
31 : : SAFE_CHARS_FILENAME, //!< Chars allowed in filenames
32 : : SAFE_CHARS_URI, //!< Chars allowed in URIs (RFC 3986)
33 : : };
34 : :
35 : : /**
36 : : * Used by ParseByteUnits()
37 : : * Lowercase base 1000
38 : : * Uppercase base 1024
39 : : */
40 : : enum class ByteUnit : uint64_t {
41 : : NOOP = 1ULL,
42 : : k = 1000ULL,
43 : : K = 1024ULL,
44 : : m = 1'000'000ULL,
45 : : M = 1ULL << 20,
46 : : g = 1'000'000'000ULL,
47 : : G = 1ULL << 30,
48 : : t = 1'000'000'000'000ULL,
49 : : T = 1ULL << 40,
50 : : };
51 : :
52 : : /**
53 : : * Remove unsafe chars. Safe chars chosen to allow simple messages/URLs/email
54 : : * addresses, but avoid anything even possibly remotely dangerous like & or >
55 : : * @param[in] str The string to sanitize
56 : : * @param[in] rule The set of safe chars to choose (default: least restrictive)
57 : : * @return A new string without unsafe chars
58 : : */
59 : : std::string SanitizeString(std::string_view str, int rule = SAFE_CHARS_DEFAULT);
60 : : /** Parse the hex string into bytes (uint8_t or std::byte). Ignores whitespace. Returns nullopt on invalid input. */
61 : : template <typename Byte = std::byte>
62 : : std::optional<std::vector<Byte>> TryParseHex(std::string_view str);
63 : : /** Like TryParseHex, but returns an empty vector on invalid input. */
64 : : template <typename Byte = uint8_t>
65 : 8 : std::vector<Byte> ParseHex(std::string_view hex_str)
66 : : {
67 [ + - ][ # # ]: 8 : return TryParseHex<Byte>(hex_str).value_or(std::vector<Byte>{});
68 : 0 : }
69 : : signed char HexDigit(char c);
70 : : /* Returns true if each character in str is a hex character, and has an even
71 : : * number of hex digits.*/
72 : : bool IsHex(std::string_view str);
73 : : /**
74 : : * Return true if the string is a hex number, optionally prefixed with "0x"
75 : : */
76 : : bool IsHexNumber(std::string_view str);
77 : : std::optional<std::vector<unsigned char>> DecodeBase64(std::string_view str);
78 : : std::string EncodeBase64(Span<const unsigned char> input);
79 : 0 : inline std::string EncodeBase64(Span<const std::byte> input) { return EncodeBase64(MakeUCharSpan(input)); }
80 : 0 : inline std::string EncodeBase64(std::string_view str) { return EncodeBase64(MakeUCharSpan(str)); }
81 : : std::optional<std::vector<unsigned char>> DecodeBase32(std::string_view str);
82 : :
83 : : /**
84 : : * Base32 encode.
85 : : * If `pad` is true, then the output will be padded with '=' so that its length
86 : : * is a multiple of 8.
87 : : */
88 : : std::string EncodeBase32(Span<const unsigned char> input, bool pad = true);
89 : :
90 : : /**
91 : : * Base32 encode.
92 : : * If `pad` is true, then the output will be padded with '=' so that its length
93 : : * is a multiple of 8.
94 : : */
95 : : std::string EncodeBase32(std::string_view str, bool pad = true);
96 : :
97 : : /**
98 : : * Splits socket address string into host string and port value.
99 : : * Validates port value.
100 : : *
101 : : * @param[in] in The socket address string to split.
102 : : * @param[out] portOut Port-portion of the input, if found and parsable.
103 : : * @param[out] hostOut Host-portion of the input, if found.
104 : : * @return true if port-portion is absent or within its allowed range, otherwise false
105 : : */
106 : : bool SplitHostPort(std::string_view in, uint16_t& portOut, std::string& hostOut);
107 : :
108 : : // LocaleIndependentAtoi is provided for backwards compatibility reasons.
109 : : //
110 : : // New code should use ToIntegral or the ParseInt* functions
111 : : // which provide parse error feedback.
112 : : //
113 : : // The goal of LocaleIndependentAtoi is to replicate the defined behaviour of
114 : : // std::atoi as it behaves under the "C" locale, and remove some undefined
115 : : // behavior. If the parsed value is bigger than the integer type's maximum
116 : : // value, or smaller than the integer type's minimum value, std::atoi has
117 : : // undefined behavior, while this function returns the maximum or minimum
118 : : // values, respectively.
119 : : template <typename T>
120 : 1 : T LocaleIndependentAtoi(std::string_view str)
121 : : {
122 : : static_assert(std::is_integral<T>::value);
123 : : T result;
124 : : // Emulate atoi(...) handling of white space and leading +/-.
125 : 1 : std::string_view s = TrimStringView(str);
126 [ + - ][ + - ]: 1 : if (!s.empty() && s[0] == '+') {
[ # # ][ # # ]
127 [ # # ][ # # ]: 0 : if (s.length() >= 2 && s[1] == '-') {
[ # # ][ # # ]
128 : 0 : return 0;
129 : : }
130 : 0 : s = s.substr(1);
131 : 0 : }
132 : 1 : auto [_, error_condition] = std::from_chars(s.data(), s.data() + s.size(), result);
133 [ - + ][ # # ]: 1 : if (error_condition == std::errc::result_out_of_range) {
134 [ # # ][ # # ]: 0 : if (s.length() >= 1 && s[0] == '-') {
[ # # ][ # # ]
135 : : // Saturate underflow, per strtoll's behavior.
136 : 0 : return std::numeric_limits<T>::min();
137 : : } else {
138 : : // Saturate overflow, per strtoll's behavior.
139 : 0 : return std::numeric_limits<T>::max();
140 : : }
141 [ - + ][ # # ]: 1 : } else if (error_condition != std::errc{}) {
142 : 0 : return 0;
143 : : }
144 : 1 : return result;
145 : 1 : }
146 : :
147 : : /**
148 : : * Tests if the given character is a decimal digit.
149 : : * @param[in] c character to test
150 : : * @return true if the argument is a decimal digit; otherwise false.
151 : : */
152 : 10180 : constexpr bool IsDigit(char c)
153 : : {
154 [ + + ]: 10180 : return c >= '0' && c <= '9';
155 : : }
156 : :
157 : : /**
158 : : * Tests if the given character is a whitespace character. The whitespace characters
159 : : * are: space, form-feed ('\f'), newline ('\n'), carriage return ('\r'), horizontal
160 : : * tab ('\t'), and vertical tab ('\v').
161 : : *
162 : : * This function is locale independent. Under the C locale this function gives the
163 : : * same result as std::isspace.
164 : : *
165 : : * @param[in] c character to test
166 : : * @return true if the argument is a whitespace character; otherwise false
167 : : */
168 : 514 : constexpr inline bool IsSpace(char c) noexcept {
169 [ + - ][ + - ]: 514 : return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || c == '\v';
[ + - ][ + - ]
[ - + ]
170 : : }
171 : :
172 : : /**
173 : : * Convert string to integral type T. Leading whitespace, a leading +, or any
174 : : * trailing character fail the parsing. The required format expressed as regex
175 : : * is `-?[0-9]+`. The minus sign is only permitted for signed integer types.
176 : : *
177 : : * @returns std::nullopt if the entire string could not be parsed, or if the
178 : : * parsed value is not in the range representable by the type T.
179 : : */
180 : : template <typename T>
181 : 0 : std::optional<T> ToIntegral(std::string_view str)
182 : : {
183 : : static_assert(std::is_integral<T>::value);
184 : : T result;
185 : 0 : const auto [first_nonmatching, error_condition] = std::from_chars(str.data(), str.data() + str.size(), result);
186 [ # # ][ # # ]: 0 : if (first_nonmatching != str.data() + str.size() || error_condition != std::errc{}) {
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
187 : 0 : return std::nullopt;
188 : : }
189 : 0 : return result;
190 : 0 : }
191 : :
192 : : /**
193 : : * Convert string to signed 32-bit integer with strict parse error feedback.
194 : : * @returns true if the entire string could be parsed as valid integer,
195 : : * false if not the entire string could be parsed or when overflow or underflow occurred.
196 : : */
197 : : [[nodiscard]] bool ParseInt32(std::string_view str, int32_t *out);
198 : :
199 : : /**
200 : : * Convert string to signed 64-bit integer with strict parse error feedback.
201 : : * @returns true if the entire string could be parsed as valid integer,
202 : : * false if not the entire string could be parsed or when overflow or underflow occurred.
203 : : */
204 : : [[nodiscard]] bool ParseInt64(std::string_view str, int64_t *out);
205 : :
206 : : /**
207 : : * Convert decimal string to unsigned 8-bit integer with strict parse error feedback.
208 : : * @returns true if the entire string could be parsed as valid integer,
209 : : * false if not the entire string could be parsed or when overflow or underflow occurred.
210 : : */
211 : : [[nodiscard]] bool ParseUInt8(std::string_view str, uint8_t *out);
212 : :
213 : : /**
214 : : * Convert decimal string to unsigned 16-bit integer with strict parse error feedback.
215 : : * @returns true if the entire string could be parsed as valid integer,
216 : : * false if the entire string could not be parsed or if overflow or underflow occurred.
217 : : */
218 : : [[nodiscard]] bool ParseUInt16(std::string_view str, uint16_t* out);
219 : :
220 : : /**
221 : : * Convert decimal string to unsigned 32-bit integer with strict parse error feedback.
222 : : * @returns true if the entire string could be parsed as valid integer,
223 : : * false if not the entire string could be parsed or when overflow or underflow occurred.
224 : : */
225 : : [[nodiscard]] bool ParseUInt32(std::string_view str, uint32_t *out);
226 : :
227 : : /**
228 : : * Convert decimal string to unsigned 64-bit integer with strict parse error feedback.
229 : : * @returns true if the entire string could be parsed as valid integer,
230 : : * false if not the entire string could be parsed or when overflow or underflow occurred.
231 : : */
232 : : [[nodiscard]] bool ParseUInt64(std::string_view str, uint64_t *out);
233 : :
234 : : /**
235 : : * Convert a span of bytes to a lower-case hexadecimal string.
236 : : */
237 : : std::string HexStr(const Span<const uint8_t> s);
238 : 0 : inline std::string HexStr(const Span<const char> s) { return HexStr(MakeUCharSpan(s)); }
239 : 0 : inline std::string HexStr(const Span<const std::byte> s) { return HexStr(MakeUCharSpan(s)); }
240 : :
241 : : /**
242 : : * Format a paragraph of text to a fixed width, adding spaces for
243 : : * indentation to any added line.
244 : : */
245 : : std::string FormatParagraph(std::string_view in, size_t width = 79, size_t indent = 0);
246 : :
247 : : /**
248 : : * Timing-attack-resistant comparison.
249 : : * Takes time proportional to length
250 : : * of first argument.
251 : : */
252 : : template <typename T>
253 : 0 : bool TimingResistantEqual(const T& a, const T& b)
254 : : {
255 [ # # ]: 0 : if (b.size() == 0) return a.size() == 0;
256 : 0 : size_t accumulator = a.size() ^ b.size();
257 [ # # ]: 0 : for (size_t i = 0; i < a.size(); i++)
258 : 0 : accumulator |= size_t(a[i] ^ b[i%b.size()]);
259 : 0 : return accumulator == 0;
260 : 0 : }
261 : :
262 : : /** Parse number as fixed point according to JSON number syntax.
263 : : * @returns true on success, false on error.
264 : : * @note The result must be in the range (-10^18,10^18), otherwise an overflow error will trigger.
265 : : */
266 : : [[nodiscard]] bool ParseFixedPoint(std::string_view, int decimals, int64_t *amount_out);
267 : :
268 : : namespace {
269 : : /** Helper class for the default infn argument to ConvertBits (just returns the input). */
270 : : struct IntIdentity
271 : : {
272 : 0 : [[maybe_unused]] int operator()(int x) const { return x; }
273 : : };
274 : :
275 : : } // namespace
276 : :
277 : : /** Convert from one power-of-2 number base to another. */
278 : : template<int frombits, int tobits, bool pad, typename O, typename It, typename I = IntIdentity>
279 : 0 : bool ConvertBits(O outfn, It it, It end, I infn = {}) {
280 : 0 : size_t acc = 0;
281 : 0 : size_t bits = 0;
282 : 0 : constexpr size_t maxv = (1 << tobits) - 1;
283 : 0 : constexpr size_t max_acc = (1 << (frombits + tobits - 1)) - 1;
284 [ # # ][ # # ]: 0 : while (it != end) {
[ # # ][ # # ]
[ # # ]
285 : 0 : int v = infn(*it);
286 [ # # ][ # # ]: 0 : if (v < 0) return false;
[ # # ][ # # ]
[ # # ]
287 : 0 : acc = ((acc << frombits) | v) & max_acc;
288 : 0 : bits += frombits;
289 [ # # ][ # # ]: 0 : while (bits >= tobits) {
[ # # ][ # # ]
[ # # ]
290 : 0 : bits -= tobits;
291 : 0 : outfn((acc >> bits) & maxv);
292 : : }
293 : 0 : ++it;
294 : : }
295 : : if (pad) {
296 [ # # ][ # # ]: 0 : if (bits) outfn((acc << (tobits - bits)) & maxv);
[ # # ][ # # ]
297 [ # # ][ # # ]: 0 : } else if (bits >= frombits || ((acc << (tobits - bits)) & maxv)) {
[ # # ][ # # ]
298 : 0 : return false;
299 : : }
300 : 0 : return true;
301 : 0 : }
302 : :
303 : : /**
304 : : * Converts the given character to its lowercase equivalent.
305 : : * This function is locale independent. It only converts uppercase
306 : : * characters in the standard 7-bit ASCII range.
307 : : * This is a feature, not a limitation.
308 : : *
309 : : * @param[in] c the character to convert to lowercase.
310 : : * @return the lowercase equivalent of c; or the argument
311 : : * if no conversion is possible.
312 : : */
313 : 52 : constexpr char ToLower(char c)
314 : : {
315 [ + + ][ - + ]: 52 : return (c >= 'A' && c <= 'Z' ? (c - 'A') + 'a' : c);
316 : : }
317 : :
318 : : /**
319 : : * Returns the lowercase equivalent of the given string.
320 : : * This function is locale independent. It only converts uppercase
321 : : * characters in the standard 7-bit ASCII range.
322 : : * This is a feature, not a limitation.
323 : : *
324 : : * @param[in] str the string to convert to lowercase.
325 : : * @returns lowercased equivalent of str
326 : : */
327 : : std::string ToLower(std::string_view str);
328 : :
329 : : /**
330 : : * Converts the given character to its uppercase equivalent.
331 : : * This function is locale independent. It only converts lowercase
332 : : * characters in the standard 7-bit ASCII range.
333 : : * This is a feature, not a limitation.
334 : : *
335 : : * @param[in] c the character to convert to uppercase.
336 : : * @return the uppercase equivalent of c; or the argument
337 : : * if no conversion is possible.
338 : : */
339 : 0 : constexpr char ToUpper(char c)
340 : : {
341 [ # # ][ # # ]: 0 : return (c >= 'a' && c <= 'z' ? (c - 'a') + 'A' : c);
342 : : }
343 : :
344 : : /**
345 : : * Returns the uppercase equivalent of the given string.
346 : : * This function is locale independent. It only converts lowercase
347 : : * characters in the standard 7-bit ASCII range.
348 : : * This is a feature, not a limitation.
349 : : *
350 : : * @param[in] str the string to convert to uppercase.
351 : : * @returns UPPERCASED EQUIVALENT OF str
352 : : */
353 : : std::string ToUpper(std::string_view str);
354 : :
355 : : /**
356 : : * Capitalizes the first character of the given string.
357 : : * This function is locale independent. It only converts lowercase
358 : : * characters in the standard 7-bit ASCII range.
359 : : * This is a feature, not a limitation.
360 : : *
361 : : * @param[in] str the string to capitalize.
362 : : * @returns string with the first letter capitalized.
363 : : */
364 : : std::string Capitalize(std::string str);
365 : :
366 : : /**
367 : : * Parse a string with suffix unit [k|K|m|M|g|G|t|T].
368 : : * Must be a whole integer, fractions not allowed (0.5t), no whitespace or +-
369 : : * Lowercase units are 1000 base. Uppercase units are 1024 base.
370 : : * Examples: 2m,27M,19g,41T
371 : : *
372 : : * @param[in] str the string to convert into bytes
373 : : * @param[in] default_multiplier if no unit is found in str use this unit
374 : : * @returns optional uint64_t bytes from str or nullopt
375 : : * if ToIntegral is false, str is empty, trailing whitespace or overflow
376 : : */
377 : : std::optional<uint64_t> ParseByteUnits(std::string_view str, ByteUnit default_multiplier);
378 : :
379 : : #endif // BITCOIN_UTIL_STRENCODINGS_H
|
