1 /* 2 * ck - C11 Annex K wrappers (selected functions; not complete) 3 * 4 * ck is also an abbreviation for "check". 5 * These are validating, checking functions. 6 * 7 * Copyright(c) 2016,2021 Glenn Strauss gstrauss()gluelogic.com All rights reserved 8 * License: BSD 3-clause (same as lighttpd) 9 */ 10 #ifndef INCLUDED_CK_H 11 #define INCLUDED_CK_H 12 #ifndef __STDC_WANT_LIB_EXT1__ /*(enable C11 Annex K ext1 *_s functions)*/ 13 #define __STDC_WANT_LIB_EXT1__ 1 14 #endif 15 #include "first.h" 16 #ifdef __FreeBSD__ 17 #include <errno.h> 18 #endif 19 20 __BEGIN_DECLS 21 22 23 #ifndef RSIZE_MAX 24 #define RSIZE_MAX (SIZE_MAX >> 1) 25 typedef size_t rsize_t; 26 typedef int errno_t; 27 #endif 28 29 30 errno_t ck_getenv_s (size_t * restrict len, char * restrict value, rsize_t maxsize, const char * restrict name); 31 32 /*(ck_memclear_s() is not from C11 Annex K 33 * ck_memclear_s() is similar to memset_s() using constant byte 0 for fill)*/ 34 errno_t ck_memclear_s (void *s, rsize_t smax, rsize_t n); 35 36 /*(ck_memzero() is not from C11 Annex K 37 * ck_memzero() is a convenience wrapper around ck_memclear_s())*/ 38 static inline errno_t ck_memzero(void *s, rsize_t n); 39 static inline errno_t ck_memzero(void *s, rsize_t n) { 40 return ck_memclear_s(s, n, n); 41 } 42 43 errno_t ck_strerror_s (char *s, rsize_t maxsize, errno_t errnum); 44 45 /*(ck_memeq_const_time() is not from C11 Annex K) 46 * constant time memory compare for equality 47 * rounds to next multiple of 64 to avoid potentially leaking exact 48 * string lengths when subject to high precision timing attacks */ 49 __attribute_nonnull__ 50 int ck_memeq_const_time (const void *a, size_t alen, const void *b, size_t blen); 51 52 /*(ck_memeq_const_time_fixed_len() is not from C11 Annex K) 53 * constant time memory compare for equality for fixed len (e.g. digests) 54 * (padding not necessary for digests, which have fixed, defined lengths) */ 55 __attribute_nonnull__ 56 int ck_memeq_const_time_fixed_len (const void *a, const void *b, size_t len); 57 58 59 /*(ck_bt() is not from C11 Annex K) 60 * ck_bt() prints backtrace to stderr */ 61 __attribute_cold__ 62 __attribute_nonnull__ 63 void ck_bt(const char *filename, unsigned int line, const char *msg); 64 65 /*(ck_bt_abort() is not from C11 Annex K) 66 * ck_bt_abort() prints backtrace to stderr and calls abort() */ 67 __attribute_cold__ 68 __attribute_nonnull__ 69 __attribute_noreturn__ 70 void ck_bt_abort(const char *filename, unsigned int line, const char *msg); 71 72 /*(ck_assert() and ck_assert_failed() are not from C11 Annex K) 73 * ck_assert() executes a runtime assertion test or aborts 74 * ck_assert() *is not* optimized away if defined(NDEBUG) 75 * (unlike standard assert(), which *is* optimized away if defined(NDEBUG)) */ 76 __attribute_cold__ 77 __attribute_nonnull__ 78 __attribute_noreturn__ 79 void ck_assert_failed(const char *filename, unsigned int line, const char *msg); 80 81 #define ck_assert(x) \ 82 do { if (!(x)) ck_assert_failed(__FILE__, __LINE__, #x); } while (0) 83 84 85 __END_DECLS 86 87 88 #endif 89