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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
/* Copyright (C) 2007-2010 Open Information Security Foundation
*
* You can copy, redistribute or modify this Program under the terms of
* the GNU General Public License version 2 as published by the Free
* Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* version 2 along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
/**
* \file
*
* \author Brian Rectanus <brectanu@gmail.com>
*/
#ifndef __UTIL_BYTE_H__
#define __UTIL_BYTE_H__
#include <stdint.h>
#define BYTE_BIG_ENDIAN 0
#define BYTE_LITTLE_ENDIAN 1
/** Wrappers for OS dependent byte swapping functions */
#ifdef OS_FREEBSD
#include <sys/endian.h>
#define SCByteSwap16(x) bswap16(x)
#define SCByteSwap32(x) bswap32(x)
#define SCByteSwap64(x) bswap64(x)
#elif defined __OpenBSD__
#include <sys/types.h>
#define SCByteSwap16(x) swap16(x)
#define SCByteSwap32(x) swap32(x)
#define SCByteSwap64(x) swap64(x)
#elif OS_DARWIN
#include <libkern/OSByteOrder.h>
#define SCByteSwap16(x) OSSwapInt16(x)
#define SCByteSwap32(x) OSSwapInt32(x)
#define SCByteSwap64(x) OSSwapInt64(x)
#elif defined(__WIN32) || defined(_WIN32)
/* Quick & dirty solution, nothing seems to exist for this in Win32 API */
#define SCByteSwap16(x) \
((((x) & 0xff00) >> 8) \
| (((x) & 0x00ff) << 8))
#define SCByteSwap32(x) \
((((x) & 0xff000000) >> 24) \
| (((x) & 0x00ff0000) >> 8) \
| (((x) & 0x0000ff00) << 8) \
| (((x) & 0x000000ff) << 24))
#define SCByteSwap64(x) \
((((x) & 0xff00000000000000ull) >> 56) \
| (((x) & 0x00ff000000000000ull) >> 40) \
| (((x) & 0x0000ff0000000000ull) >> 24) \
| (((x) & 0x000000ff00000000ull) >> 8) \
| (((x) & 0x00000000ff000000ull) << 8) \
| (((x) & 0x0000000000ff0000ull) << 24) \
| (((x) & 0x000000000000ff00ull) << 40) \
| (((x) & 0x00000000000000ffull) << 56))
#else
#include <byteswap.h>
#define SCByteSwap16(x) bswap_16(x)
#define SCByteSwap32(x) bswap_32(x)
#define SCByteSwap64(x) bswap_64(x)
#endif /* OS_FREEBSD */
/** \brief Turn byte array into string.
*
* All non-printables are copied over, except for '\0', which is
* turned into literal \0 in the string.
*
* \param bytes byte array
* \param nbytes number of bytes
* \return string nul-terminated string or NULL on error
*/
char *BytesToString(const uint8_t *bytes, size_t nbytes);
/**
* Extract bytes from a byte string and convert to a unint64_t.
*
* \param res Stores result
* \param e Endianness (BYTE_BIG_ENDIAN or BYTE_LITTLE_ENDIAN)
* \param len Number of bytes to extract (8 max)
* \param bytes Data to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractUint64(uint64_t *res, int e, uint16_t len, const uint8_t *bytes);
/**
* Extract bytes from a byte string and convert to a unint32_t.
*
* \param res Stores result
* \param e Endianness (BYTE_BIG_ENDIAN or BYTE_LITTLE_ENDIAN)
* \param len Number of bytes to extract (8 max)
* \param bytes Data to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractUint32(uint32_t *res, int e, uint16_t len, const uint8_t *bytes);
/**
* Extract bytes from a byte string and convert to a unint16_t.
*
* \param res Stores result
* \param e Endianness (BYTE_BIG_ENDIAN or BYTE_LITTLE_ENDIAN)
* \param len Number of bytes to extract (8 max)
* \param bytes Data to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractUint16(uint16_t *res, int e, uint16_t len, const uint8_t *bytes);
/**
* Extract unsigned integer value from a string.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractString(uint64_t *res, int base, uint16_t len, const char *str);
/**
* Extract unsigned integer value from a string as uint64_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param len Number of bytes to extract (23 max)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringUint64(uint64_t *res, int base, uint16_t len, const char *str);
/**
* Extract unsigned integer value from a string as uint32_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringUint32(uint32_t *res, int base, uint16_t len, const char *str);
/**
* Extract unsigned integer value from a string as uint16_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringUint16(uint16_t *res, int base, uint16_t len, const char *str);
/**
* Extract unsigned integer value from a string as uint8_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringUint8(uint8_t *res, int base, uint16_t len, const char *str);
/**
* Extract signed integer value from a string.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringSigned(int64_t *res, int base, uint16_t len, const char *str);
/**
* Extract signed integer value from a string as uint64_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringInt64(int64_t *res, int base, uint16_t len, const char *str);
/**
* Extract signed integer value from a string as uint32_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringInt32(int32_t *res, int base, uint16_t len, const char *str);
/**
* Extract signed integer value from a string as uint16_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringInt16(int16_t *res, int base, uint16_t len, const char *str);
/**
* Extract signed integer value from a string as uint8_t.
*
* \param res Stores result
* \param base Base of the number to extract
* \param len Number of bytes to extract (23 max or 0 for unbounded)
* \param str String to extract from
*
* \return n Number of bytes extracted on success
* \return -1 On error
*/
int ByteExtractStringInt8(int8_t *res, int base, uint16_t len, const char *str);
#ifdef UNITTESTS
void ByteRegisterTests(void);
#endif /* UNITTESTS */
/** ------ Inline functions ----- */
static inline int ByteExtract(uint64_t *res, int e, uint16_t len, const uint8_t *bytes)
{
uint64_t b = 0;
int i;
if ((e != BYTE_BIG_ENDIAN) && (e != BYTE_LITTLE_ENDIAN)) {
/** \todo Need standard return values */
return -1;
}
*res = 0;
/* Go through each byte and merge it into the result in the correct order */
/** \todo Probably a more efficient way to do this. */
for (i = 0; i < len; i++) {
if (e == BYTE_LITTLE_ENDIAN) {
b = bytes[i];
}
else {
b = bytes[len - i - 1];
}
*res |= (b << ((i & 7) << 3));
}
return len;
}
#endif /* __UTIL_BYTE_H__ */
|
