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