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