ssl/heartbeat_test.c

   1 /* test/heartbeat_test.c */
   2 /*
   3  * Unit test for TLS heartbeats.
   4  *
   5  * Acts as a regression test against the Heartbleed bug (CVE-2014-0160).
   6  *
   7  * Author:  Mike Bland (mbland@acm.org, http://mike-bland.com/)
   8  * Date:    2014-04-12
   9  * License: Creative Commons Attribution 4.0 International (CC By 4.0)
  10  *          http://creativecommons.org/licenses/by/4.0/deed.en_US
  11  *
  12  * OUTPUT
  13  * ------
  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.
  16  *
  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.
  20  *
  21  * In a "bleeding" version, you'll see:
  22  *
  23  *   test_dtls1_heartbleed failed:
  24  *     expected payload len: 0
  25  *     received: 1024
  26  *   sent 26 characters
  27  *     "HEARTBLEED                "
  28  *   received 1024 characters
  29  *     "HEARTBLEED                \xde\xad\xbe\xef..."
  30  *   ** test_dtls1_heartbleed failed **
  31  *
  32  * The contents of the returned buffer in the failing test will depend on the
  33  * contents of memory on your machine.
  34  *
  35  * MORE INFORMATION
  36  * ----------------
  37  * http://mike-bland.com/2014/04/12/heartbleed.html
  38  * http://mike-bland.com/tags/heartbleed.html
  39  */
  40
  41 #include "../ssl/ssl_locl.h"
  42 #include <ctype.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46
  47 /* As per https://tools.ietf.org/html/rfc6520#section-4 */
  48 #define MIN_PADDING_SIZE        16
  49
  50 /* Maximum number of payload characters to print as test output */
  51 #define MAX_PRINTABLE_CHARACTERS        1024
  52
  53 typedef struct heartbeat_test_fixture
  54         {
  55         SSL_CTX *ctx;
  56         SSL *s;
  57         const char* test_case_name;
  58         int (*process_heartbeat)(SSL* s);
  59         unsigned char* payload;
  60         int sent_payload_len;
  61         int expected_return_value;
  62         int return_payload_offset;
  63         int expected_payload_len;
  64         const char* expected_return_payload;
  65         } HEARTBEAT_TEST_FIXTURE;
  66
  67 static HEARTBEAT_TEST_FIXTURE set_up(const char* const test_case_name,
  68         const SSL_METHOD* meth)
  69         {
  70         HEARTBEAT_TEST_FIXTURE fixture;
  71         int setup_ok = 1;
  72         memset(&fixture, 0, sizeof(fixture));
  73         fixture.test_case_name = test_case_name;
  74
  75         fixture.ctx = SSL_CTX_new(meth);
  76         if (!fixture.ctx)
  77                 {
  78                 fprintf(stderr, "Failed to allocate SSL_CTX for test: %s\n",
  79                         test_case_name);
  80                 setup_ok = 0;
  81                 goto fail;
  82                 }
  83
  84         fixture.s = SSL_new(fixture.ctx);
  85         if (!fixture.s)
  86                 {
  87                 fprintf(stderr, "Failed to allocate SSL for test: %s\n", test_case_name);
  88                 setup_ok = 0;
  89                 goto fail;
  90                 }
  91
  92         if (!ssl_init_wbio_buffer(fixture.s, 1))
  93                 {
  94                 fprintf(stderr, "Failed to set up wbio buffer for test: %s\n",
  95                         test_case_name);
  96                 setup_ok = 0;
  97                 goto fail;
  98                 }
  99
 100         if (!ssl3_setup_buffers(fixture.s))
 101                 {
 102                 fprintf(stderr, "Failed to setup buffers for test: %s\n",
 103                         test_case_name);
 104                 setup_ok = 0;
 105                 goto fail;
 106                 }
 107
 108         fail:
 109         if (!setup_ok)
 110                 {
 111                 ERR_print_errors_fp(stderr);
 112                 exit(EXIT_FAILURE);
 113                 }
 114         return fixture;
 115         }
 116
 117 static HEARTBEAT_TEST_FIXTURE set_up_dtls(const char* const test_case_name)
 118         {
 119         HEARTBEAT_TEST_FIXTURE fixture = set_up(test_case_name,
 120                 DTLSv1_server_method());
 121         fixture.process_heartbeat = dtls1_process_heartbeat;
 122
 123         /* As per dtls1_get_record(), skipping the following from the beginning of
 124          * the returned heartbeat message:
 125          * type-1 byte; version-2 bytes; sequence number-8 bytes; length-2 bytes
 126          *
 127          * And then skipping the 1-byte type encoded by process_heartbeat for
 128          * a total of 14 bytes, at which point we can grab the length and the
 129          * payload we seek.
 130          */
 131         fixture.return_payload_offset = 14;
 132         return fixture;
 133         }
 134
 135 /* Needed by ssl3_write_bytes() */
 136 static int dummy_handshake(SSL* s)
 137         {
 138         return 1;
 139         }
 140
 141 static HEARTBEAT_TEST_FIXTURE set_up_tls(const char* const test_case_name)
 142         {
 143         HEARTBEAT_TEST_FIXTURE fixture = set_up(test_case_name,
 144                 TLSv1_server_method());
 145         fixture.process_heartbeat = tls1_process_heartbeat;
 146         fixture.s->handshake_func = dummy_handshake;
 147
 148         /* As per do_ssl3_write(), skipping the following from the beginning of
 149          * the returned heartbeat message:
 150          * type-1 byte; version-2 bytes; length-2 bytes
 151          *
 152          * And then skipping the 1-byte type encoded by process_heartbeat for
 153          * a total of 6 bytes, at which point we can grab the length and the payload
 154          * we seek.
 155          */
 156         fixture.return_payload_offset = 6;
 157         return fixture;
 158         }
 159
 160 static void tear_down(HEARTBEAT_TEST_FIXTURE fixture)
 161         {
 162         ERR_print_errors_fp(stderr);
 163         memset(fixture.s, 0, sizeof(*fixture.s));
 164         SSL_free(fixture.s);
 165         memset(fixture.ctx, 0, sizeof(*fixture.ctx));
 166         SSL_CTX_free(fixture.ctx);
 167         }
 168
 169 static void print_payload(const char* const prefix,
 170                 const unsigned char *payload, const int n)
 171         {
 172         const int end = n < MAX_PRINTABLE_CHARACTERS ? n : MAX_PRINTABLE_CHARACTERS;
 173         printf("%s %d character%s", prefix, n, n == 1 ? "" : "s");
 174         if (end != n) printf(" (first %d shown)", end);
 175         printf("\n  \"");
 176
 177         int i = 0;
 178         for (; i != end; ++i)
 179                 {
 180                 const unsigned char c = payload[i];
 181                 if (isprint(c)) fputc(c, stdout);
 182                 else printf("\\x%02x", c);
 183                 }
 184         printf("\"\n");
 185 }
 186
 187 static int execute_heartbeat(HEARTBEAT_TEST_FIXTURE fixture)
 188         {
 189         int result = 0;
 190         SSL* s = fixture.s;
 191         unsigned char *payload = fixture.payload;
 192         unsigned char sent_buf[MAX_PRINTABLE_CHARACTERS + 1];
 193
 194         s->s3->rrec.data = payload;
 195         s->s3->rrec.length = strlen((const char*)payload);
 196         *payload++ = TLS1_HB_REQUEST;
 197         s2n(fixture.sent_payload_len, payload);
 198
 199         /* Make a local copy of the request, since it gets overwritten at some
 200          * point */
 201         memcpy((char *)sent_buf, (const char*)payload, sizeof(sent_buf));
 202
 203         int return_value = fixture.process_heartbeat(s);
 204
 205         if (return_value != fixture.expected_return_value)
 206                 {
 207                 printf("%s failed: expected return value %d, received %d\n",
 208                                          fixture.test_case_name, fixture.expected_return_value,
 209                                          return_value);
 210                 result = 1;
 211                 }
 212
 213         /* If there is any byte alignment, it will be stored in wbuf.offset. */
 214         unsigned const char *p = &(s->s3->wbuf.buf[
 215                         fixture.return_payload_offset + s->s3->wbuf.offset]);
 216         int actual_payload_len = 0;
 217         n2s(p, actual_payload_len);
 218
 219         if (actual_payload_len != fixture.expected_payload_len)
 220                 {
 221                 printf("%s failed:\n  expected payload len: %d\n  received: %d\n",
 222                                          fixture.test_case_name, fixture.expected_payload_len,
 223                                          actual_payload_len);
 224                 print_payload("sent", sent_buf, strlen((const char*)sent_buf));
 225                 print_payload("received", p, actual_payload_len);
 226                 result = 1;
 227                 }
 228         else
 229                 {
 230                 char* actual_payload = strndup((const char*)p, actual_payload_len);
 231                 if (strcmp(actual_payload, fixture.expected_return_payload) != 0)
 232                         {
 233                         printf("%s failed:\n  expected payload: \"%s\"\n  received: \"%s\"\n",
 234                                                  fixture.test_case_name, fixture.expected_return_payload,
 235                                                  actual_payload);
 236                         result = 1;
 237                         }
 238                 free(actual_payload);
 239                 }
 240
 241         if (result != 0)
 242                 {
 243                 printf("** %s failed **\n--------\n", fixture.test_case_name);
 244                 }
 245         return result;
 246         }
 247
 248 static int honest_payload_size(unsigned char payload_buf[])
 249         {
 250         /* Omit three-byte pad at the beginning for type and payload length */
 251         return strlen((const char*)&payload_buf[3]) - MIN_PADDING_SIZE;
 252         }
 253
 254 #define SETUP_HEARTBEAT_TEST_FIXTURE(type)\
 255         HEARTBEAT_TEST_FIXTURE fixture = set_up_##type(__func__);\
 256         int result = 0
 257
 258 #define EXECUTE_HEARTBEAT_TEST()\
 259         if (execute_heartbeat(fixture) != 0) result = 1;\
 260         tear_down(fixture);\
 261         return result
 262
 263 static int test_dtls1_not_bleeding()
 264         {
 265         SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
 266         /* Three-byte pad at the beginning for type and payload length */
 267         unsigned char payload_buf[] = "   Not bleeding, sixteen spaces of padding"
 268                 "                ";
 269         const int payload_buf_len = honest_payload_size(payload_buf);
 270
 271         fixture.payload = &payload_buf[0];
 272         fixture.sent_payload_len = payload_buf_len;
 273         fixture.expected_return_value = 0;
 274         fixture.expected_payload_len = payload_buf_len;
 275         fixture.expected_return_payload = "Not bleeding, sixteen spaces of padding";
 276         EXECUTE_HEARTBEAT_TEST();
 277         }
 278
 279 static int test_dtls1_not_bleeding_empty_payload()
 280         {
 281         SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
 282         /* Three-byte pad at the beginning for type and payload length, plus a NUL
 283          * at the end */
 284         unsigned char payload_buf[4 + MIN_PADDING_SIZE];
 285         memset(payload_buf, ' ', sizeof(payload_buf));
 286         payload_buf[sizeof(payload_buf) - 1] = '\0';
 287         const int payload_buf_len = honest_payload_size(payload_buf);
 288
 289         fixture.payload = &payload_buf[0];
 290         fixture.sent_payload_len = payload_buf_len;
 291         fixture.expected_return_value = 0;
 292         fixture.expected_payload_len = payload_buf_len;
 293         fixture.expected_return_payload = "";
 294         EXECUTE_HEARTBEAT_TEST();
 295         }
 296
 297 static int test_dtls1_heartbleed()
 298         {
 299         SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
 300         /* Three-byte pad at the beginning for type and payload length */
 301         unsigned char payload_buf[] = "   HEARTBLEED                ";
 302
 303         fixture.payload = &payload_buf[0];
 304         fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
 305         fixture.expected_return_value = 0;
 306         fixture.expected_payload_len = 0;
 307         fixture.expected_return_payload = "";
 308         EXECUTE_HEARTBEAT_TEST();
 309         }
 310
 311 static int test_dtls1_heartbleed_empty_payload()
 312         {
 313         SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
 314         /* Excluding the NUL at the end, one byte short of type + payload length +
 315          * minimum padding */
 316         unsigned char payload_buf[MIN_PADDING_SIZE + 3];
 317         memset(payload_buf, ' ', sizeof(payload_buf));
 318         payload_buf[sizeof(payload_buf) - 1] = '\0';
 319
 320         fixture.payload = &payload_buf[0];
 321         fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
 322         fixture.expected_return_value = 0;
 323         fixture.expected_payload_len = 0;
 324         fixture.expected_return_payload = "";
 325         EXECUTE_HEARTBEAT_TEST();
 326         }
 327
 328 static int test_dtls1_heartbleed_excessive_plaintext_length()
 329         {
 330         SETUP_HEARTBEAT_TEST_FIXTURE(dtls);
 331         /* Excluding the NUL at the end, one byte in excess of maximum allowed
 332          * heartbeat message length */
 333         unsigned char payload_buf[SSL3_RT_MAX_PLAIN_LENGTH + 2];
 334         memset(payload_buf, ' ', sizeof(payload_buf));
 335         payload_buf[sizeof(payload_buf) - 1] = '\0';
 336
 337         fixture.payload = &payload_buf[0];
 338         fixture.sent_payload_len = honest_payload_size(payload_buf);
 339         fixture.expected_return_value = 0;
 340         fixture.expected_payload_len = 0;
 341         fixture.expected_return_payload = "";
 342         EXECUTE_HEARTBEAT_TEST();
 343         }
 344
 345 static int test_tls1_not_bleeding()
 346         {
 347         SETUP_HEARTBEAT_TEST_FIXTURE(tls);
 348         /* Three-byte pad at the beginning for type and payload length */
 349         unsigned char payload_buf[] = "   Not bleeding, sixteen spaces of padding"
 350                                         "                ";
 351         const int payload_buf_len = honest_payload_size(payload_buf);
 352
 353         fixture.payload = &payload_buf[0];
 354         fixture.sent_payload_len = payload_buf_len;
 355         fixture.expected_return_value = 0;
 356         fixture.expected_payload_len = payload_buf_len;
 357         fixture.expected_return_payload = "Not bleeding, sixteen spaces of padding";
 358         EXECUTE_HEARTBEAT_TEST();
 359         }
 360
 361 static int test_tls1_not_bleeding_empty_payload()
 362         {
 363         SETUP_HEARTBEAT_TEST_FIXTURE(tls);
 364         /* Three-byte pad at the beginning for type and payload length, plus a NUL
 365          * at the end */
 366         unsigned char payload_buf[4 + MIN_PADDING_SIZE];
 367         memset(payload_buf, ' ', sizeof(payload_buf));
 368         payload_buf[sizeof(payload_buf) - 1] = '\0';
 369         const int payload_buf_len = honest_payload_size(payload_buf);
 370
 371         fixture.payload = &payload_buf[0];
 372         fixture.sent_payload_len = payload_buf_len;
 373         fixture.expected_return_value = 0;
 374         fixture.expected_payload_len = payload_buf_len;
 375         fixture.expected_return_payload = "";
 376         EXECUTE_HEARTBEAT_TEST();
 377         }
 378
 379 static int test_tls1_heartbleed()
 380         {
 381         SETUP_HEARTBEAT_TEST_FIXTURE(tls);
 382         /* Three-byte pad at the beginning for type and payload length */
 383         unsigned char payload_buf[] = "   HEARTBLEED                ";
 384
 385         fixture.payload = &payload_buf[0];
 386         fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
 387         fixture.expected_return_value = 0;
 388         fixture.expected_payload_len = 0;
 389         fixture.expected_return_payload = "";
 390         EXECUTE_HEARTBEAT_TEST();
 391         }
 392
 393 static int test_tls1_heartbleed_empty_payload()
 394         {
 395         SETUP_HEARTBEAT_TEST_FIXTURE(tls);
 396         /* Excluding the NUL at the end, one byte short of type + payload length +
 397          * minimum padding */
 398         unsigned char payload_buf[MIN_PADDING_SIZE + 3];
 399         memset(payload_buf, ' ', sizeof(payload_buf));
 400         payload_buf[sizeof(payload_buf) - 1] = '\0';
 401
 402         fixture.payload = &payload_buf[0];
 403         fixture.sent_payload_len = MAX_PRINTABLE_CHARACTERS;
 404         fixture.expected_return_value = 0;
 405         fixture.expected_payload_len = 0;
 406         fixture.expected_return_payload = "";
 407         EXECUTE_HEARTBEAT_TEST();
 408         }
 409
 410 #undef EXECUTE_HEARTBEAT_TEST
 411 #undef SETUP_HEARTBEAT_TEST_FIXTURE
 412
 413 int main(int argc, char *argv[])
 414         {
 415         SSL_library_init();
 416         SSL_load_error_strings();
 417
 418         const int num_failed = test_dtls1_not_bleeding() +
 419                         test_dtls1_not_bleeding_empty_payload() +
 420                         test_dtls1_heartbleed() +
 421                         test_dtls1_heartbleed_empty_payload() +
 422                         /* The following test causes an assertion failure at
 423                          * ssl/d1_pkt.c:dtls1_write_bytes() in versions prior to 1.0.1g: */
 424                         (OPENSSL_VERSION_NUMBER >= 0x1000107fL ?
 425                                          test_dtls1_heartbleed_excessive_plaintext_length() : 0) +
 426                         test_tls1_not_bleeding() +
 427                         test_tls1_not_bleeding_empty_payload() +
 428                         test_tls1_heartbleed() +
 429                         test_tls1_heartbleed_empty_payload() +
 430                         0;
 431
 432         ERR_print_errors_fp(stderr);
 433
 434         if (num_failed != 0)
 435                 {
 436                 printf("%d test%s failed\n", num_failed, num_failed != 1 ? "s" : "");
 437                 return EXIT_FAILURE;
 438                 }
 439         return EXIT_SUCCESS;
 440         }