ssl/statem/statem_lib.c

   1 /*
   2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /* ====================================================================
  11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  12  * ECC cipher suite support in OpenSSL originally developed by
  13  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  14  */
  15
  16 #include <limits.h>
  17 #include <string.h>
  18 #include <stdio.h>
  19 #include "../ssl_locl.h"
  20 #include "statem_locl.h"
  21 #include <openssl/buffer.h>
  22 #include <openssl/objects.h>
  23 #include <openssl/evp.h>
  24 #include <openssl/x509.h>
  25
  26 /*
  27  * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
  28  * SSL3_RT_CHANGE_CIPHER_SPEC)
  29  */
  30 int ssl3_do_write(SSL *s, int type)
  31 {
  32     int ret;
  33     size_t written = 0;
  34
  35     ret = ssl3_write_bytes(s, type, &s->init_buf->data[s->init_off],
  36                            s->init_num, &written);
  37     if (ret < 0)
  38         return (-1);
  39     if (type == SSL3_RT_HANDSHAKE)
  40         /*
  41          * should not be done for 'Hello Request's, but in that case we'll
  42          * ignore the result anyway
  43          */
  44         if (!ssl3_finish_mac(s,
  45                              (unsigned char *)&s->init_buf->data[s->init_off],
  46                              written))
  47             return -1;
  48
  49     if (written == s->init_num) {
  50         if (s->msg_callback)
  51             s->msg_callback(1, s->version, type, s->init_buf->data,
  52                             (size_t)(s->init_off + s->init_num), s,
  53                             s->msg_callback_arg);
  54         return (1);
  55     }
  56     s->init_off += written;
  57     s->init_num -= written;
  58     return (0);
  59 }
  60
  61 int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype)
  62 {
  63     size_t msglen;
  64
  65     if ((htype != SSL3_MT_CHANGE_CIPHER_SPEC && !WPACKET_close(pkt))
  66             || !WPACKET_get_length(pkt, &msglen)
  67             || msglen > INT_MAX)
  68         return 0;
  69     s->init_num = (int)msglen;
  70     s->init_off = 0;
  71
  72     return 1;
  73 }
  74
  75 int tls_construct_finished(SSL *s, WPACKET *pkt)
  76 {
  77     size_t finish_md_len;
  78     const char *sender;
  79     size_t slen;
  80
  81     if (s->server) {
  82         sender = s->method->ssl3_enc->server_finished_label;
  83         slen = s->method->ssl3_enc->server_finished_label_len;
  84     } else {
  85         sender = s->method->ssl3_enc->client_finished_label;
  86         slen = s->method->ssl3_enc->client_finished_label_len;
  87     }
  88
  89     finish_md_len = s->method->ssl3_enc->final_finish_mac(s,
  90                                                           sender, slen,
  91                                                           s->s3->tmp.finish_md);
  92     if (finish_md_len == 0) {
  93         SSLerr(SSL_F_TLS_CONSTRUCT_FINISHED, ERR_R_INTERNAL_ERROR);
  94         goto err;
  95     }
  96
  97     s->s3->tmp.finish_md_len = finish_md_len;
  98
  99     if (!WPACKET_memcpy(pkt, s->s3->tmp.finish_md, finish_md_len)) {
 100         SSLerr(SSL_F_TLS_CONSTRUCT_FINISHED, ERR_R_INTERNAL_ERROR);
 101         goto err;
 102     }
 103
 104     /*
 105      * Copy the finished so we can use it for renegotiation checks
 106      */
 107     if (!s->server) {
 108         OPENSSL_assert(finish_md_len <= EVP_MAX_MD_SIZE);
 109         memcpy(s->s3->previous_client_finished, s->s3->tmp.finish_md,
 110                finish_md_len);
 111         s->s3->previous_client_finished_len = finish_md_len;
 112     } else {
 113         OPENSSL_assert(finish_md_len <= EVP_MAX_MD_SIZE);
 114         memcpy(s->s3->previous_server_finished, s->s3->tmp.finish_md,
 115                finish_md_len);
 116         s->s3->previous_server_finished_len = finish_md_len;
 117     }
 118
 119     return 1;
 120  err:
 121     ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 122     return 0;
 123 }
 124
 125 #ifndef OPENSSL_NO_NEXTPROTONEG
 126 /*
 127  * ssl3_take_mac calculates the Finished MAC for the handshakes messages seen
 128  * to far.
 129  */
 130 static void ssl3_take_mac(SSL *s)
 131 {
 132     const char *sender;
 133     size_t slen;
 134     /*
 135      * If no new cipher setup return immediately: other functions will set
 136      * the appropriate error.
 137      */
 138     if (s->s3->tmp.new_cipher == NULL)
 139         return;
 140     if (!s->server) {
 141         sender = s->method->ssl3_enc->server_finished_label;
 142         slen = s->method->ssl3_enc->server_finished_label_len;
 143     } else {
 144         sender = s->method->ssl3_enc->client_finished_label;
 145         slen = s->method->ssl3_enc->client_finished_label_len;
 146     }
 147
 148     s->s3->tmp.peer_finish_md_len = s->method->ssl3_enc->final_finish_mac(s,
 149                                                                           sender,
 150                                                                           slen,
 151                                                                           s->s3->tmp.peer_finish_md);
 152 }
 153 #endif
 154
 155 static int compare_extensions(const void *p1, const void *p2)
 156 {
 157     const RAW_EXTENSION *e1 = (const RAW_EXTENSION *)p1;
 158     const RAW_EXTENSION *e2 = (const RAW_EXTENSION *)p2;
 159     if (e1->type < e2->type)
 160         return -1;
 161     else if (e1->type > e2->type)
 162         return 1;
 163     else
 164         return 0;
 165 }
 166
 167 /*
 168  * Gather a list of all the extensions. We don't actually process the content
 169  * of the extensions yet, except to check their types.
 170  *
 171  * Per http://tools.ietf.org/html/rfc5246#section-7.4.1.4, there may not be
 172  * more than one extension of the same type in a ClientHello or ServerHello.
 173  * This function returns 1 if all extensions are unique and we have parsed their
 174  * types, and 0 if the extensions contain duplicates, could not be successfully
 175  * parsed, or an internal error occurred.
 176  */
 177 int tls_parse_raw_extensions(PACKET *packet, RAW_EXTENSION **res,
 178                              size_t *numfound, int *ad)
 179 {
 180     PACKET extensions = *packet;
 181     size_t num_extensions = 0, i = 0;
 182     RAW_EXTENSION *raw_extensions = NULL;
 183
 184     /* First pass: count the extensions. */
 185     while (PACKET_remaining(&extensions) > 0) {
 186         unsigned int type;
 187         PACKET extension;
 188         if (!PACKET_get_net_2(&extensions, &type) ||
 189             !PACKET_get_length_prefixed_2(&extensions, &extension)) {
 190             *ad = SSL_AD_DECODE_ERROR;
 191             goto done;
 192         }
 193         num_extensions++;
 194     }
 195
 196     if (num_extensions > 0) {
 197         raw_extensions = OPENSSL_malloc(sizeof(RAW_EXTENSION) * num_extensions);
 198         if (raw_extensions == NULL) {
 199             *ad = SSL_AD_INTERNAL_ERROR;
 200             SSLerr(SSL_F_TLS_PARSE_RAW_EXTENSIONS, ERR_R_MALLOC_FAILURE);
 201             goto done;
 202         }
 203
 204         /* Second pass: gather the extension types. */
 205         for (i = 0; i < num_extensions; i++) {
 206             if (!PACKET_get_net_2(packet, &raw_extensions[i].type) ||
 207                 !PACKET_get_length_prefixed_2(packet,
 208                                               &raw_extensions[i].data)) {
 209                 /* This should not happen. */
 210                 *ad = SSL_AD_INTERNAL_ERROR;
 211                 SSLerr(SSL_F_TLS_PARSE_RAW_EXTENSIONS, ERR_R_INTERNAL_ERROR);
 212                 goto done;
 213             }
 214         }
 215
 216         if (PACKET_remaining(packet) != 0) {
 217             *ad = SSL_AD_DECODE_ERROR;
 218             SSLerr(SSL_F_TLS_PARSE_RAW_EXTENSIONS, SSL_R_LENGTH_MISMATCH);
 219             goto done;
 220         }
 221         /* Sort the extensions and make sure there are no duplicates. */
 222         qsort(raw_extensions, num_extensions, sizeof(RAW_EXTENSION),
 223               compare_extensions);
 224         for (i = 1; i < num_extensions; i++) {
 225             if (raw_extensions[i - 1].type == raw_extensions[i].type) {
 226                 *ad = SSL_AD_DECODE_ERROR;
 227                 goto done;
 228             }
 229         }
 230     }
 231
 232     *res = raw_extensions;
 233     *numfound = num_extensions;
 234     return 1;
 235
 236  done:
 237     OPENSSL_free(raw_extensions);
 238     return 0;
 239 }
 240
 241
 242
 243 MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt)
 244 {
 245     int al;
 246     size_t remain;
 247
 248     remain = PACKET_remaining(pkt);
 249     /*
 250      * 'Change Cipher Spec' is just a single byte, which should already have
 251      * been consumed by ssl_get_message() so there should be no bytes left,
 252      * unless we're using DTLS1_BAD_VER, which has an extra 2 bytes
 253      */
 254     if (SSL_IS_DTLS(s)) {
 255         if ((s->version == DTLS1_BAD_VER
 256              && remain != DTLS1_CCS_HEADER_LENGTH + 1)
 257             || (s->version != DTLS1_BAD_VER
 258                 && remain != DTLS1_CCS_HEADER_LENGTH - 1)) {
 259             al = SSL_AD_ILLEGAL_PARAMETER;
 260             SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC,
 261                    SSL_R_BAD_CHANGE_CIPHER_SPEC);
 262             goto f_err;
 263         }
 264     } else {
 265         if (remain != 0) {
 266             al = SSL_AD_ILLEGAL_PARAMETER;
 267             SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC,
 268                    SSL_R_BAD_CHANGE_CIPHER_SPEC);
 269             goto f_err;
 270         }
 271     }
 272
 273     /* Check we have a cipher to change to */
 274     if (s->s3->tmp.new_cipher == NULL) {
 275         al = SSL_AD_UNEXPECTED_MESSAGE;
 276         SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC, SSL_R_CCS_RECEIVED_EARLY);
 277         goto f_err;
 278     }
 279
 280     s->s3->change_cipher_spec = 1;
 281     if (!ssl3_do_change_cipher_spec(s)) {
 282         al = SSL_AD_INTERNAL_ERROR;
 283         SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
 284         goto f_err;
 285     }
 286
 287     if (SSL_IS_DTLS(s)) {
 288         dtls1_reset_seq_numbers(s, SSL3_CC_READ);
 289
 290         if (s->version == DTLS1_BAD_VER)
 291             s->d1->handshake_read_seq++;
 292
 293 #ifndef OPENSSL_NO_SCTP
 294         /*
 295          * Remember that a CCS has been received, so that an old key of
 296          * SCTP-Auth can be deleted when a CCS is sent. Will be ignored if no
 297          * SCTP is used
 298          */
 299         BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD, 1, NULL);
 300 #endif
 301     }
 302
 303     return MSG_PROCESS_CONTINUE_READING;
 304  f_err:
 305     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 306     ossl_statem_set_error(s);
 307     return MSG_PROCESS_ERROR;
 308 }
 309
 310 MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt)
 311 {
 312     int al;
 313     size_t md_len;
 314
 315     /* If this occurs, we have missed a message */
 316     if (!s->s3->change_cipher_spec) {
 317         al = SSL_AD_UNEXPECTED_MESSAGE;
 318         SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_GOT_A_FIN_BEFORE_A_CCS);
 319         goto f_err;
 320     }
 321     s->s3->change_cipher_spec = 0;
 322
 323     md_len = s->s3->tmp.peer_finish_md_len;
 324
 325     if (md_len != PACKET_remaining(pkt)) {
 326         al = SSL_AD_DECODE_ERROR;
 327         SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_BAD_DIGEST_LENGTH);
 328         goto f_err;
 329     }
 330
 331     if (CRYPTO_memcmp(PACKET_data(pkt), s->s3->tmp.peer_finish_md,
 332                       md_len) != 0) {
 333         al = SSL_AD_DECRYPT_ERROR;
 334         SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_DIGEST_CHECK_FAILED);
 335         goto f_err;
 336     }
 337
 338     /*
 339      * Copy the finished so we can use it for renegotiation checks
 340      */
 341     if (s->server) {
 342         OPENSSL_assert(md_len <= EVP_MAX_MD_SIZE);
 343         memcpy(s->s3->previous_client_finished, s->s3->tmp.peer_finish_md,
 344                md_len);
 345         s->s3->previous_client_finished_len = md_len;
 346     } else {
 347         OPENSSL_assert(md_len <= EVP_MAX_MD_SIZE);
 348         memcpy(s->s3->previous_server_finished, s->s3->tmp.peer_finish_md,
 349                md_len);
 350         s->s3->previous_server_finished_len = md_len;
 351     }
 352
 353     return MSG_PROCESS_FINISHED_READING;
 354  f_err:
 355     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 356     ossl_statem_set_error(s);
 357     return MSG_PROCESS_ERROR;
 358 }
 359
 360 int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt)
 361 {
 362     if (!WPACKET_put_bytes_u8(pkt, SSL3_MT_CCS)) {
 363         SSLerr(SSL_F_TLS_CONSTRUCT_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
 364         ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 365         return 0;
 366     }
 367
 368     return 1;
 369 }
 370
 371 unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt, CERT_PKEY *cpk)
 372 {
 373     if (!WPACKET_start_sub_packet_u24(pkt)
 374             || !ssl_add_cert_chain(s, pkt, cpk)
 375             || !WPACKET_close(pkt)) {
 376         SSLerr(SSL_F_SSL3_OUTPUT_CERT_CHAIN, ERR_R_INTERNAL_ERROR);
 377         return 0;
 378     }
 379     return 1;
 380 }
 381
 382 WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst)
 383 {
 384     void (*cb) (const SSL *ssl, int type, int val) = NULL;
 385
 386 #ifndef OPENSSL_NO_SCTP
 387     if (SSL_IS_DTLS(s) && BIO_dgram_is_sctp(SSL_get_wbio(s))) {
 388         WORK_STATE ret;
 389         ret = dtls_wait_for_dry(s);
 390         if (ret != WORK_FINISHED_CONTINUE)
 391             return ret;
 392     }
 393 #endif
 394
 395     /* clean a few things up */
 396     ssl3_cleanup_key_block(s);
 397
 398     if (!SSL_IS_DTLS(s)) {
 399         /*
 400          * We don't do this in DTLS because we may still need the init_buf
 401          * in case there are any unexpected retransmits
 402          */
 403         BUF_MEM_free(s->init_buf);
 404         s->init_buf = NULL;
 405     }
 406
 407     ssl_free_wbio_buffer(s);
 408
 409     s->init_num = 0;
 410
 411     if (!s->server || s->renegotiate == 2) {
 412         /* skipped if we just sent a HelloRequest */
 413         s->renegotiate = 0;
 414         s->new_session = 0;
 415
 416         if (s->server) {
 417             ssl_update_cache(s, SSL_SESS_CACHE_SERVER);
 418
 419             s->ctx->stats.sess_accept_good++;
 420             s->handshake_func = ossl_statem_accept;
 421         } else {
 422             ssl_update_cache(s, SSL_SESS_CACHE_CLIENT);
 423             if (s->hit)
 424                 s->ctx->stats.sess_hit++;
 425
 426             s->handshake_func = ossl_statem_connect;
 427             s->ctx->stats.sess_connect_good++;
 428         }
 429
 430         if (s->info_callback != NULL)
 431             cb = s->info_callback;
 432         else if (s->ctx->info_callback != NULL)
 433             cb = s->ctx->info_callback;
 434
 435         if (cb != NULL)
 436             cb(s, SSL_CB_HANDSHAKE_DONE, 1);
 437
 438         if (SSL_IS_DTLS(s)) {
 439             /* done with handshaking */
 440             s->d1->handshake_read_seq = 0;
 441             s->d1->handshake_write_seq = 0;
 442             s->d1->next_handshake_write_seq = 0;
 443             dtls1_clear_received_buffer(s);
 444         }
 445     }
 446
 447     return WORK_FINISHED_STOP;
 448 }
 449
 450 int tls_get_message_header(SSL *s, int *mt)
 451 {
 452     /* s->init_num < SSL3_HM_HEADER_LENGTH */
 453     int skip_message, i, recvd_type, al;
 454     unsigned char *p;
 455     size_t l, readbytes;
 456
 457     p = (unsigned char *)s->init_buf->data;
 458
 459     do {
 460         while (s->init_num < SSL3_HM_HEADER_LENGTH) {
 461             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type,
 462                                           &p[s->init_num],
 463                                           SSL3_HM_HEADER_LENGTH - s->init_num,
 464                                           0, &readbytes);
 465             if (i <= 0) {
 466                 s->rwstate = SSL_READING;
 467                 return 0;
 468             }
 469             if (recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
 470                 /*
 471                  * A ChangeCipherSpec must be a single byte and may not occur
 472                  * in the middle of a handshake message.
 473                  */
 474                 if (s->init_num != 0 || readbytes != 1 || p[0] != SSL3_MT_CCS) {
 475                     al = SSL_AD_UNEXPECTED_MESSAGE;
 476                     SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER,
 477                            SSL_R_BAD_CHANGE_CIPHER_SPEC);
 478                     goto f_err;
 479                 }
 480                 s->s3->tmp.message_type = *mt = SSL3_MT_CHANGE_CIPHER_SPEC;
 481                 s->init_num = readbytes - 1;
 482                 s->init_msg = s->init_buf->data;
 483                 s->s3->tmp.message_size = readbytes;
 484                 return 1;
 485             } else if (recvd_type != SSL3_RT_HANDSHAKE) {
 486                 al = SSL_AD_UNEXPECTED_MESSAGE;
 487                 SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER, SSL_R_CCS_RECEIVED_EARLY);
 488                 goto f_err;
 489             }
 490             s->init_num += readbytes;
 491         }
 492
 493         skip_message = 0;
 494         if (!s->server)
 495             if (p[0] == SSL3_MT_HELLO_REQUEST)
 496                 /*
 497                  * The server may always send 'Hello Request' messages --
 498                  * we are doing a handshake anyway now, so ignore them if
 499                  * their format is correct. Does not count for 'Finished'
 500                  * MAC.
 501                  */
 502                 if (p[1] == 0 && p[2] == 0 && p[3] == 0) {
 503                     s->init_num = 0;
 504                     skip_message = 1;
 505
 506                     if (s->msg_callback)
 507                         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 508                                         p, SSL3_HM_HEADER_LENGTH, s,
 509                                         s->msg_callback_arg);
 510                 }
 511     } while (skip_message);
 512     /* s->init_num == SSL3_HM_HEADER_LENGTH */
 513
 514     *mt = *p;
 515     s->s3->tmp.message_type = *(p++);
 516
 517     if (RECORD_LAYER_is_sslv2_record(&s->rlayer)) {
 518         /*
 519          * Only happens with SSLv3+ in an SSLv2 backward compatible
 520          * ClientHello
 521          *
 522          * Total message size is the remaining record bytes to read
 523          * plus the SSL3_HM_HEADER_LENGTH bytes that we already read
 524          */
 525         l = RECORD_LAYER_get_rrec_length(&s->rlayer)
 526             + SSL3_HM_HEADER_LENGTH;
 527         s->s3->tmp.message_size = l;
 528
 529         s->init_msg = s->init_buf->data;
 530         s->init_num = SSL3_HM_HEADER_LENGTH;
 531     } else {
 532         n2l3(p, l);
 533         /* BUF_MEM_grow takes an 'int' parameter */
 534         if (l > (INT_MAX - SSL3_HM_HEADER_LENGTH)) {
 535             al = SSL_AD_ILLEGAL_PARAMETER;
 536             SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER, SSL_R_EXCESSIVE_MESSAGE_SIZE);
 537             goto f_err;
 538         }
 539         s->s3->tmp.message_size = l;
 540
 541         s->init_msg = s->init_buf->data + SSL3_HM_HEADER_LENGTH;
 542         s->init_num = 0;
 543     }
 544
 545     return 1;
 546  f_err:
 547     ssl3_send_alert(s, SSL3_AL_FATAL, al);
 548     return 0;
 549 }
 550
 551 int tls_get_message_body(SSL *s, size_t *len)
 552 {
 553     size_t n, readbytes;
 554     unsigned char *p;
 555     int i;
 556
 557     if (s->s3->tmp.message_type == SSL3_MT_CHANGE_CIPHER_SPEC) {
 558         /* We've already read everything in */
 559         *len = (unsigned long)s->init_num;
 560         return 1;
 561     }
 562
 563     p = s->init_msg;
 564     n = s->s3->tmp.message_size - s->init_num;
 565     while (n > 0) {
 566         i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
 567                                       &p[s->init_num], n, 0, &readbytes);
 568         if (i <= 0) {
 569             s->rwstate = SSL_READING;
 570             *len = 0;
 571             return 0;
 572         }
 573         s->init_num += readbytes;
 574         n -= readbytes;
 575     }
 576
 577 #ifndef OPENSSL_NO_NEXTPROTONEG
 578     /*
 579      * If receiving Finished, record MAC of prior handshake messages for
 580      * Finished verification.
 581      */
 582     if (*s->init_buf->data == SSL3_MT_FINISHED)
 583         ssl3_take_mac(s);
 584 #endif
 585
 586     /* Feed this message into MAC computation. */
 587     if (RECORD_LAYER_is_sslv2_record(&s->rlayer)) {
 588         if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
 589                              s->init_num)) {
 590             SSLerr(SSL_F_TLS_GET_MESSAGE_BODY, ERR_R_EVP_LIB);
 591             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 592             *len = 0;
 593             return 0;
 594         }
 595         if (s->msg_callback)
 596             s->msg_callback(0, SSL2_VERSION, 0, s->init_buf->data,
 597                             (size_t)s->init_num, s, s->msg_callback_arg);
 598     } else {
 599         if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
 600                              s->init_num + SSL3_HM_HEADER_LENGTH)) {
 601             SSLerr(SSL_F_TLS_GET_MESSAGE_BODY, ERR_R_EVP_LIB);
 602             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 603             *len = 0;
 604             return 0;
 605         }
 606         if (s->msg_callback)
 607             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE, s->init_buf->data,
 608                             (size_t)s->init_num + SSL3_HM_HEADER_LENGTH, s,
 609                             s->msg_callback_arg);
 610     }
 611
 612     *len = s->init_num;
 613     return 1;
 614 }
 615
 616 int ssl_cert_type(const X509 *x, const EVP_PKEY *pk)
 617 {
 618     if (pk == NULL && (pk = X509_get0_pubkey(x)) == NULL)
 619         return -1;
 620
 621     switch (EVP_PKEY_id(pk)) {
 622     default:
 623         return -1;
 624     case EVP_PKEY_RSA:
 625         return SSL_PKEY_RSA_ENC;
 626     case EVP_PKEY_DSA:
 627         return SSL_PKEY_DSA_SIGN;
 628 #ifndef OPENSSL_NO_EC
 629     case EVP_PKEY_EC:
 630         return SSL_PKEY_ECC;
 631 #endif
 632 #ifndef OPENSSL_NO_GOST
 633     case NID_id_GostR3410_2001:
 634         return SSL_PKEY_GOST01;
 635     case NID_id_GostR3410_2012_256:
 636         return SSL_PKEY_GOST12_256;
 637     case NID_id_GostR3410_2012_512:
 638         return SSL_PKEY_GOST12_512;
 639 #endif
 640     }
 641 }
 642
 643 int ssl_verify_alarm_type(long type)
 644 {
 645     int al;
 646
 647     switch (type) {
 648     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
 649     case X509_V_ERR_UNABLE_TO_GET_CRL:
 650     case X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER:
 651         al = SSL_AD_UNKNOWN_CA;
 652         break;
 653     case X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE:
 654     case X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE:
 655     case X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY:
 656     case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
 657     case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
 658     case X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD:
 659     case X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD:
 660     case X509_V_ERR_CERT_NOT_YET_VALID:
 661     case X509_V_ERR_CRL_NOT_YET_VALID:
 662     case X509_V_ERR_CERT_UNTRUSTED:
 663     case X509_V_ERR_CERT_REJECTED:
 664     case X509_V_ERR_HOSTNAME_MISMATCH:
 665     case X509_V_ERR_EMAIL_MISMATCH:
 666     case X509_V_ERR_IP_ADDRESS_MISMATCH:
 667     case X509_V_ERR_DANE_NO_MATCH:
 668     case X509_V_ERR_EE_KEY_TOO_SMALL:
 669     case X509_V_ERR_CA_KEY_TOO_SMALL:
 670     case X509_V_ERR_CA_MD_TOO_WEAK:
 671         al = SSL_AD_BAD_CERTIFICATE;
 672         break;
 673     case X509_V_ERR_CERT_SIGNATURE_FAILURE:
 674     case X509_V_ERR_CRL_SIGNATURE_FAILURE:
 675         al = SSL_AD_DECRYPT_ERROR;
 676         break;
 677     case X509_V_ERR_CERT_HAS_EXPIRED:
 678     case X509_V_ERR_CRL_HAS_EXPIRED:
 679         al = SSL_AD_CERTIFICATE_EXPIRED;
 680         break;
 681     case X509_V_ERR_CERT_REVOKED:
 682         al = SSL_AD_CERTIFICATE_REVOKED;
 683         break;
 684     case X509_V_ERR_UNSPECIFIED:
 685     case X509_V_ERR_OUT_OF_MEM:
 686     case X509_V_ERR_INVALID_CALL:
 687     case X509_V_ERR_STORE_LOOKUP:
 688         al = SSL_AD_INTERNAL_ERROR;
 689         break;
 690     case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
 691     case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN:
 692     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY:
 693     case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE:
 694     case X509_V_ERR_CERT_CHAIN_TOO_LONG:
 695     case X509_V_ERR_PATH_LENGTH_EXCEEDED:
 696     case X509_V_ERR_INVALID_CA:
 697         al = SSL_AD_UNKNOWN_CA;
 698         break;
 699     case X509_V_ERR_APPLICATION_VERIFICATION:
 700         al = SSL_AD_HANDSHAKE_FAILURE;
 701         break;
 702     case X509_V_ERR_INVALID_PURPOSE:
 703         al = SSL_AD_UNSUPPORTED_CERTIFICATE;
 704         break;
 705     default:
 706         al = SSL_AD_CERTIFICATE_UNKNOWN;
 707         break;
 708     }
 709     return (al);
 710 }
 711
 712 int ssl_allow_compression(SSL *s)
 713 {
 714     if (s->options & SSL_OP_NO_COMPRESSION)
 715         return 0;
 716     return ssl_security(s, SSL_SECOP_COMPRESSION, 0, 0, NULL);
 717 }
 718
 719 static int version_cmp(const SSL *s, int a, int b)
 720 {
 721     int dtls = SSL_IS_DTLS(s);
 722
 723     if (a == b)
 724         return 0;
 725     if (!dtls)
 726         return a < b ? -1 : 1;
 727     return DTLS_VERSION_LT(a, b) ? -1 : 1;
 728 }
 729
 730 typedef struct {
 731     int version;
 732     const SSL_METHOD *(*cmeth) (void);
 733     const SSL_METHOD *(*smeth) (void);
 734 } version_info;
 735
 736 #if TLS_MAX_VERSION != TLS1_3_VERSION
 737 # error Code needs update for TLS_method() support beyond TLS1_3_VERSION.
 738 #endif
 739
 740 static const version_info tls_version_table[] = {
 741 #ifndef OPENSSL_NO_TLS1_3
 742     {TLS1_3_VERSION, tlsv1_3_client_method, tlsv1_3_server_method},
 743 #else
 744     {TLS1_3_VERSION, NULL, NULL},
 745 #endif
 746 #ifndef OPENSSL_NO_TLS1_2
 747     {TLS1_2_VERSION, tlsv1_2_client_method, tlsv1_2_server_method},
 748 #else
 749     {TLS1_2_VERSION, NULL, NULL},
 750 #endif
 751 #ifndef OPENSSL_NO_TLS1_1
 752     {TLS1_1_VERSION, tlsv1_1_client_method, tlsv1_1_server_method},
 753 #else
 754     {TLS1_1_VERSION, NULL, NULL},
 755 #endif
 756 #ifndef OPENSSL_NO_TLS1
 757     {TLS1_VERSION, tlsv1_client_method, tlsv1_server_method},
 758 #else
 759     {TLS1_VERSION, NULL, NULL},
 760 #endif
 761 #ifndef OPENSSL_NO_SSL3
 762     {SSL3_VERSION, sslv3_client_method, sslv3_server_method},
 763 #else
 764     {SSL3_VERSION, NULL, NULL},
 765 #endif
 766     {0, NULL, NULL},
 767 };
 768
 769 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
 770 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
 771 #endif
 772
 773 static const version_info dtls_version_table[] = {
 774 #ifndef OPENSSL_NO_DTLS1_2
 775     {DTLS1_2_VERSION, dtlsv1_2_client_method, dtlsv1_2_server_method},
 776 #else
 777     {DTLS1_2_VERSION, NULL, NULL},
 778 #endif
 779 #ifndef OPENSSL_NO_DTLS1
 780     {DTLS1_VERSION, dtlsv1_client_method, dtlsv1_server_method},
 781     {DTLS1_BAD_VER, dtls_bad_ver_client_method, NULL},
 782 #else
 783     {DTLS1_VERSION, NULL, NULL},
 784     {DTLS1_BAD_VER, NULL, NULL},
 785 #endif
 786     {0, NULL, NULL},
 787 };
 788
 789 /*
 790  * ssl_method_error - Check whether an SSL_METHOD is enabled.
 791  *
 792  * @s: The SSL handle for the candidate method
 793  * @method: the intended method.
 794  *
 795  * Returns 0 on success, or an SSL error reason on failure.
 796  */
 797 static int ssl_method_error(const SSL *s, const SSL_METHOD *method)
 798 {
 799     int version = method->version;
 800
 801     if ((s->min_proto_version != 0 &&
 802          version_cmp(s, version, s->min_proto_version) < 0) ||
 803         ssl_security(s, SSL_SECOP_VERSION, 0, version, NULL) == 0)
 804         return SSL_R_VERSION_TOO_LOW;
 805
 806     if (s->max_proto_version != 0 &&
 807         version_cmp(s, version, s->max_proto_version) > 0)
 808         return SSL_R_VERSION_TOO_HIGH;
 809
 810     if ((s->options & method->mask) != 0)
 811         return SSL_R_UNSUPPORTED_PROTOCOL;
 812     if ((method->flags & SSL_METHOD_NO_SUITEB) != 0 && tls1_suiteb(s))
 813         return SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE;
 814     else if ((method->flags & SSL_METHOD_NO_FIPS) != 0 && FIPS_mode())
 815         return SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE;
 816
 817     return 0;
 818 }
 819
 820 /*
 821  * ssl_version_supported - Check that the specified `version` is supported by
 822  * `SSL *` instance
 823  *
 824  * @s: The SSL handle for the candidate method
 825  * @version: Protocol version to test against
 826  *
 827  * Returns 1 when supported, otherwise 0
 828  */
 829 int ssl_version_supported(const SSL *s, int version)
 830 {
 831     const version_info *vent;
 832     const version_info *table;
 833
 834     switch (s->method->version) {
 835     default:
 836         /* Version should match method version for non-ANY method */
 837         return version_cmp(s, version, s->version) == 0;
 838     case TLS_ANY_VERSION:
 839         table = tls_version_table;
 840         break;
 841     case DTLS_ANY_VERSION:
 842         table = dtls_version_table;
 843         break;
 844     }
 845
 846     for (vent = table;
 847          vent->version != 0 && version_cmp(s, version, vent->version) <= 0;
 848          ++vent) {
 849         if (vent->cmeth != NULL &&
 850             version_cmp(s, version, vent->version) == 0 &&
 851             ssl_method_error(s, vent->cmeth()) == 0) {
 852             return 1;
 853         }
 854     }
 855     return 0;
 856 }
 857
 858 /*
 859  * ssl_check_version_downgrade - In response to RFC7507 SCSV version
 860  * fallback indication from a client check whether we're using the highest
 861  * supported protocol version.
 862  *
 863  * @s server SSL handle.
 864  *
 865  * Returns 1 when using the highest enabled version, 0 otherwise.
 866  */
 867 int ssl_check_version_downgrade(SSL *s)
 868 {
 869     const version_info *vent;
 870     const version_info *table;
 871
 872     /*
 873      * Check that the current protocol is the highest enabled version
 874      * (according to s->ctx->method, as version negotiation may have changed
 875      * s->method).
 876      */
 877     if (s->version == s->ctx->method->version)
 878         return 1;
 879
 880     /*
 881      * Apparently we're using a version-flexible SSL_METHOD (not at its
 882      * highest protocol version).
 883      */
 884     if (s->ctx->method->version == TLS_method()->version)
 885         table = tls_version_table;
 886     else if (s->ctx->method->version == DTLS_method()->version)
 887         table = dtls_version_table;
 888     else {
 889         /* Unexpected state; fail closed. */
 890         return 0;
 891     }
 892
 893     for (vent = table; vent->version != 0; ++vent) {
 894         if (vent->smeth != NULL && ssl_method_error(s, vent->smeth()) == 0)
 895             return s->version == vent->version;
 896     }
 897     return 0;
 898 }
 899
 900 /*
 901  * ssl_set_version_bound - set an upper or lower bound on the supported (D)TLS
 902  * protocols, provided the initial (D)TLS method is version-flexible.  This
 903  * function sanity-checks the proposed value and makes sure the method is
 904  * version-flexible, then sets the limit if all is well.
 905  *
 906  * @method_version: The version of the current SSL_METHOD.
 907  * @version: the intended limit.
 908  * @bound: pointer to limit to be updated.
 909  *
 910  * Returns 1 on success, 0 on failure.
 911  */
 912 int ssl_set_version_bound(int method_version, int version, int *bound)
 913 {
 914     if (version == 0) {
 915         *bound = version;
 916         return 1;
 917     }
 918
 919     /*-
 920      * Restrict TLS methods to TLS protocol versions.
 921      * Restrict DTLS methods to DTLS protocol versions.
 922      * Note, DTLS version numbers are decreasing, use comparison macros.
 923      *
 924      * Note that for both lower-bounds we use explicit versions, not
 925      * (D)TLS_MIN_VERSION.  This is because we don't want to break user
 926      * configurations.  If the MIN (supported) version ever rises, the user's
 927      * "floor" remains valid even if no longer available.  We don't expect the
 928      * MAX ceiling to ever get lower, so making that variable makes sense.
 929      */
 930     switch (method_version) {
 931     default:
 932         /*
 933          * XXX For fixed version methods, should we always fail and not set any
 934          * bounds, always succeed and not set any bounds, or set the bounds and
 935          * arrange to fail later if they are not met?  At present fixed-version
 936          * methods are not subject to controls that disable individual protocol
 937          * versions.
 938          */
 939         return 0;
 940
 941     case TLS_ANY_VERSION:
 942         if (version < SSL3_VERSION || version > TLS_MAX_VERSION)
 943             return 0;
 944         break;
 945
 946     case DTLS_ANY_VERSION:
 947         if (DTLS_VERSION_GT(version, DTLS_MAX_VERSION) ||
 948             DTLS_VERSION_LT(version, DTLS1_BAD_VER))
 949             return 0;
 950         break;
 951     }
 952
 953     *bound = version;
 954     return 1;
 955 }
 956
 957 /*
 958  * ssl_choose_server_version - Choose server (D)TLS version.  Called when the
 959  * client HELLO is received to select the final server protocol version and
 960  * the version specific method.
 961  *
 962  * @s: server SSL handle.
 963  *
 964  * Returns 0 on success or an SSL error reason number on failure.
 965  */
 966 int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello)
 967 {
 968     /*-
 969      * With version-flexible methods we have an initial state with:
 970      *
 971      *   s->method->version == (D)TLS_ANY_VERSION,
 972      *   s->version == (D)TLS_MAX_VERSION.
 973      *
 974      * So we detect version-flexible methods via the method version, not the
 975      * handle version.
 976      */
 977     int server_version = s->method->version;
 978     int client_version = hello->version;
 979     const version_info *vent;
 980     const version_info *table;
 981     int disabled = 0;
 982
 983     s->client_version = client_version;
 984
 985     switch (server_version) {
 986     default:
 987         if (version_cmp(s, client_version, s->version) < 0)
 988             return SSL_R_WRONG_SSL_VERSION;
 989         /*
 990          * If this SSL handle is not from a version flexible method we don't
 991          * (and never did) check min/max FIPS or Suite B constraints.  Hope
 992          * that's OK.  It is up to the caller to not choose fixed protocol
 993          * versions they don't want.  If not, then easy to fix, just return
 994          * ssl_method_error(s, s->method)
 995          */
 996         return 0;
 997     case TLS_ANY_VERSION:
 998         table = tls_version_table;
 999         break;
1000     case DTLS_ANY_VERSION:
1001         table = dtls_version_table;
1002         break;
1003     }
1004
1005     for (vent = table; vent->version != 0; ++vent) {
1006         const SSL_METHOD *method;
1007
1008         if (vent->smeth == NULL ||
1009             version_cmp(s, client_version, vent->version) < 0)
1010             continue;
1011         method = vent->smeth();
1012         if (ssl_method_error(s, method) == 0) {
1013             s->version = vent->version;
1014             s->method = method;
1015             return 0;
1016         }
1017         disabled = 1;
1018     }
1019     return disabled ? SSL_R_UNSUPPORTED_PROTOCOL : SSL_R_VERSION_TOO_LOW;
1020 }
1021
1022 /*
1023  * ssl_choose_client_version - Choose client (D)TLS version.  Called when the
1024  * server HELLO is received to select the final client protocol version and
1025  * the version specific method.
1026  *
1027  * @s: client SSL handle.
1028  * @version: The proposed version from the server's HELLO.
1029  *
1030  * Returns 0 on success or an SSL error reason number on failure.
1031  */
1032 int ssl_choose_client_version(SSL *s, int version)
1033 {
1034     const version_info *vent;
1035     const version_info *table;
1036
1037     switch (s->method->version) {
1038     default:
1039         if (version != s->version)
1040             return SSL_R_WRONG_SSL_VERSION;
1041         /*
1042          * If this SSL handle is not from a version flexible method we don't
1043          * (and never did) check min/max, FIPS or Suite B constraints.  Hope
1044          * that's OK.  It is up to the caller to not choose fixed protocol
1045          * versions they don't want.  If not, then easy to fix, just return
1046          * ssl_method_error(s, s->method)
1047          */
1048         return 0;
1049     case TLS_ANY_VERSION:
1050         table = tls_version_table;
1051         break;
1052     case DTLS_ANY_VERSION:
1053         table = dtls_version_table;
1054         break;
1055     }
1056
1057     for (vent = table; vent->version != 0; ++vent) {
1058         const SSL_METHOD *method;
1059         int err;
1060
1061         if (version != vent->version)
1062             continue;
1063         if (vent->cmeth == NULL)
1064             break;
1065         method = vent->cmeth();
1066         err = ssl_method_error(s, method);
1067         if (err != 0)
1068             return err;
1069         s->method = method;
1070         s->version = version;
1071         return 0;
1072     }
1073
1074     return SSL_R_UNSUPPORTED_PROTOCOL;
1075 }
1076
1077 /*
1078  * ssl_get_client_min_max_version - get minimum and maximum client version
1079  * @s: The SSL connection
1080  * @min_version: The minimum supported version
1081  * @max_version: The maximum supported version
1082  *
1083  * Work out what version we should be using for the initial ClientHello if the
1084  * version is initially (D)TLS_ANY_VERSION.  We apply any explicit SSL_OP_NO_xxx
1085  * options, the MinProtocol and MaxProtocol configuration commands, any Suite B
1086  * or FIPS_mode() constraints and any floor imposed by the security level here,
1087  * so we don't advertise the wrong protocol version to only reject the outcome later.
1088  *
1089  * Computing the right floor matters.  If, e.g., TLS 1.0 and 1.2 are enabled,
1090  * TLS 1.1 is disabled, but the security level, Suite-B  and/or MinProtocol
1091  * only allow TLS 1.2, we want to advertise TLS1.2, *not* TLS1.
1092  *
1093  * Returns 0 on success or an SSL error reason number on failure.  On failure
1094  * min_version and max_version will also be set to 0.
1095  */
1096 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
1097                                    int *max_version)
1098 {
1099     int version;
1100     int hole;
1101     const SSL_METHOD *single = NULL;
1102     const SSL_METHOD *method;
1103     const version_info *table;
1104     const version_info *vent;
1105
1106     switch (s->method->version) {
1107     default:
1108         /*
1109          * If this SSL handle is not from a version flexible method we don't
1110          * (and never did) check min/max FIPS or Suite B constraints.  Hope
1111          * that's OK.  It is up to the caller to not choose fixed protocol
1112          * versions they don't want.  If not, then easy to fix, just return
1113          * ssl_method_error(s, s->method)
1114          */
1115         *min_version = *max_version = s->version;
1116         return 0;
1117     case TLS_ANY_VERSION:
1118         table = tls_version_table;
1119         break;
1120     case DTLS_ANY_VERSION:
1121         table = dtls_version_table;
1122         break;
1123     }
1124
1125     /*
1126      * SSL_OP_NO_X disables all protocols above X *if* there are some protocols
1127      * below X enabled. This is required in order to maintain the "version
1128      * capability" vector contiguous. Any versions with a NULL client method
1129      * (protocol version client is disabled at compile-time) is also a "hole".
1130      *
1131      * Our initial state is hole == 1, version == 0.  That is, versions above
1132      * the first version in the method table are disabled (a "hole" above
1133      * the valid protocol entries) and we don't have a selected version yet.
1134      *
1135      * Whenever "hole == 1", and we hit an enabled method, its version becomes
1136      * the selected version, and the method becomes a candidate "single"
1137      * method.  We're no longer in a hole, so "hole" becomes 0.
1138      *
1139      * If "hole == 0" and we hit an enabled method, then "single" is cleared,
1140      * as we support a contiguous range of at least two methods.  If we hit
1141      * a disabled method, then hole becomes true again, but nothing else
1142      * changes yet, because all the remaining methods may be disabled too.
1143      * If we again hit an enabled method after the new hole, it becomes
1144      * selected, as we start from scratch.
1145      */
1146     *min_version = version = 0;
1147     hole = 1;
1148     for (vent = table; vent->version != 0; ++vent) {
1149         /*
1150          * A table entry with a NULL client method is still a hole in the
1151          * "version capability" vector.
1152          */
1153         if (vent->cmeth == NULL) {
1154             hole = 1;
1155             continue;
1156         }
1157         method = vent->cmeth();
1158         if (ssl_method_error(s, method) != 0) {
1159             hole = 1;
1160         } else if (!hole) {
1161             single = NULL;
1162             *min_version = method->version;
1163         } else {
1164             version = (single = method)->version;
1165             *min_version = version;
1166             hole = 0;
1167         }
1168     }
1169
1170     *max_version = version;
1171
1172     /* Fail if everything is disabled */
1173     if (version == 0)
1174         return SSL_R_NO_PROTOCOLS_AVAILABLE;
1175
1176     return 0;
1177 }
1178
1179 /*
1180  * ssl_set_client_hello_version - Work out what version we should be using for
1181  * the initial ClientHello.
1182  *
1183  * @s: client SSL handle.
1184  *
1185  * Returns 0 on success or an SSL error reason number on failure.
1186  */
1187 int ssl_set_client_hello_version(SSL *s)
1188 {
1189     int ver_min, ver_max, ret;
1190
1191     ret = ssl_get_client_min_max_version(s, &ver_min, &ver_max);
1192
1193     if (ret != 0)
1194         return ret;
1195
1196     s->client_version = s->version = ver_max;
1197     return 0;
1198 }