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