fa7387a5ada1cec5207c0b15015290f05abd331a
[openssl.git] / 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     size_t written = 0;
34
35     ret = ssl3_write_bytes(s, type, &s->init_buf->data[s->init_off],
36                            s->init_num, &written);
37     if (ret < 0)
38         return (-1);
39     if (type == SSL3_RT_HANDSHAKE)
40         /*
41          * should not be done for 'Hello Request's, but in that case we'll
42          * ignore the result anyway
43          */
44         if (!ssl3_finish_mac(s,
45                              (unsigned char *)&s->init_buf->data[s->init_off],
46                              written))
47             return -1;
48
49     if (written == s->init_num) {
50         if (s->msg_callback)
51             s->msg_callback(1, s->version, type, s->init_buf->data,
52                             (size_t)(s->init_off + s->init_num), s,
53                             s->msg_callback_arg);
54         return (1);
55     }
56     s->init_off += written;
57     s->init_num -= written;
58     return (0);
59 }
60
61 int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype)
62 {
63     size_t msglen;
64
65     if ((htype != SSL3_MT_CHANGE_CIPHER_SPEC && !WPACKET_close(pkt))
66             || !WPACKET_get_length(pkt, &msglen)
67             || msglen > INT_MAX)
68         return 0;
69     s->init_num = (int)msglen;
70     s->init_off = 0;
71
72     return 1;
73 }
74
75 int tls_setup_handshake(SSL *s)
76 {
77     if (!ssl3_init_finished_mac(s))
78         return 0;
79
80     if (s->server) {
81         if (SSL_IS_FIRST_HANDSHAKE(s)) {
82             s->ctx->stats.sess_accept++;
83         } else if (!s->s3->send_connection_binding &&
84                    !(s->options &
85                      SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)) {
86             /*
87              * Server attempting to renegotiate with client that doesn't
88              * support secure renegotiation.
89              */
90             SSLerr(SSL_F_TLS_SETUP_HANDSHAKE,
91                    SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
92             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_HANDSHAKE_FAILURE);
93             return 0;
94         } else {
95             s->ctx->stats.sess_accept_renegotiate++;
96
97             s->s3->tmp.cert_request = 0;
98         }
99     } else {
100         if (SSL_IS_FIRST_HANDSHAKE(s))
101             s->ctx->stats.sess_connect++;
102         else
103             s->ctx->stats.sess_connect_renegotiate++;
104
105         /* mark client_random uninitialized */
106         memset(s->s3->client_random, 0, sizeof(s->s3->client_random));
107         s->hit = 0;
108
109         s->s3->tmp.cert_req = 0;
110
111         if (SSL_IS_DTLS(s))
112             s->statem.use_timer = 1;
113     }
114
115     return 1;
116 }
117
118 /*
119  * Size of the to-be-signed TLS13 data, without the hash size itself:
120  * 64 bytes of value 32, 33 context bytes, 1 byte separator
121  */
122 #define TLS13_TBS_START_SIZE            64
123 #define TLS13_TBS_PREAMBLE_SIZE         (TLS13_TBS_START_SIZE + 33 + 1)
124
125 static int get_cert_verify_tbs_data(SSL *s, unsigned char *tls13tbs,
126                                     void **hdata, size_t *hdatalen)
127 {
128     static const char *servercontext = "TLS 1.3, server CertificateVerify";
129     static const char *clientcontext = "TLS 1.3, client CertificateVerify";
130
131     if (SSL_IS_TLS13(s)) {
132         size_t hashlen;
133
134         /* Set the first 64 bytes of to-be-signed data to octet 32 */
135         memset(tls13tbs, 32, TLS13_TBS_START_SIZE);
136         /* This copies the 33 bytes of context plus the 0 separator byte */
137         if (s->statem.hand_state == TLS_ST_CR_CERT_VRFY
138                  || s->statem.hand_state == TLS_ST_SW_CERT_VRFY)
139             strcpy((char *)tls13tbs + TLS13_TBS_START_SIZE, servercontext);
140         else
141             strcpy((char *)tls13tbs + TLS13_TBS_START_SIZE, clientcontext);
142
143         /*
144          * If we're currently reading then we need to use the saved handshake
145          * hash value. We can't use the current handshake hash state because
146          * that includes the CertVerify itself.
147          */
148         if (s->statem.hand_state == TLS_ST_CR_CERT_VRFY
149                 || s->statem.hand_state == TLS_ST_SR_CERT_VRFY) {
150             memcpy(tls13tbs + TLS13_TBS_PREAMBLE_SIZE, s->cert_verify_hash,
151                    s->cert_verify_hash_len);
152             hashlen = s->cert_verify_hash_len;
153         } else if (!ssl_handshake_hash(s, tls13tbs + TLS13_TBS_PREAMBLE_SIZE,
154                                        EVP_MAX_MD_SIZE, &hashlen)) {
155             return 0;
156         }
157
158         *hdata = tls13tbs;
159         *hdatalen = TLS13_TBS_PREAMBLE_SIZE + hashlen;
160     } else {
161         size_t retlen;
162
163         retlen = BIO_get_mem_data(s->s3->handshake_buffer, hdata);
164         if (retlen <= 0)
165             return 0;
166         *hdatalen = retlen;
167     }
168
169     return 1;
170 }
171
172 int tls_construct_cert_verify(SSL *s, WPACKET *pkt)
173 {
174     EVP_PKEY *pkey = NULL;
175     const EVP_MD *md = NULL;
176     EVP_MD_CTX *mctx = NULL;
177     EVP_PKEY_CTX *pctx = NULL;
178     size_t hdatalen = 0, siglen = 0;
179     void *hdata;
180     unsigned char *sig = NULL;
181     unsigned char tls13tbs[TLS13_TBS_PREAMBLE_SIZE + EVP_MAX_MD_SIZE];
182     const SIGALG_LOOKUP *lu = s->s3->tmp.sigalg;
183
184     if (lu == NULL || s->s3->tmp.cert == NULL) {
185         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_INTERNAL_ERROR);
186         goto err;
187     }
188     pkey = s->s3->tmp.cert->privatekey;
189     md = ssl_md(lu->hash_idx);
190
191     if (pkey == NULL || md == NULL) {
192         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_INTERNAL_ERROR);
193         goto err;
194     }
195
196     mctx = EVP_MD_CTX_new();
197     if (mctx == NULL) {
198         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_MALLOC_FAILURE);
199         goto err;
200     }
201
202     /* Get the data to be signed */
203     if (!get_cert_verify_tbs_data(s, tls13tbs, &hdata, &hdatalen)) {
204         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_INTERNAL_ERROR);
205         goto err;
206     }
207
208     if (SSL_USE_SIGALGS(s) && !WPACKET_put_bytes_u16(pkt, lu->sigalg)) {
209         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_INTERNAL_ERROR);
210         goto err;
211     }
212     siglen = EVP_PKEY_size(pkey);
213     sig = OPENSSL_malloc(siglen);
214     if (sig == NULL) {
215         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_MALLOC_FAILURE);
216         goto err;
217     }
218
219     if (EVP_DigestSignInit(mctx, &pctx, md, NULL, pkey) <= 0
220             || EVP_DigestSignUpdate(mctx, hdata, hdatalen) <= 0) {
221         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_EVP_LIB);
222         goto err;
223     }
224
225     if (lu->sig == EVP_PKEY_RSA_PSS) {
226         if (EVP_PKEY_CTX_set_rsa_padding(pctx, RSA_PKCS1_PSS_PADDING) <= 0
227             || EVP_PKEY_CTX_set_rsa_pss_saltlen(pctx,
228                                                 RSA_PSS_SALTLEN_DIGEST) <= 0) {
229             SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_EVP_LIB);
230             goto err;
231         }
232     } else if (s->version == SSL3_VERSION) {
233         if (!EVP_MD_CTX_ctrl(mctx, EVP_CTRL_SSL3_MASTER_SECRET,
234                              (int)s->session->master_key_length,
235                              s->session->master_key)) {
236             SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_EVP_LIB);
237             goto err;
238         }
239     }
240
241     if (EVP_DigestSignFinal(mctx, sig, &siglen) <= 0) {
242         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_EVP_LIB);
243         goto err;
244     }
245
246 #ifndef OPENSSL_NO_GOST
247     {
248         int pktype = lu->sig;
249
250         if (pktype == NID_id_GostR3410_2001
251             || pktype == NID_id_GostR3410_2012_256
252             || pktype == NID_id_GostR3410_2012_512)
253             BUF_reverse(sig, NULL, siglen);
254     }
255 #endif
256
257     if (!WPACKET_sub_memcpy_u16(pkt, sig, siglen)) {
258         SSLerr(SSL_F_TLS_CONSTRUCT_CERT_VERIFY, ERR_R_INTERNAL_ERROR);
259         goto err;
260     }
261
262     /* Digest cached records and discard handshake buffer */
263     if (!ssl3_digest_cached_records(s, 0))
264         goto err;
265
266     OPENSSL_free(sig);
267     EVP_MD_CTX_free(mctx);
268     return 1;
269  err:
270     OPENSSL_free(sig);
271     EVP_MD_CTX_free(mctx);
272     ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
273     return 0;
274 }
275
276 MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, PACKET *pkt)
277 {
278     EVP_PKEY *pkey = NULL;
279     const unsigned char *data;
280 #ifndef OPENSSL_NO_GOST
281     unsigned char *gost_data = NULL;
282 #endif
283     int al = SSL_AD_INTERNAL_ERROR, ret = MSG_PROCESS_ERROR;
284     int type = 0, j, pktype;
285     unsigned int len;
286     X509 *peer;
287     const EVP_MD *md = NULL;
288     size_t hdatalen = 0;
289     void *hdata;
290     unsigned char tls13tbs[TLS13_TBS_PREAMBLE_SIZE + EVP_MAX_MD_SIZE];
291     EVP_MD_CTX *mctx = EVP_MD_CTX_new();
292     EVP_PKEY_CTX *pctx = NULL;
293
294     if (mctx == NULL) {
295         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, ERR_R_MALLOC_FAILURE);
296         goto f_err;
297     }
298
299     peer = s->session->peer;
300     pkey = X509_get0_pubkey(peer);
301     if (pkey == NULL) {
302         al = SSL_AD_INTERNAL_ERROR;
303         goto f_err;
304     }
305
306     pktype = EVP_PKEY_id(pkey);
307     type = X509_certificate_type(peer, pkey);
308
309     if (!(type & EVP_PKT_SIGN)) {
310         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY,
311                SSL_R_SIGNATURE_FOR_NON_SIGNING_CERTIFICATE);
312         al = SSL_AD_ILLEGAL_PARAMETER;
313         goto f_err;
314     }
315
316     /* Check for broken implementations of GOST ciphersuites */
317     /*
318      * If key is GOST and n is exactly 64, it is bare signature without
319      * length field (CryptoPro implementations at least till CSP 4.0)
320      */
321 #ifndef OPENSSL_NO_GOST
322     if (PACKET_remaining(pkt) == 64
323         && EVP_PKEY_id(pkey) == NID_id_GostR3410_2001) {
324         len = 64;
325     } else
326 #endif
327     {
328         if (SSL_USE_SIGALGS(s)) {
329             int rv;
330             unsigned int sigalg;
331
332             if (!PACKET_get_net_2(pkt, &sigalg)) {
333                 al = SSL_AD_DECODE_ERROR;
334                 goto f_err;
335             }
336             rv = tls12_check_peer_sigalg(s, sigalg, pkey);
337             if (rv == -1) {
338                 goto f_err;
339             } else if (rv == 0) {
340                 al = SSL_AD_DECODE_ERROR;
341                 goto f_err;
342             }
343 #ifdef SSL_DEBUG
344             fprintf(stderr, "USING TLSv1.2 HASH %s\n", EVP_MD_name(md));
345 #endif
346         } else if (!tls1_set_peer_legacy_sigalg(s, pkey)) {
347                 al = SSL_AD_INTERNAL_ERROR;
348                 goto f_err;
349         }
350
351         md = ssl_md(s->s3->tmp.peer_sigalg->hash_idx);
352
353         if (!PACKET_get_net_2(pkt, &len)) {
354             SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, SSL_R_LENGTH_MISMATCH);
355             al = SSL_AD_DECODE_ERROR;
356             goto f_err;
357         }
358     }
359     j = EVP_PKEY_size(pkey);
360     if (((int)len > j) || ((int)PACKET_remaining(pkt) > j)
361         || (PACKET_remaining(pkt) == 0)) {
362         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, SSL_R_WRONG_SIGNATURE_SIZE);
363         al = SSL_AD_DECODE_ERROR;
364         goto f_err;
365     }
366     if (!PACKET_get_bytes(pkt, &data, len)) {
367         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, SSL_R_LENGTH_MISMATCH);
368         al = SSL_AD_DECODE_ERROR;
369         goto f_err;
370     }
371
372     if (!get_cert_verify_tbs_data(s, tls13tbs, &hdata, &hdatalen)) {
373         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, ERR_R_INTERNAL_ERROR);
374         goto f_err;
375     }
376
377 #ifdef SSL_DEBUG
378     fprintf(stderr, "Using client verify alg %s\n", EVP_MD_name(md));
379 #endif
380     if (EVP_DigestVerifyInit(mctx, &pctx, md, NULL, pkey) <= 0
381             || EVP_DigestVerifyUpdate(mctx, hdata, hdatalen) <= 0) {
382         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, ERR_R_EVP_LIB);
383         goto f_err;
384     }
385 #ifndef OPENSSL_NO_GOST
386     {
387         if (pktype == NID_id_GostR3410_2001
388             || pktype == NID_id_GostR3410_2012_256
389             || pktype == NID_id_GostR3410_2012_512) {
390             if ((gost_data = OPENSSL_malloc(len)) == NULL) {
391                 SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, ERR_R_MALLOC_FAILURE);
392                 goto f_err;
393             }
394             BUF_reverse(gost_data, data, len);
395             data = gost_data;
396         }
397     }
398 #endif
399
400     if (SSL_USE_PSS(s)) {
401         if (EVP_PKEY_CTX_set_rsa_padding(pctx, RSA_PKCS1_PSS_PADDING) <= 0
402             || EVP_PKEY_CTX_set_rsa_pss_saltlen(pctx,
403                                                 RSA_PSS_SALTLEN_DIGEST) <= 0) {
404             SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, ERR_R_EVP_LIB);
405             goto f_err;
406         }
407     } else if (s->version == SSL3_VERSION
408         && !EVP_MD_CTX_ctrl(mctx, EVP_CTRL_SSL3_MASTER_SECRET,
409                             (int)s->session->master_key_length,
410                             s->session->master_key)) {
411         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, ERR_R_EVP_LIB);
412         goto f_err;
413     }
414
415     if (EVP_DigestVerifyFinal(mctx, data, len) <= 0) {
416         al = SSL_AD_DECRYPT_ERROR;
417         SSLerr(SSL_F_TLS_PROCESS_CERT_VERIFY, SSL_R_BAD_SIGNATURE);
418         goto f_err;
419     }
420
421     if (SSL_IS_TLS13(s))
422         ret = MSG_PROCESS_CONTINUE_READING;
423     else
424         ret = MSG_PROCESS_CONTINUE_PROCESSING;
425     if (0) {
426  f_err:
427         ssl3_send_alert(s, SSL3_AL_FATAL, al);
428         ossl_statem_set_error(s);
429     }
430     BIO_free(s->s3->handshake_buffer);
431     s->s3->handshake_buffer = NULL;
432     EVP_MD_CTX_free(mctx);
433 #ifndef OPENSSL_NO_GOST
434     OPENSSL_free(gost_data);
435 #endif
436     return ret;
437 }
438
439 int tls_construct_finished(SSL *s, WPACKET *pkt)
440 {
441     size_t finish_md_len;
442     const char *sender;
443     size_t slen;
444
445     if (s->server) {
446         sender = s->method->ssl3_enc->server_finished_label;
447         slen = s->method->ssl3_enc->server_finished_label_len;
448     } else {
449         sender = s->method->ssl3_enc->client_finished_label;
450         slen = s->method->ssl3_enc->client_finished_label_len;
451     }
452
453     finish_md_len = s->method->ssl3_enc->final_finish_mac(s,
454                                                           sender, slen,
455                                                           s->s3->tmp.finish_md);
456     if (finish_md_len == 0) {
457         SSLerr(SSL_F_TLS_CONSTRUCT_FINISHED, ERR_R_INTERNAL_ERROR);
458         goto err;
459     }
460
461     s->s3->tmp.finish_md_len = finish_md_len;
462
463     if (!WPACKET_memcpy(pkt, s->s3->tmp.finish_md, finish_md_len)) {
464         SSLerr(SSL_F_TLS_CONSTRUCT_FINISHED, ERR_R_INTERNAL_ERROR);
465         goto err;
466     }
467
468     /*
469      * Log the master secret, if logging is enabled. We don't log it for
470      * TLSv1.3: there's a different key schedule for that.
471      */
472     if (!SSL_IS_TLS13(s) && !ssl_log_secret(s, MASTER_SECRET_LABEL,
473                                             s->session->master_key,
474                                             s->session->master_key_length))
475         return 0;
476
477     /*
478      * Copy the finished so we can use it for renegotiation checks
479      */
480     if (!s->server) {
481         OPENSSL_assert(finish_md_len <= EVP_MAX_MD_SIZE);
482         memcpy(s->s3->previous_client_finished, s->s3->tmp.finish_md,
483                finish_md_len);
484         s->s3->previous_client_finished_len = finish_md_len;
485     } else {
486         OPENSSL_assert(finish_md_len <= EVP_MAX_MD_SIZE);
487         memcpy(s->s3->previous_server_finished, s->s3->tmp.finish_md,
488                finish_md_len);
489         s->s3->previous_server_finished_len = finish_md_len;
490     }
491
492     return 1;
493  err:
494     ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
495     return 0;
496 }
497
498 int tls_construct_key_update(SSL *s, WPACKET *pkt)
499 {
500     if (!WPACKET_put_bytes_u8(pkt, s->key_update)) {
501         SSLerr(SSL_F_TLS_CONSTRUCT_KEY_UPDATE, ERR_R_INTERNAL_ERROR);
502         goto err;
503     }
504
505     return 1;
506  err:
507     ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
508     return 0;
509 }
510
511 #ifndef OPENSSL_NO_NEXTPROTONEG
512 /*
513  * ssl3_take_mac calculates the Finished MAC for the handshakes messages seen
514  * to far.
515  */
516 static void ssl3_take_mac(SSL *s)
517 {
518     const char *sender;
519     size_t slen;
520     /*
521      * If no new cipher setup return immediately: other functions will set
522      * the appropriate error.
523      */
524     if (s->s3->tmp.new_cipher == NULL)
525         return;
526     if (!s->server) {
527         sender = s->method->ssl3_enc->server_finished_label;
528         slen = s->method->ssl3_enc->server_finished_label_len;
529     } else {
530         sender = s->method->ssl3_enc->client_finished_label;
531         slen = s->method->ssl3_enc->client_finished_label_len;
532     }
533
534     s->s3->tmp.peer_finish_md_len = s->method->ssl3_enc->final_finish_mac(s,
535                                                                           sender,
536                                                                           slen,
537                                                                           s->s3->tmp.peer_finish_md);
538 }
539 #endif
540
541 MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, PACKET *pkt)
542 {
543     int al;
544     size_t remain;
545
546     remain = PACKET_remaining(pkt);
547     /*
548      * 'Change Cipher Spec' is just a single byte, which should already have
549      * been consumed by ssl_get_message() so there should be no bytes left,
550      * unless we're using DTLS1_BAD_VER, which has an extra 2 bytes
551      */
552     if (SSL_IS_DTLS(s)) {
553         if ((s->version == DTLS1_BAD_VER
554              && remain != DTLS1_CCS_HEADER_LENGTH + 1)
555             || (s->version != DTLS1_BAD_VER
556                 && remain != DTLS1_CCS_HEADER_LENGTH - 1)) {
557             al = SSL_AD_ILLEGAL_PARAMETER;
558             SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC,
559                    SSL_R_BAD_CHANGE_CIPHER_SPEC);
560             goto f_err;
561         }
562     } else {
563         if (remain != 0) {
564             al = SSL_AD_ILLEGAL_PARAMETER;
565             SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC,
566                    SSL_R_BAD_CHANGE_CIPHER_SPEC);
567             goto f_err;
568         }
569     }
570
571     /* Check we have a cipher to change to */
572     if (s->s3->tmp.new_cipher == NULL) {
573         al = SSL_AD_UNEXPECTED_MESSAGE;
574         SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC, SSL_R_CCS_RECEIVED_EARLY);
575         goto f_err;
576     }
577
578     s->s3->change_cipher_spec = 1;
579     if (!ssl3_do_change_cipher_spec(s)) {
580         al = SSL_AD_INTERNAL_ERROR;
581         SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
582         goto f_err;
583     }
584
585     if (SSL_IS_DTLS(s)) {
586         dtls1_reset_seq_numbers(s, SSL3_CC_READ);
587
588         if (s->version == DTLS1_BAD_VER)
589             s->d1->handshake_read_seq++;
590
591 #ifndef OPENSSL_NO_SCTP
592         /*
593          * Remember that a CCS has been received, so that an old key of
594          * SCTP-Auth can be deleted when a CCS is sent. Will be ignored if no
595          * SCTP is used
596          */
597         BIO_ctrl(SSL_get_wbio(s), BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD, 1, NULL);
598 #endif
599     }
600
601     return MSG_PROCESS_CONTINUE_READING;
602  f_err:
603     ssl3_send_alert(s, SSL3_AL_FATAL, al);
604     ossl_statem_set_error(s);
605     return MSG_PROCESS_ERROR;
606 }
607
608 MSG_PROCESS_RETURN tls_process_finished(SSL *s, PACKET *pkt)
609 {
610     int al = SSL_AD_INTERNAL_ERROR;
611     size_t md_len;
612
613     /* If this occurs, we have missed a message */
614     if (!SSL_IS_TLS13(s) && !s->s3->change_cipher_spec) {
615         al = SSL_AD_UNEXPECTED_MESSAGE;
616         SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_GOT_A_FIN_BEFORE_A_CCS);
617         goto f_err;
618     }
619     s->s3->change_cipher_spec = 0;
620
621     md_len = s->s3->tmp.peer_finish_md_len;
622
623     if (md_len != PACKET_remaining(pkt)) {
624         al = SSL_AD_DECODE_ERROR;
625         SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_BAD_DIGEST_LENGTH);
626         goto f_err;
627     }
628
629     if (CRYPTO_memcmp(PACKET_data(pkt), s->s3->tmp.peer_finish_md,
630                       md_len) != 0) {
631         al = SSL_AD_DECRYPT_ERROR;
632         SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_DIGEST_CHECK_FAILED);
633         goto f_err;
634     }
635
636     /*
637      * Copy the finished so we can use it for renegotiation checks
638      */
639     if (s->server) {
640         OPENSSL_assert(md_len <= EVP_MAX_MD_SIZE);
641         memcpy(s->s3->previous_client_finished, s->s3->tmp.peer_finish_md,
642                md_len);
643         s->s3->previous_client_finished_len = md_len;
644     } else {
645         OPENSSL_assert(md_len <= EVP_MAX_MD_SIZE);
646         memcpy(s->s3->previous_server_finished, s->s3->tmp.peer_finish_md,
647                md_len);
648         s->s3->previous_server_finished_len = md_len;
649     }
650
651     /*
652      * In TLS1.3 we also have to change cipher state and do any final processing
653      * of the initial server flight (if we are a client)
654      */
655     if (SSL_IS_TLS13(s)) {
656         if (s->server) {
657             if (!s->method->ssl3_enc->change_cipher_state(s,
658                     SSL3_CC_APPLICATION | SSL3_CHANGE_CIPHER_SERVER_READ)) {
659                 SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_CANNOT_CHANGE_CIPHER);
660                 goto f_err;
661             }
662         } else {
663             if (!s->method->ssl3_enc->generate_master_secret(s,
664                     s->master_secret, s->handshake_secret, 0,
665                     &s->session->master_key_length)) {
666                 SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_CANNOT_CHANGE_CIPHER);
667                 goto f_err;
668             }
669             if (!s->method->ssl3_enc->change_cipher_state(s,
670                     SSL3_CC_APPLICATION | SSL3_CHANGE_CIPHER_CLIENT_READ)) {
671                 SSLerr(SSL_F_TLS_PROCESS_FINISHED, SSL_R_CANNOT_CHANGE_CIPHER);
672                 goto f_err;
673             }
674             if (!tls_process_initial_server_flight(s, &al))
675                 goto f_err;
676         }
677     }
678
679     return MSG_PROCESS_FINISHED_READING;
680  f_err:
681     ssl3_send_alert(s, SSL3_AL_FATAL, al);
682     ossl_statem_set_error(s);
683     return MSG_PROCESS_ERROR;
684 }
685
686 int tls_construct_change_cipher_spec(SSL *s, WPACKET *pkt)
687 {
688     if (!WPACKET_put_bytes_u8(pkt, SSL3_MT_CCS)) {
689         SSLerr(SSL_F_TLS_CONSTRUCT_CHANGE_CIPHER_SPEC, ERR_R_INTERNAL_ERROR);
690         ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
691         return 0;
692     }
693
694     return 1;
695 }
696
697 /* Add a certificate to the WPACKET */
698 static int ssl_add_cert_to_wpacket(SSL *s, WPACKET *pkt, X509 *x, int chain,
699                                    int *al)
700 {
701     int len;
702     unsigned char *outbytes;
703
704     len = i2d_X509(x, NULL);
705     if (len < 0) {
706         SSLerr(SSL_F_SSL_ADD_CERT_TO_WPACKET, ERR_R_BUF_LIB);
707         *al = SSL_AD_INTERNAL_ERROR;
708         return 0;
709     }
710     if (!WPACKET_sub_allocate_bytes_u24(pkt, len, &outbytes)
711             || i2d_X509(x, &outbytes) != len) {
712         SSLerr(SSL_F_SSL_ADD_CERT_TO_WPACKET, ERR_R_INTERNAL_ERROR);
713         *al = SSL_AD_INTERNAL_ERROR;
714         return 0;
715     }
716
717     if (SSL_IS_TLS13(s)
718             && !tls_construct_extensions(s, pkt, EXT_TLS1_3_CERTIFICATE, x,
719                                          chain, al))
720         return 0;
721
722     return 1;
723 }
724
725 /* Add certificate chain to provided WPACKET */
726 static int ssl_add_cert_chain(SSL *s, WPACKET *pkt, CERT_PKEY *cpk, int *al)
727 {
728     int i, chain_count;
729     X509 *x;
730     STACK_OF(X509) *extra_certs;
731     STACK_OF(X509) *chain = NULL;
732     X509_STORE *chain_store;
733     int tmpal = SSL_AD_INTERNAL_ERROR;
734
735     if (cpk == NULL || cpk->x509 == NULL)
736         return 1;
737
738     x = cpk->x509;
739
740     /*
741      * If we have a certificate specific chain use it, else use parent ctx.
742      */
743     if (cpk->chain != NULL)
744         extra_certs = cpk->chain;
745     else
746         extra_certs = s->ctx->extra_certs;
747
748     if ((s->mode & SSL_MODE_NO_AUTO_CHAIN) || extra_certs)
749         chain_store = NULL;
750     else if (s->cert->chain_store)
751         chain_store = s->cert->chain_store;
752     else
753         chain_store = s->ctx->cert_store;
754
755     if (chain_store != NULL) {
756         X509_STORE_CTX *xs_ctx = X509_STORE_CTX_new();
757
758         if (xs_ctx == NULL) {
759             SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, ERR_R_MALLOC_FAILURE);
760             goto err;
761         }
762         if (!X509_STORE_CTX_init(xs_ctx, chain_store, x, NULL)) {
763             X509_STORE_CTX_free(xs_ctx);
764             SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, ERR_R_X509_LIB);
765             goto err;
766         }
767         /*
768          * It is valid for the chain not to be complete (because normally we
769          * don't include the root cert in the chain). Therefore we deliberately
770          * ignore the error return from this call. We're not actually verifying
771          * the cert - we're just building as much of the chain as we can
772          */
773         (void)X509_verify_cert(xs_ctx);
774         /* Don't leave errors in the queue */
775         ERR_clear_error();
776         chain = X509_STORE_CTX_get0_chain(xs_ctx);
777         i = ssl_security_cert_chain(s, chain, NULL, 0);
778         if (i != 1) {
779 #if 0
780             /* Dummy error calls so mkerr generates them */
781             SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, SSL_R_EE_KEY_TOO_SMALL);
782             SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, SSL_R_CA_KEY_TOO_SMALL);
783             SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, SSL_R_CA_MD_TOO_WEAK);
784 #endif
785             X509_STORE_CTX_free(xs_ctx);
786             SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, i);
787             goto err;
788         }
789         chain_count = sk_X509_num(chain);
790         for (i = 0; i < chain_count; i++) {
791             x = sk_X509_value(chain, i);
792
793             if (!ssl_add_cert_to_wpacket(s, pkt, x, i, &tmpal)) {
794                 X509_STORE_CTX_free(xs_ctx);
795                 goto err;
796             }
797         }
798         X509_STORE_CTX_free(xs_ctx);
799     } else {
800         i = ssl_security_cert_chain(s, extra_certs, x, 0);
801         if (i != 1) {
802             SSLerr(SSL_F_SSL_ADD_CERT_CHAIN, i);
803             goto err;
804         }
805         if (!ssl_add_cert_to_wpacket(s, pkt, x, 0, &tmpal))
806             goto err;
807         for (i = 0; i < sk_X509_num(extra_certs); i++) {
808             x = sk_X509_value(extra_certs, i);
809             if (!ssl_add_cert_to_wpacket(s, pkt, x, i + 1, &tmpal))
810                 goto err;
811         }
812     }
813     return 1;
814
815  err:
816     *al = tmpal;
817     return 0;
818 }
819
820 unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt, CERT_PKEY *cpk,
821                                      int *al)
822 {
823     int tmpal = SSL_AD_INTERNAL_ERROR;
824
825     if (!WPACKET_start_sub_packet_u24(pkt)
826             || !ssl_add_cert_chain(s, pkt, cpk, &tmpal)
827             || !WPACKET_close(pkt)) {
828         SSLerr(SSL_F_SSL3_OUTPUT_CERT_CHAIN, ERR_R_INTERNAL_ERROR);
829         *al = tmpal;
830         return 0;
831     }
832     return 1;
833 }
834
835 /*
836  * Tidy up after the end of a handshake. In the case of SCTP this may result
837  * in NBIO events. If |clearbufs| is set then init_buf and the wbio buffer is
838  * freed up as well.
839  */
840 WORK_STATE tls_finish_handshake(SSL *s, WORK_STATE wst, int clearbufs)
841 {
842     void (*cb) (const SSL *ssl, int type, int val) = NULL;
843
844 #ifndef OPENSSL_NO_SCTP
845     if (SSL_IS_DTLS(s) && BIO_dgram_is_sctp(SSL_get_wbio(s))) {
846         WORK_STATE ret;
847         ret = dtls_wait_for_dry(s);
848         if (ret != WORK_FINISHED_CONTINUE)
849             return ret;
850     }
851 #endif
852
853     if (clearbufs) {
854         if (!SSL_IS_DTLS(s)) {
855             /*
856              * We don't do this in DTLS because we may still need the init_buf
857              * in case there are any unexpected retransmits
858              */
859             BUF_MEM_free(s->init_buf);
860             s->init_buf = NULL;
861         }
862         ssl_free_wbio_buffer(s);
863         s->init_num = 0;
864     }
865
866     if (s->statem.cleanuphand) {
867         /* skipped if we just sent a HelloRequest */
868         s->renegotiate = 0;
869         s->new_session = 0;
870         s->statem.cleanuphand = 0;
871
872         ssl3_cleanup_key_block(s);
873
874         if (s->server) {
875             ssl_update_cache(s, SSL_SESS_CACHE_SERVER);
876
877             s->ctx->stats.sess_accept_good++;
878             s->handshake_func = ossl_statem_accept;
879         } else {
880             ssl_update_cache(s, SSL_SESS_CACHE_CLIENT);
881             if (s->hit)
882                 s->ctx->stats.sess_hit++;
883
884             s->handshake_func = ossl_statem_connect;
885             s->ctx->stats.sess_connect_good++;
886         }
887
888         if (s->info_callback != NULL)
889             cb = s->info_callback;
890         else if (s->ctx->info_callback != NULL)
891             cb = s->ctx->info_callback;
892
893         if (cb != NULL)
894             cb(s, SSL_CB_HANDSHAKE_DONE, 1);
895
896         if (SSL_IS_DTLS(s)) {
897             /* done with handshaking */
898             s->d1->handshake_read_seq = 0;
899             s->d1->handshake_write_seq = 0;
900             s->d1->next_handshake_write_seq = 0;
901             dtls1_clear_received_buffer(s);
902         }
903     }
904
905     /*
906      * If we've not cleared the buffers its because we've got more work to do,
907      * so continue.
908      */
909     if (!clearbufs)
910         return WORK_FINISHED_CONTINUE;
911
912     return WORK_FINISHED_STOP;
913 }
914
915 int tls_get_message_header(SSL *s, int *mt)
916 {
917     /* s->init_num < SSL3_HM_HEADER_LENGTH */
918     int skip_message, i, recvd_type, al;
919     unsigned char *p;
920     size_t l, readbytes;
921
922     p = (unsigned char *)s->init_buf->data;
923
924     do {
925         while (s->init_num < SSL3_HM_HEADER_LENGTH) {
926             i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, &recvd_type,
927                                           &p[s->init_num],
928                                           SSL3_HM_HEADER_LENGTH - s->init_num,
929                                           0, &readbytes);
930             if (i <= 0) {
931                 s->rwstate = SSL_READING;
932                 return 0;
933             }
934             if (recvd_type == SSL3_RT_CHANGE_CIPHER_SPEC) {
935                 /*
936                  * A ChangeCipherSpec must be a single byte and may not occur
937                  * in the middle of a handshake message.
938                  */
939                 if (s->init_num != 0 || readbytes != 1 || p[0] != SSL3_MT_CCS) {
940                     al = SSL_AD_UNEXPECTED_MESSAGE;
941                     SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER,
942                            SSL_R_BAD_CHANGE_CIPHER_SPEC);
943                     goto f_err;
944                 }
945                 s->s3->tmp.message_type = *mt = SSL3_MT_CHANGE_CIPHER_SPEC;
946                 s->init_num = readbytes - 1;
947                 s->init_msg = s->init_buf->data;
948                 s->s3->tmp.message_size = readbytes;
949                 return 1;
950             } else if (recvd_type != SSL3_RT_HANDSHAKE) {
951                 al = SSL_AD_UNEXPECTED_MESSAGE;
952                 SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER, SSL_R_CCS_RECEIVED_EARLY);
953                 goto f_err;
954             }
955             s->init_num += readbytes;
956         }
957
958         skip_message = 0;
959         if (!s->server)
960             if (s->statem.hand_state != TLS_ST_OK
961                     && p[0] == SSL3_MT_HELLO_REQUEST)
962                 /*
963                  * The server may always send 'Hello Request' messages --
964                  * we are doing a handshake anyway now, so ignore them if
965                  * their format is correct. Does not count for 'Finished'
966                  * MAC.
967                  */
968                 if (p[1] == 0 && p[2] == 0 && p[3] == 0) {
969                     s->init_num = 0;
970                     skip_message = 1;
971
972                     if (s->msg_callback)
973                         s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE,
974                                         p, SSL3_HM_HEADER_LENGTH, s,
975                                         s->msg_callback_arg);
976                 }
977     } while (skip_message);
978     /* s->init_num == SSL3_HM_HEADER_LENGTH */
979
980     *mt = *p;
981     s->s3->tmp.message_type = *(p++);
982
983     if (RECORD_LAYER_is_sslv2_record(&s->rlayer)) {
984         /*
985          * Only happens with SSLv3+ in an SSLv2 backward compatible
986          * ClientHello
987          *
988          * Total message size is the remaining record bytes to read
989          * plus the SSL3_HM_HEADER_LENGTH bytes that we already read
990          */
991         l = RECORD_LAYER_get_rrec_length(&s->rlayer)
992             + SSL3_HM_HEADER_LENGTH;
993         s->s3->tmp.message_size = l;
994
995         s->init_msg = s->init_buf->data;
996         s->init_num = SSL3_HM_HEADER_LENGTH;
997     } else {
998         n2l3(p, l);
999         /* BUF_MEM_grow takes an 'int' parameter */
1000         if (l > (INT_MAX - SSL3_HM_HEADER_LENGTH)) {
1001             al = SSL_AD_ILLEGAL_PARAMETER;
1002             SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER, SSL_R_EXCESSIVE_MESSAGE_SIZE);
1003             goto f_err;
1004         }
1005         s->s3->tmp.message_size = l;
1006
1007         s->init_msg = s->init_buf->data + SSL3_HM_HEADER_LENGTH;
1008         s->init_num = 0;
1009     }
1010
1011     return 1;
1012  f_err:
1013     ssl3_send_alert(s, SSL3_AL_FATAL, al);
1014     return 0;
1015 }
1016
1017 int tls_get_message_body(SSL *s, size_t *len)
1018 {
1019     size_t n, readbytes;
1020     unsigned char *p;
1021     int i;
1022
1023     if (s->s3->tmp.message_type == SSL3_MT_CHANGE_CIPHER_SPEC) {
1024         /* We've already read everything in */
1025         *len = (unsigned long)s->init_num;
1026         return 1;
1027     }
1028
1029     p = s->init_msg;
1030     n = s->s3->tmp.message_size - s->init_num;
1031     while (n > 0) {
1032         i = s->method->ssl_read_bytes(s, SSL3_RT_HANDSHAKE, NULL,
1033                                       &p[s->init_num], n, 0, &readbytes);
1034         if (i <= 0) {
1035             s->rwstate = SSL_READING;
1036             *len = 0;
1037             return 0;
1038         }
1039         s->init_num += readbytes;
1040         n -= readbytes;
1041     }
1042
1043 #ifndef OPENSSL_NO_NEXTPROTONEG
1044     /*
1045      * If receiving Finished, record MAC of prior handshake messages for
1046      * Finished verification.
1047      */
1048     if (*s->init_buf->data == SSL3_MT_FINISHED)
1049         ssl3_take_mac(s);
1050 #endif
1051
1052     /* Feed this message into MAC computation. */
1053     if (RECORD_LAYER_is_sslv2_record(&s->rlayer)) {
1054         if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
1055                              s->init_num)) {
1056             SSLerr(SSL_F_TLS_GET_MESSAGE_BODY, ERR_R_EVP_LIB);
1057             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
1058             *len = 0;
1059             return 0;
1060         }
1061         if (s->msg_callback)
1062             s->msg_callback(0, SSL2_VERSION, 0, s->init_buf->data,
1063                             (size_t)s->init_num, s, s->msg_callback_arg);
1064     } else {
1065         if (!ssl3_finish_mac(s, (unsigned char *)s->init_buf->data,
1066                              s->init_num + SSL3_HM_HEADER_LENGTH)) {
1067             SSLerr(SSL_F_TLS_GET_MESSAGE_BODY, ERR_R_EVP_LIB);
1068             ssl3_send_alert(s, SSL3_AL_FATAL, SSL_AD_INTERNAL_ERROR);
1069             *len = 0;
1070             return 0;
1071         }
1072         if (s->msg_callback)
1073             s->msg_callback(0, s->version, SSL3_RT_HANDSHAKE, s->init_buf->data,
1074                             (size_t)s->init_num + SSL3_HM_HEADER_LENGTH, s,
1075                             s->msg_callback_arg);
1076     }
1077
1078     *len = s->init_num;
1079     return 1;
1080 }
1081
1082 int ssl_cert_type(const X509 *x, const EVP_PKEY *pk)
1083 {
1084     if (pk == NULL && (pk = X509_get0_pubkey(x)) == NULL)
1085         return -1;
1086
1087     switch (EVP_PKEY_id(pk)) {
1088     default:
1089         return -1;
1090     case EVP_PKEY_RSA:
1091         return SSL_PKEY_RSA;
1092     case EVP_PKEY_DSA:
1093         return SSL_PKEY_DSA_SIGN;
1094 #ifndef OPENSSL_NO_EC
1095     case EVP_PKEY_EC:
1096         return SSL_PKEY_ECC;
1097 #endif
1098 #ifndef OPENSSL_NO_GOST
1099     case NID_id_GostR3410_2001:
1100         return SSL_PKEY_GOST01;
1101     case NID_id_GostR3410_2012_256:
1102         return SSL_PKEY_GOST12_256;
1103     case NID_id_GostR3410_2012_512:
1104         return SSL_PKEY_GOST12_512;
1105 #endif
1106     }
1107 }
1108
1109 int ssl_verify_alarm_type(long type)
1110 {
1111     int al;
1112
1113     switch (type) {
1114     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT:
1115     case X509_V_ERR_UNABLE_TO_GET_CRL:
1116     case X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER:
1117         al = SSL_AD_UNKNOWN_CA;
1118         break;
1119     case X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE:
1120     case X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE:
1121     case X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY:
1122     case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD:
1123     case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD:
1124     case X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD:
1125     case X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD:
1126     case X509_V_ERR_CERT_NOT_YET_VALID:
1127     case X509_V_ERR_CRL_NOT_YET_VALID:
1128     case X509_V_ERR_CERT_UNTRUSTED:
1129     case X509_V_ERR_CERT_REJECTED:
1130     case X509_V_ERR_HOSTNAME_MISMATCH:
1131     case X509_V_ERR_EMAIL_MISMATCH:
1132     case X509_V_ERR_IP_ADDRESS_MISMATCH:
1133     case X509_V_ERR_DANE_NO_MATCH:
1134     case X509_V_ERR_EE_KEY_TOO_SMALL:
1135     case X509_V_ERR_CA_KEY_TOO_SMALL:
1136     case X509_V_ERR_CA_MD_TOO_WEAK:
1137         al = SSL_AD_BAD_CERTIFICATE;
1138         break;
1139     case X509_V_ERR_CERT_SIGNATURE_FAILURE:
1140     case X509_V_ERR_CRL_SIGNATURE_FAILURE:
1141         al = SSL_AD_DECRYPT_ERROR;
1142         break;
1143     case X509_V_ERR_CERT_HAS_EXPIRED:
1144     case X509_V_ERR_CRL_HAS_EXPIRED:
1145         al = SSL_AD_CERTIFICATE_EXPIRED;
1146         break;
1147     case X509_V_ERR_CERT_REVOKED:
1148         al = SSL_AD_CERTIFICATE_REVOKED;
1149         break;
1150     case X509_V_ERR_UNSPECIFIED:
1151     case X509_V_ERR_OUT_OF_MEM:
1152     case X509_V_ERR_INVALID_CALL:
1153     case X509_V_ERR_STORE_LOOKUP:
1154         al = SSL_AD_INTERNAL_ERROR;
1155         break;
1156     case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:
1157     case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN:
1158     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY:
1159     case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE:
1160     case X509_V_ERR_CERT_CHAIN_TOO_LONG:
1161     case X509_V_ERR_PATH_LENGTH_EXCEEDED:
1162     case X509_V_ERR_INVALID_CA:
1163         al = SSL_AD_UNKNOWN_CA;
1164         break;
1165     case X509_V_ERR_APPLICATION_VERIFICATION:
1166         al = SSL_AD_HANDSHAKE_FAILURE;
1167         break;
1168     case X509_V_ERR_INVALID_PURPOSE:
1169         al = SSL_AD_UNSUPPORTED_CERTIFICATE;
1170         break;
1171     default:
1172         al = SSL_AD_CERTIFICATE_UNKNOWN;
1173         break;
1174     }
1175     return (al);
1176 }
1177
1178 int ssl_allow_compression(SSL *s)
1179 {
1180     if (s->options & SSL_OP_NO_COMPRESSION)
1181         return 0;
1182     return ssl_security(s, SSL_SECOP_COMPRESSION, 0, 0, NULL);
1183 }
1184
1185 static int version_cmp(const SSL *s, int a, int b)
1186 {
1187     int dtls = SSL_IS_DTLS(s);
1188
1189     if (a == b)
1190         return 0;
1191     if (!dtls)
1192         return a < b ? -1 : 1;
1193     return DTLS_VERSION_LT(a, b) ? -1 : 1;
1194 }
1195
1196 typedef struct {
1197     int version;
1198     const SSL_METHOD *(*cmeth) (void);
1199     const SSL_METHOD *(*smeth) (void);
1200 } version_info;
1201
1202 #if TLS_MAX_VERSION != TLS1_3_VERSION
1203 # error Code needs update for TLS_method() support beyond TLS1_3_VERSION.
1204 #endif
1205
1206 static const version_info tls_version_table[] = {
1207 #ifndef OPENSSL_NO_TLS1_3
1208     {TLS1_3_VERSION, tlsv1_3_client_method, tlsv1_3_server_method},
1209 #else
1210     {TLS1_3_VERSION, NULL, NULL},
1211 #endif
1212 #ifndef OPENSSL_NO_TLS1_2
1213     {TLS1_2_VERSION, tlsv1_2_client_method, tlsv1_2_server_method},
1214 #else
1215     {TLS1_2_VERSION, NULL, NULL},
1216 #endif
1217 #ifndef OPENSSL_NO_TLS1_1
1218     {TLS1_1_VERSION, tlsv1_1_client_method, tlsv1_1_server_method},
1219 #else
1220     {TLS1_1_VERSION, NULL, NULL},
1221 #endif
1222 #ifndef OPENSSL_NO_TLS1
1223     {TLS1_VERSION, tlsv1_client_method, tlsv1_server_method},
1224 #else
1225     {TLS1_VERSION, NULL, NULL},
1226 #endif
1227 #ifndef OPENSSL_NO_SSL3
1228     {SSL3_VERSION, sslv3_client_method, sslv3_server_method},
1229 #else
1230     {SSL3_VERSION, NULL, NULL},
1231 #endif
1232     {0, NULL, NULL},
1233 };
1234
1235 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
1236 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
1237 #endif
1238
1239 static const version_info dtls_version_table[] = {
1240 #ifndef OPENSSL_NO_DTLS1_2
1241     {DTLS1_2_VERSION, dtlsv1_2_client_method, dtlsv1_2_server_method},
1242 #else
1243     {DTLS1_2_VERSION, NULL, NULL},
1244 #endif
1245 #ifndef OPENSSL_NO_DTLS1
1246     {DTLS1_VERSION, dtlsv1_client_method, dtlsv1_server_method},
1247     {DTLS1_BAD_VER, dtls_bad_ver_client_method, NULL},
1248 #else
1249     {DTLS1_VERSION, NULL, NULL},
1250     {DTLS1_BAD_VER, NULL, NULL},
1251 #endif
1252     {0, NULL, NULL},
1253 };
1254
1255 /*
1256  * ssl_method_error - Check whether an SSL_METHOD is enabled.
1257  *
1258  * @s: The SSL handle for the candidate method
1259  * @method: the intended method.
1260  *
1261  * Returns 0 on success, or an SSL error reason on failure.
1262  */
1263 static int ssl_method_error(const SSL *s, const SSL_METHOD *method)
1264 {
1265     int version = method->version;
1266
1267     if ((s->min_proto_version != 0 &&
1268          version_cmp(s, version, s->min_proto_version) < 0) ||
1269         ssl_security(s, SSL_SECOP_VERSION, 0, version, NULL) == 0)
1270         return SSL_R_VERSION_TOO_LOW;
1271
1272     if (s->max_proto_version != 0 &&
1273         version_cmp(s, version, s->max_proto_version) > 0)
1274         return SSL_R_VERSION_TOO_HIGH;
1275
1276     if ((s->options & method->mask) != 0)
1277         return SSL_R_UNSUPPORTED_PROTOCOL;
1278     if ((method->flags & SSL_METHOD_NO_SUITEB) != 0 && tls1_suiteb(s))
1279         return SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE;
1280     else if ((method->flags & SSL_METHOD_NO_FIPS) != 0 && FIPS_mode())
1281         return SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE;
1282
1283     return 0;
1284 }
1285
1286 /*
1287  * ssl_version_supported - Check that the specified `version` is supported by
1288  * `SSL *` instance
1289  *
1290  * @s: The SSL handle for the candidate method
1291  * @version: Protocol version to test against
1292  *
1293  * Returns 1 when supported, otherwise 0
1294  */
1295 int ssl_version_supported(const SSL *s, int version)
1296 {
1297     const version_info *vent;
1298     const version_info *table;
1299
1300     switch (s->method->version) {
1301     default:
1302         /* Version should match method version for non-ANY method */
1303         return version_cmp(s, version, s->version) == 0;
1304     case TLS_ANY_VERSION:
1305         table = tls_version_table;
1306         break;
1307     case DTLS_ANY_VERSION:
1308         table = dtls_version_table;
1309         break;
1310     }
1311
1312     for (vent = table;
1313          vent->version != 0 && version_cmp(s, version, vent->version) <= 0;
1314          ++vent) {
1315         if (vent->cmeth != NULL &&
1316             version_cmp(s, version, vent->version) == 0 &&
1317             ssl_method_error(s, vent->cmeth()) == 0) {
1318             return 1;
1319         }
1320     }
1321     return 0;
1322 }
1323
1324 /*
1325  * ssl_check_version_downgrade - In response to RFC7507 SCSV version
1326  * fallback indication from a client check whether we're using the highest
1327  * supported protocol version.
1328  *
1329  * @s server SSL handle.
1330  *
1331  * Returns 1 when using the highest enabled version, 0 otherwise.
1332  */
1333 int ssl_check_version_downgrade(SSL *s)
1334 {
1335     const version_info *vent;
1336     const version_info *table;
1337
1338     /*
1339      * Check that the current protocol is the highest enabled version
1340      * (according to s->ctx->method, as version negotiation may have changed
1341      * s->method).
1342      */
1343     if (s->version == s->ctx->method->version)
1344         return 1;
1345
1346     /*
1347      * Apparently we're using a version-flexible SSL_METHOD (not at its
1348      * highest protocol version).
1349      */
1350     if (s->ctx->method->version == TLS_method()->version)
1351         table = tls_version_table;
1352     else if (s->ctx->method->version == DTLS_method()->version)
1353         table = dtls_version_table;
1354     else {
1355         /* Unexpected state; fail closed. */
1356         return 0;
1357     }
1358
1359     for (vent = table; vent->version != 0; ++vent) {
1360         if (vent->smeth != NULL && ssl_method_error(s, vent->smeth()) == 0)
1361             return s->version == vent->version;
1362     }
1363     return 0;
1364 }
1365
1366 /*
1367  * ssl_set_version_bound - set an upper or lower bound on the supported (D)TLS
1368  * protocols, provided the initial (D)TLS method is version-flexible.  This
1369  * function sanity-checks the proposed value and makes sure the method is
1370  * version-flexible, then sets the limit if all is well.
1371  *
1372  * @method_version: The version of the current SSL_METHOD.
1373  * @version: the intended limit.
1374  * @bound: pointer to limit to be updated.
1375  *
1376  * Returns 1 on success, 0 on failure.
1377  */
1378 int ssl_set_version_bound(int method_version, int version, int *bound)
1379 {
1380     if (version == 0) {
1381         *bound = version;
1382         return 1;
1383     }
1384
1385     /*-
1386      * Restrict TLS methods to TLS protocol versions.
1387      * Restrict DTLS methods to DTLS protocol versions.
1388      * Note, DTLS version numbers are decreasing, use comparison macros.
1389      *
1390      * Note that for both lower-bounds we use explicit versions, not
1391      * (D)TLS_MIN_VERSION.  This is because we don't want to break user
1392      * configurations.  If the MIN (supported) version ever rises, the user's
1393      * "floor" remains valid even if no longer available.  We don't expect the
1394      * MAX ceiling to ever get lower, so making that variable makes sense.
1395      */
1396     switch (method_version) {
1397     default:
1398         /*
1399          * XXX For fixed version methods, should we always fail and not set any
1400          * bounds, always succeed and not set any bounds, or set the bounds and
1401          * arrange to fail later if they are not met?  At present fixed-version
1402          * methods are not subject to controls that disable individual protocol
1403          * versions.
1404          */
1405         return 0;
1406
1407     case TLS_ANY_VERSION:
1408         if (version < SSL3_VERSION || version > TLS_MAX_VERSION)
1409             return 0;
1410         break;
1411
1412     case DTLS_ANY_VERSION:
1413         if (DTLS_VERSION_GT(version, DTLS_MAX_VERSION) ||
1414             DTLS_VERSION_LT(version, DTLS1_BAD_VER))
1415             return 0;
1416         break;
1417     }
1418
1419     *bound = version;
1420     return 1;
1421 }
1422
1423 /*
1424  * ssl_choose_server_version - Choose server (D)TLS version.  Called when the
1425  * client HELLO is received to select the final server protocol version and
1426  * the version specific method.
1427  *
1428  * @s: server SSL handle.
1429  *
1430  * Returns 0 on success or an SSL error reason number on failure.
1431  */
1432 int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello)
1433 {
1434     /*-
1435      * With version-flexible methods we have an initial state with:
1436      *
1437      *   s->method->version == (D)TLS_ANY_VERSION,
1438      *   s->version == (D)TLS_MAX_VERSION.
1439      *
1440      * So we detect version-flexible methods via the method version, not the
1441      * handle version.
1442      */
1443     int server_version = s->method->version;
1444     int client_version = hello->legacy_version;
1445     const version_info *vent;
1446     const version_info *table;
1447     int disabled = 0;
1448     RAW_EXTENSION *suppversions;
1449
1450     s->client_version = client_version;
1451
1452     switch (server_version) {
1453     default:
1454         if (!SSL_IS_TLS13(s)) {
1455             if (version_cmp(s, client_version, s->version) < 0)
1456                 return SSL_R_WRONG_SSL_VERSION;
1457             /*
1458              * If this SSL handle is not from a version flexible method we don't
1459              * (and never did) check min/max FIPS or Suite B constraints.  Hope
1460              * that's OK.  It is up to the caller to not choose fixed protocol
1461              * versions they don't want.  If not, then easy to fix, just return
1462              * ssl_method_error(s, s->method)
1463              */
1464             return 0;
1465         }
1466         /*
1467          * Fall through if we are TLSv1.3 already (this means we must be after
1468          * a HelloRetryRequest
1469          */
1470     case TLS_ANY_VERSION:
1471         table = tls_version_table;
1472         break;
1473     case DTLS_ANY_VERSION:
1474         table = dtls_version_table;
1475         break;
1476     }
1477
1478     suppversions = &hello->pre_proc_exts[TLSEXT_IDX_supported_versions];
1479
1480     if (suppversions->present && !SSL_IS_DTLS(s)) {
1481         unsigned int candidate_vers = 0;
1482         unsigned int best_vers = 0;
1483         const SSL_METHOD *best_method = NULL;
1484         PACKET versionslist;
1485
1486         suppversions->parsed = 1;
1487
1488         if (!PACKET_as_length_prefixed_1(&suppversions->data, &versionslist)) {
1489             /* Trailing or invalid data? */
1490             return SSL_R_LENGTH_MISMATCH;
1491         }
1492
1493         while (PACKET_get_net_2(&versionslist, &candidate_vers)) {
1494             /* TODO(TLS1.3): Remove this before release */
1495             if (candidate_vers == TLS1_3_VERSION_DRAFT)
1496                 candidate_vers = TLS1_3_VERSION;
1497             /*
1498              * TODO(TLS1.3): There is some discussion on the TLS list about
1499              * wheter to ignore versions <TLS1.2 in supported_versions. At the
1500              * moment we honour them if present. To be reviewed later
1501              */
1502             if (version_cmp(s, candidate_vers, best_vers) <= 0)
1503                 continue;
1504             for (vent = table;
1505                  vent->version != 0 && vent->version != (int)candidate_vers;
1506                  ++vent)
1507                 continue;
1508             if (vent->version != 0 && vent->smeth != NULL) {
1509                 const SSL_METHOD *method;
1510
1511                 method = vent->smeth();
1512                 if (ssl_method_error(s, method) == 0) {
1513                     best_vers = candidate_vers;
1514                     best_method = method;
1515                 }
1516             }
1517         }
1518         if (PACKET_remaining(&versionslist) != 0) {
1519             /* Trailing data? */
1520             return SSL_R_LENGTH_MISMATCH;
1521         }
1522
1523         if (best_vers > 0) {
1524             if (SSL_IS_TLS13(s)) {
1525                 /*
1526                  * We get here if this is after a HelloRetryRequest. In this
1527                  * case we just check that we still negotiated TLSv1.3
1528                  */
1529                 if (best_vers != TLS1_3_VERSION)
1530                     return SSL_R_UNSUPPORTED_PROTOCOL;
1531                 return 0;
1532             }
1533             s->version = best_vers;
1534             s->method = best_method;
1535             return 0;
1536         }
1537         return SSL_R_UNSUPPORTED_PROTOCOL;
1538     }
1539
1540     /*
1541      * If the supported versions extension isn't present, then the highest
1542      * version we can negotiate is TLSv1.2
1543      */
1544     if (version_cmp(s, client_version, TLS1_3_VERSION) >= 0)
1545         client_version = TLS1_2_VERSION;
1546
1547     /*
1548      * No supported versions extension, so we just use the version supplied in
1549      * the ClientHello.
1550      */
1551     for (vent = table; vent->version != 0; ++vent) {
1552         const SSL_METHOD *method;
1553
1554         if (vent->smeth == NULL ||
1555             version_cmp(s, client_version, vent->version) < 0)
1556             continue;
1557         method = vent->smeth();
1558         if (ssl_method_error(s, method) == 0) {
1559             s->version = vent->version;
1560             s->method = method;
1561             return 0;
1562         }
1563         disabled = 1;
1564     }
1565     return disabled ? SSL_R_UNSUPPORTED_PROTOCOL : SSL_R_VERSION_TOO_LOW;
1566 }
1567
1568 /*
1569  * ssl_choose_client_version - Choose client (D)TLS version.  Called when the
1570  * server HELLO is received to select the final client protocol version and
1571  * the version specific method.
1572  *
1573  * @s: client SSL handle.
1574  * @version: The proposed version from the server's HELLO.
1575  *
1576  * Returns 0 on success or an SSL error reason number on failure.
1577  */
1578 int ssl_choose_client_version(SSL *s, int version)
1579 {
1580     const version_info *vent;
1581     const version_info *table;
1582
1583     /* TODO(TLS1.3): Remove this before release */
1584     if (version == TLS1_3_VERSION_DRAFT)
1585         version = TLS1_3_VERSION;
1586
1587     switch (s->method->version) {
1588     default:
1589         if (version != s->version)
1590             return SSL_R_WRONG_SSL_VERSION;
1591         /*
1592          * If this SSL handle is not from a version flexible method we don't
1593          * (and never did) check min/max, FIPS or Suite B constraints.  Hope
1594          * that's OK.  It is up to the caller to not choose fixed protocol
1595          * versions they don't want.  If not, then easy to fix, just return
1596          * ssl_method_error(s, s->method)
1597          */
1598         return 0;
1599     case TLS_ANY_VERSION:
1600         table = tls_version_table;
1601         break;
1602     case DTLS_ANY_VERSION:
1603         table = dtls_version_table;
1604         break;
1605     }
1606
1607     for (vent = table; vent->version != 0; ++vent) {
1608         const SSL_METHOD *method;
1609         int err;
1610
1611         if (version != vent->version)
1612             continue;
1613         if (vent->cmeth == NULL)
1614             break;
1615         if (s->hello_retry_request && version != TLS1_3_VERSION)
1616             return SSL_R_WRONG_SSL_VERSION;
1617
1618         method = vent->cmeth();
1619         err = ssl_method_error(s, method);
1620         if (err != 0)
1621             return err;
1622         s->method = method;
1623         s->version = version;
1624         return 0;
1625     }
1626
1627     return SSL_R_UNSUPPORTED_PROTOCOL;
1628 }
1629
1630 /*
1631  * ssl_get_client_min_max_version - get minimum and maximum client version
1632  * @s: The SSL connection
1633  * @min_version: The minimum supported version
1634  * @max_version: The maximum supported version
1635  *
1636  * Work out what version we should be using for the initial ClientHello if the
1637  * version is initially (D)TLS_ANY_VERSION.  We apply any explicit SSL_OP_NO_xxx
1638  * options, the MinProtocol and MaxProtocol configuration commands, any Suite B
1639  * or FIPS_mode() constraints and any floor imposed by the security level here,
1640  * so we don't advertise the wrong protocol version to only reject the outcome later.
1641  *
1642  * Computing the right floor matters.  If, e.g., TLS 1.0 and 1.2 are enabled,
1643  * TLS 1.1 is disabled, but the security level, Suite-B  and/or MinProtocol
1644  * only allow TLS 1.2, we want to advertise TLS1.2, *not* TLS1.
1645  *
1646  * Returns 0 on success or an SSL error reason number on failure.  On failure
1647  * min_version and max_version will also be set to 0.
1648  */
1649 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
1650                                    int *max_version)
1651 {
1652     int version;
1653     int hole;
1654     const SSL_METHOD *single = NULL;
1655     const SSL_METHOD *method;
1656     const version_info *table;
1657     const version_info *vent;
1658
1659     switch (s->method->version) {
1660     default:
1661         /*
1662          * If this SSL handle is not from a version flexible method we don't
1663          * (and never did) check min/max FIPS or Suite B constraints.  Hope
1664          * that's OK.  It is up to the caller to not choose fixed protocol
1665          * versions they don't want.  If not, then easy to fix, just return
1666          * ssl_method_error(s, s->method)
1667          */
1668         *min_version = *max_version = s->version;
1669         return 0;
1670     case TLS_ANY_VERSION:
1671         table = tls_version_table;
1672         break;
1673     case DTLS_ANY_VERSION:
1674         table = dtls_version_table;
1675         break;
1676     }
1677
1678     /*
1679      * SSL_OP_NO_X disables all protocols above X *if* there are some protocols
1680      * below X enabled. This is required in order to maintain the "version
1681      * capability" vector contiguous. Any versions with a NULL client method
1682      * (protocol version client is disabled at compile-time) is also a "hole".
1683      *
1684      * Our initial state is hole == 1, version == 0.  That is, versions above
1685      * the first version in the method table are disabled (a "hole" above
1686      * the valid protocol entries) and we don't have a selected version yet.
1687      *
1688      * Whenever "hole == 1", and we hit an enabled method, its version becomes
1689      * the selected version, and the method becomes a candidate "single"
1690      * method.  We're no longer in a hole, so "hole" becomes 0.
1691      *
1692      * If "hole == 0" and we hit an enabled method, then "single" is cleared,
1693      * as we support a contiguous range of at least two methods.  If we hit
1694      * a disabled method, then hole becomes true again, but nothing else
1695      * changes yet, because all the remaining methods may be disabled too.
1696      * If we again hit an enabled method after the new hole, it becomes
1697      * selected, as we start from scratch.
1698      */
1699     *min_version = version = 0;
1700     hole = 1;
1701     for (vent = table; vent->version != 0; ++vent) {
1702         /*
1703          * A table entry with a NULL client method is still a hole in the
1704          * "version capability" vector.
1705          */
1706         if (vent->cmeth == NULL) {
1707             hole = 1;
1708             continue;
1709         }
1710         method = vent->cmeth();
1711         if (ssl_method_error(s, method) != 0) {
1712             hole = 1;
1713         } else if (!hole) {
1714             single = NULL;
1715             *min_version = method->version;
1716         } else {
1717             version = (single = method)->version;
1718             *min_version = version;
1719             hole = 0;
1720         }
1721     }
1722
1723     *max_version = version;
1724
1725     /* Fail if everything is disabled */
1726     if (version == 0)
1727         return SSL_R_NO_PROTOCOLS_AVAILABLE;
1728
1729     return 0;
1730 }
1731
1732 /*
1733  * ssl_set_client_hello_version - Work out what version we should be using for
1734  * the initial ClientHello.legacy_version field.
1735  *
1736  * @s: client SSL handle.
1737  *
1738  * Returns 0 on success or an SSL error reason number on failure.
1739  */
1740 int ssl_set_client_hello_version(SSL *s)
1741 {
1742     int ver_min, ver_max, ret;
1743
1744     ret = ssl_get_client_min_max_version(s, &ver_min, &ver_max);
1745
1746     if (ret != 0)
1747         return ret;
1748
1749     s->version = ver_max;
1750
1751     /* TLS1.3 always uses TLS1.2 in the legacy_version field */
1752     if (!SSL_IS_DTLS(s) && ver_max > TLS1_2_VERSION)
1753         ver_max = TLS1_2_VERSION;
1754
1755     s->client_version = ver_max;
1756     return 0;
1757 }
1758
1759 /*
1760  * Checks a list of |groups| to determine if the |group_id| is in it. If it is
1761  * and |checkallow| is 1 then additionally check if the group is allowed to be
1762  * used. Returns 1 if the group is in the list (and allowed if |checkallow| is
1763  * 1) or 0 otherwise.
1764  */
1765 #ifndef OPENSSL_NO_EC
1766 int check_in_list(SSL *s, unsigned int group_id, const unsigned char *groups,
1767                   size_t num_groups, int checkallow)
1768 {
1769     size_t i;
1770
1771     if (groups == NULL || num_groups == 0)
1772         return 0;
1773
1774     for (i = 0; i < num_groups; i++, groups += 2) {
1775         unsigned int share_id = (groups[0] << 8) | (groups[1]);
1776
1777         if (group_id == share_id
1778                 && (!checkallow
1779                     || tls_curve_allowed(s, groups, SSL_SECOP_CURVE_CHECK))) {
1780             break;
1781         }
1782     }
1783
1784     /* If i == num_groups then not in the list */
1785     return i < num_groups;
1786 }
1787 #endif