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