Show Pages in chrome://md-settings
[chromium-blink-merge.git] / net / socket / ssl_client_socket_openssl.cc
blobf5e858d2d27ff71c8532a88a04d70d6be50e6ca9
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 // OpenSSL binding for SSLClientSocket. The class layout and general principle
6 // of operation is derived from SSLClientSocketNSS.
8 #include "net/socket/ssl_client_socket_openssl.h"
10 #include <errno.h>
11 #include <openssl/bio.h>
12 #include <openssl/err.h>
13 #include <openssl/ssl.h>
14 #include <string.h>
16 #include "base/bind.h"
17 #include "base/callback_helpers.h"
18 #include "base/environment.h"
19 #include "base/memory/singleton.h"
20 #include "base/metrics/histogram.h"
21 #include "base/profiler/scoped_tracker.h"
22 #include "base/strings/string_piece.h"
23 #include "base/synchronization/lock.h"
24 #include "base/threading/thread_local.h"
25 #include "crypto/ec_private_key.h"
26 #include "crypto/openssl_util.h"
27 #include "crypto/scoped_openssl_types.h"
28 #include "net/base/net_errors.h"
29 #include "net/cert/cert_policy_enforcer.h"
30 #include "net/cert/cert_verifier.h"
31 #include "net/cert/ct_ev_whitelist.h"
32 #include "net/cert/ct_verifier.h"
33 #include "net/cert/single_request_cert_verifier.h"
34 #include "net/cert/x509_certificate_net_log_param.h"
35 #include "net/cert/x509_util_openssl.h"
36 #include "net/http/transport_security_state.h"
37 #include "net/socket/ssl_session_cache_openssl.h"
38 #include "net/ssl/scoped_openssl_types.h"
39 #include "net/ssl/ssl_cert_request_info.h"
40 #include "net/ssl/ssl_connection_status_flags.h"
41 #include "net/ssl/ssl_info.h"
43 #if defined(OS_WIN)
44 #include "base/win/windows_version.h"
45 #endif
47 #if defined(USE_OPENSSL_CERTS)
48 #include "net/ssl/openssl_client_key_store.h"
49 #else
50 #include "net/ssl/openssl_platform_key.h"
51 #endif
53 namespace net {
55 namespace {
57 // Enable this to see logging for state machine state transitions.
58 #if 0
59 #define GotoState(s) do { DVLOG(2) << (void *)this << " " << __FUNCTION__ << \
60 " jump to state " << s; \
61 next_handshake_state_ = s; } while (0)
62 #else
63 #define GotoState(s) next_handshake_state_ = s
64 #endif
66 // This constant can be any non-negative/non-zero value (eg: it does not
67 // overlap with any value of the net::Error range, including net::OK).
68 const int kNoPendingReadResult = 1;
70 // If a client doesn't have a list of protocols that it supports, but
71 // the server supports NPN, choosing "http/1.1" is the best answer.
72 const char kDefaultSupportedNPNProtocol[] = "http/1.1";
74 // Default size of the internal BoringSSL buffers.
75 const int KDefaultOpenSSLBufferSize = 17 * 1024;
77 void FreeX509Stack(STACK_OF(X509)* ptr) {
78 sk_X509_pop_free(ptr, X509_free);
81 using ScopedX509Stack = crypto::ScopedOpenSSL<STACK_OF(X509), FreeX509Stack>;
83 #if OPENSSL_VERSION_NUMBER < 0x1000103fL
84 // This method doesn't seem to have made it into the OpenSSL headers.
85 unsigned long SSL_CIPHER_get_id(const SSL_CIPHER* cipher) { return cipher->id; }
86 #endif
88 // Used for encoding the |connection_status| field of an SSLInfo object.
89 int EncodeSSLConnectionStatus(uint16 cipher_suite,
90 int compression,
91 int version) {
92 return cipher_suite |
93 ((compression & SSL_CONNECTION_COMPRESSION_MASK) <<
94 SSL_CONNECTION_COMPRESSION_SHIFT) |
95 ((version & SSL_CONNECTION_VERSION_MASK) <<
96 SSL_CONNECTION_VERSION_SHIFT);
99 // Returns the net SSL version number (see ssl_connection_status_flags.h) for
100 // this SSL connection.
101 int GetNetSSLVersion(SSL* ssl) {
102 switch (SSL_version(ssl)) {
103 case SSL2_VERSION:
104 return SSL_CONNECTION_VERSION_SSL2;
105 case SSL3_VERSION:
106 return SSL_CONNECTION_VERSION_SSL3;
107 case TLS1_VERSION:
108 return SSL_CONNECTION_VERSION_TLS1;
109 case TLS1_1_VERSION:
110 return SSL_CONNECTION_VERSION_TLS1_1;
111 case TLS1_2_VERSION:
112 return SSL_CONNECTION_VERSION_TLS1_2;
113 default:
114 return SSL_CONNECTION_VERSION_UNKNOWN;
118 ScopedX509 OSCertHandleToOpenSSL(
119 X509Certificate::OSCertHandle os_handle) {
120 #if defined(USE_OPENSSL_CERTS)
121 return ScopedX509(X509Certificate::DupOSCertHandle(os_handle));
122 #else // !defined(USE_OPENSSL_CERTS)
123 std::string der_encoded;
124 if (!X509Certificate::GetDEREncoded(os_handle, &der_encoded))
125 return ScopedX509();
126 const uint8_t* bytes = reinterpret_cast<const uint8_t*>(der_encoded.data());
127 return ScopedX509(d2i_X509(NULL, &bytes, der_encoded.size()));
128 #endif // defined(USE_OPENSSL_CERTS)
131 ScopedX509Stack OSCertHandlesToOpenSSL(
132 const X509Certificate::OSCertHandles& os_handles) {
133 ScopedX509Stack stack(sk_X509_new_null());
134 for (size_t i = 0; i < os_handles.size(); i++) {
135 ScopedX509 x509 = OSCertHandleToOpenSSL(os_handles[i]);
136 if (!x509)
137 return ScopedX509Stack();
138 sk_X509_push(stack.get(), x509.release());
140 return stack.Pass();
143 int LogErrorCallback(const char* str, size_t len, void* context) {
144 LOG(ERROR) << base::StringPiece(str, len);
145 return 1;
148 bool IsOCSPStaplingSupported() {
149 #if defined(OS_WIN)
150 // CERT_OCSP_RESPONSE_PROP_ID is only implemented on Vista+, but it can be
151 // set on Windows XP without error. There is some overhead from the server
152 // sending the OCSP response if it supports the extension, for the subset of
153 // XP clients who will request it but be unable to use it, but this is an
154 // acceptable trade-off for simplicity of implementation.
155 return true;
156 #else
157 return false;
158 #endif
161 } // namespace
163 class SSLClientSocketOpenSSL::SSLContext {
164 public:
165 static SSLContext* GetInstance() { return Singleton<SSLContext>::get(); }
166 SSL_CTX* ssl_ctx() { return ssl_ctx_.get(); }
167 SSLSessionCacheOpenSSL* session_cache() { return &session_cache_; }
169 SSLClientSocketOpenSSL* GetClientSocketFromSSL(const SSL* ssl) {
170 DCHECK(ssl);
171 SSLClientSocketOpenSSL* socket = static_cast<SSLClientSocketOpenSSL*>(
172 SSL_get_ex_data(ssl, ssl_socket_data_index_));
173 DCHECK(socket);
174 return socket;
177 bool SetClientSocketForSSL(SSL* ssl, SSLClientSocketOpenSSL* socket) {
178 return SSL_set_ex_data(ssl, ssl_socket_data_index_, socket) != 0;
181 private:
182 friend struct DefaultSingletonTraits<SSLContext>;
184 SSLContext() {
185 crypto::EnsureOpenSSLInit();
186 ssl_socket_data_index_ = SSL_get_ex_new_index(0, 0, 0, 0, 0);
187 DCHECK_NE(ssl_socket_data_index_, -1);
188 ssl_ctx_.reset(SSL_CTX_new(SSLv23_client_method()));
189 session_cache_.Reset(ssl_ctx_.get(), kDefaultSessionCacheConfig);
190 SSL_CTX_set_cert_verify_callback(ssl_ctx_.get(), CertVerifyCallback, NULL);
191 SSL_CTX_set_cert_cb(ssl_ctx_.get(), ClientCertRequestCallback, NULL);
192 SSL_CTX_set_verify(ssl_ctx_.get(), SSL_VERIFY_PEER, NULL);
193 // This stops |SSL_shutdown| from generating the close_notify message, which
194 // is currently not sent on the network.
195 // TODO(haavardm): Remove setting quiet shutdown once 118366 is fixed.
196 SSL_CTX_set_quiet_shutdown(ssl_ctx_.get(), 1);
197 // TODO(kristianm): Only select this if ssl_config_.next_proto is not empty.
198 // It would be better if the callback were not a global setting,
199 // but that is an OpenSSL issue.
200 SSL_CTX_set_next_proto_select_cb(ssl_ctx_.get(), SelectNextProtoCallback,
201 NULL);
202 ssl_ctx_->tlsext_channel_id_enabled_new = 1;
204 scoped_ptr<base::Environment> env(base::Environment::Create());
205 std::string ssl_keylog_file;
206 if (env->GetVar("SSLKEYLOGFILE", &ssl_keylog_file) &&
207 !ssl_keylog_file.empty()) {
208 crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
209 BIO* bio = BIO_new_file(ssl_keylog_file.c_str(), "a");
210 if (!bio) {
211 LOG(ERROR) << "Failed to open " << ssl_keylog_file;
212 ERR_print_errors_cb(&LogErrorCallback, NULL);
213 } else {
214 SSL_CTX_set_keylog_bio(ssl_ctx_.get(), bio);
219 static std::string GetSessionCacheKey(const SSL* ssl) {
220 SSLClientSocketOpenSSL* socket = GetInstance()->GetClientSocketFromSSL(ssl);
221 CHECK(socket);
222 return socket->GetSessionCacheKey();
225 static SSLSessionCacheOpenSSL::Config kDefaultSessionCacheConfig;
227 static int ClientCertRequestCallback(SSL* ssl, void* arg) {
228 SSLClientSocketOpenSSL* socket = GetInstance()->GetClientSocketFromSSL(ssl);
229 DCHECK(socket);
230 return socket->ClientCertRequestCallback(ssl);
233 static int CertVerifyCallback(X509_STORE_CTX *store_ctx, void *arg) {
234 SSL* ssl = reinterpret_cast<SSL*>(X509_STORE_CTX_get_ex_data(
235 store_ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
236 SSLClientSocketOpenSSL* socket = GetInstance()->GetClientSocketFromSSL(ssl);
237 CHECK(socket);
239 return socket->CertVerifyCallback(store_ctx);
242 static int SelectNextProtoCallback(SSL* ssl,
243 unsigned char** out, unsigned char* outlen,
244 const unsigned char* in,
245 unsigned int inlen, void* arg) {
246 SSLClientSocketOpenSSL* socket = GetInstance()->GetClientSocketFromSSL(ssl);
247 return socket->SelectNextProtoCallback(out, outlen, in, inlen);
250 // This is the index used with SSL_get_ex_data to retrieve the owner
251 // SSLClientSocketOpenSSL object from an SSL instance.
252 int ssl_socket_data_index_;
254 ScopedSSL_CTX ssl_ctx_;
255 // |session_cache_| must be destroyed before |ssl_ctx_|.
256 SSLSessionCacheOpenSSL session_cache_;
259 // PeerCertificateChain is a helper object which extracts the certificate
260 // chain, as given by the server, from an OpenSSL socket and performs the needed
261 // resource management. The first element of the chain is the leaf certificate
262 // and the other elements are in the order given by the server.
263 class SSLClientSocketOpenSSL::PeerCertificateChain {
264 public:
265 explicit PeerCertificateChain(STACK_OF(X509)* chain) { Reset(chain); }
266 PeerCertificateChain(const PeerCertificateChain& other) { *this = other; }
267 ~PeerCertificateChain() {}
268 PeerCertificateChain& operator=(const PeerCertificateChain& other);
270 // Resets the PeerCertificateChain to the set of certificates in|chain|,
271 // which may be NULL, indicating to empty the store certificates.
272 // Note: If an error occurs, such as being unable to parse the certificates,
273 // this will behave as if Reset(NULL) was called.
274 void Reset(STACK_OF(X509)* chain);
276 // Note that when USE_OPENSSL is defined, OSCertHandle is X509*
277 scoped_refptr<X509Certificate> AsOSChain() const;
279 size_t size() const {
280 if (!openssl_chain_.get())
281 return 0;
282 return sk_X509_num(openssl_chain_.get());
285 bool empty() const {
286 return size() == 0;
289 X509* Get(size_t index) const {
290 DCHECK_LT(index, size());
291 return sk_X509_value(openssl_chain_.get(), index);
294 private:
295 ScopedX509Stack openssl_chain_;
298 SSLClientSocketOpenSSL::PeerCertificateChain&
299 SSLClientSocketOpenSSL::PeerCertificateChain::operator=(
300 const PeerCertificateChain& other) {
301 if (this == &other)
302 return *this;
304 openssl_chain_.reset(X509_chain_up_ref(other.openssl_chain_.get()));
305 return *this;
308 void SSLClientSocketOpenSSL::PeerCertificateChain::Reset(
309 STACK_OF(X509)* chain) {
310 openssl_chain_.reset(chain ? X509_chain_up_ref(chain) : NULL);
313 scoped_refptr<X509Certificate>
314 SSLClientSocketOpenSSL::PeerCertificateChain::AsOSChain() const {
315 #if defined(USE_OPENSSL_CERTS)
316 // When OSCertHandle is typedef'ed to X509, this implementation does a short
317 // cut to avoid converting back and forth between DER and the X509 struct.
318 X509Certificate::OSCertHandles intermediates;
319 for (size_t i = 1; i < sk_X509_num(openssl_chain_.get()); ++i) {
320 intermediates.push_back(sk_X509_value(openssl_chain_.get(), i));
323 return make_scoped_refptr(X509Certificate::CreateFromHandle(
324 sk_X509_value(openssl_chain_.get(), 0), intermediates));
325 #else
326 // DER-encode the chain and convert to a platform certificate handle.
327 std::vector<base::StringPiece> der_chain;
328 for (size_t i = 0; i < sk_X509_num(openssl_chain_.get()); ++i) {
329 X509* x = sk_X509_value(openssl_chain_.get(), i);
330 base::StringPiece der;
331 if (!x509_util::GetDER(x, &der))
332 return NULL;
333 der_chain.push_back(der);
336 return make_scoped_refptr(X509Certificate::CreateFromDERCertChain(der_chain));
337 #endif
340 // static
341 SSLSessionCacheOpenSSL::Config
342 SSLClientSocketOpenSSL::SSLContext::kDefaultSessionCacheConfig = {
343 &GetSessionCacheKey, // key_func
344 1024, // max_entries
345 256, // expiration_check_count
346 60 * 60, // timeout_seconds
349 // static
350 void SSLClientSocket::ClearSessionCache() {
351 SSLClientSocketOpenSSL::SSLContext* context =
352 SSLClientSocketOpenSSL::SSLContext::GetInstance();
353 context->session_cache()->Flush();
356 // static
357 uint16 SSLClientSocket::GetMaxSupportedSSLVersion() {
358 return SSL_PROTOCOL_VERSION_TLS1_2;
361 SSLClientSocketOpenSSL::SSLClientSocketOpenSSL(
362 scoped_ptr<ClientSocketHandle> transport_socket,
363 const HostPortPair& host_and_port,
364 const SSLConfig& ssl_config,
365 const SSLClientSocketContext& context)
366 : transport_send_busy_(false),
367 transport_recv_busy_(false),
368 pending_read_error_(kNoPendingReadResult),
369 pending_read_ssl_error_(SSL_ERROR_NONE),
370 transport_read_error_(OK),
371 transport_write_error_(OK),
372 server_cert_chain_(new PeerCertificateChain(NULL)),
373 completed_connect_(false),
374 was_ever_used_(false),
375 client_auth_cert_needed_(false),
376 cert_verifier_(context.cert_verifier),
377 cert_transparency_verifier_(context.cert_transparency_verifier),
378 channel_id_service_(context.channel_id_service),
379 ssl_(NULL),
380 transport_bio_(NULL),
381 transport_(transport_socket.Pass()),
382 host_and_port_(host_and_port),
383 ssl_config_(ssl_config),
384 ssl_session_cache_shard_(context.ssl_session_cache_shard),
385 trying_cached_session_(false),
386 next_handshake_state_(STATE_NONE),
387 npn_status_(kNextProtoUnsupported),
388 channel_id_xtn_negotiated_(false),
389 transport_security_state_(context.transport_security_state),
390 policy_enforcer_(context.cert_policy_enforcer),
391 net_log_(transport_->socket()->NetLog()),
392 weak_factory_(this) {
395 SSLClientSocketOpenSSL::~SSLClientSocketOpenSSL() {
396 Disconnect();
399 void SSLClientSocketOpenSSL::GetSSLCertRequestInfo(
400 SSLCertRequestInfo* cert_request_info) {
401 cert_request_info->host_and_port = host_and_port_;
402 cert_request_info->cert_authorities = cert_authorities_;
403 cert_request_info->cert_key_types = cert_key_types_;
406 SSLClientSocket::NextProtoStatus SSLClientSocketOpenSSL::GetNextProto(
407 std::string* proto) {
408 *proto = npn_proto_;
409 return npn_status_;
412 ChannelIDService*
413 SSLClientSocketOpenSSL::GetChannelIDService() const {
414 return channel_id_service_;
417 int SSLClientSocketOpenSSL::ExportKeyingMaterial(
418 const base::StringPiece& label,
419 bool has_context, const base::StringPiece& context,
420 unsigned char* out, unsigned int outlen) {
421 crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
423 int rv = SSL_export_keying_material(
424 ssl_, out, outlen, label.data(), label.size(),
425 reinterpret_cast<const unsigned char*>(context.data()),
426 context.length(), context.length() > 0);
428 if (rv != 1) {
429 int ssl_error = SSL_get_error(ssl_, rv);
430 LOG(ERROR) << "Failed to export keying material;"
431 << " returned " << rv
432 << ", SSL error code " << ssl_error;
433 return MapOpenSSLError(ssl_error, err_tracer);
435 return OK;
438 int SSLClientSocketOpenSSL::GetTLSUniqueChannelBinding(std::string* out) {
439 NOTIMPLEMENTED();
440 return ERR_NOT_IMPLEMENTED;
443 int SSLClientSocketOpenSSL::Connect(const CompletionCallback& callback) {
444 // It is an error to create an SSLClientSocket whose context has no
445 // TransportSecurityState.
446 DCHECK(transport_security_state_);
448 net_log_.BeginEvent(NetLog::TYPE_SSL_CONNECT);
450 // Set up new ssl object.
451 int rv = Init();
452 if (rv != OK) {
453 net_log_.EndEventWithNetErrorCode(NetLog::TYPE_SSL_CONNECT, rv);
454 return rv;
457 // Set SSL to client mode. Handshake happens in the loop below.
458 SSL_set_connect_state(ssl_);
460 // Enable fastradio padding.
461 SSL_enable_fastradio_padding(ssl_,
462 ssl_config_.fastradio_padding_enabled &&
463 ssl_config_.fastradio_padding_eligible);
465 GotoState(STATE_HANDSHAKE);
466 rv = DoHandshakeLoop(OK);
467 if (rv == ERR_IO_PENDING) {
468 user_connect_callback_ = callback;
469 } else {
470 net_log_.EndEventWithNetErrorCode(NetLog::TYPE_SSL_CONNECT, rv);
473 return rv > OK ? OK : rv;
476 void SSLClientSocketOpenSSL::Disconnect() {
477 if (ssl_) {
478 // Calling SSL_shutdown prevents the session from being marked as
479 // unresumable.
480 SSL_shutdown(ssl_);
481 SSL_free(ssl_);
482 ssl_ = NULL;
484 if (transport_bio_) {
485 BIO_free_all(transport_bio_);
486 transport_bio_ = NULL;
489 // Shut down anything that may call us back.
490 verifier_.reset();
491 transport_->socket()->Disconnect();
493 // Null all callbacks, delete all buffers.
494 transport_send_busy_ = false;
495 send_buffer_ = NULL;
496 transport_recv_busy_ = false;
497 recv_buffer_ = NULL;
499 user_connect_callback_.Reset();
500 user_read_callback_.Reset();
501 user_write_callback_.Reset();
502 user_read_buf_ = NULL;
503 user_read_buf_len_ = 0;
504 user_write_buf_ = NULL;
505 user_write_buf_len_ = 0;
507 pending_read_error_ = kNoPendingReadResult;
508 pending_read_ssl_error_ = SSL_ERROR_NONE;
509 pending_read_error_info_ = OpenSSLErrorInfo();
511 transport_read_error_ = OK;
512 transport_write_error_ = OK;
514 server_cert_verify_result_.Reset();
515 completed_connect_ = false;
517 cert_authorities_.clear();
518 cert_key_types_.clear();
519 client_auth_cert_needed_ = false;
521 start_cert_verification_time_ = base::TimeTicks();
523 npn_status_ = kNextProtoUnsupported;
524 npn_proto_.clear();
526 channel_id_xtn_negotiated_ = false;
527 channel_id_request_handle_.Cancel();
530 bool SSLClientSocketOpenSSL::IsConnected() const {
531 // If the handshake has not yet completed.
532 if (!completed_connect_)
533 return false;
534 // If an asynchronous operation is still pending.
535 if (user_read_buf_.get() || user_write_buf_.get())
536 return true;
538 return transport_->socket()->IsConnected();
541 bool SSLClientSocketOpenSSL::IsConnectedAndIdle() const {
542 // If the handshake has not yet completed.
543 if (!completed_connect_)
544 return false;
545 // If an asynchronous operation is still pending.
546 if (user_read_buf_.get() || user_write_buf_.get())
547 return false;
548 // If there is data waiting to be sent, or data read from the network that
549 // has not yet been consumed.
550 if (BIO_pending(transport_bio_) > 0 ||
551 BIO_wpending(transport_bio_) > 0) {
552 return false;
555 return transport_->socket()->IsConnectedAndIdle();
558 int SSLClientSocketOpenSSL::GetPeerAddress(IPEndPoint* addressList) const {
559 return transport_->socket()->GetPeerAddress(addressList);
562 int SSLClientSocketOpenSSL::GetLocalAddress(IPEndPoint* addressList) const {
563 return transport_->socket()->GetLocalAddress(addressList);
566 const BoundNetLog& SSLClientSocketOpenSSL::NetLog() const {
567 return net_log_;
570 void SSLClientSocketOpenSSL::SetSubresourceSpeculation() {
571 if (transport_.get() && transport_->socket()) {
572 transport_->socket()->SetSubresourceSpeculation();
573 } else {
574 NOTREACHED();
578 void SSLClientSocketOpenSSL::SetOmniboxSpeculation() {
579 if (transport_.get() && transport_->socket()) {
580 transport_->socket()->SetOmniboxSpeculation();
581 } else {
582 NOTREACHED();
586 bool SSLClientSocketOpenSSL::WasEverUsed() const {
587 return was_ever_used_;
590 bool SSLClientSocketOpenSSL::UsingTCPFastOpen() const {
591 if (transport_.get() && transport_->socket())
592 return transport_->socket()->UsingTCPFastOpen();
594 NOTREACHED();
595 return false;
598 bool SSLClientSocketOpenSSL::GetSSLInfo(SSLInfo* ssl_info) {
599 ssl_info->Reset();
600 if (server_cert_chain_->empty())
601 return false;
603 ssl_info->cert = server_cert_verify_result_.verified_cert;
604 ssl_info->cert_status = server_cert_verify_result_.cert_status;
605 ssl_info->is_issued_by_known_root =
606 server_cert_verify_result_.is_issued_by_known_root;
607 ssl_info->public_key_hashes =
608 server_cert_verify_result_.public_key_hashes;
609 ssl_info->client_cert_sent =
610 ssl_config_.send_client_cert && ssl_config_.client_cert.get();
611 ssl_info->channel_id_sent = WasChannelIDSent();
612 ssl_info->pinning_failure_log = pinning_failure_log_;
614 AddSCTInfoToSSLInfo(ssl_info);
616 const SSL_CIPHER* cipher = SSL_get_current_cipher(ssl_);
617 CHECK(cipher);
618 ssl_info->security_bits = SSL_CIPHER_get_bits(cipher, NULL);
620 ssl_info->connection_status = EncodeSSLConnectionStatus(
621 static_cast<uint16>(SSL_CIPHER_get_id(cipher)), 0 /* no compression */,
622 GetNetSSLVersion(ssl_));
624 if (!SSL_get_secure_renegotiation_support(ssl_))
625 ssl_info->connection_status |= SSL_CONNECTION_NO_RENEGOTIATION_EXTENSION;
627 if (ssl_config_.version_fallback)
628 ssl_info->connection_status |= SSL_CONNECTION_VERSION_FALLBACK;
630 ssl_info->handshake_type = SSL_session_reused(ssl_) ?
631 SSLInfo::HANDSHAKE_RESUME : SSLInfo::HANDSHAKE_FULL;
633 DVLOG(3) << "Encoded connection status: cipher suite = "
634 << SSLConnectionStatusToCipherSuite(ssl_info->connection_status)
635 << " version = "
636 << SSLConnectionStatusToVersion(ssl_info->connection_status);
637 return true;
640 int SSLClientSocketOpenSSL::Read(IOBuffer* buf,
641 int buf_len,
642 const CompletionCallback& callback) {
643 user_read_buf_ = buf;
644 user_read_buf_len_ = buf_len;
646 int rv = DoReadLoop();
648 if (rv == ERR_IO_PENDING) {
649 user_read_callback_ = callback;
650 } else {
651 if (rv > 0)
652 was_ever_used_ = true;
653 user_read_buf_ = NULL;
654 user_read_buf_len_ = 0;
657 return rv;
660 int SSLClientSocketOpenSSL::Write(IOBuffer* buf,
661 int buf_len,
662 const CompletionCallback& callback) {
663 user_write_buf_ = buf;
664 user_write_buf_len_ = buf_len;
666 int rv = DoWriteLoop();
668 if (rv == ERR_IO_PENDING) {
669 user_write_callback_ = callback;
670 } else {
671 if (rv > 0)
672 was_ever_used_ = true;
673 user_write_buf_ = NULL;
674 user_write_buf_len_ = 0;
677 return rv;
680 int SSLClientSocketOpenSSL::SetReceiveBufferSize(int32 size) {
681 return transport_->socket()->SetReceiveBufferSize(size);
684 int SSLClientSocketOpenSSL::SetSendBufferSize(int32 size) {
685 return transport_->socket()->SetSendBufferSize(size);
688 int SSLClientSocketOpenSSL::Init() {
689 DCHECK(!ssl_);
690 DCHECK(!transport_bio_);
692 SSLContext* context = SSLContext::GetInstance();
693 crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
695 ssl_ = SSL_new(context->ssl_ctx());
696 if (!ssl_ || !context->SetClientSocketForSSL(ssl_, this))
697 return ERR_UNEXPECTED;
699 if (!SSL_set_tlsext_host_name(ssl_, host_and_port_.host().c_str()))
700 return ERR_UNEXPECTED;
702 trying_cached_session_ = context->session_cache()->SetSSLSessionWithKey(
703 ssl_, GetSessionCacheKey());
705 send_buffer_ = new GrowableIOBuffer();
706 send_buffer_->SetCapacity(KDefaultOpenSSLBufferSize);
707 recv_buffer_ = new GrowableIOBuffer();
708 recv_buffer_->SetCapacity(KDefaultOpenSSLBufferSize);
710 BIO* ssl_bio = NULL;
712 // SSLClientSocketOpenSSL retains ownership of the BIO buffers.
713 if (!BIO_new_bio_pair_external_buf(
714 &ssl_bio, send_buffer_->capacity(),
715 reinterpret_cast<uint8_t*>(send_buffer_->data()), &transport_bio_,
716 recv_buffer_->capacity(),
717 reinterpret_cast<uint8_t*>(recv_buffer_->data())))
718 return ERR_UNEXPECTED;
719 DCHECK(ssl_bio);
720 DCHECK(transport_bio_);
722 // Install a callback on OpenSSL's end to plumb transport errors through.
723 BIO_set_callback(ssl_bio, &SSLClientSocketOpenSSL::BIOCallback);
724 BIO_set_callback_arg(ssl_bio, reinterpret_cast<char*>(this));
726 SSL_set_bio(ssl_, ssl_bio, ssl_bio);
728 // OpenSSL defaults some options to on, others to off. To avoid ambiguity,
729 // set everything we care about to an absolute value.
730 SslSetClearMask options;
731 options.ConfigureFlag(SSL_OP_NO_SSLv2, true);
732 bool ssl3_enabled = (ssl_config_.version_min == SSL_PROTOCOL_VERSION_SSL3);
733 options.ConfigureFlag(SSL_OP_NO_SSLv3, !ssl3_enabled);
734 bool tls1_enabled = (ssl_config_.version_min <= SSL_PROTOCOL_VERSION_TLS1 &&
735 ssl_config_.version_max >= SSL_PROTOCOL_VERSION_TLS1);
736 options.ConfigureFlag(SSL_OP_NO_TLSv1, !tls1_enabled);
737 bool tls1_1_enabled =
738 (ssl_config_.version_min <= SSL_PROTOCOL_VERSION_TLS1_1 &&
739 ssl_config_.version_max >= SSL_PROTOCOL_VERSION_TLS1_1);
740 options.ConfigureFlag(SSL_OP_NO_TLSv1_1, !tls1_1_enabled);
741 bool tls1_2_enabled =
742 (ssl_config_.version_min <= SSL_PROTOCOL_VERSION_TLS1_2 &&
743 ssl_config_.version_max >= SSL_PROTOCOL_VERSION_TLS1_2);
744 options.ConfigureFlag(SSL_OP_NO_TLSv1_2, !tls1_2_enabled);
746 options.ConfigureFlag(SSL_OP_NO_COMPRESSION, true);
748 // TODO(joth): Set this conditionally, see http://crbug.com/55410
749 options.ConfigureFlag(SSL_OP_LEGACY_SERVER_CONNECT, true);
751 SSL_set_options(ssl_, options.set_mask);
752 SSL_clear_options(ssl_, options.clear_mask);
754 // Same as above, this time for the SSL mode.
755 SslSetClearMask mode;
757 mode.ConfigureFlag(SSL_MODE_RELEASE_BUFFERS, true);
758 mode.ConfigureFlag(SSL_MODE_CBC_RECORD_SPLITTING, true);
760 mode.ConfigureFlag(SSL_MODE_ENABLE_FALSE_START,
761 ssl_config_.false_start_enabled);
763 mode.ConfigureFlag(SSL_MODE_SEND_FALLBACK_SCSV, ssl_config_.version_fallback);
765 SSL_set_mode(ssl_, mode.set_mask);
766 SSL_clear_mode(ssl_, mode.clear_mask);
768 // Removing ciphers by ID from OpenSSL is a bit involved as we must use the
769 // textual name with SSL_set_cipher_list because there is no public API to
770 // directly remove a cipher by ID.
771 STACK_OF(SSL_CIPHER)* ciphers = SSL_get_ciphers(ssl_);
772 DCHECK(ciphers);
773 // See SSLConfig::disabled_cipher_suites for description of the suites
774 // disabled by default. Note that !SHA256 and !SHA384 only remove HMAC-SHA256
775 // and HMAC-SHA384 cipher suites, not GCM cipher suites with SHA256 or SHA384
776 // as the handshake hash.
777 std::string command(
778 "DEFAULT:!NULL:!aNULL:!SHA256:!SHA384:!aECDH:!AESGCM+AES256:!aPSK");
779 // Walk through all the installed ciphers, seeing if any need to be
780 // appended to the cipher removal |command|.
781 for (size_t i = 0; i < sk_SSL_CIPHER_num(ciphers); ++i) {
782 const SSL_CIPHER* cipher = sk_SSL_CIPHER_value(ciphers, i);
783 const uint16 id = static_cast<uint16>(SSL_CIPHER_get_id(cipher));
784 // Remove any ciphers with a strength of less than 80 bits. Note the NSS
785 // implementation uses "effective" bits here but OpenSSL does not provide
786 // this detail. This only impacts Triple DES: reports 112 vs. 168 bits,
787 // both of which are greater than 80 anyway.
788 bool disable = SSL_CIPHER_get_bits(cipher, NULL) < 80;
789 if (!disable) {
790 disable = std::find(ssl_config_.disabled_cipher_suites.begin(),
791 ssl_config_.disabled_cipher_suites.end(), id) !=
792 ssl_config_.disabled_cipher_suites.end();
794 if (disable) {
795 const char* name = SSL_CIPHER_get_name(cipher);
796 DVLOG(3) << "Found cipher to remove: '" << name << "', ID: " << id
797 << " strength: " << SSL_CIPHER_get_bits(cipher, NULL);
798 command.append(":!");
799 command.append(name);
803 // Disable ECDSA cipher suites on platforms that do not support ECDSA
804 // signed certificates, as servers may use the presence of such
805 // ciphersuites as a hint to send an ECDSA certificate.
806 #if defined(OS_WIN)
807 if (base::win::GetVersion() < base::win::VERSION_VISTA)
808 command.append(":!ECDSA");
809 #endif
811 int rv = SSL_set_cipher_list(ssl_, command.c_str());
812 // If this fails (rv = 0) it means there are no ciphers enabled on this SSL.
813 // This will almost certainly result in the socket failing to complete the
814 // handshake at which point the appropriate error is bubbled up to the client.
815 LOG_IF(WARNING, rv != 1) << "SSL_set_cipher_list('" << command << "') "
816 "returned " << rv;
818 // TLS channel ids.
819 if (IsChannelIDEnabled(ssl_config_, channel_id_service_)) {
820 SSL_enable_tls_channel_id(ssl_);
823 if (!ssl_config_.next_protos.empty()) {
824 // Get list of ciphers that are enabled.
825 STACK_OF(SSL_CIPHER)* enabled_ciphers = SSL_get_ciphers(ssl_);
826 DCHECK(enabled_ciphers);
827 std::vector<uint16> enabled_ciphers_vector;
828 for (size_t i = 0; i < sk_SSL_CIPHER_num(enabled_ciphers); ++i) {
829 const SSL_CIPHER* cipher = sk_SSL_CIPHER_value(enabled_ciphers, i);
830 const uint16 id = static_cast<uint16>(SSL_CIPHER_get_id(cipher));
831 enabled_ciphers_vector.push_back(id);
834 std::vector<uint8_t> wire_protos =
835 SerializeNextProtos(ssl_config_.next_protos,
836 HasCipherAdequateForHTTP2(enabled_ciphers_vector) &&
837 IsTLSVersionAdequateForHTTP2(ssl_config_));
838 SSL_set_alpn_protos(ssl_, wire_protos.empty() ? NULL : &wire_protos[0],
839 wire_protos.size());
842 if (ssl_config_.signed_cert_timestamps_enabled) {
843 SSL_enable_signed_cert_timestamps(ssl_);
844 SSL_enable_ocsp_stapling(ssl_);
847 if (IsOCSPStaplingSupported())
848 SSL_enable_ocsp_stapling(ssl_);
850 return OK;
853 void SSLClientSocketOpenSSL::DoReadCallback(int rv) {
854 // Since Run may result in Read being called, clear |user_read_callback_|
855 // up front.
856 if (rv > 0)
857 was_ever_used_ = true;
858 user_read_buf_ = NULL;
859 user_read_buf_len_ = 0;
860 base::ResetAndReturn(&user_read_callback_).Run(rv);
863 void SSLClientSocketOpenSSL::DoWriteCallback(int rv) {
864 // Since Run may result in Write being called, clear |user_write_callback_|
865 // up front.
866 if (rv > 0)
867 was_ever_used_ = true;
868 user_write_buf_ = NULL;
869 user_write_buf_len_ = 0;
870 base::ResetAndReturn(&user_write_callback_).Run(rv);
873 bool SSLClientSocketOpenSSL::DoTransportIO() {
874 bool network_moved = false;
875 int rv;
876 // Read and write as much data as possible. The loop is necessary because
877 // Write() may return synchronously.
878 do {
879 rv = BufferSend();
880 if (rv != ERR_IO_PENDING && rv != 0)
881 network_moved = true;
882 } while (rv > 0);
883 if (transport_read_error_ == OK && BufferRecv() != ERR_IO_PENDING)
884 network_moved = true;
885 return network_moved;
888 // TODO(vadimt): Remove including "base/threading/thread_local.h" and
889 // g_first_run_completed once crbug.com/424386 is fixed.
890 base::LazyInstance<base::ThreadLocalBoolean>::Leaky g_first_run_completed =
891 LAZY_INSTANCE_INITIALIZER;
893 int SSLClientSocketOpenSSL::DoHandshake() {
894 crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
895 int net_error = OK;
897 int rv;
899 // TODO(vadimt): Leave only 1 call to SSL_do_handshake once crbug.com/424386
900 // is fixed.
901 if (ssl_config_.send_client_cert && ssl_config_.client_cert.get()) {
902 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
903 tracked_objects::ScopedTracker tracking_profile1(
904 FROM_HERE_WITH_EXPLICIT_FUNCTION("424386 DoHandshake_WithCert"));
906 rv = SSL_do_handshake(ssl_);
907 } else {
908 if (g_first_run_completed.Get().Get()) {
909 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is
910 // fixed.
911 tracked_objects::ScopedTracker tracking_profile1(
912 FROM_HERE_WITH_EXPLICIT_FUNCTION(
913 "424386 DoHandshake_WithoutCert Not First"));
915 rv = SSL_do_handshake(ssl_);
916 } else {
917 g_first_run_completed.Get().Set(true);
919 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is
920 // fixed.
921 tracked_objects::ScopedTracker tracking_profile1(
922 FROM_HERE_WITH_EXPLICIT_FUNCTION(
923 "424386 DoHandshake_WithoutCert First"));
925 rv = SSL_do_handshake(ssl_);
929 if (client_auth_cert_needed_) {
930 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
931 tracked_objects::ScopedTracker tracking_profile2(
932 FROM_HERE_WITH_EXPLICIT_FUNCTION(
933 "424386 SSLClientSocketOpenSSL::DoHandshake2"));
935 net_error = ERR_SSL_CLIENT_AUTH_CERT_NEEDED;
936 // If the handshake already succeeded (because the server requests but
937 // doesn't require a client cert), we need to invalidate the SSL session
938 // so that we won't try to resume the non-client-authenticated session in
939 // the next handshake. This will cause the server to ask for a client
940 // cert again.
941 if (rv == 1) {
942 // Remove from session cache but don't clear this connection.
943 SSL_SESSION* session = SSL_get_session(ssl_);
944 if (session) {
945 int rv = SSL_CTX_remove_session(SSL_get_SSL_CTX(ssl_), session);
946 LOG_IF(WARNING, !rv) << "Couldn't invalidate SSL session: " << session;
949 } else if (rv == 1) {
950 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
951 tracked_objects::ScopedTracker tracking_profile3(
952 FROM_HERE_WITH_EXPLICIT_FUNCTION(
953 "424386 SSLClientSocketOpenSSL::DoHandshake3"));
955 if (trying_cached_session_ && logging::DEBUG_MODE) {
956 DVLOG(2) << "Result of session reuse for " << host_and_port_.ToString()
957 << " is: " << (SSL_session_reused(ssl_) ? "Success" : "Fail");
960 if (ssl_config_.version_fallback &&
961 ssl_config_.version_max < ssl_config_.version_fallback_min) {
962 return ERR_SSL_FALLBACK_BEYOND_MINIMUM_VERSION;
965 // SSL handshake is completed. If NPN wasn't negotiated, see if ALPN was.
966 if (npn_status_ == kNextProtoUnsupported) {
967 const uint8_t* alpn_proto = NULL;
968 unsigned alpn_len = 0;
969 SSL_get0_alpn_selected(ssl_, &alpn_proto, &alpn_len);
970 if (alpn_len > 0) {
971 npn_proto_.assign(reinterpret_cast<const char*>(alpn_proto), alpn_len);
972 npn_status_ = kNextProtoNegotiated;
973 set_negotiation_extension(kExtensionALPN);
977 RecordChannelIDSupport(channel_id_service_,
978 channel_id_xtn_negotiated_,
979 ssl_config_.channel_id_enabled,
980 crypto::ECPrivateKey::IsSupported());
982 // Only record OCSP histograms if OCSP was requested.
983 if (ssl_config_.signed_cert_timestamps_enabled ||
984 IsOCSPStaplingSupported()) {
985 const uint8_t* ocsp_response;
986 size_t ocsp_response_len;
987 SSL_get0_ocsp_response(ssl_, &ocsp_response, &ocsp_response_len);
989 set_stapled_ocsp_response_received(ocsp_response_len != 0);
990 UMA_HISTOGRAM_BOOLEAN("Net.OCSPResponseStapled", ocsp_response_len != 0);
993 const uint8_t* sct_list;
994 size_t sct_list_len;
995 SSL_get0_signed_cert_timestamp_list(ssl_, &sct_list, &sct_list_len);
996 set_signed_cert_timestamps_received(sct_list_len != 0);
998 // Verify the certificate.
999 UpdateServerCert();
1000 GotoState(STATE_VERIFY_CERT);
1001 } else {
1002 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
1003 tracked_objects::ScopedTracker tracking_profile4(
1004 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1005 "424386 SSLClientSocketOpenSSL::DoHandshake4"));
1007 int ssl_error = SSL_get_error(ssl_, rv);
1009 if (ssl_error == SSL_ERROR_WANT_CHANNEL_ID_LOOKUP) {
1010 // The server supports channel ID. Stop to look one up before returning to
1011 // the handshake.
1012 channel_id_xtn_negotiated_ = true;
1013 GotoState(STATE_CHANNEL_ID_LOOKUP);
1014 return OK;
1017 OpenSSLErrorInfo error_info;
1018 net_error = MapOpenSSLErrorWithDetails(ssl_error, err_tracer, &error_info);
1020 // If not done, stay in this state
1021 if (net_error == ERR_IO_PENDING) {
1022 GotoState(STATE_HANDSHAKE);
1023 } else {
1024 LOG(ERROR) << "handshake failed; returned " << rv
1025 << ", SSL error code " << ssl_error
1026 << ", net_error " << net_error;
1027 net_log_.AddEvent(
1028 NetLog::TYPE_SSL_HANDSHAKE_ERROR,
1029 CreateNetLogOpenSSLErrorCallback(net_error, ssl_error, error_info));
1032 return net_error;
1035 int SSLClientSocketOpenSSL::DoChannelIDLookup() {
1036 net_log_.AddEvent(NetLog::TYPE_SSL_CHANNEL_ID_REQUESTED);
1037 GotoState(STATE_CHANNEL_ID_LOOKUP_COMPLETE);
1038 return channel_id_service_->GetOrCreateChannelID(
1039 host_and_port_.host(),
1040 &channel_id_private_key_,
1041 &channel_id_cert_,
1042 base::Bind(&SSLClientSocketOpenSSL::OnHandshakeIOComplete,
1043 base::Unretained(this)),
1044 &channel_id_request_handle_);
1047 int SSLClientSocketOpenSSL::DoChannelIDLookupComplete(int result) {
1048 if (result < 0)
1049 return result;
1051 DCHECK_LT(0u, channel_id_private_key_.size());
1052 // Decode key.
1053 std::vector<uint8> encrypted_private_key_info;
1054 std::vector<uint8> subject_public_key_info;
1055 encrypted_private_key_info.assign(
1056 channel_id_private_key_.data(),
1057 channel_id_private_key_.data() + channel_id_private_key_.size());
1058 subject_public_key_info.assign(
1059 channel_id_cert_.data(),
1060 channel_id_cert_.data() + channel_id_cert_.size());
1061 scoped_ptr<crypto::ECPrivateKey> ec_private_key(
1062 crypto::ECPrivateKey::CreateFromEncryptedPrivateKeyInfo(
1063 ChannelIDService::kEPKIPassword,
1064 encrypted_private_key_info,
1065 subject_public_key_info));
1066 if (!ec_private_key) {
1067 LOG(ERROR) << "Failed to import Channel ID.";
1068 return ERR_CHANNEL_ID_IMPORT_FAILED;
1071 // Hand the key to OpenSSL. Check for error in case OpenSSL rejects the key
1072 // type.
1073 crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
1074 int rv = SSL_set1_tls_channel_id(ssl_, ec_private_key->key());
1075 if (!rv) {
1076 LOG(ERROR) << "Failed to set Channel ID.";
1077 int err = SSL_get_error(ssl_, rv);
1078 return MapOpenSSLError(err, err_tracer);
1081 // Return to the handshake.
1082 set_channel_id_sent(true);
1083 net_log_.AddEvent(NetLog::TYPE_SSL_CHANNEL_ID_PROVIDED);
1084 GotoState(STATE_HANDSHAKE);
1085 return OK;
1088 int SSLClientSocketOpenSSL::DoVerifyCert(int result) {
1089 DCHECK(!server_cert_chain_->empty());
1090 DCHECK(start_cert_verification_time_.is_null());
1092 GotoState(STATE_VERIFY_CERT_COMPLETE);
1094 // If the certificate is bad and has been previously accepted, use
1095 // the previous status and bypass the error.
1096 base::StringPiece der_cert;
1097 if (!x509_util::GetDER(server_cert_chain_->Get(0), &der_cert)) {
1098 NOTREACHED();
1099 return ERR_CERT_INVALID;
1101 CertStatus cert_status;
1102 if (ssl_config_.IsAllowedBadCert(der_cert, &cert_status)) {
1103 VLOG(1) << "Received an expected bad cert with status: " << cert_status;
1104 server_cert_verify_result_.Reset();
1105 server_cert_verify_result_.cert_status = cert_status;
1106 server_cert_verify_result_.verified_cert = server_cert_;
1107 return OK;
1110 // When running in a sandbox, it may not be possible to create an
1111 // X509Certificate*, as that may depend on OS functionality blocked
1112 // in the sandbox.
1113 if (!server_cert_.get()) {
1114 server_cert_verify_result_.Reset();
1115 server_cert_verify_result_.cert_status = CERT_STATUS_INVALID;
1116 return ERR_CERT_INVALID;
1119 start_cert_verification_time_ = base::TimeTicks::Now();
1121 int flags = 0;
1122 if (ssl_config_.rev_checking_enabled)
1123 flags |= CertVerifier::VERIFY_REV_CHECKING_ENABLED;
1124 if (ssl_config_.verify_ev_cert)
1125 flags |= CertVerifier::VERIFY_EV_CERT;
1126 if (ssl_config_.cert_io_enabled)
1127 flags |= CertVerifier::VERIFY_CERT_IO_ENABLED;
1128 if (ssl_config_.rev_checking_required_local_anchors)
1129 flags |= CertVerifier::VERIFY_REV_CHECKING_REQUIRED_LOCAL_ANCHORS;
1130 verifier_.reset(new SingleRequestCertVerifier(cert_verifier_));
1131 return verifier_->Verify(
1132 server_cert_.get(),
1133 host_and_port_.host(),
1134 flags,
1135 // TODO(davidben): Route the CRLSet through SSLConfig so
1136 // SSLClientSocket doesn't depend on SSLConfigService.
1137 SSLConfigService::GetCRLSet().get(),
1138 &server_cert_verify_result_,
1139 base::Bind(&SSLClientSocketOpenSSL::OnHandshakeIOComplete,
1140 base::Unretained(this)),
1141 net_log_);
1144 int SSLClientSocketOpenSSL::DoVerifyCertComplete(int result) {
1145 verifier_.reset();
1147 if (!start_cert_verification_time_.is_null()) {
1148 base::TimeDelta verify_time =
1149 base::TimeTicks::Now() - start_cert_verification_time_;
1150 if (result == OK) {
1151 UMA_HISTOGRAM_TIMES("Net.SSLCertVerificationTime", verify_time);
1152 } else {
1153 UMA_HISTOGRAM_TIMES("Net.SSLCertVerificationTimeError", verify_time);
1157 if (result == OK) {
1158 if (SSL_session_reused(ssl_)) {
1159 // Record whether or not the server tried to resume a session for a
1160 // different version. See https://crbug.com/441456.
1161 UMA_HISTOGRAM_BOOLEAN(
1162 "Net.SSLSessionVersionMatch",
1163 SSL_version(ssl_) == SSL_get_session(ssl_)->ssl_version);
1167 const CertStatus cert_status = server_cert_verify_result_.cert_status;
1168 if (transport_security_state_ &&
1169 (result == OK ||
1170 (IsCertificateError(result) && IsCertStatusMinorError(cert_status))) &&
1171 !transport_security_state_->CheckPublicKeyPins(
1172 host_and_port_.host(),
1173 server_cert_verify_result_.is_issued_by_known_root,
1174 server_cert_verify_result_.public_key_hashes,
1175 &pinning_failure_log_)) {
1176 result = ERR_SSL_PINNED_KEY_NOT_IN_CERT_CHAIN;
1179 if (result == OK) {
1180 // Only check Certificate Transparency if there were no other errors with
1181 // the connection.
1182 VerifyCT();
1184 // TODO(joth): Work out if we need to remember the intermediate CA certs
1185 // when the server sends them to us, and do so here.
1186 SSLContext::GetInstance()->session_cache()->MarkSSLSessionAsGood(ssl_);
1187 } else {
1188 DVLOG(1) << "DoVerifyCertComplete error " << ErrorToString(result)
1189 << " (" << result << ")";
1192 completed_connect_ = true;
1193 // Exit DoHandshakeLoop and return the result to the caller to Connect.
1194 DCHECK_EQ(STATE_NONE, next_handshake_state_);
1195 return result;
1198 void SSLClientSocketOpenSSL::DoConnectCallback(int rv) {
1199 if (!user_connect_callback_.is_null()) {
1200 CompletionCallback c = user_connect_callback_;
1201 user_connect_callback_.Reset();
1202 c.Run(rv > OK ? OK : rv);
1206 void SSLClientSocketOpenSSL::UpdateServerCert() {
1207 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
1208 tracked_objects::ScopedTracker tracking_profile(
1209 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1210 "424386 SSLClientSocketOpenSSL::UpdateServerCert"));
1212 server_cert_chain_->Reset(SSL_get_peer_cert_chain(ssl_));
1214 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
1215 tracked_objects::ScopedTracker tracking_profile1(
1216 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1217 "424386 SSLClientSocketOpenSSL::UpdateServerCert1"));
1218 server_cert_ = server_cert_chain_->AsOSChain();
1220 if (server_cert_.get()) {
1221 net_log_.AddEvent(
1222 NetLog::TYPE_SSL_CERTIFICATES_RECEIVED,
1223 base::Bind(&NetLogX509CertificateCallback,
1224 base::Unretained(server_cert_.get())));
1226 // TODO(rsleevi): Plumb an OCSP response into the Mac system library and
1227 // update IsOCSPStaplingSupported for Mac. https://crbug.com/430714
1228 if (IsOCSPStaplingSupported()) {
1229 #if defined(OS_WIN)
1230 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is
1231 // fixed.
1232 tracked_objects::ScopedTracker tracking_profile2(
1233 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1234 "424386 SSLClientSocketOpenSSL::UpdateServerCert2"));
1236 const uint8_t* ocsp_response_raw;
1237 size_t ocsp_response_len;
1238 SSL_get0_ocsp_response(ssl_, &ocsp_response_raw, &ocsp_response_len);
1240 CRYPT_DATA_BLOB ocsp_response_blob;
1241 ocsp_response_blob.cbData = ocsp_response_len;
1242 ocsp_response_blob.pbData = const_cast<BYTE*>(ocsp_response_raw);
1243 BOOL ok = CertSetCertificateContextProperty(
1244 server_cert_->os_cert_handle(),
1245 CERT_OCSP_RESPONSE_PROP_ID,
1246 CERT_SET_PROPERTY_IGNORE_PERSIST_ERROR_FLAG,
1247 &ocsp_response_blob);
1248 if (!ok) {
1249 VLOG(1) << "Failed to set OCSP response property: "
1250 << GetLastError();
1252 #else
1253 NOTREACHED();
1254 #endif
1259 void SSLClientSocketOpenSSL::VerifyCT() {
1260 if (!cert_transparency_verifier_)
1261 return;
1263 const uint8_t* ocsp_response_raw;
1264 size_t ocsp_response_len;
1265 SSL_get0_ocsp_response(ssl_, &ocsp_response_raw, &ocsp_response_len);
1266 std::string ocsp_response;
1267 if (ocsp_response_len > 0) {
1268 ocsp_response.assign(reinterpret_cast<const char*>(ocsp_response_raw),
1269 ocsp_response_len);
1272 const uint8_t* sct_list_raw;
1273 size_t sct_list_len;
1274 SSL_get0_signed_cert_timestamp_list(ssl_, &sct_list_raw, &sct_list_len);
1275 std::string sct_list;
1276 if (sct_list_len > 0)
1277 sct_list.assign(reinterpret_cast<const char*>(sct_list_raw), sct_list_len);
1279 // Note that this is a completely synchronous operation: The CT Log Verifier
1280 // gets all the data it needs for SCT verification and does not do any
1281 // external communication.
1282 cert_transparency_verifier_->Verify(
1283 server_cert_verify_result_.verified_cert.get(), ocsp_response, sct_list,
1284 &ct_verify_result_, net_log_);
1286 if (!policy_enforcer_) {
1287 server_cert_verify_result_.cert_status &= ~CERT_STATUS_IS_EV;
1288 } else {
1289 if (server_cert_verify_result_.cert_status & CERT_STATUS_IS_EV) {
1290 scoped_refptr<ct::EVCertsWhitelist> ev_whitelist =
1291 SSLConfigService::GetEVCertsWhitelist();
1292 if (!policy_enforcer_->DoesConformToCTEVPolicy(
1293 server_cert_verify_result_.verified_cert.get(),
1294 ev_whitelist.get(), ct_verify_result_, net_log_)) {
1295 // TODO(eranm): Log via the BoundNetLog, see crbug.com/437766
1296 VLOG(1) << "EV certificate for "
1297 << server_cert_verify_result_.verified_cert->subject()
1298 .GetDisplayName()
1299 << " does not conform to CT policy, removing EV status.";
1300 server_cert_verify_result_.cert_status &= ~CERT_STATUS_IS_EV;
1306 void SSLClientSocketOpenSSL::OnHandshakeIOComplete(int result) {
1307 int rv = DoHandshakeLoop(result);
1308 if (rv != ERR_IO_PENDING) {
1309 net_log_.EndEventWithNetErrorCode(NetLog::TYPE_SSL_CONNECT, rv);
1310 DoConnectCallback(rv);
1314 void SSLClientSocketOpenSSL::OnSendComplete(int result) {
1315 if (next_handshake_state_ == STATE_HANDSHAKE) {
1316 // In handshake phase.
1317 OnHandshakeIOComplete(result);
1318 return;
1321 // OnSendComplete may need to call DoPayloadRead while the renegotiation
1322 // handshake is in progress.
1323 int rv_read = ERR_IO_PENDING;
1324 int rv_write = ERR_IO_PENDING;
1325 bool network_moved;
1326 do {
1327 if (user_read_buf_.get())
1328 rv_read = DoPayloadRead();
1329 if (user_write_buf_.get())
1330 rv_write = DoPayloadWrite();
1331 network_moved = DoTransportIO();
1332 } while (rv_read == ERR_IO_PENDING && rv_write == ERR_IO_PENDING &&
1333 (user_read_buf_.get() || user_write_buf_.get()) && network_moved);
1335 // Performing the Read callback may cause |this| to be deleted. If this
1336 // happens, the Write callback should not be invoked. Guard against this by
1337 // holding a WeakPtr to |this| and ensuring it's still valid.
1338 base::WeakPtr<SSLClientSocketOpenSSL> guard(weak_factory_.GetWeakPtr());
1339 if (user_read_buf_.get() && rv_read != ERR_IO_PENDING)
1340 DoReadCallback(rv_read);
1342 if (!guard.get())
1343 return;
1345 if (user_write_buf_.get() && rv_write != ERR_IO_PENDING)
1346 DoWriteCallback(rv_write);
1349 void SSLClientSocketOpenSSL::OnRecvComplete(int result) {
1350 if (next_handshake_state_ == STATE_HANDSHAKE) {
1351 // In handshake phase.
1352 OnHandshakeIOComplete(result);
1353 return;
1356 // Network layer received some data, check if client requested to read
1357 // decrypted data.
1358 if (!user_read_buf_.get())
1359 return;
1361 int rv = DoReadLoop();
1362 if (rv != ERR_IO_PENDING)
1363 DoReadCallback(rv);
1366 int SSLClientSocketOpenSSL::DoHandshakeLoop(int last_io_result) {
1367 int rv = last_io_result;
1368 do {
1369 // Default to STATE_NONE for next state.
1370 // (This is a quirk carried over from the windows
1371 // implementation. It makes reading the logs a bit harder.)
1372 // State handlers can and often do call GotoState just
1373 // to stay in the current state.
1374 State state = next_handshake_state_;
1375 GotoState(STATE_NONE);
1376 switch (state) {
1377 case STATE_HANDSHAKE:
1378 rv = DoHandshake();
1379 break;
1380 case STATE_CHANNEL_ID_LOOKUP:
1381 DCHECK_EQ(OK, rv);
1382 rv = DoChannelIDLookup();
1383 break;
1384 case STATE_CHANNEL_ID_LOOKUP_COMPLETE:
1385 rv = DoChannelIDLookupComplete(rv);
1386 break;
1387 case STATE_VERIFY_CERT:
1388 DCHECK_EQ(OK, rv);
1389 rv = DoVerifyCert(rv);
1390 break;
1391 case STATE_VERIFY_CERT_COMPLETE:
1392 rv = DoVerifyCertComplete(rv);
1393 break;
1394 case STATE_NONE:
1395 default:
1396 rv = ERR_UNEXPECTED;
1397 NOTREACHED() << "unexpected state" << state;
1398 break;
1401 bool network_moved = DoTransportIO();
1402 if (network_moved && next_handshake_state_ == STATE_HANDSHAKE) {
1403 // In general we exit the loop if rv is ERR_IO_PENDING. In this
1404 // special case we keep looping even if rv is ERR_IO_PENDING because
1405 // the transport IO may allow DoHandshake to make progress.
1406 rv = OK; // This causes us to stay in the loop.
1408 } while (rv != ERR_IO_PENDING && next_handshake_state_ != STATE_NONE);
1409 return rv;
1412 int SSLClientSocketOpenSSL::DoReadLoop() {
1413 bool network_moved;
1414 int rv;
1415 do {
1416 rv = DoPayloadRead();
1417 network_moved = DoTransportIO();
1418 } while (rv == ERR_IO_PENDING && network_moved);
1420 return rv;
1423 int SSLClientSocketOpenSSL::DoWriteLoop() {
1424 bool network_moved;
1425 int rv;
1426 do {
1427 rv = DoPayloadWrite();
1428 network_moved = DoTransportIO();
1429 } while (rv == ERR_IO_PENDING && network_moved);
1431 return rv;
1434 int SSLClientSocketOpenSSL::DoPayloadRead() {
1435 crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
1437 int rv;
1438 if (pending_read_error_ != kNoPendingReadResult) {
1439 rv = pending_read_error_;
1440 pending_read_error_ = kNoPendingReadResult;
1441 if (rv == 0) {
1442 net_log_.AddByteTransferEvent(NetLog::TYPE_SSL_SOCKET_BYTES_RECEIVED,
1443 rv, user_read_buf_->data());
1444 } else {
1445 net_log_.AddEvent(
1446 NetLog::TYPE_SSL_READ_ERROR,
1447 CreateNetLogOpenSSLErrorCallback(rv, pending_read_ssl_error_,
1448 pending_read_error_info_));
1450 pending_read_ssl_error_ = SSL_ERROR_NONE;
1451 pending_read_error_info_ = OpenSSLErrorInfo();
1452 return rv;
1455 int total_bytes_read = 0;
1456 do {
1457 rv = SSL_read(ssl_, user_read_buf_->data() + total_bytes_read,
1458 user_read_buf_len_ - total_bytes_read);
1459 if (rv > 0)
1460 total_bytes_read += rv;
1461 } while (total_bytes_read < user_read_buf_len_ && rv > 0);
1463 if (total_bytes_read == user_read_buf_len_) {
1464 rv = total_bytes_read;
1465 } else {
1466 // Otherwise, an error occurred (rv <= 0). The error needs to be handled
1467 // immediately, while the OpenSSL errors are still available in
1468 // thread-local storage. However, the handled/remapped error code should
1469 // only be returned if no application data was already read; if it was, the
1470 // error code should be deferred until the next call of DoPayloadRead.
1472 // If no data was read, |*next_result| will point to the return value of
1473 // this function. If at least some data was read, |*next_result| will point
1474 // to |pending_read_error_|, to be returned in a future call to
1475 // DoPayloadRead() (e.g.: after the current data is handled).
1476 int *next_result = &rv;
1477 if (total_bytes_read > 0) {
1478 pending_read_error_ = rv;
1479 rv = total_bytes_read;
1480 next_result = &pending_read_error_;
1483 if (client_auth_cert_needed_) {
1484 *next_result = ERR_SSL_CLIENT_AUTH_CERT_NEEDED;
1485 } else if (*next_result <= 0) {
1486 // A zero return from SSL_read may mean any of:
1487 // - The underlying BIO_read returned 0.
1488 // - The peer sent a close_notify.
1489 // - Any arbitrary error. https://crbug.com/466303
1491 // TransportReadComplete converts the first to an ERR_CONNECTION_CLOSED
1492 // error, so it does not occur. The second and third are distinguished by
1493 // SSL_ERROR_ZERO_RETURN.
1494 pending_read_ssl_error_ = SSL_get_error(ssl_, *next_result);
1495 if (pending_read_ssl_error_ == SSL_ERROR_ZERO_RETURN) {
1496 *next_result = 0;
1497 } else {
1498 *next_result = MapOpenSSLErrorWithDetails(
1499 pending_read_ssl_error_, err_tracer, &pending_read_error_info_);
1502 // Many servers do not reliably send a close_notify alert when shutting
1503 // down a connection, and instead terminate the TCP connection. This is
1504 // reported as ERR_CONNECTION_CLOSED. Because of this, map the unclean
1505 // shutdown to a graceful EOF, instead of treating it as an error as it
1506 // should be.
1507 if (*next_result == ERR_CONNECTION_CLOSED)
1508 *next_result = 0;
1510 if (rv > 0 && *next_result == ERR_IO_PENDING) {
1511 // If at least some data was read from SSL_read(), do not treat
1512 // insufficient data as an error to return in the next call to
1513 // DoPayloadRead() - instead, let the call fall through to check
1514 // SSL_read() again. This is because DoTransportIO() may complete
1515 // in between the next call to DoPayloadRead(), and thus it is
1516 // important to check SSL_read() on subsequent invocations to see
1517 // if a complete record may now be read.
1518 *next_result = kNoPendingReadResult;
1523 if (rv >= 0) {
1524 net_log_.AddByteTransferEvent(NetLog::TYPE_SSL_SOCKET_BYTES_RECEIVED, rv,
1525 user_read_buf_->data());
1526 } else if (rv != ERR_IO_PENDING) {
1527 net_log_.AddEvent(
1528 NetLog::TYPE_SSL_READ_ERROR,
1529 CreateNetLogOpenSSLErrorCallback(rv, pending_read_ssl_error_,
1530 pending_read_error_info_));
1531 pending_read_ssl_error_ = SSL_ERROR_NONE;
1532 pending_read_error_info_ = OpenSSLErrorInfo();
1534 return rv;
1537 int SSLClientSocketOpenSSL::DoPayloadWrite() {
1538 crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
1539 int rv = SSL_write(ssl_, user_write_buf_->data(), user_write_buf_len_);
1541 if (rv >= 0) {
1542 net_log_.AddByteTransferEvent(NetLog::TYPE_SSL_SOCKET_BYTES_SENT, rv,
1543 user_write_buf_->data());
1544 return rv;
1547 int ssl_error = SSL_get_error(ssl_, rv);
1548 OpenSSLErrorInfo error_info;
1549 int net_error = MapOpenSSLErrorWithDetails(ssl_error, err_tracer,
1550 &error_info);
1552 if (net_error != ERR_IO_PENDING) {
1553 net_log_.AddEvent(
1554 NetLog::TYPE_SSL_WRITE_ERROR,
1555 CreateNetLogOpenSSLErrorCallback(net_error, ssl_error, error_info));
1557 return net_error;
1560 int SSLClientSocketOpenSSL::BufferSend(void) {
1561 if (transport_send_busy_)
1562 return ERR_IO_PENDING;
1564 size_t buffer_read_offset;
1565 uint8_t* read_buf;
1566 size_t max_read;
1567 int status = BIO_zero_copy_get_read_buf(transport_bio_, &read_buf,
1568 &buffer_read_offset, &max_read);
1569 DCHECK_EQ(status, 1); // Should never fail.
1570 if (!max_read)
1571 return 0; // Nothing pending in the OpenSSL write BIO.
1572 CHECK_EQ(read_buf, reinterpret_cast<uint8_t*>(send_buffer_->StartOfBuffer()));
1573 CHECK_LT(buffer_read_offset, static_cast<size_t>(send_buffer_->capacity()));
1574 send_buffer_->set_offset(buffer_read_offset);
1576 int rv = transport_->socket()->Write(
1577 send_buffer_.get(), max_read,
1578 base::Bind(&SSLClientSocketOpenSSL::BufferSendComplete,
1579 base::Unretained(this)));
1580 if (rv == ERR_IO_PENDING) {
1581 transport_send_busy_ = true;
1582 } else {
1583 TransportWriteComplete(rv);
1585 return rv;
1588 int SSLClientSocketOpenSSL::BufferRecv(void) {
1589 if (transport_recv_busy_)
1590 return ERR_IO_PENDING;
1592 // Determine how much was requested from |transport_bio_| that was not
1593 // actually available.
1594 size_t requested = BIO_ctrl_get_read_request(transport_bio_);
1595 if (requested == 0) {
1596 // This is not a perfect match of error codes, as no operation is
1597 // actually pending. However, returning 0 would be interpreted as
1598 // a possible sign of EOF, which is also an inappropriate match.
1599 return ERR_IO_PENDING;
1602 // Known Issue: While only reading |requested| data is the more correct
1603 // implementation, it has the downside of resulting in frequent reads:
1604 // One read for the SSL record header (~5 bytes) and one read for the SSL
1605 // record body. Rather than issuing these reads to the underlying socket
1606 // (and constantly allocating new IOBuffers), a single Read() request to
1607 // fill |transport_bio_| is issued. As long as an SSL client socket cannot
1608 // be gracefully shutdown (via SSL close alerts) and re-used for non-SSL
1609 // traffic, this over-subscribed Read()ing will not cause issues.
1611 size_t buffer_write_offset;
1612 uint8_t* write_buf;
1613 size_t max_write;
1614 int status = BIO_zero_copy_get_write_buf(transport_bio_, &write_buf,
1615 &buffer_write_offset, &max_write);
1616 DCHECK_EQ(status, 1); // Should never fail.
1617 if (!max_write)
1618 return ERR_IO_PENDING;
1620 CHECK_EQ(write_buf,
1621 reinterpret_cast<uint8_t*>(recv_buffer_->StartOfBuffer()));
1622 CHECK_LT(buffer_write_offset, static_cast<size_t>(recv_buffer_->capacity()));
1624 recv_buffer_->set_offset(buffer_write_offset);
1625 int rv = transport_->socket()->Read(
1626 recv_buffer_.get(),
1627 max_write,
1628 base::Bind(&SSLClientSocketOpenSSL::BufferRecvComplete,
1629 base::Unretained(this)));
1630 if (rv == ERR_IO_PENDING) {
1631 transport_recv_busy_ = true;
1632 } else {
1633 rv = TransportReadComplete(rv);
1635 return rv;
1638 void SSLClientSocketOpenSSL::BufferSendComplete(int result) {
1639 TransportWriteComplete(result);
1640 OnSendComplete(result);
1643 void SSLClientSocketOpenSSL::BufferRecvComplete(int result) {
1644 result = TransportReadComplete(result);
1645 OnRecvComplete(result);
1648 void SSLClientSocketOpenSSL::TransportWriteComplete(int result) {
1649 DCHECK(ERR_IO_PENDING != result);
1650 int bytes_written = 0;
1651 if (result < 0) {
1652 // Record the error. Save it to be reported in a future read or write on
1653 // transport_bio_'s peer.
1654 transport_write_error_ = result;
1655 } else {
1656 bytes_written = result;
1658 DCHECK_GE(send_buffer_->RemainingCapacity(), bytes_written);
1659 int ret = BIO_zero_copy_get_read_buf_done(transport_bio_, bytes_written);
1660 DCHECK_EQ(1, ret);
1661 transport_send_busy_ = false;
1664 int SSLClientSocketOpenSSL::TransportReadComplete(int result) {
1665 DCHECK(ERR_IO_PENDING != result);
1666 // If an EOF, canonicalize to ERR_CONNECTION_CLOSED here so MapOpenSSLError
1667 // does not report success.
1668 if (result == 0)
1669 result = ERR_CONNECTION_CLOSED;
1670 int bytes_read = 0;
1671 if (result < 0) {
1672 DVLOG(1) << "TransportReadComplete result " << result;
1673 // Received an error. Save it to be reported in a future read on
1674 // transport_bio_'s peer.
1675 transport_read_error_ = result;
1676 } else {
1677 bytes_read = result;
1679 DCHECK_GE(recv_buffer_->RemainingCapacity(), bytes_read);
1680 int ret = BIO_zero_copy_get_write_buf_done(transport_bio_, bytes_read);
1681 DCHECK_EQ(1, ret);
1682 transport_recv_busy_ = false;
1683 return result;
1686 int SSLClientSocketOpenSSL::ClientCertRequestCallback(SSL* ssl) {
1687 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
1688 tracked_objects::ScopedTracker tracking_profile(
1689 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1690 "424386 SSLClientSocketOpenSSL::ClientCertRequestCallback"));
1692 DVLOG(3) << "OpenSSL ClientCertRequestCallback called";
1693 DCHECK(ssl == ssl_);
1695 net_log_.AddEvent(NetLog::TYPE_SSL_CLIENT_CERT_REQUESTED);
1697 // Clear any currently configured certificates.
1698 SSL_certs_clear(ssl_);
1700 #if defined(OS_IOS)
1701 // TODO(droger): Support client auth on iOS. See http://crbug.com/145954).
1702 LOG(WARNING) << "Client auth is not supported";
1703 #else // !defined(OS_IOS)
1704 if (!ssl_config_.send_client_cert) {
1705 // First pass: we know that a client certificate is needed, but we do not
1706 // have one at hand.
1707 client_auth_cert_needed_ = true;
1708 STACK_OF(X509_NAME) *authorities = SSL_get_client_CA_list(ssl);
1709 for (size_t i = 0; i < sk_X509_NAME_num(authorities); i++) {
1710 X509_NAME *ca_name = (X509_NAME *)sk_X509_NAME_value(authorities, i);
1711 unsigned char* str = NULL;
1712 int length = i2d_X509_NAME(ca_name, &str);
1713 cert_authorities_.push_back(std::string(
1714 reinterpret_cast<const char*>(str),
1715 static_cast<size_t>(length)));
1716 OPENSSL_free(str);
1719 const unsigned char* client_cert_types;
1720 size_t num_client_cert_types =
1721 SSL_get0_certificate_types(ssl, &client_cert_types);
1722 for (size_t i = 0; i < num_client_cert_types; i++) {
1723 cert_key_types_.push_back(
1724 static_cast<SSLClientCertType>(client_cert_types[i]));
1727 return -1; // Suspends handshake.
1730 // Second pass: a client certificate should have been selected.
1731 if (ssl_config_.client_cert.get()) {
1732 ScopedX509 leaf_x509 =
1733 OSCertHandleToOpenSSL(ssl_config_.client_cert->os_cert_handle());
1734 if (!leaf_x509) {
1735 LOG(WARNING) << "Failed to import certificate";
1736 OpenSSLPutNetError(FROM_HERE, ERR_SSL_CLIENT_AUTH_CERT_BAD_FORMAT);
1737 return -1;
1740 ScopedX509Stack chain = OSCertHandlesToOpenSSL(
1741 ssl_config_.client_cert->GetIntermediateCertificates());
1742 if (!chain) {
1743 LOG(WARNING) << "Failed to import intermediate certificates";
1744 OpenSSLPutNetError(FROM_HERE, ERR_SSL_CLIENT_AUTH_CERT_BAD_FORMAT);
1745 return -1;
1748 // TODO(davidben): With Linux client auth support, this should be
1749 // conditioned on OS_ANDROID and then, with https://crbug.com/394131,
1750 // removed altogether. OpenSSLClientKeyStore is mostly an artifact of the
1751 // net/ client auth API lacking a private key handle.
1752 #if defined(USE_OPENSSL_CERTS)
1753 crypto::ScopedEVP_PKEY privkey =
1754 OpenSSLClientKeyStore::GetInstance()->FetchClientCertPrivateKey(
1755 ssl_config_.client_cert.get());
1756 #else // !defined(USE_OPENSSL_CERTS)
1757 crypto::ScopedEVP_PKEY privkey =
1758 FetchClientCertPrivateKey(ssl_config_.client_cert.get());
1759 #endif // defined(USE_OPENSSL_CERTS)
1760 if (!privkey) {
1761 // Could not find the private key. Fail the handshake and surface an
1762 // appropriate error to the caller.
1763 LOG(WARNING) << "Client cert found without private key";
1764 OpenSSLPutNetError(FROM_HERE, ERR_SSL_CLIENT_AUTH_CERT_NO_PRIVATE_KEY);
1765 return -1;
1768 if (!SSL_use_certificate(ssl_, leaf_x509.get()) ||
1769 !SSL_use_PrivateKey(ssl_, privkey.get()) ||
1770 !SSL_set1_chain(ssl_, chain.get())) {
1771 LOG(WARNING) << "Failed to set client certificate";
1772 return -1;
1775 int cert_count = 1 + sk_X509_num(chain.get());
1776 net_log_.AddEvent(NetLog::TYPE_SSL_CLIENT_CERT_PROVIDED,
1777 NetLog::IntegerCallback("cert_count", cert_count));
1778 return 1;
1780 #endif // defined(OS_IOS)
1782 // Send no client certificate.
1783 net_log_.AddEvent(NetLog::TYPE_SSL_CLIENT_CERT_PROVIDED,
1784 NetLog::IntegerCallback("cert_count", 0));
1785 return 1;
1788 int SSLClientSocketOpenSSL::CertVerifyCallback(X509_STORE_CTX* store_ctx) {
1789 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
1790 tracked_objects::ScopedTracker tracking_profile(
1791 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1792 "424386 SSLClientSocketOpenSSL::CertVerifyCallback"));
1794 if (!completed_connect_) {
1795 // If the first handshake hasn't completed then we accept any certificates
1796 // because we verify after the handshake.
1797 return 1;
1800 // Disallow the server certificate to change in a renegotiation.
1801 if (server_cert_chain_->empty()) {
1802 LOG(ERROR) << "Received invalid certificate chain between handshakes";
1803 return 0;
1805 base::StringPiece old_der, new_der;
1806 if (store_ctx->cert == NULL ||
1807 !x509_util::GetDER(server_cert_chain_->Get(0), &old_der) ||
1808 !x509_util::GetDER(store_ctx->cert, &new_der)) {
1809 LOG(ERROR) << "Failed to encode certificates";
1810 return 0;
1812 if (old_der != new_der) {
1813 LOG(ERROR) << "Server certificate changed between handshakes";
1814 return 0;
1817 return 1;
1820 // SelectNextProtoCallback is called by OpenSSL during the handshake. If the
1821 // server supports NPN, selects a protocol from the list that the server
1822 // provides. According to third_party/openssl/openssl/ssl/ssl_lib.c, the
1823 // callback can assume that |in| is syntactically valid.
1824 int SSLClientSocketOpenSSL::SelectNextProtoCallback(unsigned char** out,
1825 unsigned char* outlen,
1826 const unsigned char* in,
1827 unsigned int inlen) {
1828 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
1829 tracked_objects::ScopedTracker tracking_profile(
1830 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1831 "424386 SSLClientSocketOpenSSL::SelectNextProtoCallback"));
1833 if (ssl_config_.next_protos.empty()) {
1834 *out = reinterpret_cast<uint8*>(
1835 const_cast<char*>(kDefaultSupportedNPNProtocol));
1836 *outlen = arraysize(kDefaultSupportedNPNProtocol) - 1;
1837 npn_status_ = kNextProtoUnsupported;
1838 return SSL_TLSEXT_ERR_OK;
1841 // Assume there's no overlap between our protocols and the server's list.
1842 npn_status_ = kNextProtoNoOverlap;
1844 // For each protocol in server preference order, see if we support it.
1845 for (unsigned int i = 0; i < inlen; i += in[i] + 1) {
1846 for (NextProto next_proto : ssl_config_.next_protos) {
1847 const std::string proto = NextProtoToString(next_proto);
1848 if (in[i] == proto.size() &&
1849 memcmp(&in[i + 1], proto.data(), in[i]) == 0) {
1850 // We found a match.
1851 *out = const_cast<unsigned char*>(in) + i + 1;
1852 *outlen = in[i];
1853 npn_status_ = kNextProtoNegotiated;
1854 break;
1857 if (npn_status_ == kNextProtoNegotiated)
1858 break;
1861 // If we didn't find a protocol, we select the first one from our list.
1862 if (npn_status_ == kNextProtoNoOverlap) {
1863 // NextProtoToString returns a pointer to a static string.
1864 const char* proto = NextProtoToString(ssl_config_.next_protos[0]);
1865 *out = reinterpret_cast<unsigned char*>(const_cast<char*>(proto));
1866 *outlen = strlen(proto);
1869 npn_proto_.assign(reinterpret_cast<const char*>(*out), *outlen);
1870 DVLOG(2) << "next protocol: '" << npn_proto_ << "' status: " << npn_status_;
1871 set_negotiation_extension(kExtensionNPN);
1872 return SSL_TLSEXT_ERR_OK;
1875 long SSLClientSocketOpenSSL::MaybeReplayTransportError(
1876 BIO *bio,
1877 int cmd,
1878 const char *argp, int argi, long argl,
1879 long retvalue) {
1880 if (cmd == (BIO_CB_READ|BIO_CB_RETURN) && retvalue <= 0) {
1881 // If there is no more data in the buffer, report any pending errors that
1882 // were observed. Note that both the readbuf and the writebuf are checked
1883 // for errors, since the application may have encountered a socket error
1884 // while writing that would otherwise not be reported until the application
1885 // attempted to write again - which it may never do. See
1886 // https://crbug.com/249848.
1887 if (transport_read_error_ != OK) {
1888 OpenSSLPutNetError(FROM_HERE, transport_read_error_);
1889 return -1;
1891 if (transport_write_error_ != OK) {
1892 OpenSSLPutNetError(FROM_HERE, transport_write_error_);
1893 return -1;
1895 } else if (cmd == BIO_CB_WRITE) {
1896 // Because of the write buffer, this reports a failure from the previous
1897 // write payload. If the current payload fails to write, the error will be
1898 // reported in a future write or read to |bio|.
1899 if (transport_write_error_ != OK) {
1900 OpenSSLPutNetError(FROM_HERE, transport_write_error_);
1901 return -1;
1904 return retvalue;
1907 // static
1908 long SSLClientSocketOpenSSL::BIOCallback(
1909 BIO *bio,
1910 int cmd,
1911 const char *argp, int argi, long argl,
1912 long retvalue) {
1913 // TODO(vadimt): Remove ScopedTracker below once crbug.com/424386 is fixed.
1914 tracked_objects::ScopedTracker tracking_profile(
1915 FROM_HERE_WITH_EXPLICIT_FUNCTION(
1916 "424386 SSLClientSocketOpenSSL::BIOCallback"));
1918 SSLClientSocketOpenSSL* socket = reinterpret_cast<SSLClientSocketOpenSSL*>(
1919 BIO_get_callback_arg(bio));
1920 CHECK(socket);
1921 return socket->MaybeReplayTransportError(
1922 bio, cmd, argp, argi, argl, retvalue);
1925 void SSLClientSocketOpenSSL::AddSCTInfoToSSLInfo(SSLInfo* ssl_info) const {
1926 for (ct::SCTList::const_iterator iter =
1927 ct_verify_result_.verified_scts.begin();
1928 iter != ct_verify_result_.verified_scts.end(); ++iter) {
1929 ssl_info->signed_certificate_timestamps.push_back(
1930 SignedCertificateTimestampAndStatus(*iter, ct::SCT_STATUS_OK));
1932 for (ct::SCTList::const_iterator iter =
1933 ct_verify_result_.invalid_scts.begin();
1934 iter != ct_verify_result_.invalid_scts.end(); ++iter) {
1935 ssl_info->signed_certificate_timestamps.push_back(
1936 SignedCertificateTimestampAndStatus(*iter, ct::SCT_STATUS_INVALID));
1938 for (ct::SCTList::const_iterator iter =
1939 ct_verify_result_.unknown_logs_scts.begin();
1940 iter != ct_verify_result_.unknown_logs_scts.end(); ++iter) {
1941 ssl_info->signed_certificate_timestamps.push_back(
1942 SignedCertificateTimestampAndStatus(*iter,
1943 ct::SCT_STATUS_LOG_UNKNOWN));
1947 std::string SSLClientSocketOpenSSL::GetSessionCacheKey() const {
1948 std::string result = host_and_port_.ToString();
1949 result.append("/");
1950 result.append(ssl_session_cache_shard_);
1952 // Shard the session cache based on maximum protocol version. This causes
1953 // fallback connections to use a separate session cache.
1954 result.append("/");
1955 switch (ssl_config_.version_max) {
1956 case SSL_PROTOCOL_VERSION_SSL3:
1957 result.append("ssl3");
1958 break;
1959 case SSL_PROTOCOL_VERSION_TLS1:
1960 result.append("tls1");
1961 break;
1962 case SSL_PROTOCOL_VERSION_TLS1_1:
1963 result.append("tls1.1");
1964 break;
1965 case SSL_PROTOCOL_VERSION_TLS1_2:
1966 result.append("tls1.2");
1967 break;
1968 default:
1969 NOTREACHED();
1972 return result;
1975 scoped_refptr<X509Certificate>
1976 SSLClientSocketOpenSSL::GetUnverifiedServerCertificateChain() const {
1977 return server_cert_;
1980 } // namespace net