2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
5 * Licensed under the OpenSSL license (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
14 #include "../ssl_locl.h"
15 #include "statem_locl.h"
16 #include "internal/cryptlib.h"
17 #include <openssl/buffer.h>
18 #include <openssl/objects.h>
19 #include <openssl/evp.h>
20 #include <openssl/x509.h>
23 * Map error codes to TLS/SSL alart types.
25 typedef struct x509err2alert_st {
30 /* Fixed value used in the ServerHello random field to identify an HRR */
31 const unsigned char hrrrandom[] = {
32 0xcf, 0x21, 0xad, 0x74, 0xe5, 0x9a, 0x61, 0x11, 0xbe, 0x1d, 0x8c, 0x02,
33 0x1e, 0x65, 0xb8, 0x91, 0xc2, 0xa2, 0x11, 0x16, 0x7a, 0xbb, 0x8c, 0x5e,
34 0x07, 0x9e, 0x09, 0xe2, 0xc8, 0xa8, 0x33, 0x9c
38 * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
39 * SSL3_RT_CHANGE_CIPHER_SPEC)
41 int ssl3_do_write(SSL *s, int type)
46 ret = ssl3_write_bytes(s, type, &s->init_buf->data[s->init_off],
47 s->init_num, &written);
50 if (type == SSL3_RT_HANDSHAKE)
52 * should not be done for 'Hello Request's, but in that case we'll
53 * ignore the result anyway
54 * TLS1.3 KeyUpdate and NewSessionTicket do not need to be added
56 if (!SSL_IS_TLS13(s) || (s->statem.hand_state != TLS_ST_SW_SESSION_TICKET
57 && s->statem.hand_state != TLS_ST_CW_KEY_UPDATE
58 && s->statem.hand_state != TLS_ST_SW_KEY_UPDATE))
59 if (!ssl3_finish_mac(s,
60 (unsigned char *)&s->init_buf->data[s->init_off],
63 if (written == s->init_num) {
65 s->msg_callback(1, s->version, type, s->init_buf->data,
66 (size_t)(s->init_off + s->init_num), s,
70 s->init_off += written;
71 s->init_num -= written;
75 int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype)
79 if ((htype != SSL3_MT_CHANGE_CIPHER_SPEC && !WPACKET_close(pkt))
80 || !WPACKET_get_length(pkt, &msglen)
83 s->init_num = (int)msglen;
89 int tls_setup_handshake(SSL *s)
91 if (!ssl3_init_finished_mac(s)) {
92 /* SSLfatal() already called */
96 /* Reset any extension flags */
97 memset(s->ext.extflags, 0, sizeof(s->ext.extflags));
100 STACK_OF(SSL_CIPHER) *ciphers = SSL_get_ciphers(s);
101 int i, ver_min, ver_max, ok = 0;
104 * Sanity check that the maximum version we accept has ciphers
105 * enabled. For clients we do this check during construction of the
108 if (ssl_get_min_max_version(s, &ver_min, &ver_max, NULL) != 0) {
109 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_SETUP_HANDSHAKE,
110 ERR_R_INTERNAL_ERROR);
113 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
114 const SSL_CIPHER *c = sk_SSL_CIPHER_value(ciphers, i);
116 if (SSL_IS_DTLS(s)) {
117 if (DTLS_VERSION_GE(ver_max, c->min_dtls) &&
118 DTLS_VERSION_LE(ver_max, c->max_dtls))
120 } else if (ver_max >= c->min_tls && ver_max <= c->max_tls) {
127 SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_TLS_SETUP_HANDSHAKE,
128 SSL_R_NO_CIPHERS_AVAILABLE);
129 ERR_add_error_data(1, "No ciphers enabled for max supported "
133 if (SSL_IS_FIRST_HANDSHAKE(s)) {
134 /* N.B. s->session_ctx == s->ctx here */
135 tsan_counter(&s->session_ctx->stats.sess_accept);
137 /* N.B. s->ctx may not equal s->session_ctx */
138 tsan_counter(&s->ctx->stats.sess_accept_renegotiate);
140 s->s3->tmp.cert_request = 0;
143 if (SSL_IS_FIRST_HANDSHAKE(s))
144 tsan_counter(&s->session_ctx->stats.sess_connect);
146 tsan_counter(&s->session_ctx->stats.sess_connect_renegotiate);
148 /* mark client_random uninitialized */
149 memset(s->s3->client_random, 0, sizeof(s->s3->client_random));
152 s->s3->tmp.cert_req = 0;
155 s->statem.use_timer = 1;
162 * Size of the to-be-signed TLS13 data, without the hash size itself:
163 * 64 bytes of value 32, 33 context bytes, 1 byte separator
165 #define TLS13_TBS_START_SIZE 64
166 #define TLS13_TBS_PREAMBLE_SIZE (TLS13_TBS_START_SIZE + 33 + 1)
168 static int get_cert_verify_tbs_data(SSL *s, unsigned char *tls13tbs,
169 void **hdata, size_t *hdatalen)
171 static const char *servercontext = "TLS 1.3, server CertificateVerify";
172 static const char *clientcontext = "TLS 1.3, client CertificateVerify";
174 if (SSL_IS_TLS13(s)) {
177 /* Set the first 64 bytes of to-be-signed data to octet 32 */
178 memset(tls13tbs, 32, TLS13_TBS_START_SIZE);
179 /* This copies the 33 bytes of context plus the 0 separator byte */
180 if (s->statem.hand_state == TLS_ST_CR_CERT_VRFY
181 || s->statem.hand_state == TLS_ST_SW_CERT_VRFY)
182 strcpy((char *)tls13tbs + TLS13_TBS_START_SIZE, servercontext);
184 strcpy((char *)tls13tbs + TLS13_TBS_START_SIZE, clientcontext);
187 * If we're currently reading then we need to use the saved handshake
188 * hash value. We can't use the current handshake hash state because
189 * that includes the CertVerify itself.
191 if (s->statem.hand_state == TLS_ST_CR_CERT_VRFY
192 || s->statem.hand_state == TLS_ST_SR_CERT_VRFY) {
193 memcpy(tls13tbs + TLS13_TBS_PREAMBLE_SIZE, s->cert_verify_hash,
194 s->cert_verify_hash_len);
195 hashlen = s->cert_verify_hash_len;
196 } else if (!ssl_handshake_hash(s, tls13tbs + TLS13_TBS_PREAMBLE_SIZE,
197 EVP_MAX_MD_SIZE, &hashlen)) {
198 /* SSLfatal() already called */
203 *hdatalen = TLS13_TBS_PREAMBLE_SIZE + hashlen;
208 retlen = retlen_l = BIO_get_mem_data(s->s3->handshake_buffer, hdata);
210 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_GET_CERT_VERIFY_TBS_DATA,
211 ERR_R_INTERNAL_ERROR);
220 int tls_construct_cert_verify(SSL *s, WPACKET *pkt)
222 EVP_PKEY *pkey = NULL;
223 const EVP_MD *md = NULL;
224 EVP_MD_CTX *mctx = NULL;
225 EVP_PKEY_CTX *pctx = NULL;
226 size_t hdatalen = 0, siglen = 0;
228 unsigned char *sig = NULL;
229 unsigned char tls13tbs[TLS13_TBS_PREAMBLE_SIZE + EVP_MAX_MD_SIZE];
230 const SIGALG_LOOKUP *lu = s->s3->tmp.sigalg;
232 if (lu == NULL || s->s3->tmp.cert == NULL) {
233 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
234 ERR_R_INTERNAL_ERROR);
237 pkey = s->s3->tmp.cert->privatekey;
239 if (pkey == NULL || !tls1_lookup_md(lu, &md)) {
240 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
241 ERR_R_INTERNAL_ERROR);
245 mctx = EVP_MD_CTX_new();
247 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
248 ERR_R_MALLOC_FAILURE);
252 /* Get the data to be signed */
253 if (!get_cert_verify_tbs_data(s, tls13tbs, &hdata, &hdatalen)) {
254 /* SSLfatal() already called */
258 if (SSL_USE_SIGALGS(s) && !WPACKET_put_bytes_u16(pkt, lu->sigalg)) {
259 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
260 ERR_R_INTERNAL_ERROR);
263 siglen = EVP_PKEY_size(pkey);
264 sig = OPENSSL_malloc(siglen);
266 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
267 ERR_R_MALLOC_FAILURE);
271 if (EVP_DigestSignInit(mctx, &pctx, md, NULL, pkey) <= 0) {
272 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
277 if (lu->sig == EVP_PKEY_RSA_PSS) {
278 if (EVP_PKEY_CTX_set_rsa_padding(pctx, RSA_PKCS1_PSS_PADDING) <= 0
279 || EVP_PKEY_CTX_set_rsa_pss_saltlen(pctx,
280 RSA_PSS_SALTLEN_DIGEST) <= 0) {
281 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
286 if (s->version == SSL3_VERSION) {
287 if (EVP_DigestSignUpdate(mctx, hdata, hdatalen) <= 0
288 || !EVP_MD_CTX_ctrl(mctx, EVP_CTRL_SSL3_MASTER_SECRET,
289 (int)s->session->master_key_length,
290 s->session->master_key)
291 || EVP_DigestSignFinal(mctx, sig, &siglen) <= 0) {
293 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
297 } else if (EVP_DigestSign(mctx, sig, &siglen, hdata, hdatalen) <= 0) {
298 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
303 #ifndef OPENSSL_NO_GOST
305 int pktype = lu->sig;
307 if (pktype == NID_id_GostR3410_2001
308 || pktype == NID_id_GostR3410_2012_256
309 || pktype == NID_id_GostR3410_2012_512)
310 BUF_reverse(sig, NULL, siglen);
314 if (!WPACKET_sub_memcpy_u16(pkt, sig, siglen)) {
315 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_CERT_VERIFY,
316 ERR_R_INTERNAL_ERROR);
320 /* Digest cached records and discard handshake buffer */
321 if (!ssl3_digest_cached_records(s, 0)) {
322 /* SSLfatal() already called */
327 EVP_MD_CTX_free(mctx);
331 EVP_MD_CTX_free(mctx);
335 MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt)
337 EVP_PKEY *pkey = NULL;
338 const unsigned char *data;
339 #ifndef OPENSSL_NO_GOST
340 unsigned char *gost_data = NULL;
342 MSG_PROCESS_RETURN ret = MSG_PROCESS_ERROR;
346 const EVP_MD *md = NULL;
349 unsigned char tls13tbs[TLS13_TBS_PREAMBLE_SIZE + EVP_MAX_MD_SIZE];
350 EVP_MD_CTX *mctx = EVP_MD_CTX_new();
351 EVP_PKEY_CTX *pctx = NULL;
354 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
355 ERR_R_MALLOC_FAILURE);
359 peer = s->session->peer;
360 pkey = X509_get0_pubkey(peer);
362 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
363 ERR_R_INTERNAL_ERROR);
367 if (ssl_cert_lookup_by_pkey(pkey, NULL) == NULL) {
368 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_TLS_PROCESS_CERT_VERIFY,
369 SSL_R_SIGNATURE_FOR_NON_SIGNING_CERTIFICATE);
373 if (SSL_USE_SIGALGS(s)) {
376 if (!PACKET_get_net_2(pkt, &sigalg)) {
377 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
381 if (tls12_check_peer_sigalg(s, sigalg, pkey) <= 0) {
382 /* SSLfatal() already called */
385 } else if (!tls1_set_peer_legacy_sigalg(s, pkey)) {
386 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
387 ERR_R_INTERNAL_ERROR);
391 if (!tls1_lookup_md(s->s3->tmp.peer_sigalg, &md)) {
392 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
393 ERR_R_INTERNAL_ERROR);
398 if (SSL_USE_SIGALGS(s))
399 fprintf(stderr, "USING TLSv1.2 HASH %s\n", EVP_MD_name(md));
402 /* Check for broken implementations of GOST ciphersuites */
404 * If key is GOST and len is exactly 64 or 128, it is signature without
405 * length field (CryptoPro implementations at least till TLS 1.2)
407 #ifndef OPENSSL_NO_GOST
408 if (!SSL_USE_SIGALGS(s)
409 && ((PACKET_remaining(pkt) == 64
410 && (EVP_PKEY_id(pkey) == NID_id_GostR3410_2001
411 || EVP_PKEY_id(pkey) == NID_id_GostR3410_2012_256))
412 || (PACKET_remaining(pkt) == 128
413 && EVP_PKEY_id(pkey) == NID_id_GostR3410_2012_512))) {
414 len = PACKET_remaining(pkt);
417 if (!PACKET_get_net_2(pkt, &len)) {
418 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
419 SSL_R_LENGTH_MISMATCH);
423 j = EVP_PKEY_size(pkey);
424 if (((int)len > j) || ((int)PACKET_remaining(pkt) > j)
425 || (PACKET_remaining(pkt) == 0)) {
426 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
427 SSL_R_WRONG_SIGNATURE_SIZE);
430 if (!PACKET_get_bytes(pkt, &data, len)) {
431 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
432 SSL_R_LENGTH_MISMATCH);
436 if (!get_cert_verify_tbs_data(s, tls13tbs, &hdata, &hdatalen)) {
437 /* SSLfatal() already called */
442 fprintf(stderr, "Using client verify alg %s\n", EVP_MD_name(md));
444 if (EVP_DigestVerifyInit(mctx, &pctx, md, NULL, pkey) <= 0) {
445 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
449 #ifndef OPENSSL_NO_GOST
451 int pktype = EVP_PKEY_id(pkey);
452 if (pktype == NID_id_GostR3410_2001
453 || pktype == NID_id_GostR3410_2012_256
454 || pktype == NID_id_GostR3410_2012_512) {
455 if ((gost_data = OPENSSL_malloc(len)) == NULL) {
456 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
457 SSL_F_TLS_PROCESS_CERT_VERIFY, ERR_R_MALLOC_FAILURE);
460 BUF_reverse(gost_data, data, len);
466 if (SSL_USE_PSS(s)) {
467 if (EVP_PKEY_CTX_set_rsa_padding(pctx, RSA_PKCS1_PSS_PADDING) <= 0
468 || EVP_PKEY_CTX_set_rsa_pss_saltlen(pctx,
469 RSA_PSS_SALTLEN_DIGEST) <= 0) {
470 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
475 if (s->version == SSL3_VERSION) {
476 if (EVP_DigestVerifyUpdate(mctx, hdata, hdatalen) <= 0
477 || !EVP_MD_CTX_ctrl(mctx, EVP_CTRL_SSL3_MASTER_SECRET,
478 (int)s->session->master_key_length,
479 s->session->master_key)) {
480 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
484 if (EVP_DigestVerifyFinal(mctx, data, len) <= 0) {
485 SSLfatal(s, SSL_AD_DECRYPT_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
486 SSL_R_BAD_SIGNATURE);
490 j = EVP_DigestVerify(mctx, data, len, hdata, hdatalen);
492 SSLfatal(s, SSL_AD_DECRYPT_ERROR, SSL_F_TLS_PROCESS_CERT_VERIFY,
493 SSL_R_BAD_SIGNATURE);
499 * In TLSv1.3 on the client side we make sure we prepare the client
500 * certificate after the CertVerify instead of when we get the
501 * CertificateRequest. This is because in TLSv1.3 the CertificateRequest
502 * comes *before* the Certificate message. In TLSv1.2 it comes after. We
503 * want to make sure that SSL_get_peer_certificate() will return the actual
504 * server certificate from the client_cert_cb callback.
506 if (!s->server && SSL_IS_TLS13(s) && s->s3->tmp.cert_req == 1)
507 ret = MSG_PROCESS_CONTINUE_PROCESSING;
509 ret = MSG_PROCESS_CONTINUE_READING;
511 BIO_free(s->s3->handshake_buffer);
512 s->s3->handshake_buffer = NULL;
513 EVP_MD_CTX_free(mctx);
514 #ifndef OPENSSL_NO_GOST
515 OPENSSL_free(gost_data);
520 int tls_construct_finished(SSL *s, WPACKET *pkt)
522 size_t finish_md_len;
526 /* This is a real handshake so make sure we clean it up at the end */
527 if (!s->server && s->post_handshake_auth != SSL_PHA_REQUESTED)
528 s->statem.cleanuphand = 1;
531 * We only change the keys if we didn't already do this when we sent the
536 && s->s3->tmp.cert_req == 0
537 && (!s->method->ssl3_enc->change_cipher_state(s,
538 SSL3_CC_HANDSHAKE | SSL3_CHANGE_CIPHER_CLIENT_WRITE))) {;
539 /* SSLfatal() already called */
544 sender = s->method->ssl3_enc->server_finished_label;
545 slen = s->method->ssl3_enc->server_finished_label_len;
547 sender = s->method->ssl3_enc->client_finished_label;
548 slen = s->method->ssl3_enc->client_finished_label_len;
551 finish_md_len = s->method->ssl3_enc->final_finish_mac(s,
553 s->s3->tmp.finish_md);
554 if (finish_md_len == 0) {
555 /* SSLfatal() already called */
559 s->s3->tmp.finish_md_len = finish_md_len;
561 if (!WPACKET_memcpy(pkt, s->s3->tmp.finish_md, finish_md_len)) {
562 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_FINISHED,
563 ERR_R_INTERNAL_ERROR);
568 * Log the master secret, if logging is enabled. We don't log it for
569 * TLSv1.3: there's a different key schedule for that.
571 if (!SSL_IS_TLS13(s) && !ssl_log_secret(s, MASTER_SECRET_LABEL,
572 s->session->master_key,
573 s->session->master_key_length)) {
574 /* SSLfatal() already called */
579 * Copy the finished so we can use it for renegotiation checks
581 if (!ossl_assert(finish_md_len <= EVP_MAX_MD_SIZE)) {
582 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_FINISHED,
583 ERR_R_INTERNAL_ERROR);
587 memcpy(s->s3->previous_client_finished, s->s3->tmp.finish_md,
589 s->s3->previous_client_finished_len = finish_md_len;
591 memcpy(s->s3->previous_server_finished, s->s3->tmp.finish_md,
593 s->s3->previous_server_finished_len = finish_md_len;
599 int tls_construct_key_update(SSL *s, WPACKET *pkt)
601 if (!WPACKET_put_bytes_u8(pkt, s->key_update)) {
602 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_KEY_UPDATE,
603 ERR_R_INTERNAL_ERROR);
607 s->key_update = SSL_KEY_UPDATE_NONE;
611 MSG_PROCESS_RETURN tls_process_key_update(SSL *s, PACKET *pkt)
613 unsigned int updatetype;
615 s->key_update_count++;
616 if (s->key_update_count > MAX_KEY_UPDATE_MESSAGES) {
617 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_TLS_PROCESS_KEY_UPDATE,
618 SSL_R_TOO_MANY_KEY_UPDATES);
619 return MSG_PROCESS_ERROR;
623 * A KeyUpdate message signals a key change so the end of the message must
624 * be on a record boundary.
626 if (RECORD_LAYER_processed_read_pending(&s->rlayer)) {
627 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_TLS_PROCESS_KEY_UPDATE,
628 SSL_R_NOT_ON_RECORD_BOUNDARY);
629 return MSG_PROCESS_ERROR;
632 if (!PACKET_get_1(pkt, &updatetype)
633 || PACKET_remaining(pkt) != 0) {
634 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_TLS_PROCESS_KEY_UPDATE,
635 SSL_R_BAD_KEY_UPDATE);
636 return MSG_PROCESS_ERROR;
640 * There are only two defined key update types. Fail if we get a value we
643 if (updatetype != SSL_KEY_UPDATE_NOT_REQUESTED
644 && updatetype != SSL_KEY_UPDATE_REQUESTED) {
645 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_TLS_PROCESS_KEY_UPDATE,
646 SSL_R_BAD_KEY_UPDATE);
647 return MSG_PROCESS_ERROR;
651 * If we get a request for us to update our sending keys too then, we need
652 * to additionally send a KeyUpdate message. However that message should
653 * not also request an update (otherwise we get into an infinite loop). We
654 * ignore a request for us to update our sending keys too if we already
657 if (updatetype == SSL_KEY_UPDATE_REQUESTED
658 && (s->shutdown & SSL_SENT_SHUTDOWN) == 0)
659 s->key_update = SSL_KEY_UPDATE_NOT_REQUESTED;
661 if (!tls13_update_key(s, 0)) {
662 /* SSLfatal() already called */
663 return MSG_PROCESS_ERROR;
666 return MSG_PROCESS_FINISHED_READING;
670 * ssl3_take_mac calculates the Finished MAC for the handshakes messages seen
673 int ssl3_take_mac(SSL *s)
679 sender = s->method->ssl3_enc->server_finished_label;
680 slen = s->method->ssl3_enc->server_finished_label_len;
682 sender = s->method->ssl3_enc->client_finished_label;
683 slen = s->method->ssl3_enc->client_finished_label_len;
686 s->s3->tmp.peer_finish_md_len =
687 s->method->ssl3_enc->final_finish_mac(s, sender, slen,
688 s->s3->tmp.peer_finish_md);
690 if (s->s3->tmp.peer_finish_md_len == 0) {
691 /* SSLfatal() already called */
698 MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt)
702 remain = PACKET_remaining(pkt);
704 * 'Change Cipher Spec' is just a single byte, which should already have
705 * been consumed by ssl_get_message() so there should be no bytes left,
706 * unless we're using DTLS1_BAD_VER, which has an extra 2 bytes
708 if (SSL_IS_DTLS(s)) {
709 if ((s->version == DTLS1_BAD_VER
710 && remain != DTLS1_CCS_HEADER_LENGTH + 1)
711 || (s->version != DTLS1_BAD_VER
712 && remain != DTLS1_CCS_HEADER_LENGTH - 1)) {
713 SSLfatal(s, SSL_AD_DECODE_ERROR,
714 SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC,
715 SSL_R_BAD_CHANGE_CIPHER_SPEC);
716 return MSG_PROCESS_ERROR;
720 SSLfatal(s, SSL_AD_DECODE_ERROR,
721 SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC,
722 SSL_R_BAD_CHANGE_CIPHER_SPEC);
723 return MSG_PROCESS_ERROR;
727 /* Check we have a cipher to change to */
728 if (s->s3->tmp.new_cipher == NULL) {
729 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE,
730 SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC, SSL_R_CCS_RECEIVED_EARLY);
731 return MSG_PROCESS_ERROR;
734 s->s3->change_cipher_spec = 1;
735 if (!ssl3_do_change_cipher_spec(s)) {
736 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC,
737 ERR_R_INTERNAL_ERROR);
738 return MSG_PROCESS_ERROR;
741 if (SSL_IS_DTLS(s)) {
742 dtls1_reset_seq_numbers(s, SSL3_CC_READ);
744 if (s->version == DTLS1_BAD_VER)
745 s->d1->handshake_read_seq++;
747 #ifndef OPENSSL_NO_SCTP
749 * Remember that a CCS has been received, so that an old key of
750 * SCTP-Auth can be deleted when a CCS is sent. Will be ignored if no
753 BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD, 1, NULL);
757 return MSG_PROCESS_CONTINUE_READING;
760 MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt)
765 /* This is a real handshake so make sure we clean it up at the end */
768 * To get this far we must have read encrypted data from the client. We
769 * no longer tolerate unencrypted alerts. This value is ignored if less
772 s->statem.enc_read_state = ENC_READ_STATE_VALID;
773 if (s->post_handshake_auth != SSL_PHA_REQUESTED)
774 s->statem.cleanuphand = 1;
775 if (SSL_IS_TLS13(s) && !tls13_save_handshake_digest_for_pha(s)) {
776 /* SSLfatal() already called */
777 return MSG_PROCESS_ERROR;
782 * In TLSv1.3 a Finished message signals a key change so the end of the
783 * message must be on a record boundary.
785 if (SSL_IS_TLS13(s) && RECORD_LAYER_processed_read_pending(&s->rlayer)) {
786 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_TLS_PROCESS_FINISHED,
787 SSL_R_NOT_ON_RECORD_BOUNDARY);
788 return MSG_PROCESS_ERROR;
791 /* If this occurs, we have missed a message */
792 if (!SSL_IS_TLS13(s) && !s->s3->change_cipher_spec) {
793 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE, SSL_F_TLS_PROCESS_FINISHED,
794 SSL_R_GOT_A_FIN_BEFORE_A_CCS);
795 return MSG_PROCESS_ERROR;
797 s->s3->change_cipher_spec = 0;
799 md_len = s->s3->tmp.peer_finish_md_len;
801 if (md_len != PACKET_remaining(pkt)) {
802 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_TLS_PROCESS_FINISHED,
803 SSL_R_BAD_DIGEST_LENGTH);
804 return MSG_PROCESS_ERROR;
807 if (CRYPTO_memcmp(PACKET_data(pkt), s->s3->tmp.peer_finish_md,
809 SSLfatal(s, SSL_AD_DECRYPT_ERROR, SSL_F_TLS_PROCESS_FINISHED,
810 SSL_R_DIGEST_CHECK_FAILED);
811 return MSG_PROCESS_ERROR;
815 * Copy the finished so we can use it for renegotiation checks
817 if (!ossl_assert(md_len <= EVP_MAX_MD_SIZE)) {
818 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PROCESS_FINISHED,
819 ERR_R_INTERNAL_ERROR);
820 return MSG_PROCESS_ERROR;
823 memcpy(s->s3->previous_client_finished, s->s3->tmp.peer_finish_md,
825 s->s3->previous_client_finished_len = md_len;
827 memcpy(s->s3->previous_server_finished, s->s3->tmp.peer_finish_md,
829 s->s3->previous_server_finished_len = md_len;
833 * In TLS1.3 we also have to change cipher state and do any final processing
834 * of the initial server flight (if we are a client)
836 if (SSL_IS_TLS13(s)) {
838 if (s->post_handshake_auth != SSL_PHA_REQUESTED &&
839 !s->method->ssl3_enc->change_cipher_state(s,
840 SSL3_CC_APPLICATION | SSL3_CHANGE_CIPHER_SERVER_READ)) {
841 /* SSLfatal() already called */
842 return MSG_PROCESS_ERROR;
845 if (!s->method->ssl3_enc->generate_master_secret(s,
846 s->master_secret, s->handshake_secret, 0,
847 &s->session->master_key_length)) {
848 /* SSLfatal() already called */
849 return MSG_PROCESS_ERROR;
851 if (!s->method->ssl3_enc->change_cipher_state(s,
852 SSL3_CC_APPLICATION | SSL3_CHANGE_CIPHER_CLIENT_READ)) {
853 /* SSLfatal() already called */
854 return MSG_PROCESS_ERROR;
856 if (!tls_process_initial_server_flight(s)) {
857 /* SSLfatal() already called */
858 return MSG_PROCESS_ERROR;
863 return MSG_PROCESS_FINISHED_READING;
866 int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt)
868 if (!WPACKET_put_bytes_u8(pkt, SSL3_MT_CCS)) {
869 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
870 SSL_F_TLS_CONSTRUCT_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
877 /* Add a certificate to the WPACKET */
878 static int ssl_add_cert_to_wpacket(SSL *s, WPACKET *pkt, X509 *x, int chain)
881 unsigned char *outbytes;
883 len = i2d_X509(x, NULL);
885 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_ADD_CERT_TO_WPACKET,
889 if (!WPACKET_sub_allocate_bytes_u24(pkt, len, &outbytes)
890 || i2d_X509(x, &outbytes) != len) {
891 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_ADD_CERT_TO_WPACKET,
892 ERR_R_INTERNAL_ERROR);
897 && !tls_construct_extensions(s, pkt, SSL_EXT_TLS1_3_CERTIFICATE, x,
899 /* SSLfatal() already called */
906 /* Add certificate chain to provided WPACKET */
907 static int ssl_add_cert_chain(SSL *s, WPACKET *pkt, CERT_PKEY *cpk)
911 STACK_OF(X509) *extra_certs;
912 STACK_OF(X509) *chain = NULL;
913 X509_STORE *chain_store;
915 if (cpk == NULL || cpk->x509 == NULL)
921 * If we have a certificate specific chain use it, else use parent ctx.
923 if (cpk->chain != NULL)
924 extra_certs = cpk->chain;
926 extra_certs = s->ctx->extra_certs;
928 if ((s->mode & SSL_MODE_NO_AUTO_CHAIN) || extra_certs)
930 else if (s->cert->chain_store)
931 chain_store = s->cert->chain_store;
933 chain_store = s->ctx->cert_store;
935 if (chain_store != NULL) {
936 X509_STORE_CTX *xs_ctx = X509_STORE_CTX_new();
938 if (xs_ctx == NULL) {
939 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_ADD_CERT_CHAIN,
940 ERR_R_MALLOC_FAILURE);
943 if (!X509_STORE_CTX_init(xs_ctx, chain_store, x, NULL)) {
944 X509_STORE_CTX_free(xs_ctx);
945 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_ADD_CERT_CHAIN,
950 * It is valid for the chain not to be complete (because normally we
951 * don't include the root cert in the chain). Therefore we deliberately
952 * ignore the error return from this call. We're not actually verifying
953 * the cert - we're just building as much of the chain as we can
955 (void)X509_verify_cert(xs_ctx);
956 /* Don't leave errors in the queue */
958 chain = X509_STORE_CTX_get0_chain(xs_ctx);
959 i = ssl_security_cert_chain(s, chain, NULL, 0);
962 /* Dummy error calls so mkerr generates them */
963 SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, SSL_R_EE_KEY_TOO_SMALL);
964 SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, SSL_R_CA_KEY_TOO_SMALL);
965 SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, SSL_R_CA_MD_TOO_WEAK);
967 X509_STORE_CTX_free(xs_ctx);
968 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_ADD_CERT_CHAIN, i);
971 chain_count = sk_X509_num(chain);
972 for (i = 0; i < chain_count; i++) {
973 x = sk_X509_value(chain, i);
975 if (!ssl_add_cert_to_wpacket(s, pkt, x, i)) {
976 /* SSLfatal() already called */
977 X509_STORE_CTX_free(xs_ctx);
981 X509_STORE_CTX_free(xs_ctx);
983 i = ssl_security_cert_chain(s, extra_certs, x, 0);
985 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL_ADD_CERT_CHAIN, i);
988 if (!ssl_add_cert_to_wpacket(s, pkt, x, 0)) {
989 /* SSLfatal() already called */
992 for (i = 0; i < sk_X509_num(extra_certs); i++) {
993 x = sk_X509_value(extra_certs, i);
994 if (!ssl_add_cert_to_wpacket(s, pkt, x, i + 1)) {
995 /* SSLfatal() already called */
1003 unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt, CERT_PKEY *cpk)
1005 if (!WPACKET_start_sub_packet_u24(pkt)) {
1006 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_OUTPUT_CERT_CHAIN,
1007 ERR_R_INTERNAL_ERROR);
1011 if (!ssl_add_cert_chain(s, pkt, cpk))
1014 if (!WPACKET_close(pkt)) {
1015 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_SSL3_OUTPUT_CERT_CHAIN,
1016 ERR_R_INTERNAL_ERROR);
1024 * Tidy up after the end of a handshake. In the case of SCTP this may result
1025 * in NBIO events. If |clearbufs| is set then init_buf and the wbio buffer is
1028 WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs, int stop)
1030 void (*cb) (const SSL *ssl, int type, int val) = NULL;
1033 if (!SSL_IS_DTLS(s)) {
1035 * We don't do this in DTLS because we may still need the init_buf
1036 * in case there are any unexpected retransmits
1038 BUF_MEM_free(s->init_buf);
1041 if (!ssl_free_wbio_buffer(s)) {
1042 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_FINISH_HANDSHAKE,
1043 ERR_R_INTERNAL_ERROR);
1049 if (SSL_IS_TLS13(s) && !s->server
1050 && s->post_handshake_auth == SSL_PHA_REQUESTED)
1051 s->post_handshake_auth = SSL_PHA_EXT_SENT;
1054 * Only set if there was a Finished message and this isn't after a TLSv1.3
1055 * post handshake exchange
1057 if (s->statem.cleanuphand) {
1058 /* skipped if we just sent a HelloRequest */
1061 s->statem.cleanuphand = 0;
1062 s->ext.ticket_expected = 0;
1064 ssl3_cleanup_key_block(s);
1068 * In TLSv1.3 we update the cache as part of constructing the
1071 if (!SSL_IS_TLS13(s))
1072 ssl_update_cache(s, SSL_SESS_CACHE_SERVER);
1074 /* N.B. s->ctx may not equal s->session_ctx */
1075 tsan_counter(&s->ctx->stats.sess_accept_good);
1076 s->handshake_func = ossl_statem_accept;
1078 if (SSL_IS_DTLS(s) && !s->hit) {
1080 * We are finishing after the client. We start the timer going
1081 * in case there are any retransmits of our final flight
1084 dtls1_start_timer(s);
1087 if (SSL_IS_TLS13(s)) {
1089 * We encourage applications to only use TLSv1.3 tickets once,
1090 * so we remove this one from the cache.
1092 if ((s->session_ctx->session_cache_mode
1093 & SSL_SESS_CACHE_CLIENT) != 0)
1094 SSL_CTX_remove_session(s->session_ctx, s->session);
1097 * In TLSv1.3 we update the cache as part of processing the
1100 ssl_update_cache(s, SSL_SESS_CACHE_CLIENT);
1103 tsan_counter(&s->session_ctx->stats.sess_hit);
1105 s->handshake_func = ossl_statem_connect;
1106 tsan_counter(&s->session_ctx->stats.sess_connect_good);
1108 if (SSL_IS_DTLS(s) && s->hit) {
1110 * We are finishing after the server. We start the timer going
1111 * in case there are any retransmits of our final flight
1114 dtls1_start_timer(s);
1118 if (SSL_IS_DTLS(s)) {
1119 /* done with handshaking */
1120 s->d1->handshake_read_seq = 0;
1121 s->d1->handshake_write_seq = 0;
1122 s->d1->next_handshake_write_seq = 0;
1123 dtls1_clear_received_buffer(s);
1127 if (s->info_callback != NULL)
1128 cb = s->info_callback;
1129 else if (s->ctx->info_callback != NULL)
1130 cb = s->ctx->info_callback;
1132 /* The callback may expect us to not be in init at handshake done */
1133 ossl_statem_set_in_init(s, 0);
1136 cb(s, SSL_CB_HANDSHAKE_DONE, 1);
1139 /* If we've got more work to do we go back into init */
1140 ossl_statem_set_in_init(s, 1);
1141 return WORK_FINISHED_CONTINUE;
1144 return WORK_FINISHED_STOP;
1147 int tls_get_message_header(SSL *s, int *mt)
1149 /* s->init_num < SSL3_HM_HEADER_LENGTH */
1150 int skip_message, i, recvd_type;
1152 size_t l, readbytes;
1154 p = (unsigned char *)s->init_buf->data;
1157 while (s->init_num < SSL3_HM_HEADER_LENGTH) {
1158 i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type,
1160 SSL3_HM_HEADER_LENGTH - s->init_num,
1163 s->rwstate = SSL_READING;
1166 if (recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
1168 * A ChangeCipherSpec must be a single byte and may not occur
1169 * in the middle of a handshake message.
1171 if (s->init_num != 0 || readbytes != 1 || p[0] != SSL3_MT_CCS) {
1172 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE,
1173 SSL_F_TLS_GET_MESSAGE_HEADER,
1174 SSL_R_BAD_CHANGE_CIPHER_SPEC);
1177 if (s->statem.hand_state == TLS_ST_BEFORE
1178 && (s->s3->flags & TLS1_FLAGS_STATELESS) != 0) {
1180 * We are stateless and we received a CCS. Probably this is
1181 * from a client between the first and second ClientHellos.
1182 * We should ignore this, but return an error because we do
1183 * not return success until we see the second ClientHello
1184 * with a valid cookie.
1188 s->s3->tmp.message_type = *mt = SSL3_MT_CHANGE_CIPHER_SPEC;
1189 s->init_num = readbytes - 1;
1190 s->init_msg = s->init_buf->data;
1191 s->s3->tmp.message_size = readbytes;
1193 } else if (recvd_type != SSL3_RT_HANDSHAKE) {
1194 SSLfatal(s, SSL_AD_UNEXPECTED_MESSAGE,
1195 SSL_F_TLS_GET_MESSAGE_HEADER,
1196 SSL_R_CCS_RECEIVED_EARLY);
1199 s->init_num += readbytes;
1204 if (s->statem.hand_state != TLS_ST_OK
1205 && p[0] == SSL3_MT_HELLO_REQUEST)
1207 * The server may always send 'Hello Request' messages --
1208 * we are doing a handshake anyway now, so ignore them if
1209 * their format is correct. Does not count for 'Finished'
1212 if (p[1] == 0 && p[2] == 0 && p[3] == 0) {
1216 if (s->msg_callback)
1217 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
1218 p, SSL3_HM_HEADER_LENGTH, s,
1219 s->msg_callback_arg);
1221 } while (skip_message);
1222 /* s->init_num == SSL3_HM_HEADER_LENGTH */
1225 s->s3->tmp.message_type = *(p++);
1227 if (RECORD_LAYER_is_sslv2_record(&s->rlayer)) {
1229 * Only happens with SSLv3+ in an SSLv2 backward compatible
1232 * Total message size is the remaining record bytes to read
1233 * plus the SSL3_HM_HEADER_LENGTH bytes that we already read
1235 l = RECORD_LAYER_get_rrec_length(&s->rlayer)
1236 + SSL3_HM_HEADER_LENGTH;
1237 s->s3->tmp.message_size = l;
1239 s->init_msg = s->init_buf->data;
1240 s->init_num = SSL3_HM_HEADER_LENGTH;
1243 /* BUF_MEM_grow takes an 'int' parameter */
1244 if (l > (INT_MAX - SSL3_HM_HEADER_LENGTH)) {
1245 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_TLS_GET_MESSAGE_HEADER,
1246 SSL_R_EXCESSIVE_MESSAGE_SIZE);
1249 s->s3->tmp.message_size = l;
1251 s->init_msg = s->init_buf->data + SSL3_HM_HEADER_LENGTH;
1258 int tls_get_message_body(SSL *s, size_t *len)
1260 size_t n, readbytes;
1264 if (s->s3->tmp.message_type == SSL3_MT_CHANGE_CIPHER_SPEC) {
1265 /* We've already read everything in */
1266 *len = (unsigned long)s->init_num;
1271 n = s->s3->tmp.message_size - s->init_num;
1273 i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
1274 &p[s->init_num], n, 0, &readbytes);
1276 s->rwstate = SSL_READING;
1280 s->init_num += readbytes;
1285 * If receiving Finished, record MAC of prior handshake messages for
1286 * Finished verification.
1288 if (*(s->init_buf->data) == SSL3_MT_FINISHED && !ssl3_take_mac(s)) {
1289 /* SSLfatal() already called */
1294 /* Feed this message into MAC computation. */
1295 if (RECORD_LAYER_is_sslv2_record(&s->rlayer)) {
1296 if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
1298 /* SSLfatal() already called */
1302 if (s->msg_callback)
1303 s->msg_callback(0, SSL2_VERSION, 0, s->init_buf->data,
1304 (size_t)s->init_num, s, s->msg_callback_arg);
1307 * We defer feeding in the HRR until later. We'll do it as part of
1308 * processing the message
1309 * The TLsv1.3 handshake transcript stops at the ClientFinished
1312 #define SERVER_HELLO_RANDOM_OFFSET (SSL3_HM_HEADER_LENGTH + 2)
1313 /* KeyUpdate and NewSessionTicket do not need to be added */
1314 if (!SSL_IS_TLS13(s) || (s->s3->tmp.message_type != SSL3_MT_NEWSESSION_TICKET
1315 && s->s3->tmp.message_type != SSL3_MT_KEY_UPDATE)) {
1316 if (s->s3->tmp.message_type != SSL3_MT_SERVER_HELLO
1317 || s->init_num < SERVER_HELLO_RANDOM_OFFSET + SSL3_RANDOM_SIZE
1318 || memcmp(hrrrandom,
1319 s->init_buf->data + SERVER_HELLO_RANDOM_OFFSET,
1320 SSL3_RANDOM_SIZE) != 0) {
1321 if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
1322 s->init_num + SSL3_HM_HEADER_LENGTH)) {
1323 /* SSLfatal() already called */
1329 if (s->msg_callback)
1330 s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE, s->init_buf->data,
1331 (size_t)s->init_num + SSL3_HM_HEADER_LENGTH, s,
1332 s->msg_callback_arg);
1339 static const X509ERR2ALERT x509table[] = {
1340 {X509_V_ERR_APPLICATION_VERIFICATION, SSL_AD_HANDSHAKE_FAILURE},
1341 {X509_V_ERR_CA_KEY_TOO_SMALL, SSL_AD_BAD_CERTIFICATE},
1342 {X509_V_ERR_CA_MD_TOO_WEAK, SSL_AD_BAD_CERTIFICATE},
1343 {X509_V_ERR_CERT_CHAIN_TOO_LONG, SSL_AD_UNKNOWN_CA},
1344 {X509_V_ERR_CERT_HAS_EXPIRED, SSL_AD_CERTIFICATE_EXPIRED},
1345 {X509_V_ERR_CERT_NOT_YET_VALID, SSL_AD_BAD_CERTIFICATE},
1346 {X509_V_ERR_CERT_REJECTED, SSL_AD_BAD_CERTIFICATE},
1347 {X509_V_ERR_CERT_REVOKED, SSL_AD_CERTIFICATE_REVOKED},
1348 {X509_V_ERR_CERT_SIGNATURE_FAILURE, SSL_AD_DECRYPT_ERROR},
1349 {X509_V_ERR_CERT_UNTRUSTED, SSL_AD_BAD_CERTIFICATE},
1350 {X509_V_ERR_CRL_HAS_EXPIRED, SSL_AD_CERTIFICATE_EXPIRED},
1351 {X509_V_ERR_CRL_NOT_YET_VALID, SSL_AD_BAD_CERTIFICATE},
1352 {X509_V_ERR_CRL_SIGNATURE_FAILURE, SSL_AD_DECRYPT_ERROR},
1353 {X509_V_ERR_DANE_NO_MATCH, SSL_AD_BAD_CERTIFICATE},
1354 {X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT, SSL_AD_UNKNOWN_CA},
1355 {X509_V_ERR_EE_KEY_TOO_SMALL, SSL_AD_BAD_CERTIFICATE},
1356 {X509_V_ERR_EMAIL_MISMATCH, SSL_AD_BAD_CERTIFICATE},
1357 {X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD, SSL_AD_BAD_CERTIFICATE},
1358 {X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD, SSL_AD_BAD_CERTIFICATE},
1359 {X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD, SSL_AD_BAD_CERTIFICATE},
1360 {X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD, SSL_AD_BAD_CERTIFICATE},
1361 {X509_V_ERR_HOSTNAME_MISMATCH, SSL_AD_BAD_CERTIFICATE},
1362 {X509_V_ERR_INVALID_CA, SSL_AD_UNKNOWN_CA},
1363 {X509_V_ERR_INVALID_CALL, SSL_AD_INTERNAL_ERROR},
1364 {X509_V_ERR_INVALID_PURPOSE, SSL_AD_UNSUPPORTED_CERTIFICATE},
1365 {X509_V_ERR_IP_ADDRESS_MISMATCH, SSL_AD_BAD_CERTIFICATE},
1366 {X509_V_ERR_OUT_OF_MEM, SSL_AD_INTERNAL_ERROR},
1367 {X509_V_ERR_PATH_LENGTH_EXCEEDED, SSL_AD_UNKNOWN_CA},
1368 {X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN, SSL_AD_UNKNOWN_CA},
1369 {X509_V_ERR_STORE_LOOKUP, SSL_AD_INTERNAL_ERROR},
1370 {X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY, SSL_AD_BAD_CERTIFICATE},
1371 {X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE, SSL_AD_BAD_CERTIFICATE},
1372 {X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE, SSL_AD_BAD_CERTIFICATE},
1373 {X509_V_ERR_UNABLE_TO_GET_CRL, SSL_AD_UNKNOWN_CA},
1374 {X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER, SSL_AD_UNKNOWN_CA},
1375 {X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT, SSL_AD_UNKNOWN_CA},
1376 {X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY, SSL_AD_UNKNOWN_CA},
1377 {X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE, SSL_AD_UNKNOWN_CA},
1378 {X509_V_ERR_UNSPECIFIED, SSL_AD_INTERNAL_ERROR},
1380 /* Last entry; return this if we don't find the value above. */
1381 {X509_V_OK, SSL_AD_CERTIFICATE_UNKNOWN}
1384 int ssl_x509err2alert(int x509err)
1386 const X509ERR2ALERT *tp;
1388 for (tp = x509table; tp->x509err != X509_V_OK; ++tp)
1389 if (tp->x509err == x509err)
1394 int ssl_allow_compression(SSL *s)
1396 if (s->options & SSL_OP_NO_COMPRESSION)
1398 return ssl_security(s, SSL_SECOP_COMPRESSION, 0, 0, NULL);
1401 static int version_cmp(const SSL *s, int a, int b)
1403 int dtls = SSL_IS_DTLS(s);
1408 return a < b ? -1 : 1;
1409 return DTLS_VERSION_LT(a, b) ? -1 : 1;
1414 const SSL_METHOD *(*cmeth) (void);
1415 const SSL_METHOD *(*smeth) (void);
1418 #if TLS_MAX_VERSION != TLS1_3_VERSION
1419 # error Code needs update for TLS_method() support beyond TLS1_3_VERSION.
1422 /* Must be in order high to low */
1423 static const version_info tls_version_table[] = {
1424 #ifndef OPENSSL_NO_TLS1_3
1425 {TLS1_3_VERSION, tlsv1_3_client_method, tlsv1_3_server_method},
1427 {TLS1_3_VERSION, NULL, NULL},
1429 #ifndef OPENSSL_NO_TLS1_2
1430 {TLS1_2_VERSION, tlsv1_2_client_method, tlsv1_2_server_method},
1432 {TLS1_2_VERSION, NULL, NULL},
1434 #ifndef OPENSSL_NO_TLS1_1
1435 {TLS1_1_VERSION, tlsv1_1_client_method, tlsv1_1_server_method},
1437 {TLS1_1_VERSION, NULL, NULL},
1439 #ifndef OPENSSL_NO_TLS1
1440 {TLS1_VERSION, tlsv1_client_method, tlsv1_server_method},
1442 {TLS1_VERSION, NULL, NULL},
1444 #ifndef OPENSSL_NO_SSL3
1445 {SSL3_VERSION, sslv3_client_method, sslv3_server_method},
1447 {SSL3_VERSION, NULL, NULL},
1452 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
1453 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
1456 /* Must be in order high to low */
1457 static const version_info dtls_version_table[] = {
1458 #ifndef OPENSSL_NO_DTLS1_2
1459 {DTLS1_2_VERSION, dtlsv1_2_client_method, dtlsv1_2_server_method},
1461 {DTLS1_2_VERSION, NULL, NULL},
1463 #ifndef OPENSSL_NO_DTLS1
1464 {DTLS1_VERSION, dtlsv1_client_method, dtlsv1_server_method},
1465 {DTLS1_BAD_VER, dtls_bad_ver_client_method, NULL},
1467 {DTLS1_VERSION, NULL, NULL},
1468 {DTLS1_BAD_VER, NULL, NULL},
1474 * ssl_method_error - Check whether an SSL_METHOD is enabled.
1476 * @s: The SSL handle for the candidate method
1477 * @method: the intended method.
1479 * Returns 0 on success, or an SSL error reason on failure.
1481 static int ssl_method_error(const SSL *s, const SSL_METHOD *method)
1483 int version = method->version;
1485 if ((s->min_proto_version != 0 &&
1486 version_cmp(s, version, s->min_proto_version) < 0) ||
1487 ssl_security(s, SSL_SECOP_VERSION, 0, version, NULL) == 0)
1488 return SSL_R_VERSION_TOO_LOW;
1490 if (s->max_proto_version != 0 &&
1491 version_cmp(s, version, s->max_proto_version) > 0)
1492 return SSL_R_VERSION_TOO_HIGH;
1494 if ((s->options & method->mask) != 0)
1495 return SSL_R_UNSUPPORTED_PROTOCOL;
1496 if ((method->flags & SSL_METHOD_NO_SUITEB) != 0 && tls1_suiteb(s))
1497 return SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE;
1503 * Only called by servers. Returns 1 if the server has a TLSv1.3 capable
1504 * certificate type, or has PSK or a certificate callback configured. Otherwise
1507 static int is_tls13_capable(const SSL *s)
1512 #ifndef OPENSSL_NO_PSK
1513 if (s->psk_server_callback != NULL)
1517 if (s->psk_find_session_cb != NULL || s->cert->cert_cb != NULL)
1520 for (i = 0; i < SSL_PKEY_NUM; i++) {
1521 /* Skip over certs disallowed for TLSv1.3 */
1523 case SSL_PKEY_DSA_SIGN:
1524 case SSL_PKEY_GOST01:
1525 case SSL_PKEY_GOST12_256:
1526 case SSL_PKEY_GOST12_512:
1531 if (!ssl_has_cert(s, i))
1533 if (i != SSL_PKEY_ECC)
1536 * Prior to TLSv1.3 sig algs allowed any curve to be used. TLSv1.3 is
1537 * more restrictive so check that our sig algs are consistent with this
1538 * EC cert. See section 4.2.3 of RFC8446.
1540 eckey = EVP_PKEY_get0_EC_KEY(s->cert->pkeys[SSL_PKEY_ECC].privatekey);
1543 curve = EC_GROUP_get_curve_name(EC_KEY_get0_group(eckey));
1544 if (tls_check_sigalg_curve(s, curve))
1552 * ssl_version_supported - Check that the specified `version` is supported by
1555 * @s: The SSL handle for the candidate method
1556 * @version: Protocol version to test against
1558 * Returns 1 when supported, otherwise 0
1560 int ssl_version_supported(const SSL *s, int version, const SSL_METHOD **meth)
1562 const version_info *vent;
1563 const version_info *table;
1565 switch (s->method->version) {
1567 /* Version should match method version for non-ANY method */
1568 return version_cmp(s, version, s->version) == 0;
1569 case TLS_ANY_VERSION:
1570 table = tls_version_table;
1572 case DTLS_ANY_VERSION:
1573 table = dtls_version_table;
1578 vent->version != 0 && version_cmp(s, version, vent->version) <= 0;
1580 if (vent->cmeth != NULL
1581 && version_cmp(s, version, vent->version) == 0
1582 && ssl_method_error(s, vent->cmeth()) == 0
1584 || version != TLS1_3_VERSION
1585 || is_tls13_capable(s))) {
1587 *meth = vent->cmeth();
1595 * ssl_check_version_downgrade - In response to RFC7507 SCSV version
1596 * fallback indication from a client check whether we're using the highest
1597 * supported protocol version.
1599 * @s server SSL handle.
1601 * Returns 1 when using the highest enabled version, 0 otherwise.
1603 int ssl_check_version_downgrade(SSL *s)
1605 const version_info *vent;
1606 const version_info *table;
1609 * Check that the current protocol is the highest enabled version
1610 * (according to s->ctx->method, as version negotiation may have changed
1613 if (s->version == s->ctx->method->version)
1617 * Apparently we're using a version-flexible SSL_METHOD (not at its
1618 * highest protocol version).
1620 if (s->ctx->method->version == TLS_method()->version)
1621 table = tls_version_table;
1622 else if (s->ctx->method->version == DTLS_method()->version)
1623 table = dtls_version_table;
1625 /* Unexpected state; fail closed. */
1629 for (vent = table; vent->version != 0; ++vent) {
1630 if (vent->smeth != NULL && ssl_method_error(s, vent->smeth()) == 0)
1631 return s->version == vent->version;
1637 * ssl_set_version_bound - set an upper or lower bound on the supported (D)TLS
1638 * protocols, provided the initial (D)TLS method is version-flexible. This
1639 * function sanity-checks the proposed value and makes sure the method is
1640 * version-flexible, then sets the limit if all is well.
1642 * @method_version: The version of the current SSL_METHOD.
1643 * @version: the intended limit.
1644 * @bound: pointer to limit to be updated.
1646 * Returns 1 on success, 0 on failure.
1648 int ssl_set_version_bound(int method_version, int version, int *bound)
1656 * Restrict TLS methods to TLS protocol versions.
1657 * Restrict DTLS methods to DTLS protocol versions.
1658 * Note, DTLS version numbers are decreasing, use comparison macros.
1660 * Note that for both lower-bounds we use explicit versions, not
1661 * (D)TLS_MIN_VERSION. This is because we don't want to break user
1662 * configurations. If the MIN (supported) version ever rises, the user's
1663 * "floor" remains valid even if no longer available. We don't expect the
1664 * MAX ceiling to ever get lower, so making that variable makes sense.
1666 switch (method_version) {
1669 * XXX For fixed version methods, should we always fail and not set any
1670 * bounds, always succeed and not set any bounds, or set the bounds and
1671 * arrange to fail later if they are not met? At present fixed-version
1672 * methods are not subject to controls that disable individual protocol
1677 case TLS_ANY_VERSION:
1678 if (version < SSL3_VERSION || version > TLS_MAX_VERSION)
1682 case DTLS_ANY_VERSION:
1683 if (DTLS_VERSION_GT(version, DTLS_MAX_VERSION) ||
1684 DTLS_VERSION_LT(version, DTLS1_BAD_VER))
1693 static void check_for_downgrade(SSL *s, int vers, DOWNGRADE *dgrd)
1695 if (vers == TLS1_2_VERSION
1696 && ssl_version_supported(s, TLS1_3_VERSION, NULL)) {
1697 *dgrd = DOWNGRADE_TO_1_2;
1698 } else if (!SSL_IS_DTLS(s)
1699 && vers < TLS1_2_VERSION
1701 * We need to ensure that a server that disables TLSv1.2
1702 * (creating a hole between TLSv1.3 and TLSv1.1) can still
1703 * complete handshakes with clients that support TLSv1.2 and
1704 * below. Therefore we do not enable the sentinel if TLSv1.3 is
1705 * enabled and TLSv1.2 is not.
1707 && ssl_version_supported(s, TLS1_2_VERSION, NULL)) {
1708 *dgrd = DOWNGRADE_TO_1_1;
1710 *dgrd = DOWNGRADE_NONE;
1715 * ssl_choose_server_version - Choose server (D)TLS version. Called when the
1716 * client HELLO is received to select the final server protocol version and
1717 * the version specific method.
1719 * @s: server SSL handle.
1721 * Returns 0 on success or an SSL error reason number on failure.
1723 int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello, DOWNGRADE *dgrd)
1726 * With version-flexible methods we have an initial state with:
1728 * s->method->version == (D)TLS_ANY_VERSION,
1729 * s->version == (D)TLS_MAX_VERSION.
1731 * So we detect version-flexible methods via the method version, not the
1734 int server_version = s->method->version;
1735 int client_version = hello->legacy_version;
1736 const version_info *vent;
1737 const version_info *table;
1739 RAW_EXTENSION *suppversions;
1741 s->client_version = client_version;
1743 switch (server_version) {
1745 if (!SSL_IS_TLS13(s)) {
1746 if (version_cmp(s, client_version, s->version) < 0)
1747 return SSL_R_WRONG_SSL_VERSION;
1748 *dgrd = DOWNGRADE_NONE;
1750 * If this SSL handle is not from a version flexible method we don't
1751 * (and never did) check min/max FIPS or Suite B constraints. Hope
1752 * that's OK. It is up to the caller to not choose fixed protocol
1753 * versions they don't want. If not, then easy to fix, just return
1754 * ssl_method_error(s, s->method)
1759 * Fall through if we are TLSv1.3 already (this means we must be after
1760 * a HelloRetryRequest
1763 case TLS_ANY_VERSION:
1764 table = tls_version_table;
1766 case DTLS_ANY_VERSION:
1767 table = dtls_version_table;
1771 suppversions = &hello->pre_proc_exts[TLSEXT_IDX_supported_versions];
1773 /* If we did an HRR then supported versions is mandatory */
1774 if (!suppversions->present && s->hello_retry_request != SSL_HRR_NONE)
1775 return SSL_R_UNSUPPORTED_PROTOCOL;
1777 if (suppversions->present && !SSL_IS_DTLS(s)) {
1778 unsigned int candidate_vers = 0;
1779 unsigned int best_vers = 0;
1780 const SSL_METHOD *best_method = NULL;
1781 PACKET versionslist;
1783 suppversions->parsed = 1;
1785 if (!PACKET_as_length_prefixed_1(&suppversions->data, &versionslist)) {
1786 /* Trailing or invalid data? */
1787 return SSL_R_LENGTH_MISMATCH;
1791 * The TLSv1.3 spec says the client MUST set this to TLS1_2_VERSION.
1792 * The spec only requires servers to check that it isn't SSLv3:
1793 * "Any endpoint receiving a Hello message with
1794 * ClientHello.legacy_version or ServerHello.legacy_version set to
1795 * 0x0300 MUST abort the handshake with a "protocol_version" alert."
1796 * We are slightly stricter and require that it isn't SSLv3 or lower.
1797 * We tolerate TLSv1 and TLSv1.1.
1799 if (client_version <= SSL3_VERSION)
1800 return SSL_R_BAD_LEGACY_VERSION;
1802 while (PACKET_get_net_2(&versionslist, &candidate_vers)) {
1803 if (version_cmp(s, candidate_vers, best_vers) <= 0)
1805 if (ssl_version_supported(s, candidate_vers, &best_method))
1806 best_vers = candidate_vers;
1808 if (PACKET_remaining(&versionslist) != 0) {
1809 /* Trailing data? */
1810 return SSL_R_LENGTH_MISMATCH;
1813 if (best_vers > 0) {
1814 if (s->hello_retry_request != SSL_HRR_NONE) {
1816 * This is after a HelloRetryRequest so we better check that we
1817 * negotiated TLSv1.3
1819 if (best_vers != TLS1_3_VERSION)
1820 return SSL_R_UNSUPPORTED_PROTOCOL;
1823 check_for_downgrade(s, best_vers, dgrd);
1824 s->version = best_vers;
1825 s->method = best_method;
1828 return SSL_R_UNSUPPORTED_PROTOCOL;
1832 * If the supported versions extension isn't present, then the highest
1833 * version we can negotiate is TLSv1.2
1835 if (version_cmp(s, client_version, TLS1_3_VERSION) >= 0)
1836 client_version = TLS1_2_VERSION;
1839 * No supported versions extension, so we just use the version supplied in
1842 for (vent = table; vent->version != 0; ++vent) {
1843 const SSL_METHOD *method;
1845 if (vent->smeth == NULL ||
1846 version_cmp(s, client_version, vent->version) < 0)
1848 method = vent->smeth();
1849 if (ssl_method_error(s, method) == 0) {
1850 check_for_downgrade(s, vent->version, dgrd);
1851 s->version = vent->version;
1857 return disabled ? SSL_R_UNSUPPORTED_PROTOCOL : SSL_R_VERSION_TOO_LOW;
1861 * ssl_choose_client_version - Choose client (D)TLS version. Called when the
1862 * server HELLO is received to select the final client protocol version and
1863 * the version specific method.
1865 * @s: client SSL handle.
1866 * @version: The proposed version from the server's HELLO.
1867 * @extensions: The extensions received
1869 * Returns 1 on success or 0 on error.
1871 int ssl_choose_client_version(SSL *s, int version, RAW_EXTENSION *extensions)
1873 const version_info *vent;
1874 const version_info *table;
1875 int ret, ver_min, ver_max, real_max, origv;
1878 s->version = version;
1880 /* This will overwrite s->version if the extension is present */
1881 if (!tls_parse_extension(s, TLSEXT_IDX_supported_versions,
1882 SSL_EXT_TLS1_2_SERVER_HELLO
1883 | SSL_EXT_TLS1_3_SERVER_HELLO, extensions,
1889 if (s->hello_retry_request != SSL_HRR_NONE
1890 && s->version != TLS1_3_VERSION) {
1892 SSLfatal(s, SSL_AD_PROTOCOL_VERSION, SSL_F_SSL_CHOOSE_CLIENT_VERSION,
1893 SSL_R_WRONG_SSL_VERSION);
1897 switch (s->method->version) {
1899 if (s->version != s->method->version) {
1901 SSLfatal(s, SSL_AD_PROTOCOL_VERSION,
1902 SSL_F_SSL_CHOOSE_CLIENT_VERSION,
1903 SSL_R_WRONG_SSL_VERSION);
1907 * If this SSL handle is not from a version flexible method we don't
1908 * (and never did) check min/max, FIPS or Suite B constraints. Hope
1909 * that's OK. It is up to the caller to not choose fixed protocol
1910 * versions they don't want. If not, then easy to fix, just return
1911 * ssl_method_error(s, s->method)
1914 case TLS_ANY_VERSION:
1915 table = tls_version_table;
1917 case DTLS_ANY_VERSION:
1918 table = dtls_version_table;
1922 ret = ssl_get_min_max_version(s, &ver_min, &ver_max, &real_max);
1925 SSLfatal(s, SSL_AD_PROTOCOL_VERSION,
1926 SSL_F_SSL_CHOOSE_CLIENT_VERSION, ret);
1929 if (SSL_IS_DTLS(s) ? DTLS_VERSION_LT(s->version, ver_min)
1930 : s->version < ver_min) {
1932 SSLfatal(s, SSL_AD_PROTOCOL_VERSION,
1933 SSL_F_SSL_CHOOSE_CLIENT_VERSION, SSL_R_UNSUPPORTED_PROTOCOL);
1935 } else if (SSL_IS_DTLS(s) ? DTLS_VERSION_GT(s->version, ver_max)
1936 : s->version > ver_max) {
1938 SSLfatal(s, SSL_AD_PROTOCOL_VERSION,
1939 SSL_F_SSL_CHOOSE_CLIENT_VERSION, SSL_R_UNSUPPORTED_PROTOCOL);
1943 if ((s->mode & SSL_MODE_SEND_FALLBACK_SCSV) == 0)
1946 /* Check for downgrades */
1947 if (s->version == TLS1_2_VERSION && real_max > s->version) {
1948 if (memcmp(tls12downgrade,
1949 s->s3->server_random + SSL3_RANDOM_SIZE
1950 - sizeof(tls12downgrade),
1951 sizeof(tls12downgrade)) == 0) {
1953 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER,
1954 SSL_F_SSL_CHOOSE_CLIENT_VERSION,
1955 SSL_R_INAPPROPRIATE_FALLBACK);
1958 } else if (!SSL_IS_DTLS(s)
1959 && s->version < TLS1_2_VERSION
1960 && real_max > s->version) {
1961 if (memcmp(tls11downgrade,
1962 s->s3->server_random + SSL3_RANDOM_SIZE
1963 - sizeof(tls11downgrade),
1964 sizeof(tls11downgrade)) == 0) {
1966 SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER,
1967 SSL_F_SSL_CHOOSE_CLIENT_VERSION,
1968 SSL_R_INAPPROPRIATE_FALLBACK);
1973 for (vent = table; vent->version != 0; ++vent) {
1974 if (vent->cmeth == NULL || s->version != vent->version)
1977 s->method = vent->cmeth();
1982 SSLfatal(s, SSL_AD_PROTOCOL_VERSION, SSL_F_SSL_CHOOSE_CLIENT_VERSION,
1983 SSL_R_UNSUPPORTED_PROTOCOL);
1988 * ssl_get_min_max_version - get minimum and maximum protocol version
1989 * @s: The SSL connection
1990 * @min_version: The minimum supported version
1991 * @max_version: The maximum supported version
1992 * @real_max: The highest version below the lowest compile time version hole
1993 * where that hole lies above at least one run-time enabled
1996 * Work out what version we should be using for the initial ClientHello if the
1997 * version is initially (D)TLS_ANY_VERSION. We apply any explicit SSL_OP_NO_xxx
1998 * options, the MinProtocol and MaxProtocol configuration commands, any Suite B
1999 * constraints and any floor imposed by the security level here,
2000 * so we don't advertise the wrong protocol version to only reject the outcome later.
2002 * Computing the right floor matters. If, e.g., TLS 1.0 and 1.2 are enabled,
2003 * TLS 1.1 is disabled, but the security level, Suite-B and/or MinProtocol
2004 * only allow TLS 1.2, we want to advertise TLS1.2, *not* TLS1.
2006 * Returns 0 on success or an SSL error reason number on failure. On failure
2007 * min_version and max_version will also be set to 0.
2009 int ssl_get_min_max_version(const SSL *s, int *min_version, int *max_version,
2012 int version, tmp_real_max;
2014 const SSL_METHOD *single = NULL;
2015 const SSL_METHOD *method;
2016 const version_info *table;
2017 const version_info *vent;
2019 switch (s->method->version) {
2022 * If this SSL handle is not from a version flexible method we don't
2023 * (and never did) check min/max FIPS or Suite B constraints. Hope
2024 * that's OK. It is up to the caller to not choose fixed protocol
2025 * versions they don't want. If not, then easy to fix, just return
2026 * ssl_method_error(s, s->method)
2028 *min_version = *max_version = s->version;
2030 * Providing a real_max only makes sense where we're using a version
2033 if (!ossl_assert(real_max == NULL))
2034 return ERR_R_INTERNAL_ERROR;
2036 case TLS_ANY_VERSION:
2037 table = tls_version_table;
2039 case DTLS_ANY_VERSION:
2040 table = dtls_version_table;
2045 * SSL_OP_NO_X disables all protocols above X *if* there are some protocols
2046 * below X enabled. This is required in order to maintain the "version
2047 * capability" vector contiguous. Any versions with a NULL client method
2048 * (protocol version client is disabled at compile-time) is also a "hole".
2050 * Our initial state is hole == 1, version == 0. That is, versions above
2051 * the first version in the method table are disabled (a "hole" above
2052 * the valid protocol entries) and we don't have a selected version yet.
2054 * Whenever "hole == 1", and we hit an enabled method, its version becomes
2055 * the selected version, and the method becomes a candidate "single"
2056 * method. We're no longer in a hole, so "hole" becomes 0.
2058 * If "hole == 0" and we hit an enabled method, then "single" is cleared,
2059 * as we support a contiguous range of at least two methods. If we hit
2060 * a disabled method, then hole becomes true again, but nothing else
2061 * changes yet, because all the remaining methods may be disabled too.
2062 * If we again hit an enabled method after the new hole, it becomes
2063 * selected, as we start from scratch.
2065 *min_version = version = 0;
2067 if (real_max != NULL)
2070 for (vent = table; vent->version != 0; ++vent) {
2072 * A table entry with a NULL client method is still a hole in the
2073 * "version capability" vector.
2075 if (vent->cmeth == NULL) {
2080 method = vent->cmeth();
2082 if (hole == 1 && tmp_real_max == 0)
2083 tmp_real_max = vent->version;
2085 if (ssl_method_error(s, method) != 0) {
2089 *min_version = method->version;
2091 if (real_max != NULL && tmp_real_max != 0)
2092 *real_max = tmp_real_max;
2093 version = (single = method)->version;
2094 *min_version = version;
2099 *max_version = version;
2101 /* Fail if everything is disabled */
2103 return SSL_R_NO_PROTOCOLS_AVAILABLE;
2109 * ssl_set_client_hello_version - Work out what version we should be using for
2110 * the initial ClientHello.legacy_version field.
2112 * @s: client SSL handle.
2114 * Returns 0 on success or an SSL error reason number on failure.
2116 int ssl_set_client_hello_version(SSL *s)
2118 int ver_min, ver_max, ret;
2121 * In a renegotiation we always send the same client_version that we sent
2122 * last time, regardless of which version we eventually negotiated.
2124 if (!SSL_IS_FIRST_HANDSHAKE(s))
2127 ret = ssl_get_min_max_version(s, &ver_min, &ver_max, NULL);
2132 s->version = ver_max;
2134 /* TLS1.3 always uses TLS1.2 in the legacy_version field */
2135 if (!SSL_IS_DTLS(s) && ver_max > TLS1_2_VERSION)
2136 ver_max = TLS1_2_VERSION;
2138 s->client_version = ver_max;
2143 * Checks a list of |groups| to determine if the |group_id| is in it. If it is
2144 * and |checkallow| is 1 then additionally check if the group is allowed to be
2145 * used. Returns 1 if the group is in the list (and allowed if |checkallow| is
2146 * 1) or 0 otherwise.
2148 #ifndef OPENSSL_NO_EC
2149 int check_in_list(SSL *s, uint16_t group_id, const uint16_t *groups,
2150 size_t num_groups, int checkallow)
2154 if (groups == NULL || num_groups == 0)
2157 for (i = 0; i < num_groups; i++) {
2158 uint16_t group = groups[i];
2160 if (group_id == group
2162 || tls_curve_allowed(s, group, SSL_SECOP_CURVE_CHECK))) {
2171 /* Replace ClientHello1 in the transcript hash with a synthetic message */
2172 int create_synthetic_message_hash(SSL *s, const unsigned char *hashval,
2173 size_t hashlen, const unsigned char *hrr,
2176 unsigned char hashvaltmp[EVP_MAX_MD_SIZE];
2177 unsigned char msghdr[SSL3_HM_HEADER_LENGTH];
2179 memset(msghdr, 0, sizeof(msghdr));
2181 if (hashval == NULL) {
2182 hashval = hashvaltmp;
2184 /* Get the hash of the initial ClientHello */
2185 if (!ssl3_digest_cached_records(s, 0)
2186 || !ssl_handshake_hash(s, hashvaltmp, sizeof(hashvaltmp),
2188 /* SSLfatal() already called */
2193 /* Reinitialise the transcript hash */
2194 if (!ssl3_init_finished_mac(s)) {
2195 /* SSLfatal() already called */
2199 /* Inject the synthetic message_hash message */
2200 msghdr[0] = SSL3_MT_MESSAGE_HASH;
2201 msghdr[SSL3_HM_HEADER_LENGTH - 1] = (unsigned char)hashlen;
2202 if (!ssl3_finish_mac(s, msghdr, SSL3_HM_HEADER_LENGTH)
2203 || !ssl3_finish_mac(s, hashval, hashlen)) {
2204 /* SSLfatal() already called */
2209 * Now re-inject the HRR and current message if appropriate (we just deleted
2210 * it when we reinitialised the transcript hash above). Only necessary after
2211 * receiving a ClientHello2 with a cookie.
2214 && (!ssl3_finish_mac(s, hrr, hrrlen)
2215 || !ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
2216 s->s3->tmp.message_size
2217 + SSL3_HM_HEADER_LENGTH))) {
2218 /* SSLfatal() already called */
2225 static int ca_dn_cmp(const X509_NAME *const *a, const X509_NAME *const *b)
2227 return X509_NAME_cmp(*a, *b);
2230 int parse_ca_names(SSL *s, PACKET *pkt)
2232 STACK_OF(X509_NAME) *ca_sk = sk_X509_NAME_new(ca_dn_cmp);
2233 X509_NAME *xn = NULL;
2236 if (ca_sk == NULL) {
2237 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_PARSE_CA_NAMES,
2238 ERR_R_MALLOC_FAILURE);
2241 /* get the CA RDNs */
2242 if (!PACKET_get_length_prefixed_2(pkt, &cadns)) {
2243 SSLfatal(s, SSL_AD_DECODE_ERROR,SSL_F_PARSE_CA_NAMES,
2244 SSL_R_LENGTH_MISMATCH);
2248 while (PACKET_remaining(&cadns)) {
2249 const unsigned char *namestart, *namebytes;
2250 unsigned int name_len;
2252 if (!PACKET_get_net_2(&cadns, &name_len)
2253 || !PACKET_get_bytes(&cadns, &namebytes, name_len)) {
2254 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_PARSE_CA_NAMES,
2255 SSL_R_LENGTH_MISMATCH);
2259 namestart = namebytes;
2260 if ((xn = d2i_X509_NAME(NULL, &namebytes, name_len)) == NULL) {
2261 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_PARSE_CA_NAMES,
2265 if (namebytes != (namestart + name_len)) {
2266 SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_PARSE_CA_NAMES,
2267 SSL_R_CA_DN_LENGTH_MISMATCH);
2271 if (!sk_X509_NAME_push(ca_sk, xn)) {
2272 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_PARSE_CA_NAMES,
2273 ERR_R_MALLOC_FAILURE);
2279 sk_X509_NAME_pop_free(s->s3->tmp.peer_ca_names, X509_NAME_free);
2280 s->s3->tmp.peer_ca_names = ca_sk;
2285 sk_X509_NAME_pop_free(ca_sk, X509_NAME_free);
2290 const STACK_OF(X509_NAME) *get_ca_names(SSL *s)
2292 const STACK_OF(X509_NAME) *ca_sk = NULL;;
2295 ca_sk = SSL_get_client_CA_list(s);
2296 if (ca_sk != NULL && sk_X509_NAME_num(ca_sk) == 0)
2301 ca_sk = SSL_get0_CA_list(s);
2306 int construct_ca_names(SSL *s, const STACK_OF(X509_NAME) *ca_sk, WPACKET *pkt)
2308 /* Start sub-packet for client CA list */
2309 if (!WPACKET_start_sub_packet_u16(pkt)) {
2310 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_CONSTRUCT_CA_NAMES,
2311 ERR_R_INTERNAL_ERROR);
2315 if (ca_sk != NULL) {
2318 for (i = 0; i < sk_X509_NAME_num(ca_sk); i++) {
2319 unsigned char *namebytes;
2320 X509_NAME *name = sk_X509_NAME_value(ca_sk, i);
2324 || (namelen = i2d_X509_NAME(name, NULL)) < 0
2325 || !WPACKET_sub_allocate_bytes_u16(pkt, namelen,
2327 || i2d_X509_NAME(name, &namebytes) != namelen) {
2328 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_CONSTRUCT_CA_NAMES,
2329 ERR_R_INTERNAL_ERROR);
2335 if (!WPACKET_close(pkt)) {
2336 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_CONSTRUCT_CA_NAMES,
2337 ERR_R_INTERNAL_ERROR);
2344 /* Create a buffer containing data to be signed for server key exchange */
2345 size_t construct_key_exchange_tbs(SSL *s, unsigned char **ptbs,
2346 const void *param, size_t paramlen)
2348 size_t tbslen = 2 * SSL3_RANDOM_SIZE + paramlen;
2349 unsigned char *tbs = OPENSSL_malloc(tbslen);
2352 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_CONSTRUCT_KEY_EXCHANGE_TBS,
2353 ERR_R_MALLOC_FAILURE);
2356 memcpy(tbs, s->s3->client_random, SSL3_RANDOM_SIZE);
2357 memcpy(tbs + SSL3_RANDOM_SIZE, s->s3->server_random, SSL3_RANDOM_SIZE);
2359 memcpy(tbs + SSL3_RANDOM_SIZE * 2, param, paramlen);
2366 * Saves the current handshake digest for Post-Handshake Auth,
2367 * Done after ClientFinished is processed, done exactly once
2369 int tls13_save_handshake_digest_for_pha(SSL *s)
2371 if (s->pha_dgst == NULL) {
2372 if (!ssl3_digest_cached_records(s, 1))
2373 /* SSLfatal() already called */
2376 s->pha_dgst = EVP_MD_CTX_new();
2377 if (s->pha_dgst == NULL) {
2378 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
2379 SSL_F_TLS13_SAVE_HANDSHAKE_DIGEST_FOR_PHA,
2380 ERR_R_INTERNAL_ERROR);
2383 if (!EVP_MD_CTX_copy_ex(s->pha_dgst,
2384 s->s3->handshake_dgst)) {
2385 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
2386 SSL_F_TLS13_SAVE_HANDSHAKE_DIGEST_FOR_PHA,
2387 ERR_R_INTERNAL_ERROR);
2395 * Restores the Post-Handshake Auth handshake digest
2396 * Done just before sending/processing the Cert Request
2398 int tls13_restore_handshake_digest_for_pha(SSL *s)
2400 if (s->pha_dgst == NULL) {
2401 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
2402 SSL_F_TLS13_RESTORE_HANDSHAKE_DIGEST_FOR_PHA,
2403 ERR_R_INTERNAL_ERROR);
2406 if (!EVP_MD_CTX_copy_ex(s->s3->handshake_dgst,
2408 SSLfatal(s, SSL_AD_INTERNAL_ERROR,
2409 SSL_F_TLS13_RESTORE_HANDSHAKE_DIGEST_FOR_PHA,
2410 ERR_R_INTERNAL_ERROR);