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 #include <openssl/objects.h>
  62 #include "ssl_locl.h"
  63
  64 #ifdef OPENSSL_SYS_WIN32
  65 #include <sys/timeb.h>
  66 #endif
  67
  68 static void get_current_time(struct timeval *t);
  69 const char dtls1_version_str[]="DTLSv1" OPENSSL_VERSION_PTEXT;
  70
  71 SSL3_ENC_METHOD DTLSv1_enc_data={
  72     dtls1_enc,
  73         tls1_mac,
  74         tls1_setup_key_block,
  75         tls1_generate_master_secret,
  76         tls1_change_cipher_state,
  77         tls1_final_finish_mac,
  78         TLS1_FINISH_MAC_LENGTH,
  79         tls1_cert_verify_mac,
  80         TLS_MD_CLIENT_FINISH_CONST,TLS_MD_CLIENT_FINISH_CONST_SIZE,
  81         TLS_MD_SERVER_FINISH_CONST,TLS_MD_SERVER_FINISH_CONST_SIZE,
  82         tls1_alert_code,
  83         };
  84
  85 long dtls1_default_timeout(void)
  86         {
  87         /* 2 hours, the 24 hours mentioned in the DTLSv1 spec
  88          * is way too long for http, the cache would over fill */
  89         return(60*60*2);
  90         }
  91
  92 int dtls1_new(SSL *s)
  93         {
  94         DTLS1_STATE *d1;
  95
  96         if (!ssl3_new(s)) return(0);
  97         if ((d1=OPENSSL_malloc(sizeof *d1)) == NULL) return (0);
  98         memset(d1,0, sizeof *d1);
  99
 100         /* d1->handshake_epoch=0; */
 101
 102         d1->unprocessed_rcds.q=pqueue_new();
 103         d1->processed_rcds.q=pqueue_new();
 104         d1->buffered_messages = pqueue_new();
 105         d1->sent_messages=pqueue_new();
 106         d1->buffered_app_data.q=pqueue_new();
 107
 108         if ( s->server)
 109                 {
 110                 d1->cookie_len = sizeof(s->d1->cookie);
 111                 }
 112
 113         if( ! d1->unprocessed_rcds.q || ! d1->processed_rcds.q
 114         || ! d1->buffered_messages || ! d1->sent_messages || ! d1->buffered_app_data.q)
 115                 {
 116         if ( d1->unprocessed_rcds.q) pqueue_free(d1->unprocessed_rcds.q);
 117         if ( d1->processed_rcds.q) pqueue_free(d1->processed_rcds.q);
 118         if ( d1->buffered_messages) pqueue_free(d1->buffered_messages);
 119                 if ( d1->sent_messages) pqueue_free(d1->sent_messages);
 120                 if ( d1->buffered_app_data.q) pqueue_free(d1->buffered_app_data.q);
 121                 OPENSSL_free(d1);
 122                 return (0);
 123                 }
 124
 125         s->d1=d1;
 126         s->method->ssl_clear(s);
 127         return(1);
 128         }
 129
 130 void dtls1_free(SSL *s)
 131         {
 132     pitem *item = NULL;
 133     hm_fragment *frag = NULL;
 134
 135         ssl3_free(s);
 136
 137     while( (item = pqueue_pop(s->d1->unprocessed_rcds.q)) != NULL)
 138         {
 139         OPENSSL_free(item->data);
 140         pitem_free(item);
 141         }
 142     pqueue_free(s->d1->unprocessed_rcds.q);
 143
 144     while( (item = pqueue_pop(s->d1->processed_rcds.q)) != NULL)
 145         {
 146         OPENSSL_free(item->data);
 147         pitem_free(item);
 148         }
 149     pqueue_free(s->d1->processed_rcds.q);
 150
 151     while( (item = pqueue_pop(s->d1->buffered_messages)) != NULL)
 152         {
 153         frag = (hm_fragment *)item->data;
 154         OPENSSL_free(frag->fragment);
 155         OPENSSL_free(frag);
 156         pitem_free(item);
 157         }
 158     pqueue_free(s->d1->buffered_messages);
 159
 160     while ( (item = pqueue_pop(s->d1->sent_messages)) != NULL)
 161         {
 162         frag = (hm_fragment *)item->data;
 163         OPENSSL_free(frag->fragment);
 164         OPENSSL_free(frag);
 165         pitem_free(item);
 166         }
 167         pqueue_free(s->d1->sent_messages);
 168
 169         while ( (item = pqueue_pop(s->d1->buffered_app_data.q)) != NULL)
 170                 {
 171                 frag = (hm_fragment *)item->data;
 172                 OPENSSL_free(frag->fragment);
 173                 OPENSSL_free(frag);
 174                 pitem_free(item);
 175                 }
 176         pqueue_free(s->d1->buffered_app_data.q);
 177
 178         OPENSSL_free(s->d1);
 179         }
 180
 181 void dtls1_clear(SSL *s)
 182         {
 183         ssl3_clear(s);
 184         if (s->options & SSL_OP_CISCO_ANYCONNECT)
 185                 s->version=DTLS1_BAD_VER;
 186         else
 187                 s->version=DTLS1_VERSION;
 188         }
 189
 190 /*
 191  * As it's impossible to use stream ciphers in "datagram" mode, this
 192  * simple filter is designed to disengage them in DTLS. Unfortunately
 193  * there is no universal way to identify stream SSL_CIPHER, so we have
 194  * to explicitly list their SSL_* codes. Currently RC4 is the only one
 195  * available, but if new ones emerge, they will have to be added...
 196  */
 197 const SSL_CIPHER *dtls1_get_cipher(unsigned int u)
 198         {
 199         const SSL_CIPHER *ciph = ssl3_get_cipher(u);
 200
 201         if (ciph != NULL)
 202                 {
 203                 if (ciph->algorithm_enc == SSL_RC4)
 204                         return NULL;
 205                 }
 206
 207         return ciph;
 208         }
 209
 210 void dtls1_start_timer(SSL *s)
 211         {
 212         /* If timer is not set, initialize duration with 1 second */
 213         if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
 214                 {
 215                 s->d1->timeout_duration = 1;
 216                 }
 217
 218         /* Set timeout to current time */
 219         get_current_time(&(s->d1->next_timeout));
 220
 221         /* Add duration to current time */
 222         s->d1->next_timeout.tv_sec += s->d1->timeout_duration;
 223         BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
 224         }
 225
 226 struct timeval* dtls1_get_timeout(SSL *s, struct timeval* timeleft)
 227         {
 228         struct timeval timenow;
 229
 230         /* If no timeout is set, just return NULL */
 231         if (s->d1->next_timeout.tv_sec == 0 && s->d1->next_timeout.tv_usec == 0)
 232                 {
 233                 return NULL;
 234                 }
 235
 236         /* Get current time */
 237         get_current_time(&timenow);
 238
 239         /* If timer already expired, set remaining time to 0 */
 240         if (s->d1->next_timeout.tv_sec < timenow.tv_sec ||
 241                 (s->d1->next_timeout.tv_sec == timenow.tv_sec &&
 242                  s->d1->next_timeout.tv_usec <= timenow.tv_usec))
 243                 {
 244                 memset(timeleft, 0, sizeof(struct timeval));
 245                 return timeleft;
 246                 }
 247
 248         /* Calculate time left until timer expires */
 249         memcpy(timeleft, &(s->d1->next_timeout), sizeof(struct timeval));
 250         timeleft->tv_sec -= timenow.tv_sec;
 251         timeleft->tv_usec -= timenow.tv_usec;
 252         if (timeleft->tv_usec < 0)
 253                 {
 254                 timeleft->tv_sec--;
 255                 timeleft->tv_usec += 1000000;
 256                 }
 257
 258         return timeleft;
 259         }
 260
 261 int dtls1_is_timer_expired(SSL *s)
 262         {
 263         struct timeval timeleft;
 264
 265         /* Get time left until timeout, return false if no timer running */
 266         if (dtls1_get_timeout(s, &timeleft) == NULL)
 267                 {
 268                 return 0;
 269                 }
 270
 271         /* Return false if timer is not expired yet */
 272         if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0)
 273                 {
 274                 return 0;
 275                 }
 276
 277         /* Timer expired, so return true */
 278         return 1;
 279         }
 280
 281 void dtls1_double_timeout(SSL *s)
 282         {
 283         s->d1->timeout_duration *= 2;
 284         if (s->d1->timeout_duration > 60)
 285                 s->d1->timeout_duration = 60;
 286         dtls1_start_timer(s);
 287         }
 288
 289 void dtls1_stop_timer(SSL *s)
 290         {
 291         /* Reset everything */
 292         memset(&(s->d1->next_timeout), 0, sizeof(struct timeval));
 293         s->d1->timeout_duration = 1;
 294         BIO_ctrl(SSL_get_rbio(s), BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, &(s->d1->next_timeout));
 295         }
 296
 297 static void get_current_time(struct timeval *t)
 298 {
 299 #ifdef OPENSSL_SYS_WIN32
 300         struct _timeb tb;
 301         _ftime(&tb);
 302         t->tv_sec = (long)tb.time;
 303         t->tv_usec = (long)tb.millitm * 1000;
 304 #elif defined(OPENSSL_SYS_VMS)
 305         struct timeb tb;
 306         ftime(&tb);
 307         t->tv_sec = (long)tb.time;
 308         t->tv_usec = (long)tb.millitm * 1000;
 309 #else
 310         gettimeofday(t, NULL);
 311 #endif
 312 }