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->handshake_epoch=0; */
 142
 143     d1->unprocessed_rcds.q = pqueue_new();
 144     d1->processed_rcds.q = pqueue_new();
 145     d1->buffered_messages = pqueue_new();
 146     d1->sent_messages = pqueue_new();
 147     d1->buffered_app_data.q = pqueue_new();
 148
 149     if (s->server) {
 150         d1->cookie_len = sizeof(s->d1->cookie);
 151     }
 152
 153     d1->link_mtu = 0;
 154     d1->mtu = 0;
 155
 156     if (!d1->unprocessed_rcds.q || !d1->processed_rcds.q
 157         || !d1->buffered_messages || !d1->sent_messages
 158         || !d1->buffered_app_data.q) {
 159         if (d1->unprocessed_rcds.q)
 160             pqueue_free(d1->unprocessed_rcds.q);
 161         if (d1->processed_rcds.q)
 162             pqueue_free(d1->processed_rcds.q);
 163         if (d1->buffered_messages)
 164             pqueue_free(d1->buffered_messages);
 165         if (d1->sent_messages)
 166             pqueue_free(d1->sent_messages);
 167         if (d1->buffered_app_data.q)
 168             pqueue_free(d1->buffered_app_data.q);
 169         OPENSSL_free(d1);
 170         ssl3_free(s);
 171         return (0);
 172     }
 173
 174     s->d1 = d1;
 175     s->method->ssl_clear(s);
 176     return (1);
 177 }
 178
 179 static void dtls1_clear_queues(SSL *s)
 180 {
 181     pitem *item = NULL;
 182     hm_fragment *frag = NULL;
 183     DTLS1_RECORD_DATA *rdata;
 184
 185     while ((item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL) {
 186         rdata = (DTLS1_RECORD_DATA *)item->data;
 187         if (rdata->rbuf.buf) {
 188             OPENSSL_free(rdata->rbuf.buf);
 189         }
 190         OPENSSL_free(item->data);
 191         pitem_free(item);
 192     }
 193
 194     while ((item = pqueue_pop(s->d1->processed_rcds.q)) != NULL) {
 195         rdata = (DTLS1_RECORD_DATA *)item->data;
 196         if (rdata->rbuf.buf) {
 197             OPENSSL_free(rdata->rbuf.buf);
 198         }
 199         OPENSSL_free(item->data);
 200         pitem_free(item);
 201     }
 202
 203     while ((item = pqueue_pop(s->d1->buffered_messages)) != NULL) {
 204         frag = (hm_fragment *)item->data;
 205         dtls1_hm_fragment_free(frag);
 206         pitem_free(item);
 207     }
 208
 209     while ((item = pqueue_pop(s->d1->sent_messages)) != NULL) {
 210         frag = (hm_fragment *)item->data;
 211         dtls1_hm_fragment_free(frag);
 212         pitem_free(item);
 213     }
 214
 215     while ((item = pqueue_pop(s->d1->buffered_app_data.q)) != NULL) {
 216         rdata = (DTLS1_RECORD_DATA *)item->data;
 217         if (rdata->rbuf.buf) {
 218             OPENSSL_free(rdata->rbuf.buf);
 219         }
 220         OPENSSL_free(item->data);
 221         pitem_free(item);
 222     }
 223 }
 224
 225 void dtls1_free(SSL *s)
 226 {
 227     DTLS_RECORD_LAYER_free(&s->rlayer);
 228
 229     ssl3_free(s);
 230
 231     dtls1_clear_queues(s);
 232
 233     pqueue_free(s->d1->unprocessed_rcds.q);
 234     pqueue_free(s->d1->processed_rcds.q);
 235     pqueue_free(s->d1->buffered_messages);
 236     pqueue_free(s->d1->sent_messages);
 237     pqueue_free(s->d1->buffered_app_data.q);
 238
 239     OPENSSL_free(s->d1);
 240     s->d1 = NULL;
 241 }
 242
 243 void dtls1_clear(SSL *s)
 244 {
 245     pqueue unprocessed_rcds;
 246     pqueue processed_rcds;
 247     pqueue buffered_messages;
 248     pqueue sent_messages;
 249     pqueue buffered_app_data;
 250     unsigned int mtu;
 251     unsigned int link_mtu;
 252
 253     DTLS_RECORD_LAYER_clear(&s->rlayer);
 254
 255     if (s->d1) {
 256         unprocessed_rcds = s->d1->unprocessed_rcds.q;
 257         processed_rcds = s->d1->processed_rcds.q;
 258         buffered_messages = s->d1->buffered_messages;
 259         sent_messages = s->d1->sent_messages;
 260         buffered_app_data = s->d1->buffered_app_data.q;
 261         mtu = s->d1->mtu;
 262         link_mtu = s->d1->link_mtu;
 263
 264         dtls1_clear_queues(s);
 265
 266         memset(s->d1, 0, sizeof(*(s->d1)));
 267
 268         if (s->server) {
 269             s->d1->cookie_len = sizeof(s->d1->cookie);
 270         }
 271
 272         if (SSL_get_options(s) & SSL_OP_NO_QUERY_MTU) {
 273             s->d1->mtu = mtu;
 274             s->d1->link_mtu = link_mtu;
 275         }
 276
 277         s->d1->unprocessed_rcds.q = unprocessed_rcds;
 278         s->d1->processed_rcds.q = processed_rcds;
 279         s->d1->buffered_messages = buffered_messages;
 280         s->d1->sent_messages = sent_messages;
 281         s->d1->buffered_app_data.q = buffered_app_data;
 282     }
 283
 284     ssl3_clear(s);
 285     if (s->options & SSL_OP_CISCO_ANYCONNECT)
 286         s->client_version = s->version = DTLS1_BAD_VER;
 287     else if (s->method->version == DTLS_ANY_VERSION)
 288         s->version = DTLS1_2_VERSION;
 289     else
 290         s->version = s->method->version;
 291 }
 292
 293 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg)
 294 {
 295     int ret = 0;
 296
 297     switch (cmd) {
 298     case DTLS_CTRL_GET_TIMEOUT:
 299         if (dtls1_get_timeout(s, (struct timeval *)parg) != NULL) {
 300             ret = 1;
 301         }
 302         break;
 303     case DTLS_CTRL_HANDLE_TIMEOUT:
 304         ret = dtls1_handle_timeout(s);
 305         break;
 306     case DTLS_CTRL_LISTEN:
 307         ret = dtls1_listen(s, parg);
 308         break;
 309     case SSL_CTRL_CHECK_PROTO_VERSION:
 310         /*
 311          * For library-internal use; checks that the current protocol is the
 312          * highest enabled version (according to s->ctx->method, as version
 313          * negotiation may have changed s->method).
 314          */
 315         if (s->version == s->ctx->method->version)
 316             return 1;
 317         /*
 318          * Apparently we're using a version-flexible SSL_METHOD (not at its
 319          * highest protocol version).
 320          */
 321         if (s->ctx->method->version == DTLS_method()->version) {
 322 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
 323 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
 324 #endif
 325             if (!(s->options & SSL_OP_NO_DTLSv1_2))
 326                 return s->version == DTLS1_2_VERSION;
 327             if (!(s->options & SSL_OP_NO_DTLSv1))
 328                 return s->version == DTLS1_VERSION;
 329         }
 330         return 0;               /* Unexpected state; fail closed. */
 331     case DTLS_CTRL_SET_LINK_MTU:
 332         if (larg < (long)dtls1_link_min_mtu())
 333             return 0;
 334         s->d1->link_mtu = larg;
 335         return 1;
 336     case DTLS_CTRL_GET_LINK_MIN_MTU:
 337         return (long)dtls1_link_min_mtu();
 338     case SSL_CTRL_SET_MTU:
 339         /*
 340          *  We may not have a BIO set yet so can't call dtls1_min_mtu()
 341          *  We'll have to make do with dtls1_link_min_mtu() and max overhead
 342          */
 343         if (larg < (long)dtls1_link_min_mtu() - DTLS1_MAX_MTU_OVERHEAD)
 344             return 0;
 345         s->d1->mtu = larg;
 346         return larg;
 347     default:
 348         ret = ssl3_ctrl(s, cmd, larg, parg);
 349         break;
 350     }
 351     return (ret);
 352 }
 353
 354 /*
 355  * As it's impossible to use stream ciphers in "datagram" mode, this
 356  * simple filter is designed to disengage them in DTLS. Unfortunately
 357  * there is no universal way to identify stream SSL_CIPHER, so we have
 358  * to explicitly list their SSL_* codes. Currently RC4 is the only one
 359  * available, but if new ones emerge, they will have to be added...
 360  */
 361 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
 362 {
 363     const SSL_CIPHER *ciph = ssl3_get_cipher(u);
 364
 365     if (ciph != NULL) {
 366         if (ciph->algorithm_enc == SSL_RC4)
 367             return NULL;
 368     }
 369
 370     return ciph;
 371 }
 372
 373 void dtls1_start_timer(SSL *s)
 374 {
 375 #ifndef OPENSSL_NO_SCTP
 376     /* Disable timer for SCTP */
 377     if (BIO_dgram_is_sctp(SSL_get_wbio(s))) {
 378         memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
 379         return;
 380     }
 381 #endif
 382
 383     /* If timer is not set, initialize duration with 1 second */
 384     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
 385         s->d1->timeout_duration = 1;
 386     }
 387
 388     /* Set timeout to current time */
 389     get_current_time(&(s->d1->next_timeout));
 390
 391     /* Add duration to current time */
 392     s->d1->next_timeout.tv_sec += s->d1->timeout_duration;
 393     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
 394              &(s->d1->next_timeout));
 395 }
 396
 397 struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft)
 398 {
 399     struct timeval timenow;
 400
 401     /* If no timeout is set, just return NULL */
 402     if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0) {
 403         return NULL;
 404     }
 405
 406     /* Get current time */
 407     get_current_time(&timenow);
 408
 409     /* If timer already expired, set remaining time to 0 */
 410     if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
 411         (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
 412          s->d1->next_timeout.tv_usec <= timenow.tv_usec)) {
 413         memset(timeleft, 0, sizeof(struct timeval));
 414         return timeleft;
 415     }
 416
 417     /* Calculate time left until timer expires */
 418     memcpy(timeleft, &(s->d1->next_timeout), sizeof(struct timeval));
 419     timeleft->tv_sec -= timenow.tv_sec;
 420     timeleft->tv_usec -= timenow.tv_usec;
 421     if (timeleft->tv_usec < 0) {
 422         timeleft->tv_sec--;
 423         timeleft->tv_usec += 1000000;
 424     }
 425
 426     /*
 427      * If remaining time is less than 15 ms, set it to 0 to prevent issues
 428      * because of small devergences with socket timeouts.
 429      */
 430     if (timeleft->tv_sec == 0 && timeleft->tv_usec < 15000) {
 431         memset(timeleft, 0, sizeof(struct timeval));
 432     }
 433
 434     return timeleft;
 435 }
 436
 437 int dtls1_is_timer_expired(SSL *s)
 438 {
 439     struct timeval timeleft;
 440
 441     /* Get time left until timeout, return false if no timer running */
 442     if (dtls1_get_timeout(s, &timeleft) == NULL) {
 443         return 0;
 444     }
 445
 446     /* Return false if timer is not expired yet */
 447     if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0) {
 448         return 0;
 449     }
 450
 451     /* Timer expired, so return true */
 452     return 1;
 453 }
 454
 455 void dtls1_double_timeout(SSL *s)
 456 {
 457     s->d1->timeout_duration *= 2;
 458     if (s->d1->timeout_duration > 60)
 459         s->d1->timeout_duration = 60;
 460     dtls1_start_timer(s);
 461 }
 462
 463 void dtls1_stop_timer(SSL *s)
 464 {
 465     /* Reset everything */
 466     memset(&(s->d1->timeout), 0, sizeof(struct dtls1_timeout_st));
 467     memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
 468     s->d1->timeout_duration = 1;
 469     BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0,
 470              &(s->d1->next_timeout));
 471     /* Clear retransmission buffer */
 472     dtls1_clear_record_buffer(s);
 473 }
 474
 475 int dtls1_check_timeout_num(SSL *s)
 476 {
 477     unsigned int mtu;
 478
 479     s->d1->timeout.num_alerts++;
 480
 481     /* Reduce MTU after 2 unsuccessful retransmissions */
 482     if (s->d1->timeout.num_alerts > 2
 483         && !(SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)) {
 484         mtu =
 485             BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_GET_FALLBACK_MTU, 0,
 486                      NULL);
 487         if (mtu < s->d1->mtu)
 488             s->d1->mtu = mtu;
 489     }
 490
 491     if (s->d1->timeout.num_alerts > DTLS1_TMO_ALERT_COUNT) {
 492         /* fail the connection, enough alerts have been sent */
 493         SSLerr(SSL_F_DTLS1_CHECK_TIMEOUT_NUM, SSL_R_READ_TIMEOUT_EXPIRED);
 494         return -1;
 495     }
 496
 497     return 0;
 498 }
 499
 500 int dtls1_handle_timeout(SSL *s)
 501 {
 502     /* if no timer is expired, don't do anything */
 503     if (!dtls1_is_timer_expired(s)) {
 504         return 0;
 505     }
 506
 507     dtls1_double_timeout(s);
 508
 509     if (dtls1_check_timeout_num(s) < 0)
 510         return -1;
 511
 512     s->d1->timeout.read_timeouts++;
 513     if (s->d1->timeout.read_timeouts > DTLS1_TMO_READ_COUNT) {
 514         s->d1->timeout.read_timeouts = 1;
 515     }
 516 #ifndef OPENSSL_NO_HEARTBEATS
 517     if (s->tlsext_hb_pending) {
 518         s->tlsext_hb_pending = 0;
 519         return dtls1_heartbeat(s);
 520     }
 521 #endif
 522
 523     dtls1_start_timer(s);
 524     return dtls1_retransmit_buffered_messages(s);
 525 }
 526
 527 static void get_current_time(struct timeval *t)
 528 {
 529 #if defined(_WIN32)
 530     SYSTEMTIME st;
 531     union {
 532         unsigned __int64 ul;
 533         FILETIME ft;
 534     } now;
 535
 536     GetSystemTime(&st);
 537     SystemTimeToFileTime(&st, &now.ft);
 538 # ifdef  __MINGW32__
 539     now.ul -= 116444736000000000ULL;
 540 # else
 541     now.ul -= 116444736000000000UI64; /* re-bias to 1/1/1970 */
 542 # endif
 543     t->tv_sec = (long)(now.ul / 10000000);
 544     t->tv_usec = ((int)(now.ul % 10000000)) / 10;
 545 #elif defined(OPENSSL_SYS_VMS)
 546     struct timeb tb;
 547     ftime(&tb);
 548     t->tv_sec = (long)tb.time;
 549     t->tv_usec = (long)tb.millitm * 1000;
 550 #else
 551     gettimeofday(t, NULL);
 552 #endif
 553 }
 554
 555 int dtls1_listen(SSL *s, struct sockaddr *client)
 556 {
 557     int ret;
 558
 559     /* Ensure there is no state left over from a previous invocation */
 560     if(!SSL_clear(s))
 561         return -1;
 562
 563     SSL_set_options(s, SSL_OP_COOKIE_EXCHANGE);
 564     s->d1->listen = 1;
 565
 566     ret = SSL_accept(s);
 567     if (ret <= 0)
 568         return ret;
 569
 570     (void)BIO_dgram_get_peer(SSL_get_rbio(s), client);
 571     return 1;
 572 }
 573
 574 static int dtls1_set_handshake_header(SSL *s, int htype, unsigned long len)
 575 {
 576     unsigned char *p = (unsigned char *)s->init_buf->data;
 577     dtls1_set_message_header(s, p, htype, len, 0, len);
 578     s->init_num = (int)len + DTLS1_HM_HEADER_LENGTH;
 579     s->init_off = 0;
 580     /* Buffer the message to handle re-xmits */
 581
 582     if(!dtls1_buffer_message(s, 0))
 583         return 0;
 584
 585     return 1;
 586 }
 587
 588 static int dtls1_handshake_write(SSL *s)
 589 {
 590     return dtls1_do_write(s, SSL3_RT_HANDSHAKE);
 591 }