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         }
 335     }
 336
 337     return WORK_FINISHED_STOP;
 338 }
 339
 340 int tls_get_message_header(SSL *s, int *mt)
 341 {
 342     /* s->init_num < SSL3_HM_HEADER_LENGTH */
 343     int skip_message, i, recvd_type, al;
 344     unsigned char *p;
 345     unsigned long l;
 346
 347     p = (unsigned char *)s->init_buf->data;
 348
 349     do {
 350         while (s->init_num < SSL3_HM_HEADER_LENGTH) {
 351             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type,
 352                 &p[s->init_num], SSL3_HM_HEADER_LENGTH - s->init_num, 0);
 353             if (i <= 0) {
 354                 s->rwstate = SSL_READING;
 355                 return 0;
 356             }
 357             if (recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
 358                 /*
 359                  * A ChangeCipherSpec must be a single byte and may not occur
 360                  * in the middle of a handshake message.
 361                  */
 362                 if (s->init_num != 0 || i != 1 || p[0] != SSL3_MT_CCS) {
 363                     al = SSL_AD_UNEXPECTED_MESSAGE;
 364                     SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER,
 365                            SSL_R_BAD_CHANGE_CIPHER_SPEC);
 366                     goto f_err;
 367                 }
 368                 s->s3->tmp.message_type = *mt = SSL3_MT_CHANGE_CIPHER_SPEC;
 369                 s->init_num = i - 1;
 370                 s->s3->tmp.message_size = i;
 371                 return 1;
 372             } else if (recvd_type != SSL3_RT_HANDSHAKE) {
 373                 al = SSL_AD_UNEXPECTED_MESSAGE;
 374                 SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER, SSL_R_CCS_RECEIVED_EARLY);
 375                 goto f_err;
 376             }
 377             s->init_num += i;
 378         }
 379
 380         skip_message = 0;
 381         if (!s->server)
 382             if (p[0] == SSL3_MT_HELLO_REQUEST)
 383                 /*
 384                  * The server may always send 'Hello Request' messages --
 385                  * we are doing a handshake anyway now, so ignore them if
 386                  * their format is correct. Does not count for 'Finished'
 387                  * MAC.
 388                  */
 389                 if (p[1] == 0 && p[2] == 0 && p[3] == 0) {
 390                     s->init_num = 0;
 391                     skip_message = 1;
 392
 393                     if (s->msg_callback)
 394                         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
 395                                         p, SSL3_HM_HEADER_LENGTH, s,
 396                                         s->msg_callback_arg);
 397                 }
 398     } while (skip_message);
 399     /* s->init_num == SSL3_HM_HEADER_LENGTH */
 400
 401     *mt = *p;
 402     s->s3->tmp.message_type = *(p++);
 403
 404     if (RECORD_LAYER_is_sslv2_record(&s->rlayer)) {
 405         /*
 406          * Only happens with SSLv3+ in an SSLv2 backward compatible
 407          * ClientHello
 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         if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
 486                              s->init_num)) {
 487             SSLerr(SSL_F_TLS_GET_MESSAGE_BODY, ERR_R_EVP_LIB);
 488             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 489             *len = 0;
 490             return 0;
 491         }
 492         if (s->msg_callback)
 493             s->msg_callback(0, SSL2_VERSION, 0,  s->init_buf->data,
 494                             (size_t)s->init_num, s, s->msg_callback_arg);
 495     } else {
 496         if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
 497             s->init_num + SSL3_HM_HEADER_LENGTH)) {
 498             SSLerr(SSL_F_TLS_GET_MESSAGE_BODY, ERR_R_EVP_LIB);
 499             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 500             *len = 0;
 501             return 0;
 502         }
 503         if (s->msg_callback)
 504             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE, s->init_buf->data,
 505                             (size_t)s->init_num + SSL3_HM_HEADER_LENGTH, s,
 506                             s->msg_callback_arg);
 507     }
 508
 509     /*
 510      * init_num should never be negative...should probably be declared
 511      * unsigned
 512      */
 513     if (s->init_num < 0) {
 514         SSLerr(SSL_F_TLS_GET_MESSAGE_BODY, ERR_R_INTERNAL_ERROR);
 515         ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
 516         *len = 0;
 517         return 0;
 518     }
 519     *len = (unsigned long)s->init_num;
 520     return 1;
 521 }
 522
 523 int ssl_cert_type(X509 *x, EVP_PKEY *pk)
 524 {
 525     if (pk == NULL &&
 526         (pk = X509_get0_pubkey(x)) == NULL)
 527         return -1;
 528
 529     switch (EVP_PKEY_id(pk)) {
 530     default:
 531         return -1;
 532     case EVP_PKEY_RSA:
 533         return SSL_PKEY_RSA_ENC;
 534     case EVP_PKEY_DSA:
 535         return SSL_PKEY_DSA_SIGN;
 536 #ifndef OPENSSL_NO_EC
 537     case EVP_PKEY_EC:
 538         return SSL_PKEY_ECC;
 539 #endif
 540 #ifndef OPENSSL_NO_GOST
 541     case NID_id_GostR3410_2001:
 542         return SSL_PKEY_GOST01;
 543     case NID_id_GostR3410_2012_256:
 544         return SSL_PKEY_GOST12_256;
 545     case NID_id_GostR3410_2012_512:
 546         return SSL_PKEY_GOST12_512;
 547 #endif
 548     }
 549 }
 550
 551 int ssl_verify_alarm_type(long type)
 552 {
 553     int al;
 554
 555     switch (type) {
 556     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
 557     case X509_V_ERR_UNABLE_TO_GET_CRL:
 558     case X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER:
 559         al = SSL_AD_UNKNOWN_CA;
 560         break;
 561     case X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE:
 562     case X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE:
 563     case X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY:
 564     case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
 565     case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
 566     case X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD:
 567     case X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD:
 568     case X509_V_ERR_CERT_NOT_YET_VALID:
 569     case X509_V_ERR_CRL_NOT_YET_VALID:
 570     case X509_V_ERR_CERT_UNTRUSTED:
 571     case X509_V_ERR_CERT_REJECTED:
 572     case X509_V_ERR_HOSTNAME_MISMATCH:
 573     case X509_V_ERR_EMAIL_MISMATCH:
 574     case X509_V_ERR_IP_ADDRESS_MISMATCH:
 575     case X509_V_ERR_DANE_NO_MATCH:
 576     case X509_V_ERR_EE_KEY_TOO_SMALL:
 577     case X509_V_ERR_CA_KEY_TOO_SMALL:
 578     case X509_V_ERR_CA_MD_TOO_WEAK:
 579         al = SSL_AD_BAD_CERTIFICATE;
 580         break;
 581     case X509_V_ERR_CERT_SIGNATURE_FAILURE:
 582     case X509_V_ERR_CRL_SIGNATURE_FAILURE:
 583         al = SSL_AD_DECRYPT_ERROR;
 584         break;
 585     case X509_V_ERR_CERT_HAS_EXPIRED:
 586     case X509_V_ERR_CRL_HAS_EXPIRED:
 587         al = SSL_AD_CERTIFICATE_EXPIRED;
 588         break;
 589     case X509_V_ERR_CERT_REVOKED:
 590         al = SSL_AD_CERTIFICATE_REVOKED;
 591         break;
 592     case X509_V_ERR_UNSPECIFIED:
 593     case X509_V_ERR_OUT_OF_MEM:
 594     case X509_V_ERR_INVALID_CALL:
 595     case X509_V_ERR_STORE_LOOKUP:
 596         al = SSL_AD_INTERNAL_ERROR;
 597         break;
 598     case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
 599     case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN:
 600     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY:
 601     case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE:
 602     case X509_V_ERR_CERT_CHAIN_TOO_LONG:
 603     case X509_V_ERR_PATH_LENGTH_EXCEEDED:
 604     case X509_V_ERR_INVALID_CA:
 605         al = SSL_AD_UNKNOWN_CA;
 606         break;
 607     case X509_V_ERR_APPLICATION_VERIFICATION:
 608         al = SSL_AD_HANDSHAKE_FAILURE;
 609         break;
 610     case X509_V_ERR_INVALID_PURPOSE:
 611         al = SSL_AD_UNSUPPORTED_CERTIFICATE;
 612         break;
 613     default:
 614         al = SSL_AD_CERTIFICATE_UNKNOWN;
 615         break;
 616     }
 617     return (al);
 618 }
 619
 620 int ssl_allow_compression(SSL *s)
 621 {
 622     if (s->options & SSL_OP_NO_COMPRESSION)
 623         return 0;
 624     return ssl_security(s, SSL_SECOP_COMPRESSION, 0, 0, NULL);
 625 }
 626
 627 static int version_cmp(const SSL *s, int a, int b)
 628 {
 629     int dtls = SSL_IS_DTLS(s);
 630
 631     if (a == b)
 632         return 0;
 633     if (!dtls)
 634         return a < b ? -1 : 1;
 635     return DTLS_VERSION_LT(a, b) ? -1 : 1;
 636 }
 637
 638 typedef struct {
 639     int version;
 640     const SSL_METHOD *(*cmeth)(void);
 641     const SSL_METHOD *(*smeth)(void);
 642 } version_info;
 643
 644 #if TLS_MAX_VERSION != TLS1_2_VERSION
 645 # error Code needs update for TLS_method() support beyond TLS1_2_VERSION.
 646 #endif
 647
 648 static const version_info tls_version_table[] = {
 649 #ifndef OPENSSL_NO_TLS1_2
 650     { TLS1_2_VERSION, tlsv1_2_client_method, tlsv1_2_server_method },
 651 #else
 652     { TLS1_2_VERSION, NULL, NULL },
 653 #endif
 654 #ifndef OPENSSL_NO_TLS1_1
 655     { TLS1_1_VERSION, tlsv1_1_client_method, tlsv1_1_server_method },
 656 #else
 657     { TLS1_1_VERSION, NULL, NULL },
 658 #endif
 659 #ifndef OPENSSL_NO_TLS1
 660     { TLS1_VERSION, tlsv1_client_method, tlsv1_server_method },
 661 #else
 662     { TLS1_VERSION, NULL, NULL },
 663 #endif
 664 #ifndef OPENSSL_NO_SSL3
 665     { SSL3_VERSION, sslv3_client_method, sslv3_server_method },
 666 #else
 667     { SSL3_VERSION, NULL, NULL },
 668 #endif
 669     { 0, NULL, NULL },
 670 };
 671
 672 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
 673 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
 674 #endif
 675
 676 static const version_info dtls_version_table[] = {
 677 #ifndef OPENSSL_NO_DTLS1_2
 678     { DTLS1_2_VERSION, dtlsv1_2_client_method, dtlsv1_2_server_method },
 679 #else
 680     { DTLS1_2_VERSION, NULL, NULL },
 681 #endif
 682 #ifndef OPENSSL_NO_DTLS1
 683     { DTLS1_VERSION, dtlsv1_client_method, dtlsv1_server_method },
 684 #else
 685     { DTLS1_VERSION, NULL, NULL },
 686 #endif
 687     { 0, NULL, NULL },
 688 };
 689
 690 /*
 691  * ssl_method_error - Check whether an SSL_METHOD is enabled.
 692  *
 693  * @s: The SSL handle for the candidate method
 694  * @method: the intended method.
 695  *
 696  * Returns 0 on success, or an SSL error reason on failure.
 697  */
 698 static int ssl_method_error(const SSL *s, const SSL_METHOD *method)
 699 {
 700     int version = method->version;
 701
 702     if ((s->min_proto_version != 0 &&
 703          version_cmp(s, version, s->min_proto_version) < 0) ||
 704         ssl_security(s, SSL_SECOP_VERSION, 0, version, NULL) == 0)
 705         return SSL_R_VERSION_TOO_LOW;
 706
 707     if (s->max_proto_version != 0 &&
 708              version_cmp(s, version, s->max_proto_version) > 0)
 709         return SSL_R_VERSION_TOO_HIGH;
 710
 711     if ((s->options & method->mask) != 0)
 712         return SSL_R_UNSUPPORTED_PROTOCOL;
 713     if ((method->flags & SSL_METHOD_NO_SUITEB) != 0 && tls1_suiteb(s))
 714         return SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE;
 715     else if ((method->flags & SSL_METHOD_NO_FIPS) != 0 && FIPS_mode())
 716         return SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE;
 717
 718     return 0;
 719 }
 720
 721 /*
 722  * ssl_version_supported - Check that the specified `version` is supported by
 723  * `SSL *` instance
 724  *
 725  * @s: The SSL handle for the candidate method
 726  * @version: Protocol version to test against
 727  *
 728  * Returns 1 when supported, otherwise 0
 729  */
 730 int ssl_version_supported(const SSL *s, int version)
 731 {
 732     const version_info *vent;
 733     const version_info *table;
 734
 735     switch (s->method->version) {
 736     default:
 737         /* Version should match method version for non-ANY method */
 738         return version_cmp(s, version, s->version) == 0;
 739     case TLS_ANY_VERSION:
 740         table = tls_version_table;
 741         break;
 742     case DTLS_ANY_VERSION:
 743         table = dtls_version_table;
 744         break;
 745     }
 746
 747     for (vent = table;
 748          vent->version != 0 && version_cmp(s, version, vent->version) <= 0;
 749          ++vent) {
 750         if (vent->cmeth != NULL &&
 751             version_cmp(s, version, vent->version) == 0 &&
 752             ssl_method_error(s, vent->cmeth()) == 0) {
 753             return 1;
 754         }
 755     }
 756     return 0;
 757 }
 758
 759 /*
 760  * ssl_check_version_downgrade - In response to RFC7507 SCSV version
 761  * fallback indication from a client check whether we're using the highest
 762  * supported protocol version.
 763  *
 764  * @s server SSL handle.
 765  *
 766  * Returns 1 when using the highest enabled version, 0 otherwise.
 767  */
 768 int ssl_check_version_downgrade(SSL *s)
 769 {
 770     const version_info *vent;
 771     const version_info *table;
 772
 773     /*
 774      * Check that the current protocol is the highest enabled version
 775      * (according to s->ctx->method, as version negotiation may have changed
 776      * s->method).
 777      */
 778     if (s->version == s->ctx->method->version)
 779         return 1;
 780
 781     /*
 782      * Apparently we're using a version-flexible SSL_METHOD (not at its
 783      * highest protocol version).
 784      */
 785     if (s->ctx->method->version == TLS_method()->version)
 786         table = tls_version_table;
 787     else if (s->ctx->method->version == DTLS_method()->version)
 788         table = dtls_version_table;
 789     else {
 790         /* Unexpected state; fail closed. */
 791         return 0;
 792     }
 793
 794     for (vent = table; vent->version != 0; ++vent) {
 795         if (vent->smeth != NULL &&
 796             ssl_method_error(s, vent->smeth()) == 0)
 797             return s->version == vent->version;
 798     }
 799     return 0;
 800 }
 801
 802 /*
 803  * ssl_set_version_bound - set an upper or lower bound on the supported (D)TLS
 804  * protocols, provided the initial (D)TLS method is version-flexible.  This
 805  * function sanity-checks the proposed value and makes sure the method is
 806  * version-flexible, then sets the limit if all is well.
 807  *
 808  * @method_version: The version of the current SSL_METHOD.
 809  * @version: the intended limit.
 810  * @bound: pointer to limit to be updated.
 811  *
 812  * Returns 1 on success, 0 on failure.
 813  */
 814 int ssl_set_version_bound(int method_version, int version, int *bound)
 815 {
 816     if (version == 0) {
 817         *bound = version;
 818         return 1;
 819     }
 820
 821     /*-
 822      * Restrict TLS methods to TLS protocol versions.
 823      * Restrict DTLS methods to DTLS protocol versions.
 824      * Note, DTLS version numbers are decreasing, use comparison macros.
 825      *
 826      * Note that for both lower-bounds we use explicit versions, not
 827      * (D)TLS_MIN_VERSION.  This is because we don't want to break user
 828      * configurations.  If the MIN (supported) version ever rises, the user's
 829      * "floor" remains valid even if no longer available.  We don't expect the
 830      * MAX ceiling to ever get lower, so making that variable makes sense.
 831      */
 832     switch (method_version) {
 833     default:
 834         /*
 835          * XXX For fixed version methods, should we always fail and not set any
 836          * bounds, always succeed and not set any bounds, or set the bounds and
 837          * arrange to fail later if they are not met?  At present fixed-version
 838          * methods are not subject to controls that disable individual protocol
 839          * versions.
 840          */
 841         return 0;
 842
 843     case TLS_ANY_VERSION:
 844         if (version < SSL3_VERSION || version > TLS_MAX_VERSION)
 845             return 0;
 846         break;
 847
 848     case DTLS_ANY_VERSION:
 849         if (DTLS_VERSION_GT(version, DTLS_MAX_VERSION) ||
 850             DTLS_VERSION_LT(version, DTLS1_VERSION))
 851             return 0;
 852         break;
 853     }
 854
 855     *bound = version;
 856     return 1;
 857 }
 858
 859 /*
 860  * ssl_choose_server_version - Choose server (D)TLS version.  Called when the
 861  * client HELLO is received to select the final server protocol version and
 862  * the version specific method.
 863  *
 864  * @s: server SSL handle.
 865  *
 866  * Returns 0 on success or an SSL error reason number on failure.
 867  */
 868 int ssl_choose_server_version(SSL *s)
 869 {
 870     /*-
 871      * With version-flexible methods we have an initial state with:
 872      *
 873      *   s->method->version == (D)TLS_ANY_VERSION,
 874      *   s->version == (D)TLS_MAX_VERSION.
 875      *
 876      * So we detect version-flexible methods via the method version, not the
 877      * handle version.
 878      */
 879     int server_version = s->method->version;
 880     int client_version = s->client_version;
 881     const version_info *vent;
 882     const version_info *table;
 883     int disabled = 0;
 884
 885     switch (server_version) {
 886     default:
 887         if (version_cmp(s, client_version, s->version) < 0)
 888             return SSL_R_WRONG_SSL_VERSION;
 889         /*
 890          * If this SSL handle is not from a version flexible method we don't
 891          * (and never did) check min/max FIPS or Suite B constraints.  Hope
 892          * that's OK.  It is up to the caller to not choose fixed protocol
 893          * versions they don't want.  If not, then easy to fix, just return
 894          * ssl_method_error(s, s->method)
 895          */
 896         return 0;
 897     case TLS_ANY_VERSION:
 898         table = tls_version_table;
 899         break;
 900     case DTLS_ANY_VERSION:
 901         table = dtls_version_table;
 902         break;
 903     }
 904
 905     for (vent = table; vent->version != 0; ++vent) {
 906         const SSL_METHOD *method;
 907
 908         if (vent->smeth == NULL ||
 909             version_cmp(s, client_version, vent->version) < 0)
 910             continue;
 911         method = vent->smeth();
 912         if (ssl_method_error(s, method) == 0) {
 913             s->version = vent->version;
 914             s->method = method;
 915             return 0;
 916         }
 917         disabled = 1;
 918     }
 919     return disabled ? SSL_R_UNSUPPORTED_PROTOCOL : SSL_R_VERSION_TOO_LOW;
 920 }
 921
 922 /*
 923  * ssl_choose_client_version - Choose client (D)TLS version.  Called when the
 924  * server HELLO is received to select the final client protocol version and
 925  * the version specific method.
 926  *
 927  * @s: client SSL handle.
 928  * @version: The proposed version from the server's HELLO.
 929  *
 930  * Returns 0 on success or an SSL error reason number on failure.
 931  */
 932 int ssl_choose_client_version(SSL *s, int version)
 933 {
 934     const version_info *vent;
 935     const version_info *table;
 936
 937     switch (s->method->version) {
 938     default:
 939         if (version != s->version)
 940             return SSL_R_WRONG_SSL_VERSION;
 941         /*
 942          * If this SSL handle is not from a version flexible method we don't
 943          * (and never did) check min/max, FIPS or Suite B constraints.  Hope
 944          * that's OK.  It is up to the caller to not choose fixed protocol
 945          * versions they don't want.  If not, then easy to fix, just return
 946          * ssl_method_error(s, s->method)
 947          */
 948         return 0;
 949     case TLS_ANY_VERSION:
 950         table = tls_version_table;
 951         break;
 952     case DTLS_ANY_VERSION:
 953         table = dtls_version_table;
 954         break;
 955     }
 956
 957     for (vent = table; vent->version != 0; ++vent) {
 958         const SSL_METHOD *method;
 959         int err;
 960
 961         if (version != vent->version)
 962             continue;
 963         if (vent->cmeth == NULL)
 964             break;
 965         method = vent->cmeth();
 966         err = ssl_method_error(s, method);
 967         if (err != 0)
 968             return err;
 969         s->method = method;
 970         s->version = version;
 971         return 0;
 972     }
 973
 974     return SSL_R_UNSUPPORTED_PROTOCOL;
 975 }
 976
 977 /*
 978  * ssl_get_client_min_max_version - get minimum and maximum client version
 979  * @s: The SSL connection
 980  * @min_version: The minimum supported version
 981  * @max_version: The maximum supported version
 982  *
 983  * Work out what version we should be using for the initial ClientHello if the
 984  * version is initially (D)TLS_ANY_VERSION.  We apply any explicit SSL_OP_NO_xxx
 985  * options, the MinProtocol and MaxProtocol configuration commands, any Suite B
 986  * or FIPS_mode() constraints and any floor imposed by the security level here,
 987  * so we don't advertise the wrong protocol version to only reject the outcome later.
 988  *
 989  * Computing the right floor matters.  If, e.g., TLS 1.0 and 1.2 are enabled,
 990  * TLS 1.1 is disabled, but the security level, Suite-B  and/or MinProtocol
 991  * only allow TLS 1.2, we want to advertise TLS1.2, *not* TLS1.
 992  *
 993  * Returns 0 on success or an SSL error reason number on failure.  On failure
 994  * min_version and max_version will also be set to 0.
 995  */
 996 int ssl_get_client_min_max_version(const SSL *s, int *min_version, int *max_version)
 997 {
 998     int version;
 999     int hole;
1000     const SSL_METHOD *single = NULL;
1001     const SSL_METHOD *method;
1002     const version_info *table;
1003     const version_info *vent;
1004
1005     switch (s->method->version) {
1006     default:
1007         /*
1008          * If this SSL handle is not from a version flexible method we don't
1009          * (and never did) check min/max FIPS or Suite B constraints.  Hope
1010          * that's OK.  It is up to the caller to not choose fixed protocol
1011          * versions they don't want.  If not, then easy to fix, just return
1012          * ssl_method_error(s, s->method)
1013          */
1014         *min_version = *max_version = s->version;
1015         return 0;
1016     case TLS_ANY_VERSION:
1017         table = tls_version_table;
1018         break;
1019     case DTLS_ANY_VERSION:
1020         table = dtls_version_table;
1021         break;
1022     }
1023
1024     /*
1025      * SSL_OP_NO_X disables all protocols above X *if* there are some protocols
1026      * below X enabled. This is required in order to maintain the "version
1027      * capability" vector contiguous. Any versions with a NULL client method
1028      * (protocol version client is disabled at compile-time) is also a "hole".
1029      *
1030      * Our initial state is hole == 1, version == 0.  That is, versions above
1031      * the first version in the method table are disabled (a "hole" above
1032      * the valid protocol entries) and we don't have a selected version yet.
1033      *
1034      * Whenever "hole == 1", and we hit an enabled method, its version becomes
1035      * the selected version, and the method becomes a candidate "single"
1036      * method.  We're no longer in a hole, so "hole" becomes 0.
1037      *
1038      * If "hole == 0" and we hit an enabled method, then "single" is cleared,
1039      * as we support a contiguous range of at least two methods.  If we hit
1040      * a disabled method, then hole becomes true again, but nothing else
1041      * changes yet, because all the remaining methods may be disabled too.
1042      * If we again hit an enabled method after the new hole, it becomes
1043      * selected, as we start from scratch.
1044      */
1045     *min_version = version = 0;
1046     hole = 1;
1047     for (vent = table; vent->version != 0; ++vent) {
1048         /*
1049          * A table entry with a NULL client method is still a hole in the
1050          * "version capability" vector.
1051          */
1052         if (vent->cmeth == NULL) {
1053             hole = 1;
1054             continue;
1055         }
1056         method = vent->cmeth();
1057         if (ssl_method_error(s, method) != 0) {
1058             hole = 1;
1059         } else if (!hole) {
1060             single = NULL;
1061             *min_version = method->version;
1062         } else {
1063             version = (single = method)->version;
1064             *min_version = version;
1065             hole = 0;
1066         }
1067     }
1068
1069     *max_version = version;
1070
1071     /* Fail if everything is disabled */
1072     if (version == 0)
1073         return SSL_R_NO_PROTOCOLS_AVAILABLE;
1074
1075     return 0;
1076 }
1077
1078 /*
1079  * ssl_set_client_hello_version - Work out what version we should be using for
1080  * the initial ClientHello.
1081  *
1082  * @s: client SSL handle.
1083  *
1084  * Returns 0 on success or an SSL error reason number on failure.
1085  */
1086 int ssl_set_client_hello_version(SSL *s)
1087 {
1088     int ver_min, ver_max, ret;
1089
1090     ret = ssl_get_client_min_max_version(s, &ver_min, &ver_max);
1091
1092     if (ret != 0)
1093         return ret;
1094
1095     s->client_version = s->version = ver_max;
1096     return 0;
1097 }