blob: 5fa1a3c5026677721dddbf6eb89a66a798dd2749 [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001/*
2 * Copyright 2004 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Steve Anton10542f22019-01-11 09:11:00 -080011#include "rtc_base/openssl_stream_adapter.h"
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000012
13#include <openssl/bio.h>
14#include <openssl/crypto.h>
15#include <openssl/err.h>
16#include <openssl/rand.h>
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +000017#include <openssl/tls1.h>
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000018#include <openssl/x509v3.h>
Ali Tofigh7fa90572022-03-17 15:47:49 +010019
20#include "absl/strings/string_view.h"
torbjorngaad67802016-04-07 08:55:28 -070021#ifndef OPENSSL_IS_BORINGSSL
22#include <openssl/dtls1.h>
ssarohabbfed522016-12-11 18:42:07 -080023#include <openssl/ssl.h>
torbjorngaad67802016-04-07 08:55:28 -070024#endif
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000025
Guido Urdaneta14bba6e2020-09-25 16:00:51 +020026#include <atomic>
jbauch555604a2016-04-26 03:13:22 -070027#include <memory>
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -070028#include <utility>
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000029#include <vector>
30
Harald Alvestrand11840ce2022-11-10 10:50:50 +000031#include "api/array_view.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020032#include "rtc_base/checks.h"
33#include "rtc_base/logging.h"
Karl Wiberge40468b2017-11-22 10:42:26 +010034#include "rtc_base/numerics/safe_conversions.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020035#include "rtc_base/openssl.h"
Steve Anton10542f22019-01-11 09:11:00 -080036#include "rtc_base/openssl_adapter.h"
37#include "rtc_base/openssl_digest.h"
Taylor Brandstetter165c6182020-12-10 16:23:03 -080038#ifdef OPENSSL_IS_BORINGSSL
39#include "rtc_base/boringssl_identity.h"
40#else
Steve Anton10542f22019-01-11 09:11:00 -080041#include "rtc_base/openssl_identity.h"
Taylor Brandstetter165c6182020-12-10 16:23:03 -080042#endif
43#include "rtc_base/openssl_utility.h"
Steve Anton10542f22019-01-11 09:11:00 -080044#include "rtc_base/ssl_certificate.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020045#include "rtc_base/stream.h"
Philipp Hancke117e6922022-06-17 14:14:55 +020046#include "rtc_base/string_encode.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020047#include "rtc_base/thread.h"
Steve Anton10542f22019-01-11 09:11:00 -080048#include "rtc_base/time_utils.h"
Harald Alvestrand13799132020-03-09 19:39:36 +010049#include "system_wrappers/include/field_trial.h"
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000050
Jiawei Oua9c94d52018-01-30 23:05:07 -080051#if (OPENSSL_VERSION_NUMBER < 0x10100000L)
52#error "webrtc requires at least OpenSSL version 1.1.0, to support DTLS-SRTP"
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +010053#endif
54
Benjamin Wright8e98c602019-02-28 17:25:01 -080055// Defines for the TLS Cipher Suite Map.
56#define DEFINE_CIPHER_ENTRY_SSL3(name) \
57 { SSL3_CK_##name, "TLS_" #name }
58#define DEFINE_CIPHER_ENTRY_TLS1(name) \
59 { TLS1_CK_##name, "TLS_" #name }
60
61namespace rtc {
62namespace {
Danil Chapovalov5286dcf2022-07-18 17:04:56 +020063using ::webrtc::SafeTask;
Artem Titov96e3b992021-07-26 16:03:14 +020064// SRTP cipher suite table. `internal_name` is used to construct a
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -080065// colon-separated profile strings which is needed by
66// SSL_CTX_set_tlsext_use_srtp().
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000067struct SrtpCipherMapEntry {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000068 const char* internal_name;
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -080069 const int id;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000070};
71
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +010072// Cipher name table. Maps internal OpenSSL cipher ids to the RFC name.
73struct SslCipherMapEntry {
74 uint32_t openssl_id;
75 const char* rfc_name;
76};
77
Benjamin Wright8e98c602019-02-28 17:25:01 -080078// This isn't elegant, but it's better than an external reference
79constexpr SrtpCipherMapEntry kSrtpCipherMap[] = {
Mirko Bonadei7750d802021-07-26 17:27:42 +020080 {"SRTP_AES128_CM_SHA1_80", kSrtpAes128CmSha1_80},
81 {"SRTP_AES128_CM_SHA1_32", kSrtpAes128CmSha1_32},
82 {"SRTP_AEAD_AES_128_GCM", kSrtpAeadAes128Gcm},
83 {"SRTP_AEAD_AES_256_GCM", kSrtpAeadAes256Gcm}};
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +010084
Benjamin Wright8e98c602019-02-28 17:25:01 -080085#ifndef OPENSSL_IS_BORINGSSL
David Benjamin3c1f05d2017-12-01 17:28:03 -050086// The "SSL_CIPHER_standard_name" function is only available in OpenSSL when
87// compiled with tracing, so we need to define the mapping manually here.
Benjamin Wright8e98c602019-02-28 17:25:01 -080088constexpr SslCipherMapEntry kSslCipherMap[] = {
deadbeef37f5ecf2017-02-27 14:06:41 -080089 // TLS v1.0 ciphersuites from RFC2246.
90 DEFINE_CIPHER_ENTRY_SSL3(RSA_RC4_128_SHA),
91 {SSL3_CK_RSA_DES_192_CBC3_SHA, "TLS_RSA_WITH_3DES_EDE_CBC_SHA"},
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +010092
deadbeef37f5ecf2017-02-27 14:06:41 -080093 // AES ciphersuites from RFC3268.
94 {TLS1_CK_RSA_WITH_AES_128_SHA, "TLS_RSA_WITH_AES_128_CBC_SHA"},
95 {TLS1_CK_DHE_RSA_WITH_AES_128_SHA, "TLS_DHE_RSA_WITH_AES_128_CBC_SHA"},
96 {TLS1_CK_RSA_WITH_AES_256_SHA, "TLS_RSA_WITH_AES_256_CBC_SHA"},
97 {TLS1_CK_DHE_RSA_WITH_AES_256_SHA, "TLS_DHE_RSA_WITH_AES_256_CBC_SHA"},
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +010098
deadbeef37f5ecf2017-02-27 14:06:41 -080099 // ECC ciphersuites from RFC4492.
100 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_ECDSA_WITH_RC4_128_SHA),
101 {TLS1_CK_ECDHE_ECDSA_WITH_DES_192_CBC3_SHA,
102 "TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA"},
103 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_ECDSA_WITH_AES_128_CBC_SHA),
104 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_ECDSA_WITH_AES_256_CBC_SHA),
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100105
deadbeef37f5ecf2017-02-27 14:06:41 -0800106 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_RSA_WITH_RC4_128_SHA),
107 {TLS1_CK_ECDHE_RSA_WITH_DES_192_CBC3_SHA,
108 "TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA"},
109 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_RSA_WITH_AES_128_CBC_SHA),
110 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_RSA_WITH_AES_256_CBC_SHA),
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100111
deadbeef37f5ecf2017-02-27 14:06:41 -0800112 // TLS v1.2 ciphersuites.
113 {TLS1_CK_RSA_WITH_AES_128_SHA256, "TLS_RSA_WITH_AES_128_CBC_SHA256"},
114 {TLS1_CK_RSA_WITH_AES_256_SHA256, "TLS_RSA_WITH_AES_256_CBC_SHA256"},
115 {TLS1_CK_DHE_RSA_WITH_AES_128_SHA256,
116 "TLS_DHE_RSA_WITH_AES_128_CBC_SHA256"},
117 {TLS1_CK_DHE_RSA_WITH_AES_256_SHA256,
118 "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256"},
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100119
deadbeef37f5ecf2017-02-27 14:06:41 -0800120 // TLS v1.2 GCM ciphersuites from RFC5288.
121 DEFINE_CIPHER_ENTRY_TLS1(RSA_WITH_AES_128_GCM_SHA256),
122 DEFINE_CIPHER_ENTRY_TLS1(RSA_WITH_AES_256_GCM_SHA384),
123 DEFINE_CIPHER_ENTRY_TLS1(DHE_RSA_WITH_AES_128_GCM_SHA256),
124 DEFINE_CIPHER_ENTRY_TLS1(DHE_RSA_WITH_AES_256_GCM_SHA384),
125 DEFINE_CIPHER_ENTRY_TLS1(DH_RSA_WITH_AES_128_GCM_SHA256),
126 DEFINE_CIPHER_ENTRY_TLS1(DH_RSA_WITH_AES_256_GCM_SHA384),
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100127
deadbeef37f5ecf2017-02-27 14:06:41 -0800128 // ECDH HMAC based ciphersuites from RFC5289.
129 {TLS1_CK_ECDHE_ECDSA_WITH_AES_128_SHA256,
130 "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"},
131 {TLS1_CK_ECDHE_ECDSA_WITH_AES_256_SHA384,
132 "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384"},
133 {TLS1_CK_ECDHE_RSA_WITH_AES_128_SHA256,
134 "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"},
135 {TLS1_CK_ECDHE_RSA_WITH_AES_256_SHA384,
136 "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"},
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100137
deadbeef37f5ecf2017-02-27 14:06:41 -0800138 // ECDH GCM based ciphersuites from RFC5289.
139 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_ECDSA_WITH_AES_128_GCM_SHA256),
140 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_ECDSA_WITH_AES_256_GCM_SHA384),
141 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_RSA_WITH_AES_128_GCM_SHA256),
142 DEFINE_CIPHER_ENTRY_TLS1(ECDHE_RSA_WITH_AES_256_GCM_SHA384),
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100143
deadbeef37f5ecf2017-02-27 14:06:41 -0800144 {0, nullptr}};
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100145#endif // #ifndef OPENSSL_IS_BORINGSSL
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +0000146
Benjamin Wright8e98c602019-02-28 17:25:01 -0800147#ifdef OPENSSL_IS_BORINGSSL
148// Enabled by EnableTimeCallbackForTesting. Should never be set in production
149// code.
150bool g_use_time_callback_for_testing = false;
151// Not used in production code. Actual time should be relative to Jan 1, 1970.
152void TimeCallbackForTesting(const SSL* ssl, struct timeval* out_clock) {
153 int64_t time = TimeNanos();
154 out_clock->tv_sec = time / kNumNanosecsPerSec;
155 out_clock->tv_usec = (time % kNumNanosecsPerSec) / kNumNanosecsPerMicrosec;
156}
157#endif
Guo-wei Shieh456696a2015-09-30 21:48:54 -0700158
Benjamin Wright8e98c602019-02-28 17:25:01 -0800159} // namespace
Guo-wei Shieh456696a2015-09-30 21:48:54 -0700160
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000161//////////////////////////////////////////////////////////////////////
162// StreamBIO
163//////////////////////////////////////////////////////////////////////
164
165static int stream_write(BIO* h, const char* buf, int num);
166static int stream_read(BIO* h, char* buf, int size);
167static int stream_puts(BIO* h, const char* str);
168static long stream_ctrl(BIO* h, int cmd, long arg1, void* arg2);
169static int stream_new(BIO* h);
170static int stream_free(BIO* data);
171
Jiawei Oueb0df082018-02-02 14:51:18 -0800172static BIO_METHOD* BIO_stream_method() {
173 static BIO_METHOD* method = [] {
174 BIO_METHOD* method = BIO_meth_new(BIO_TYPE_BIO, "stream");
175 BIO_meth_set_write(method, stream_write);
176 BIO_meth_set_read(method, stream_read);
177 BIO_meth_set_puts(method, stream_puts);
178 BIO_meth_set_ctrl(method, stream_ctrl);
179 BIO_meth_set_create(method, stream_new);
180 BIO_meth_set_destroy(method, stream_free);
181 return method;
182 }();
183 return method;
184}
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000185
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000186static BIO* BIO_new_stream(StreamInterface* stream) {
Jiawei Oueb0df082018-02-02 14:51:18 -0800187 BIO* ret = BIO_new(BIO_stream_method());
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700188 if (ret == nullptr) {
deadbeef37f5ecf2017-02-27 14:06:41 -0800189 return nullptr;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700190 }
Jiawei Oueb0df082018-02-02 14:51:18 -0800191 BIO_set_data(ret, stream);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000192 return ret;
193}
194
195// bio methods return 1 (or at least non-zero) on success and 0 on failure.
196
197static int stream_new(BIO* b) {
Jiawei Oueb0df082018-02-02 14:51:18 -0800198 BIO_set_shutdown(b, 0);
199 BIO_set_init(b, 1);
200 BIO_set_data(b, 0);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000201 return 1;
202}
203
204static int stream_free(BIO* b) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700205 if (b == nullptr) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000206 return 0;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700207 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000208 return 1;
209}
210
211static int stream_read(BIO* b, char* out, int outl) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700212 if (!out) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000213 return -1;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700214 }
Jiawei Oueb0df082018-02-02 14:51:18 -0800215 StreamInterface* stream = static_cast<StreamInterface*>(BIO_get_data(b));
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000216 BIO_clear_retry_flags(b);
217 size_t read;
218 int error;
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000219 StreamResult result = stream->Read(
220 rtc::MakeArrayView(reinterpret_cast<uint8_t*>(out), outl), read, error);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000221 if (result == SR_SUCCESS) {
henrike@webrtc.orgd89b69a2014-11-06 17:23:09 +0000222 return checked_cast<int>(read);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000223 } else if (result == SR_BLOCK) {
224 BIO_set_retry_read(b);
225 }
226 return -1;
227}
228
229static int stream_write(BIO* b, const char* in, int inl) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700230 if (!in) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000231 return -1;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700232 }
Jiawei Oueb0df082018-02-02 14:51:18 -0800233 StreamInterface* stream = static_cast<StreamInterface*>(BIO_get_data(b));
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000234 BIO_clear_retry_flags(b);
235 size_t written;
236 int error;
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000237 StreamResult result = stream->Write(
238 rtc::MakeArrayView(reinterpret_cast<const uint8_t*>(in), inl), written,
239 error);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000240 if (result == SR_SUCCESS) {
henrike@webrtc.orgd89b69a2014-11-06 17:23:09 +0000241 return checked_cast<int>(written);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000242 } else if (result == SR_BLOCK) {
243 BIO_set_retry_write(b);
244 }
245 return -1;
246}
247
248static int stream_puts(BIO* b, const char* str) {
henrike@webrtc.orgd89b69a2014-11-06 17:23:09 +0000249 return stream_write(b, str, checked_cast<int>(strlen(str)));
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000250}
251
252static long stream_ctrl(BIO* b, int cmd, long num, void* ptr) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000253 switch (cmd) {
254 case BIO_CTRL_RESET:
255 return 0;
Jiawei Ou018dd6e2018-01-30 12:13:48 -0800256 case BIO_CTRL_EOF: {
257 StreamInterface* stream = static_cast<StreamInterface*>(ptr);
258 // 1 means end-of-stream.
259 return (stream->GetState() == SS_CLOSED) ? 1 : 0;
260 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000261 case BIO_CTRL_WPENDING:
262 case BIO_CTRL_PENDING:
263 return 0;
264 case BIO_CTRL_FLUSH:
265 return 1;
Henrik Lundinf4baca52015-06-10 09:45:58 +0200266 case BIO_CTRL_DGRAM_QUERY_MTU:
267 // openssl defaults to mtu=256 unless we return something here.
268 // The handshake doesn't actually need to send packets above 1k,
269 // so this seems like a sensible value that should work in most cases.
270 // Webrtc uses the same value for video packets.
271 return 1200;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000272 default:
273 return 0;
274 }
275}
276
277/////////////////////////////////////////////////////////////////////////////
278// OpenSSLStreamAdapter
279/////////////////////////////////////////////////////////////////////////////
280
Guido Urdaneta14bba6e2020-09-25 16:00:51 +0200281static std::atomic<bool> g_use_legacy_tls_protocols_override(false);
282static std::atomic<bool> g_allow_legacy_tls_protocols(false);
283
284void SetAllowLegacyTLSProtocols(const absl::optional<bool>& allow) {
285 g_use_legacy_tls_protocols_override.store(allow.has_value());
286 if (allow.has_value())
287 g_allow_legacy_tls_protocols.store(allow.value());
288}
289
290bool ShouldAllowLegacyTLSProtocols() {
291 return g_use_legacy_tls_protocols_override.load()
292 ? g_allow_legacy_tls_protocols.load()
Guido Urdanetaae2e8642020-10-26 09:55:26 +0100293 : webrtc::field_trial::IsEnabled("WebRTC-LegacyTlsProtocols");
Guido Urdaneta14bba6e2020-09-25 16:00:51 +0200294}
295
Harald Alvestrand8515d5a2020-03-20 22:51:32 +0100296OpenSSLStreamAdapter::OpenSSLStreamAdapter(
297 std::unique_ptr<StreamInterface> stream)
Niels Möller0131a4d2021-04-16 09:16:21 +0200298 : stream_(std::move(stream)),
Tommi04482982020-10-05 12:43:53 +0000299 owner_(rtc::Thread::Current()),
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000300 state_(SSL_NONE),
301 role_(SSL_CLIENT),
Guo-wei Shieha7446d22016-01-11 15:27:03 -0800302 ssl_read_needs_write_(false),
303 ssl_write_needs_read_(false),
deadbeef37f5ecf2017-02-27 14:06:41 -0800304 ssl_(nullptr),
305 ssl_ctx_(nullptr),
Joachim Bauch831c5582015-05-20 12:48:41 +0200306 ssl_mode_(SSL_MODE_TLS),
Harald Alvestrand13799132020-03-09 19:39:36 +0100307 ssl_max_version_(SSL_PROTOCOL_TLS_12),
308 // Default is to support legacy TLS protocols.
309 // This will be changed to default non-support in M82 or M83.
Niels Möller0131a4d2021-04-16 09:16:21 +0200310 support_legacy_tls_protocols_flag_(ShouldAllowLegacyTLSProtocols()) {
311 stream_->SignalEvent.connect(this, &OpenSSLStreamAdapter::OnEvent);
312}
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000313
314OpenSSLStreamAdapter::~OpenSSLStreamAdapter() {
Tommi04482982020-10-05 12:43:53 +0000315 timeout_task_.Stop();
deadbeef89824f62016-09-30 11:55:43 -0700316 Cleanup(0);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000317}
318
Harald Alvestrand8515d5a2020-03-20 22:51:32 +0100319void OpenSSLStreamAdapter::SetIdentity(std::unique_ptr<SSLIdentity> identity) {
deadbeef89824f62016-09-30 11:55:43 -0700320 RTC_DCHECK(!identity_);
Taylor Brandstetter165c6182020-12-10 16:23:03 -0800321#ifdef OPENSSL_IS_BORINGSSL
322 identity_.reset(static_cast<BoringSSLIdentity*>(identity.release()));
323#else
Harald Alvestrand8515d5a2020-03-20 22:51:32 +0100324 identity_.reset(static_cast<OpenSSLIdentity*>(identity.release()));
Taylor Brandstetter165c6182020-12-10 16:23:03 -0800325#endif
Harald Alvestrand8515d5a2020-03-20 22:51:32 +0100326}
327
Taylor Brandstetter165c6182020-12-10 16:23:03 -0800328SSLIdentity* OpenSSLStreamAdapter::GetIdentityForTesting() const {
Harald Alvestrand8515d5a2020-03-20 22:51:32 +0100329 return identity_.get();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000330}
331
332void OpenSSLStreamAdapter::SetServerRole(SSLRole role) {
333 role_ = role;
334}
335
deadbeef89824f62016-09-30 11:55:43 -0700336bool OpenSSLStreamAdapter::SetPeerCertificateDigest(
Ali Tofigh7fa90572022-03-17 15:47:49 +0100337 absl::string_view digest_alg,
deadbeef89824f62016-09-30 11:55:43 -0700338 const unsigned char* digest_val,
339 size_t digest_len,
340 SSLPeerCertificateDigestError* error) {
341 RTC_DCHECK(!peer_certificate_verified_);
Benjamin Wright5d355542018-10-26 17:57:00 -0700342 RTC_DCHECK(!HasPeerCertificateDigest());
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000343 size_t expected_len;
deadbeef89824f62016-09-30 11:55:43 -0700344 if (error) {
345 *error = SSLPeerCertificateDigestError::NONE;
346 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000347
348 if (!OpenSSLDigest::GetDigestSize(digest_alg, &expected_len)) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100349 RTC_LOG(LS_WARNING) << "Unknown digest algorithm: " << digest_alg;
deadbeef89824f62016-09-30 11:55:43 -0700350 if (error) {
351 *error = SSLPeerCertificateDigestError::UNKNOWN_ALGORITHM;
352 }
deadbeef81f6f4f2016-09-19 17:20:52 -0700353 return false;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000354 }
deadbeef89824f62016-09-30 11:55:43 -0700355 if (expected_len != digest_len) {
356 if (error) {
357 *error = SSLPeerCertificateDigestError::INVALID_LENGTH;
358 }
deadbeef81f6f4f2016-09-19 17:20:52 -0700359 return false;
deadbeef89824f62016-09-30 11:55:43 -0700360 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000361
362 peer_certificate_digest_value_.SetData(digest_val, digest_len);
Ali Tofigh7fa90572022-03-17 15:47:49 +0100363 peer_certificate_digest_algorithm_ = std::string(digest_alg);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000364
Taylor Brandstetterc3928662018-02-23 13:04:51 -0800365 if (!peer_cert_chain_) {
deadbeef89824f62016-09-30 11:55:43 -0700366 // Normal case, where the digest is set before we obtain the certificate
367 // from the handshake.
368 return true;
369 }
370
371 if (!VerifyPeerCertificate()) {
372 Error("SetPeerCertificateDigest", -1, SSL_AD_BAD_CERTIFICATE, false);
373 if (error) {
374 *error = SSLPeerCertificateDigestError::VERIFICATION_FAILED;
375 }
376 return false;
377 }
378
379 if (state_ == SSL_CONNECTED) {
380 // Post the event asynchronously to unwind the stack. The caller
381 // of ContinueSSL may be the same object listening for these
382 // events and may not be prepared for reentrancy.
383 PostEvent(SE_OPEN | SE_READ | SE_WRITE, 0);
384 }
385
deadbeef81f6f4f2016-09-19 17:20:52 -0700386 return true;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000387}
388
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800389std::string OpenSSLStreamAdapter::SslCipherSuiteToName(int cipher_suite) {
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100390#ifdef OPENSSL_IS_BORINGSSL
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800391 const SSL_CIPHER* ssl_cipher = SSL_get_cipher_by_value(cipher_suite);
Guo-wei Shieh456696a2015-09-30 21:48:54 -0700392 if (!ssl_cipher) {
393 return std::string();
394 }
David Benjamina8f73762017-09-28 15:49:42 -0400395 return SSL_CIPHER_standard_name(ssl_cipher);
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100396#else
Joachim Reiersene457e432022-10-21 12:08:22 -0700397 const int openssl_cipher_id = 0x03000000L | cipher_suite;
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100398 for (const SslCipherMapEntry* entry = kSslCipherMap; entry->rfc_name;
399 ++entry) {
Joachim Reiersene457e432022-10-21 12:08:22 -0700400 if (openssl_cipher_id == static_cast<int>(entry->openssl_id)) {
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100401 return entry->rfc_name;
402 }
403 }
404 return std::string();
405#endif
Guo-wei Shieh456696a2015-09-30 21:48:54 -0700406}
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +0000407
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800408bool OpenSSLStreamAdapter::GetSslCipherSuite(int* cipher_suite) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700409 if (state_ != SSL_CONNECTED) {
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +0000410 return false;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700411 }
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +0000412
413 const SSL_CIPHER* current_cipher = SSL_get_current_cipher(ssl_);
deadbeef37f5ecf2017-02-27 14:06:41 -0800414 if (current_cipher == nullptr) {
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +0000415 return false;
416 }
417
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800418 *cipher_suite = static_cast<uint16_t>(SSL_CIPHER_get_id(current_cipher));
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +0000419 return true;
420}
421
Harald Alvestrand5cb78072019-10-28 09:51:17 +0100422SSLProtocolVersion OpenSSLStreamAdapter::GetSslVersion() const {
Benjamin Wright8e98c602019-02-28 17:25:01 -0800423 if (state_ != SSL_CONNECTED) {
Harald Alvestrand5cb78072019-10-28 09:51:17 +0100424 return SSL_PROTOCOL_NOT_GIVEN;
Benjamin Wright8e98c602019-02-28 17:25:01 -0800425 }
torbjorng43166b82016-03-11 00:06:47 -0800426
427 int ssl_version = SSL_version(ssl_);
428 if (ssl_mode_ == SSL_MODE_DTLS) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700429 if (ssl_version == DTLS1_VERSION) {
torbjorng43166b82016-03-11 00:06:47 -0800430 return SSL_PROTOCOL_DTLS_10;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700431 } else if (ssl_version == DTLS1_2_VERSION) {
torbjorng43166b82016-03-11 00:06:47 -0800432 return SSL_PROTOCOL_DTLS_12;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700433 }
torbjorng43166b82016-03-11 00:06:47 -0800434 } else {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700435 if (ssl_version == TLS1_VERSION) {
torbjorng43166b82016-03-11 00:06:47 -0800436 return SSL_PROTOCOL_TLS_10;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700437 } else if (ssl_version == TLS1_1_VERSION) {
torbjorng43166b82016-03-11 00:06:47 -0800438 return SSL_PROTOCOL_TLS_11;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700439 } else if (ssl_version == TLS1_2_VERSION) {
torbjorng43166b82016-03-11 00:06:47 -0800440 return SSL_PROTOCOL_TLS_12;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700441 }
torbjorng43166b82016-03-11 00:06:47 -0800442 }
443
Harald Alvestrand5cb78072019-10-28 09:51:17 +0100444 return SSL_PROTOCOL_NOT_GIVEN;
445}
446
447bool OpenSSLStreamAdapter::GetSslVersionBytes(int* version) const {
448 if (state_ != SSL_CONNECTED) {
449 return false;
450 }
451 *version = SSL_version(ssl_);
452 return true;
torbjorng43166b82016-03-11 00:06:47 -0800453}
454
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000455// Key Extractor interface
Ali Tofigh7fa90572022-03-17 15:47:49 +0100456bool OpenSSLStreamAdapter::ExportKeyingMaterial(absl::string_view label,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200457 const uint8_t* context,
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000458 size_t context_len,
459 bool use_context,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200460 uint8_t* result,
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000461 size_t result_len) {
Ali Tofigh7fa90572022-03-17 15:47:49 +0100462 if (SSL_export_keying_material(ssl_, result, result_len, label.data(),
463 label.length(), context, context_len,
464 use_context) != 1) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000465 return false;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700466 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000467 return true;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000468}
469
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800470bool OpenSSLStreamAdapter::SetDtlsSrtpCryptoSuites(
471 const std::vector<int>& ciphers) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700472 if (state_ != SSL_NONE) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000473 return false;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700474 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000475
Benjamin Wright8e98c602019-02-28 17:25:01 -0800476 std::string internal_ciphers;
477 for (const int cipher : ciphers) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000478 bool found = false;
Benjamin Wright8e98c602019-02-28 17:25:01 -0800479 for (const auto& entry : kSrtpCipherMap) {
480 if (cipher == entry.id) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000481 found = true;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700482 if (!internal_ciphers.empty()) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000483 internal_ciphers += ":";
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700484 }
Benjamin Wright8e98c602019-02-28 17:25:01 -0800485 internal_ciphers += entry.internal_name;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000486 break;
487 }
488 }
489
490 if (!found) {
Benjamin Wright8e98c602019-02-28 17:25:01 -0800491 RTC_LOG(LS_ERROR) << "Could not find cipher: " << cipher;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000492 return false;
493 }
494 }
495
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700496 if (internal_ciphers.empty()) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000497 return false;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700498 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000499
500 srtp_ciphers_ = internal_ciphers;
501 return true;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000502}
503
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800504bool OpenSSLStreamAdapter::GetDtlsSrtpCryptoSuite(int* crypto_suite) {
deadbeef89824f62016-09-30 11:55:43 -0700505 RTC_DCHECK(state_ == SSL_CONNECTED);
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700506 if (state_ != SSL_CONNECTED) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000507 return false;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700508 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000509
Yves Gerey665174f2018-06-19 15:03:05 +0200510 const SRTP_PROTECTION_PROFILE* srtp_profile =
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000511 SSL_get_selected_srtp_profile(ssl_);
512
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700513 if (!srtp_profile) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000514 return false;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700515 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000516
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800517 *crypto_suite = srtp_profile->id;
deadbeef89824f62016-09-30 11:55:43 -0700518 RTC_DCHECK(!SrtpCryptoSuiteToName(*crypto_suite).empty());
Guo-wei Shieh521ed7b2015-11-18 19:41:53 -0800519 return true;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000520}
521
deadbeef89824f62016-09-30 11:55:43 -0700522bool OpenSSLStreamAdapter::IsTlsConnected() {
523 return state_ == SSL_CONNECTED;
524}
525
Taylor Brandstetterc8762a82016-08-11 12:01:49 -0700526int OpenSSLStreamAdapter::StartSSL() {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700527 // Don't allow StartSSL to be called twice.
deadbeef89824f62016-09-30 11:55:43 -0700528 if (state_ != SSL_NONE) {
deadbeef89824f62016-09-30 11:55:43 -0700529 return -1;
530 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000531
Niels Möller0131a4d2021-04-16 09:16:21 +0200532 if (stream_->GetState() != SS_OPEN) {
Taylor Brandstetterc8762a82016-08-11 12:01:49 -0700533 state_ = SSL_WAIT;
534 return 0;
535 }
536
537 state_ = SSL_CONNECTING;
538 if (int err = BeginSSL()) {
deadbeef89824f62016-09-30 11:55:43 -0700539 Error("BeginSSL", err, 0, false);
Taylor Brandstetterc8762a82016-08-11 12:01:49 -0700540 return err;
541 }
542
543 return 0;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000544}
545
546void OpenSSLStreamAdapter::SetMode(SSLMode mode) {
deadbeef89824f62016-09-30 11:55:43 -0700547 RTC_DCHECK(state_ == SSL_NONE);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000548 ssl_mode_ = mode;
549}
550
Joachim Bauch831c5582015-05-20 12:48:41 +0200551void OpenSSLStreamAdapter::SetMaxProtocolVersion(SSLProtocolVersion version) {
deadbeef37f5ecf2017-02-27 14:06:41 -0800552 RTC_DCHECK(ssl_ctx_ == nullptr);
Joachim Bauch831c5582015-05-20 12:48:41 +0200553 ssl_max_version_ = version;
554}
555
Yves Gerey665174f2018-06-19 15:03:05 +0200556void OpenSSLStreamAdapter::SetInitialRetransmissionTimeout(int timeout_ms) {
deadbeef37f5ecf2017-02-27 14:06:41 -0800557 RTC_DCHECK(ssl_ctx_ == nullptr);
skvladd0309122017-02-02 17:18:37 -0800558 dtls_handshake_timeout_ms_ = timeout_ms;
559}
560
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000561//
562// StreamInterface Implementation
563//
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000564// Backwards compatible Write() method using deprecated API.
565// Needed because deprecated API is still =0 in API definition.
Yves Gerey665174f2018-06-19 15:03:05 +0200566StreamResult OpenSSLStreamAdapter::Write(const void* data,
567 size_t data_len,
568 size_t* written,
569 int* error) {
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000570 // TODO(bugs.webrtc.org/14632): Consider doing
571 // RTC_CHECK_NOTREACHED(); when downstream usage is eliminated.
572 size_t dummy_written;
573 int dummy_error;
574 return Write(
575 rtc::MakeArrayView(reinterpret_cast<const uint8_t*>(data), data_len),
576 written ? *written : dummy_written, error ? *error : dummy_error);
577}
578
579StreamResult OpenSSLStreamAdapter::Write(rtc::ArrayView<const uint8_t> data,
580 size_t& written,
581 int& error) {
582 RTC_DLOG(LS_VERBOSE) << "OpenSSLStreamAdapter::Write(" << data.size() << ")";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000583
584 switch (state_) {
Yves Gerey665174f2018-06-19 15:03:05 +0200585 case SSL_NONE:
586 // pass-through in clear text
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000587 return stream_->Write(data, written, error);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000588
Yves Gerey665174f2018-06-19 15:03:05 +0200589 case SSL_WAIT:
590 case SSL_CONNECTING:
deadbeef89824f62016-09-30 11:55:43 -0700591 return SR_BLOCK;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000592
Yves Gerey665174f2018-06-19 15:03:05 +0200593 case SSL_CONNECTED:
Benjamin Wright5d355542018-10-26 17:57:00 -0700594 if (WaitingToVerifyPeerCertificate()) {
Yves Gerey665174f2018-06-19 15:03:05 +0200595 return SR_BLOCK;
596 }
597 break;
598
599 case SSL_ERROR:
600 case SSL_CLOSED:
601 default:
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000602 error = ssl_error_code_;
Yves Gerey665174f2018-06-19 15:03:05 +0200603 return SR_ERROR;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000604 }
605
606 // OpenSSL will return an error if we try to write zero bytes
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000607 if (data.size() == 0) {
608 written = 0;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000609 return SR_SUCCESS;
610 }
611
612 ssl_write_needs_read_ = false;
613
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000614 int code = SSL_write(ssl_, data.data(), checked_cast<int>(data.size()));
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000615 int ssl_error = SSL_get_error(ssl_, code);
616 switch (ssl_error) {
Yves Gerey665174f2018-06-19 15:03:05 +0200617 case SSL_ERROR_NONE:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200618 RTC_DLOG(LS_VERBOSE) << " -- success";
Yves Gerey665174f2018-06-19 15:03:05 +0200619 RTC_DCHECK_GT(code, 0);
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000620 RTC_DCHECK_LE(code, data.size());
621 written = code;
Yves Gerey665174f2018-06-19 15:03:05 +0200622 return SR_SUCCESS;
623 case SSL_ERROR_WANT_READ:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200624 RTC_DLOG(LS_VERBOSE) << " -- error want read";
Yves Gerey665174f2018-06-19 15:03:05 +0200625 ssl_write_needs_read_ = true;
626 return SR_BLOCK;
627 case SSL_ERROR_WANT_WRITE:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200628 RTC_DLOG(LS_VERBOSE) << " -- error want write";
Yves Gerey665174f2018-06-19 15:03:05 +0200629 return SR_BLOCK;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000630
Yves Gerey665174f2018-06-19 15:03:05 +0200631 case SSL_ERROR_ZERO_RETURN:
632 default:
633 Error("SSL_write", (ssl_error ? ssl_error : -1), 0, false);
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000634 error = ssl_error_code_;
Yves Gerey665174f2018-06-19 15:03:05 +0200635 return SR_ERROR;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000636 }
637 // not reached
638}
639
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000640// Backwards compatible Read() method using deprecated API.
Yves Gerey665174f2018-06-19 15:03:05 +0200641StreamResult OpenSSLStreamAdapter::Read(void* data,
642 size_t data_len,
643 size_t* read,
644 int* error) {
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000645 // TODO(bugs.webrtc.org/14632): Consider doing
646 // RTC_CHECK_NOTREACHED() when downstream usage is thought to be eliminated.
647 size_t dummy_read;
648 int dummy_error;
649 return Read(rtc::MakeArrayView(reinterpret_cast<uint8_t*>(data), data_len),
650 read ? *read : dummy_read, error ? *error : dummy_error);
651}
652
653StreamResult OpenSSLStreamAdapter::Read(rtc::ArrayView<uint8_t> data,
654 size_t& read,
655 int& error) {
656 RTC_DLOG(LS_VERBOSE) << "OpenSSLStreamAdapter::Read(" << data.size() << ")";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000657 switch (state_) {
658 case SSL_NONE:
659 // pass-through in clear text
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000660 return stream_->Read(data, read, error);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000661 case SSL_WAIT:
662 case SSL_CONNECTING:
663 return SR_BLOCK;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000664 case SSL_CONNECTED:
Benjamin Wright5d355542018-10-26 17:57:00 -0700665 if (WaitingToVerifyPeerCertificate()) {
deadbeef89824f62016-09-30 11:55:43 -0700666 return SR_BLOCK;
667 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000668 break;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000669 case SSL_CLOSED:
670 return SR_EOS;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000671 case SSL_ERROR:
672 default:
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000673 error = ssl_error_code_;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000674 return SR_ERROR;
675 }
676
677 // Don't trust OpenSSL with zero byte reads
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000678 if (data.size() == 0) {
679 read = 0;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000680 return SR_SUCCESS;
681 }
682
683 ssl_read_needs_write_ = false;
684
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000685 const int code = SSL_read(ssl_, data.data(), checked_cast<int>(data.size()));
Benjamin Wrightf54e30b2019-02-26 17:33:50 -0800686 const int ssl_error = SSL_get_error(ssl_, code);
687
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000688 switch (ssl_error) {
689 case SSL_ERROR_NONE:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200690 RTC_DLOG(LS_VERBOSE) << " -- success";
kwibergee89e782017-08-09 17:22:01 -0700691 RTC_DCHECK_GT(code, 0);
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000692 RTC_DCHECK_LE(code, data.size());
693 read = code;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000694
695 if (ssl_mode_ == SSL_MODE_DTLS) {
696 // Enforce atomic reads -- this is a short read
697 unsigned int pending = SSL_pending(ssl_);
698
699 if (pending) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200700 RTC_DLOG(LS_INFO) << " -- short DTLS read. flushing";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000701 FlushInput(pending);
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000702 error = SSE_MSG_TRUNC;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000703 return SR_ERROR;
704 }
705 }
706 return SR_SUCCESS;
707 case SSL_ERROR_WANT_READ:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200708 RTC_DLOG(LS_VERBOSE) << " -- error want read";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000709 return SR_BLOCK;
710 case SSL_ERROR_WANT_WRITE:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200711 RTC_DLOG(LS_VERBOSE) << " -- error want write";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000712 ssl_read_needs_write_ = true;
713 return SR_BLOCK;
714 case SSL_ERROR_ZERO_RETURN:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200715 RTC_DLOG(LS_VERBOSE) << " -- remote side closed";
deadbeef89824f62016-09-30 11:55:43 -0700716 Close();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000717 return SR_EOS;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000718 default:
deadbeef89824f62016-09-30 11:55:43 -0700719 Error("SSL_read", (ssl_error ? ssl_error : -1), 0, false);
Harald Alvestrand11840ce2022-11-10 10:50:50 +0000720 error = ssl_error_code_;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000721 return SR_ERROR;
722 }
723 // not reached
724}
725
726void OpenSSLStreamAdapter::FlushInput(unsigned int left) {
727 unsigned char buf[2048];
728
729 while (left) {
730 // This should always succeed
Benjamin Wrightf54e30b2019-02-26 17:33:50 -0800731 const int toread = (sizeof(buf) < left) ? sizeof(buf) : left;
732 const int code = SSL_read(ssl_, buf, toread);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000733
Benjamin Wrightf54e30b2019-02-26 17:33:50 -0800734 const int ssl_error = SSL_get_error(ssl_, code);
deadbeef89824f62016-09-30 11:55:43 -0700735 RTC_DCHECK(ssl_error == SSL_ERROR_NONE);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000736
737 if (ssl_error != SSL_ERROR_NONE) {
Jonas Olssonaddc3802018-02-01 09:53:06 +0100738 RTC_DLOG(LS_VERBOSE) << " -- error " << code;
deadbeef89824f62016-09-30 11:55:43 -0700739 Error("SSL_read", (ssl_error ? ssl_error : -1), 0, false);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000740 return;
741 }
742
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200743 RTC_DLOG(LS_VERBOSE) << " -- flushed " << code << " bytes";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000744 left -= code;
745 }
746}
747
748void OpenSSLStreamAdapter::Close() {
deadbeef89824f62016-09-30 11:55:43 -0700749 Cleanup(0);
750 RTC_DCHECK(state_ == SSL_CLOSED || state_ == SSL_ERROR);
751 // When we're closed at SSL layer, also close the stream level which
752 // performs necessary clean up. Otherwise, a new incoming packet after
753 // this could overflow the stream buffer.
Niels Möller0131a4d2021-04-16 09:16:21 +0200754 stream_->Close();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000755}
756
757StreamState OpenSSLStreamAdapter::GetState() const {
758 switch (state_) {
759 case SSL_WAIT:
760 case SSL_CONNECTING:
761 return SS_OPENING;
762 case SSL_CONNECTED:
Benjamin Wright5d355542018-10-26 17:57:00 -0700763 if (WaitingToVerifyPeerCertificate()) {
deadbeef89824f62016-09-30 11:55:43 -0700764 return SS_OPENING;
765 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000766 return SS_OPEN;
767 default:
768 return SS_CLOSED;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700769 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000770 // not reached
771}
772
Yves Gerey665174f2018-06-19 15:03:05 +0200773void OpenSSLStreamAdapter::OnEvent(StreamInterface* stream,
774 int events,
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000775 int err) {
776 int events_to_signal = 0;
777 int signal_error = 0;
Niels Möller0131a4d2021-04-16 09:16:21 +0200778 RTC_DCHECK(stream == stream_.get());
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700779
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000780 if ((events & SE_OPEN)) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200781 RTC_DLOG(LS_VERBOSE) << "OpenSSLStreamAdapter::OnEvent SE_OPEN";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000782 if (state_ != SSL_WAIT) {
deadbeef89824f62016-09-30 11:55:43 -0700783 RTC_DCHECK(state_ == SSL_NONE);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000784 events_to_signal |= SE_OPEN;
785 } else {
786 state_ = SSL_CONNECTING;
787 if (int err = BeginSSL()) {
deadbeef89824f62016-09-30 11:55:43 -0700788 Error("BeginSSL", err, 0, true);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000789 return;
790 }
791 }
792 }
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700793
Yves Gerey665174f2018-06-19 15:03:05 +0200794 if ((events & (SE_READ | SE_WRITE))) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200795 RTC_DLOG(LS_VERBOSE) << "OpenSSLStreamAdapter::OnEvent"
796 << ((events & SE_READ) ? " SE_READ" : "")
797 << ((events & SE_WRITE) ? " SE_WRITE" : "");
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000798 if (state_ == SSL_NONE) {
Yves Gerey665174f2018-06-19 15:03:05 +0200799 events_to_signal |= events & (SE_READ | SE_WRITE);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000800 } else if (state_ == SSL_CONNECTING) {
801 if (int err = ContinueSSL()) {
deadbeef89824f62016-09-30 11:55:43 -0700802 Error("ContinueSSL", err, 0, true);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000803 return;
804 }
805 } else if (state_ == SSL_CONNECTED) {
806 if (((events & SE_READ) && ssl_write_needs_read_) ||
807 (events & SE_WRITE)) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200808 RTC_DLOG(LS_VERBOSE) << " -- onStreamWriteable";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000809 events_to_signal |= SE_WRITE;
810 }
811 if (((events & SE_WRITE) && ssl_read_needs_write_) ||
812 (events & SE_READ)) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200813 RTC_DLOG(LS_VERBOSE) << " -- onStreamReadable";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000814 events_to_signal |= SE_READ;
815 }
816 }
817 }
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700818
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000819 if ((events & SE_CLOSE)) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200820 RTC_DLOG(LS_VERBOSE) << "OpenSSLStreamAdapter::OnEvent(SE_CLOSE, " << err
821 << ")";
deadbeef89824f62016-09-30 11:55:43 -0700822 Cleanup(0);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000823 events_to_signal |= SE_CLOSE;
824 // SE_CLOSE is the only event that uses the final parameter to OnEvent().
deadbeef89824f62016-09-30 11:55:43 -0700825 RTC_DCHECK(signal_error == 0);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000826 signal_error = err;
827 }
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700828
829 if (events_to_signal) {
Niels Möller0131a4d2021-04-16 09:16:21 +0200830 // Note that the adapter presents itself as the origin of the stream events,
831 // since users of the adapter may not recognize the adapted object.
832 SignalEvent(this, events_to_signal, signal_error);
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700833 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000834}
835
Tommi04482982020-10-05 12:43:53 +0000836void OpenSSLStreamAdapter::PostEvent(int events, int err) {
Danil Chapovalov5286dcf2022-07-18 17:04:56 +0200837 owner_->PostTask(SafeTask(task_safety_.flag(), [this, events, err]() {
838 SignalEvent(this, events, err);
839 }));
Tommi04482982020-10-05 12:43:53 +0000840}
841
842void OpenSSLStreamAdapter::SetTimeout(int delay_ms) {
843 // We need to accept 0 delay here as well as >0 delay, because
844 // DTLSv1_get_timeout seems to frequently return 0 ms.
845 RTC_DCHECK_GE(delay_ms, 0);
846 RTC_DCHECK(!timeout_task_.Running());
847
848 timeout_task_ = webrtc::RepeatingTaskHandle::DelayedStart(
849 owner_, webrtc::TimeDelta::Millis(delay_ms),
850 [flag = task_safety_.flag(), this]() {
851 if (flag->alive()) {
852 RTC_DLOG(LS_INFO) << "DTLS timeout expired";
853 timeout_task_.Stop();
Jonas Oreland808f4942021-06-16 13:42:20 +0200854 int res = DTLSv1_handle_timeout(ssl_);
855 if (res > 0) {
856 RTC_LOG(LS_INFO) << "DTLS retransmission";
857 } else if (res < 0) {
858 RTC_LOG(LS_INFO) << "DTLSv1_handle_timeout() return -1";
Philipp Hancke9c83d9d2022-04-28 19:01:28 +0200859 Error("DTLSv1_handle_timeout", res, -1, true);
860 return webrtc::TimeDelta::PlusInfinity();
Jonas Oreland808f4942021-06-16 13:42:20 +0200861 }
Tommi04482982020-10-05 12:43:53 +0000862 ContinueSSL();
863 } else {
Artem Titovd3251962021-11-15 16:57:07 +0100864 RTC_DCHECK_NOTREACHED();
Tommi04482982020-10-05 12:43:53 +0000865 }
866 // This callback will never run again (stopped above).
867 return webrtc::TimeDelta::PlusInfinity();
868 });
869}
870
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000871int OpenSSLStreamAdapter::BeginSSL() {
deadbeef89824f62016-09-30 11:55:43 -0700872 RTC_DCHECK(state_ == SSL_CONNECTING);
Taylor Brandstetterc8762a82016-08-11 12:01:49 -0700873 // The underlying stream has opened.
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200874 RTC_DLOG(LS_INFO) << "BeginSSL with peer.";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000875
deadbeef37f5ecf2017-02-27 14:06:41 -0800876 BIO* bio = nullptr;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000877
Taylor Brandstetterc8762a82016-08-11 12:01:49 -0700878 // First set up the context.
deadbeef37f5ecf2017-02-27 14:06:41 -0800879 RTC_DCHECK(ssl_ctx_ == nullptr);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000880 ssl_ctx_ = SetupSSLContext();
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700881 if (!ssl_ctx_) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000882 return -1;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700883 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000884
Niels Möller0131a4d2021-04-16 09:16:21 +0200885 bio = BIO_new_stream(stream_.get());
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700886 if (!bio) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000887 return -1;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700888 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000889
890 ssl_ = SSL_new(ssl_ctx_);
891 if (!ssl_) {
892 BIO_free(bio);
893 return -1;
894 }
895
896 SSL_set_app_data(ssl_, this);
897
898 SSL_set_bio(ssl_, bio, bio); // the SSL object owns the bio now.
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100899 if (ssl_mode_ == SSL_MODE_DTLS) {
Taylor Brandstetter4f0dfbd2016-06-15 17:15:23 -0700900#ifdef OPENSSL_IS_BORINGSSL
skvladd0309122017-02-02 17:18:37 -0800901 DTLSv1_set_initial_timeout_duration(ssl_, dtls_handshake_timeout_ms_);
Taylor Brandstetter4f0dfbd2016-06-15 17:15:23 -0700902#else
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +0100903 // Enable read-ahead for DTLS so whole packets are read from internal BIO
904 // before parsing. This is done internally by BoringSSL for DTLS.
905 SSL_set_read_ahead(ssl_, 1);
philipel49c08692016-05-24 01:49:43 -0700906#endif
Taylor Brandstetter4f0dfbd2016-06-15 17:15:23 -0700907 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000908
909 SSL_set_mode(ssl_, SSL_MODE_ENABLE_PARTIAL_WRITE |
Yves Gerey665174f2018-06-19 15:03:05 +0200910 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000911
912 // Do the connect
913 return ContinueSSL();
914}
915
916int OpenSSLStreamAdapter::ContinueSSL() {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200917 RTC_DLOG(LS_VERBOSE) << "ContinueSSL";
deadbeef89824f62016-09-30 11:55:43 -0700918 RTC_DCHECK(state_ == SSL_CONNECTING);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000919
920 // Clear the DTLS timer
Tommi04482982020-10-05 12:43:53 +0000921 timeout_task_.Stop();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000922
Benjamin Wrightf54e30b2019-02-26 17:33:50 -0800923 const int code = (role_ == SSL_CLIENT) ? SSL_connect(ssl_) : SSL_accept(ssl_);
924 const int ssl_error = SSL_get_error(ssl_, code);
925
926 switch (ssl_error) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000927 case SSL_ERROR_NONE:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200928 RTC_DLOG(LS_VERBOSE) << " -- success";
deadbeef89824f62016-09-30 11:55:43 -0700929 // By this point, OpenSSL should have given us a certificate, or errored
930 // out if one was missing.
Benjamin Wrightb19b4972018-10-25 10:46:49 -0700931 RTC_DCHECK(peer_cert_chain_ || !GetClientAuthEnabled());
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000932
933 state_ = SSL_CONNECTED;
Benjamin Wright5d355542018-10-26 17:57:00 -0700934 if (!WaitingToVerifyPeerCertificate()) {
deadbeef89824f62016-09-30 11:55:43 -0700935 // We have everything we need to start the connection, so signal
936 // SE_OPEN. If we need a client certificate fingerprint and don't have
937 // it yet, we'll instead signal SE_OPEN in SetPeerCertificateDigest.
938 //
Taylor Brandstetterfe69a742016-09-30 17:34:32 -0700939 // TODO(deadbeef): Post this event asynchronously to unwind the stack.
940 // The caller of ContinueSSL may be the same object listening for these
941 // events and may not be prepared for reentrancy.
942 // PostEvent(SE_OPEN | SE_READ | SE_WRITE, 0);
Niels Möller0131a4d2021-04-16 09:16:21 +0200943 SignalEvent(this, SE_OPEN | SE_READ | SE_WRITE, 0);
deadbeef89824f62016-09-30 11:55:43 -0700944 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000945 break;
946
947 case SSL_ERROR_WANT_READ: {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200948 RTC_DLOG(LS_VERBOSE) << " -- error want read";
Mirko Bonadei675513b2017-11-09 11:09:25 +0100949 struct timeval timeout;
950 if (DTLSv1_get_timeout(ssl_, &timeout)) {
951 int delay = timeout.tv_sec * 1000 + timeout.tv_usec / 1000;
Tommi04482982020-10-05 12:43:53 +0000952 SetTimeout(delay);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000953 }
Yves Gerey665174f2018-06-19 15:03:05 +0200954 } break;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000955
956 case SSL_ERROR_WANT_WRITE:
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200957 RTC_DLOG(LS_VERBOSE) << " -- error want write";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000958 break;
959
960 case SSL_ERROR_ZERO_RETURN:
961 default:
zhihuangd82eee02016-08-26 11:25:05 -0700962 SSLHandshakeError ssl_handshake_err = SSLHandshakeError::UNKNOWN;
963 int err_code = ERR_peek_last_error();
964 if (err_code != 0 && ERR_GET_REASON(err_code) == SSL_R_NO_SHARED_CIPHER) {
965 ssl_handshake_err = SSLHandshakeError::INCOMPATIBLE_CIPHERSUITE;
966 }
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200967 RTC_DLOG(LS_VERBOSE) << " -- error " << code << ", " << err_code << ", "
968 << ERR_GET_REASON(err_code);
Sam Zackrissonb298f742020-10-06 11:40:30 +0000969 SignalSSLHandshakeError(ssl_handshake_err);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000970 return (ssl_error != 0) ? ssl_error : -1;
971 }
972
973 return 0;
974}
975
Ali Tofigh2ab914c2022-04-13 12:55:15 +0200976void OpenSSLStreamAdapter::Error(absl::string_view context,
deadbeef89824f62016-09-30 11:55:43 -0700977 int err,
978 uint8_t alert,
979 bool signal) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100980 RTC_LOG(LS_WARNING) << "OpenSSLStreamAdapter::Error(" << context << ", "
981 << err << ", " << static_cast<int>(alert) << ")";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000982 state_ = SSL_ERROR;
983 ssl_error_code_ = err;
deadbeef89824f62016-09-30 11:55:43 -0700984 Cleanup(alert);
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700985 if (signal) {
Niels Möller0131a4d2021-04-16 09:16:21 +0200986 SignalEvent(this, SE_CLOSE, err);
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -0700987 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000988}
989
deadbeef89824f62016-09-30 11:55:43 -0700990void OpenSSLStreamAdapter::Cleanup(uint8_t alert) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +0200991 RTC_DLOG(LS_INFO) << "Cleanup";
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000992
993 if (state_ != SSL_ERROR) {
994 state_ = SSL_CLOSED;
995 ssl_error_code_ = 0;
996 }
997
998 if (ssl_) {
deadbeef89824f62016-09-30 11:55:43 -0700999 int ret;
1000// SSL_send_fatal_alert is only available in BoringSSL.
1001#ifdef OPENSSL_IS_BORINGSSL
1002 if (alert) {
1003 ret = SSL_send_fatal_alert(ssl_, alert);
1004 if (ret < 0) {
Mirko Bonadei675513b2017-11-09 11:09:25 +01001005 RTC_LOG(LS_WARNING) << "SSL_send_fatal_alert failed, error = "
1006 << SSL_get_error(ssl_, ret);
deadbeef89824f62016-09-30 11:55:43 -07001007 }
1008 } else {
1009#endif
1010 ret = SSL_shutdown(ssl_);
1011 if (ret < 0) {
Mirko Bonadei675513b2017-11-09 11:09:25 +01001012 RTC_LOG(LS_WARNING)
1013 << "SSL_shutdown failed, error = " << SSL_get_error(ssl_, ret);
deadbeef89824f62016-09-30 11:55:43 -07001014 }
1015#ifdef OPENSSL_IS_BORINGSSL
jiayl@webrtc.orgf1d751c2014-09-25 16:38:46 +00001016 }
deadbeef89824f62016-09-30 11:55:43 -07001017#endif
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001018 SSL_free(ssl_);
deadbeef37f5ecf2017-02-27 14:06:41 -08001019 ssl_ = nullptr;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001020 }
1021 if (ssl_ctx_) {
1022 SSL_CTX_free(ssl_ctx_);
deadbeef37f5ecf2017-02-27 14:06:41 -08001023 ssl_ctx_ = nullptr;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001024 }
1025 identity_.reset();
Taylor Brandstetterc3928662018-02-23 13:04:51 -08001026 peer_cert_chain_.reset();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001027
1028 // Clear the DTLS timer
Tommi04482982020-10-05 12:43:53 +00001029 timeout_task_.Stop();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001030}
1031
1032SSL_CTX* OpenSSLStreamAdapter::SetupSSLContext() {
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001033#ifdef OPENSSL_IS_BORINGSSL
1034 // If X509 objects aren't used, we can use these methods to avoid
1035 // linking the sizable crypto/x509 code, using CRYPTO_BUFFER instead.
1036 SSL_CTX* ctx =
1037 SSL_CTX_new(ssl_mode_ == SSL_MODE_DTLS ? DTLS_with_buffers_method()
1038 : TLS_with_buffers_method());
1039#else
David Benjamin170a4b32019-01-30 09:46:16 -06001040 SSL_CTX* ctx =
1041 SSL_CTX_new(ssl_mode_ == SSL_MODE_DTLS ? DTLS_method() : TLS_method());
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001042#endif
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001043 if (ctx == nullptr) {
deadbeef37f5ecf2017-02-27 14:06:41 -08001044 return nullptr;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001045 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001046
Harald Alvestrand13799132020-03-09 19:39:36 +01001047 if (support_legacy_tls_protocols_flag_) {
1048 // TODO(https://bugs.webrtc.org/10261): Completely remove this branch in
1049 // M84.
1050 SSL_CTX_set_min_proto_version(
1051 ctx, ssl_mode_ == SSL_MODE_DTLS ? DTLS1_VERSION : TLS1_VERSION);
1052 switch (ssl_max_version_) {
1053 case SSL_PROTOCOL_TLS_10:
1054 SSL_CTX_set_max_proto_version(
1055 ctx, ssl_mode_ == SSL_MODE_DTLS ? DTLS1_VERSION : TLS1_VERSION);
1056 break;
1057 case SSL_PROTOCOL_TLS_11:
1058 SSL_CTX_set_max_proto_version(
1059 ctx, ssl_mode_ == SSL_MODE_DTLS ? DTLS1_VERSION : TLS1_1_VERSION);
1060 break;
1061 case SSL_PROTOCOL_TLS_12:
1062 default:
1063 SSL_CTX_set_max_proto_version(
1064 ctx, ssl_mode_ == SSL_MODE_DTLS ? DTLS1_2_VERSION : TLS1_2_VERSION);
1065 break;
1066 }
1067 } else {
1068 // TODO(https://bugs.webrtc.org/10261): Make this the default in M84.
1069 SSL_CTX_set_min_proto_version(
1070 ctx, ssl_mode_ == SSL_MODE_DTLS ? DTLS1_2_VERSION : TLS1_2_VERSION);
1071 SSL_CTX_set_max_proto_version(
1072 ctx, ssl_mode_ == SSL_MODE_DTLS ? DTLS1_2_VERSION : TLS1_2_VERSION);
Joachim Bauch831c5582015-05-20 12:48:41 +02001073 }
Harald Alvestrand13799132020-03-09 19:39:36 +01001074
David Benjamin170a4b32019-01-30 09:46:16 -06001075#ifdef OPENSSL_IS_BORINGSSL
1076 // SSL_CTX_set_current_time_cb is only supported in BoringSSL.
deadbeef6cf94a02016-11-28 17:38:34 -08001077 if (g_use_time_callback_for_testing) {
1078 SSL_CTX_set_current_time_cb(ctx, &TimeCallbackForTesting);
1079 }
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001080 SSL_CTX_set0_buffer_pool(ctx, openssl::GetBufferPool());
Torbjorn Granlund9adc91d2016-03-24 14:05:06 +01001081#endif
Joachim Bauch831c5582015-05-20 12:48:41 +02001082
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001083 if (identity_ && !identity_->ConfigureIdentity(ctx)) {
1084 SSL_CTX_free(ctx);
deadbeef37f5ecf2017-02-27 14:06:41 -08001085 return nullptr;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001086 }
1087
tfarinaa41ab932015-10-30 16:08:48 -07001088#if !defined(NDEBUG)
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001089 SSL_CTX_set_info_callback(ctx, OpenSSLAdapter::SSLInfoCallback);
1090#endif
1091
tkchin@webrtc.orgc569a492014-09-23 05:56:44 +00001092 int mode = SSL_VERIFY_PEER;
Benjamin Wrightb19b4972018-10-25 10:46:49 -07001093 if (GetClientAuthEnabled()) {
tkchin@webrtc.orgc569a492014-09-23 05:56:44 +00001094 // Require a certificate from the client.
1095 // Note: Normally this is always true in production, but it may be disabled
1096 // for testing purposes (e.g. SSLAdapter unit tests).
1097 mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
1098 }
1099
David Benjamindc246562017-09-29 12:14:08 -04001100 // Configure a custom certificate verification callback to check the peer
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001101 // certificate digest.
1102#ifdef OPENSSL_IS_BORINGSSL
1103 // Use CRYPTO_BUFFER version of the callback if building with BoringSSL.
1104 SSL_CTX_set_custom_verify(ctx, mode, SSLVerifyCallback);
1105#else
1106 // Note the second argument to SSL_CTX_set_verify is to override individual
1107 // errors in the default verification logic, which is not what we want here.
David Benjamindc246562017-09-29 12:14:08 -04001108 SSL_CTX_set_verify(ctx, mode, nullptr);
1109 SSL_CTX_set_cert_verify_callback(ctx, SSLVerifyCallback, nullptr);
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001110#endif
David Benjamindc246562017-09-29 12:14:08 -04001111
Joachim Bauch831c5582015-05-20 12:48:41 +02001112 // Select list of available ciphers. Note that !SHA256 and !SHA384 only
1113 // remove HMAC-SHA256 and HMAC-SHA384 cipher suites, not GCM cipher suites
1114 // with SHA256 or SHA384 as the handshake hash.
David Benjamin7a46cc52021-08-17 16:56:20 -04001115 // This matches the list of SSLClientSocketImpl in Chromium.
deadbeef37f5ecf2017-02-27 14:06:41 -08001116 SSL_CTX_set_cipher_list(
David Benjamin7a46cc52021-08-17 16:56:20 -04001117 ctx,
1118 "DEFAULT:!NULL:!aNULL:!SHA256:!SHA384:!aECDH:!AESGCM+AES256:!aPSK:!3DES");
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001119
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001120 if (!srtp_ciphers_.empty()) {
1121 if (SSL_CTX_set_tlsext_use_srtp(ctx, srtp_ciphers_.c_str())) {
1122 SSL_CTX_free(ctx);
deadbeef37f5ecf2017-02-27 14:06:41 -08001123 return nullptr;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001124 }
1125 }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001126
1127 return ctx;
1128}
1129
deadbeef89824f62016-09-30 11:55:43 -07001130bool OpenSSLStreamAdapter::VerifyPeerCertificate() {
Benjamin Wright5d355542018-10-26 17:57:00 -07001131 if (!HasPeerCertificateDigest() || !peer_cert_chain_ ||
Taylor Brandstetterc3928662018-02-23 13:04:51 -08001132 !peer_cert_chain_->GetSize()) {
Mirko Bonadei675513b2017-11-09 11:09:25 +01001133 RTC_LOG(LS_WARNING) << "Missing digest or peer certificate.";
deadbeef89824f62016-09-30 11:55:43 -07001134 return false;
1135 }
deadbeef81f6f4f2016-09-19 17:20:52 -07001136
deadbeef89824f62016-09-30 11:55:43 -07001137 unsigned char digest[EVP_MAX_MD_SIZE];
1138 size_t digest_length;
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001139 if (!peer_cert_chain_->Get(0).ComputeDigest(
1140 peer_certificate_digest_algorithm_, digest, sizeof(digest),
1141 &digest_length)) {
Mirko Bonadei675513b2017-11-09 11:09:25 +01001142 RTC_LOG(LS_WARNING) << "Failed to compute peer cert digest.";
deadbeef89824f62016-09-30 11:55:43 -07001143 return false;
1144 }
1145
1146 Buffer computed_digest(digest, digest_length);
1147 if (computed_digest != peer_certificate_digest_value_) {
Mirko Bonadei675513b2017-11-09 11:09:25 +01001148 RTC_LOG(LS_WARNING)
Philipp Hancke117e6922022-06-17 14:14:55 +02001149 << "Rejected peer certificate due to mismatched digest using "
1150 << peer_certificate_digest_algorithm_ << ". Expected "
1151 << rtc::hex_encode_with_delimiter(peer_certificate_digest_value_, ':')
1152 << " got " << rtc::hex_encode_with_delimiter(computed_digest, ':');
jbauchf8f457b2017-03-09 16:24:57 -08001153 return false;
deadbeef81f6f4f2016-09-19 17:20:52 -07001154 }
deadbeef89824f62016-09-30 11:55:43 -07001155 // Ignore any verification error if the digest matches, since there is no
1156 // value in checking the validity of a self-signed cert issued by untrusted
1157 // sources.
Tomas Gunnarssond48ff452020-10-02 18:28:46 +02001158 RTC_DLOG(LS_INFO) << "Accepted peer certificate.";
deadbeef89824f62016-09-30 11:55:43 -07001159 peer_certificate_verified_ = true;
1160 return true;
1161}
1162
Jian Cui0a8798b2017-11-16 16:58:02 -08001163std::unique_ptr<SSLCertChain> OpenSSLStreamAdapter::GetPeerSSLCertChain()
1164 const {
Steve Antonf25303e2018-10-16 15:23:31 -07001165 return peer_cert_chain_ ? peer_cert_chain_->Clone() : nullptr;
Jian Cui0a8798b2017-11-16 16:58:02 -08001166}
1167
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001168#ifdef OPENSSL_IS_BORINGSSL
1169enum ssl_verify_result_t OpenSSLStreamAdapter::SSLVerifyCallback(
1170 SSL* ssl,
1171 uint8_t* out_alert) {
1172 // Get our OpenSSLStreamAdapter from the context.
1173 OpenSSLStreamAdapter* stream =
1174 reinterpret_cast<OpenSSLStreamAdapter*>(SSL_get_app_data(ssl));
1175 const STACK_OF(CRYPTO_BUFFER)* chain = SSL_get0_peer_certificates(ssl);
1176 // Creates certificate chain.
1177 std::vector<std::unique_ptr<SSLCertificate>> cert_chain;
1178 for (CRYPTO_BUFFER* cert : chain) {
1179 cert_chain.emplace_back(new BoringSSLCertificate(bssl::UpRef(cert)));
1180 }
1181 stream->peer_cert_chain_.reset(new SSLCertChain(std::move(cert_chain)));
1182
1183 // If the peer certificate digest isn't known yet, we'll wait to verify
1184 // until it's known, and for now just return a success status.
1185 if (stream->peer_certificate_digest_algorithm_.empty()) {
1186 RTC_LOG(LS_INFO) << "Waiting to verify certificate until digest is known.";
1187 // TODO(deadbeef): Use ssl_verify_retry?
1188 return ssl_verify_ok;
1189 }
1190
1191 if (!stream->VerifyPeerCertificate()) {
1192 return ssl_verify_invalid;
1193 }
1194
1195 return ssl_verify_ok;
1196}
1197#else // OPENSSL_IS_BORINGSSL
David Benjamindc246562017-09-29 12:14:08 -04001198int OpenSSLStreamAdapter::SSLVerifyCallback(X509_STORE_CTX* store, void* arg) {
1199 // Get our SSL structure and OpenSSLStreamAdapter from the store.
deadbeef89824f62016-09-30 11:55:43 -07001200 SSL* ssl = reinterpret_cast<SSL*>(
1201 X509_STORE_CTX_get_ex_data(store, SSL_get_ex_data_X509_STORE_CTX_idx()));
deadbeef89824f62016-09-30 11:55:43 -07001202 OpenSSLStreamAdapter* stream =
1203 reinterpret_cast<OpenSSLStreamAdapter*>(SSL_get_app_data(ssl));
henrike@webrtc.org4e5f65a2014-06-05 20:40:11 +00001204
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001205 // Record the peer's certificate.
Jiawei Ou9d4e8402018-05-23 15:44:20 -07001206 X509* cert = X509_STORE_CTX_get0_cert(store);
Taylor Brandstetterc3928662018-02-23 13:04:51 -08001207 stream->peer_cert_chain_.reset(
Mirko Bonadei317a1f02019-09-17 17:06:18 +02001208 new SSLCertChain(std::make_unique<OpenSSLCertificate>(cert)));
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001209
deadbeef89824f62016-09-30 11:55:43 -07001210 // If the peer certificate digest isn't known yet, we'll wait to verify
1211 // until it's known, and for now just return a success status.
1212 if (stream->peer_certificate_digest_algorithm_.empty()) {
Tomas Gunnarssond48ff452020-10-02 18:28:46 +02001213 RTC_DLOG(LS_INFO) << "Waiting to verify certificate until digest is known.";
deadbeef89824f62016-09-30 11:55:43 -07001214 return 1;
1215 }
1216
David Benjamindc246562017-09-29 12:14:08 -04001217 if (!stream->VerifyPeerCertificate()) {
1218 X509_STORE_CTX_set_error(store, X509_V_ERR_CERT_REJECTED);
1219 return 0;
1220 }
1221
1222 return 1;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001223}
Taylor Brandstetter165c6182020-12-10 16:23:03 -08001224#endif // !OPENSSL_IS_BORINGSSL
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001225
Taylor Brandstetter4f0dfbd2016-06-15 17:15:23 -07001226bool OpenSSLStreamAdapter::IsBoringSsl() {
1227#ifdef OPENSSL_IS_BORINGSSL
1228 return true;
1229#else
1230 return false;
1231#endif
1232}
1233
torbjorng43166b82016-03-11 00:06:47 -08001234#define CDEF(X) \
1235 { static_cast<uint16_t>(TLS1_CK_##X & 0xffff), "TLS_" #X }
1236
1237struct cipher_list {
1238 uint16_t cipher;
1239 const char* cipher_str;
1240};
1241
1242// TODO(torbjorng): Perhaps add more cipher suites to these lists.
1243static const cipher_list OK_RSA_ciphers[] = {
Yves Gerey665174f2018-06-19 15:03:05 +02001244 CDEF(ECDHE_RSA_WITH_AES_128_CBC_SHA),
1245 CDEF(ECDHE_RSA_WITH_AES_256_CBC_SHA),
1246 CDEF(ECDHE_RSA_WITH_AES_128_GCM_SHA256),
torbjorng43166b82016-03-11 00:06:47 -08001247#ifdef TLS1_CK_ECDHE_RSA_WITH_AES_256_GCM_SHA256
Yves Gerey665174f2018-06-19 15:03:05 +02001248 CDEF(ECDHE_RSA_WITH_AES_256_GCM_SHA256),
torbjorng43166b82016-03-11 00:06:47 -08001249#endif
torbjorngaad67802016-04-07 08:55:28 -07001250#ifdef TLS1_CK_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
Yves Gerey665174f2018-06-19 15:03:05 +02001251 CDEF(ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256),
torbjorngaad67802016-04-07 08:55:28 -07001252#endif
torbjorng43166b82016-03-11 00:06:47 -08001253};
1254
1255static const cipher_list OK_ECDSA_ciphers[] = {
Yves Gerey665174f2018-06-19 15:03:05 +02001256 CDEF(ECDHE_ECDSA_WITH_AES_128_CBC_SHA),
1257 CDEF(ECDHE_ECDSA_WITH_AES_256_CBC_SHA),
1258 CDEF(ECDHE_ECDSA_WITH_AES_128_GCM_SHA256),
torbjorng43166b82016-03-11 00:06:47 -08001259#ifdef TLS1_CK_ECDHE_ECDSA_WITH_AES_256_GCM_SHA256
Yves Gerey665174f2018-06-19 15:03:05 +02001260 CDEF(ECDHE_ECDSA_WITH_AES_256_GCM_SHA256),
torbjorng43166b82016-03-11 00:06:47 -08001261#endif
torbjorngaad67802016-04-07 08:55:28 -07001262#ifdef TLS1_CK_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
Yves Gerey665174f2018-06-19 15:03:05 +02001263 CDEF(ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256),
torbjorngaad67802016-04-07 08:55:28 -07001264#endif
torbjorng43166b82016-03-11 00:06:47 -08001265};
1266#undef CDEF
1267
1268bool OpenSSLStreamAdapter::IsAcceptableCipher(int cipher, KeyType key_type) {
Torbjorn Granlundb6d4ec42015-08-17 14:08:59 +02001269 if (key_type == KT_RSA) {
torbjorng43166b82016-03-11 00:06:47 -08001270 for (const cipher_list& c : OK_RSA_ciphers) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001271 if (cipher == c.cipher) {
torbjorng43166b82016-03-11 00:06:47 -08001272 return true;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001273 }
Torbjorn Granlundb6d4ec42015-08-17 14:08:59 +02001274 }
Joachim Bauch831c5582015-05-20 12:48:41 +02001275 }
torbjorng43166b82016-03-11 00:06:47 -08001276
1277 if (key_type == KT_ECDSA) {
1278 for (const cipher_list& c : OK_ECDSA_ciphers) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001279 if (cipher == c.cipher) {
torbjorng43166b82016-03-11 00:06:47 -08001280 return true;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001281 }
torbjorng43166b82016-03-11 00:06:47 -08001282 }
1283 }
1284
1285 return false;
1286}
1287
Ali Tofigh7fa90572022-03-17 15:47:49 +01001288bool OpenSSLStreamAdapter::IsAcceptableCipher(absl::string_view cipher,
torbjorng43166b82016-03-11 00:06:47 -08001289 KeyType key_type) {
1290 if (key_type == KT_RSA) {
1291 for (const cipher_list& c : OK_RSA_ciphers) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001292 if (cipher == c.cipher_str) {
torbjorng43166b82016-03-11 00:06:47 -08001293 return true;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001294 }
torbjorng43166b82016-03-11 00:06:47 -08001295 }
1296 }
1297
1298 if (key_type == KT_ECDSA) {
1299 for (const cipher_list& c : OK_ECDSA_ciphers) {
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001300 if (cipher == c.cipher_str) {
torbjorng43166b82016-03-11 00:06:47 -08001301 return true;
Benjamin Wrightd4d5f8a2018-10-15 11:19:39 -07001302 }
torbjorng43166b82016-03-11 00:06:47 -08001303 }
1304 }
1305
1306 return false;
pthatcher@webrtc.org3ee4fe52015-02-11 22:34:36 +00001307}
1308
Benjamin Wrightb19b4972018-10-25 10:46:49 -07001309void OpenSSLStreamAdapter::EnableTimeCallbackForTesting() {
Joachim Reiersen637bed52019-04-25 10:41:35 -07001310#ifdef OPENSSL_IS_BORINGSSL
deadbeef6cf94a02016-11-28 17:38:34 -08001311 g_use_time_callback_for_testing = true;
Joachim Reiersen637bed52019-04-25 10:41:35 -07001312#endif
deadbeef6cf94a02016-11-28 17:38:34 -08001313}
1314
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001315} // namespace rtc