• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57 /* ====================================================================
58  * Copyright (c) 1998-2002 The OpenSSL Project.  All rights reserved.
59  *
60  * Redistribution and use in source and binary forms, with or without
61  * modification, are permitted provided that the following conditions
62  * are met:
63  *
64  * 1. Redistributions of source code must retain the above copyright
65  *    notice, this list of conditions and the following disclaimer.
66  *
67  * 2. Redistributions in binary form must reproduce the above copyright
68  *    notice, this list of conditions and the following disclaimer in
69  *    the documentation and/or other materials provided with the
70  *    distribution.
71  *
72  * 3. All advertising materials mentioning features or use of this
73  *    software must display the following acknowledgment:
74  *    "This product includes software developed by the OpenSSL Project
75  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76  *
77  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78  *    endorse or promote products derived from this software without
79  *    prior written permission. For written permission, please contact
80  *    openssl-core@openssl.org.
81  *
82  * 5. Products derived from this software may not be called "OpenSSL"
83  *    nor may "OpenSSL" appear in their names without prior written
84  *    permission of the OpenSSL Project.
85  *
86  * 6. Redistributions of any form whatsoever must retain the following
87  *    acknowledgment:
88  *    "This product includes software developed by the OpenSSL Project
89  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90  *
91  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
95  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102  * OF THE POSSIBILITY OF SUCH DAMAGE.
103  * ====================================================================
104  *
105  * This product includes cryptographic software written by Eric Young
106  * (eay@cryptsoft.com).  This product includes software written by Tim
107  * Hudson (tjh@cryptsoft.com). */
108 /* ====================================================================
109  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
110  * ECC cipher suite support in OpenSSL originally developed by
111  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. */
112 
113 #include <openssl/ssl.h>
114 
115 #include <assert.h>
116 
117 #include <utility>
118 
119 #include <openssl/rand.h>
120 
121 #include "../crypto/internal.h"
122 #include "internal.h"
123 
124 
125 BSSL_NAMESPACE_BEGIN
126 
SSL_HANDSHAKE(SSL * ssl_arg)127 SSL_HANDSHAKE::SSL_HANDSHAKE(SSL *ssl_arg)
128     : ssl(ssl_arg),
129       scts_requested(false),
130       needs_psk_binder(false),
131       received_hello_retry_request(false),
132       sent_hello_retry_request(false),
133       handshake_finalized(false),
134       accept_psk_mode(false),
135       cert_request(false),
136       certificate_status_expected(false),
137       ocsp_stapling_requested(false),
138       delegated_credential_requested(false),
139       should_ack_sni(false),
140       in_false_start(false),
141       in_early_data(false),
142       early_data_offered(false),
143       can_early_read(false),
144       can_early_write(false),
145       next_proto_neg_seen(false),
146       ticket_expected(false),
147       extended_master_secret(false),
148       pending_private_key_op(false),
149       grease_seeded(false),
150       handback(false),
151       cert_compression_negotiated(false),
152       apply_jdk11_workaround(false) {
153   assert(ssl);
154 }
155 
~SSL_HANDSHAKE()156 SSL_HANDSHAKE::~SSL_HANDSHAKE() {
157   ssl->ctx->x509_method->hs_flush_cached_ca_names(this);
158 }
159 
ResizeSecrets(size_t hash_len)160 void SSL_HANDSHAKE::ResizeSecrets(size_t hash_len) {
161   if (hash_len > SSL_MAX_MD_SIZE) {
162     abort();
163   }
164   hash_len_ = hash_len;
165 }
166 
ssl_handshake_new(SSL * ssl)167 UniquePtr<SSL_HANDSHAKE> ssl_handshake_new(SSL *ssl) {
168   UniquePtr<SSL_HANDSHAKE> hs = MakeUnique<SSL_HANDSHAKE>(ssl);
169   if (!hs || !hs->transcript.Init()) {
170     return nullptr;
171   }
172   hs->config = ssl->config.get();
173   if (!hs->config) {
174     assert(hs->config);
175     return nullptr;
176   }
177   return hs;
178 }
179 
ssl_check_message_type(SSL * ssl,const SSLMessage & msg,int type)180 bool ssl_check_message_type(SSL *ssl, const SSLMessage &msg, int type) {
181   if (msg.type != type) {
182     ssl_send_alert(ssl, SSL3_AL_FATAL, SSL_AD_UNEXPECTED_MESSAGE);
183     OPENSSL_PUT_ERROR(SSL, SSL_R_UNEXPECTED_MESSAGE);
184     ERR_add_error_dataf("got type %d, wanted type %d", msg.type, type);
185     return false;
186   }
187 
188   return true;
189 }
190 
ssl_add_message_cbb(SSL * ssl,CBB * cbb)191 bool ssl_add_message_cbb(SSL *ssl, CBB *cbb) {
192   Array<uint8_t> msg;
193   if (!ssl->method->finish_message(ssl, cbb, &msg) ||
194       !ssl->method->add_message(ssl, std::move(msg))) {
195     return false;
196   }
197 
198   return true;
199 }
200 
ssl_max_handshake_message_len(const SSL * ssl)201 size_t ssl_max_handshake_message_len(const SSL *ssl) {
202   // kMaxMessageLen is the default maximum message size for handshakes which do
203   // not accept peer certificate chains.
204   static const size_t kMaxMessageLen = 16384;
205 
206   if (SSL_in_init(ssl)) {
207     SSL_CONFIG *config = ssl->config.get();  // SSL_in_init() implies not NULL.
208     if ((!ssl->server || (config->verify_mode & SSL_VERIFY_PEER)) &&
209         kMaxMessageLen < ssl->max_cert_list) {
210       return ssl->max_cert_list;
211     }
212     return kMaxMessageLen;
213   }
214 
215   if (ssl_protocol_version(ssl) < TLS1_3_VERSION) {
216     // In TLS 1.2 and below, the largest acceptable post-handshake message is
217     // a HelloRequest.
218     return 0;
219   }
220 
221   if (ssl->server) {
222     // The largest acceptable post-handshake message for a server is a
223     // KeyUpdate. We will never initiate post-handshake auth.
224     return 1;
225   }
226 
227   // Clients must accept NewSessionTicket, so allow the default size.
228   return kMaxMessageLen;
229 }
230 
ssl_hash_message(SSL_HANDSHAKE * hs,const SSLMessage & msg)231 bool ssl_hash_message(SSL_HANDSHAKE *hs, const SSLMessage &msg) {
232   // V2ClientHello messages are pre-hashed.
233   if (msg.is_v2_hello) {
234     return true;
235   }
236 
237   return hs->transcript.Update(msg.raw);
238 }
239 
ssl_parse_extensions(const CBS * cbs,uint8_t * out_alert,const SSL_EXTENSION_TYPE * ext_types,size_t num_ext_types,int ignore_unknown)240 int ssl_parse_extensions(const CBS *cbs, uint8_t *out_alert,
241                          const SSL_EXTENSION_TYPE *ext_types,
242                          size_t num_ext_types, int ignore_unknown) {
243   // Reset everything.
244   for (size_t i = 0; i < num_ext_types; i++) {
245     *ext_types[i].out_present = 0;
246     CBS_init(ext_types[i].out_data, NULL, 0);
247   }
248 
249   CBS copy = *cbs;
250   while (CBS_len(&copy) != 0) {
251     uint16_t type;
252     CBS data;
253     if (!CBS_get_u16(&copy, &type) ||
254         !CBS_get_u16_length_prefixed(&copy, &data)) {
255       OPENSSL_PUT_ERROR(SSL, SSL_R_PARSE_TLSEXT);
256       *out_alert = SSL_AD_DECODE_ERROR;
257       return 0;
258     }
259 
260     const SSL_EXTENSION_TYPE *ext_type = NULL;
261     for (size_t i = 0; i < num_ext_types; i++) {
262       if (type == ext_types[i].type) {
263         ext_type = &ext_types[i];
264         break;
265       }
266     }
267 
268     if (ext_type == NULL) {
269       if (ignore_unknown) {
270         continue;
271       }
272       OPENSSL_PUT_ERROR(SSL, SSL_R_UNEXPECTED_EXTENSION);
273       *out_alert = SSL_AD_UNSUPPORTED_EXTENSION;
274       return 0;
275     }
276 
277     // Duplicate ext_types are forbidden.
278     if (*ext_type->out_present) {
279       OPENSSL_PUT_ERROR(SSL, SSL_R_DUPLICATE_EXTENSION);
280       *out_alert = SSL_AD_ILLEGAL_PARAMETER;
281       return 0;
282     }
283 
284     *ext_type->out_present = 1;
285     *ext_type->out_data = data;
286   }
287 
288   return 1;
289 }
290 
ssl_verify_peer_cert(SSL_HANDSHAKE * hs)291 enum ssl_verify_result_t ssl_verify_peer_cert(SSL_HANDSHAKE *hs) {
292   SSL *const ssl = hs->ssl;
293   const SSL_SESSION *prev_session = ssl->s3->established_session.get();
294   if (prev_session != NULL) {
295     // If renegotiating, the server must not change the server certificate. See
296     // https://mitls.org/pages/attacks/3SHAKE. We never resume on renegotiation,
297     // so this check is sufficient to ensure the reported peer certificate never
298     // changes on renegotiation.
299     assert(!ssl->server);
300     if (sk_CRYPTO_BUFFER_num(prev_session->certs.get()) !=
301         sk_CRYPTO_BUFFER_num(hs->new_session->certs.get())) {
302       OPENSSL_PUT_ERROR(SSL, SSL_R_SERVER_CERT_CHANGED);
303       ssl_send_alert(ssl, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
304       return ssl_verify_invalid;
305     }
306 
307     for (size_t i = 0; i < sk_CRYPTO_BUFFER_num(hs->new_session->certs.get());
308          i++) {
309       const CRYPTO_BUFFER *old_cert =
310           sk_CRYPTO_BUFFER_value(prev_session->certs.get(), i);
311       const CRYPTO_BUFFER *new_cert =
312           sk_CRYPTO_BUFFER_value(hs->new_session->certs.get(), i);
313       if (CRYPTO_BUFFER_len(old_cert) != CRYPTO_BUFFER_len(new_cert) ||
314           OPENSSL_memcmp(CRYPTO_BUFFER_data(old_cert),
315                          CRYPTO_BUFFER_data(new_cert),
316                          CRYPTO_BUFFER_len(old_cert)) != 0) {
317         OPENSSL_PUT_ERROR(SSL, SSL_R_SERVER_CERT_CHANGED);
318         ssl_send_alert(ssl, SSL3_AL_FATAL, SSL_AD_ILLEGAL_PARAMETER);
319         return ssl_verify_invalid;
320       }
321     }
322 
323     // The certificate is identical, so we may skip re-verifying the
324     // certificate. Since we only authenticated the previous one, copy other
325     // authentication from the established session and ignore what was newly
326     // received.
327     hs->new_session->ocsp_response = UpRef(prev_session->ocsp_response);
328     hs->new_session->signed_cert_timestamp_list =
329         UpRef(prev_session->signed_cert_timestamp_list);
330     hs->new_session->verify_result = prev_session->verify_result;
331     return ssl_verify_ok;
332   }
333 
334   uint8_t alert = SSL_AD_CERTIFICATE_UNKNOWN;
335   enum ssl_verify_result_t ret;
336   if (hs->config->custom_verify_callback != nullptr) {
337     ret = hs->config->custom_verify_callback(ssl, &alert);
338     switch (ret) {
339       case ssl_verify_ok:
340         hs->new_session->verify_result = X509_V_OK;
341         break;
342       case ssl_verify_invalid:
343         // If |SSL_VERIFY_NONE|, the error is non-fatal, but we keep the result.
344         if (hs->config->verify_mode == SSL_VERIFY_NONE) {
345           ERR_clear_error();
346           ret = ssl_verify_ok;
347         }
348         hs->new_session->verify_result = X509_V_ERR_APPLICATION_VERIFICATION;
349         break;
350       case ssl_verify_retry:
351         break;
352     }
353   } else {
354     ret = ssl->ctx->x509_method->session_verify_cert_chain(
355               hs->new_session.get(), hs, &alert)
356               ? ssl_verify_ok
357               : ssl_verify_invalid;
358   }
359 
360   if (ret == ssl_verify_invalid) {
361     OPENSSL_PUT_ERROR(SSL, SSL_R_CERTIFICATE_VERIFY_FAILED);
362     ssl_send_alert(ssl, SSL3_AL_FATAL, alert);
363   }
364 
365   // Emulate OpenSSL's client OCSP callback. OpenSSL verifies certificates
366   // before it receives the OCSP, so it needs a second callback for OCSP.
367   if (ret == ssl_verify_ok && !ssl->server &&
368       hs->config->ocsp_stapling_enabled &&
369       ssl->ctx->legacy_ocsp_callback != nullptr) {
370     int cb_ret =
371         ssl->ctx->legacy_ocsp_callback(ssl, ssl->ctx->legacy_ocsp_callback_arg);
372     if (cb_ret <= 0) {
373       OPENSSL_PUT_ERROR(SSL, SSL_R_OCSP_CB_ERROR);
374       ssl_send_alert(ssl, SSL3_AL_FATAL,
375                      cb_ret == 0 ? SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
376                                  : SSL_AD_INTERNAL_ERROR);
377       ret = ssl_verify_invalid;
378     }
379   }
380 
381   return ret;
382 }
383 
384 // Verifies a stored certificate when resuming a session. A few things are
385 // different from verify_peer_cert:
386 // 1. We can't be renegotiating if we're resuming a session.
387 // 2. The session is immutable, so we don't support verify_mode ==
388 // SSL_VERIFY_NONE
389 // 3. We don't call the OCSP callback.
390 // 4. We only support custom verify callbacks.
ssl_reverify_peer_cert(SSL_HANDSHAKE * hs)391 enum ssl_verify_result_t ssl_reverify_peer_cert(SSL_HANDSHAKE *hs) {
392   SSL *const ssl = hs->ssl;
393   assert(ssl->s3->established_session == nullptr);
394   assert(hs->config->verify_mode != SSL_VERIFY_NONE);
395 
396   uint8_t alert = SSL_AD_CERTIFICATE_UNKNOWN;
397   enum ssl_verify_result_t ret = ssl_verify_invalid;
398   if (hs->config->custom_verify_callback != nullptr) {
399     ret = hs->config->custom_verify_callback(ssl, &alert);
400   }
401 
402   if (ret == ssl_verify_invalid) {
403     OPENSSL_PUT_ERROR(SSL, SSL_R_CERTIFICATE_VERIFY_FAILED);
404     ssl_send_alert(ssl, SSL3_AL_FATAL, alert);
405   }
406 
407   return ret;
408 }
409 
ssl_get_grease_value(SSL_HANDSHAKE * hs,enum ssl_grease_index_t index)410 uint16_t ssl_get_grease_value(SSL_HANDSHAKE *hs,
411                               enum ssl_grease_index_t index) {
412   // Draw entropy for all GREASE values at once. This avoids calling
413   // |RAND_bytes| repeatedly and makes the values consistent within a
414   // connection. The latter is so the second ClientHello matches after
415   // HelloRetryRequest and so supported_groups and key_shares are consistent.
416   if (!hs->grease_seeded) {
417     RAND_bytes(hs->grease_seed, sizeof(hs->grease_seed));
418     hs->grease_seeded = true;
419   }
420 
421   // This generates a random value of the form 0xωaωa, for all 0 ≤ ω < 16.
422   uint16_t ret = hs->grease_seed[index];
423   ret = (ret & 0xf0) | 0x0a;
424   ret |= ret << 8;
425   return ret;
426 }
427 
ssl_get_finished(SSL_HANDSHAKE * hs)428 enum ssl_hs_wait_t ssl_get_finished(SSL_HANDSHAKE *hs) {
429   SSL *const ssl = hs->ssl;
430   SSLMessage msg;
431   if (!ssl->method->get_message(ssl, &msg)) {
432     return ssl_hs_read_message;
433   }
434 
435   if (!ssl_check_message_type(ssl, msg, SSL3_MT_FINISHED)) {
436     return ssl_hs_error;
437   }
438 
439   // Snapshot the finished hash before incorporating the new message.
440   uint8_t finished[EVP_MAX_MD_SIZE];
441   size_t finished_len;
442   if (!hs->transcript.GetFinishedMAC(finished, &finished_len,
443                                      SSL_get_session(ssl), !ssl->server) ||
444       !ssl_hash_message(hs, msg)) {
445     return ssl_hs_error;
446   }
447 
448   int finished_ok = CBS_mem_equal(&msg.body, finished, finished_len);
449 #if defined(BORINGSSL_UNSAFE_FUZZER_MODE)
450   finished_ok = 1;
451 #endif
452   if (!finished_ok) {
453     ssl_send_alert(ssl, SSL3_AL_FATAL, SSL_AD_DECRYPT_ERROR);
454     OPENSSL_PUT_ERROR(SSL, SSL_R_DIGEST_CHECK_FAILED);
455     return ssl_hs_error;
456   }
457 
458   // Copy the Finished so we can use it for renegotiation checks.
459   if (finished_len > sizeof(ssl->s3->previous_client_finished) ||
460       finished_len > sizeof(ssl->s3->previous_server_finished)) {
461     OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
462     return ssl_hs_error;
463   }
464 
465   if (ssl->server) {
466     OPENSSL_memcpy(ssl->s3->previous_client_finished, finished, finished_len);
467     ssl->s3->previous_client_finished_len = finished_len;
468   } else {
469     OPENSSL_memcpy(ssl->s3->previous_server_finished, finished, finished_len);
470     ssl->s3->previous_server_finished_len = finished_len;
471   }
472 
473   ssl->method->next_message(ssl);
474   return ssl_hs_ok;
475 }
476 
ssl_send_finished(SSL_HANDSHAKE * hs)477 bool ssl_send_finished(SSL_HANDSHAKE *hs) {
478   SSL *const ssl = hs->ssl;
479   const SSL_SESSION *session = SSL_get_session(ssl);
480 
481   uint8_t finished[EVP_MAX_MD_SIZE];
482   size_t finished_len;
483   if (!hs->transcript.GetFinishedMAC(finished, &finished_len, session,
484                                      ssl->server)) {
485     return 0;
486   }
487 
488   // Log the master secret, if logging is enabled.
489   if (!ssl_log_secret(
490           ssl, "CLIENT_RANDOM",
491           MakeConstSpan(session->master_key, session->master_key_length))) {
492     return 0;
493   }
494 
495   // Copy the Finished so we can use it for renegotiation checks.
496   if (finished_len > sizeof(ssl->s3->previous_client_finished) ||
497       finished_len > sizeof(ssl->s3->previous_server_finished)) {
498     OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
499     return 0;
500   }
501 
502   if (ssl->server) {
503     OPENSSL_memcpy(ssl->s3->previous_server_finished, finished, finished_len);
504     ssl->s3->previous_server_finished_len = finished_len;
505   } else {
506     OPENSSL_memcpy(ssl->s3->previous_client_finished, finished, finished_len);
507     ssl->s3->previous_client_finished_len = finished_len;
508   }
509 
510   ScopedCBB cbb;
511   CBB body;
512   if (!ssl->method->init_message(ssl, cbb.get(), &body, SSL3_MT_FINISHED) ||
513       !CBB_add_bytes(&body, finished, finished_len) ||
514       !ssl_add_message_cbb(ssl, cbb.get())) {
515     OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
516     return 0;
517   }
518 
519   return 1;
520 }
521 
ssl_output_cert_chain(SSL_HANDSHAKE * hs)522 bool ssl_output_cert_chain(SSL_HANDSHAKE *hs) {
523   ScopedCBB cbb;
524   CBB body;
525   if (!hs->ssl->method->init_message(hs->ssl, cbb.get(), &body,
526                                      SSL3_MT_CERTIFICATE) ||
527       !ssl_add_cert_chain(hs, &body) ||
528       !ssl_add_message_cbb(hs->ssl, cbb.get())) {
529     OPENSSL_PUT_ERROR(SSL, ERR_R_INTERNAL_ERROR);
530     return false;
531   }
532 
533   return true;
534 }
535 
ssl_run_handshake(SSL_HANDSHAKE * hs,bool * out_early_return)536 int ssl_run_handshake(SSL_HANDSHAKE *hs, bool *out_early_return) {
537   SSL *const ssl = hs->ssl;
538   for (;;) {
539     // Resolve the operation the handshake was waiting on.
540     switch (hs->wait) {
541       case ssl_hs_error:
542         ERR_restore_state(hs->error.get());
543         return -1;
544 
545       case ssl_hs_flush: {
546         int ret = ssl->method->flush_flight(ssl);
547         if (ret <= 0) {
548           return ret;
549         }
550         break;
551       }
552 
553       case ssl_hs_read_server_hello:
554       case ssl_hs_read_message:
555       case ssl_hs_read_change_cipher_spec: {
556         if (ssl->quic_method) {
557           hs->wait = ssl_hs_ok;
558           // The change cipher spec is omitted in QUIC.
559           if (hs->wait != ssl_hs_read_change_cipher_spec) {
560             ssl->s3->rwstate = SSL_ERROR_WANT_READ;
561             return -1;
562           }
563           break;
564         }
565 
566         uint8_t alert = SSL_AD_DECODE_ERROR;
567         size_t consumed = 0;
568         ssl_open_record_t ret;
569         if (hs->wait == ssl_hs_read_change_cipher_spec) {
570           ret = ssl_open_change_cipher_spec(ssl, &consumed, &alert,
571                                             ssl->s3->read_buffer.span());
572         } else {
573           ret = ssl_open_handshake(ssl, &consumed, &alert,
574                                    ssl->s3->read_buffer.span());
575         }
576         if (ret == ssl_open_record_error &&
577             hs->wait == ssl_hs_read_server_hello) {
578           uint32_t err = ERR_peek_error();
579           if (ERR_GET_LIB(err) == ERR_LIB_SSL &&
580               ERR_GET_REASON(err) == SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE) {
581             // Add a dedicated error code to the queue for a handshake_failure
582             // alert in response to ClientHello. This matches NSS's client
583             // behavior and gives a better error on a (probable) failure to
584             // negotiate initial parameters. Note: this error code comes after
585             // the original one.
586             //
587             // See https://crbug.com/446505.
588             OPENSSL_PUT_ERROR(SSL, SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO);
589           }
590         }
591         bool retry;
592         int bio_ret = ssl_handle_open_record(ssl, &retry, ret, consumed, alert);
593         if (bio_ret <= 0) {
594           return bio_ret;
595         }
596         if (retry) {
597           continue;
598         }
599         ssl->s3->read_buffer.DiscardConsumed();
600         break;
601       }
602 
603       case ssl_hs_read_end_of_early_data: {
604         if (ssl->s3->hs->can_early_read) {
605           // While we are processing early data, the handshake returns early.
606           *out_early_return = true;
607           return 1;
608         }
609         hs->wait = ssl_hs_ok;
610         break;
611       }
612 
613       case ssl_hs_certificate_selection_pending:
614         ssl->s3->rwstate = SSL_ERROR_PENDING_CERTIFICATE;
615         hs->wait = ssl_hs_ok;
616         return -1;
617 
618       case ssl_hs_handoff:
619         ssl->s3->rwstate = SSL_ERROR_HANDOFF;
620         hs->wait = ssl_hs_ok;
621         return -1;
622 
623       case ssl_hs_handback:
624         ssl->s3->rwstate = SSL_ERROR_HANDBACK;
625         hs->wait = ssl_hs_handback;
626         return -1;
627 
628       case ssl_hs_x509_lookup:
629         ssl->s3->rwstate = SSL_ERROR_WANT_X509_LOOKUP;
630         hs->wait = ssl_hs_ok;
631         return -1;
632 
633       case ssl_hs_channel_id_lookup:
634         ssl->s3->rwstate = SSL_ERROR_WANT_CHANNEL_ID_LOOKUP;
635         hs->wait = ssl_hs_ok;
636         return -1;
637 
638       case ssl_hs_private_key_operation:
639         ssl->s3->rwstate = SSL_ERROR_WANT_PRIVATE_KEY_OPERATION;
640         hs->wait = ssl_hs_ok;
641         return -1;
642 
643       case ssl_hs_pending_session:
644         ssl->s3->rwstate = SSL_ERROR_PENDING_SESSION;
645         hs->wait = ssl_hs_ok;
646         return -1;
647 
648       case ssl_hs_pending_ticket:
649         ssl->s3->rwstate = SSL_ERROR_PENDING_TICKET;
650         hs->wait = ssl_hs_ok;
651         return -1;
652 
653       case ssl_hs_certificate_verify:
654         ssl->s3->rwstate = SSL_ERROR_WANT_CERTIFICATE_VERIFY;
655         hs->wait = ssl_hs_ok;
656         return -1;
657 
658       case ssl_hs_early_data_rejected:
659         assert(ssl->s3->early_data_reason != ssl_early_data_unknown);
660         ssl->s3->rwstate = SSL_ERROR_EARLY_DATA_REJECTED;
661         // Cause |SSL_write| to start failing immediately.
662         hs->can_early_write = false;
663         return -1;
664 
665       case ssl_hs_early_return:
666         *out_early_return = true;
667         hs->wait = ssl_hs_ok;
668         return 1;
669 
670       case ssl_hs_ok:
671         break;
672     }
673 
674     // Run the state machine again.
675     hs->wait = ssl->do_handshake(hs);
676     if (hs->wait == ssl_hs_error) {
677       hs->error.reset(ERR_save_state());
678       return -1;
679     }
680     if (hs->wait == ssl_hs_ok) {
681       // The handshake has completed.
682       *out_early_return = false;
683       return 1;
684     }
685 
686     // Otherwise, loop to the beginning and resolve what was blocking the
687     // handshake.
688   }
689 }
690 
691 BSSL_NAMESPACE_END
692