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