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