/* wc_port.h * * Copyright (C) 2006-2025 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 3 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/wc_port.h */ #ifndef WOLF_CRYPT_PORT_H #define WOLF_CRYPT_PORT_H #include #include #ifdef __cplusplus extern "C" { #endif /* Detect if compiler supports C99. "NO_WOLF_C99" can be defined in * user_settings.h to disable checking for C99 support. */ #if !defined(WOLF_C99) && defined(__STDC_VERSION__) && \ !defined(WOLFSSL_ARDUINO) && !defined(NO_WOLF_C99) #if __STDC_VERSION__ >= 199901L #define WOLF_C99 #endif #endif /* GENERIC INCLUDE SECTION */ #if defined(FREESCALE_MQX) || defined(FREESCALE_KSDK_MQX) #include #if (defined(MQX_USE_IO_OLD) && MQX_USE_IO_OLD) || \ defined(FREESCALE_MQX_5_0) #include #else #include #endif #endif #if defined(WOLFSSL_MAX3266X) || defined(WOLFSSL_MAX3266X_OLD) #include #endif #ifdef WOLFSSL_LINUXKM #include "../../linuxkm/linuxkm_wc_port.h" #elif defined(WOLFSSL_BSDKM) #include "../../bsdkm/bsdkm_wc_port.h" #endif /* WOLFSSL_LINUXKM */ #ifndef WARN_UNUSED_RESULT #if defined(WOLFSSL_LINUXKM) && defined(__must_check) #define WARN_UNUSED_RESULT __must_check #elif (defined(__GNUC__) && (__GNUC__ >= 4)) || \ (defined(__IAR_SYSTEMS_ICC__) && (__VER__ >= 9040001)) #define WARN_UNUSED_RESULT __attribute__((warn_unused_result)) #else #define WARN_UNUSED_RESULT #endif #endif /* !WARN_UNUSED_RESULT */ #ifndef WC_MAYBE_UNUSED #if (defined(__GNUC__) && (__GNUC__ >= 4)) || defined(__clang__) || \ defined(__IAR_SYSTEMS_ICC__) #define WC_MAYBE_UNUSED __attribute__((unused)) #else #define WC_MAYBE_UNUSED #endif #endif /* !WC_MAYBE_UNUSED */ #ifndef WC_DEPRECATED #ifdef WOLFSSL_ZEPHYR #define WC_DEPRECATED(msg) /* null expansion */ #elif ((defined(__GNUC__) && \ ((__GNUC__ >= 5) || \ ((__GNUC__ == 4) && (__GNUC_MINOR__ > 5))))) || \ defined(__clang__) #define WC_DEPRECATED(msg) __attribute__((deprecated(msg))) #elif defined(__WATCOMC__) /* Watcom macro needs to expand to something, here just a comment: */ #define WC_DEPRECATED(msg) /* null expansion */ #elif defined(_MSC_VER) || defined(__MINGW32__) || defined(__CYGWIN__) || \ defined(_WIN32_WCE) #define WC_DEPRECATED(msg) __declspec(deprecated(msg)) #elif (defined(__GNUC__) && (__GNUC__ >= 4)) || \ defined(__IAR_SYSTEMS_ICC__) #define WC_DEPRECATED(msg) __attribute__((deprecated)) #else #define WC_DEPRECATED(msg) /* null expansion */ #endif #endif /* !WC_MAYBE_UNUSED */ /* 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 #elif defined(__CCRX__) #define WC_INLINE inline #elif defined(__DCC__) #ifndef __cplusplus #define WC_INLINE __inline__ #else #define WC_INLINE inline #endif #else #define WC_INLINE WC_MAYBE_UNUSED #endif #else #define WC_INLINE WC_MAYBE_UNUSED #endif #endif #ifndef WC_OMIT_FRAME_POINTER #if defined(__GNUC__) #define WC_OMIT_FRAME_POINTER \ __attribute__((optimize("-fomit-frame-pointer"))) #else #define WC_OMIT_FRAME_POINTER #endif #endif /* THREADING/MUTEX SECTION */ #if defined(SINGLE_THREADED) && defined(NO_FILESYSTEM) /* No system headers required for build. */ #elif defined(__WATCOMC__) #if defined(SINGLE_THREADED) #if defined(USE_WINDOWS_API) #define _WINSOCKAPI_ /* block inclusion of winsock.h header file */ #include #undef _WINSOCKAPI_ /* undefine it for MINGW winsock2.h header */ #ifndef WOLFSSL_USER_IO #include #include /* required for InetPton */ #endif #elif defined(__OS2__) #include #endif #else #if defined(USE_WINDOWS_API) #define _WINSOCKAPI_ /* block inclusion of winsock.h header file */ #include #undef _WINSOCKAPI_ /* undefine it for MINGW winsock2.h header */ #include #ifndef WOLFSSL_USER_IO #include #include /* required for InetPton */ #endif #elif defined(__NT__) #define _WINSOCKAPI_ /* block inclusion of winsock.h header file */ #include #undef _WINSOCKAPI_ /* undefine it for MINGW winsock2.h header file */ #elif defined(__OS2__) #define INCL_DOSSEMAPHORES #define INCL_DOSPROCESS #include #include #else #ifndef WOLFSSL_USER_MUTEX #define WOLFSSL_PTHREADS #endif #if defined(WOLFSSL_PTHREADS) #include #endif #endif #endif #elif defined(USE_WINDOWS_API) #if defined(WOLFSSL_PTHREADS) #include #endif #ifdef WOLFSSL_GAME_BUILD #include "system/xtl.h" #else #ifndef WIN32_LEAN_AND_MEAN #define WIN32_LEAN_AND_MEAN #endif #if !defined(WOLFSSL_SGX) && !defined(WOLFSSL_NOT_WINDOWS_API) #define _WINSOCKAPI_ /* block inclusion of winsock.h header file. */ #include #undef _WINSOCKAPI_ /* undefine it for MINGW winsock2.h header */ #ifndef WOLFSSL_USER_IO #include #include /* required for InetPton */ #endif #endif /* WOLFSSL_SGX */ #endif #if !defined(SINGLE_THREADED) && !defined(_WIN32_WCE) #include #endif #elif defined(THREADX) #ifndef SINGLE_THREADED #ifdef NEED_THREADX_TYPES #include #endif #include #endif #elif defined(WOLFSSL_DEOS) #include "mutexapi.h" #elif defined(MICRIUM) /* do nothing, just don't pick Unix */ #elif defined(FREERTOS) || defined(FREERTOS_TCP) || defined(WOLFSSL_SAFERTOS) /* do nothing */ #elif defined(RTTHREAD) /* do nothing */ #elif defined(EBSNET) /* do nothing */ #elif defined(FREESCALE_MQX) || defined(FREESCALE_KSDK_MQX) /* do nothing */ #elif defined(FREESCALE_FREE_RTOS) #include "fsl_os_abstraction.h" #elif defined(WOLFSSL_VXWORKS) #include #ifdef WOLFSSL_VXWORKS_6_x #ifndef SEM_ID_NULL #define SEM_ID_NULL ((SEM_ID)NULL) #endif #endif #elif defined(WOLFSSL_uITRON4) #include "stddef.h" #include "kernel.h" #elif defined(WOLFSSL_uTKERNEL2) #include "tk/tkernel.h" #elif defined(WOLFSSL_CMSIS_RTOS) #include "cmsis_os.h" #elif defined(WOLFSSL_CMSIS_RTOSv2) #include "cmsis_os2.h" #elif defined(WOLFSSL_MDK_ARM) #if defined(WOLFSSL_MDK5) #include "cmsis_os.h" #else #include #endif #elif defined(WOLFSSL_CMSIS_RTOS) #include "cmsis_os.h" #elif defined(MBED) /* do nothing */ #elif defined(WOLFSSL_TIRTOS) #include #include #include #elif defined(WOLFSSL_FROSTED) #include #elif defined(INTIME_RTOS) #include #include #elif defined(WOLFSSL_NUCLEUS_1_2) /* NU_DEBUG needed struct access in nucleus_realloc */ #define NU_DEBUG #include "plus/nucleus.h" #include "nucleus.h" #elif defined(WOLFSSL_APACHE_MYNEWT) /* do nothing */ #elif defined(WOLFSSL_ZEPHYR) #include #ifndef SINGLE_THREADED #if !defined(CONFIG_PTHREAD_IPC) && !defined(CONFIG_POSIX_THREADS) #error "Threading needs CONFIG_PTHREAD_IPC / CONFIG_POSIX_THREADS" #endif #ifdef max #undef max #endif #if KERNEL_VERSION_NUMBER >= 0x30100 #include #include #include #else #include #include #include #endif #define max MAX #endif #elif defined(WOLFSSL_TELIT_M2MB) /* Telit SDK uses C++ compile option (--cpp), which causes link issue to API's if wrapped in extern "C" */ #ifdef __cplusplus } /* extern "C" */ #endif #include "m2mb_types.h" #include "m2mb_os_types.h" #include "m2mb_os_api.h" #include "m2mb_os.h" #include "m2mb_os_mtx.h" #ifndef NO_ASN_TIME #include "m2mb_rtc.h" #endif #ifndef NO_FILESYSTEM #include "m2mb_fs_posix.h" #endif #undef kB /* eliminate conflict in asn.h */ #ifdef __cplusplus extern "C" { #endif #elif defined(WOLFSSL_EMBOS) /* do nothing */ #else #ifndef SINGLE_THREADED #ifndef WOLFSSL_USER_MUTEX #if defined(WOLFSSL_LINUXKM) /* definitions are in linuxkm/linuxkm_wc_port.h */ #elif defined(WOLFSSL_BSDKM) /* definitions are in bsdkm/bsdkm_wc_port.h */ #else #define WOLFSSL_PTHREADS #include #endif #endif #endif #if (defined(OPENSSL_EXTRA) || defined(GOAHEAD_WS)) && \ !defined(NO_FILESYSTEM) #ifdef FUSION_RTOS #include #else #include /* for close of BIO */ #endif #endif #endif #ifdef WOLFSSL_API_PREFIX_MAP #define InitMutex wc_InitMutex #define FreeMutex wc_FreeMutex #define LockMutex wc_LockMutex #define UnLockMutex wc_UnLockMutex #elif defined(HAVE_FIPS) /* For FIPS keep the function names the same */ #define wc_InitMutex InitMutex #define wc_FreeMutex FreeMutex #define wc_LockMutex LockMutex #define wc_UnLockMutex UnLockMutex #endif /* HAVE_FIPS */ #ifdef SINGLE_THREADED typedef int wolfSSL_Mutex; #else /* MULTI_THREADED */ /* FREERTOS comes first to enable use of FreeRTOS Windows simulator only */ #if defined(FREERTOS) #if defined(ESP_IDF_VERSION_MAJOR) && (ESP_IDF_VERSION_MAJOR >= 4) typedef SemaphoreHandle_t wolfSSL_Mutex; #else typedef xSemaphoreHandle wolfSSL_Mutex; #endif #elif defined(FREERTOS_TCP) #include "FreeRTOS.h" #include "semphr.h" typedef SemaphoreHandle_t wolfSSL_Mutex; #elif defined (RTTHREAD) #include "rtthread.h" typedef rt_mutex_t wolfSSL_Mutex; #elif defined(WOLFSSL_SAFERTOS) typedef struct wolfSSL_Mutex { signed char mutexBuffer[portQUEUE_OVERHEAD_BYTES]; xSemaphoreHandle mutex; } wolfSSL_Mutex; #elif defined(USE_WINDOWS_API) && !defined(WOLFSSL_PTHREADS) typedef CRITICAL_SECTION wolfSSL_Mutex; #elif defined(MAXQ10XX_MUTEX) #include #include #include typedef pthread_mutex_t wolfSSL_Mutex; int maxq_CryptHwMutexTryLock(void); #elif defined(WOLFSSL_PTHREADS) #ifdef WOLFSSL_USE_RWLOCK typedef pthread_rwlock_t wolfSSL_RwLock; #endif typedef pthread_mutex_t wolfSSL_Mutex; #define WOLFSSL_MUTEX_INITIALIZER(lockname) PTHREAD_MUTEX_INITIALIZER #elif defined(THREADX) typedef TX_MUTEX wolfSSL_Mutex; #elif defined(WOLFSSL_DEOS) typedef mutex_handle_t wolfSSL_Mutex; #elif defined(MICRIUM) typedef OS_MUTEX wolfSSL_Mutex; #elif defined(EBSNET) #if (defined(RTPLATFORM) && (RTPLATFORM != 0)) typedef RTP_MUTEX wolfSSL_Mutex; #else typedef KS_RTIPSEM wolfSSL_Mutex; #endif #elif defined(FREESCALE_MQX) || defined(FREESCALE_KSDK_MQX) typedef MUTEX_STRUCT wolfSSL_Mutex; #elif defined(FREESCALE_FREE_RTOS) typedef mutex_t wolfSSL_Mutex; #elif defined(WOLFSSL_VXWORKS) typedef SEM_ID wolfSSL_Mutex; #elif defined(WOLFSSL_uITRON4) typedef struct wolfSSL_Mutex { T_CSEM sem ; ID id ; } wolfSSL_Mutex; #elif defined(WOLFSSL_uTKERNEL2) typedef struct wolfSSL_Mutex { T_CSEM sem ; ID id ; } wolfSSL_Mutex; #elif defined(WOLFSSL_MDK_ARM) #if defined(WOLFSSL_CMSIS_RTOS) typedef osMutexId wolfSSL_Mutex; #else typedef OS_MUT wolfSSL_Mutex; #endif #elif defined(WOLFSSL_CMSIS_RTOS) typedef osMutexId wolfSSL_Mutex; #elif defined(WOLFSSL_CMSIS_RTOSv2) typedef osMutexId_t wolfSSL_Mutex; #elif defined(WOLFSSL_TIRTOS) typedef ti_sysbios_knl_Semaphore_Handle wolfSSL_Mutex; #elif defined(WOLFSSL_FROSTED) typedef mutex_t * wolfSSL_Mutex; #elif defined(INTIME_RTOS) typedef RTHANDLE wolfSSL_Mutex; #elif defined(WOLFSSL_NUCLEUS_1_2) typedef NU_SEMAPHORE wolfSSL_Mutex; #elif defined(WOLFSSL_ZEPHYR) typedef struct k_mutex wolfSSL_Mutex; #elif defined(WOLFSSL_TELIT_M2MB) typedef M2MB_OS_MTX_HANDLE wolfSSL_Mutex; #elif defined(WOLFSSL_EMBOS) typedef OS_MUTEX wolfSSL_Mutex; #elif defined(WOLFSSL_USER_MUTEX) /* typedef User_Mutex wolfSSL_Mutex; */ #elif defined(WOLFSSL_LINUXKM) /* definitions are in linuxkm/linuxkm_wc_port.h */ #elif defined(WOLFSSL_BSDKM) /* definitions are in bsdkm/bsdkm_wc_port.h */ #elif defined(__WATCOMC__) /* OS/2 */ typedef ULONG wolfSSL_Mutex; #else #error Need a mutex type in multithreaded mode #endif /* USE_WINDOWS_API */ #endif /* SINGLE_THREADED */ #ifdef WOLFSSL_TEST_NO_MUTEX_INITIALIZER #undef WOLFSSL_MUTEX_INITIALIZER #endif #ifdef WOLFSSL_MUTEX_INITIALIZER #define WOLFSSL_MUTEX_INITIALIZER_CLAUSE(lockname) = WOLFSSL_MUTEX_INITIALIZER(lockname) #else #define WOLFSSL_MUTEX_INITIALIZER_CLAUSE(lockname) /* null expansion */ #endif #if !defined(WOLFSSL_USE_RWLOCK) || defined(SINGLE_THREADED) || \ (defined(WC_MUTEX_OPS_INLINE) && !defined(WC_RWLOCK_OPS_INLINE)) typedef wolfSSL_Mutex wolfSSL_RwLock; #endif #ifndef WOLFSSL_NO_ATOMICS #if defined(WOLFSSL_USER_DEFINED_ATOMICS) /* user-supplied bindings for wolfSSL_Atomic_Int etc. */ #if !defined(WOLFSSL_ATOMIC_INITIALIZER) || \ !defined(WOLFSSL_ATOMIC_LOAD) || \ !defined(WOLFSSL_ATOMIC_STORE) #error WOLFSSL_USER_DEFINED_ATOMICS is set but macro(s) are missing. #else #define WOLFSSL_ATOMIC_OPS #endif #elif defined(SINGLE_THREADED) typedef int wolfSSL_Atomic_Int; typedef unsigned int wolfSSL_Atomic_Uint; #define WOLFSSL_ATOMIC_INITIALIZER(x) (x) #define WOLFSSL_ATOMIC_LOAD(x) (x) #define WOLFSSL_ATOMIC_STORE(x, val) (x) = (val) #define WOLFSSL_ATOMIC_OPS #elif defined(WOLFSSL_BSDKM) /* Note: can be safely included in both linux kernel and * userspace builds. In FreeBSD kernel however it does nothing and * should not be included. Use FreeBSD instead. * definitions are in bsdkm/bsdkm_wc_port.h */ #elif defined(HAVE_C___ATOMIC) && defined(WOLFSSL_HAVE_ATOMIC_H) && \ !defined(__cplusplus) /* Default C Implementation */ #include typedef atomic_int wolfSSL_Atomic_Int; typedef atomic_uint wolfSSL_Atomic_Uint; #define WOLFSSL_ATOMIC_INITIALIZER(x) (x) #define WOLFSSL_ATOMIC_LOAD(x) atomic_load(&(x)) #define WOLFSSL_ATOMIC_STORE(x, val) atomic_store(&(x), val) #define WOLFSSL_ATOMIC_OPS #elif defined(__GNUC__) && defined(__ATOMIC_CONSUME) /* direct calls using gcc-style compiler built-ins */ typedef volatile int wolfSSL_Atomic_Int; typedef volatile unsigned int wolfSSL_Atomic_Uint; #define WOLFSSL_ATOMIC_INITIALIZER(x) (x) #define WOLFSSL_ATOMIC_LOAD(x) __atomic_load_n(&(x), \ __ATOMIC_CONSUME) #define WOLFSSL_ATOMIC_STORE(x, val) __atomic_store_n(&(x), \ val, __ATOMIC_RELEASE) #define WOLFSSL_ATOMIC_OPS #elif defined(_MSC_VER) && !defined(WOLFSSL_NOT_WINDOWS_API) /* Use MSVC compiler intrinsics for atomic ops */ #ifdef _WIN32_WCE #include #else #include #endif typedef volatile long wolfSSL_Atomic_Int; typedef volatile unsigned long wolfSSL_Atomic_Uint; #define WOLFSSL_ATOMIC_INITIALIZER(x) (x) #define WOLFSSL_ATOMIC_LOAD(x) (x) #define WOLFSSL_ATOMIC_STORE(x, val) (x) = (val) #define WOLFSSL_ATOMIC_OPS #endif /* If we weren't able to implement atomics above, disable them here. */ #ifndef WOLFSSL_ATOMIC_OPS #define WOLFSSL_NO_ATOMICS #endif #endif /* !WOLFSSL_NO_ATOMICS */ #ifdef WOLFSSL_NO_ATOMICS #define WOLFSSL_ATOMIC_INITIALIZER(x) (x) #define WOLFSSL_ATOMIC_LOAD(x) (x) #define WOLFSSL_ATOMIC_STORE(x, val) (x) = (val) #endif /* WOLFSSL_NO_ATOMICS */ /* WOLFSSL_ATOMIC_COERCE_INT() needs to accept either a regular int or an * wolfSSL_Atomic_Int as its argument, and evaluate to a regular int. * Allows a user-supplied override definition with type introspection. */ #ifndef WOLFSSL_ATOMIC_COERCE_INT #define WOLFSSL_ATOMIC_COERCE_INT(x) ((int)(x)) #endif #ifndef WOLFSSL_ATOMIC_COERCE_UINT #define WOLFSSL_ATOMIC_COERCE_UINT(x) ((unsigned int)(x)) #endif #ifdef WOLFSSL_USER_DEFINED_ATOMICS /* user-supplied bindings for wolfSSL_Atomic_Int_Init(), * wolfSSL_Atomic_Int_FetchAdd(), etc. */ #elif defined(WOLFSSL_ATOMIC_OPS) && !defined(SINGLE_THREADED) WOLFSSL_API void wolfSSL_Atomic_Int_Init(wolfSSL_Atomic_Int* c, int i); WOLFSSL_API void wolfSSL_Atomic_Uint_Init( wolfSSL_Atomic_Uint* c, unsigned int i); /* FetchOp functions return the value of the counter immediately preceding * the effects of the operation. * OpFetch functions return the value of the counter immediately after * the effects of the operation. */ WOLFSSL_API int wolfSSL_Atomic_Int_FetchAdd(wolfSSL_Atomic_Int* c, int i); WOLFSSL_API int wolfSSL_Atomic_Int_FetchSub(wolfSSL_Atomic_Int* c, int i); WOLFSSL_API int wolfSSL_Atomic_Int_AddFetch(wolfSSL_Atomic_Int* c, int i); WOLFSSL_API int wolfSSL_Atomic_Int_SubFetch(wolfSSL_Atomic_Int* c, int i); WOLFSSL_API int wolfSSL_Atomic_Int_CompareExchange( wolfSSL_Atomic_Int* c, int *expected_i, int new_i); WOLFSSL_API unsigned int wolfSSL_Atomic_Uint_FetchAdd( wolfSSL_Atomic_Uint* c, unsigned int i); WOLFSSL_API unsigned int wolfSSL_Atomic_Uint_FetchSub( wolfSSL_Atomic_Uint* c, unsigned int i); WOLFSSL_API unsigned int wolfSSL_Atomic_Uint_AddFetch( wolfSSL_Atomic_Uint* c, unsigned int i); WOLFSSL_API unsigned int wolfSSL_Atomic_Uint_SubFetch( wolfSSL_Atomic_Uint* c, unsigned int i); WOLFSSL_API int wolfSSL_Atomic_Uint_CompareExchange( wolfSSL_Atomic_Uint* c, unsigned int *expected_i, unsigned int new_i); WOLFSSL_API int wolfSSL_Atomic_Ptr_CompareExchange( void** c, void **expected_ptr, void *new_ptr); #else /* Code using these fallback implementations in non-SINGLE_THREADED builds * needs to arrange its own explicit fallback to int for wolfSSL_Atomic_Int * and unsigned int for wolfSSL_Atomic_Uint, which is not defined if * !defined(WOLFSSL_ATOMIC_OPS) && !defined(SINGLE_THREADED). This forces * local awareness of thread-unsafe semantics. */ #define wolfSSL_Atomic_Int_Init(c, i) (*(c) = (i)) #define wolfSSL_Atomic_Uint_Init(c, i) (*(c) = (i)) static WC_INLINE int wolfSSL_Atomic_Int_FetchAdd(int *c, int i) { int ret = *c; *c += i; return ret; } static WC_INLINE int wolfSSL_Atomic_Int_FetchSub(int *c, int i) { int ret = *c; *c -= i; return ret; } static WC_INLINE int wolfSSL_Atomic_Int_AddFetch(int *c, int i) { return (*c += i); } static WC_INLINE int wolfSSL_Atomic_Int_SubFetch(int *c, int i) { return (*c -= i); } static WC_INLINE int wolfSSL_Atomic_Int_CompareExchange( int *c, int *expected_i, int new_i) { if (*c == *expected_i) { *c = new_i; return 1; } else { *expected_i = *c; return 0; } } static WC_INLINE int wolfSSL_Atomic_Ptr_CompareExchange( void **c, void *expected_ptr, void *new_ptr) { if (*(char **)c == *(char **)expected_ptr) { *(char **)c = (char *)new_ptr; return 1; } else { *(char **)expected_ptr = *(char **)c; return 0; } } static WC_INLINE unsigned int wolfSSL_Atomic_Uint_FetchAdd( unsigned int *c, unsigned int i) { unsigned int ret = *c; *c += i; return ret; } static WC_INLINE unsigned int wolfSSL_Atomic_Uint_FetchSub( unsigned int *c, unsigned int i) { unsigned int ret = *c; *c -= i; return ret; } static WC_INLINE unsigned int wolfSSL_Atomic_Uint_AddFetch( unsigned int *c, unsigned int i) { return (*c += i); } static WC_INLINE unsigned int wolfSSL_Atomic_Uint_SubFetch( unsigned int *c, unsigned int i) { return (*c -= i); } static WC_INLINE int wolfSSL_Atomic_Uint_CompareExchange( unsigned int *c, unsigned int *expected_i, unsigned int new_i) { if (*c == *expected_i) { *c = new_i; return 1; } else { *expected_i = *c; return 0; } } #endif /* Reference counting. */ typedef struct wolfSSL_RefWithMutex { #if !defined(SINGLE_THREADED) wolfSSL_Mutex mutex; #endif int count; } wolfSSL_RefWithMutex; #if defined(WOLFSSL_ATOMIC_OPS) && !defined(SINGLE_THREADED) typedef struct wolfSSL_Ref { wolfSSL_Atomic_Int count; } wolfSSL_Ref; #else typedef struct wolfSSL_RefWithMutex wolfSSL_Ref; #endif #if defined(SINGLE_THREADED) || defined(WOLFSSL_ATOMIC_OPS) #define wolfSSL_RefInit(ref, err) \ do { \ wolfSSL_Atomic_Int_Init(&(ref)->count, 1); \ *(err) = 0; \ } while(0) #define wolfSSL_RefFree(ref) WC_DO_NOTHING #define wolfSSL_RefInc(ref, err) \ do { \ (void)wolfSSL_Atomic_Int_FetchAdd(&(ref)->count, 1); \ *(err) = 0; \ } while(0) #define wolfSSL_RefDec(ref, isZero, err) \ do { \ int __prev = wolfSSL_Atomic_Int_FetchSub(&(ref)->count, 1); \ /* __prev holds the value of count before subtracting 1 */ \ *(isZero) = (__prev == 1); \ *(err) = 0; \ } while(0) #else #define WOLFSSL_REFCNT_ERROR_RETURN #define wolfSSL_RefInit wolfSSL_RefWithMutexInit #define wolfSSL_RefFree wolfSSL_RefWithMutexFree #define wolfSSL_RefInc wolfSSL_RefWithMutexInc #define wolfSSL_RefDec wolfSSL_RefWithMutexDec #endif #if defined(SINGLE_THREADED) #define wolfSSL_RefWithMutexInit wolfSSL_RefInit #define wolfSSL_RefWithMutexFree wolfSSL_RefFree #define wolfSSL_RefWithMutexInc wolfSSL_RefInc #define wolfSSL_RefWithMutexLock(ref) 0 #define wolfSSL_RefWithMutexUnlock(ref) 0 #define wolfSSL_RefWithMutexDec wolfSSL_RefDec #else WOLFSSL_LOCAL void wolfSSL_RefWithMutexInit(wolfSSL_RefWithMutex* ref, int* err); WOLFSSL_LOCAL void wolfSSL_RefWithMutexFree(wolfSSL_RefWithMutex* ref); WOLFSSL_LOCAL void wolfSSL_RefWithMutexInc(wolfSSL_RefWithMutex* ref, int* err); WOLFSSL_LOCAL int wolfSSL_RefWithMutexLock(wolfSSL_RefWithMutex* ref); WOLFSSL_LOCAL int wolfSSL_RefWithMutexUnlock(wolfSSL_RefWithMutex* ref); WOLFSSL_LOCAL void wolfSSL_RefWithMutexDec(wolfSSL_RefWithMutex* ref, int* isZero, int* err); #endif /* Enable crypt HW mutex for Freescale MMCAU, PIC32MZ or STM32 */ #if defined(FREESCALE_MMCAU) || defined(WOLFSSL_MICROCHIP_PIC32MZ) || \ defined(STM32_CRYPTO) || defined(STM32_HASH) || defined(STM32_RNG) || \ defined(WOLFSSL_MAX3266X) || defined(WOLFSSL_MAX3266X_OLD) #ifndef WOLFSSL_CRYPT_HW_MUTEX #define WOLFSSL_CRYPT_HW_MUTEX 1 #endif #endif /* FREESCALE_MMCAU */ #ifndef WOLFSSL_CRYPT_HW_MUTEX #define WOLFSSL_CRYPT_HW_MUTEX 0 #endif #if WOLFSSL_CRYPT_HW_MUTEX /* wolfSSL_CryptHwMutexInit is called on first wolfSSL_CryptHwMutexLock, however it's recommended to call this directly on Hw init to avoid possible race condition where two calls to wolfSSL_CryptHwMutexLock are made at the same time. */ WOLFSSL_LOCAL int wolfSSL_CryptHwMutexInit(void); WOLFSSL_LOCAL int wolfSSL_CryptHwMutexLock(void); WOLFSSL_LOCAL int wolfSSL_CryptHwMutexUnLock(void); #else /* Define stubs, since HW mutex is disabled */ #define wolfSSL_CryptHwMutexInit() 0 /* Success */ #define wolfSSL_CryptHwMutexLock() 0 /* Success */ #define wolfSSL_CryptHwMutexUnLock() (void)0 /* Success */ #endif /* WOLFSSL_CRYPT_HW_MUTEX */ #if defined(WOLFSSL_ALGO_HW_MUTEX) && (defined(NO_RNG_MUTEX) && \ defined(NO_AES_MUTEX) && defined(NO_HASH_MUTEX) && defined(NO_PK_MUTEX)) #error WOLFSSL_ALGO_HW_MUTEX does not support having all mutexes off #endif /* To support HW that can do different Crypto in parallel */ #if WOLFSSL_CRYPT_HW_MUTEX && defined(WOLFSSL_ALGO_HW_MUTEX) typedef enum { #ifndef NO_RNG_MUTEX rng_mutex, #endif #ifndef NO_AES_MUTEX aes_mutex, #endif #ifndef NO_HASH_MUTEX hash_mutex, #endif #ifndef NO_PK_MUTEX pk_mutex, #endif } hw_mutex_algo; #endif /* If algo mutex is off, or WOLFSSL_ALGO_HW_MUTEX is not define, default */ /* to using the generic wolfSSL_CryptHwMutex */ #if (!defined(NO_RNG_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX)) && \ WOLFSSL_CRYPT_HW_MUTEX WOLFSSL_LOCAL int wolfSSL_HwRngMutexInit(void); WOLFSSL_LOCAL int wolfSSL_HwRngMutexLock(void); WOLFSSL_LOCAL int wolfSSL_HwRngMutexUnLock(void); #else #define wolfSSL_HwRngMutexInit wolfSSL_CryptHwMutexInit #define wolfSSL_HwRngMutexLock wolfSSL_CryptHwMutexLock #define wolfSSL_HwRngMutexUnLock wolfSSL_CryptHwMutexUnLock #endif /* !defined(NO_RNG_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX) */ #if (!defined(NO_AES_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX)) && \ WOLFSSL_CRYPT_HW_MUTEX WOLFSSL_LOCAL int wolfSSL_HwAesMutexInit(void); WOLFSSL_LOCAL int wolfSSL_HwAesMutexLock(void); WOLFSSL_LOCAL int wolfSSL_HwAesMutexUnLock(void); #else #define wolfSSL_HwAesMutexInit wolfSSL_CryptHwMutexInit #define wolfSSL_HwAesMutexLock wolfSSL_CryptHwMutexLock #define wolfSSL_HwAesMutexUnLock wolfSSL_CryptHwMutexUnLock #endif /* !defined(NO_AES_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX) */ #if (!defined(NO_HASH_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX)) && \ WOLFSSL_CRYPT_HW_MUTEX WOLFSSL_LOCAL int wolfSSL_HwHashMutexInit(void); WOLFSSL_LOCAL int wolfSSL_HwHashMutexLock(void); WOLFSSL_LOCAL int wolfSSL_HwHashMutexUnLock(void); #else #define wolfSSL_HwHashMutexInit wolfSSL_CryptHwMutexInit #define wolfSSL_HwHashMutexLock wolfSSL_CryptHwMutexLock #define wolfSSL_HwHashMutexUnLock wolfSSL_CryptHwMutexUnLock #endif /* !defined(NO_HASH_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX) */ #if (!defined(NO_PK_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX)) && \ WOLFSSL_CRYPT_HW_MUTEX WOLFSSL_LOCAL int wolfSSL_HwPkMutexInit(void); WOLFSSL_LOCAL int wolfSSL_HwPkMutexLock(void); WOLFSSL_LOCAL int wolfSSL_HwPkMutexUnLock(void); #else #define wolfSSL_HwPkMutexInit wolfSSL_CryptHwMutexInit #define wolfSSL_HwPkMutexLock wolfSSL_CryptHwMutexLock #define wolfSSL_HwPkMutexUnLock wolfSSL_CryptHwMutexUnLock #endif /* !defined(NO_PK_MUTEX) && defined(WOLFSSL_ALGO_HW_MUTEX) */ /* Mutex functions */ #ifndef WC_MUTEX_OPS_INLINE WOLFSSL_API int wc_InitMutex(wolfSSL_Mutex* m); WOLFSSL_API int wc_FreeMutex(wolfSSL_Mutex* m); WOLFSSL_API int wc_LockMutex(wolfSSL_Mutex* m); WOLFSSL_API int wc_UnLockMutex(wolfSSL_Mutex* m); #endif WOLFSSL_API wolfSSL_Mutex* wc_InitAndAllocMutex(void); #ifndef WC_RWLOCK_OPS_INLINE /* RwLock functions. Fallback to Mutex when not implemented explicitly. */ WOLFSSL_API int wc_InitRwLock(wolfSSL_RwLock* m); WOLFSSL_API int wc_FreeRwLock(wolfSSL_RwLock* m); WOLFSSL_API int wc_LockRwLock_Wr(wolfSSL_RwLock* m); WOLFSSL_API int wc_LockRwLock_Rd(wolfSSL_RwLock* m); WOLFSSL_API int wc_UnLockRwLock(wolfSSL_RwLock* m); #endif #if defined(OPENSSL_EXTRA) || defined(HAVE_WEBSERVER) /* dynamically set which mutex to use. unlock / lock is controlled by flag */ typedef void (mutex_cb)(int flag, int type, const char* file, int line); WOLFSSL_API int wc_LockMutex_ex(int flag, int type, const char* file, int line); WOLFSSL_API int wc_SetMutexCb(mutex_cb* cb); WOLFSSL_API mutex_cb* wc_GetMutexCb(void); #endif /* main crypto initialization function */ WOLFSSL_ABI WOLFSSL_API int wolfCrypt_Init(void); WOLFSSL_ABI WOLFSSL_API int wolfCrypt_Cleanup(void); #ifdef WOLFSSL_TRACK_MEMORY_VERBOSE WOLFSSL_API long wolfCrypt_heap_peakAllocs_checkpoint(void); WOLFSSL_API long wolfCrypt_heap_peakBytes_checkpoint(void); #endif /* FILESYSTEM SECTION */ /* filesystem abstraction layer, used by ssl.c */ #ifndef NO_FILESYSTEM #if defined(EBSNET) #include "vfapi.h" #include "vfile.h" int ebsnet_fseek(int a, long b, int c); /* Not prototyped in vfile.h per * EBSnet feedback */ #define XFILE int #define XFOPEN(NAME, MODE) vf_open((const char *)NAME, VO_RDONLY, 0) #define XFSEEK ebsnet_fseek #define XFTELL vf_tell #define XFREAD(BUF, SZ, AMT, FD) vf_read(FD, BUF, SZ*AMT) #define XFWRITE(BUF, SZ, AMT, FD) vf_write(FD, BUF, SZ*AMT) #define XFCLOSE vf_close #define XSEEK_SET VSEEK_SET #define XSEEK_END VSEEK_END #define XBADFILE -1 #define XFGETS(b,s,f) -2 /* Not ported yet */ #define XSNPRINTF rtp_snprintf #define XFPRINTF fprintf #elif defined(LSR_FS) #include #define XFILE struct fs_file* #define XFOPEN(NAME, MODE) fs_open((char*)NAME) #define XFSEEK(F, O, W) (void)F #define XFTELL(F) (F)->len #define XFREAD(BUF, SZ, AMT, F) fs_read(F, (char*)BUF, SZ*AMT) #define XFWRITE(BUF, SZ, AMT, F) fs_write(F, (char*)BUF, SZ*AMT) #define XFCLOSE fs_close #define XSEEK_SET 0 #define XSEEK_END 0 #define XBADFILE NULL #define XFGETS(b,s,f) -2 /* Not ported yet */ #elif defined(FREESCALE_MQX) || defined(FREESCALE_KSDK_MQX) #define XFILE MQX_FILE_PTR #define XFOPEN fopen #define XFSEEK fseek #define XFTELL ftell #define XFREAD fread #define XFWRITE fwrite #define XFCLOSE fclose #define XSEEK_SET IO_SEEK_SET #define XSEEK_END IO_SEEK_END #define XBADFILE NULL #define XFGETS fgets #elif defined(WOLFSSL_DEOS) #define NO_FILESYSTEM #warning "TODO - DDC-I Certifiable Fast File System for Deos is not integrated" #elif defined(MICRIUM) #include #define XFILE FS_FILE* #define XFOPEN fs_fopen #define XFSEEK fs_fseek #define XFTELL fs_ftell #define XFREAD fs_fread #define XFWRITE fs_fwrite #define XFCLOSE fs_fclose #define XSEEK_SET FS_SEEK_SET #define XSEEK_END FS_SEEK_END #define XBADFILE NULL #define XFGETS(b,s,f) -2 /* Not ported yet */ #elif defined(WOLFSSL_NUCLEUS_1_2) #include "fal/inc/fal.h" #define XFILE FILE* #define XFOPEN fopen #define XFSEEK fseek #define XFTELL ftell #define XFREAD fread #define XFWRITE fwrite #define XFCLOSE fclose #define XSEEK_SET PSEEK_SET #define XSEEK_END PSEEK_END #define XBADFILE NULL #elif defined(WOLFSSL_APACHE_MYNEWT) #include #define XFILE struct fs_file* #define XFOPEN mynewt_fopen #define XFSEEK mynewt_fseek #define XFTELL mynewt_ftell #define XFREAD mynewt_fread #define XFWRITE mynewt_fwrite #define XFCLOSE mynewt_fclose #define XSEEK_SET 0 #define XSEEK_END 2 #define XBADFILE NULL #define XFGETS(b,s,f) -2 /* Not ported yet */ #elif defined(WOLFSSL_ZEPHYR) #include #define XFILE struct fs_file_t* /* These are our wrappers for opening and closing files to * make the API more POSIX like. */ XFILE z_fs_open(const char* filename, const char* mode); int z_fs_close(XFILE file); int z_fs_rewind(XFILE file); #define XFOPEN z_fs_open #define XFCLOSE z_fs_close #define XFFLUSH fs_sync #define XFSEEK fs_seek #define XFTELL fs_tell #define XFREWIND z_fs_rewind #define XFREAD(P,S,N,F) fs_read(F, P, S*N) #define XFWRITE(P,S,N,F) fs_write(F, P, S*N) #define XSEEK_SET FS_SEEK_SET #define XSEEK_END FS_SEEK_END #define XBADFILE NULL #define XFGETS(b,s,f) -2 /* Not ported yet */ #define XSTAT fs_stat #define XSTAT_TYPE struct fs_dirent #define XS_ISREG(s) (s == FS_DIR_ENTRY_FILE) #define SEPARATOR_CHAR ':' #elif defined(WOLFSSL_TELIT_M2MB) #define XFILE INT32 #define XFOPEN(NAME, MODE) m2mb_fs_open((NAME), 0, (MODE)) #define XFSEEK(F, O, W) m2mb_fs_lseek((F), (O), (W)) #define XFTELL(F) m2mb_fs_lseek((F), 0, M2MB_SEEK_END) #define XFREAD(BUF, SZ, AMT, F) m2mb_fs_read((F), (BUF), (SZ)*(AMT)) #define XFWRITE(BUF, SZ, AMT, F) m2mb_fs_write((F), (BUF), (SZ)*(AMT)) #define XFCLOSE m2mb_fs_close #define XSEEK_SET M2MB_SEEK_SET #define XSEEK_END M2MB_SEEK_END #define XBADFILE -1 #define XFGETS(b,s,f) -2 /* Not ported yet */ #elif defined (WOLFSSL_XILINX) #include "xsdps.h" #include "ff.h" /* workaround to declare variable and provide type */ #define XFILE FIL curFile; FIL* #define XFOPEN(NAME, MODE) ({ FRESULT res; res = f_open(&curFile, (NAME), (FA_OPEN_ALWAYS | FA_WRITE | FA_READ)); (res == FR_OK) ? &curFile : NULL; }) #define XFSEEK(F, O, W) f_lseek((F), (O)) #define XFTELL(F) f_tell((F)) #define XFREAD(BUF, SZ, AMT, F) ({ FRESULT res; UINT br; res = f_read((F), (BUF), (SZ)*(AMT), &br); (void)br; res; }) #define XFWRITE(BUF, SZ, AMT, F) ({ FRESULT res; UINT written; res = f_write((F), (BUF), (SZ)*(AMT), &written); (void)written; res; }) #define XFCLOSE(F) f_close((F)) #define XSEEK_SET 0 #define XSEEK_END 0 #define XBADFILE NULL #define XFGETS(b,s,f) f_gets((b), (s), (f)) #elif defined (_WIN32_WCE) /* stdio, WINCE case */ #include #define XFILE FILE* #define XFOPEN fopen #define XFDOPEN fdopen #define XFSEEK fseek #define XFTELL ftell #define XFREAD fread #define XFWRITE fwrite #define XFCLOSE fclose #define XSEEK_SET SEEK_SET #define XSEEK_END SEEK_END #define XBADFILE NULL #define XFGETS fgets #define XVSNPRINTF _vsnprintf #elif defined(FUSION_RTOS) #include #include #include #include #include #include #define XFILE FCL_FILE* #define XFOPEN FCL_FOPEN #define XFSEEK FCL_FSEEK #define XFTELL FCL_FTELL #define XFREAD FCL_FREAD #define XFWRITE FCL_FWRITE #define XFCLOSE FCL_FCLOSE #define XSEEK_SET SEEK_SET #define XSEEK_END SEEK_END #define XBADFILE NULL #define XFGETS FCL_FGETS #define XFPUTS FCL_FPUTS #define XFPRINTF FCL_FPRINTF #define XVFPRINTF FCL_VFPRINTF #define XVSNPRINTF FCL_VSNPRINTF #define XSNPRINTF FCL_SNPRINTF #define XSPRINTF FCL_SPRINTF #define DIR FCL_DIR #define stat FCL_STAT #define opendir FCL_OPENDIR #define closedir FCL_CLOSEDIR #define readdir FCL_READDIR #define dirent fclDirent #define strncasecmp FCL_STRNCASECMP /* FUSION SPECIFIC ERROR CODE */ #define FUSION_IO_SEND_E FCL_EWOULDBLOCK #elif defined(WOLFSSL_USER_FILESYSTEM) /* To be defined in user_settings.h */ #else /* stdio, default case */ #include #define XFILE FILE* #if defined(WOLFSSL_MDK_ARM) extern FILE * wolfSSL_fopen(const char *name, const char *mode) ; #define XFOPEN wolfSSL_fopen #else #define XFOPEN fopen #endif #define XFDOPEN fdopen #define XFSEEK fseek #define XFTELL ftell #define XFREAD fread #define XFWRITE fwrite #define XFCLOSE fclose #define XSEEK_SET SEEK_SET #define XSEEK_END SEEK_END #define XBADFILE NULL #define XFGETS fgets #define XFPRINTF fprintf #define XFFLUSH fflush #define XFEOF(fp) feof(fp) #define XFERROR(fp) ferror(fp) #define XCLEARERR(fp) clearerr(fp) #if !defined(NO_WOLFSSL_DIR)\ && !defined(WOLFSSL_NUCLEUS) && !defined(WOLFSSL_NUCLEUS_1_2) #if defined(__WATCOMC__) #include #include #define XWRITE write #define XREAD read #define XCLOSE close #define XSTAT stat #define XS_ISREG(s) S_ISREG(s) #if defined(__UNIX__) #include #define SEPARATOR_CHAR ':' #else #include #define SEPARATOR_CHAR ';' #endif #if defined(__NT__) #define XALTHOMEVARNAME "USERPROFILE" #endif #elif defined(USE_WINDOWS_API) #include #include #ifndef XSTAT #define XSTAT _stat #endif #define XS_ISREG(s) (s & _S_IFREG) #define SEPARATOR_CHAR ';' #define XWRITE _write #define XREAD _read #define XALTHOMEVARNAME "USERPROFILE" #elif defined(ARDUINO) #ifndef XSTAT #define XSTAT _stat #endif #define XS_ISREG(s) (s & _S_IFREG) #define SEPARATOR_CHAR ';' #elif defined(INTIME_RTOS) #include #ifndef XSTAT #define XSTAT _stat64 #endif #define XS_ISREG(s) S_ISREG(s) #define SEPARATOR_CHAR ';' #define XWRITE write #define XREAD read #define XCLOSE close #elif defined(WOLFSSL_TELIT_M2MB) #ifndef XSTAT #define XSTAT m2mb_fs_stat #endif #define XS_ISREG(s) (s & M2MB_S_IFREG) #define SEPARATOR_CHAR ':' #else #include #include #include #define XWRITE write #define XREAD read #define XCLOSE close #ifndef XSTAT #define XSTAT stat #endif #define XS_ISREG(s) S_ISREG(s) #define SEPARATOR_CHAR ':' #endif #ifndef XSTAT_TYPE #define XSTAT_TYPE struct XSTAT #endif #endif /* !NO_WOLFSSL_DIR !WOLFSSL_NUCLEUS !WOLFSSL_NUCLEUS_1_2 */ #endif #ifndef MAX_FILENAME_SZ #define MAX_FILENAME_SZ (260 + 1) /* max file name length */ #endif #ifndef MAX_PATH #define MAX_PATH (260 + 1) #endif #ifndef XFEOF #define XFEOF(fp) 0 #endif #ifndef XFERROR #define XFERROR(fp) 0 #endif #ifndef XCLEARERR #define XCLEARERR(fp) WC_DO_NOTHING #endif WOLFSSL_API int wc_FileLoad(const char* fname, unsigned char** buf, size_t* bufLen, void* heap); #if !defined(NO_WOLFSSL_DIR) && !defined(WOLFSSL_NUCLEUS) && \ !defined(WOLFSSL_NUCLEUS_1_2) typedef struct ReadDirCtx { #ifdef USE_WINDOWS_API WIN32_FIND_DATAA FindFileData; HANDLE hFind; XSTAT_TYPE s; #elif defined(WOLFSSL_ZEPHYR) struct fs_dirent entry; struct fs_dir_t dir; struct fs_dirent s; struct fs_dir_t* dirp; #elif defined(WOLFSSL_TELIT_M2MB) M2MB_DIR_T* dir; struct M2MB_DIRENT* entry; struct M2MB_STAT s; #elif defined(INTIME_RTOS) struct stat64 s; struct _find64 FindFileData; #define IntimeFindFirst(name, data) (0 == _findfirst64(name, data)) #define IntimeFindNext(data) (0 == _findnext64(data)) #define IntimeFindClose(data) (0 == _findclose64(data)) #define IntimeFilename(ctx) ctx->FindFileData.f_filename #elif defined(ARDUINO) /* TODO: board specific features */ #else struct dirent* entry; DIR* dir; XSTAT_TYPE s; #endif char name[MAX_FILENAME_SZ]; } ReadDirCtx; #define WC_READDIR_NOFILE (-1) WOLFSSL_API int wc_ReadDirFirst(ReadDirCtx* ctx, const char* path, char** name); WOLFSSL_API int wc_ReadDirNext(ReadDirCtx* ctx, const char* path, char** name); WOLFSSL_API void wc_ReadDirClose(ReadDirCtx* ctx); #endif /* !NO_WOLFSSL_DIR */ #define WC_ISFILEEXIST_NOFILE (-1) WOLFSSL_API int wc_FileExists(const char* fname); #endif /* !NO_FILESYSTEM */ /* Defaults, user may over-ride with user_settings.h or in a porting section * above */ #ifndef XVFPRINTF #define XVFPRINTF vfprintf #endif #ifndef XVSNPRINTF #define XVSNPRINTF vsnprintf #endif #ifndef XFPUTS #define XFPUTS fputs #endif #ifndef XSPRINTF #define XSPRINTF sprintf #endif #ifdef USE_WINDOWS_API #ifndef SOCKET_T #ifdef __MINGW64__ typedef size_t SOCKET_T; #else typedef unsigned int SOCKET_T; #endif #endif #ifndef SOCKET_INVALID #define SOCKET_INVALID INVALID_SOCKET #endif #else #ifndef SOCKET_T typedef int SOCKET_T; #endif #ifndef SOCKET_INVALID #define SOCKET_INVALID (-1) #endif #endif /* MIN/MAX MACRO SECTION */ /* Windows API defines its own min() macro. */ #if defined(USE_WINDOWS_API) #if defined(min) || defined(WOLFSSL_MYSQL_COMPATIBLE) #undef WOLFSSL_HAVE_MIN #define WOLFSSL_HAVE_MIN #endif /* min */ #if defined(max) || defined(WOLFSSL_MYSQL_COMPATIBLE) #undef WOLFSSL_HAVE_MAX #define WOLFSSL_HAVE_MAX #endif /* max */ #endif /* USE_WINDOWS_API */ #ifdef __QNXNTO__ #define WOLFSSL_HAVE_MIN #define WOLFSSL_HAVE_MAX #endif /* TIME SECTION */ /* Time functions */ #ifndef NO_ASN_TIME #if defined(USER_TIME) /* Use our gmtime and time_t/struct tm types. Only needs seconds since EPOCH using XTIME function. time_t XTIME(time_t * timer) {} */ #define WOLFSSL_GMTIME #ifndef HAVE_TM_TYPE #define USE_WOLF_TM #endif #ifndef HAVE_TIME_T_TYPE #define USE_WOLF_TIME_T #endif #elif defined(TIME_OVERRIDES) /* Override XTIME() and XGMTIME() functionality. Requires user to provide these functions: time_t XTIME(time_t * timer) {} struct tm* XGMTIME(const time_t* timer, struct tm* tmp) {} */ #ifndef HAVE_TIME_T_TYPE #define USE_WOLF_TIME_T #endif #ifndef HAVE_TM_TYPE #define USE_WOLF_TM #endif #define NEED_TMP_TIME #elif defined(WOLFSSL_XILINX) #ifndef XTIME #define XTIME(t1) xilinx_time((t1)) #endif #include time_t xilinx_time(time_t * timer); #elif defined(HAVE_RTP_SYS) #include "os.h" /* dc_rtc_api needs */ #include "dc_rtc_api.h" /* to get current time */ /* uses partial structures */ #define XTIME(tl) (0) #define XGMTIME(c, t) rtpsys_gmtime((c)) #elif defined(WOLFSSL_DEOS) || defined(WOLFSSL_DEOS_RTEMS) #include #ifndef XTIME extern time_t deos_time(time_t* timer); #define XTIME(t1) deos_time((t1)) #endif #elif defined(MICRIUM) #include #include #define XTIME(t1) micrium_time((t1)) #define WOLFSSL_GMTIME #elif defined(MICROCHIP_TCPIP_V5) || defined(MICROCHIP_TCPIP) #include extern time_t pic32_time(time_t* timer); #define XTIME(t1) pic32_time((t1)) #define XGMTIME(c, t) gmtime((c)) #elif defined(FREESCALE_RTC) #include #include "fsl_rtc.h" #ifndef XTIME #define XTIME(t1) fsl_time((t1)) #endif #elif defined(FREESCALE_SNVS_RTC) #include #include "fsl_snvs_hp.h" time_t fsl_time(time_t* t); #ifndef XTIME #define XTIME(t1) fsl_time((t1)) #endif #elif defined(FREESCALE_MQX) || defined(FREESCALE_KSDK_MQX) #ifdef FREESCALE_MQX_4_0 #include extern time_t mqx_time(time_t* timer); #else #define HAVE_GMTIME_R #endif #define XTIME(t1) mqx_time((t1)) #elif defined(FREESCALE_KSDK_BM) || defined(FREESCALE_FREE_RTOS) || defined(FREESCALE_KSDK_FREERTOS) #include #ifndef XTIME /*extern time_t ksdk_time(time_t* timer);*/ #define XTIME(t1) ksdk_time((t1)) #endif #define XGMTIME(c, t) gmtime((c)) #elif defined(WOLFSSL_ATMEL) && defined(WOLFSSL_ATMEL_TIME) #define XTIME(t1) atmel_get_curr_time_and_date((t1)) #define WOLFSSL_GMTIME #define USE_WOLF_TM #define USE_WOLF_TIME_T #elif defined(WOLFSSL_WICED) #include time_t wiced_pseudo_unix_epoch_time(time_t * timer); #define XTIME(t1) wiced_pseudo_unix_epoch_time((t1)) #define HAVE_GMTIME_R #elif defined(IDIRECT_DEV_TIME) /*Gets the timestamp from cloak software owned by VT iDirect in place of time() from */ #include #define XTIME(t1) idirect_time((t1)) #define XGMTIME(c, t) gmtime((c)) #elif defined(_WIN32_WCE) #define _WINSOCKAPI_ /* block inclusion of winsock.h header file */ #include #undef _WINSOCKAPI_ /* undefine it for MINGW winsock2.h header file */ #include /* For file system */ time_t windows_time(time_t* timer); #define FindNextFileA(h, d) FindNextFile(h, (LPWIN32_FIND_DATAW) d) #define FindFirstFileA(fn, d) FindFirstFile((LPCWSTR) fn, \ (LPWIN32_FIND_DATAW) d) #define XTIME(t1) windows_time((t1)) #define WOLFSSL_GMTIME /* if struct tm is not defined in WINCE SDK */ #ifndef _TM_DEFINED struct tm { int tm_sec; /* seconds */ int tm_min; /* minutes */ int tm_hour; /* hours */ int tm_mday; /* day of month (month specific) */ int tm_mon; /* month */ int tm_year; /* year */ int tm_wday; /* day of week (out of 1-7)*/ int tm_yday; /* day of year (out of 365) */ int tm_isdst; /* is it daylight savings */ }; #define _TM_DEFINED #endif #elif defined(WOLFSSL_APACHE_MYNEWT) #include "os/os_time.h" typedef long time_t; extern time_t mynewt_time(time_t* timer); #define XTIME(t1) mynewt_time((t1)) #define WOLFSSL_GMTIME #define USE_WOLF_TM #define USE_WOLF_TIME_T #elif defined(WOLFSSL_ZEPHYR) #include #ifndef _POSIX_C_SOURCE #if KERNEL_VERSION_NUMBER >= 0x30100 #include #else #include #endif #else #include #endif #if defined(CONFIG_RTC) #if defined(CONFIG_PICOLIBC) || defined(CONFIG_NEWLIB_LIBC) #include #else #warning "RTC support needs picolibc or newlib (nano)" #endif #endif time_t z_time(time_t *timer); #define XTIME(tl) z_time((tl)) #define XGMTIME(c, t) gmtime((c)) #elif defined(WOLFSSL_TELIT_M2MB) typedef long time_t; extern time_t m2mb_xtime(time_t * timer); #define XTIME(tl) m2mb_xtime((tl)) #ifdef WOLFSSL_TLS13 extern time_t m2mb_xtime_ms(time_t * timer); #define XTIME_MS(tl) m2mb_xtime_ms((tl)) #endif #ifndef NO_CRYPT_BENCHMARK extern double m2mb_xtime_bench(int reset); #define WOLFSSL_CURRTIME_REMAP m2mb_xtime_bench #endif #define XGMTIME(c, t) gmtime((c)) #define WOLFSSL_GMTIME #define USE_WOLF_TM #elif defined(WOLFSSL_LINUXKM) /* definitions are in linuxkm/linuxkm_wc_port.h */ #elif defined(WOLFSSL_BSDKM) /* definitions are in bsdkm/bsdkm_wc_port.h */ #elif defined(HAL_RTC_MODULE_ENABLED) #include WOLFSSL_LOCAL time_t stm32_hal_time(time_t* t1); #define XTIME(t1) stm32_hal_time(t1) #define WOLFSSL_GMTIME #else /* default */ /* uses complete facility */ #include #if defined(HAVE_SYS_TIME_H) #include #endif /* PowerPC time_t is int */ #if defined(__PPC__) || defined(__ppc__) #define TIME_T_NOT_64BIT #endif #define XMKTIME(tm) mktime(tm) #define XDIFFTIME(to, from) difftime(to, from) #endif #ifdef SIZEOF_TIME_T /* check if size of time_t from autoconf is less than 8 bytes (64bits) */ #if SIZEOF_TIME_T < 8 #undef TIME_T_NOT_64BIT #define TIME_T_NOT_64BIT #endif #endif #ifdef TIME_T_NOT_LONG /* one old reference to TIME_T_NOT_LONG in GCC-ARM example README * this keeps support for the old macro name */ #undef TIME_T_NOT_64BIT #define TIME_T_NOT_64BIT #endif /* Map default time functions */ #if !defined(XTIME) && !defined(TIME_OVERRIDES) && !defined(USER_TIME) #ifdef TEST_BEFORE_DATE #define XTIME(tl) (946681200UL) /* Jan 1, 2000 */ #else #define XTIME(tl) time((tl)) #endif #endif #if defined(WOLFSSL_GMTIME) && !defined(HAVE_GMTIME_R) #define HAVE_GMTIME_R #endif #if !defined(XGMTIME) && !defined(TIME_OVERRIDES) /* Always use gmtime_r if available. */ #if defined(HAVE_GMTIME_S) /* reentrant version */ #define XGMTIME(c, t) gmtime_s((c), (t)) #define NEED_TMP_TIME #elif defined(HAVE_GMTIME_R) #define XGMTIME(c, t) gmtime_r((c), (t)) #define NEED_TMP_TIME #else #define XGMTIME(c, t) gmtime((c)) #endif #endif #if !defined(XVALIDATE_DATE) && !defined(HAVE_VALIDATE_DATE) #define USE_WOLF_VALIDDATE #define XVALIDATE_DATE(d, f, t) wc_ValidateDate((d), (f), (t)) #endif /* wolf struct tm and time_t */ #if defined(USE_WOLF_TM) struct tm { int tm_sec; /* seconds after the minute [0-60] */ int tm_min; /* minutes after the hour [0-59] */ int tm_hour; /* hours since midnight [0-23] */ int tm_mday; /* day of the month [1-31] */ int tm_mon; /* months since January [0-11] */ int tm_year; /* years since 1900 */ int tm_wday; /* days since Sunday [0-6] */ int tm_yday; /* days since January 1 [0-365] */ int tm_isdst; /* Daylight Savings Time flag */ long tm_gmtoff; /* offset from CUT in seconds */ char *tm_zone; /* timezone abbreviation */ }; #endif /* USE_WOLF_TM */ #if defined(USE_WOLF_TIME_T) typedef long time_t; #endif #if defined(USE_WOLF_SUSECONDS_T) typedef long suseconds_t; #endif #if defined(USE_WOLF_TIMEVAL_T) struct timeval { time_t tv_sec; suseconds_t tv_usec; }; #endif /* forward declarations */ #if defined(USER_TIME) struct tm* gmtime(const time_t* timer); extern time_t XTIME(time_t * timer); #ifdef STACK_TRAP /* for stack trap tracking, don't call os gmtime on OS X/linux, uses a lot of stack spce */ extern time_t time(time_t * timer); #define XTIME(tl) time((tl)) #endif /* STACK_TRAP */ #elif defined(TIME_OVERRIDES) extern time_t XTIME(time_t * timer); extern struct tm* XGMTIME(const time_t* timer, struct tm* tmp); #elif defined(WOLFSSL_GMTIME) struct tm* gmtime(const time_t* timer); struct tm* gmtime_r(const time_t* timer, struct tm *ret); #endif #endif /* !NO_ASN_TIME */ #if (!defined(WOLFSSL_LEANPSK) && !defined(STRING_USER)) || \ defined(USE_WOLF_STRNSTR) WOLFSSL_TEST_VIS char* wolfSSL_strnstr(const char* s1, const char* s2, unsigned int n); #endif #ifndef FILE_BUFFER_SIZE /* default static file buffer size for input, will use dynamic buffer if * not big enough */ #ifdef WOLFSSL_CERT_EXT #define FILE_BUFFER_SIZE (3*1024) #else #define FILE_BUFFER_SIZE (1*1024) #endif #endif #ifdef HAVE_CAVIUM_OCTEON_SYNC /* By default, the OCTEON's global variables are all thread local. This * tag allows them to be shared between threads. */ #include "cvmx-platform.h" #define WC_THREADSHARED CVMX_SHARED #else #define WC_THREADSHARED #endif #ifdef WOLFSSL_DSP #include "wolfssl_dsp.h" /* callbacks for setting handle */ typedef int (*wolfSSL_DSP_Handle_cb)(remote_handle64 *handle, int finished, void *ctx); WOLFSSL_API int wolfSSL_GetHandleCbSet(); WOLFSSL_API int wolfSSL_SetHandleCb(wolfSSL_DSP_Handle_cb in); WOLFSSL_LOCAL int wolfSSL_InitHandle(); WOLFSSL_LOCAL void wolfSSL_CleanupHandle(); #endif #ifdef WOLFSSL_SCE #ifndef WOLFSSL_SCE_GSCE_HANDLE #define WOLFSSL_SCE_GSCE_HANDLE g_sce #endif #endif #ifdef WOLF_C99 /* use alternate keyword for compatibility with -std=c99 */ #define XASM_VOLATILE(a) __asm__ volatile(a) #elif defined(__IAR_SYSTEMS_ICC__) #define XASM_VOLATILE(a) asm volatile(a) #elif defined(__KEIL__) #define XASM_VOLATILE(a) __asm volatile(a) #else #define XASM_VOLATILE(a) __asm__ __volatile__(a) #endif #ifndef WOLFSSL_NO_FENCE #ifdef XFENCE /* use user-supplied XFENCE definition. */ #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && \ !defined(__STDC_NO_ATOMICS__) #ifdef WOLFSSL_NO_ATOMIC #define XFENCE() WC_DO_NOTHING #else #include #define XFENCE() atomic_thread_fence(memory_order_seq_cst) #endif #elif defined(__GNUC__) && (__GNUC__ == 4) && \ defined(__GNUC_MINOR__) && (__GNUC_MINOR__ >= 1) #define XFENCE() __sync_synchronize() #elif (defined(__GNUC__) && (__GNUC__ >= 5)) || defined (__clang__) #define XFENCE() __atomic_thread_fence(__ATOMIC_SEQ_CST) #elif defined(WOLFSSL_NO_ASM) #define XFENCE() WC_DO_NOTHING #elif defined (__i386__) || defined(__x86_64__) #define XFENCE() XASM_VOLATILE("lfence") #elif defined (__arm__) && (__ARM_ARCH > 6) #define XFENCE() XASM_VOLATILE("isb") #elif defined(__aarch64__) /* Change ".inst 0xd50330ff" to "sb" when compilers support it. */ #ifdef WOLFSSL_ARMASM_BARRIER_SB #define XFENCE() XASM_VOLATILE(".inst 0xd50330ff") #elif defined(WOLFSSL_ARMASM_BARRIER_DETECT) extern int aarch64_use_sb; #define XFENCE() \ do { \ if (aarch64_use_sb) \ XASM_VOLATILE(".inst 0xd50330ff"); \ else \ XASM_VOLATILE("isb"); \ } while (0) #else #define XFENCE() XASM_VOLATILE("isb") #endif #elif defined(__riscv) #define XFENCE() XASM_VOLATILE("fence") #elif defined(__PPC__) || defined(__POWERPC__) #define XFENCE() XASM_VOLATILE("isync; sync") #else #define XFENCE() WC_DO_NOTHING #endif #else #define XFENCE() WC_DO_NOTHING #endif /* AFTER user_settings.h is loaded, ** determine if POSIX multi-threaded: HAVE_PTHREAD */ #if defined(SINGLE_THREADED) || defined(__MINGW32__) /* Never HAVE_PTHREAD in single thread, or non-POSIX mode. ** Reminder: MING32 is win32 threads, not POSIX threads */ #undef HAVE_PTHREAD #else /* _POSIX_THREADS is defined by unistd.h so this check needs to happen * after we include all the platform relevant libs. */ #ifdef _POSIX_THREADS /* HAVE_PTHREAD == POSIX threads capable and enabled. */ #undef HAVE_PTHREAD #define HAVE_PTHREAD 1 #endif #endif #if defined(WC_RNG_SEED_CB) && !defined(WC_GENERATE_SEED_DEFAULT) #define WC_GENERATE_SEED_DEFAULT wc_GenerateSeed #endif #ifdef __cplusplus } /* extern "C" */ #endif #endif /* WOLF_CRYPT_PORT_H */