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