1 /* $OpenBSD */ 2 /* 3 * Copyright (c) 2011 Damien Miller <djm@mindrot.org> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 18 /* Utility functions/framework for regress tests */ 19 20 #ifndef _TEST_HELPER_H 21 #define _TEST_HELPER_H 22 23 #include <sys/types.h> 24 #include <stdint.h> 25 26 #include <openssl/bn.h> 27 #include <openssl/err.h> 28 29 enum test_predicate { 30 TEST_EQ, TEST_NE, TEST_LT, TEST_LE, TEST_GT, TEST_GE 31 }; 32 typedef void (test_onerror_func_t)(void *); 33 34 /* Supplied by test suite */ 35 void tests(void); 36 37 const char *test_data_file(const char *name); 38 void test_start(const char *n); 39 void set_onerror_func(test_onerror_func_t *f, void *ctx); 40 void test_done(void); 41 void assert_string(const char *file, int line, 42 const char *a1, const char *a2, 43 const char *aa1, const char *aa2, enum test_predicate pred); 44 void assert_mem(const char *file, int line, 45 const char *a1, const char *a2, 46 const void *aa1, const void *aa2, size_t l, enum test_predicate pred); 47 void assert_mem_filled(const char *file, int line, 48 const char *a1, 49 const void *aa1, u_char v, size_t l, enum test_predicate pred); 50 void assert_int(const char *file, int line, 51 const char *a1, const char *a2, 52 int aa1, int aa2, enum test_predicate pred); 53 void assert_size_t(const char *file, int line, 54 const char *a1, const char *a2, 55 size_t aa1, size_t aa2, enum test_predicate pred); 56 void assert_u_int(const char *file, int line, 57 const char *a1, const char *a2, 58 u_int aa1, u_int aa2, enum test_predicate pred); 59 void assert_long_long(const char *file, int line, 60 const char *a1, const char *a2, 61 long long aa1, long long aa2, enum test_predicate pred); 62 void assert_char(const char *file, int line, 63 const char *a1, const char *a2, 64 char aa1, char aa2, enum test_predicate pred); 65 void assert_ptr(const char *file, int line, 66 const char *a1, const char *a2, 67 const void *aa1, const void *aa2, enum test_predicate pred); 68 void assert_u8(const char *file, int line, 69 const char *a1, const char *a2, 70 u_int8_t aa1, u_int8_t aa2, enum test_predicate pred); 71 void assert_u16(const char *file, int line, 72 const char *a1, const char *a2, 73 u_int16_t aa1, u_int16_t aa2, enum test_predicate pred); 74 void assert_u32(const char *file, int line, 75 const char *a1, const char *a2, 76 u_int32_t aa1, u_int32_t aa2, enum test_predicate pred); 77 void assert_u64(const char *file, int line, 78 const char *a1, const char *a2, 79 u_int64_t aa1, u_int64_t aa2, enum test_predicate pred); 80 81 #define TEST_START(n) test_start(n) 82 #define TEST_DONE() test_done() 83 #define TEST_ONERROR(f, c) set_onerror_func(f, c) 84 85 #define ASSERT_STRING_EQ(a1, a2) \ 86 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 87 #define ASSERT_MEM_EQ(a1, a2, l) \ 88 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_EQ) 89 #define ASSERT_MEM_FILLED_EQ(a1, c, l) \ 90 assert_mem_filled(__FILE__, __LINE__, #a1, a1, c, l, TEST_EQ) 91 #define ASSERT_MEM_ZERO_EQ(a1, l) \ 92 assert_mem_filled(__FILE__, __LINE__, #a1, a1, '\0', l, TEST_EQ) 93 #define ASSERT_INT_EQ(a1, a2) \ 94 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 95 #define ASSERT_SIZE_T_EQ(a1, a2) \ 96 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 97 #define ASSERT_U_INT_EQ(a1, a2) \ 98 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 99 #define ASSERT_LONG_LONG_EQ(a1, a2) \ 100 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 101 #define ASSERT_CHAR_EQ(a1, a2) \ 102 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 103 #define ASSERT_PTR_EQ(a1, a2) \ 104 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 105 #define ASSERT_U8_EQ(a1, a2) \ 106 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 107 #define ASSERT_U16_EQ(a1, a2) \ 108 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 109 #define ASSERT_U32_EQ(a1, a2) \ 110 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 111 #define ASSERT_U64_EQ(a1, a2) \ 112 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ) 113 114 #define ASSERT_STRING_NE(a1, a2) \ 115 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 116 #define ASSERT_MEM_NE(a1, a2, l) \ 117 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_NE) 118 #define ASSERT_MEM_ZERO_NE(a1, l) \ 119 assert_mem_filled(__FILE__, __LINE__, #a1, a1, '\0', l, TEST_NE) 120 #define ASSERT_INT_NE(a1, a2) \ 121 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 122 #define ASSERT_SIZE_T_NE(a1, a2) \ 123 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 124 #define ASSERT_U_INT_NE(a1, a2) \ 125 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 126 #define ASSERT_LONG_LONG_NE(a1, a2) \ 127 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 128 #define ASSERT_CHAR_NE(a1, a2) \ 129 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 130 #define ASSERT_PTR_NE(a1, a2) \ 131 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 132 #define ASSERT_U8_NE(a1, a2) \ 133 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 134 #define ASSERT_U16_NE(a1, a2) \ 135 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 136 #define ASSERT_U32_NE(a1, a2) \ 137 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 138 #define ASSERT_U64_NE(a1, a2) \ 139 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE) 140 141 #define ASSERT_STRING_LT(a1, a2) \ 142 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 143 #define ASSERT_MEM_LT(a1, a2, l) \ 144 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_LT) 145 #define ASSERT_INT_LT(a1, a2) \ 146 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 147 #define ASSERT_SIZE_T_LT(a1, a2) \ 148 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 149 #define ASSERT_U_INT_LT(a1, a2) \ 150 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 151 #define ASSERT_LONG_LONG_LT(a1, a2) \ 152 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 153 #define ASSERT_CHAR_LT(a1, a2) \ 154 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 155 #define ASSERT_PTR_LT(a1, a2) \ 156 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 157 #define ASSERT_U8_LT(a1, a2) \ 158 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 159 #define ASSERT_U16_LT(a1, a2) \ 160 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 161 #define ASSERT_U32_LT(a1, a2) \ 162 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 163 #define ASSERT_U64_LT(a1, a2) \ 164 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT) 165 166 #define ASSERT_STRING_LE(a1, a2) \ 167 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 168 #define ASSERT_MEM_LE(a1, a2, l) \ 169 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_LE) 170 #define ASSERT_INT_LE(a1, a2) \ 171 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 172 #define ASSERT_SIZE_T_LE(a1, a2) \ 173 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 174 #define ASSERT_U_INT_LE(a1, a2) \ 175 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 176 #define ASSERT_LONG_LONG_LE(a1, a2) \ 177 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 178 #define ASSERT_CHAR_LE(a1, a2) \ 179 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 180 #define ASSERT_PTR_LE(a1, a2) \ 181 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 182 #define ASSERT_U8_LE(a1, a2) \ 183 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 184 #define ASSERT_U16_LE(a1, a2) \ 185 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 186 #define ASSERT_U32_LE(a1, a2) \ 187 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 188 #define ASSERT_U64_LE(a1, a2) \ 189 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE) 190 191 #define ASSERT_STRING_GT(a1, a2) \ 192 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 193 #define ASSERT_MEM_GT(a1, a2, l) \ 194 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_GT) 195 #define ASSERT_INT_GT(a1, a2) \ 196 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 197 #define ASSERT_SIZE_T_GT(a1, a2) \ 198 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 199 #define ASSERT_U_INT_GT(a1, a2) \ 200 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 201 #define ASSERT_LONG_LONG_GT(a1, a2) \ 202 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 203 #define ASSERT_CHAR_GT(a1, a2) \ 204 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 205 #define ASSERT_PTR_GT(a1, a2) \ 206 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 207 #define ASSERT_U8_GT(a1, a2) \ 208 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 209 #define ASSERT_U16_GT(a1, a2) \ 210 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 211 #define ASSERT_U32_GT(a1, a2) \ 212 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 213 #define ASSERT_U64_GT(a1, a2) \ 214 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT) 215 216 #define ASSERT_STRING_GE(a1, a2) \ 217 assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 218 #define ASSERT_MEM_GE(a1, a2, l) \ 219 assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_GE) 220 #define ASSERT_INT_GE(a1, a2) \ 221 assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 222 #define ASSERT_SIZE_T_GE(a1, a2) \ 223 assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 224 #define ASSERT_U_INT_GE(a1, a2) \ 225 assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 226 #define ASSERT_LONG_LONG_GE(a1, a2) \ 227 assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 228 #define ASSERT_CHAR_GE(a1, a2) \ 229 assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 230 #define ASSERT_PTR_GE(a1, a2) \ 231 assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 232 #define ASSERT_U8_GE(a1, a2) \ 233 assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 234 #define ASSERT_U16_GE(a1, a2) \ 235 assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 236 #define ASSERT_U32_GE(a1, a2) \ 237 assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 238 #define ASSERT_U64_GE(a1, a2) \ 239 assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE) 240 241 /* Fuzzing support */ 242 243 struct fuzz; 244 #define FUZZ_1_BIT_FLIP 0x00000001 /* Flip one bit at a time */ 245 #define FUZZ_2_BIT_FLIP 0x00000002 /* Flip two bits at a time */ 246 #define FUZZ_1_BYTE_FLIP 0x00000004 /* Flip one byte at a time */ 247 #define FUZZ_2_BYTE_FLIP 0x00000008 /* Flip two bytes at a time */ 248 #define FUZZ_TRUNCATE_START 0x00000010 /* Truncate from beginning */ 249 #define FUZZ_TRUNCATE_END 0x00000020 /* Truncate from end */ 250 #define FUZZ_BASE64 0x00000040 /* Try all base64 chars */ 251 #define FUZZ_MAX FUZZ_BASE64 252 253 /* Start fuzzing a blob of data with selected strategies (bitmask) */ 254 struct fuzz *fuzz_begin(u_int strategies, void *p, size_t l); 255 256 /* Free a fuzz context */ 257 void fuzz_cleanup(struct fuzz *fuzz); 258 259 /* Prepare the next fuzz case in the series */ 260 void fuzz_next(struct fuzz *fuzz); 261 262 /* Determine whether the current fuzz sequence is exhausted (nonzero = yes) */ 263 int fuzz_done(struct fuzz *fuzz); 264 265 /* Return the length and a pointer to the current fuzzed case */ 266 size_t fuzz_len(struct fuzz *fuzz); 267 u_char *fuzz_ptr(struct fuzz *fuzz); 268 269 /* Dump the current fuzz case to stderr */ 270 void fuzz_dump(struct fuzz *fuzz); 271 #endif /* _TEST_HELPER_H */ 272