| 1 |
/* |
| 2 |
* DTLS implementation written by Nagendra Modadugu |
| 3 |
* ([email protected]) for the OpenSSL project 2005. |
| 4 |
*/ |
| 5 |
/* ==================================================================== |
| 6 |
* Copyright (c) 1999-2005 The OpenSSL Project. All rights reserved. |
| 7 |
* |
| 8 |
* Redistribution and use in source and binary forms, with or without |
| 9 |
* modification, are permitted provided that the following conditions |
| 10 |
* are met: |
| 11 |
* |
| 12 |
* 1. Redistributions of source code must retain the above copyright |
| 13 |
* notice, this list of conditions and the following disclaimer. |
| 14 |
* |
| 15 |
* 2. Redistributions in binary form must reproduce the above copyright |
| 16 |
* notice, this list of conditions and the following disclaimer in |
| 17 |
* the documentation and/or other materials provided with the |
| 18 |
* distribution. |
| 19 |
* |
| 20 |
* 3. All advertising materials mentioning features or use of this |
| 21 |
* software must display the following acknowledgment: |
| 22 |
* "This product includes software developed by the OpenSSL Project |
| 23 |
* for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" |
| 24 |
* |
| 25 |
* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to |
| 26 |
* endorse or promote products derived from this software without |
| 27 |
* prior written permission. For written permission, please contact |
| 28 |
* [email protected]. |
| 29 |
* |
| 30 |
* 5. Products derived from this software may not be called "OpenSSL" |
| 31 |
* nor may "OpenSSL" appear in their names without prior written |
| 32 |
* permission of the OpenSSL Project. |
| 33 |
* |
| 34 |
* 6. Redistributions of any form whatsoever must retain the following |
| 35 |
* acknowledgment: |
| 36 |
* "This product includes software developed by the OpenSSL Project |
| 37 |
* for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" |
| 38 |
* |
| 39 |
* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY |
| 40 |
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 41 |
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| 42 |
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR |
| 43 |
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 44 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 45 |
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| 46 |
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 47 |
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| 48 |
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 49 |
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 50 |
* OF THE POSSIBILITY OF SUCH DAMAGE. |
| 51 |
* ==================================================================== |
| 52 |
* |
| 53 |
* This product includes cryptographic software written by Eric Young |
| 54 |
* ([email protected]). This product includes software written by Tim |
| 55 |
* Hudson ([email protected]). */ |
| 56 |
|
| 57 |
#include <openssl/ssl.h> |
| 58 |
|
| 59 |
#include <limits.h> |
| 60 |
#include <string.h> |
| 61 |
|
| 62 |
#include <openssl/err.h> |
| 63 |
#include <openssl/mem.h> |
| 64 |
#include <openssl/nid.h> |
| 65 |
|
| 66 |
#include "internal.h" |
| 67 |
|
| 68 |
#if defined(OPENSSL_WINDOWS) |
| 69 |
#include <sys/timeb.h> |
| 70 |
#else |
| 71 |
#include <sys/socket.h> |
| 72 |
#include <sys/time.h> |
| 73 |
#endif |
| 74 |
|
| 75 |
|
| 76 |
/* DTLS1_MTU_TIMEOUTS is the maximum number of timeouts to expire |
| 77 |
* before starting to decrease the MTU. */ |
| 78 |
#define DTLS1_MTU_TIMEOUTS 2 |
| 79 |
|
| 80 |
/* DTLS1_MAX_TIMEOUTS is the maximum number of timeouts to expire |
| 81 |
* before failing the DTLS handshake. */ |
| 82 |
#define DTLS1_MAX_TIMEOUTS 12 |
| 83 |
|
| 84 |
static void get_current_time(const SSL *ssl, struct timeval *out_clock); |
| 85 |
|
| 86 |
int dtls1_new(SSL *ssl) { |
| 87 |
DTLS1_STATE *d1; |
| 88 |
|
| 89 |
if (!ssl3_new(ssl)) { |
| 90 |
return 0; |
| 91 |
} |
| 92 |
d1 = OPENSSL_malloc(sizeof *d1); |
| 93 |
if (d1 == NULL) { |
| 94 |
ssl3_free(ssl); |
| 95 |
return 0; |
| 96 |
} |
| 97 |
memset(d1, 0, sizeof *d1); |
| 98 |
|
| 99 |
d1->buffered_messages = pqueue_new(); |
| 100 |
d1->sent_messages = pqueue_new(); |
| 101 |
|
| 102 |
if (!d1->buffered_messages || !d1->sent_messages) { |
| 103 |
pqueue_free(d1->buffered_messages); |
| 104 |
pqueue_free(d1->sent_messages); |
| 105 |
OPENSSL_free(d1); |
| 106 |
ssl3_free(ssl); |
| 107 |
return 0; |
| 108 |
} |
| 109 |
|
| 110 |
ssl->d1 = d1; |
| 111 |
|
| 112 |
/* Set the version to the highest supported version. |
| 113 |
* |
| 114 |
* TODO(davidben): Move this field into |s3|, have it store the normalized |
| 115 |
* protocol version, and implement this pre-negotiation quirk in |SSL_version| |
| 116 |
* at the API boundary rather than in internal state. */ |
| 117 |
ssl->version = DTLS1_2_VERSION; |
| 118 |
return 1; |
| 119 |
} |
| 120 |
|
| 121 |
static void dtls1_clear_queues(SSL *ssl) { |
| 122 |
pitem *item = NULL; |
| 123 |
hm_fragment *frag = NULL; |
| 124 |
|
| 125 |
while ((item = pqueue_pop(ssl->d1->buffered_messages)) != NULL) { |
| 126 |
frag = (hm_fragment *)item->data; |
| 127 |
dtls1_hm_fragment_free(frag); |
| 128 |
pitem_free(item); |
| 129 |
} |
| 130 |
|
| 131 |
while ((item = pqueue_pop(ssl->d1->sent_messages)) != NULL) { |
| 132 |
frag = (hm_fragment *)item->data; |
| 133 |
dtls1_hm_fragment_free(frag); |
| 134 |
pitem_free(item); |
| 135 |
} |
| 136 |
} |
| 137 |
|
| 138 |
void dtls1_free(SSL *ssl) { |
| 139 |
ssl3_free(ssl); |
| 140 |
|
| 141 |
if (ssl == NULL || ssl->d1 == NULL) { |
| 142 |
return; |
| 143 |
} |
| 144 |
|
| 145 |
dtls1_clear_queues(ssl); |
| 146 |
|
| 147 |
pqueue_free(ssl->d1->buffered_messages); |
| 148 |
pqueue_free(ssl->d1->sent_messages); |
| 149 |
|
| 150 |
OPENSSL_free(ssl->d1); |
| 151 |
ssl->d1 = NULL; |
| 152 |
} |
| 153 |
|
| 154 |
int dtls1_supports_cipher(const SSL_CIPHER *cipher) { |
| 155 |
/* DTLS does not support stream ciphers. The NULL cipher is rejected because |
| 156 |
* it's not needed. */ |
| 157 |
return cipher->algorithm_enc != SSL_RC4 && cipher->algorithm_enc != SSL_eNULL; |
| 158 |
} |
| 159 |
|
| 160 |
void DTLSv1_set_initial_timeout_duration(SSL *ssl, unsigned int duration_ms) { |
| 161 |
ssl->initial_timeout_duration_ms = duration_ms; |
| 162 |
} |
| 163 |
|
| 164 |
void dtls1_start_timer(SSL *ssl) { |
| 165 |
/* If timer is not set, initialize duration (by default, 1 second) */ |
| 166 |
if (ssl->d1->next_timeout.tv_sec == 0 && ssl->d1->next_timeout.tv_usec == 0) { |
| 167 |
ssl->d1->timeout_duration_ms = ssl->initial_timeout_duration_ms; |
| 168 |
} |
| 169 |
|
| 170 |
/* Set timeout to current time */ |
| 171 |
get_current_time(ssl, &ssl->d1->next_timeout); |
| 172 |
|
| 173 |
/* Add duration to current time */ |
| 174 |
ssl->d1->next_timeout.tv_sec += ssl->d1->timeout_duration_ms / 1000; |
| 175 |
ssl->d1->next_timeout.tv_usec += (ssl->d1->timeout_duration_ms % 1000) * 1000; |
| 176 |
if (ssl->d1->next_timeout.tv_usec >= 1000000) { |
| 177 |
ssl->d1->next_timeout.tv_sec++; |
| 178 |
ssl->d1->next_timeout.tv_usec -= 1000000; |
| 179 |
} |
| 180 |
BIO_ctrl(ssl->rbio, BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, |
| 181 |
&ssl->d1->next_timeout); |
| 182 |
} |
| 183 |
|
| 184 |
int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out) { |
| 185 |
if (!SSL_IS_DTLS(ssl)) { |
| 186 |
return 0; |
| 187 |
} |
| 188 |
|
| 189 |
/* If no timeout is set, just return NULL */ |
| 190 |
if (ssl->d1->next_timeout.tv_sec == 0 && ssl->d1->next_timeout.tv_usec == 0) { |
| 191 |
return 0; |
| 192 |
} |
| 193 |
|
| 194 |
/* Get current time */ |
| 195 |
struct timeval timenow; |
| 196 |
get_current_time(ssl, &timenow); |
| 197 |
|
| 198 |
/* If timer already expired, set remaining time to 0 */ |
| 199 |
if (ssl->d1->next_timeout.tv_sec < timenow.tv_sec || |
| 200 |
(ssl->d1->next_timeout.tv_sec == timenow.tv_sec && |
| 201 |
ssl->d1->next_timeout.tv_usec <= timenow.tv_usec)) { |
| 202 |
memset(out, 0, sizeof(struct timeval)); |
| 203 |
return 1; |
| 204 |
} |
| 205 |
|
| 206 |
/* Calculate time left until timer expires */ |
| 207 |
memcpy(out, &ssl->d1->next_timeout, sizeof(struct timeval)); |
| 208 |
out->tv_sec -= timenow.tv_sec; |
| 209 |
out->tv_usec -= timenow.tv_usec; |
| 210 |
if (out->tv_usec < 0) { |
| 211 |
out->tv_sec--; |
| 212 |
out->tv_usec += 1000000; |
| 213 |
} |
| 214 |
|
| 215 |
/* If remaining time is less than 15 ms, set it to 0 to prevent issues |
| 216 |
* because of small devergences with socket timeouts. */ |
| 217 |
if (out->tv_sec == 0 && out->tv_usec < 15000) { |
| 218 |
memset(out, 0, sizeof(struct timeval)); |
| 219 |
} |
| 220 |
|
| 221 |
return 1; |
| 222 |
} |
| 223 |
|
| 224 |
int dtls1_is_timer_expired(SSL *ssl) { |
| 225 |
struct timeval timeleft; |
| 226 |
|
| 227 |
/* Get time left until timeout, return false if no timer running */ |
| 228 |
if (!DTLSv1_get_timeout(ssl, &timeleft)) { |
| 229 |
return 0; |
| 230 |
} |
| 231 |
|
| 232 |
/* Return false if timer is not expired yet */ |
| 233 |
if (timeleft.tv_sec > 0 || timeleft.tv_usec > 0) { |
| 234 |
return 0; |
| 235 |
} |
| 236 |
|
| 237 |
/* Timer expired, so return true */ |
| 238 |
return 1; |
| 239 |
} |
| 240 |
|
| 241 |
void dtls1_double_timeout(SSL *ssl) { |
| 242 |
ssl->d1->timeout_duration_ms *= 2; |
| 243 |
if (ssl->d1->timeout_duration_ms > 60000) { |
| 244 |
ssl->d1->timeout_duration_ms = 60000; |
| 245 |
} |
| 246 |
dtls1_start_timer(ssl); |
| 247 |
} |
| 248 |
|
| 249 |
void dtls1_stop_timer(SSL *ssl) { |
| 250 |
/* Reset everything */ |
| 251 |
ssl->d1->num_timeouts = 0; |
| 252 |
memset(&ssl->d1->next_timeout, 0, sizeof(struct timeval)); |
| 253 |
ssl->d1->timeout_duration_ms = ssl->initial_timeout_duration_ms; |
| 254 |
BIO_ctrl(ssl->rbio, BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT, 0, |
| 255 |
&ssl->d1->next_timeout); |
| 256 |
/* Clear retransmission buffer */ |
| 257 |
dtls1_clear_record_buffer(ssl); |
| 258 |
} |
| 259 |
|
| 260 |
int dtls1_check_timeout_num(SSL *ssl) { |
| 261 |
ssl->d1->num_timeouts++; |
| 262 |
|
| 263 |
/* Reduce MTU after 2 unsuccessful retransmissions */ |
| 264 |
if (ssl->d1->num_timeouts > DTLS1_MTU_TIMEOUTS && |
| 265 |
!(SSL_get_options(ssl) & SSL_OP_NO_QUERY_MTU)) { |
| 266 |
long mtu = BIO_ctrl(ssl->wbio, BIO_CTRL_DGRAM_GET_FALLBACK_MTU, 0, NULL); |
| 267 |
if (mtu >= 0 && mtu <= (1 << 30) && (unsigned)mtu >= dtls1_min_mtu()) { |
| 268 |
ssl->d1->mtu = (unsigned)mtu; |
| 269 |
} |
| 270 |
} |
| 271 |
|
| 272 |
if (ssl->d1->num_timeouts > DTLS1_MAX_TIMEOUTS) { |
| 273 |
/* fail the connection, enough alerts have been sent */ |
| 274 |
OPENSSL_PUT_ERROR(SSL, SSL_R_READ_TIMEOUT_EXPIRED); |
| 275 |
return -1; |
| 276 |
} |
| 277 |
|
| 278 |
return 0; |
| 279 |
} |
| 280 |
|
| 281 |
int DTLSv1_handle_timeout(SSL *ssl) { |
| 282 |
ssl->rwstate = SSL_NOTHING; |
| 283 |
/* Functions which use SSL_get_error must clear the error queue on entry. */ |
| 284 |
ERR_clear_error(); |
| 285 |
|
| 286 |
if (!SSL_IS_DTLS(ssl)) { |
| 287 |
return -1; |
| 288 |
} |
| 289 |
|
| 290 |
/* if no timer is expired, don't do anything */ |
| 291 |
if (!dtls1_is_timer_expired(ssl)) { |
| 292 |
return 0; |
| 293 |
} |
| 294 |
|
| 295 |
dtls1_double_timeout(ssl); |
| 296 |
|
| 297 |
if (dtls1_check_timeout_num(ssl) < 0) { |
| 298 |
return -1; |
| 299 |
} |
| 300 |
|
| 301 |
dtls1_start_timer(ssl); |
| 302 |
return dtls1_retransmit_buffered_messages(ssl); |
| 303 |
} |
| 304 |
|
| 305 |
static void get_current_time(const SSL *ssl, struct timeval *out_clock) { |
| 306 |
if (ssl->ctx->current_time_cb != NULL) { |
| 307 |
ssl->ctx->current_time_cb(ssl, out_clock); |
| 308 |
return; |
| 309 |
} |
| 310 |
|
| 311 |
#if defined(OPENSSL_WINDOWS) |
| 312 |
struct _timeb time; |
| 313 |
_ftime(&time); |
| 314 |
out_clock->tv_sec = time.time; |
| 315 |
out_clock->tv_usec = time.millitm * 1000; |
| 316 |
#else |
| 317 |
gettimeofday(out_clock, NULL); |
| 318 |
#endif |
| 319 |
} |
| 320 |
|
| 321 |
int dtls1_set_handshake_header(SSL *ssl, int htype, unsigned long len) { |
| 322 |
uint8_t *message = (uint8_t *)ssl->init_buf->data; |
| 323 |
const struct hm_header_st *msg_hdr = &ssl->d1->w_msg_hdr; |
| 324 |
uint8_t serialised_header[DTLS1_HM_HEADER_LENGTH]; |
| 325 |
uint8_t *p = serialised_header; |
| 326 |
|
| 327 |
ssl->d1->handshake_write_seq = ssl->d1->next_handshake_write_seq; |
| 328 |
ssl->d1->next_handshake_write_seq++; |
| 329 |
|
| 330 |
dtls1_set_message_header(ssl, htype, len, ssl->d1->handshake_write_seq, 0, |
| 331 |
len); |
| 332 |
ssl->init_num = (int)len + DTLS1_HM_HEADER_LENGTH; |
| 333 |
ssl->init_off = 0; |
| 334 |
|
| 335 |
/* Buffer the message to handle re-xmits */ |
| 336 |
dtls1_buffer_message(ssl); |
| 337 |
|
| 338 |
/* Add the new message to the handshake hash. Serialize the message |
| 339 |
* header as if it were a single fragment. */ |
| 340 |
*p++ = msg_hdr->type; |
| 341 |
l2n3(msg_hdr->msg_len, p); |
| 342 |
s2n(msg_hdr->seq, p); |
| 343 |
l2n3(0, p); |
| 344 |
l2n3(msg_hdr->msg_len, p); |
| 345 |
return ssl3_update_handshake_hash(ssl, serialised_header, |
| 346 |
sizeof(serialised_header)) && |
| 347 |
ssl3_update_handshake_hash(ssl, message + DTLS1_HM_HEADER_LENGTH, len); |
| 348 |
} |
| 349 |
|
| 350 |
int dtls1_handshake_write(SSL *ssl) { |
| 351 |
return dtls1_do_handshake_write(ssl, dtls1_use_current_epoch); |
| 352 |
} |
| 353 |
|
| 354 |
void dtls1_expect_flight(SSL *ssl) { |
| 355 |
dtls1_start_timer(ssl); |
| 356 |
} |
| 357 |
|
| 358 |
void dtls1_received_flight(SSL *ssl) { |
| 359 |
dtls1_stop_timer(ssl); |
| 360 |
} |