libeap/src/utils/common.h

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