2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
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
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.
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>
27 * send s->init_buf in records of type 'type' (SSL3_RT_HANDSHAKE or
28 * SSL3_RT_CHANGE_CIPHER_SPEC)
30 int ssl3_do_write(SSL
*s
, int type
)
35 ret
= ssl3_write_bytes(s
, type
, &s
->init_buf
->data
[s
->init_off
],
36 s
->init_num
, &written
);
39 if (type
== SSL3_RT_HANDSHAKE
)
41 * should not be done for 'Hello Request's, but in that case we'll
42 * ignore the result anyway
44 if (!ssl3_finish_mac(s
,
45 (unsigned char *)&s
->init_buf
->data
[s
->init_off
],
49 if (written
== s
->init_num
) {
51 s
->msg_callback(1, s
->version
, type
, s
->init_buf
->data
,
52 (size_t)(s
->init_off
+ s
->init_num
), s
,
56 s
->init_off
+= written
;
57 s
->init_num
-= written
;
61 int tls_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
)
65 if ((htype
!= SSL3_MT_CHANGE_CIPHER_SPEC
&& !WPACKET_close(pkt
))
66 || !WPACKET_get_length(pkt
, &msglen
)
69 s
->init_num
= (int)msglen
;
75 int tls_construct_finished(SSL
*s
, WPACKET
*pkt
)
82 sender
= s
->method
->ssl3_enc
->server_finished_label
;
83 slen
= s
->method
->ssl3_enc
->server_finished_label_len
;
85 sender
= s
->method
->ssl3_enc
->client_finished_label
;
86 slen
= s
->method
->ssl3_enc
->client_finished_label_len
;
89 finish_md_len
= s
->method
->ssl3_enc
->final_finish_mac(s
,
91 s
->s3
->tmp
.finish_md
);
92 if (finish_md_len
== 0) {
93 SSLerr(SSL_F_TLS_CONSTRUCT_FINISHED
, ERR_R_INTERNAL_ERROR
);
97 s
->s3
->tmp
.finish_md_len
= finish_md_len
;
99 if (!WPACKET_memcpy(pkt
, s
->s3
->tmp
.finish_md
, finish_md_len
)) {
100 SSLerr(SSL_F_TLS_CONSTRUCT_FINISHED
, ERR_R_INTERNAL_ERROR
);
105 * Copy the finished so we can use it for renegotiation checks
108 OPENSSL_assert(finish_md_len
<= EVP_MAX_MD_SIZE
);
109 memcpy(s
->s3
->previous_client_finished
, s
->s3
->tmp
.finish_md
,
111 s
->s3
->previous_client_finished_len
= finish_md_len
;
113 OPENSSL_assert(finish_md_len
<= EVP_MAX_MD_SIZE
);
114 memcpy(s
->s3
->previous_server_finished
, s
->s3
->tmp
.finish_md
,
116 s
->s3
->previous_server_finished_len
= finish_md_len
;
121 ssl3_send_alert(s
, SSL3_AL_FATAL
, SSL_AD_INTERNAL_ERROR
);
125 #ifndef OPENSSL_NO_NEXTPROTONEG
127 * ssl3_take_mac calculates the Finished MAC for the handshakes messages seen
130 static void ssl3_take_mac(SSL
*s
)
135 * If no new cipher setup return immediately: other functions will set
136 * the appropriate error.
138 if (s
->s3
->tmp
.new_cipher
== NULL
)
141 sender
= s
->method
->ssl3_enc
->server_finished_label
;
142 slen
= s
->method
->ssl3_enc
->server_finished_label_len
;
144 sender
= s
->method
->ssl3_enc
->client_finished_label
;
145 slen
= s
->method
->ssl3_enc
->client_finished_label_len
;
148 s
->s3
->tmp
.peer_finish_md_len
= s
->method
->ssl3_enc
->final_finish_mac(s
,
151 s
->s3
->tmp
.peer_finish_md
);
155 MSG_PROCESS_RETURN
tls_process_change_cipher_spec(SSL
*s
, PACKET
*pkt
)
160 remain
= PACKET_remaining(pkt
);
162 * 'Change Cipher Spec' is just a single byte, which should already have
163 * been consumed by ssl_get_message() so there should be no bytes left,
164 * unless we're using DTLS1_BAD_VER, which has an extra 2 bytes
166 if (SSL_IS_DTLS(s
)) {
167 if ((s
->version
== DTLS1_BAD_VER
168 && remain
!= DTLS1_CCS_HEADER_LENGTH
+ 1)
169 || (s
->version
!= DTLS1_BAD_VER
170 && remain
!= DTLS1_CCS_HEADER_LENGTH
- 1)) {
171 al
= SSL_AD_ILLEGAL_PARAMETER
;
172 SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC
,
173 SSL_R_BAD_CHANGE_CIPHER_SPEC
);
178 al
= SSL_AD_ILLEGAL_PARAMETER
;
179 SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC
,
180 SSL_R_BAD_CHANGE_CIPHER_SPEC
);
185 /* Check we have a cipher to change to */
186 if (s
->s3
->tmp
.new_cipher
== NULL
) {
187 al
= SSL_AD_UNEXPECTED_MESSAGE
;
188 SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC
, SSL_R_CCS_RECEIVED_EARLY
);
192 s
->s3
->change_cipher_spec
= 1;
193 if (!ssl3_do_change_cipher_spec(s
)) {
194 al
= SSL_AD_INTERNAL_ERROR
;
195 SSLerr(SSL_F_TLS_PROCESS_CHANGE_CIPHER_SPEC
, ERR_R_INTERNAL_ERROR
);
199 if (SSL_IS_DTLS(s
)) {
200 dtls1_reset_seq_numbers(s
, SSL3_CC_READ
);
202 if (s
->version
== DTLS1_BAD_VER
)
203 s
->d1
->handshake_read_seq
++;
205 #ifndef OPENSSL_NO_SCTP
207 * Remember that a CCS has been received, so that an old key of
208 * SCTP-Auth can be deleted when a CCS is sent. Will be ignored if no
211 BIO_ctrl(SSL_get_wbio(s
), BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD
, 1, NULL
);
215 return MSG_PROCESS_CONTINUE_READING
;
217 ssl3_send_alert(s
, SSL3_AL_FATAL
, al
);
218 ossl_statem_set_error(s
);
219 return MSG_PROCESS_ERROR
;
222 MSG_PROCESS_RETURN
tls_process_finished(SSL
*s
, PACKET
*pkt
)
227 /* If this occurs, we have missed a message */
228 if (!s
->s3
->change_cipher_spec
) {
229 al
= SSL_AD_UNEXPECTED_MESSAGE
;
230 SSLerr(SSL_F_TLS_PROCESS_FINISHED
, SSL_R_GOT_A_FIN_BEFORE_A_CCS
);
233 s
->s3
->change_cipher_spec
= 0;
235 md_len
= s
->s3
->tmp
.peer_finish_md_len
;
237 if (md_len
!= PACKET_remaining(pkt
)) {
238 al
= SSL_AD_DECODE_ERROR
;
239 SSLerr(SSL_F_TLS_PROCESS_FINISHED
, SSL_R_BAD_DIGEST_LENGTH
);
243 if (CRYPTO_memcmp(PACKET_data(pkt
), s
->s3
->tmp
.peer_finish_md
,
245 al
= SSL_AD_DECRYPT_ERROR
;
246 SSLerr(SSL_F_TLS_PROCESS_FINISHED
, SSL_R_DIGEST_CHECK_FAILED
);
251 * Copy the finished so we can use it for renegotiation checks
254 OPENSSL_assert(md_len
<= EVP_MAX_MD_SIZE
);
255 memcpy(s
->s3
->previous_client_finished
, s
->s3
->tmp
.peer_finish_md
,
257 s
->s3
->previous_client_finished_len
= md_len
;
259 OPENSSL_assert(md_len
<= EVP_MAX_MD_SIZE
);
260 memcpy(s
->s3
->previous_server_finished
, s
->s3
->tmp
.peer_finish_md
,
262 s
->s3
->previous_server_finished_len
= md_len
;
265 return MSG_PROCESS_FINISHED_READING
;
267 ssl3_send_alert(s
, SSL3_AL_FATAL
, al
);
268 ossl_statem_set_error(s
);
269 return MSG_PROCESS_ERROR
;
272 int tls_construct_change_cipher_spec(SSL
*s
, WPACKET
*pkt
)
274 if (!WPACKET_put_bytes_u8(pkt
, SSL3_MT_CCS
)) {
275 SSLerr(SSL_F_TLS_CONSTRUCT_CHANGE_CIPHER_SPEC
, ERR_R_INTERNAL_ERROR
);
276 ssl3_send_alert(s
, SSL3_AL_FATAL
, SSL_AD_INTERNAL_ERROR
);
283 unsigned long ssl3_output_cert_chain(SSL
*s
, WPACKET
*pkt
, CERT_PKEY
*cpk
)
285 if (!WPACKET_start_sub_packet_u24(pkt
)
286 || !ssl_add_cert_chain(s
, pkt
, cpk
)
287 || !WPACKET_close(pkt
)) {
288 SSLerr(SSL_F_SSL3_OUTPUT_CERT_CHAIN
, ERR_R_INTERNAL_ERROR
);
294 WORK_STATE
tls_finish_handshake(SSL
*s
, WORK_STATE wst
)
296 void (*cb
) (const SSL
*ssl
, int type
, int val
) = NULL
;
298 #ifndef OPENSSL_NO_SCTP
299 if (SSL_IS_DTLS(s
) && BIO_dgram_is_sctp(SSL_get_wbio(s
))) {
301 ret
= dtls_wait_for_dry(s
);
302 if (ret
!= WORK_FINISHED_CONTINUE
)
307 /* clean a few things up */
308 ssl3_cleanup_key_block(s
);
310 if (!SSL_IS_DTLS(s
)) {
312 * We don't do this in DTLS because we may still need the init_buf
313 * in case there are any unexpected retransmits
315 BUF_MEM_free(s
->init_buf
);
319 ssl_free_wbio_buffer(s
);
323 if (!s
->server
|| s
->renegotiate
== 2) {
324 /* skipped if we just sent a HelloRequest */
329 ssl_update_cache(s
, SSL_SESS_CACHE_SERVER
);
331 s
->ctx
->stats
.sess_accept_good
++;
332 s
->handshake_func
= ossl_statem_accept
;
334 ssl_update_cache(s
, SSL_SESS_CACHE_CLIENT
);
336 s
->ctx
->stats
.sess_hit
++;
338 s
->handshake_func
= ossl_statem_connect
;
339 s
->ctx
->stats
.sess_connect_good
++;
342 if (s
->info_callback
!= NULL
)
343 cb
= s
->info_callback
;
344 else if (s
->ctx
->info_callback
!= NULL
)
345 cb
= s
->ctx
->info_callback
;
348 cb(s
, SSL_CB_HANDSHAKE_DONE
, 1);
350 if (SSL_IS_DTLS(s
)) {
351 /* done with handshaking */
352 s
->d1
->handshake_read_seq
= 0;
353 s
->d1
->handshake_write_seq
= 0;
354 s
->d1
->next_handshake_write_seq
= 0;
355 dtls1_clear_received_buffer(s
);
359 return WORK_FINISHED_STOP
;
362 int tls_get_message_header(SSL
*s
, int *mt
)
364 /* s->init_num < SSL3_HM_HEADER_LENGTH */
365 int skip_message
, i
, recvd_type
, al
;
369 p
= (unsigned char *)s
->init_buf
->data
;
372 while (s
->init_num
< SSL3_HM_HEADER_LENGTH
) {
373 i
= s
->method
->ssl_read_bytes(s
, SSL3_RT_HANDSHAKE
, &recvd_type
,
375 SSL3_HM_HEADER_LENGTH
- s
->init_num
,
378 s
->rwstate
= SSL_READING
;
381 if (recvd_type
== SSL3_RT_CHANGE_CIPHER_SPEC
) {
383 * A ChangeCipherSpec must be a single byte and may not occur
384 * in the middle of a handshake message.
386 if (s
->init_num
!= 0 || read
!= 1 || p
[0] != SSL3_MT_CCS
) {
387 al
= SSL_AD_UNEXPECTED_MESSAGE
;
388 SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER
,
389 SSL_R_BAD_CHANGE_CIPHER_SPEC
);
392 s
->s3
->tmp
.message_type
= *mt
= SSL3_MT_CHANGE_CIPHER_SPEC
;
393 s
->init_num
= read
- 1;
394 s
->s3
->tmp
.message_size
= read
;
396 } else if (recvd_type
!= SSL3_RT_HANDSHAKE
) {
397 al
= SSL_AD_UNEXPECTED_MESSAGE
;
398 SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER
, SSL_R_CCS_RECEIVED_EARLY
);
406 if (p
[0] == SSL3_MT_HELLO_REQUEST
)
408 * The server may always send 'Hello Request' messages --
409 * we are doing a handshake anyway now, so ignore them if
410 * their format is correct. Does not count for 'Finished'
413 if (p
[1] == 0 && p
[2] == 0 && p
[3] == 0) {
418 s
->msg_callback(0, s
->version
, SSL3_RT_HANDSHAKE
,
419 p
, SSL3_HM_HEADER_LENGTH
, s
,
420 s
->msg_callback_arg
);
422 } while (skip_message
);
423 /* s->init_num == SSL3_HM_HEADER_LENGTH */
426 s
->s3
->tmp
.message_type
= *(p
++);
428 if (RECORD_LAYER_is_sslv2_record(&s
->rlayer
)) {
430 * Only happens with SSLv3+ in an SSLv2 backward compatible
433 * Total message size is the remaining record bytes to read
434 * plus the SSL3_HM_HEADER_LENGTH bytes that we already read
436 l
= RECORD_LAYER_get_rrec_length(&s
->rlayer
)
437 + SSL3_HM_HEADER_LENGTH
;
438 s
->s3
->tmp
.message_size
= l
;
440 s
->init_msg
= s
->init_buf
->data
;
441 s
->init_num
= SSL3_HM_HEADER_LENGTH
;
444 /* BUF_MEM_grow takes an 'int' parameter */
445 if (l
> (INT_MAX
- SSL3_HM_HEADER_LENGTH
)) {
446 al
= SSL_AD_ILLEGAL_PARAMETER
;
447 SSLerr(SSL_F_TLS_GET_MESSAGE_HEADER
, SSL_R_EXCESSIVE_MESSAGE_SIZE
);
450 s
->s3
->tmp
.message_size
= l
;
452 s
->init_msg
= s
->init_buf
->data
+ SSL3_HM_HEADER_LENGTH
;
458 ssl3_send_alert(s
, SSL3_AL_FATAL
, al
);
462 int tls_get_message_body(SSL
*s
, size_t *len
)
468 if (s
->s3
->tmp
.message_type
== SSL3_MT_CHANGE_CIPHER_SPEC
) {
469 /* We've already read everything in */
470 *len
= (unsigned long)s
->init_num
;
475 n
= s
->s3
->tmp
.message_size
- s
->init_num
;
477 i
= s
->method
->ssl_read_bytes(s
, SSL3_RT_HANDSHAKE
, NULL
,
478 &p
[s
->init_num
], n
, 0, &read
);
480 s
->rwstate
= SSL_READING
;
488 #ifndef OPENSSL_NO_NEXTPROTONEG
490 * If receiving Finished, record MAC of prior handshake messages for
491 * Finished verification.
493 if (*s
->init_buf
->data
== SSL3_MT_FINISHED
)
497 /* Feed this message into MAC computation. */
498 if (RECORD_LAYER_is_sslv2_record(&s
->rlayer
)) {
499 if (!ssl3_finish_mac(s
, (unsigned char *)s
->init_buf
->data
,
501 SSLerr(SSL_F_TLS_GET_MESSAGE_BODY
, ERR_R_EVP_LIB
);
502 ssl3_send_alert(s
, SSL3_AL_FATAL
, SSL_AD_INTERNAL_ERROR
);
507 s
->msg_callback(0, SSL2_VERSION
, 0, s
->init_buf
->data
,
508 (size_t)s
->init_num
, s
, s
->msg_callback_arg
);
510 if (!ssl3_finish_mac(s
, (unsigned char *)s
->init_buf
->data
,
511 s
->init_num
+ SSL3_HM_HEADER_LENGTH
)) {
512 SSLerr(SSL_F_TLS_GET_MESSAGE_BODY
, ERR_R_EVP_LIB
);
513 ssl3_send_alert(s
, SSL3_AL_FATAL
, SSL_AD_INTERNAL_ERROR
);
518 s
->msg_callback(0, s
->version
, SSL3_RT_HANDSHAKE
, s
->init_buf
->data
,
519 (size_t)s
->init_num
+ SSL3_HM_HEADER_LENGTH
, s
,
520 s
->msg_callback_arg
);
527 int ssl_cert_type(const X509
*x
, const EVP_PKEY
*pk
)
529 if (pk
== NULL
&& (pk
= X509_get0_pubkey(x
)) == NULL
)
532 switch (EVP_PKEY_id(pk
)) {
536 return SSL_PKEY_RSA_ENC
;
538 return SSL_PKEY_DSA_SIGN
;
539 #ifndef OPENSSL_NO_EC
543 #ifndef OPENSSL_NO_GOST
544 case NID_id_GostR3410_2001
:
545 return SSL_PKEY_GOST01
;
546 case NID_id_GostR3410_2012_256
:
547 return SSL_PKEY_GOST12_256
;
548 case NID_id_GostR3410_2012_512
:
549 return SSL_PKEY_GOST12_512
;
554 int ssl_verify_alarm_type(long type
)
559 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
:
560 case X509_V_ERR_UNABLE_TO_GET_CRL
:
561 case X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER
:
562 al
= SSL_AD_UNKNOWN_CA
;
564 case X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE
:
565 case X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE
:
566 case X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY
:
567 case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD
:
568 case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD
:
569 case X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD
:
570 case X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD
:
571 case X509_V_ERR_CERT_NOT_YET_VALID
:
572 case X509_V_ERR_CRL_NOT_YET_VALID
:
573 case X509_V_ERR_CERT_UNTRUSTED
:
574 case X509_V_ERR_CERT_REJECTED
:
575 case X509_V_ERR_HOSTNAME_MISMATCH
:
576 case X509_V_ERR_EMAIL_MISMATCH
:
577 case X509_V_ERR_IP_ADDRESS_MISMATCH
:
578 case X509_V_ERR_DANE_NO_MATCH
:
579 case X509_V_ERR_EE_KEY_TOO_SMALL
:
580 case X509_V_ERR_CA_KEY_TOO_SMALL
:
581 case X509_V_ERR_CA_MD_TOO_WEAK
:
582 al
= SSL_AD_BAD_CERTIFICATE
;
584 case X509_V_ERR_CERT_SIGNATURE_FAILURE
:
585 case X509_V_ERR_CRL_SIGNATURE_FAILURE
:
586 al
= SSL_AD_DECRYPT_ERROR
;
588 case X509_V_ERR_CERT_HAS_EXPIRED
:
589 case X509_V_ERR_CRL_HAS_EXPIRED
:
590 al
= SSL_AD_CERTIFICATE_EXPIRED
;
592 case X509_V_ERR_CERT_REVOKED
:
593 al
= SSL_AD_CERTIFICATE_REVOKED
;
595 case X509_V_ERR_UNSPECIFIED
:
596 case X509_V_ERR_OUT_OF_MEM
:
597 case X509_V_ERR_INVALID_CALL
:
598 case X509_V_ERR_STORE_LOOKUP
:
599 al
= SSL_AD_INTERNAL_ERROR
;
601 case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
:
602 case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
:
603 case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
:
604 case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE
:
605 case X509_V_ERR_CERT_CHAIN_TOO_LONG
:
606 case X509_V_ERR_PATH_LENGTH_EXCEEDED
:
607 case X509_V_ERR_INVALID_CA
:
608 al
= SSL_AD_UNKNOWN_CA
;
610 case X509_V_ERR_APPLICATION_VERIFICATION
:
611 al
= SSL_AD_HANDSHAKE_FAILURE
;
613 case X509_V_ERR_INVALID_PURPOSE
:
614 al
= SSL_AD_UNSUPPORTED_CERTIFICATE
;
617 al
= SSL_AD_CERTIFICATE_UNKNOWN
;
623 int ssl_allow_compression(SSL
*s
)
625 if (s
->options
& SSL_OP_NO_COMPRESSION
)
627 return ssl_security(s
, SSL_SECOP_COMPRESSION
, 0, 0, NULL
);
630 static int version_cmp(const SSL
*s
, int a
, int b
)
632 int dtls
= SSL_IS_DTLS(s
);
637 return a
< b
? -1 : 1;
638 return DTLS_VERSION_LT(a
, b
) ? -1 : 1;
643 const SSL_METHOD
*(*cmeth
) (void);
644 const SSL_METHOD
*(*smeth
) (void);
647 #if TLS_MAX_VERSION != TLS1_3_VERSION
648 # error Code needs update for TLS_method() support beyond TLS1_3_VERSION.
651 static const version_info tls_version_table
[] = {
652 #ifndef OPENSSL_NO_TLS1_3
653 {TLS1_3_VERSION
, tlsv1_3_client_method
, tlsv1_3_server_method
},
655 {TLS1_3_VERSION
, NULL
, NULL
},
657 #ifndef OPENSSL_NO_TLS1_2
658 {TLS1_2_VERSION
, tlsv1_2_client_method
, tlsv1_2_server_method
},
660 {TLS1_2_VERSION
, NULL
, NULL
},
662 #ifndef OPENSSL_NO_TLS1_1
663 {TLS1_1_VERSION
, tlsv1_1_client_method
, tlsv1_1_server_method
},
665 {TLS1_1_VERSION
, NULL
, NULL
},
667 #ifndef OPENSSL_NO_TLS1
668 {TLS1_VERSION
, tlsv1_client_method
, tlsv1_server_method
},
670 {TLS1_VERSION
, NULL
, NULL
},
672 #ifndef OPENSSL_NO_SSL3
673 {SSL3_VERSION
, sslv3_client_method
, sslv3_server_method
},
675 {SSL3_VERSION
, NULL
, NULL
},
680 #if DTLS_MAX_VERSION != DTLS1_2_VERSION
681 # error Code needs update for DTLS_method() support beyond DTLS1_2_VERSION.
684 static const version_info dtls_version_table
[] = {
685 #ifndef OPENSSL_NO_DTLS1_2
686 {DTLS1_2_VERSION
, dtlsv1_2_client_method
, dtlsv1_2_server_method
},
688 {DTLS1_2_VERSION
, NULL
, NULL
},
690 #ifndef OPENSSL_NO_DTLS1
691 {DTLS1_VERSION
, dtlsv1_client_method
, dtlsv1_server_method
},
692 {DTLS1_BAD_VER
, dtls_bad_ver_client_method
, NULL
},
694 {DTLS1_VERSION
, NULL
, NULL
},
695 {DTLS1_BAD_VER
, NULL
, NULL
},
701 * ssl_method_error - Check whether an SSL_METHOD is enabled.
703 * @s: The SSL handle for the candidate method
704 * @method: the intended method.
706 * Returns 0 on success, or an SSL error reason on failure.
708 static int ssl_method_error(const SSL
*s
, const SSL_METHOD
*method
)
710 int version
= method
->version
;
712 if ((s
->min_proto_version
!= 0 &&
713 version_cmp(s
, version
, s
->min_proto_version
) < 0) ||
714 ssl_security(s
, SSL_SECOP_VERSION
, 0, version
, NULL
) == 0)
715 return SSL_R_VERSION_TOO_LOW
;
717 if (s
->max_proto_version
!= 0 &&
718 version_cmp(s
, version
, s
->max_proto_version
) > 0)
719 return SSL_R_VERSION_TOO_HIGH
;
721 if ((s
->options
& method
->mask
) != 0)
722 return SSL_R_UNSUPPORTED_PROTOCOL
;
723 if ((method
->flags
& SSL_METHOD_NO_SUITEB
) != 0 && tls1_suiteb(s
))
724 return SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE
;
725 else if ((method
->flags
& SSL_METHOD_NO_FIPS
) != 0 && FIPS_mode())
726 return SSL_R_AT_LEAST_TLS_1_0_NEEDED_IN_FIPS_MODE
;
732 * ssl_version_supported - Check that the specified `version` is supported by
735 * @s: The SSL handle for the candidate method
736 * @version: Protocol version to test against
738 * Returns 1 when supported, otherwise 0
740 int ssl_version_supported(const SSL
*s
, int version
)
742 const version_info
*vent
;
743 const version_info
*table
;
745 switch (s
->method
->version
) {
747 /* Version should match method version for non-ANY method */
748 return version_cmp(s
, version
, s
->version
) == 0;
749 case TLS_ANY_VERSION
:
750 table
= tls_version_table
;
752 case DTLS_ANY_VERSION
:
753 table
= dtls_version_table
;
758 vent
->version
!= 0 && version_cmp(s
, version
, vent
->version
) <= 0;
760 if (vent
->cmeth
!= NULL
&&
761 version_cmp(s
, version
, vent
->version
) == 0 &&
762 ssl_method_error(s
, vent
->cmeth()) == 0) {
770 * ssl_check_version_downgrade - In response to RFC7507 SCSV version
771 * fallback indication from a client check whether we're using the highest
772 * supported protocol version.
774 * @s server SSL handle.
776 * Returns 1 when using the highest enabled version, 0 otherwise.
778 int ssl_check_version_downgrade(SSL
*s
)
780 const version_info
*vent
;
781 const version_info
*table
;
784 * Check that the current protocol is the highest enabled version
785 * (according to s->ctx->method, as version negotiation may have changed
788 if (s
->version
== s
->ctx
->method
->version
)
792 * Apparently we're using a version-flexible SSL_METHOD (not at its
793 * highest protocol version).
795 if (s
->ctx
->method
->version
== TLS_method()->version
)
796 table
= tls_version_table
;
797 else if (s
->ctx
->method
->version
== DTLS_method()->version
)
798 table
= dtls_version_table
;
800 /* Unexpected state; fail closed. */
804 for (vent
= table
; vent
->version
!= 0; ++vent
) {
805 if (vent
->smeth
!= NULL
&& ssl_method_error(s
, vent
->smeth()) == 0)
806 return s
->version
== vent
->version
;
812 * ssl_set_version_bound - set an upper or lower bound on the supported (D)TLS
813 * protocols, provided the initial (D)TLS method is version-flexible. This
814 * function sanity-checks the proposed value and makes sure the method is
815 * version-flexible, then sets the limit if all is well.
817 * @method_version: The version of the current SSL_METHOD.
818 * @version: the intended limit.
819 * @bound: pointer to limit to be updated.
821 * Returns 1 on success, 0 on failure.
823 int ssl_set_version_bound(int method_version
, int version
, int *bound
)
831 * Restrict TLS methods to TLS protocol versions.
832 * Restrict DTLS methods to DTLS protocol versions.
833 * Note, DTLS version numbers are decreasing, use comparison macros.
835 * Note that for both lower-bounds we use explicit versions, not
836 * (D)TLS_MIN_VERSION. This is because we don't want to break user
837 * configurations. If the MIN (supported) version ever rises, the user's
838 * "floor" remains valid even if no longer available. We don't expect the
839 * MAX ceiling to ever get lower, so making that variable makes sense.
841 switch (method_version
) {
844 * XXX For fixed version methods, should we always fail and not set any
845 * bounds, always succeed and not set any bounds, or set the bounds and
846 * arrange to fail later if they are not met? At present fixed-version
847 * methods are not subject to controls that disable individual protocol
852 case TLS_ANY_VERSION
:
853 if (version
< SSL3_VERSION
|| version
> TLS_MAX_VERSION
)
857 case DTLS_ANY_VERSION
:
858 if (DTLS_VERSION_GT(version
, DTLS_MAX_VERSION
) ||
859 DTLS_VERSION_LT(version
, DTLS1_BAD_VER
))
869 * ssl_choose_server_version - Choose server (D)TLS version. Called when the
870 * client HELLO is received to select the final server protocol version and
871 * the version specific method.
873 * @s: server SSL handle.
875 * Returns 0 on success or an SSL error reason number on failure.
877 int ssl_choose_server_version(SSL
*s
)
880 * With version-flexible methods we have an initial state with:
882 * s->method->version == (D)TLS_ANY_VERSION,
883 * s->version == (D)TLS_MAX_VERSION.
885 * So we detect version-flexible methods via the method version, not the
888 int server_version
= s
->method
->version
;
889 int client_version
= s
->client_version
;
890 const version_info
*vent
;
891 const version_info
*table
;
894 switch (server_version
) {
896 if (version_cmp(s
, client_version
, s
->version
) < 0)
897 return SSL_R_WRONG_SSL_VERSION
;
899 * If this SSL handle is not from a version flexible method we don't
900 * (and never did) check min/max FIPS or Suite B constraints. Hope
901 * that's OK. It is up to the caller to not choose fixed protocol
902 * versions they don't want. If not, then easy to fix, just return
903 * ssl_method_error(s, s->method)
906 case TLS_ANY_VERSION
:
907 table
= tls_version_table
;
909 case DTLS_ANY_VERSION
:
910 table
= dtls_version_table
;
914 for (vent
= table
; vent
->version
!= 0; ++vent
) {
915 const SSL_METHOD
*method
;
917 if (vent
->smeth
== NULL
||
918 version_cmp(s
, client_version
, vent
->version
) < 0)
920 method
= vent
->smeth();
921 if (ssl_method_error(s
, method
) == 0) {
922 s
->version
= vent
->version
;
928 return disabled
? SSL_R_UNSUPPORTED_PROTOCOL
: SSL_R_VERSION_TOO_LOW
;
932 * ssl_choose_client_version - Choose client (D)TLS version. Called when the
933 * server HELLO is received to select the final client protocol version and
934 * the version specific method.
936 * @s: client SSL handle.
937 * @version: The proposed version from the server's HELLO.
939 * Returns 0 on success or an SSL error reason number on failure.
941 int ssl_choose_client_version(SSL
*s
, int version
)
943 const version_info
*vent
;
944 const version_info
*table
;
946 switch (s
->method
->version
) {
948 if (version
!= s
->version
)
949 return SSL_R_WRONG_SSL_VERSION
;
951 * If this SSL handle is not from a version flexible method we don't
952 * (and never did) check min/max, FIPS or Suite B constraints. Hope
953 * that's OK. It is up to the caller to not choose fixed protocol
954 * versions they don't want. If not, then easy to fix, just return
955 * ssl_method_error(s, s->method)
958 case TLS_ANY_VERSION
:
959 table
= tls_version_table
;
961 case DTLS_ANY_VERSION
:
962 table
= dtls_version_table
;
966 for (vent
= table
; vent
->version
!= 0; ++vent
) {
967 const SSL_METHOD
*method
;
970 if (version
!= vent
->version
)
972 if (vent
->cmeth
== NULL
)
974 method
= vent
->cmeth();
975 err
= ssl_method_error(s
, method
);
979 s
->version
= version
;
983 return SSL_R_UNSUPPORTED_PROTOCOL
;
987 * ssl_get_client_min_max_version - get minimum and maximum client version
988 * @s: The SSL connection
989 * @min_version: The minimum supported version
990 * @max_version: The maximum supported version
992 * Work out what version we should be using for the initial ClientHello if the
993 * version is initially (D)TLS_ANY_VERSION. We apply any explicit SSL_OP_NO_xxx
994 * options, the MinProtocol and MaxProtocol configuration commands, any Suite B
995 * or FIPS_mode() constraints and any floor imposed by the security level here,
996 * so we don't advertise the wrong protocol version to only reject the outcome later.
998 * Computing the right floor matters. If, e.g., TLS 1.0 and 1.2 are enabled,
999 * TLS 1.1 is disabled, but the security level, Suite-B and/or MinProtocol
1000 * only allow TLS 1.2, we want to advertise TLS1.2, *not* TLS1.
1002 * Returns 0 on success or an SSL error reason number on failure. On failure
1003 * min_version and max_version will also be set to 0.
1005 int ssl_get_client_min_max_version(const SSL
*s
, int *min_version
,
1010 const SSL_METHOD
*single
= NULL
;
1011 const SSL_METHOD
*method
;
1012 const version_info
*table
;
1013 const version_info
*vent
;
1015 switch (s
->method
->version
) {
1018 * If this SSL handle is not from a version flexible method we don't
1019 * (and never did) check min/max FIPS or Suite B constraints. Hope
1020 * that's OK. It is up to the caller to not choose fixed protocol
1021 * versions they don't want. If not, then easy to fix, just return
1022 * ssl_method_error(s, s->method)
1024 *min_version
= *max_version
= s
->version
;
1026 case TLS_ANY_VERSION
:
1027 table
= tls_version_table
;
1029 case DTLS_ANY_VERSION
:
1030 table
= dtls_version_table
;
1035 * SSL_OP_NO_X disables all protocols above X *if* there are some protocols
1036 * below X enabled. This is required in order to maintain the "version
1037 * capability" vector contiguous. Any versions with a NULL client method
1038 * (protocol version client is disabled at compile-time) is also a "hole".
1040 * Our initial state is hole == 1, version == 0. That is, versions above
1041 * the first version in the method table are disabled (a "hole" above
1042 * the valid protocol entries) and we don't have a selected version yet.
1044 * Whenever "hole == 1", and we hit an enabled method, its version becomes
1045 * the selected version, and the method becomes a candidate "single"
1046 * method. We're no longer in a hole, so "hole" becomes 0.
1048 * If "hole == 0" and we hit an enabled method, then "single" is cleared,
1049 * as we support a contiguous range of at least two methods. If we hit
1050 * a disabled method, then hole becomes true again, but nothing else
1051 * changes yet, because all the remaining methods may be disabled too.
1052 * If we again hit an enabled method after the new hole, it becomes
1053 * selected, as we start from scratch.
1055 *min_version
= version
= 0;
1057 for (vent
= table
; vent
->version
!= 0; ++vent
) {
1059 * A table entry with a NULL client method is still a hole in the
1060 * "version capability" vector.
1062 if (vent
->cmeth
== NULL
) {
1066 method
= vent
->cmeth();
1067 if (ssl_method_error(s
, method
) != 0) {
1071 *min_version
= method
->version
;
1073 version
= (single
= method
)->version
;
1074 *min_version
= version
;
1079 *max_version
= version
;
1081 /* Fail if everything is disabled */
1083 return SSL_R_NO_PROTOCOLS_AVAILABLE
;
1089 * ssl_set_client_hello_version - Work out what version we should be using for
1090 * the initial ClientHello.
1092 * @s: client SSL handle.
1094 * Returns 0 on success or an SSL error reason number on failure.
1096 int ssl_set_client_hello_version(SSL
*s
)
1098 int ver_min
, ver_max
, ret
;
1100 ret
= ssl_get_client_min_max_version(s
, &ver_min
, &ver_max
);
1105 s
->client_version
= s
->version
= ver_max
;