1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/* MIT License
*
* Copyright (c) 1998 Massachusetts Institute of Technology
* Copyright (c) The c-ares project and its contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* SPDX-License-Identifier: MIT
*/
#ifndef __ARES_STR_H
#define __ARES_STR_H
CARES_EXTERN char *ares_strdup(const char *s1);
CARES_EXTERN size_t ares_strlen(const char *str);
/*! Copy string from source to destination with destination buffer size
* provided. The destination is guaranteed to be null terminated, if the
* provided buffer isn't large enough, only those bytes from the source that
* will fit will be copied.
*
* \param[out] dest Destination buffer
* \param[in] src Source to copy
* \param[in] dest_size Size of destination buffer
* \return String length. Will be at most dest_size-1
*/
CARES_EXTERN size_t ares_strcpy(char *dest, const char *src, size_t dest_size);
CARES_EXTERN ares_bool_t ares_str_isnum(const char *str);
CARES_EXTERN ares_bool_t ares_str_isalnum(const char *str);
CARES_EXTERN void ares_str_ltrim(char *str);
CARES_EXTERN void ares_str_rtrim(char *str);
CARES_EXTERN void ares_str_trim(char *str);
CARES_EXTERN void ares_str_lower(char *str);
CARES_EXTERN unsigned char ares_tolower(unsigned char c);
CARES_EXTERN unsigned char *ares_memmem(const unsigned char *big,
size_t big_len,
const unsigned char *little,
size_t little_len);
CARES_EXTERN ares_bool_t ares_memeq(const unsigned char *ptr,
const unsigned char *val, size_t len);
CARES_EXTERN ares_bool_t ares_memeq_ci(const unsigned char *ptr,
const unsigned char *val, size_t len);
CARES_EXTERN ares_bool_t ares_is_hostname(const char *str);
/*! Validate the string provided is printable. The length specified must be
* at least the size of the buffer provided. If a NULL-terminator is hit
* before the length provided is hit, this will not be considered a valid
* printable string. This does not validate that the string is actually
* NULL terminated.
*
* \param[in] str Buffer containing string to evaluate.
* \param[in] len Number of characters to evaluate within provided buffer.
* If 0, will return TRUE since it did not hit an exception.
* \return ARES_TRUE if the entire string is printable, ARES_FALSE if not.
*/
CARES_EXTERN ares_bool_t ares_str_isprint(const char *str, size_t len);
/* We only care about ASCII rules */
#define ares_isascii(x) (((unsigned char)x) <= 127)
#define ares_isdigit(x) (((unsigned char)x) >= '0' && ((unsigned char)x) <= '9')
#define ares_isxdigit(x) \
(ares_isdigit(x) || \
(((unsigned char)x) >= 'a' && ((unsigned char)x) <= 'f') || \
(((unsigned char)x) >= 'A' && ((unsigned char)x) <= 'F'))
#define ares_isupper(x) (((unsigned char)x) >= 'A' && ((unsigned char)x) <= 'Z')
#define ares_islower(x) (((unsigned char)x) >= 'a' && ((unsigned char)x) <= 'z')
#define ares_isalpha(x) (ares_islower(x) || ares_isupper(x))
#define ares_isspace(x) \
(((unsigned char)(x)) == '\r' || ((unsigned char)(x)) == '\t' || \
((unsigned char)(x)) == ' ' || ((unsigned char)(x)) == '\v' || \
((unsigned char)(x)) == '\f' || ((unsigned char)(x)) == '\n')
#define ares_isprint(x) \
(((unsigned char)(x)) >= 0x20 && ((unsigned char)(x)) <= 0x7E)
/* Character set allowed by hostnames. This is to include the normal
* domain name character set plus:
* - underscores which are used in SRV records.
* - Forward slashes such as are used for classless in-addr.arpa
* delegation (CNAMEs)
* - Asterisks may be used for wildcard domains in CNAMEs as seen in the
* real world.
* While RFC 2181 section 11 does state not to do validation,
* that applies to servers, not clients. Vulnerabilities have been
* reported when this validation is not performed. Security is more
* important than edge-case compatibility (which is probably invalid
* anyhow).
* [A-Za-z0-9-*._/]
*/
#define ares_is_hostnamech(x) \
(ares_isalpha(x) || ares_isdigit(x) || ((unsigned char)(x)) == '-' || \
((unsigned char)(x)) == '.' || ((unsigned char)(x)) == '_' || \
((unsigned char)(x)) == '/' || ((unsigned char)(x)) == '*')
/*! Compare two strings (for sorting)
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \return < 0 if First String less than Second String,
* 0 if First String equal to Second String,
* > 0 if First String greater than Second String
*/
CARES_EXTERN int ares_strcmp(const char *a, const char *b);
/*! Compare two strings up to specified length (for sorting)
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \param[in] n Length
* \return < 0 if First String less than Second String,
* 0 if First String equal to Second String,
* > 0 if First String greater than Second String
*/
CARES_EXTERN int ares_strncmp(const char *a, const char *b, size_t n);
/*! Compare two strings in a case-insensitive manner (for sorting)
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \return < 0 if First String less than Second String,
* 0 if First String equal to Second String,
* > 0 if First String greater than Second String
*/
CARES_EXTERN int ares_strcasecmp(const char *a, const char *b);
/*! Compare two strings in a case-insensitive manner up to specified length
* (for sorting)
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \param[in] n Length
* \return < 0 if First String less than Second String,
* 0 if First String equal to Second String,
* > 0 if First String greater than Second String
*/
CARES_EXTERN int ares_strncasecmp(const char *a, const char *b, size_t n);
/*! Compare two strings for equality
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \return ARES_TRUE on match, or ARES_FALSE if no match
*/
CARES_EXTERN ares_bool_t ares_streq(const char *a, const char *b);
/*! Compare two strings for equality up to specified length
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \param[in] n Length
* \return ARES_TRUE on match, or ARES_FALSE if no match
*/
CARES_EXTERN ares_bool_t ares_streq_max(const char *a, const char *b, size_t n);
/*! Compare two strings for equality in a case insensitive manner
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \return ARES_TRUE on match, or ARES_FALSE if no match
*/
CARES_EXTERN ares_bool_t ares_strcaseeq(const char *a, const char *b);
/*! Compare two strings for equality up to specified length in a case
* insensitive manner
*
* Treats NULL and "" strings as equivalent
*
* \param[in] a First String
* \param[in] b Second String
* \param[in] n Length
* \return ARES_TRUE on match, or ARES_FALSE if no match
*/
CARES_EXTERN ares_bool_t ares_strcaseeq_max(const char *a, const char *b,
size_t n);
/*! Free a C array, each element in the array will be freed by the provided
* free function. Both NULL-terminated arrays and known length arrays are
* supported.
*
* \param[in] arr Array to be freed.
* \param[in] nmembers Number of members in the array, or SIZE_MAX for
* NULL-terminated arrays
* \param[in] freefunc Function to call on each array member (e.g. ares_free)
*/
CARES_EXTERN void ares_free_array(void *arr, size_t nmembers,
void (*freefunc)(void *));
#endif /* __ARES_STR_H */
|
