ssl/d1_lib.c

   1 /* ssl/d1_lib.c */
   2 /*
   3  * DTLS implementation written by Nagendra Modadugu
   4  * (nagendra@cs.stanford.edu) for the OpenSSL project 2005.
   5  */
   6 /* ====================================================================
   7  * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  *
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in
  18  *    the documentation and/or other materials provided with the
  19  *    distribution.
  20  *
  21  * 3. All advertising materials mentioning features or use of this
  22  *    software must display the following acknowledgment:
  23  *    "This product includes software developed by the OpenSSL Project
  24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  25  *
  26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  27  *    endorse or promote products derived from this software without
  28  *    prior written permission. For written permission, please contact
  29  *    openssl-core@OpenSSL.org.
  30  *
  31  * 5. Products derived from this software may not be called "OpenSSL"
  32  *    nor may "OpenSSL" appear in their names without prior written
  33  *    permission of the OpenSSL Project.
  34  *
  35  * 6. Redistributions of any form whatsoever must retain the following
  36  *    acknowledgment:
  37  *    "This product includes software developed by the OpenSSL Project
  38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  51  * OF THE POSSIBILITY OF SUCH DAMAGE.
  52  * ====================================================================
  53  *
  54  * This product includes cryptographic software written by Eric Young
  55  * (eay@cryptsoft.com).  This product includes software written by Tim
  56  * Hudson (tjh@cryptsoft.com).
  57  *
  58  */
  59
  60 #include <stdio.h>
  61 #define USE_SOCKETS
  62 #include <openssl/objects.h>
  63 #include "ssl_locl.h"
  64
  65 #if defined(OPENSSL_SYS_VMS)
  66 # include <sys/timeb.h>
  67 #endif
  68
  69 static void get_current_time(struct timeval *t);
  70 static int dtls1_set_handshake_header(SSL *s, int type, unsigned long len);
  71 static int dtls1_handshake_write(SSL *s);
  72 const char dtls1_version_str[] = "DTLSv1" OPENSSL_VERSION_PTEXT;
  73 int dtls1_listen(SSL *s, struct sockaddr *client);
  74
  75 const SSL3_ENC_METHOD DTLSv1_enc_data = {
  76     tls1_enc,
  77     tls1_mac,
  78     tls1_setup_key_block,
  79     tls1_generate_master_secret,
  80     tls1_change_cipher_state,
  81     tls1_final_finish_mac,
  82     TLS1_FINISH_MAC_LENGTH,
  83     tls1_cert_verify_mac,
  84     TLS_MD_CLIENT_FINISH_CONST, TLS_MD_CLIENT_FINISH_CONST_SIZE,
  85     TLS_MD_SERVER_FINISH_CONST, TLS_MD_SERVER_FINISH_CONST_SIZE,
  86     tls1_alert_code,
  87     tls1_export_keying_material,
  88     SSL_ENC_FLAG_DTLS | SSL_ENC_FLAG_EXPLICIT_IV,
  89     DTLS1_HM_HEADER_LENGTH,
  90     dtls1_set_handshake_header,
  91     dtls1_handshake_write
  92 };
  93
  94 const SSL3_ENC_METHOD DTLSv1_2_enc_data = {
  95     tls1_enc,
  96     tls1_mac,
  97     tls1_setup_key_block,
  98     tls1_generate_master_secret,
  99     tls1_change_cipher_state,
 100     tls1_final_finish_mac,
 101     TLS1_FINISH_MAC_LENGTH,
 102     tls1_cert_verify_mac,
 103     TLS_MD_CLIENT_FINISH_CONST, TLS_MD_CLIENT_FINISH_CONST_SIZE,
 104     TLS_MD_SERVER_FINISH_CONST, TLS_MD_SERVER_FINISH_CONST_SIZE,
 105     tls1_alert_code,
 106     tls1_export_keying_material,
 107     SSL_ENC_FLAG_DTLS | SSL_ENC_FLAG_EXPLICIT_IV | SSL_ENC_FLAG_SIGALGS
 108         | SSL_ENC_FLAG_SHA256_PRF | SSL_ENC_FLAG_TLS1_2_CIPHERS,
 109     DTLS1_HM_HEADER_LENGTH,
 110     dtls1_set_handshake_header,
 111     dtls1_handshake_write
 112 };
 113
 114 long dtls1_default_timeout(void)
 115 {
 116     /*
 117      * 2 hours, the 24 hours mentioned in the DTLSv1 spec is way too long for
 118      * http, the cache would over fill
 119      */
 120     return (60 * 60 * 2);
 121 }
 122
 123 int dtls1_new(SSL *s)
 124 {
 125     DTLS1_STATE *d1;
 126
 127     if (!ssl3_new(s))
 128         return (0);
 129     if ((d1 = OPENSSL_malloc(sizeof *d1)) == NULL) {
 130         ssl3_free(s);
 131         return (0);
 132     }
 133     memset(d1, 0, sizeof *d1);
 134
 135     if(!DTLS_RECORD_LAYER_new(&s->rlayer)) {
 136         OPENSSL_free(d1);
 137         ssl3_free(s);
 138         return 0;
 139     }
 140
 141     d1->unprocessed_rcds.q = pqueue_new();
 142     d1->processed_rcds.q = pqueue_new();
 143     d1->buffered_messages = pqueue_new();
 144     d1->sent_messages = pqueue_new();
 145     d1->buffered_app_data.q = pqueue_new();
 146
 147     if (s->server) {
 148         d1->cookie_len = sizeof(s->d1->cookie);
 149     }
 150
 151     d1->link_mtu = 0;
 152     d1->mtu = 0;
 153
 154     if (!d1->unprocessed_rcds.q || !d1->processed_rcds.q
 155         || !d1->buffered_messages || !d1->sent_messages
 156         || !d1->buffered_app_data.q) {
 157         if (d1->unprocessed_rcds.q)
 158             pqueue_free(d1->unprocessed_rcds.q);
 159         if (d1->processed_rcds.q)
 160             pqueue_free(d1->processed_rcds.q);
 161         if (d1->buffered_messages)
 162             pqueue_free(d1->buffered_messages);
 163         if (d1->sent_messages)
 164             pqueue_free(d1->sent_messages);
 165         if (d1->buffered_app_data.q)
 166             pqueue_free(d1->buffered_app_data.q);
 167         OPENSSL_free(d1);
 168         ssl3_free(s);
 169         return (0);
 170     }
 171
 172     s->d1 = d1;
 173     s->method->ssl_clear(s);
 174     return (1);
 175 }
 176
 177 static void dtls1_clear_queues(SSL *s)
 178 {
 179     pitem *item = NULL;
 180     hm_fragment *frag = NULL;
 181     DTLS1_RECORD_DATA *rdata;
 182
 183     while ((item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL) {
 184         rdata = (DTLS1_RECORD_DATA *)item->data;
 185         if (rdata->rbuf.buf) {
 186             OPENSSL_free(rdata->rbuf.buf);
 187         }
 188         OPENSSL_free(item->data);
 189         pitem_free(item);
 190     }
 191
 192     while ((item = pqueue_pop(s->d1->processed_rcds.q)) != NULL) {
 193         rdata = (DTLS1_RECORD_DATA *)item->data;
 194         if (rdata->rbuf.buf) {
 195             OPENSSL_free(rdata->rbuf.buf);
 196         }
 197         OPENSSL_free(item->data);
 198         pitem_free(item);
 199     }
 200
 201     while ((item = pqueue_pop(s->d1->buffered_messages)) != NULL) {
 202         frag = (hm_fragment *)item->data;
 203         dtls1_hm_fragment_free(frag);
 204         pitem_free(item);
 205     }
 206
 207     while ((item = pqueue_pop(s->d1->sent_messages)) != NULL) {
 208         frag = (hm_fragment *)item->data;
 209         dtls1_hm_fragment_free(frag);
 210         pitem_free(item);
 211     }
 212
 213     while ((item = pqueue_pop(s->d1->buffered_app_data.q)) != NULL) {
 214         rdata = (DTLS1_RECORD_DATA *)item->data;
 215         if (rdata->rbuf.buf) {
 216             OPENSSL_free(rdata->rbuf.buf);
 217         }
 218         OPENSSL_free(item->data);
 219         pitem_free(item);
 220     }
 221 }
 222
 223 void dtls1_free(SSL *s)
 224 {
 225     DTLS_RECORD_LAYER_free(&s->rlayer);
 226
 227     ssl3_free(s);
 228
 229     dtls1_clear_queues(s);
 230
 231     pqueue_free(s->d1->unprocessed_rcds.q);
 232     pqueue_free(s->d1->processed_rcds.q);
 233     pqueue_free(s->d1->buffered_messages);
 234     pqueue_free(s->d1->sent_messages);
 235     pqueue_free(s->d1->buffered_app_data.q);
 236
 237     OPENSSL_free(s->d1);
 238     s->d1 = NULL;
 239 }
 240
 241 void dtls1_clear(SSL *s)
 242 {
 243     pqueue unprocessed_rcds;
 244     pqueue processed_rcds;
 245     pqueue buffered_messages;
 246     pqueue sent_messages;
 247     pqueue buffered_app_data;
 248     unsigned int mtu;
 249     unsigned int link_mtu;
 250
 251     DTLS_RECORD_LAYER_clear(&s->rlayer);
 252
 253     if (s->d1) {
 254         unprocessed_rcds = s->d1->unprocessed_rcds.q;
 255         processed_rcds = s->d1->processed_rcds.q;
 256         buffered_messages = s->d1->buffered_messages;
 257         sent_messages = s->d1->sent_messages;
 258         buffered_app_data = s->d1->buffered_app_data.q;
 259         mtu = s->d1->mtu;
 260         link_mtu = s->d1->link_mtu;
 261
 262         dtls1_clear_queues(s);
 263
 264         memset(s->d1, 0, sizeof(*(s->d1)));
 265
 266         if (s->server) {
 267             s->d1->cookie_len = sizeof(s->d1->cookie);
 268         }
 269
 270         if (SSL_get_options(s) & SSL_OP_NO_QUERY_MTU) {
 271             s->d1->mtu = mtu;
 272             s->d1->link_mtu = link_mtu;
 273         }
 274
 275         s->d1->unprocessed_rcds.q = unprocessed_rcds;
 276         s->d1->processed_rcds.q = processed_rcds;
 277         s->d1->buffered_messages = buffered_messages;
 278         s->d1->sent_messages = sent_messages;
 279         s->d1->buffered_app_data.q = buffered_app_data;
 280     }
 281
 282     ssl3_clear(s);
 283     if (s->options & SSL_OP_CISCO_ANYCONNECT)
 284         s->client_version = s->version = DTLS1_BAD_VER;
 285     else if (s->method->version == DTLS_ANY_VERSION)
 286         s->version = DTLS1_2_VERSION;
 287     else
 288         s->version = s->method->version;
 289 }
 290
 291 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg)
 292 {
 293     int ret = 0;
 294
 295     switch (cmd) {
 296     case DTLS_CTRL_GET_TIMEOUT:
 297         if (dtls1_get_timeout(s, (struct timeval *)parg) != NULL) {
 298             ret = 1;
 299         }
 300         break;
 301     case DTLS_CTRL_HANDLE_TIMEOUT:
 302         ret = dtls1_handle_timeout(s);
 303         break;
 304     case DTLS_CTRL_LISTEN:
 305         ret = dtls1_listen(s, parg);
 306         break;
 307     case SSL_CTRL_CHECK_PROTO_VERSION:
 308         /*
 309          * For library-internal use; checks that the current protocol is the
 310          * highest enabled version (according to s->ctx->method, as version
 311          * negotiation may have changed s->method).
 312          */
 313         if (s->version == s->ctx->method->version)
 314             return 1;
 315         /*
 316          * Apparently we're using a version-flexible SSL_METHOD (not at its
 317          * highest protocol version).
 318          */
 319         if (s->ctx->method->version == DTLS_method()->version) {
 320 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
 321 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
 322 #endif
 323             if (!(s->options & SSL_OP_NO_DTLSv1_2))
 324                 return s->version == DTLS1_2_VERSION;
 325             if (!(s->options & SSL_OP_NO_DTLSv1))
 326                 return s->version == DTLS1_VERSION;
 327         }
 328         return 0;               /* Unexpected state; fail closed. */
 329     case DTLS_CTRL_SET_LINK_MTU:
 330         if (larg < (long)dtls1_link_min_mtu())
 331             return 0;
 332         s->d1->link_mtu = larg;
 333         return 1;
 334     case DTLS_CTRL_GET_LINK_MIN_MTU:
 335         return (long)dtls1_link_min_mtu();
 336     case SSL_CTRL_SET_MTU:
 337         /*
 338          *  We may not have a BIO set yet so can't call dtls1_min_mtu()
 339          *  We'll have to make do with dtls1_link_min_mtu() and max overhead
 340          */
 341         if (larg < (long)dtls1_link_min_mtu() - DTLS1_MAX_MTU_OVERHEAD)
 342             return 0;
 343         s->d1->mtu = larg;
 344         return larg;
 345     default:
 346         ret = ssl3_ctrl(s, cmd, larg, parg);
 347         break;
 348     }
 349     return (ret);
 350 }
 351
 352 /*
 353  * As it's impossible to use stream ciphers in "datagram" mode, this
 354  * simple filter is designed to disengage them in DTLS. Unfortunately
 355  * there is no universal way to identify stream SSL_CIPHER, so we have
 356  * to explicitly list their SSL_* codes. Currently RC4 is the only one
 357  * available, but if new ones emerge, they will have to be added...
 358  */
 359 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
 360 {
 361     const SSL_CIPHER *ciph = ssl3_get_cipher(u);
 362
 363     if (ciph != NULL) {
 364         if (ciph->algorithm_enc == SSL_RC4)
 365             return NULL;
 366     }
 367
 368     return ciph;
 369 }
 370
 371 void dtls1_start_timer(SSL *s)
 372 {
 373 #ifndef OPENSSL_NO_SCTP
 374     /* Disable timer for SCTP */
 375     if (BIO_dgram_is_sctp(SSL_get_wbio(s))) {
 376         memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
 377         return;
 378     }
 379 #endif
 380
 381     /* If timer is not set, initialize duration with 1 second */
 382     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
 383         s->d1->timeout_duration = 1;
 384     }
 385
 386     /* Set timeout to current time */
 387     get_current_time(&(s->d1->next_timeout));
 388
 389     /* Add duration to current time */
 390     s->d1->next_timeout.tv_sec += s->d1->timeout_duration;
 391     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
 392              &(s->d1->next_timeout));
 393 }
 394
 395 struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft)
 396 {
 397     struct timeval timenow;
 398
 399     /* If no timeout is set, just return NULL */
 400     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
 401         return NULL;
 402     }
 403
 404     /* Get current time */
 405     get_current_time(&timenow);
 406
 407     /* If timer already expired, set remaining time to 0 */
 408     if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
 409         (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
 410          s->d1->next_timeout.tv_usec <= timenow.tv_usec)) {
 411         memset(timeleft, 0, sizeof(struct timeval));
 412         return timeleft;
 413     }
 414
 415     /* Calculate time left until timer expires */
 416     memcpy(timeleft, &(s->d1->next_timeout), sizeof(struct timeval));
 417     timeleft->tv_sec -= timenow.tv_sec;
 418     timeleft->tv_usec -= timenow.tv_usec;
 419     if (timeleft->tv_usec < 0) {
 420         timeleft->tv_sec--;
 421         timeleft->tv_usec += 1000000;
 422     }
 423
 424     /*
 425      * If remaining time is less than 15 ms, set it to 0 to prevent issues
 426      * because of small devergences with socket timeouts.
 427      */
 428     if (timeleft->tv_sec == 0 && timeleft->tv_usec < 15000) {
 429         memset(timeleft, 0, sizeof(struct timeval));
 430     }
 431
 432     return timeleft;
 433 }
 434
 435 int dtls1_is_timer_expired(SSL *s)
 436 {
 437     struct timeval timeleft;
 438
 439     /* Get time left until timeout, return false if no timer running */
 440     if (dtls1_get_timeout(s, &timeleft) == NULL) {
 441         return 0;
 442     }
 443
 444     /* Return false if timer is not expired yet */
 445     if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0) {
 446         return 0;
 447     }
 448
 449     /* Timer expired, so return true */
 450     return 1;
 451 }
 452
 453 void dtls1_double_timeout(SSL *s)
 454 {
 455     s->d1->timeout_duration *= 2;
 456     if (s->d1->timeout_duration > 60)
 457         s->d1->timeout_duration = 60;
 458     dtls1_start_timer(s);
 459 }
 460
 461 void dtls1_stop_timer(SSL *s)
 462 {
 463     /* Reset everything */
 464     memset(&(s->d1->timeout), 0, sizeof(struct dtls1_timeout_st));
 465     memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
 466     s->d1->timeout_duration = 1;
 467     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
 468              &(s->d1->next_timeout));
 469     /* Clear retransmission buffer */
 470     dtls1_clear_record_buffer(s);
 471 }
 472
 473 int dtls1_check_timeout_num(SSL *s)
 474 {
 475     unsigned int mtu;
 476
 477     s->d1->timeout.num_alerts++;
 478
 479     /* Reduce MTU after 2 unsuccessful retransmissions */
 480     if (s->d1->timeout.num_alerts > 2
 481         && !(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
 482         mtu =
 483             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_FALLBACK_MTU, 0,
 484                      NULL);
 485         if (mtu < s->d1->mtu)
 486             s->d1->mtu = mtu;
 487     }
 488
 489     if (s->d1->timeout.num_alerts > DTLS1_TMO_ALERT_COUNT) {
 490         /* fail the connection, enough alerts have been sent */
 491         SSLerr(SSL_F_DTLS1_CHECK_TIMEOUT_NUM, SSL_R_READ_TIMEOUT_EXPIRED);
 492         return -1;
 493     }
 494
 495     return 0;
 496 }
 497
 498 int dtls1_handle_timeout(SSL *s)
 499 {
 500     /* if no timer is expired, don't do anything */
 501     if (!dtls1_is_timer_expired(s)) {
 502         return 0;
 503     }
 504
 505     dtls1_double_timeout(s);
 506
 507     if (dtls1_check_timeout_num(s) < 0)
 508         return -1;
 509
 510     s->d1->timeout.read_timeouts++;
 511     if (s->d1->timeout.read_timeouts > DTLS1_TMO_READ_COUNT) {
 512         s->d1->timeout.read_timeouts = 1;
 513     }
 514 #ifndef OPENSSL_NO_HEARTBEATS
 515     if (s->tlsext_hb_pending) {
 516         s->tlsext_hb_pending = 0;
 517         return dtls1_heartbeat(s);
 518     }
 519 #endif
 520
 521     dtls1_start_timer(s);
 522     return dtls1_retransmit_buffered_messages(s);
 523 }
 524
 525 static void get_current_time(struct timeval *t)
 526 {
 527 #if defined(_WIN32)
 528     SYSTEMTIME st;
 529     union {
 530         unsigned __int64 ul;
 531         FILETIME ft;
 532     } now;
 533
 534     GetSystemTime(&st);
 535     SystemTimeToFileTime(&st, &now.ft);
 536 # ifdef  __MINGW32__
 537     now.ul -= 116444736000000000ULL;
 538 # else
 539     now.ul -= 116444736000000000UI64; /* re-bias to 1/1/1970 */
 540 # endif
 541     t->tv_sec = (long)(now.ul / 10000000);
 542     t->tv_usec = ((int)(now.ul % 10000000)) / 10;
 543 #elif defined(OPENSSL_SYS_VMS)
 544     struct timeb tb;
 545     ftime(&tb);
 546     t->tv_sec = (long)tb.time;
 547     t->tv_usec = (long)tb.millitm * 1000;
 548 #else
 549     gettimeofday(t, NULL);
 550 #endif
 551 }
 552
 553 int dtls1_listen(SSL *s, struct sockaddr *client)
 554 {
 555     int ret;
 556
 557     /* Ensure there is no state left over from a previous invocation */
 558     if(!SSL_clear(s))
 559         return -1;
 560
 561     SSL_set_options(s, SSL_OP_COOKIE_EXCHANGE);
 562     s->d1->listen = 1;
 563
 564     ret = SSL_accept(s);
 565     if (ret <= 0)
 566         return ret;
 567
 568     (void)BIO_dgram_get_peer(SSL_get_rbio(s), client);
 569     return 1;
 570 }
 571
 572 static int dtls1_set_handshake_header(SSL *s, int htype, unsigned long len)
 573 {
 574     unsigned char *p = (unsigned char *)s->init_buf->data;
 575     dtls1_set_message_header(s, p, htype, len, 0, len);
 576     s->init_num = (int)len + DTLS1_HM_HEADER_LENGTH;
 577     s->init_off = 0;
 578     /* Buffer the message to handle re-xmits */
 579
 580     if(!dtls1_buffer_message(s, 0))
 581         return 0;
 582
 583     return 1;
 584 }
 585
 586 static int dtls1_handshake_write(SSL *s)
 587 {
 588     return dtls1_do_write(s, SSL3_RT_HANDSHAKE);
 589 }