1 /*
2 * wpa_supplicant/hostapd / common helper functions, etc.
3 * Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9 #ifndef COMMON_H
10 #define COMMON_H
11
12 #include "os.h"
13
14 #if defined(__linux__) || defined(__GLIBC__)
15 #include <endian.h>
16 #include <byteswap.h>
17 #endif /* __linux__ */
18
19 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) || \
20 defined(__OpenBSD__)
21 #include <sys/types.h>
22 #include <sys/endian.h>
23 #define __BYTE_ORDER _BYTE_ORDER
24 #define __LITTLE_ENDIAN _LITTLE_ENDIAN
25 #define __BIG_ENDIAN _BIG_ENDIAN
26 #ifdef __OpenBSD__
27 #define bswap_16 swap16
28 #define bswap_32 swap32
29 #define bswap_64 swap64
30 #else /* __OpenBSD__ */
31 #define bswap_16 bswap16
32 #define bswap_32 bswap32
33 #define bswap_64 bswap64
34 #endif /* __OpenBSD__ */
35 #endif /* defined(__FreeBSD__) || defined(__NetBSD__) ||
36 * defined(__DragonFly__) || defined(__OpenBSD__) */
37
38 #ifdef __APPLE__
39 #include <sys/types.h>
40 #include <machine/endian.h>
41 #define __BYTE_ORDER _BYTE_ORDER
42 #define __LITTLE_ENDIAN _LITTLE_ENDIAN
43 #define __BIG_ENDIAN _BIG_ENDIAN
bswap_16(unsigned short v)44 static inline unsigned short bswap_16(unsigned short v)
45 {
46 return ((v & 0xff) << 8) | (v >> 8);
47 }
48
bswap_32(unsigned int v)49 static inline unsigned int bswap_32(unsigned int v)
50 {
51 return ((v & 0xff) << 24) | ((v & 0xff00) << 8) |
52 ((v & 0xff0000) >> 8) | (v >> 24);
53 }
54 #endif /* __APPLE__ */
55
56 #ifdef __NetBSD__
57 #include <net/if.h>
58 #endif
59
60 #ifdef __rtems__
61 #include <rtems/endian.h>
62 #define __BYTE_ORDER BYTE_ORDER
63 #define __LITTLE_ENDIAN LITTLE_ENDIAN
64 #define __BIG_ENDIAN BIG_ENDIAN
65 #define bswap_16 CPU_swap_u16
66 #define bswap_32 CPU_swap_u32
67 #endif /* __rtems__ */
68
69 #ifdef CONFIG_NATIVE_WINDOWS
70 #include <winsock.h>
71
72 typedef int socklen_t;
73
74 #ifndef MSG_DONTWAIT
75 #define MSG_DONTWAIT 0 /* not supported */
76 #endif
77
78 #endif /* CONFIG_NATIVE_WINDOWS */
79
80 #ifdef _MSC_VER
81 #define inline __inline
82
83 #undef vsnprintf
84 #define vsnprintf _vsnprintf
85 #undef close
86 #define close closesocket
87 #endif /* _MSC_VER */
88
89
90 /* Define platform specific integer types */
91
92 #ifdef _MSC_VER
93 typedef UINT64 u64;
94 typedef UINT32 u32;
95 typedef UINT16 u16;
96 typedef UINT8 u8;
97 typedef INT64 s64;
98 typedef INT32 s32;
99 typedef INT16 s16;
100 typedef INT8 s8;
101 #define WPA_TYPES_DEFINED
102 #endif /* _MSC_VER */
103
104 #ifdef __vxworks
105 typedef unsigned long long u64;
106 typedef UINT32 u32;
107 typedef UINT16 u16;
108 typedef UINT8 u8;
109 typedef long long s64;
110 typedef INT32 s32;
111 typedef INT16 s16;
112 typedef INT8 s8;
113 #define WPA_TYPES_DEFINED
114 #endif /* __vxworks */
115
116 #ifndef WPA_TYPES_DEFINED
117 #ifdef CONFIG_USE_INTTYPES_H
118 #include <inttypes.h>
119 #else
120 #include <stdint.h>
121 #endif
122 typedef uint64_t u64;
123 typedef uint32_t u32;
124 typedef uint16_t u16;
125 typedef uint8_t u8;
126 typedef int64_t s64;
127 typedef int32_t s32;
128 typedef int16_t s16;
129 typedef int8_t s8;
130 #define WPA_TYPES_DEFINED
131 #endif /* !WPA_TYPES_DEFINED */
132
133
134 /* Define platform specific byte swapping macros */
135
136 #if defined(__CYGWIN__) || defined(CONFIG_NATIVE_WINDOWS)
137
wpa_swap_16(unsigned short v)138 static inline unsigned short wpa_swap_16(unsigned short v)
139 {
140 return ((v & 0xff) << 8) | (v >> 8);
141 }
142
wpa_swap_32(unsigned int v)143 static inline unsigned int wpa_swap_32(unsigned int v)
144 {
145 return ((v & 0xff) << 24) | ((v & 0xff00) << 8) |
146 ((v & 0xff0000) >> 8) | (v >> 24);
147 }
148
149 #define le_to_host16(n) (n)
150 #define host_to_le16(n) (n)
151 #define be_to_host16(n) wpa_swap_16(n)
152 #define host_to_be16(n) wpa_swap_16(n)
153 #define le_to_host32(n) (n)
154 #define host_to_le32(n) (n)
155 #define be_to_host32(n) wpa_swap_32(n)
156 #define host_to_be32(n) wpa_swap_32(n)
157 #define host_to_le64(n) (n)
158
159 #define WPA_BYTE_SWAP_DEFINED
160
161 #endif /* __CYGWIN__ || CONFIG_NATIVE_WINDOWS */
162
163
164 #ifndef WPA_BYTE_SWAP_DEFINED
165
166 #ifndef __BYTE_ORDER
167 #ifndef __LITTLE_ENDIAN
168 #ifndef __BIG_ENDIAN
169 #define __LITTLE_ENDIAN 1234
170 #define __BIG_ENDIAN 4321
171 #if defined(sparc)
172 #define __BYTE_ORDER __BIG_ENDIAN
173 #endif
174 #endif /* __BIG_ENDIAN */
175 #endif /* __LITTLE_ENDIAN */
176 #endif /* __BYTE_ORDER */
177
178 #if __BYTE_ORDER == __LITTLE_ENDIAN
179 #define le_to_host16(n) ((__force u16) (le16) (n))
180 #define host_to_le16(n) ((__force le16) (u16) (n))
181 #define be_to_host16(n) bswap_16((__force u16) (be16) (n))
182 #define host_to_be16(n) ((__force be16) bswap_16((n)))
183 #define le_to_host32(n) ((__force u32) (le32) (n))
184 #define host_to_le32(n) ((__force le32) (u32) (n))
185 #define be_to_host32(n) bswap_32((__force u32) (be32) (n))
186 #define host_to_be32(n) ((__force be32) bswap_32((n)))
187 #define le_to_host64(n) ((__force u64) (le64) (n))
188 #define host_to_le64(n) ((__force le64) (u64) (n))
189 #define be_to_host64(n) bswap_64((__force u64) (be64) (n))
190 #define host_to_be64(n) ((__force be64) bswap_64((n)))
191 #elif __BYTE_ORDER == __BIG_ENDIAN
192 #define le_to_host16(n) bswap_16(n)
193 #define host_to_le16(n) bswap_16(n)
194 #define be_to_host16(n) (n)
195 #define host_to_be16(n) (n)
196 #define le_to_host32(n) bswap_32(n)
197 #define host_to_le32(n) bswap_32(n)
198 #define be_to_host32(n) (n)
199 #define host_to_be32(n) (n)
200 #define le_to_host64(n) bswap_64(n)
201 #define host_to_le64(n) bswap_64(n)
202 #define be_to_host64(n) (n)
203 #define host_to_be64(n) (n)
204 #ifndef WORDS_BIGENDIAN
205 #define WORDS_BIGENDIAN
206 #endif
207 #else
208 #error Could not determine CPU byte order
209 #endif
210
211 #define WPA_BYTE_SWAP_DEFINED
212 #endif /* !WPA_BYTE_SWAP_DEFINED */
213
214
215 /* Macros for handling unaligned memory accesses */
216
WPA_GET_BE16(const u8 * a)217 static inline u16 WPA_GET_BE16(const u8 *a)
218 {
219 return (a[0] << 8) | a[1];
220 }
221
WPA_PUT_BE16(u8 * a,u16 val)222 static inline void WPA_PUT_BE16(u8 *a, u16 val)
223 {
224 a[0] = val >> 8;
225 a[1] = val & 0xff;
226 }
227
WPA_GET_LE16(const u8 * a)228 static inline u16 WPA_GET_LE16(const u8 *a)
229 {
230 return (a[1] << 8) | a[0];
231 }
232
WPA_PUT_LE16(u8 * a,u16 val)233 static inline void WPA_PUT_LE16(u8 *a, u16 val)
234 {
235 a[1] = val >> 8;
236 a[0] = val & 0xff;
237 }
238
WPA_GET_BE24(const u8 * a)239 static inline u32 WPA_GET_BE24(const u8 *a)
240 {
241 return (a[0] << 16) | (a[1] << 8) | a[2];
242 }
243
WPA_PUT_BE24(u8 * a,u32 val)244 static inline void WPA_PUT_BE24(u8 *a, u32 val)
245 {
246 a[0] = (val >> 16) & 0xff;
247 a[1] = (val >> 8) & 0xff;
248 a[2] = val & 0xff;
249 }
250
WPA_GET_BE32(const u8 * a)251 static inline u32 WPA_GET_BE32(const u8 *a)
252 {
253 return ((u32) a[0] << 24) | (a[1] << 16) | (a[2] << 8) | a[3];
254 }
255
WPA_PUT_BE32(u8 * a,u32 val)256 static inline void WPA_PUT_BE32(u8 *a, u32 val)
257 {
258 a[0] = (val >> 24) & 0xff;
259 a[1] = (val >> 16) & 0xff;
260 a[2] = (val >> 8) & 0xff;
261 a[3] = val & 0xff;
262 }
263
WPA_GET_LE32(const u8 * a)264 static inline u32 WPA_GET_LE32(const u8 *a)
265 {
266 return ((u32) a[3] << 24) | (a[2] << 16) | (a[1] << 8) | a[0];
267 }
268
WPA_PUT_LE32(u8 * a,u32 val)269 static inline void WPA_PUT_LE32(u8 *a, u32 val)
270 {
271 a[3] = (val >> 24) & 0xff;
272 a[2] = (val >> 16) & 0xff;
273 a[1] = (val >> 8) & 0xff;
274 a[0] = val & 0xff;
275 }
276
WPA_GET_BE64(const u8 * a)277 static inline u64 WPA_GET_BE64(const u8 *a)
278 {
279 return (((u64) a[0]) << 56) | (((u64) a[1]) << 48) |
280 (((u64) a[2]) << 40) | (((u64) a[3]) << 32) |
281 (((u64) a[4]) << 24) | (((u64) a[5]) << 16) |
282 (((u64) a[6]) << 8) | ((u64) a[7]);
283 }
284
WPA_PUT_BE64(u8 * a,u64 val)285 static inline void WPA_PUT_BE64(u8 *a, u64 val)
286 {
287 a[0] = val >> 56;
288 a[1] = val >> 48;
289 a[2] = val >> 40;
290 a[3] = val >> 32;
291 a[4] = val >> 24;
292 a[5] = val >> 16;
293 a[6] = val >> 8;
294 a[7] = val & 0xff;
295 }
296
WPA_GET_LE64(const u8 * a)297 static inline u64 WPA_GET_LE64(const u8 *a)
298 {
299 return (((u64) a[7]) << 56) | (((u64) a[6]) << 48) |
300 (((u64) a[5]) << 40) | (((u64) a[4]) << 32) |
301 (((u64) a[3]) << 24) | (((u64) a[2]) << 16) |
302 (((u64) a[1]) << 8) | ((u64) a[0]);
303 }
304
WPA_PUT_LE64(u8 * a,u64 val)305 static inline void WPA_PUT_LE64(u8 *a, u64 val)
306 {
307 a[7] = val >> 56;
308 a[6] = val >> 48;
309 a[5] = val >> 40;
310 a[4] = val >> 32;
311 a[3] = val >> 24;
312 a[2] = val >> 16;
313 a[1] = val >> 8;
314 a[0] = val & 0xff;
315 }
316
317
318 #ifndef ETH_ALEN
319 #define ETH_ALEN 6
320 #endif
321 #ifndef ETH_HLEN
322 #define ETH_HLEN 14
323 #endif
324 #ifndef IFNAMSIZ
325 #define IFNAMSIZ 16
326 #endif
327 #ifndef ETH_P_ALL
328 #define ETH_P_ALL 0x0003
329 #endif
330 #ifndef ETH_P_IP
331 #define ETH_P_IP 0x0800
332 #endif
333 #ifndef ETH_P_80211_ENCAP
334 #define ETH_P_80211_ENCAP 0x890d /* TDLS comes under this category */
335 #endif
336 #ifndef ETH_P_PAE
337 #define ETH_P_PAE 0x888E /* Port Access Entity (IEEE 802.1X) */
338 #endif /* ETH_P_PAE */
339 #ifndef ETH_P_EAPOL
340 #define ETH_P_EAPOL ETH_P_PAE
341 #endif /* ETH_P_EAPOL */
342 #ifndef ETH_P_RSN_PREAUTH
343 #define ETH_P_RSN_PREAUTH 0x88c7
344 #endif /* ETH_P_RSN_PREAUTH */
345 #ifndef ETH_P_RRB
346 #define ETH_P_RRB 0x890D
347 #endif /* ETH_P_RRB */
348 #ifndef ETH_P_OUI
349 #define ETH_P_OUI 0x88B7
350 #endif /* ETH_P_OUI */
351
352
353 #ifdef __GNUC__
354 #define PRINTF_FORMAT(a,b) __attribute__ ((format (printf, (a), (b))))
355 #define STRUCT_PACKED __attribute__ ((packed))
356 #else
357 #define PRINTF_FORMAT(a,b)
358 #define STRUCT_PACKED
359 #endif
360
361
362 #ifdef CONFIG_ANSI_C_EXTRA
363
364 #if !defined(_MSC_VER) || _MSC_VER < 1400
365 /* snprintf - used in number of places; sprintf() is _not_ a good replacement
366 * due to possible buffer overflow; see, e.g.,
367 * http://www.ijs.si/software/snprintf/ for portable implementation of
368 * snprintf. */
369 int snprintf(char *str, size_t size, const char *format, ...);
370
371 /* vsnprintf - only used for wpa_msg() in wpa_supplicant.c */
372 int vsnprintf(char *str, size_t size, const char *format, va_list ap);
373 #endif /* !defined(_MSC_VER) || _MSC_VER < 1400 */
374
375 /* getopt - only used in main.c */
376 int getopt(int argc, char *const argv[], const char *optstring);
377 extern char *optarg;
378 extern int optind;
379
380 #ifndef CONFIG_NO_SOCKLEN_T_TYPEDEF
381 #ifndef __socklen_t_defined
382 typedef int socklen_t;
383 #endif
384 #endif
385
386 /* inline - define as __inline or just define it to be empty, if needed */
387 #ifdef CONFIG_NO_INLINE
388 #define inline
389 #else
390 #define inline __inline
391 #endif
392
393 #ifndef __func__
394 #define __func__ "__func__ not defined"
395 #endif
396
397 #ifndef bswap_16
398 #define bswap_16(a) ((((u16) (a) << 8) & 0xff00) | (((u16) (a) >> 8) & 0xff))
399 #endif
400
401 #ifndef bswap_32
402 #define bswap_32(a) ((((u32) (a) << 24) & 0xff000000) | \
403 (((u32) (a) << 8) & 0xff0000) | \
404 (((u32) (a) >> 8) & 0xff00) | \
405 (((u32) (a) >> 24) & 0xff))
406 #endif
407
408 #ifndef MSG_DONTWAIT
409 #define MSG_DONTWAIT 0
410 #endif
411
412 #ifdef _WIN32_WCE
413 void perror(const char *s);
414 #endif /* _WIN32_WCE */
415
416 #endif /* CONFIG_ANSI_C_EXTRA */
417
418 #ifndef MAC2STR
419 #define MAC2STR(a) (a)[0], (a)[1], (a)[2], (a)[3], (a)[4], (a)[5]
420 #define MACSTR "%02x:%02x:%02x:%02x:%02x:%02x"
421
422 /*
423 * Compact form for string representation of MAC address
424 * To be used, e.g., for constructing dbus paths for P2P Devices
425 */
426 #define COMPACT_MACSTR "%02x%02x%02x%02x%02x%02x"
427 #endif
428
429 #ifndef BIT
430 #define BIT(x) (1U << (x))
431 #endif
432
433 /*
434 * Definitions for sparse validation
435 * (http://kernel.org/pub/linux/kernel/people/josh/sparse/)
436 */
437 #ifdef __CHECKER__
438 #define __force __attribute__((force))
439 #undef __bitwise
440 #define __bitwise __attribute__((bitwise))
441 #else
442 #define __force
443 #undef __bitwise
444 #define __bitwise
445 #endif
446
447 typedef u16 __bitwise be16;
448 typedef u16 __bitwise le16;
449 typedef u32 __bitwise be32;
450 typedef u32 __bitwise le32;
451 typedef u64 __bitwise be64;
452 typedef u64 __bitwise le64;
453
454 #ifndef __must_check
455 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
456 #define __must_check __attribute__((__warn_unused_result__))
457 #else
458 #define __must_check
459 #endif /* __GNUC__ */
460 #endif /* __must_check */
461
462 #ifndef __maybe_unused
463 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
464 #define __maybe_unused __attribute__((unused))
465 #else
466 #define __maybe_unused
467 #endif /* __GNUC__ */
468 #endif /* __must_check */
469
470 #define SSID_MAX_LEN 32
471
472 struct wpa_ssid_value {
473 u8 ssid[SSID_MAX_LEN];
474 size_t ssid_len;
475 };
476
477 int hwaddr_aton(const char *txt, u8 *addr);
478 int hwaddr_masked_aton(const char *txt, u8 *addr, u8 *mask, u8 maskable);
479 int hwaddr_compact_aton(const char *txt, u8 *addr);
480 int hwaddr_aton2(const char *txt, u8 *addr);
481 int hex2byte(const char *hex);
482 int hexstr2bin(const char *hex, u8 *buf, size_t len);
483 void inc_byte_array(u8 *counter, size_t len);
484 void buf_shift_right(u8 *buf, size_t len, size_t bits);
485 void wpa_get_ntp_timestamp(u8 *buf);
486 int wpa_scnprintf(char *buf, size_t size, const char *fmt, ...);
487 int wpa_snprintf_hex_sep(char *buf, size_t buf_size, const u8 *data, size_t len,
488 char sep);
489 int wpa_snprintf_hex(char *buf, size_t buf_size, const u8 *data, size_t len);
490 int wpa_snprintf_hex_uppercase(char *buf, size_t buf_size, const u8 *data,
491 size_t len);
492
493 int hwaddr_mask_txt(char *buf, size_t len, const u8 *addr, const u8 *mask);
494 int ssid_parse(const char *buf, struct wpa_ssid_value *ssid);
495
496 #ifdef CONFIG_NATIVE_WINDOWS
497 void wpa_unicode2ascii_inplace(TCHAR *str);
498 TCHAR * wpa_strdup_tchar(const char *str);
499 #else /* CONFIG_NATIVE_WINDOWS */
500 #define wpa_unicode2ascii_inplace(s) do { } while (0)
501 #define wpa_strdup_tchar(s) strdup((s))
502 #endif /* CONFIG_NATIVE_WINDOWS */
503
504 void printf_encode(char *txt, size_t maxlen, const u8 *data, size_t len);
505 size_t printf_decode(u8 *buf, size_t maxlen, const char *str);
506
507 const char * wpa_ssid_txt(const u8 *ssid, size_t ssid_len);
508
509 char * wpa_config_parse_string(const char *value, size_t *len);
510 int is_hex(const u8 *data, size_t len);
511 int has_ctrl_char(const u8 *data, size_t len);
512 int has_newline(const char *str);
513 size_t merge_byte_arrays(u8 *res, size_t res_len,
514 const u8 *src1, size_t src1_len,
515 const u8 *src2, size_t src2_len);
516 char * dup_binstr(const void *src, size_t len);
517
is_zero_ether_addr(const u8 * a)518 static inline int is_zero_ether_addr(const u8 *a)
519 {
520 return !(a[0] | a[1] | a[2] | a[3] | a[4] | a[5]);
521 }
522
is_broadcast_ether_addr(const u8 * a)523 static inline int is_broadcast_ether_addr(const u8 *a)
524 {
525 return (a[0] & a[1] & a[2] & a[3] & a[4] & a[5]) == 0xff;
526 }
527
is_multicast_ether_addr(const u8 * a)528 static inline int is_multicast_ether_addr(const u8 *a)
529 {
530 return a[0] & 0x01;
531 }
532
533 #define broadcast_ether_addr (const u8 *) "\xff\xff\xff\xff\xff\xff"
534
535 #include "wpa_debug.h"
536
537
538 struct wpa_freq_range_list {
539 struct wpa_freq_range {
540 unsigned int min;
541 unsigned int max;
542 } *range;
543 unsigned int num;
544 };
545
546 int freq_range_list_parse(struct wpa_freq_range_list *res, const char *value);
547 int freq_range_list_includes(const struct wpa_freq_range_list *list,
548 unsigned int freq);
549 char * freq_range_list_str(const struct wpa_freq_range_list *list);
550
551 int int_array_len(const int *a);
552 void int_array_concat(int **res, const int *a);
553 void int_array_sort_unique(int *a);
554 void int_array_add_unique(int **res, int a);
555
556 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
557
558 void str_clear_free(char *str);
559 void bin_clear_free(void *bin, size_t len);
560
561 int random_mac_addr(u8 *addr);
562 int random_mac_addr_keep_oui(u8 *addr);
563
564 const char * cstr_token(const char *str, const char *delim, const char **last);
565 char * str_token(char *str, const char *delim, char **context);
566 size_t utf8_escape(const char *inp, size_t in_size,
567 char *outp, size_t out_size);
568 size_t utf8_unescape(const char *inp, size_t in_size,
569 char *outp, size_t out_size);
570 int is_ctrl_char(char c);
571
572 int str_starts(const char *str, const char *start);
573
574 u8 rssi_to_rcpi(int rssi);
575 char * get_param(const char *cmd, const char *param);
576
577 void forced_memzero(void *ptr, size_t len);
578
579 /*
580 * gcc 4.4 ends up generating strict-aliasing warnings about some very common
581 * networking socket uses that do not really result in a real problem and
582 * cannot be easily avoided with union-based type-punning due to struct
583 * definitions including another struct in system header files. To avoid having
584 * to fully disable strict-aliasing warnings, provide a mechanism to hide the
585 * typecast from aliasing for now. A cleaner solution will hopefully be found
586 * in the future to handle these cases.
587 */
588 void * __hide_aliasing_typecast(void *foo);
589 #define aliasing_hide_typecast(a,t) (t *) __hide_aliasing_typecast((a))
590
591 #ifdef CONFIG_VALGRIND
592 #include <valgrind/memcheck.h>
593 #define WPA_MEM_DEFINED(ptr, len) VALGRIND_MAKE_MEM_DEFINED((ptr), (len))
594 #else /* CONFIG_VALGRIND */
595 #define WPA_MEM_DEFINED(ptr, len) do { } while (0)
596 #endif /* CONFIG_VALGRIND */
597
598 #endif /* COMMON_H */
599