/* types.h * * Copyright (C) 2006-2020 wolfSSL Inc. * * This file is part of wolfSSL. * * wolfSSL is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * wolfSSL 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 * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA */ /*! \file wolfssl/wolfcrypt/types.h */ /* DESCRIPTION This library defines the primitive data types and abstraction macros to decouple library dependencies with standard string, memory and so on. */ #ifndef WOLF_CRYPT_TYPES_H #define WOLF_CRYPT_TYPES_H #include #include #ifdef __cplusplus extern "C" { #endif #define WOLFSSL_ABI /* Tag for all the APIs that are a part of the fixed ABI. */ /* * This struct is used multiple time by other structs and * needs to be defined somwhere that all structs can import * (with minimal depencencies). */ #if defined(HAVE_EX_DATA) || defined(FORTRESS) typedef struct WOLFSSL_CRYPTO_EX_DATA { void* ex_data[MAX_EX_DATA]; } WOLFSSL_CRYPTO_EX_DATA; #endif #if defined(WORDS_BIGENDIAN) #define BIG_ENDIAN_ORDER #endif #ifndef BIG_ENDIAN_ORDER #define LITTLE_ENDIAN_ORDER #endif #ifndef WOLFSSL_TYPES #ifndef byte typedef unsigned char byte; typedef signed char sword8; typedef unsigned char word8; #endif #ifdef WC_16BIT_CPU typedef int sword16; typedef unsigned int word16; typedef long sword32; typedef unsigned long word32; #else typedef short sword16; typedef unsigned short word16; typedef int sword32; typedef unsigned int word32; #endif typedef byte word24[3]; #endif /* constant pointer to a constant char */ #ifdef WOLFSSL_NO_CONSTCHARCONST typedef const char* wcchar; #else typedef const char* const wcchar; #endif /* try to set SIZEOF_LONG or SIZEOF_LONG_LONG if user didn't */ #if defined(_MSC_VER) || defined(HAVE_LIMITS_H) #if !defined(SIZEOF_LONG_LONG) && !defined(SIZEOF_LONG) #include #if defined(ULONG_MAX) && (ULONG_MAX == 0xffffffffUL) #define SIZEOF_LONG 4 #endif #if defined(ULLONG_MAX) && (ULLONG_MAX == 0xffffffffffffffffULL) #define SIZEOF_LONG_LONG 8 #endif #endif #elif !defined(__BCPLUSPLUS__) && !defined(__EMSCRIPTEN__) #if !defined(SIZEOF_LONG_LONG) && !defined(SIZEOF_LONG) #if (defined(__alpha__) || defined(__ia64__) || \ defined(_ARCH_PPC64) || defined(__mips64) || \ defined(__x86_64__) || defined(__s390x__ ) || \ ((defined(sun) || defined(__sun)) && \ (defined(LP64) || defined(_LP64)))) /* long should be 64bit */ #define SIZEOF_LONG 8 #elif defined(__i386__) || defined(__CORTEX_M3__) /* long long should be 64bit */ #define SIZEOF_LONG_LONG 8 #endif #endif #endif #if defined(_MSC_VER) || defined(__BCPLUSPLUS__) #define WORD64_AVAILABLE #define W64LIT(x) x##ui64 typedef __int64 sword64; typedef unsigned __int64 word64; #elif defined(__EMSCRIPTEN__) #define WORD64_AVAILABLE #define W64LIT(x) x##ull typedef long long sword64; typedef unsigned long long word64; #elif defined(SIZEOF_LONG) && SIZEOF_LONG == 8 #define WORD64_AVAILABLE #define W64LIT(x) x##LL typedef long sword64; typedef unsigned long word64; #elif defined(SIZEOF_LONG_LONG) && SIZEOF_LONG_LONG == 8 #define WORD64_AVAILABLE #define W64LIT(x) x##LL typedef long long sword64; typedef unsigned long long word64; #elif defined(__SIZEOF_LONG_LONG__) && __SIZEOF_LONG_LONG__ == 8 #define WORD64_AVAILABLE #define W64LIT(x) x##LL typedef long long sword64; typedef unsigned long long word64; #endif #if !defined(NO_64BIT) && defined(WORD64_AVAILABLE) && !defined(WC_16BIT_CPU) /* These platforms have 64-bit CPU registers. */ #if (defined(__alpha__) || defined(__ia64__) || defined(_ARCH_PPC64) || \ defined(__mips64) || defined(__x86_64__) || defined(_M_X64)) || \ defined(__aarch64__) || defined(__sparc64__) || defined(__s390x__ ) || \ (defined(__riscv_xlen) && (__riscv_xlen == 64)) typedef word64 wolfssl_word; #define WC_64BIT_CPU #elif (defined(sun) || defined(__sun)) && \ (defined(LP64) || defined(_LP64)) /* LP64 with GNU GCC compiler is reserved for when long int is 64 bits * and int uses 32 bits. When using Solaris Studio sparc and __sparc are * available for 32 bit detection but __sparc64__ could be missed. This * uses LP64 for checking 64 bit CPU arch. */ typedef word64 wolfssl_word; #define WC_64BIT_CPU #else typedef word32 wolfssl_word; #ifdef WORD64_AVAILABLE #define WOLFCRYPT_SLOW_WORD64 #endif #define WC_32BIT_CPU #endif #elif defined(WC_16BIT_CPU) #undef WORD64_AVAILABLE typedef word16 wolfssl_word; #define MP_16BIT /* for mp_int, mp_word needs to be twice as big as mp_digit, no 64 bit type so make mp_digit 16 bit */ #else #undef WORD64_AVAILABLE typedef word32 wolfssl_word; #define MP_16BIT /* for mp_int, mp_word needs to be twice as big as mp_digit, no 64 bit type so make mp_digit 16 bit */ #define WC_32BIT_CPU #endif enum { WOLFSSL_WORD_SIZE = sizeof(wolfssl_word), WOLFSSL_BIT_SIZE = 8, WOLFSSL_WORD_BITS = WOLFSSL_WORD_SIZE * WOLFSSL_BIT_SIZE }; #define WOLFSSL_MAX_16BIT 0xffffU /* use inlining if compiler allows */ #ifndef WC_INLINE #ifndef NO_INLINE #ifdef _MSC_VER #define WC_INLINE __inline #elif defined(__GNUC__) #ifdef WOLFSSL_VXWORKS #define WC_INLINE __inline__ #else #define WC_INLINE inline #endif #elif defined(__IAR_SYSTEMS_ICC__) #define WC_INLINE inline #elif defined(THREADX) #define WC_INLINE _Inline #elif defined(__ghc__) #ifndef __cplusplus #define WC_INLINE __inline #else #define WC_INLINE inline #endif #else #define WC_INLINE #endif #else #ifdef __GNUC__ #define WC_INLINE __attribute__((unused)) #else #define WC_INLINE #endif #endif #endif #if defined(HAVE_FIPS) || defined(HAVE_SELFTEST) #define INLINE WC_INLINE #endif /* set up rotate style */ #if (defined(_MSC_VER) || defined(__BCPLUSPLUS__)) && \ !defined(WOLFSSL_SGX) && !defined(INTIME_RTOS) #define INTEL_INTRINSICS #define FAST_ROTATE #elif defined(__MWERKS__) && TARGET_CPU_PPC #define PPC_INTRINSICS #define FAST_ROTATE #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__)) /* GCC does peephole optimizations which should result in using rotate instructions */ #define FAST_ROTATE #endif /* set up thread local storage if available */ #ifdef HAVE_THREAD_LS #if defined(_MSC_VER) #define THREAD_LS_T __declspec(thread) /* Thread local storage only in FreeRTOS v8.2.1 and higher */ #elif defined(FREERTOS) || defined(FREERTOS_TCP) || \ defined(WOLFSSL_ZEPHYR) #define THREAD_LS_T #else #define THREAD_LS_T __thread #endif #else #define THREAD_LS_T #endif /* GCC 7 has new switch() fall-through detection */ /* default to FALL_THROUGH stub */ #ifndef FALL_THROUGH #define FALL_THROUGH #if defined(__GNUC__) #if ((__GNUC__ > 7) || ((__GNUC__ == 7) && (__GNUC_MINOR__ >= 1))) #undef FALL_THROUGH #if defined(WOLFSSL_LINUXKM) && defined(fallthrough) #define FALL_THROUGH fallthrough #else #define FALL_THROUGH __attribute__ ((fallthrough)); #endif #endif #endif #endif /* FALL_THROUGH */ /* Micrium will use Visual Studio for compilation but not the Win32 API */ #if defined(_WIN32) && !defined(MICRIUM) && !defined(FREERTOS) && \ !defined(FREERTOS_TCP) && !defined(EBSNET) && \ !defined(WOLFSSL_UTASKER) && !defined(INTIME_RTOS) #define USE_WINDOWS_API #endif #define XSTR_SIZEOF(x) (sizeof(x) - 1) /* -1 to not count the null char */ /* idea to add global alloc override by Moises Guimaraes */ /* default to libc stuff */ /* XREALLOC is used once in normal math lib, not in fast math lib */ /* XFREE on some embedded systems doesn't like free(0) so test */ #if defined(HAVE_IO_POOL) WOLFSSL_API void* XMALLOC(size_t n, void* heap, int type); WOLFSSL_API void* XREALLOC(void *p, size_t n, void* heap, int type); WOLFSSL_API void XFREE(void *p, void* heap, int type); #elif (defined(WOLFSSL_ASYNC_CRYPT) && defined(HAVE_INTEL_QA)) || \ defined(HAVE_INTEL_QA_SYNC) #ifndef HAVE_INTEL_QA_SYNC #include #undef USE_WOLFSSL_MEMORY #ifdef WOLFSSL_DEBUG_MEMORY #define XMALLOC(s, h, t) IntelQaMalloc((s), (h), (t), __func__, __LINE__) #define XFREE(p, h, t) IntelQaFree((p), (h), (t), __func__, __LINE__) #define XREALLOC(p, n, h, t) IntelQaRealloc((p), (n), (h), (t), __func__, __LINE__) #else #define XMALLOC(s, h, t) IntelQaMalloc((s), (h), (t)) #define XFREE(p, h, t) IntelQaFree((p), (h), (t)) #define XREALLOC(p, n, h, t) IntelQaRealloc((p), (n), (h), (t)) #endif /* WOLFSSL_DEBUG_MEMORY */ #else #include #undef USE_WOLFSSL_MEMORY #ifdef WOLFSSL_DEBUG_MEMORY #define XMALLOC(s, h, t) wc_CryptoCb_IntelQaMalloc((s), (h), (t), __func__, __LINE__) #define XFREE(p, h, t) wc_CryptoCb_IntelQaFree((p), (h), (t), __func__, __LINE__) #define XREALLOC(p, n, h, t) wc_CryptoCb_IntelQaRealloc((p), (n), (h), (t), __func__, __LINE__) #else #define XMALLOC(s, h, t) wc_CryptoCb_IntelQaMalloc((s), (h), (t)) #define XFREE(p, h, t) wc_CryptoCb_IntelQaFree((p), (h), (t)) #define XREALLOC(p, n, h, t) wc_CryptoCb_IntelQaRealloc((p), (n), (h), (t)) #endif /* WOLFSSL_DEBUG_MEMORY */ #endif #elif defined(XMALLOC_USER) /* prototypes for user heap override functions */ #include /* for size_t */ extern void *XMALLOC(size_t n, void* heap, int type); extern void *XREALLOC(void *p, size_t n, void* heap, int type); extern void XFREE(void *p, void* heap, int type); #elif defined(WOLFSSL_MEMORY_LOG) #define XMALLOC(n, h, t) xmalloc(n, h, t, __func__, __FILE__, __LINE__) #define XREALLOC(p, n, h, t) xrealloc(p, n, h, t, __func__, __FILE__, __LINE__) #define XFREE(p, h, t) xfree(p, h, t, __func__, __FILE__, __LINE__) /* prototypes for user heap override functions */ #include /* for size_t */ #include WOLFSSL_API void *xmalloc(size_t n, void* heap, int type, const char* func, const char* file, unsigned int line); WOLFSSL_API void *xrealloc(void *p, size_t n, void* heap, int type, const char* func, const char* file, unsigned int line); WOLFSSL_API void xfree(void *p, void* heap, int type, const char* func, const char* file, unsigned int line); #elif defined(XMALLOC_OVERRIDE) /* override the XMALLOC, XFREE and XREALLOC macros */ #elif defined(WOLFSSL_TELIT_M2MB) /* Telit M2MB SDK requires use m2mb_os API's, not std malloc/free */ /* Use of malloc/free will cause CPU reboot */ #define XMALLOC(s, h, t) ((void)h, (void)t, m2mb_os_malloc((s))) #define XFREE(p, h, t) {void* xp = (p); if((xp)) m2mb_os_free((xp));} #define XREALLOC(p, n, h, t) m2mb_os_realloc((p), (n)) #elif defined(NO_WOLFSSL_MEMORY) #ifdef WOLFSSL_NO_MALLOC /* this platform does not support heap use */ #ifdef WOLFSSL_MALLOC_CHECK #include static inline void* malloc_check(size_t sz) { printf("wolfSSL_malloc failed"); return NULL; }; #define XMALLOC(s, h, t) malloc_check((s)) #define XFREE(p, h, t) #define XREALLOC(p, n, h, t) (NULL) #else #define XMALLOC(s, h, t) (NULL) #define XFREE(p, h, t) #define XREALLOC(p, n, h, t) (NULL) #endif #else /* just use plain C stdlib stuff if desired */ #include #define XMALLOC(s, h, t) malloc((size_t)(s)) #define XFREE(p, h, t) {void* xp = (p); if((xp)) free((xp));} #define XREALLOC(p, n, h, t) realloc((p), (size_t)(n)) #endif #elif defined(WOLFSSL_LINUXKM) /* the requisite linux/slab.h is included in wc_port.h, with incompatible warnings masked out. */ #define XMALLOC(s, h, t) ({(void)(h); (void)(t); kmalloc(s, GFP_KERNEL);}) #define XFREE(p, h, t) ({void* _xp; (void)(h); _xp = (p); if(_xp) kfree(_xp);}) #define XREALLOC(p, n, h, t) ({(void)(h); (void)(t); krealloc((p), (n), GFP_KERNEL);}) #elif !defined(MICRIUM_MALLOC) && !defined(EBSNET) \ && !defined(WOLFSSL_SAFERTOS) && !defined(FREESCALE_MQX) \ && !defined(FREESCALE_KSDK_MQX) && !defined(FREESCALE_FREE_RTOS) \ && !defined(WOLFSSL_LEANPSK) && !defined(WOLFSSL_uITRON4) /* default C runtime, can install different routines at runtime via cbs */ #include #ifdef WOLFSSL_STATIC_MEMORY #ifdef WOLFSSL_DEBUG_MEMORY #define XMALLOC(s, h, t) wolfSSL_Malloc((s), (h), (t), __func__, __LINE__) #define XFREE(p, h, t) {void* xp = (p); if((xp)) wolfSSL_Free((xp), (h), (t), __func__, __LINE__);} #define XREALLOC(p, n, h, t) wolfSSL_Realloc((p), (n), (h), (t), __func__, __LINE__) #else #define XMALLOC(s, h, t) wolfSSL_Malloc((s), (h), (t)) #define XFREE(p, h, t) {void* xp = (p); if((xp)) wolfSSL_Free((xp), (h), (t));} #define XREALLOC(p, n, h, t) wolfSSL_Realloc((p), (n), (h), (t)) #endif /* WOLFSSL_DEBUG_MEMORY */ #elif !defined(FREERTOS) && !defined(FREERTOS_TCP) #ifdef WOLFSSL_DEBUG_MEMORY #define XMALLOC(s, h, t) ((void)h, (void)t, wolfSSL_Malloc((s), __func__, __LINE__)) #define XFREE(p, h, t) {void* xp = (p); if((xp)) wolfSSL_Free((xp), __func__, __LINE__);} #define XREALLOC(p, n, h, t) wolfSSL_Realloc((p), (n), __func__, __LINE__) #else #define XMALLOC(s, h, t) ((void)h, (void)t, wolfSSL_Malloc((s))) #define XFREE(p, h, t) {void* xp = (p); if((xp)) wolfSSL_Free((xp));} #define XREALLOC(p, n, h, t) wolfSSL_Realloc((p), (n)) #endif /* WOLFSSL_DEBUG_MEMORY */ #endif /* WOLFSSL_STATIC_MEMORY */ #endif /* declare/free variable handling for async and smallstack */ #if defined(WOLFSSL_ASYNC_CRYPT) || defined(WOLFSSL_SMALL_STACK) #define DECLARE_VAR_IS_HEAP_ALLOC #define DECLARE_VAR(VAR_NAME, VAR_TYPE, VAR_SIZE, HEAP) \ VAR_TYPE* VAR_NAME = (VAR_TYPE*)XMALLOC(sizeof(VAR_TYPE) * VAR_SIZE, (HEAP), DYNAMIC_TYPE_WOLF_BIGINT) #define DECLARE_ARRAY(VAR_NAME, VAR_TYPE, VAR_ITEMS, VAR_SIZE, HEAP) \ VAR_TYPE* VAR_NAME[VAR_ITEMS]; \ int idx##VAR_NAME, inner_idx_##VAR_NAME; \ for (idx##VAR_NAME=0; idx##VAR_NAME #else #include #endif #define XMEMCPY(d,s,l) memcpy((d),(s),(l)) #define XMEMSET(b,c,l) memset((b),(c),(l)) #define XMEMCMP(s1,s2,n) memcmp((s1),(s2),(n)) #define XMEMMOVE(d,s,l) memmove((d),(s),(l)) #define XSTRLEN(s1) strlen((s1)) #define XSTRNCPY(s1,s2,n) strncpy((s1),(s2),(n)) /* strstr, strncmp, strcmp, and strncat only used by wolfSSL proper, * not required for wolfCrypt only */ #define XSTRSTR(s1,s2) strstr((s1),(s2)) #define XSTRNSTR(s1,s2,n) mystrnstr((s1),(s2),(n)) #define XSTRNCMP(s1,s2,n) strncmp((s1),(s2),(n)) #define XSTRCMP(s1,s2) strcmp((s1),(s2)) #define XSTRNCAT(s1,s2,n) strncat((s1),(s2),(n)) #ifdef USE_WOLF_STRSEP #define XSTRSEP(s1,d) wc_strsep((s1),(d)) #else #define XSTRSEP(s1,d) strsep((s1),(d)) #endif #ifndef XSTRNCASECMP #if defined(MICROCHIP_PIC32) || defined(WOLFSSL_TIRTOS) || \ defined(WOLFSSL_ZEPHYR) /* XC32 does not support strncasecmp, so use case sensitive one */ #define XSTRNCASECMP(s1,s2,n) strncmp((s1),(s2),(n)) #elif defined(USE_WINDOWS_API) || defined(FREERTOS_TCP_WINSIM) #define XSTRNCASECMP(s1,s2,n) _strnicmp((s1),(s2),(n)) #else #if defined(HAVE_STRINGS_H) && defined(WOLF_C99) && \ !defined(WOLFSSL_SGX) #include #endif #if defined(WOLFSSL_DEOS) #define XSTRNCASECMP(s1,s2,n) strnicmp((s1),(s2),(n)) #elif defined(WOLFSSL_CMSIS_RTOSv2) #define XSTRNCASECMP(s1,s2,n) strncmp((s1),(s2),(n)) #else #define XSTRNCASECMP(s1,s2,n) strncasecmp((s1),(s2),(n)) #endif #endif #endif /* !XSTRNCASECMP */ /* snprintf is used in asn.c for GetTimeString, PKCS7 test, and when debugging is turned on */ #ifndef USE_WINDOWS_API #ifndef XSNPRINTF #if defined(NO_FILESYSTEM) && (defined(OPENSSL_EXTRA) || \ defined(HAVE_PKCS7)) && !defined(NO_STDIO_FILESYSTEM) /* case where stdio is not included else where but is needed for snprintf */ #include #endif #if defined(WOLFSSL_ESPIDF) && \ (!defined(NO_ASN_TIME) && defined(HAVE_PKCS7)) #include /* later gcc than 7.1 introduces -Wformat-truncation */ /* In cases when truncation is expected the caller needs*/ /* to check the return value from the function so that */ /* compiler doesn't complain. */ /* xtensa-esp32-elf v8.2.0 warns trancation at */ /* GetAsnTimeString() */ static WC_INLINE int _xsnprintf_(char *s, size_t n, const char *format, ...) { va_list ap; int ret; if ((int)n <= 0) return -1; va_start(ap, format); ret = vsnprintf(s, n, format, ap); if (ret < 0) ret = -1; va_end(ap); return ret; } #define XSNPRINTF _xsnprintf_ #else #define XSNPRINTF snprintf #endif #endif #else #if defined(_MSC_VER) || defined(__CYGWIN__) || defined(__MINGW32__) #if defined(_MSC_VER) && (_MSC_VER >= 1900) /* Beginning with the UCRT in Visual Studio 2015 and Windows 10, snprintf is no longer identical to _snprintf. The snprintf function behavior is now C99 standard compliant. */ #include #define XSNPRINTF snprintf #else /* 4996 warning to use MS extensions e.g., _sprintf_s instead of _snprintf */ #if !defined(__MINGW32__) #pragma warning(disable: 4996) #endif static WC_INLINE int xsnprintf(char *buffer, size_t bufsize, const char *format, ...) { va_list ap; int ret; if ((int)bufsize <= 0) return -1; va_start(ap, format); ret = vsnprintf(buffer, bufsize, format, ap); if (ret >= (int)bufsize) ret = -1; va_end(ap); return ret; } #define XSNPRINTF xsnprintf #endif /* (_MSC_VER >= 1900) */ #else #define XSNPRINTF snprintf #endif /* _MSC_VER */ #endif /* USE_WINDOWS_API */ #if defined(WOLFSSL_CERT_EXT) || defined(OPENSSL_EXTRA) \ || defined(HAVE_ALPN) /* use only Thread Safe version of strtok */ #if defined(USE_WOLF_STRTOK) #define XSTRTOK(s1,d,ptr) wc_strtok((s1),(d),(ptr)) #elif defined(USE_WINDOWS_API) || defined(INTIME_RTOS) #define XSTRTOK(s1,d,ptr) strtok_s((s1),(d),(ptr)) #else #define XSTRTOK(s1,d,ptr) strtok_r((s1),(d),(ptr)) #endif #endif #if defined(WOLFSSL_CERT_EXT) || defined(HAVE_OCSP) || \ defined(HAVE_CRL_IO) || defined(HAVE_HTTP_CLIENT) || \ !defined(NO_CRYPT_BENCHMARK) #ifndef XATOI /* if custom XATOI is not already defined */ #include #define XATOI(s) atoi((s)) #endif #endif #endif #ifdef USE_WOLF_STRTOK WOLFSSL_API char* wc_strtok(char *str, const char *delim, char **nextp); #endif #ifdef USE_WOLF_STRSEP WOLFSSL_API char* wc_strsep(char **stringp, const char *delim); #endif #if !defined(NO_FILESYSTEM) && defined(OPENSSL_EXTRA) && \ !defined(NO_STDIO_FILESYSTEM) #ifndef XGETENV #include #define XGETENV getenv #endif #endif /* OPENSSL_EXTRA */ #ifndef CTYPE_USER #ifndef WOLFSSL_LINUXKM #include #endif #if defined(HAVE_ECC) || defined(HAVE_OCSP) || \ defined(WOLFSSL_KEY_GEN) || !defined(NO_DSA) || \ defined(OPENSSL_EXTRA) #define XTOUPPER(c) toupper((c)) #endif #ifdef OPENSSL_ALL #define XISALNUM(c) isalnum((c)) #endif /* needed by wolfSSL_check_domain_name() */ #define XTOLOWER(c) tolower((c)) #endif /* memory allocation types for user hints */ enum { DYNAMIC_TYPE_CA = 1, DYNAMIC_TYPE_CERT = 2, DYNAMIC_TYPE_KEY = 3, DYNAMIC_TYPE_FILE = 4, DYNAMIC_TYPE_SUBJECT_CN = 5, DYNAMIC_TYPE_PUBLIC_KEY = 6, DYNAMIC_TYPE_SIGNER = 7, DYNAMIC_TYPE_NONE = 8, DYNAMIC_TYPE_BIGINT = 9, DYNAMIC_TYPE_RSA = 10, DYNAMIC_TYPE_METHOD = 11, DYNAMIC_TYPE_OUT_BUFFER = 12, DYNAMIC_TYPE_IN_BUFFER = 13, DYNAMIC_TYPE_INFO = 14, DYNAMIC_TYPE_DH = 15, DYNAMIC_TYPE_DOMAIN = 16, DYNAMIC_TYPE_SSL = 17, DYNAMIC_TYPE_CTX = 18, DYNAMIC_TYPE_WRITEV = 19, DYNAMIC_TYPE_OPENSSL = 20, DYNAMIC_TYPE_DSA = 21, DYNAMIC_TYPE_CRL = 22, DYNAMIC_TYPE_REVOKED = 23, DYNAMIC_TYPE_CRL_ENTRY = 24, DYNAMIC_TYPE_CERT_MANAGER = 25, DYNAMIC_TYPE_CRL_MONITOR = 26, DYNAMIC_TYPE_OCSP_STATUS = 27, DYNAMIC_TYPE_OCSP_ENTRY = 28, DYNAMIC_TYPE_ALTNAME = 29, DYNAMIC_TYPE_SUITES = 30, DYNAMIC_TYPE_CIPHER = 31, DYNAMIC_TYPE_RNG = 32, DYNAMIC_TYPE_ARRAYS = 33, DYNAMIC_TYPE_DTLS_POOL = 34, DYNAMIC_TYPE_SOCKADDR = 35, DYNAMIC_TYPE_LIBZ = 36, DYNAMIC_TYPE_ECC = 37, DYNAMIC_TYPE_TMP_BUFFER = 38, DYNAMIC_TYPE_DTLS_MSG = 39, DYNAMIC_TYPE_X509 = 40, DYNAMIC_TYPE_TLSX = 41, DYNAMIC_TYPE_OCSP = 42, DYNAMIC_TYPE_SIGNATURE = 43, DYNAMIC_TYPE_HASHES = 44, DYNAMIC_TYPE_SRP = 45, DYNAMIC_TYPE_COOKIE_PWD = 46, DYNAMIC_TYPE_USER_CRYPTO = 47, DYNAMIC_TYPE_OCSP_REQUEST = 48, DYNAMIC_TYPE_X509_EXT = 49, DYNAMIC_TYPE_X509_STORE = 50, DYNAMIC_TYPE_X509_CTX = 51, DYNAMIC_TYPE_URL = 52, DYNAMIC_TYPE_DTLS_FRAG = 53, DYNAMIC_TYPE_DTLS_BUFFER = 54, DYNAMIC_TYPE_SESSION_TICK = 55, DYNAMIC_TYPE_PKCS = 56, DYNAMIC_TYPE_MUTEX = 57, DYNAMIC_TYPE_PKCS7 = 58, DYNAMIC_TYPE_AES_BUFFER = 59, DYNAMIC_TYPE_WOLF_BIGINT = 60, DYNAMIC_TYPE_ASN1 = 61, DYNAMIC_TYPE_LOG = 62, DYNAMIC_TYPE_WRITEDUP = 63, DYNAMIC_TYPE_PRIVATE_KEY = 64, DYNAMIC_TYPE_HMAC = 65, DYNAMIC_TYPE_ASYNC = 66, DYNAMIC_TYPE_ASYNC_NUMA = 67, DYNAMIC_TYPE_ASYNC_NUMA64 = 68, DYNAMIC_TYPE_CURVE25519 = 69, DYNAMIC_TYPE_ED25519 = 70, DYNAMIC_TYPE_SECRET = 71, DYNAMIC_TYPE_DIGEST = 72, DYNAMIC_TYPE_RSA_BUFFER = 73, DYNAMIC_TYPE_DCERT = 74, DYNAMIC_TYPE_STRING = 75, DYNAMIC_TYPE_PEM = 76, DYNAMIC_TYPE_DER = 77, DYNAMIC_TYPE_CERT_EXT = 78, DYNAMIC_TYPE_ALPN = 79, DYNAMIC_TYPE_ENCRYPTEDINFO= 80, DYNAMIC_TYPE_DIRCTX = 81, DYNAMIC_TYPE_HASHCTX = 82, DYNAMIC_TYPE_SEED = 83, DYNAMIC_TYPE_SYMMETRIC_KEY= 84, DYNAMIC_TYPE_ECC_BUFFER = 85, DYNAMIC_TYPE_QSH = 86, DYNAMIC_TYPE_SALT = 87, DYNAMIC_TYPE_HASH_TMP = 88, DYNAMIC_TYPE_BLOB = 89, DYNAMIC_TYPE_NAME_ENTRY = 90, DYNAMIC_TYPE_CURVE448 = 91, DYNAMIC_TYPE_ED448 = 92, DYNAMIC_TYPE_AES = 93, DYNAMIC_TYPE_CMAC = 94, DYNAMIC_TYPE_SNIFFER_SERVER = 1000, DYNAMIC_TYPE_SNIFFER_SESSION = 1001, DYNAMIC_TYPE_SNIFFER_PB = 1002, DYNAMIC_TYPE_SNIFFER_PB_BUFFER = 1003, DYNAMIC_TYPE_SNIFFER_TICKET_ID = 1004, DYNAMIC_TYPE_SNIFFER_NAMED_KEY = 1005, }; /* max error buffer string size */ #ifndef WOLFSSL_MAX_ERROR_SZ #define WOLFSSL_MAX_ERROR_SZ 80 #endif /* stack protection */ enum { MIN_STACK_BUFFER = 8 }; /* Algorithm Types */ enum wc_AlgoType { WC_ALGO_TYPE_NONE = 0, WC_ALGO_TYPE_HASH = 1, WC_ALGO_TYPE_CIPHER = 2, WC_ALGO_TYPE_PK = 3, WC_ALGO_TYPE_RNG = 4, WC_ALGO_TYPE_SEED = 5, WC_ALGO_TYPE_HMAC = 6, WC_ALGO_TYPE_MAX = WC_ALGO_TYPE_HMAC }; /* hash types */ enum wc_HashType { #if defined(HAVE_SELFTEST) || defined(HAVE_FIPS) && \ (defined(HAVE_FIPS_VERSION) && (HAVE_FIPS_VERSION <= 2)) /* In selftest build, WC_* types are not mapped to WC_HASH_TYPE types. * Values here are based on old selftest hmac.h enum, with additions. * These values are fixed for backwards FIPS compatibility */ WC_HASH_TYPE_NONE = 15, WC_HASH_TYPE_MD2 = 16, WC_HASH_TYPE_MD4 = 17, WC_HASH_TYPE_MD5 = 0, WC_HASH_TYPE_SHA = 1, /* SHA-1 (not old SHA-0) */ WC_HASH_TYPE_SHA224 = 8, WC_HASH_TYPE_SHA256 = 2, WC_HASH_TYPE_SHA384 = 5, WC_HASH_TYPE_SHA512 = 4, WC_HASH_TYPE_MD5_SHA = 18, WC_HASH_TYPE_SHA3_224 = 10, WC_HASH_TYPE_SHA3_256 = 11, WC_HASH_TYPE_SHA3_384 = 12, WC_HASH_TYPE_SHA3_512 = 13, WC_HASH_TYPE_BLAKE2B = 14, WC_HASH_TYPE_BLAKE2S = 19, WC_HASH_TYPE_MAX = WC_HASH_TYPE_BLAKE2S #else WC_HASH_TYPE_NONE = 0, WC_HASH_TYPE_MD2 = 1, WC_HASH_TYPE_MD4 = 2, WC_HASH_TYPE_MD5 = 3, WC_HASH_TYPE_SHA = 4, /* SHA-1 (not old SHA-0) */ WC_HASH_TYPE_SHA224 = 5, WC_HASH_TYPE_SHA256 = 6, WC_HASH_TYPE_SHA384 = 7, WC_HASH_TYPE_SHA512 = 8, WC_HASH_TYPE_MD5_SHA = 9, WC_HASH_TYPE_SHA3_224 = 10, WC_HASH_TYPE_SHA3_256 = 11, WC_HASH_TYPE_SHA3_384 = 12, WC_HASH_TYPE_SHA3_512 = 13, WC_HASH_TYPE_BLAKE2B = 14, WC_HASH_TYPE_BLAKE2S = 15, WC_HASH_TYPE_MAX = WC_HASH_TYPE_BLAKE2S #endif /* HAVE_SELFTEST */ }; /* cipher types */ enum wc_CipherType { WC_CIPHER_NONE = 0, WC_CIPHER_AES = 1, WC_CIPHER_AES_CBC = 2, WC_CIPHER_AES_GCM = 3, WC_CIPHER_AES_CTR = 4, WC_CIPHER_AES_XTS = 5, WC_CIPHER_AES_CFB = 6, WC_CIPHER_DES3 = 7, WC_CIPHER_DES = 8, WC_CIPHER_CHACHA = 9, WC_CIPHER_HC128 = 10, WC_CIPHER_IDEA = 11, WC_CIPHER_MAX = WC_CIPHER_HC128 }; /* PK=public key (asymmetric) based algorithms */ enum wc_PkType { WC_PK_TYPE_NONE = 0, WC_PK_TYPE_RSA = 1, WC_PK_TYPE_DH = 2, WC_PK_TYPE_ECDH = 3, WC_PK_TYPE_ECDSA_SIGN = 4, WC_PK_TYPE_ECDSA_VERIFY = 5, WC_PK_TYPE_ED25519 = 6, WC_PK_TYPE_CURVE25519 = 7, WC_PK_TYPE_RSA_KEYGEN = 8, WC_PK_TYPE_EC_KEYGEN = 9, WC_PK_TYPE_RSA_CHECK_PRIV_KEY = 10, WC_PK_TYPE_EC_CHECK_PRIV_KEY = 11, WC_PK_TYPE_MAX = WC_PK_TYPE_EC_CHECK_PRIV_KEY }; /* settings detection for compile vs runtime math incompatibilities */ enum { #if !defined(USE_FAST_MATH) && !defined(SIZEOF_LONG) && !defined(SIZEOF_LONG_LONG) CTC_SETTINGS = 0x0 #elif !defined(USE_FAST_MATH) && defined(SIZEOF_LONG) && (SIZEOF_LONG == 8) CTC_SETTINGS = 0x1 #elif !defined(USE_FAST_MATH) && defined(SIZEOF_LONG_LONG) && (SIZEOF_LONG_LONG == 8) CTC_SETTINGS = 0x2 #elif !defined(USE_FAST_MATH) && defined(SIZEOF_LONG_LONG) && (SIZEOF_LONG_LONG == 4) CTC_SETTINGS = 0x4 #elif defined(USE_FAST_MATH) && !defined(SIZEOF_LONG) && !defined(SIZEOF_LONG_LONG) CTC_SETTINGS = 0x8 #elif defined(USE_FAST_MATH) && defined(SIZEOF_LONG) && (SIZEOF_LONG == 8) CTC_SETTINGS = 0x10 #elif defined(USE_FAST_MATH) && defined(SIZEOF_LONG_LONG) && (SIZEOF_LONG_LONG == 8) CTC_SETTINGS = 0x20 #elif defined(USE_FAST_MATH) && defined(SIZEOF_LONG_LONG) && (SIZEOF_LONG_LONG == 4) CTC_SETTINGS = 0x40 #else #error "bad math long / long long settings" #endif }; WOLFSSL_API word32 CheckRunTimeSettings(void); /* If user uses RSA, DH, DSA, or ECC math lib directly then fast math and long types need to match at compile time and run time, CheckCtcSettings will return 1 if a match otherwise 0 */ #define CheckCtcSettings() (CTC_SETTINGS == CheckRunTimeSettings()) /* invalid device id */ #define INVALID_DEVID -2 /* AESNI requires alignment and ARMASM gains some performance from it * Xilinx RSA operations require alignment */ #if defined(WOLFSSL_AESNI) || defined(WOLFSSL_ARMASM) || \ defined(USE_INTEL_SPEEDUP) || defined(WOLFSSL_AFALG_XILINX) #if !defined(ALIGN16) #if defined(__IAR_SYSTEMS_ICC__) || defined(__GNUC__) #define ALIGN16 __attribute__ ( (aligned (16))) #elif defined(_MSC_VER) /* disable align warning, we want alignment ! */ #pragma warning(disable: 4324) #define ALIGN16 __declspec (align (16)) #else #define ALIGN16 #endif #endif /* !ALIGN16 */ #if !defined (ALIGN32) #if defined(__IAR_SYSTEMS_ICC__) || defined(__GNUC__) #define ALIGN32 __attribute__ ( (aligned (32))) #elif defined(_MSC_VER) /* disable align warning, we want alignment ! */ #pragma warning(disable: 4324) #define ALIGN32 __declspec (align (32)) #else #define ALIGN32 #endif #endif /* !ALIGN32 */ #if !defined(ALIGN64) #if defined(__IAR_SYSTEMS_ICC__) || defined(__GNUC__) #define ALIGN64 __attribute__ ( (aligned (64))) #elif defined(_MSC_VER) /* disable align warning, we want alignment ! */ #pragma warning(disable: 4324) #define ALIGN64 __declspec (align (64)) #else #define ALIGN64 #endif #endif /* !ALIGN64 */ #if defined(__IAR_SYSTEMS_ICC__) || defined(__GNUC__) #define ALIGN128 __attribute__ ( (aligned (128))) #elif defined(_MSC_VER) /* disable align warning, we want alignment ! */ #pragma warning(disable: 4324) #define ALIGN128 __declspec (align (128)) #else #define ALIGN128 #endif #if defined(__IAR_SYSTEMS_ICC__) || defined(__GNUC__) #define ALIGN256 __attribute__ ( (aligned (256))) #elif defined(_MSC_VER) /* disable align warning, we want alignment ! */ #pragma warning(disable: 4324) #define ALIGN256 __declspec (align (256)) #else #define ALIGN256 #endif #else #ifndef ALIGN16 #define ALIGN16 #endif #ifndef ALIGN32 #define ALIGN32 #endif #ifndef ALIGN64 #define ALIGN64 #endif #ifndef ALIGN128 #define ALIGN128 #endif #ifndef ALIGN256 #define ALIGN256 #endif #endif /* WOLFSSL_AESNI || WOLFSSL_ARMASM */ #ifndef TRUE #define TRUE 1 #endif #ifndef FALSE #define FALSE 0 #endif #if defined(HAVE_STACK_SIZE) #define EXIT_TEST(ret) return (void*)((size_t)(ret)) #else #define EXIT_TEST(ret) return ret #endif #if (defined(__IAR_SYSTEMS_ICC__) && (__IAR_SYSTEMS_ICC__ > 8)) || \ defined(__GNUC__) #define WOLFSSL_PACK __attribute__ ((packed)) #else #define WOLFSSL_PACK #endif #ifndef __GNUC_PREREQ #if defined(__GNUC__) && defined(__GNUC_MINOR__) #define __GNUC_PREREQ(maj, min) \ ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min)) #else #define __GNUC_PREREQ(maj, min) (0) /* not GNUC */ #endif #endif #if defined(__IAR_SYSTEMS_ICC__) || defined(__GNUC__) #define WC_NORETURN __attribute__((noreturn)) #else #define WC_NORETURN #endif #if defined(WOLFSSL_KEY_GEN) || defined(HAVE_COMP_KEY) || \ defined(WOLFSSL_DEBUG_MATH) || defined(DEBUG_WOLFSSL) || \ defined(WOLFSSL_PUBLIC_MP) || defined(OPENSSL_EXTRA) || \ (defined(HAVE_ECC) && defined(HAVE_ECC_KEY_EXPORT)) #undef WC_MP_TO_RADIX #define WC_MP_TO_RADIX #endif #ifdef __cplusplus } /* extern "C" */ #endif #endif /* WOLF_CRYPT_TYPES_H */