1 /* test/heartbeat_test.c */
3 * Unit test for TLS heartbeats.
5 * Acts as a regression test against the Heartbleed bug (CVE-2014-0160).
7 * Author: Mike Bland (mbland@acm.org, http://mike-bland.com/)
9 * License: Creative Commons Attribution 4.0 International (CC By 4.0)
10 * http://creativecommons.org/licenses/by/4.0/deed.en_US
14 * The program returns zero on success. It will print a message with a count
15 * of the number of failed tests and return nonzero if any tests fail.
17 * It will print the contents of the request and response buffers for each
18 * failing test. In a "fixed" version, all the tests should pass and there
19 * should be no output.
21 * In a "bleeding" version, you'll see:
23 * test_dtls1_heartbleed failed:
24 * expected payload len: 0
28 * received 1024 characters
29 * "HEARTBLEED \xde\xad\xbe\xef..."
30 * ** test_dtls1_heartbleed failed **
32 * The contents of the returned buffer in the failing test will depend on the
33 * contents of memory on your machine.
37 * http://mike-bland.com/2014/04/12/heartbleed.html
38 * http://mike-bland.com/tags/heartbleed.html
41 #include "../ssl/ssl_locl.h"
47 #ifndef OPENSSL_NO_HEARTBEATS
49 /* As per https://tools.ietf.org/html/rfc6520#section-4 */
50 #define MIN_PADDING_SIZE 16
52 /* Maximum number of payload characters to print as test output */
53 #define MAX_PRINTABLE_CHARACTERS 1024
55 typedef struct heartbeat_test_fixture
59 const char* test_case_name;
60 int (*process_heartbeat)(SSL* s);
61 unsigned char* payload;
63 int expected_return_value;
64 int return_payload_offset;
65 int expected_payload_len;
66 const char* expected_return_payload;
67 } HEARTBEAT_TEST_FIXTURE;
69 static HEARTBEAT_TEST_FIXTURE set_up(const char* const test_case_name,
70 const SSL_METHOD* meth)
72 HEARTBEAT_TEST_FIXTURE fixture;
74 memset(&fixture, 0, sizeof(fixture));
75 fixture.test_case_name = test_case_name;
77 fixture.ctx = SSL_CTX_new(meth);
80 fprintf(stderr, "Failed to allocate SSL_CTX for test: %s\n",
86 fixture.s = SSL_new(fixture.ctx);
89 fprintf(stderr, "Failed to allocate SSL for test: %s\n", test_case_name);
94 if (!ssl_init_wbio_buffer(fixture.s, 1))
96 fprintf(stderr, "Failed to set up wbio buffer for test: %s\n",
102 if (!ssl3_setup_buffers(fixture.s))
104 fprintf(stderr, "Failed to setup buffers for test: %s\n",
110 /* Clear the memory for the return buffer, since this isn't automatically
111 * zeroed in opt mode and will cause spurious test failures that will change
112 * with each execution.
114 memset(fixture.s->s3->wbuf.buf, 0, fixture.s->s3->wbuf.len);
119 ERR_print_errors_fp(stderr);
125 static HEARTBEAT_TEST_FIXTURE set_up_dtls(const char* const test_case_name)
127 HEARTBEAT_TEST_FIXTURE fixture = set_up(test_case_name,
128 DTLSv1_server_method());
129 fixture.process_heartbeat = dtls1_process_heartbeat;
131 /* As per dtls1_get_record(), skipping the following from the beginning of
132 * the returned heartbeat message:
133 * type-1 byte; version-2 bytes; sequence number-8 bytes; length-2 bytes
135 * And then skipping the 1-byte type encoded by process_heartbeat for
136 * a total of 14 bytes, at which point we can grab the length and the
139 fixture.return_payload_offset = 14;
143 /* Needed by ssl3_write_bytes() */
144 static int dummy_handshake(SSL* s)
149 static HEARTBEAT_TEST_FIXTURE set_up_tls(const char* const test_case_name)
151 HEARTBEAT_TEST_FIXTURE fixture = set_up(test_case_name,
152 TLSv1_server_method());
153 fixture.process_heartbeat = tls1_process_heartbeat;
154 fixture.s->handshake_func = dummy_handshake;
156 /* As per do_ssl3_write(), skipping the following from the beginning of
157 * the returned heartbeat message:
158 * type-1 byte; version-2 bytes; length-2 bytes
160 * And then skipping the 1-byte type encoded by process_heartbeat for
161 * a total of 6 bytes, at which point we can grab the length and the payload
164 fixture.return_payload_offset = 6;
168 static void tear_down(HEARTBEAT_TEST_FIXTURE fixture)
170 ERR_print_errors_fp(stderr);
172 SSL_CTX_free(fixture.ctx);
175 static void print_payload(const char* const prefix,
176 const unsigned char *payload, const int n)
178 const int end = n < MAX_PRINTABLE_CHARACTERS ? n
179 : MAX_PRINTABLE_CHARACTERS;
182 printf("%s %d character%s", prefix, n, n == 1 ? "" : "s");
183 if (end != n) printf(" (first %d shown)", end);
186 for (; i != end; ++i)
188 const unsigned char c = payload[i];
189 if (isprint(c)) fputc(c, stdout);
190 else printf("\\x%02x", c);
195 static int execute_heartbeat(HEARTBEAT_TEST_FIXTURE fixture)
199 unsigned char *payload = fixture.payload;
200 unsigned char sent_buf[MAX_PRINTABLE_CHARACTERS + 1];
202 unsigned const char *p;
203 int actual_payload_len;
205 s->s3->rrec.data = payload;
206 s->s3->rrec.length = strlen((const char*)payload);
207 *payload++ = TLS1_HB_REQUEST;
208 s2n(fixture.sent_payload_len, payload);
210 /* Make a local copy of the request, since it gets overwritten at some
212 memcpy((char *)sent_buf, (const char*)payload, sizeof(sent_buf));
214 return_value = fixture.process_heartbeat(s);
216 if (return_value != fixture.expected_return_value)
218 printf("%s failed: expected return value %d, received %d\n",
219 fixture.test_case_name, fixture.expected_return_value,
224 /* If there is any byte alignment, it will be stored in wbuf.offset. */
225 p = &(s->s3->wbuf.buf[
226 fixture.return_payload_offset + s->s3->wbuf.offset]);
227 actual_payload_len = 0;
228 n2s(p, actual_payload_len);
230 if (actual_payload_len != fixture.expected_payload_len)
232 printf("%s failed:\n expected payload len: %d\n received: %d\n",
233 fixture.test_case_name, fixture.expected_payload_len,
235 print_payload("sent", sent_buf, strlen((const char*)sent_buf));
236 print_payload("received", p, actual_payload_len);
241 char* actual_payload = BUF_strndup((const char*)p, actual_payload_len);
242 if (strcmp(actual_payload, fixture.expected_return_payload) != 0)
244 printf("%s failed:\n expected payload: \"%s\"\n received: \"%s\"\n",
245 fixture.test_case_name, fixture.expected_return_payload,
249 OPENSSL_free(actual_payload);
254 printf("** %s failed **\n--------\n", fixture.test_case_name);
259 static int honest_payload_size(unsigned char payload_buf[])
261 /* Omit three-byte pad at the beginning for type and payload length */
262 return strlen((const char*)&payload_buf[3]) - MIN_PADDING_SIZE;
265 #define SETUP_HEARTBEAT_TEST_FIXTURE(type)\
266 HEARTBEAT_TEST_FIXTURE fixture = set_up_##type(__func__);\
269 #define EXECUTE_HEARTBEAT_TEST()\
270 if (execute_heartbeat(fixture) != 0) result = 1;\
274 static int test_dtls1_not_bleeding()
276 SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
277 /* Three-byte pad at the beginning for type and payload length */
278 unsigned char payload_buf[] = " Not bleeding, sixteen spaces of padding"
280 const int payload_buf_len = honest_payload_size(payload_buf);
282 fixture.payload = &payload_buf[0];
283 fixture.sent_payload_len = payload_buf_len;
284 fixture.expected_return_value = 0;
285 fixture.expected_payload_len = payload_buf_len;
286 fixture.expected_return_payload = "Not bleeding, sixteen spaces of padding";
287 EXECUTE_HEARTBEAT_TEST();
290 static int test_dtls1_not_bleeding_empty_payload()
294 SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
295 /* Three-byte pad at the beginning for type and payload length, plus a NUL
297 unsigned char payload_buf[4 + MIN_PADDING_SIZE];
298 memset(payload_buf, ' ', sizeof(payload_buf));
299 payload_buf[sizeof(payload_buf) - 1] = '\0';
300 payload_buf_len = honest_payload_size(payload_buf);
302 fixture.payload = &payload_buf[0];
303 fixture.sent_payload_len = payload_buf_len;
304 fixture.expected_return_value = 0;
305 fixture.expected_payload_len = payload_buf_len;
306 fixture.expected_return_payload = "";
307 EXECUTE_HEARTBEAT_TEST();
310 static int test_dtls1_heartbleed()
312 SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
313 /* Three-byte pad at the beginning for type and payload length */
314 unsigned char payload_buf[] = " HEARTBLEED ";
316 fixture.payload = &payload_buf[0];
317 fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
318 fixture.expected_return_value = 0;
319 fixture.expected_payload_len = 0;
320 fixture.expected_return_payload = "";
321 EXECUTE_HEARTBEAT_TEST();
324 static int test_dtls1_heartbleed_empty_payload()
326 SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
327 /* Excluding the NUL at the end, one byte short of type + payload length +
329 unsigned char payload_buf[MIN_PADDING_SIZE + 3];
330 memset(payload_buf, ' ', sizeof(payload_buf));
331 payload_buf[sizeof(payload_buf) - 1] = '\0';
333 fixture.payload = &payload_buf[0];
334 fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
335 fixture.expected_return_value = 0;
336 fixture.expected_payload_len = 0;
337 fixture.expected_return_payload = "";
338 EXECUTE_HEARTBEAT_TEST();
341 static int test_dtls1_heartbleed_excessive_plaintext_length()
343 SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
344 /* Excluding the NUL at the end, one byte in excess of maximum allowed
345 * heartbeat message length */
346 unsigned char payload_buf[SSL3_RT_MAX_PLAIN_LENGTH + 2];
347 memset(payload_buf, ' ', sizeof(payload_buf));
348 payload_buf[sizeof(payload_buf) - 1] = '\0';
350 fixture.payload = &payload_buf[0];
351 fixture.sent_payload_len = honest_payload_size(payload_buf);
352 fixture.expected_return_value = 0;
353 fixture.expected_payload_len = 0;
354 fixture.expected_return_payload = "";
355 EXECUTE_HEARTBEAT_TEST();
358 static int test_tls1_not_bleeding()
360 SETUP_HEARTBEAT_TEST_FIXTURE(tls);
361 /* Three-byte pad at the beginning for type and payload length */
362 unsigned char payload_buf[] = " Not bleeding, sixteen spaces of padding"
364 const int payload_buf_len = honest_payload_size(payload_buf);
366 fixture.payload = &payload_buf[0];
367 fixture.sent_payload_len = payload_buf_len;
368 fixture.expected_return_value = 0;
369 fixture.expected_payload_len = payload_buf_len;
370 fixture.expected_return_payload = "Not bleeding, sixteen spaces of padding";
371 EXECUTE_HEARTBEAT_TEST();
374 static int test_tls1_not_bleeding_empty_payload()
378 SETUP_HEARTBEAT_TEST_FIXTURE(tls);
379 /* Three-byte pad at the beginning for type and payload length, plus a NUL
381 unsigned char payload_buf[4 + MIN_PADDING_SIZE];
382 memset(payload_buf, ' ', sizeof(payload_buf));
383 payload_buf[sizeof(payload_buf) - 1] = '\0';
384 payload_buf_len = honest_payload_size(payload_buf);
386 fixture.payload = &payload_buf[0];
387 fixture.sent_payload_len = payload_buf_len;
388 fixture.expected_return_value = 0;
389 fixture.expected_payload_len = payload_buf_len;
390 fixture.expected_return_payload = "";
391 EXECUTE_HEARTBEAT_TEST();
394 static int test_tls1_heartbleed()
396 SETUP_HEARTBEAT_TEST_FIXTURE(tls);
397 /* Three-byte pad at the beginning for type and payload length */
398 unsigned char payload_buf[] = " HEARTBLEED ";
400 fixture.payload = &payload_buf[0];
401 fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
402 fixture.expected_return_value = 0;
403 fixture.expected_payload_len = 0;
404 fixture.expected_return_payload = "";
405 EXECUTE_HEARTBEAT_TEST();
408 static int test_tls1_heartbleed_empty_payload()
410 SETUP_HEARTBEAT_TEST_FIXTURE(tls);
411 /* Excluding the NUL at the end, one byte short of type + payload length +
413 unsigned char payload_buf[MIN_PADDING_SIZE + 3];
414 memset(payload_buf, ' ', sizeof(payload_buf));
415 payload_buf[sizeof(payload_buf) - 1] = '\0';
417 fixture.payload = &payload_buf[0];
418 fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
419 fixture.expected_return_value = 0;
420 fixture.expected_payload_len = 0;
421 fixture.expected_return_payload = "";
422 EXECUTE_HEARTBEAT_TEST();
425 #undef EXECUTE_HEARTBEAT_TEST
426 #undef SETUP_HEARTBEAT_TEST_FIXTURE
428 int main(int argc, char *argv[])
433 SSL_load_error_strings();
435 num_failed = test_dtls1_not_bleeding() +
436 test_dtls1_not_bleeding_empty_payload() +
437 test_dtls1_heartbleed() +
438 test_dtls1_heartbleed_empty_payload() +
439 /* The following test causes an assertion failure at
440 * ssl/d1_pkt.c:dtls1_write_bytes() in versions prior to 1.0.1g: */
441 (OPENSSL_VERSION_NUMBER >= 0x1000107fL ?
442 test_dtls1_heartbleed_excessive_plaintext_length() : 0) +
443 test_tls1_not_bleeding() +
444 test_tls1_not_bleeding_empty_payload() +
445 test_tls1_heartbleed() +
446 test_tls1_heartbleed_empty_payload() +
449 ERR_print_errors_fp(stderr);
453 printf("%d test%s failed\n", num_failed, num_failed != 1 ? "s" : "");
459 #else /* OPENSSL_NO_HEARTBEATS*/
461 int main(int argc, char *argv[])
465 #endif /* OPENSSL_NO_HEARTBEATS */