xref: /aosp_15_r20/external/boringssl/src/ssl/dtls_method.cc (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1 /*
2  * DTLS implementation written by Nagendra Modadugu
3  * ([email protected]) for the OpenSSL project 2005.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999-2005 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    [email protected].
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * ([email protected]).  This product includes software written by Tim
55  * Hudson ([email protected]). */
56 
57 #include <openssl/ssl.h>
58 
59 #include <assert.h>
60 #include <string.h>
61 
62 #include <openssl/err.h>
63 
64 #include "../crypto/internal.h"
65 #include "internal.h"
66 
67 
68 using namespace bssl;
69 
dtls1_on_handshake_complete(SSL * ssl)70 static void dtls1_on_handshake_complete(SSL *ssl) {
71   // Stop the reply timer left by the last flight we sent.
72   dtls1_stop_timer(ssl);
73   // If the final flight had a reply, we know the peer has received it. If not,
74   // we must leave the flight around for post-handshake retransmission.
75   if (ssl->d1->flight_has_reply) {
76     dtls_clear_outgoing_messages(ssl);
77   }
78 }
79 
dtls1_set_read_state(SSL * ssl,ssl_encryption_level_t level,UniquePtr<SSLAEADContext> aead_ctx,Span<const uint8_t> secret_for_quic)80 static bool dtls1_set_read_state(SSL *ssl, ssl_encryption_level_t level,
81                                  UniquePtr<SSLAEADContext> aead_ctx,
82                                  Span<const uint8_t> secret_for_quic) {
83   assert(secret_for_quic.empty());  // QUIC does not use DTLS.
84   // Cipher changes are forbidden if the current epoch has leftover data.
85   if (dtls_has_unprocessed_handshake_data(ssl)) {
86     OPENSSL_PUT_ERROR(SSL, SSL_R_EXCESS_HANDSHAKE_DATA);
87     ssl_send_alert(ssl, SSL3_AL_FATAL, SSL_AD_UNEXPECTED_MESSAGE);
88     return false;
89   }
90 
91   ssl->d1->r_epoch++;
92   ssl->d1->bitmap = DTLS1_BITMAP();
93   ssl->s3->read_sequence = 0;
94 
95   ssl->s3->aead_read_ctx = std::move(aead_ctx);
96   ssl->s3->read_level = level;
97   ssl->d1->has_change_cipher_spec = false;
98   return true;
99 }
100 
dtls1_set_write_state(SSL * ssl,ssl_encryption_level_t level,UniquePtr<SSLAEADContext> aead_ctx,Span<const uint8_t> secret_for_quic)101 static bool dtls1_set_write_state(SSL *ssl, ssl_encryption_level_t level,
102                                   UniquePtr<SSLAEADContext> aead_ctx,
103                                   Span<const uint8_t> secret_for_quic) {
104   assert(secret_for_quic.empty());  // QUIC does not use DTLS.
105   ssl->d1->w_epoch++;
106   ssl->d1->last_write_sequence = ssl->s3->write_sequence;
107   ssl->s3->write_sequence = 0;
108 
109   ssl->d1->last_aead_write_ctx = std::move(ssl->s3->aead_write_ctx);
110   ssl->s3->aead_write_ctx = std::move(aead_ctx);
111   ssl->s3->write_level = level;
112   return true;
113 }
114 
115 static const SSL_PROTOCOL_METHOD kDTLSProtocolMethod = {
116     true /* is_dtls */,
117     dtls1_new,
118     dtls1_free,
119     dtls1_get_message,
120     dtls1_next_message,
121     dtls_has_unprocessed_handshake_data,
122     dtls1_open_handshake,
123     dtls1_open_change_cipher_spec,
124     dtls1_open_app_data,
125     dtls1_write_app_data,
126     dtls1_dispatch_alert,
127     dtls1_init_message,
128     dtls1_finish_message,
129     dtls1_add_message,
130     dtls1_add_change_cipher_spec,
131     dtls1_flush_flight,
132     dtls1_on_handshake_complete,
133     dtls1_set_read_state,
134     dtls1_set_write_state,
135 };
136 
DTLS_method(void)137 const SSL_METHOD *DTLS_method(void) {
138   static const SSL_METHOD kMethod = {
139       0,
140       &kDTLSProtocolMethod,
141       &ssl_crypto_x509_method,
142   };
143   return &kMethod;
144 }
145 
DTLS_with_buffers_method(void)146 const SSL_METHOD *DTLS_with_buffers_method(void) {
147   static const SSL_METHOD kMethod = {
148       0,
149       &kDTLSProtocolMethod,
150       &ssl_noop_x509_method,
151   };
152   return &kMethod;
153 }
154 
155 // Legacy version-locked methods.
156 
DTLSv1_2_method(void)157 const SSL_METHOD *DTLSv1_2_method(void) {
158   static const SSL_METHOD kMethod = {
159       DTLS1_2_VERSION,
160       &kDTLSProtocolMethod,
161       &ssl_crypto_x509_method,
162   };
163   return &kMethod;
164 }
165 
DTLSv1_method(void)166 const SSL_METHOD *DTLSv1_method(void) {
167   static const SSL_METHOD kMethod = {
168       DTLS1_VERSION,
169       &kDTLSProtocolMethod,
170       &ssl_crypto_x509_method,
171   };
172   return &kMethod;
173 }
174 
175 // Legacy side-specific methods.
176 
DTLSv1_2_server_method(void)177 const SSL_METHOD *DTLSv1_2_server_method(void) {
178   return DTLSv1_2_method();
179 }
180 
DTLSv1_server_method(void)181 const SSL_METHOD *DTLSv1_server_method(void) {
182   return DTLSv1_method();
183 }
184 
DTLSv1_2_client_method(void)185 const SSL_METHOD *DTLSv1_2_client_method(void) {
186   return DTLSv1_2_method();
187 }
188 
DTLSv1_client_method(void)189 const SSL_METHOD *DTLSv1_client_method(void) {
190   return DTLSv1_method();
191 }
192 
DTLS_server_method(void)193 const SSL_METHOD *DTLS_server_method(void) {
194   return DTLS_method();
195 }
196 
DTLS_client_method(void)197 const SSL_METHOD *DTLS_client_method(void) {
198   return DTLS_method();
199 }
200