1 /*	$OpenBSD: test_helper.h,v 1.9 2018/10/17 23:28:05 djm Exp $	*/
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 "includes.h"
24 
25 #include <sys/types.h>
26 #ifdef HAVE_STDINT_H
27 # include <stdint.h>
28 #endif
29 
30 #include <openssl/bn.h>
31 #include <openssl/err.h>
32 
33 enum test_predicate {
34 	TEST_EQ, TEST_NE, TEST_LT, TEST_LE, TEST_GT, TEST_GE
35 };
36 typedef void (test_onerror_func_t)(void *);
37 
38 /* Supplied by test suite */
39 void tests(void);
40 
41 const char *test_data_file(const char *name);
42 void test_start(const char *n);
43 void test_info(char *s, size_t len);
44 void set_onerror_func(test_onerror_func_t *f, void *ctx);
45 void test_done(void);
46 int test_is_verbose(void);
47 int test_is_quiet(void);
48 int test_is_fast(void);
49 int test_is_slow(void);
50 void test_subtest_info(const char *fmt, ...)
51     __attribute__((format(printf, 1, 2)));
52 void ssl_err_check(const char *file, int line);
53 void assert_bignum(const char *file, int line,
54     const char *a1, const char *a2,
55     const BIGNUM *aa1, const BIGNUM *aa2, enum test_predicate pred);
56 void assert_string(const char *file, int line,
57     const char *a1, const char *a2,
58     const char *aa1, const char *aa2, enum test_predicate pred);
59 void assert_mem(const char *file, int line,
60     const char *a1, const char *a2,
61     const void *aa1, const void *aa2, size_t l, enum test_predicate pred);
62 void assert_mem_filled(const char *file, int line,
63     const char *a1,
64     const void *aa1, u_char v, size_t l, enum test_predicate pred);
65 void assert_int(const char *file, int line,
66     const char *a1, const char *a2,
67     int aa1, int aa2, enum test_predicate pred);
68 void assert_size_t(const char *file, int line,
69     const char *a1, const char *a2,
70     size_t aa1, size_t aa2, enum test_predicate pred);
71 void assert_u_int(const char *file, int line,
72     const char *a1, const char *a2,
73     u_int aa1, u_int aa2, enum test_predicate pred);
74 void assert_long(const char *file, int line,
75     const char *a1, const char *a2,
76     long aa1, long aa2, enum test_predicate pred);
77 void assert_long_long(const char *file, int line,
78     const char *a1, const char *a2,
79     long long aa1, long long aa2, enum test_predicate pred);
80 void assert_char(const char *file, int line,
81     const char *a1, const char *a2,
82     char aa1, char aa2, enum test_predicate pred);
83 void assert_ptr(const char *file, int line,
84     const char *a1, const char *a2,
85     const void *aa1, const void *aa2, enum test_predicate pred);
86 void assert_u8(const char *file, int line,
87     const char *a1, const char *a2,
88     u_int8_t aa1, u_int8_t aa2, enum test_predicate pred);
89 void assert_u16(const char *file, int line,
90     const char *a1, const char *a2,
91     u_int16_t aa1, u_int16_t aa2, enum test_predicate pred);
92 void assert_u32(const char *file, int line,
93     const char *a1, const char *a2,
94     u_int32_t aa1, u_int32_t aa2, enum test_predicate pred);
95 void assert_u64(const char *file, int line,
96     const char *a1, const char *a2,
97     u_int64_t aa1, u_int64_t aa2, enum test_predicate pred);
98 
99 #define TEST_START(n)			test_start(n)
100 #define TEST_DONE()			test_done()
101 #define TEST_ONERROR(f, c)		set_onerror_func(f, c)
102 #define SSL_ERR_CHECK() 		ssl_err_check(__FILE__, __LINE__)
103 
104 #define ASSERT_BIGNUM_EQ(a1, a2) \
105 	assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
106 #define ASSERT_STRING_EQ(a1, a2) \
107 	assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
108 #define ASSERT_MEM_EQ(a1, a2, l) \
109 	assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_EQ)
110 #define ASSERT_MEM_FILLED_EQ(a1, c, l) \
111 	assert_mem_filled(__FILE__, __LINE__, #a1, a1, c, l, TEST_EQ)
112 #define ASSERT_MEM_ZERO_EQ(a1, l) \
113 	assert_mem_filled(__FILE__, __LINE__, #a1, a1, '\0', l, TEST_EQ)
114 #define ASSERT_INT_EQ(a1, a2) \
115 	assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
116 #define ASSERT_SIZE_T_EQ(a1, a2) \
117 	assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
118 #define ASSERT_U_INT_EQ(a1, a2) \
119 	assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
120 #define ASSERT_LONG_EQ(a1, a2) \
121 	assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
122 #define ASSERT_LONG_LONG_EQ(a1, a2) \
123 	assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
124 #define ASSERT_CHAR_EQ(a1, a2) \
125 	assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
126 #define ASSERT_PTR_EQ(a1, a2) \
127 	assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
128 #define ASSERT_U8_EQ(a1, a2) \
129 	assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
130 #define ASSERT_U16_EQ(a1, a2) \
131 	assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
132 #define ASSERT_U32_EQ(a1, a2) \
133 	assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
134 #define ASSERT_U64_EQ(a1, a2) \
135 	assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_EQ)
136 
137 #define ASSERT_BIGNUM_NE(a1, a2) \
138 	assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
139 #define ASSERT_STRING_NE(a1, a2) \
140 	assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
141 #define ASSERT_MEM_NE(a1, a2, l) \
142 	assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_NE)
143 #define ASSERT_MEM_ZERO_NE(a1, l) \
144 	assert_mem_filled(__FILE__, __LINE__, #a1, a1, '\0', l, TEST_NE)
145 #define ASSERT_INT_NE(a1, a2) \
146 	assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
147 #define ASSERT_SIZE_T_NE(a1, a2) \
148 	assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
149 #define ASSERT_U_INT_NE(a1, a2) \
150 	assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
151 #define ASSERT_LONG_NE(a1, a2) \
152 	assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
153 #define ASSERT_LONG_LONG_NE(a1, a2) \
154 	assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
155 #define ASSERT_CHAR_NE(a1, a2) \
156 	assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
157 #define ASSERT_PTR_NE(a1, a2) \
158 	assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
159 #define ASSERT_U8_NE(a1, a2) \
160 	assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
161 #define ASSERT_U16_NE(a1, a2) \
162 	assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
163 #define ASSERT_U32_NE(a1, a2) \
164 	assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
165 #define ASSERT_U64_NE(a1, a2) \
166 	assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_NE)
167 
168 #define ASSERT_BIGNUM_LT(a1, a2) \
169 	assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
170 #define ASSERT_STRING_LT(a1, a2) \
171 	assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
172 #define ASSERT_MEM_LT(a1, a2, l) \
173 	assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_LT)
174 #define ASSERT_INT_LT(a1, a2) \
175 	assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
176 #define ASSERT_SIZE_T_LT(a1, a2) \
177 	assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
178 #define ASSERT_U_INT_LT(a1, a2) \
179 	assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
180 #define ASSERT_LONG_LT(a1, a2) \
181 	assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
182 #define ASSERT_LONG_LONG_LT(a1, a2) \
183 	assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
184 #define ASSERT_CHAR_LT(a1, a2) \
185 	assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
186 #define ASSERT_PTR_LT(a1, a2) \
187 	assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
188 #define ASSERT_U8_LT(a1, a2) \
189 	assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
190 #define ASSERT_U16_LT(a1, a2) \
191 	assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
192 #define ASSERT_U32_LT(a1, a2) \
193 	assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
194 #define ASSERT_U64_LT(a1, a2) \
195 	assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LT)
196 
197 #define ASSERT_BIGNUM_LE(a1, a2) \
198 	assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
199 #define ASSERT_STRING_LE(a1, a2) \
200 	assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
201 #define ASSERT_MEM_LE(a1, a2, l) \
202 	assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_LE)
203 #define ASSERT_INT_LE(a1, a2) \
204 	assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
205 #define ASSERT_SIZE_T_LE(a1, a2) \
206 	assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
207 #define ASSERT_U_INT_LE(a1, a2) \
208 	assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
209 #define ASSERT_LONG_LE(a1, a2) \
210 	assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
211 #define ASSERT_LONG_LONG_LE(a1, a2) \
212 	assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
213 #define ASSERT_CHAR_LE(a1, a2) \
214 	assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
215 #define ASSERT_PTR_LE(a1, a2) \
216 	assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
217 #define ASSERT_U8_LE(a1, a2) \
218 	assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
219 #define ASSERT_U16_LE(a1, a2) \
220 	assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
221 #define ASSERT_U32_LE(a1, a2) \
222 	assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
223 #define ASSERT_U64_LE(a1, a2) \
224 	assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_LE)
225 
226 #define ASSERT_BIGNUM_GT(a1, a2) \
227 	assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
228 #define ASSERT_STRING_GT(a1, a2) \
229 	assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
230 #define ASSERT_MEM_GT(a1, a2, l) \
231 	assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_GT)
232 #define ASSERT_INT_GT(a1, a2) \
233 	assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
234 #define ASSERT_SIZE_T_GT(a1, a2) \
235 	assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
236 #define ASSERT_U_INT_GT(a1, a2) \
237 	assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
238 #define ASSERT_LONG_GT(a1, a2) \
239 	assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
240 #define ASSERT_LONG_LONG_GT(a1, a2) \
241 	assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
242 #define ASSERT_CHAR_GT(a1, a2) \
243 	assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
244 #define ASSERT_PTR_GT(a1, a2) \
245 	assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
246 #define ASSERT_U8_GT(a1, a2) \
247 	assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
248 #define ASSERT_U16_GT(a1, a2) \
249 	assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
250 #define ASSERT_U32_GT(a1, a2) \
251 	assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
252 #define ASSERT_U64_GT(a1, a2) \
253 	assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GT)
254 
255 #define ASSERT_BIGNUM_GE(a1, a2) \
256 	assert_bignum(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
257 #define ASSERT_STRING_GE(a1, a2) \
258 	assert_string(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
259 #define ASSERT_MEM_GE(a1, a2, l) \
260 	assert_mem(__FILE__, __LINE__, #a1, #a2, a1, a2, l, TEST_GE)
261 #define ASSERT_INT_GE(a1, a2) \
262 	assert_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
263 #define ASSERT_SIZE_T_GE(a1, a2) \
264 	assert_size_t(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
265 #define ASSERT_U_INT_GE(a1, a2) \
266 	assert_u_int(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
267 #define ASSERT_LONG_GE(a1, a2) \
268 	assert_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
269 #define ASSERT_LONG_LONG_GE(a1, a2) \
270 	assert_long_long(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
271 #define ASSERT_CHAR_GE(a1, a2) \
272 	assert_char(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
273 #define ASSERT_PTR_GE(a1, a2) \
274 	assert_ptr(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
275 #define ASSERT_U8_GE(a1, a2) \
276 	assert_u8(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
277 #define ASSERT_U16_GE(a1, a2) \
278 	assert_u16(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
279 #define ASSERT_U32_GE(a1, a2) \
280 	assert_u32(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
281 #define ASSERT_U64_GE(a1, a2) \
282 	assert_u64(__FILE__, __LINE__, #a1, #a2, a1, a2, TEST_GE)
283 
284 /* Fuzzing support */
285 
286 struct fuzz;
287 #define FUZZ_1_BIT_FLIP		0x00000001	/* Flip one bit at a time */
288 #define FUZZ_2_BIT_FLIP		0x00000002	/* Flip two bits at a time */
289 #define FUZZ_1_BYTE_FLIP	0x00000004	/* Flip one byte at a time */
290 #define FUZZ_2_BYTE_FLIP	0x00000008	/* Flip two bytes at a time */
291 #define FUZZ_TRUNCATE_START	0x00000010	/* Truncate from beginning */
292 #define FUZZ_TRUNCATE_END	0x00000020	/* Truncate from end */
293 #define FUZZ_BASE64		0x00000040	/* Try all base64 chars */
294 #define FUZZ_MAX		FUZZ_BASE64
295 
296 /* Start fuzzing a blob of data with selected strategies (bitmask) */
297 struct fuzz *fuzz_begin(u_int strategies, const void *p, size_t l);
298 
299 /* Free a fuzz context */
300 void fuzz_cleanup(struct fuzz *fuzz);
301 
302 /* Prepare the next fuzz case in the series */
303 void fuzz_next(struct fuzz *fuzz);
304 
305 /*
306  * Check whether this fuzz case is identical to the original
307  * This is slow, but useful if the caller needs to ensure that all tests
308  * generated change the input (e.g. when fuzzing signatures).
309  */
310 int fuzz_matches_original(struct fuzz *fuzz);
311 
312 /* Determine whether the current fuzz sequence is exhausted (nonzero = yes) */
313 int fuzz_done(struct fuzz *fuzz);
314 
315 /* Return the length and a pointer to the current fuzzed case */
316 size_t fuzz_len(struct fuzz *fuzz);
317 u_char *fuzz_ptr(struct fuzz *fuzz);
318 
319 /* Dump the current fuzz case to stderr */
320 void fuzz_dump(struct fuzz *fuzz);
321 
322 #endif /* _TEST_HELPER_H */
323