2 * Copyright 2008 The WebRTC Project Authors. All rights reserved.
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.
11 #if HAVE_OPENSSL_SSL_H
13 #include "webrtc/base/openssladapter.h"
15 #if defined(WEBRTC_POSIX)
19 // Must be included first before openssl headers.
20 #include "webrtc/base/win32.h" // NOLINT
22 #include <openssl/bio.h>
23 #include <openssl/crypto.h>
24 #include <openssl/err.h>
25 #include <openssl/opensslv.h>
26 #include <openssl/rand.h>
27 #include <openssl/x509.h>
28 #include <openssl/x509v3.h>
32 #endif // HAVE_CONFIG_H
34 #include "webrtc/base/common.h"
35 #include "webrtc/base/logging.h"
36 #include "webrtc/base/openssl.h"
37 #include "webrtc/base/sslroots.h"
38 #include "webrtc/base/stringutils.h"
40 // TODO: Use a nicer abstraction for mutex.
42 #if defined(WEBRTC_WIN)
43 #define MUTEX_TYPE HANDLE
44 #define MUTEX_SETUP(x) (x) = CreateMutex(NULL, FALSE, NULL)
45 #define MUTEX_CLEANUP(x) CloseHandle(x)
46 #define MUTEX_LOCK(x) WaitForSingleObject((x), INFINITE)
47 #define MUTEX_UNLOCK(x) ReleaseMutex(x)
48 #define THREAD_ID GetCurrentThreadId()
49 #elif defined(WEBRTC_POSIX)
50 #define MUTEX_TYPE pthread_mutex_t
51 #define MUTEX_SETUP(x) pthread_mutex_init(&(x), NULL)
52 #define MUTEX_CLEANUP(x) pthread_mutex_destroy(&(x))
53 #define MUTEX_LOCK(x) pthread_mutex_lock(&(x))
54 #define MUTEX_UNLOCK(x) pthread_mutex_unlock(&(x))
55 #define THREAD_ID pthread_self()
57 #error You must define mutex operations appropriate for your platform!
60 struct CRYPTO_dynlock_value {
64 //////////////////////////////////////////////////////////////////////
66 //////////////////////////////////////////////////////////////////////
68 static int socket_write(BIO* h, const char* buf, int num);
69 static int socket_read(BIO* h, char* buf, int size);
70 static int socket_puts(BIO* h, const char* str);
71 static long socket_ctrl(BIO* h, int cmd, long arg1, void* arg2);
72 static int socket_new(BIO* h);
73 static int socket_free(BIO* data);
75 static BIO_METHOD methods_socket = {
88 static BIO_METHOD* BIO_s_socket2() { return(&methods_socket); }
90 static BIO* BIO_new_socket(rtc::AsyncSocket* socket) {
91 BIO* ret = BIO_new(BIO_s_socket2());
99 static int socket_new(BIO* b) {
102 b->num = 0; // 1 means socket closed
107 static int socket_free(BIO* b) {
113 static int socket_read(BIO* b, char* out, int outl) {
116 rtc::AsyncSocket* socket = static_cast<rtc::AsyncSocket*>(b->ptr);
117 BIO_clear_retry_flags(b);
118 int result = socket->Recv(out, outl);
121 } else if (result == 0) {
123 } else if (socket->IsBlocking()) {
124 BIO_set_retry_read(b);
129 static int socket_write(BIO* b, const char* in, int inl) {
132 rtc::AsyncSocket* socket = static_cast<rtc::AsyncSocket*>(b->ptr);
133 BIO_clear_retry_flags(b);
134 int result = socket->Send(in, inl);
137 } else if (socket->IsBlocking()) {
138 BIO_set_retry_write(b);
143 static int socket_puts(BIO* b, const char* str) {
144 return socket_write(b, str, strlen(str));
147 static long socket_ctrl(BIO* b, int cmd, long num, void* ptr) {
156 case BIO_CTRL_WPENDING:
157 case BIO_CTRL_PENDING:
166 /////////////////////////////////////////////////////////////////////////////
168 /////////////////////////////////////////////////////////////////////////////
172 // This array will store all of the mutexes available to OpenSSL.
173 static MUTEX_TYPE* mutex_buf = NULL;
175 static void locking_function(int mode, int n, const char * file, int line) {
176 if (mode & CRYPTO_LOCK) {
177 MUTEX_LOCK(mutex_buf[n]);
179 MUTEX_UNLOCK(mutex_buf[n]);
183 static unsigned long id_function() { // NOLINT
184 // Use old-style C cast because THREAD_ID's type varies with the platform,
185 // in some cases requiring static_cast, and in others requiring
187 return (unsigned long)THREAD_ID; // NOLINT
190 static CRYPTO_dynlock_value* dyn_create_function(const char* file, int line) {
191 CRYPTO_dynlock_value* value = new CRYPTO_dynlock_value;
194 MUTEX_SETUP(value->mutex);
198 static void dyn_lock_function(int mode, CRYPTO_dynlock_value* l,
199 const char* file, int line) {
200 if (mode & CRYPTO_LOCK) {
201 MUTEX_LOCK(l->mutex);
203 MUTEX_UNLOCK(l->mutex);
207 static void dyn_destroy_function(CRYPTO_dynlock_value* l,
208 const char* file, int line) {
209 MUTEX_CLEANUP(l->mutex);
213 VerificationCallback OpenSSLAdapter::custom_verify_callback_ = NULL;
215 bool OpenSSLAdapter::InitializeSSL(VerificationCallback callback) {
216 if (!InitializeSSLThread() || !SSL_library_init())
218 #if !defined(ADDRESS_SANITIZER) || !defined(WEBRTC_MAC) || defined(WEBRTC_IOS)
219 // Loading the error strings crashes mac_asan. Omit this debugging aid there.
220 SSL_load_error_strings();
222 ERR_load_BIO_strings();
223 OpenSSL_add_all_algorithms();
225 custom_verify_callback_ = callback;
229 bool OpenSSLAdapter::InitializeSSLThread() {
230 mutex_buf = new MUTEX_TYPE[CRYPTO_num_locks()];
233 for (int i = 0; i < CRYPTO_num_locks(); ++i)
234 MUTEX_SETUP(mutex_buf[i]);
236 // we need to cast our id_function to return an unsigned long -- pthread_t is
238 CRYPTO_set_id_callback(id_function);
239 CRYPTO_set_locking_callback(locking_function);
240 CRYPTO_set_dynlock_create_callback(dyn_create_function);
241 CRYPTO_set_dynlock_lock_callback(dyn_lock_function);
242 CRYPTO_set_dynlock_destroy_callback(dyn_destroy_function);
246 bool OpenSSLAdapter::CleanupSSL() {
249 CRYPTO_set_id_callback(NULL);
250 CRYPTO_set_locking_callback(NULL);
251 CRYPTO_set_dynlock_create_callback(NULL);
252 CRYPTO_set_dynlock_lock_callback(NULL);
253 CRYPTO_set_dynlock_destroy_callback(NULL);
254 for (int i = 0; i < CRYPTO_num_locks(); ++i)
255 MUTEX_CLEANUP(mutex_buf[i]);
261 OpenSSLAdapter::OpenSSLAdapter(AsyncSocket* socket)
262 : SSLAdapter(socket),
264 ssl_read_needs_write_(false),
265 ssl_write_needs_read_(false),
267 ssl_(NULL), ssl_ctx_(NULL),
268 custom_verification_succeeded_(false) {
271 OpenSSLAdapter::~OpenSSLAdapter() {
276 OpenSSLAdapter::StartSSL(const char* hostname, bool restartable) {
277 if (state_ != SSL_NONE)
280 ssl_host_name_ = hostname;
281 restartable_ = restartable;
283 if (socket_->GetState() != Socket::CS_CONNECTED) {
288 state_ = SSL_CONNECTING;
289 if (int err = BeginSSL()) {
290 Error("BeginSSL", err, false);
298 OpenSSLAdapter::BeginSSL() {
299 LOG(LS_INFO) << "BeginSSL: " << ssl_host_name_;
300 ASSERT(state_ == SSL_CONNECTING);
305 // First set up the context
307 ssl_ctx_ = SetupSSLContext();
314 bio = BIO_new_socket(static_cast<AsyncSocketAdapter*>(socket_));
320 ssl_ = SSL_new(ssl_ctx_);
326 SSL_set_app_data(ssl_, this);
328 SSL_set_bio(ssl_, bio, bio);
329 SSL_set_mode(ssl_, SSL_MODE_ENABLE_PARTIAL_WRITE |
330 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
332 // the SSL object owns the bio now
351 OpenSSLAdapter::ContinueSSL() {
352 ASSERT(state_ == SSL_CONNECTING);
354 int code = SSL_connect(ssl_);
355 switch (SSL_get_error(ssl_, code)) {
357 if (!SSLPostConnectionCheck(ssl_, ssl_host_name_.c_str())) {
358 LOG(LS_ERROR) << "TLS post connection check failed";
359 // make sure we close the socket
361 // The connect failed so return -1 to shut down the socket
365 state_ = SSL_CONNECTED;
366 AsyncSocketAdapter::OnConnectEvent(this);
367 #if 0 // TODO: worry about this
368 // Don't let ourselves go away during the callbacks
369 PRefPtr<OpenSSLAdapter> lock(this);
370 LOG(LS_INFO) << " -- onStreamReadable";
371 AsyncSocketAdapter::OnReadEvent(this);
372 LOG(LS_INFO) << " -- onStreamWriteable";
373 AsyncSocketAdapter::OnWriteEvent(this);
377 case SSL_ERROR_WANT_READ:
378 case SSL_ERROR_WANT_WRITE:
381 case SSL_ERROR_ZERO_RETURN:
383 LOG(LS_WARNING) << "ContinueSSL -- error " << code;
384 return (code != 0) ? code : -1;
391 OpenSSLAdapter::Error(const char* context, int err, bool signal) {
392 LOG(LS_WARNING) << "OpenSSLAdapter::Error("
393 << context << ", " << err << ")";
397 AsyncSocketAdapter::OnCloseEvent(this, err);
401 OpenSSLAdapter::Cleanup() {
402 LOG(LS_INFO) << "Cleanup";
405 ssl_read_needs_write_ = false;
406 ssl_write_needs_read_ = false;
407 custom_verification_succeeded_ = false;
415 SSL_CTX_free(ssl_ctx_);
421 // AsyncSocket Implementation
425 OpenSSLAdapter::Send(const void* pv, size_t cb) {
426 //LOG(LS_INFO) << "OpenSSLAdapter::Send(" << cb << ")";
430 return AsyncSocketAdapter::Send(pv, cb);
434 SetError(EWOULDBLOCK);
445 // OpenSSL will return an error if we try to write zero bytes
449 ssl_write_needs_read_ = false;
451 int code = SSL_write(ssl_, pv, cb);
452 switch (SSL_get_error(ssl_, code)) {
454 //LOG(LS_INFO) << " -- success";
456 case SSL_ERROR_WANT_READ:
457 //LOG(LS_INFO) << " -- error want read";
458 ssl_write_needs_read_ = true;
459 SetError(EWOULDBLOCK);
461 case SSL_ERROR_WANT_WRITE:
462 //LOG(LS_INFO) << " -- error want write";
463 SetError(EWOULDBLOCK);
465 case SSL_ERROR_ZERO_RETURN:
466 //LOG(LS_INFO) << " -- remote side closed";
467 SetError(EWOULDBLOCK);
468 // do we need to signal closure?
471 //LOG(LS_INFO) << " -- error " << code;
472 Error("SSL_write", (code ? code : -1), false);
480 OpenSSLAdapter::Recv(void* pv, size_t cb) {
481 //LOG(LS_INFO) << "OpenSSLAdapter::Recv(" << cb << ")";
485 return AsyncSocketAdapter::Recv(pv, cb);
489 SetError(EWOULDBLOCK);
500 // Don't trust OpenSSL with zero byte reads
504 ssl_read_needs_write_ = false;
506 int code = SSL_read(ssl_, pv, cb);
507 switch (SSL_get_error(ssl_, code)) {
509 //LOG(LS_INFO) << " -- success";
511 case SSL_ERROR_WANT_READ:
512 //LOG(LS_INFO) << " -- error want read";
513 SetError(EWOULDBLOCK);
515 case SSL_ERROR_WANT_WRITE:
516 //LOG(LS_INFO) << " -- error want write";
517 ssl_read_needs_write_ = true;
518 SetError(EWOULDBLOCK);
520 case SSL_ERROR_ZERO_RETURN:
521 //LOG(LS_INFO) << " -- remote side closed";
522 SetError(EWOULDBLOCK);
523 // do we need to signal closure?
526 //LOG(LS_INFO) << " -- error " << code;
527 Error("SSL_read", (code ? code : -1), false);
535 OpenSSLAdapter::Close() {
537 state_ = restartable_ ? SSL_WAIT : SSL_NONE;
538 return AsyncSocketAdapter::Close();
542 OpenSSLAdapter::GetState() const {
544 // return CS_CONNECTED;
545 ConnState state = socket_->GetState();
546 if ((state == CS_CONNECTED)
547 && ((state_ == SSL_WAIT) || (state_ == SSL_CONNECTING)))
548 state = CS_CONNECTING;
553 OpenSSLAdapter::OnConnectEvent(AsyncSocket* socket) {
554 LOG(LS_INFO) << "OpenSSLAdapter::OnConnectEvent";
555 if (state_ != SSL_WAIT) {
556 ASSERT(state_ == SSL_NONE);
557 AsyncSocketAdapter::OnConnectEvent(socket);
561 state_ = SSL_CONNECTING;
562 if (int err = BeginSSL()) {
563 AsyncSocketAdapter::OnCloseEvent(socket, err);
568 OpenSSLAdapter::OnReadEvent(AsyncSocket* socket) {
569 //LOG(LS_INFO) << "OpenSSLAdapter::OnReadEvent";
571 if (state_ == SSL_NONE) {
572 AsyncSocketAdapter::OnReadEvent(socket);
576 if (state_ == SSL_CONNECTING) {
577 if (int err = ContinueSSL()) {
578 Error("ContinueSSL", err);
583 if (state_ != SSL_CONNECTED)
586 // Don't let ourselves go away during the callbacks
587 //PRefPtr<OpenSSLAdapter> lock(this); // TODO: fix this
588 if (ssl_write_needs_read_) {
589 //LOG(LS_INFO) << " -- onStreamWriteable";
590 AsyncSocketAdapter::OnWriteEvent(socket);
593 //LOG(LS_INFO) << " -- onStreamReadable";
594 AsyncSocketAdapter::OnReadEvent(socket);
598 OpenSSLAdapter::OnWriteEvent(AsyncSocket* socket) {
599 //LOG(LS_INFO) << "OpenSSLAdapter::OnWriteEvent";
601 if (state_ == SSL_NONE) {
602 AsyncSocketAdapter::OnWriteEvent(socket);
606 if (state_ == SSL_CONNECTING) {
607 if (int err = ContinueSSL()) {
608 Error("ContinueSSL", err);
613 if (state_ != SSL_CONNECTED)
616 // Don't let ourselves go away during the callbacks
617 //PRefPtr<OpenSSLAdapter> lock(this); // TODO: fix this
619 if (ssl_read_needs_write_) {
620 //LOG(LS_INFO) << " -- onStreamReadable";
621 AsyncSocketAdapter::OnReadEvent(socket);
624 //LOG(LS_INFO) << " -- onStreamWriteable";
625 AsyncSocketAdapter::OnWriteEvent(socket);
629 OpenSSLAdapter::OnCloseEvent(AsyncSocket* socket, int err) {
630 LOG(LS_INFO) << "OpenSSLAdapter::OnCloseEvent(" << err << ")";
631 AsyncSocketAdapter::OnCloseEvent(socket, err);
634 // This code is taken from the "Network Security with OpenSSL"
635 // sample in chapter 5
637 bool OpenSSLAdapter::VerifyServerName(SSL* ssl, const char* host,
638 bool ignore_bad_cert) {
642 // Checking the return from SSL_get_peer_certificate here is not strictly
643 // necessary. With our setup, it is not possible for it to return
644 // NULL. However, it is good form to check the return.
645 X509* certificate = SSL_get_peer_certificate(ssl);
649 // Logging certificates is extremely verbose. So it is disabled by default.
650 #ifdef LOG_CERTIFICATES
652 LOG(LS_INFO) << "Certificate from server:";
653 BIO* mem = BIO_new(BIO_s_mem());
654 X509_print_ex(mem, certificate, XN_FLAG_SEP_CPLUS_SPC, X509_FLAG_NO_HEADER);
655 BIO_write(mem, "\0", 1);
657 BIO_get_mem_data(mem, &buffer);
658 LOG(LS_INFO) << buffer;
661 char* cipher_description =
662 SSL_CIPHER_description(SSL_get_current_cipher(ssl), NULL, 128);
663 LOG(LS_INFO) << "Cipher: " << cipher_description;
664 OPENSSL_free(cipher_description);
669 int extension_count = X509_get_ext_count(certificate);
670 for (int i = 0; i < extension_count; ++i) {
671 X509_EXTENSION* extension = X509_get_ext(certificate, i);
672 int extension_nid = OBJ_obj2nid(X509_EXTENSION_get_object(extension));
674 if (extension_nid == NID_subject_alt_name) {
675 const X509V3_EXT_METHOD* meth = X509V3_EXT_get(extension);
679 void* ext_str = NULL;
681 // We assign this to a local variable, instead of passing the address
682 // directly to ASN1_item_d2i.
683 // See http://readlist.com/lists/openssl.org/openssl-users/0/4761.html.
684 unsigned char* ext_value_data = extension->value->data;
686 const unsigned char **ext_value_data_ptr =
687 (const_cast<const unsigned char **>(&ext_value_data));
690 ext_str = ASN1_item_d2i(NULL, ext_value_data_ptr,
691 extension->value->length,
692 ASN1_ITEM_ptr(meth->it));
694 ext_str = meth->d2i(NULL, ext_value_data_ptr, extension->value->length);
697 STACK_OF(CONF_VALUE)* value = meth->i2v(meth, ext_str, NULL);
699 // Cast to size_t to be compilable for both OpenSSL and BoringSSL.
700 for (size_t j = 0; j < static_cast<size_t>(sk_CONF_VALUE_num(value));
702 CONF_VALUE* nval = sk_CONF_VALUE_value(value, j);
703 // The value for nval can contain wildcards
704 if (!strcmp(nval->name, "DNS") && string_match(host, nval->value)) {
709 sk_CONF_VALUE_pop_free(value, X509V3_conf_free);
713 ASN1_item_free(reinterpret_cast<ASN1_VALUE*>(ext_str),
714 ASN1_ITEM_ptr(meth->it));
716 meth->ext_free(ext_str);
727 && ((subject = X509_get_subject_name(certificate)) != NULL)
728 && (X509_NAME_get_text_by_NID(subject, NID_commonName,
729 data, sizeof(data)) > 0)) {
730 data[sizeof(data)-1] = 0;
731 if (_stricmp(data, host) == 0)
735 X509_free(certificate);
737 // This should only ever be turned on for debugging and development.
738 if (!ok && ignore_bad_cert) {
739 LOG(LS_WARNING) << "TLS certificate check FAILED. "
740 << "Allowing connection anyway.";
747 bool OpenSSLAdapter::SSLPostConnectionCheck(SSL* ssl, const char* host) {
748 bool ok = VerifyServerName(ssl, host, ignore_bad_cert());
751 ok = (SSL_get_verify_result(ssl) == X509_V_OK ||
752 custom_verification_succeeded_);
755 if (!ok && ignore_bad_cert()) {
756 LOG(LS_INFO) << "Other TLS post connection checks failed.";
765 // We only use this for tracing and so it is only needed in debug mode
768 OpenSSLAdapter::SSLInfoCallback(const SSL* s, int where, int ret) {
769 const char* str = "undefined";
770 int w = where & ~SSL_ST_MASK;
771 if (w & SSL_ST_CONNECT) {
773 } else if (w & SSL_ST_ACCEPT) {
776 if (where & SSL_CB_LOOP) {
777 LOG(LS_INFO) << str << ":" << SSL_state_string_long(s);
778 } else if (where & SSL_CB_ALERT) {
779 str = (where & SSL_CB_READ) ? "read" : "write";
780 LOG(LS_INFO) << "SSL3 alert " << str
781 << ":" << SSL_alert_type_string_long(ret)
782 << ":" << SSL_alert_desc_string_long(ret);
783 } else if (where & SSL_CB_EXIT) {
785 LOG(LS_INFO) << str << ":failed in " << SSL_state_string_long(s);
786 } else if (ret < 0) {
787 LOG(LS_INFO) << str << ":error in " << SSL_state_string_long(s);
795 OpenSSLAdapter::SSLVerifyCallback(int ok, X509_STORE_CTX* store) {
799 X509* cert = X509_STORE_CTX_get_current_cert(store);
800 int depth = X509_STORE_CTX_get_error_depth(store);
801 int err = X509_STORE_CTX_get_error(store);
803 LOG(LS_INFO) << "Error with certificate at depth: " << depth;
804 X509_NAME_oneline(X509_get_issuer_name(cert), data, sizeof(data));
805 LOG(LS_INFO) << " issuer = " << data;
806 X509_NAME_oneline(X509_get_subject_name(cert), data, sizeof(data));
807 LOG(LS_INFO) << " subject = " << data;
808 LOG(LS_INFO) << " err = " << err
809 << ":" << X509_verify_cert_error_string(err);
813 // Get our stream pointer from the store
814 SSL* ssl = reinterpret_cast<SSL*>(
815 X509_STORE_CTX_get_ex_data(store,
816 SSL_get_ex_data_X509_STORE_CTX_idx()));
818 OpenSSLAdapter* stream =
819 reinterpret_cast<OpenSSLAdapter*>(SSL_get_app_data(ssl));
821 if (!ok && custom_verify_callback_) {
823 reinterpret_cast<void*>(X509_STORE_CTX_get_current_cert(store));
824 if (custom_verify_callback_(cert)) {
825 stream->custom_verification_succeeded_ = true;
826 LOG(LS_INFO) << "validated certificate using custom callback";
831 // Should only be used for debugging and development.
832 if (!ok && stream->ignore_bad_cert()) {
833 LOG(LS_WARNING) << "Ignoring cert error while verifying cert chain";
840 bool OpenSSLAdapter::ConfigureTrustedRootCertificates(SSL_CTX* ctx) {
841 // Add the root cert that we care about to the SSL context
842 int count_of_added_certs = 0;
843 for (int i = 0; i < ARRAY_SIZE(kSSLCertCertificateList); i++) {
844 const unsigned char* cert_buffer = kSSLCertCertificateList[i];
845 size_t cert_buffer_len = kSSLCertCertificateSizeList[i];
846 X509* cert = d2i_X509(NULL, &cert_buffer, cert_buffer_len);
848 int return_value = X509_STORE_add_cert(SSL_CTX_get_cert_store(ctx), cert);
849 if (return_value == 0) {
850 LOG(LS_WARNING) << "Unable to add certificate.";
852 count_of_added_certs++;
857 return count_of_added_certs > 0;
861 OpenSSLAdapter::SetupSSLContext() {
862 SSL_CTX* ctx = SSL_CTX_new(TLSv1_client_method());
864 unsigned long error = ERR_get_error(); // NOLINT: type used by OpenSSL.
865 LOG(LS_WARNING) << "SSL_CTX creation failed: "
866 << '"' << ERR_reason_error_string(error) << "\" "
867 << "(error=" << error << ')';
870 if (!ConfigureTrustedRootCertificates(ctx)) {
876 SSL_CTX_set_info_callback(ctx, SSLInfoCallback);
879 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER, SSLVerifyCallback);
880 SSL_CTX_set_verify_depth(ctx, 4);
881 SSL_CTX_set_cipher_list(ctx, "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH");
888 #endif // HAVE_OPENSSL_SSL_H