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