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_WIN32) || defined(OPENSSL_SYS_VMS)
  66 #include <sys/timeb.h>
  67 #endif
  68
  69 static void get_current_time(struct timeval *t);
  70 const char dtls1_version_str[]="DTLSv1" OPENSSL_VERSION_PTEXT;
  71 int dtls1_listen(SSL *s, struct sockaddr *client);
  72
  73 SSL3_ENC_METHOD DTLSv1_enc_data={
  74     dtls1_enc,
  75         tls1_mac,
  76         tls1_setup_key_block,
  77         tls1_generate_master_secret,
  78         tls1_change_cipher_state,
  79         tls1_final_finish_mac,
  80         TLS1_FINISH_MAC_LENGTH,
  81         tls1_cert_verify_mac,
  82         TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
  83         TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
  84         tls1_alert_code,
  85         };
  86
  87 long dtls1_default_timeout(void)
  88         {
  89         /* 2 hours, the 24 hours mentioned in the DTLSv1 spec
  90          * is way too long for http, the cache would over fill */
  91         return(60*60*2);
  92         }
  93
  94 int dtls1_new(SSL *s)
  95         {
  96         DTLS1_STATE *d1;
  97
  98         if (!ssl3_new(s)) return(0);
  99         if ((d1=OPENSSL_malloc(sizeof *d1)) == NULL) return (0);
 100         memset(d1,0, sizeof *d1);
 101
 102         /* d1->handshake_epoch=0; */
 103
 104         d1->unprocessed_rcds.q=pqueue_new();
 105         d1->processed_rcds.q=pqueue_new();
 106         d1->buffered_messages = pqueue_new();
 107         d1->sent_messages=pqueue_new();
 108         d1->buffered_app_data.q=pqueue_new();
 109
 110         if ( s->server)
 111                 {
 112                 d1->cookie_len = sizeof(s->d1->cookie);
 113                 }
 114
 115         if( ! d1->unprocessed_rcds.q || ! d1->processed_rcds.q
 116         || ! d1->buffered_messages || ! d1->sent_messages || ! d1->buffered_app_data.q)
 117                 {
 118         if ( d1->unprocessed_rcds.q) pqueue_free(d1->unprocessed_rcds.q);
 119         if ( d1->processed_rcds.q) pqueue_free(d1->processed_rcds.q);
 120         if ( d1->buffered_messages) pqueue_free(d1->buffered_messages);
 121                 if ( d1->sent_messages) pqueue_free(d1->sent_messages);
 122                 if ( d1->buffered_app_data.q) pqueue_free(d1->buffered_app_data.q);
 123                 OPENSSL_free(d1);
 124                 return (0);
 125                 }
 126
 127         s->d1=d1;
 128         s->method->ssl_clear(s);
 129         return(1);
 130         }
 131
 132 static void dtls1_clear_queues(SSL *s)
 133         {
 134     pitem *item = NULL;
 135     hm_fragment *frag = NULL;
 136         DTLS1_RECORD_DATA *rdata;
 137
 138     while( (item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL)
 139         {
 140                 rdata = (DTLS1_RECORD_DATA *) item->data;
 141                 if (rdata->rbuf.buf)
 142                         {
 143                         OPENSSL_free(rdata->rbuf.buf);
 144                         }
 145         OPENSSL_free(item->data);
 146         pitem_free(item);
 147         }
 148
 149     while( (item = pqueue_pop(s->d1->processed_rcds.q)) != NULL)
 150         {
 151                 rdata = (DTLS1_RECORD_DATA *) item->data;
 152                 if (rdata->rbuf.buf)
 153                         {
 154                         OPENSSL_free(rdata->rbuf.buf);
 155                         }
 156         OPENSSL_free(item->data);
 157         pitem_free(item);
 158         }
 159
 160     while( (item = pqueue_pop(s->d1->buffered_messages)) != NULL)
 161         {
 162         frag = (hm_fragment *)item->data;
 163         OPENSSL_free(frag->fragment);
 164         OPENSSL_free(frag);
 165         pitem_free(item);
 166         }
 167
 168     while ( (item = pqueue_pop(s->d1->sent_messages)) != NULL)
 169         {
 170         frag = (hm_fragment *)item->data;
 171         OPENSSL_free(frag->fragment);
 172         OPENSSL_free(frag);
 173         pitem_free(item);
 174         }
 175
 176         while ( (item = pqueue_pop(s->d1->buffered_app_data.q)) != NULL)
 177                 {
 178                 frag = (hm_fragment *)item->data;
 179                 OPENSSL_free(frag->fragment);
 180                 OPENSSL_free(frag);
 181                 pitem_free(item);
 182                 }
 183         }
 184
 185 void dtls1_free(SSL *s)
 186         {
 187         ssl3_free(s);
 188
 189         dtls1_clear_queues(s);
 190
 191     pqueue_free(s->d1->unprocessed_rcds.q);
 192     pqueue_free(s->d1->processed_rcds.q);
 193     pqueue_free(s->d1->buffered_messages);
 194         pqueue_free(s->d1->sent_messages);
 195         pqueue_free(s->d1->buffered_app_data.q);
 196
 197         OPENSSL_free(s->d1);
 198         }
 199
 200 void dtls1_clear(SSL *s)
 201         {
 202     pqueue unprocessed_rcds;
 203     pqueue processed_rcds;
 204     pqueue buffered_messages;
 205         pqueue sent_messages;
 206         pqueue buffered_app_data;
 207         unsigned int mtu;
 208
 209         if (s->d1)
 210                 {
 211                 unprocessed_rcds = s->d1->unprocessed_rcds.q;
 212                 processed_rcds = s->d1->processed_rcds.q;
 213                 buffered_messages = s->d1->buffered_messages;
 214                 sent_messages = s->d1->sent_messages;
 215                 buffered_app_data = s->d1->buffered_app_data.q;
 216                 mtu = s->d1->mtu;
 217
 218                 dtls1_clear_queues(s);
 219
 220                 memset(s->d1, 0, sizeof(*(s->d1)));
 221
 222                 if (s->server)
 223                         {
 224                         s->d1->cookie_len = sizeof(s->d1->cookie);
 225                         }
 226
 227                 if (SSL_get_options(s) & SSL_OP_NO_QUERY_MTU)
 228                         {
 229                         s->d1->mtu = mtu;
 230                         }
 231
 232                 s->d1->unprocessed_rcds.q = unprocessed_rcds;
 233                 s->d1->processed_rcds.q = processed_rcds;
 234                 s->d1->buffered_messages = buffered_messages;
 235                 s->d1->sent_messages = sent_messages;
 236                 s->d1->buffered_app_data.q = buffered_app_data;
 237                 }
 238
 239         ssl3_clear(s);
 240         if (s->options & SSL_OP_CISCO_ANYCONNECT)
 241                 s->version=DTLS1_BAD_VER;
 242         else
 243                 s->version=DTLS1_VERSION;
 244         }
 245
 246 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg)
 247         {
 248         int ret=0;
 249
 250         switch (cmd)
 251                 {
 252         case DTLS_CTRL_GET_TIMEOUT:
 253                 if (dtls1_get_timeout(s, (struct timeval*) parg) != NULL)
 254                         {
 255                         ret = 1;
 256                         }
 257                 break;
 258         case DTLS_CTRL_HANDLE_TIMEOUT:
 259                 ret = dtls1_handle_timeout(s);
 260                 break;
 261         case DTLS_CTRL_LISTEN:
 262                 ret = dtls1_listen(s, parg);
 263                 break;
 264
 265         default:
 266                 ret = ssl3_ctrl(s, cmd, larg, parg);
 267                 break;
 268                 }
 269         return(ret);
 270         }
 271
 272 /*
 273  * As it's impossible to use stream ciphers in "datagram" mode, this
 274  * simple filter is designed to disengage them in DTLS. Unfortunately
 275  * there is no universal way to identify stream SSL_CIPHER, so we have
 276  * to explicitly list their SSL_* codes. Currently RC4 is the only one
 277  * available, but if new ones emerge, they will have to be added...
 278  */
 279 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
 280         {
 281         const SSL_CIPHER *ciph = ssl3_get_cipher(u);
 282
 283         if (ciph != NULL)
 284                 {
 285                 if (ciph->algorithm_enc == SSL_RC4)
 286                         return NULL;
 287                 }
 288
 289         return ciph;
 290         }
 291
 292 void dtls1_start_timer(SSL *s)
 293         {
 294         /* If timer is not set, initialize duration with 1 second */
 295         if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
 296                 {
 297                 s->d1->timeout_duration = 1;
 298                 }
 299
 300         /* Set timeout to current time */
 301         get_current_time(&(s->d1->next_timeout));
 302
 303         /* Add duration to current time */
 304         s->d1->next_timeout.tv_sec += s->d1->timeout_duration;
 305         BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
 306         }
 307
 308 struct timeval* dtls1_get_timeout(SSL *s, struct timeval* timeleft)
 309         {
 310         struct timeval timenow;
 311
 312         /* If no timeout is set, just return NULL */
 313         if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
 314                 {
 315                 return NULL;
 316                 }
 317
 318         /* Get current time */
 319         get_current_time(&timenow);
 320
 321         /* If timer already expired, set remaining time to 0 */
 322         if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
 323                 (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
 324                  s->d1->next_timeout.tv_usec <= timenow.tv_usec))
 325                 {
 326                 memset(timeleft, 0, sizeof(struct timeval));
 327                 return timeleft;
 328                 }
 329
 330         /* Calculate time left until timer expires */
 331         memcpy(timeleft, &(s->d1->next_timeout), sizeof(struct timeval));
 332         timeleft->tv_sec -= timenow.tv_sec;
 333         timeleft->tv_usec -= timenow.tv_usec;
 334         if (timeleft->tv_usec < 0)
 335                 {
 336                 timeleft->tv_sec--;
 337                 timeleft->tv_usec += 1000000;
 338                 }
 339
 340         /* If remaining time is less than 15 ms, set it to 0
 341          * to prevent issues because of small devergences with
 342          * socket timeouts.
 343          */
 344         if (timeleft->tv_sec == 0 && timeleft->tv_usec < 15000)
 345                 {
 346                 memset(timeleft, 0, sizeof(struct timeval));
 347                 }
 348
 349
 350         return timeleft;
 351         }
 352
 353 int dtls1_is_timer_expired(SSL *s)
 354         {
 355         struct timeval timeleft;
 356
 357         /* Get time left until timeout, return false if no timer running */
 358         if (dtls1_get_timeout(s, &timeleft) == NULL)
 359                 {
 360                 return 0;
 361                 }
 362
 363         /* Return false if timer is not expired yet */
 364         if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0)
 365                 {
 366                 return 0;
 367                 }
 368
 369         /* Timer expired, so return true */
 370         return 1;
 371         }
 372
 373 void dtls1_double_timeout(SSL *s)
 374         {
 375         s->d1->timeout_duration *= 2;
 376         if (s->d1->timeout_duration > 60)
 377                 s->d1->timeout_duration = 60;
 378         dtls1_start_timer(s);
 379         }
 380
 381 void dtls1_stop_timer(SSL *s)
 382         {
 383         /* Reset everything */
 384         memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
 385         s->d1->timeout_duration = 1;
 386         BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
 387         /* Clear retransmission buffer */
 388         dtls1_clear_record_buffer(s);
 389         }
 390
 391 int dtls1_handle_timeout(SSL *s)
 392         {
 393         DTLS1_STATE *state;
 394
 395         /* if no timer is expired, don't do anything */
 396         if (!dtls1_is_timer_expired(s))
 397                 {
 398                 return 0;
 399                 }
 400
 401         dtls1_double_timeout(s);
 402         state = s->d1;
 403         state->timeout.num_alerts++;
 404         if ( state->timeout.num_alerts > DTLS1_TMO_ALERT_COUNT)
 405                 {
 406                 /* fail the connection, enough alerts have been sent */
 407                 SSLerr(SSL_F_DTLS1_HANDLE_TIMEOUT,SSL_R_READ_TIMEOUT_EXPIRED);
 408                 return -1;
 409                 }
 410
 411         state->timeout.read_timeouts++;
 412         if ( state->timeout.read_timeouts > DTLS1_TMO_READ_COUNT)
 413                 {
 414                 state->timeout.read_timeouts = 1;
 415                 }
 416
 417         dtls1_start_timer(s);
 418         return dtls1_retransmit_buffered_messages(s);
 419         }
 420
 421 static void get_current_time(struct timeval *t)
 422 {
 423 #ifdef OPENSSL_SYS_WIN32
 424         struct _timeb tb;
 425         _ftime(&tb);
 426         t->tv_sec = (long)tb.time;
 427         t->tv_usec = (long)tb.millitm * 1000;
 428 #elif defined(OPENSSL_SYS_VMS)
 429         struct timeb tb;
 430         ftime(&tb);
 431         t->tv_sec = (long)tb.time;
 432         t->tv_usec = (long)tb.millitm * 1000;
 433 #else
 434         gettimeofday(t, NULL);
 435 #endif
 436 }
 437
 438 int dtls1_listen(SSL *s, struct sockaddr *client)
 439         {
 440         int ret;
 441
 442         SSL_set_options(s, SSL_OP_COOKIE_EXCHANGE);
 443         s->d1->listen = 1;
 444
 445         ret = SSL_accept(s);
 446         if (ret <= 0) return ret;
 447
 448         (void) BIO_dgram_get_peer(SSL_get_rbio(s), client);
 449         return 1;
 450         }