1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/socket/ssl_server_socket_impl.h"
#include <memory>
#include <optional>
#include <string_view>
#include <utility>
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/notimplemented.h"
#include "base/strings/string_util.h"
#include "crypto/openssl_util.h"
#include "crypto/rsa_private_key.h"
#include "net/base/completion_once_callback.h"
#include "net/base/net_errors.h"
#include "net/cert/cert_verify_result.h"
#include "net/cert/client_cert_verifier.h"
#include "net/cert/x509_util.h"
#include "net/log/net_log_event_type.h"
#include "net/log/net_log_with_source.h"
#include "net/socket/socket_bio_adapter.h"
#include "net/ssl/openssl_ssl_util.h"
#include "net/ssl/ssl_connection_status_flags.h"
#include "net/ssl/ssl_info.h"
#include "net/ssl/ssl_private_key.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "third_party/boringssl/src/include/openssl/bytestring.h"
#include "third_party/boringssl/src/include/openssl/err.h"
#include "third_party/boringssl/src/include/openssl/pool.h"
#include "third_party/boringssl/src/include/openssl/ssl.h"
#define GotoState(s) next_handshake_state_ = s
namespace net {
namespace {
// This constant can be any non-negative/non-zero value (eg: it does not
// overlap with any value of the net::Error range, including net::OK).
const int kSSLServerSocketNoPendingResult = 1;
std::vector<bssl::UniquePtr<CRYPTO_BUFFER>> ChainFromX509Certificate(
X509Certificate* cert) {
std::vector<bssl::UniquePtr<CRYPTO_BUFFER>> cert_chain;
cert_chain.reserve(1 + cert->intermediate_buffers().size());
cert_chain.push_back(bssl::UpRef(cert->cert_buffer()));
for (const auto& handle : cert->intermediate_buffers()) {
cert_chain.push_back(bssl::UpRef(handle.get()));
}
return cert_chain;
}
} // namespace
class SSLServerContextImpl::SocketImpl : public SSLServerSocket,
public SocketBIOAdapter::Delegate {
public:
SocketImpl(SSLServerContextImpl* context,
std::unique_ptr<StreamSocket> socket);
SocketImpl(const SocketImpl&) = delete;
SocketImpl& operator=(const SocketImpl&) = delete;
~SocketImpl() override;
// SSLServerSocket interface.
int Handshake(CompletionOnceCallback callback) override;
// SSLSocket interface.
int ExportKeyingMaterial(std::string_view label,
std::optional<base::span<const uint8_t>> context,
base::span<uint8_t> out) override;
// Socket interface (via StreamSocket).
int Read(IOBuffer* buf,
int buf_len,
CompletionOnceCallback callback) override;
int ReadIfReady(IOBuffer* buf,
int buf_len,
CompletionOnceCallback callback) override;
int CancelReadIfReady() override;
int Write(IOBuffer* buf,
int buf_len,
CompletionOnceCallback callback,
const NetworkTrafficAnnotationTag& traffic_annotation) override;
int SetReceiveBufferSize(int32_t size) override;
int SetSendBufferSize(int32_t size) override;
// StreamSocket implementation.
int Connect(CompletionOnceCallback callback) override;
void Disconnect() override;
bool IsConnected() const override;
bool IsConnectedAndIdle() const override;
int GetPeerAddress(IPEndPoint* address) const override;
int GetLocalAddress(IPEndPoint* address) const override;
const NetLogWithSource& NetLog() const override;
bool WasEverUsed() const override;
NextProto GetNegotiatedProtocol() const override;
std::optional<std::string_view> GetPeerApplicationSettings() const override;
bool GetSSLInfo(SSLInfo* ssl_info) override;
int64_t GetTotalReceivedBytes() const override;
void ApplySocketTag(const SocketTag& tag) override;
static SocketImpl* FromSSL(SSL* ssl);
static ssl_verify_result_t CertVerifyCallback(SSL* ssl, uint8_t* out_alert);
ssl_verify_result_t CertVerifyCallbackImpl(uint8_t* out_alert);
static const SSL_PRIVATE_KEY_METHOD kPrivateKeyMethod;
static ssl_private_key_result_t PrivateKeySignCallback(SSL* ssl,
uint8_t* out,
size_t* out_len,
size_t max_out,
uint16_t algorithm,
const uint8_t* in,
size_t in_len);
static ssl_private_key_result_t PrivateKeyDecryptCallback(SSL* ssl,
uint8_t* out,
size_t* out_len,
size_t max_out,
const uint8_t* in,
size_t in_len);
static ssl_private_key_result_t PrivateKeyCompleteCallback(SSL* ssl,
uint8_t* out,
size_t* out_len,
size_t max_out);
ssl_private_key_result_t PrivateKeySignCallback(
uint16_t algorithm,
base::span<const uint8_t> input);
ssl_private_key_result_t PrivateKeyCompleteCallback(base::span<uint8_t> buf,
size_t* out_len);
void OnPrivateKeyComplete(Error error, const std::vector<uint8_t>& signature);
static int ALPNSelectCallback(SSL* ssl,
const uint8_t** out,
uint8_t* out_len,
const uint8_t* in,
unsigned in_len,
void* arg);
static ssl_select_cert_result_t SelectCertificateCallback(
const SSL_CLIENT_HELLO* client_hello);
// SocketBIOAdapter::Delegate implementation.
void OnReadReady() override;
void OnWriteReady() override;
private:
enum State {
STATE_NONE,
STATE_HANDSHAKE,
};
void OnHandshakeIOComplete(int result);
[[nodiscard]] int DoPayloadRead(IOBuffer* buf, int buf_len);
[[nodiscard]] int DoPayloadWrite();
[[nodiscard]] int DoHandshakeLoop(int last_io_result);
[[nodiscard]] int DoHandshake();
void DoHandshakeCallback(int result);
void DoReadCallback(int result);
void DoWriteCallback(int result);
[[nodiscard]] int Init();
void ExtractClientCert();
raw_ptr<SSLServerContextImpl> context_;
NetLogWithSource net_log_;
CompletionOnceCallback user_handshake_callback_;
CompletionOnceCallback user_read_callback_;
CompletionOnceCallback user_write_callback_;
// SSLPrivateKey signature.
int signature_result_;
std::vector<uint8_t> signature_;
// Used by Read function.
scoped_refptr<IOBuffer> user_read_buf_;
int user_read_buf_len_ = 0;
// Used by Write function.
scoped_refptr<IOBuffer> user_write_buf_;
int user_write_buf_len_ = 0;
// OpenSSL stuff
bssl::UniquePtr<SSL> ssl_;
// Whether we received any data in early data.
bool early_data_received_ = false;
// StreamSocket for sending and receiving data.
std::unique_ptr<StreamSocket> transport_socket_;
std::unique_ptr<SocketBIOAdapter> transport_adapter_;
// Certificate for the client.
scoped_refptr<X509Certificate> client_cert_;
State next_handshake_state_ = STATE_NONE;
bool completed_handshake_ = false;
NextProto negotiated_protocol_ = NextProto::kProtoUnknown;
base::WeakPtrFactory<SocketImpl> weak_factory_{this};
};
SSLServerContextImpl::SocketImpl::SocketImpl(
SSLServerContextImpl* context,
std::unique_ptr<StreamSocket> transport_socket)
: context_(context),
signature_result_(kSSLServerSocketNoPendingResult),
transport_socket_(std::move(transport_socket)) {}
SSLServerContextImpl::SocketImpl::~SocketImpl() {
if (ssl_) {
// Calling SSL_shutdown prevents the session from being marked as
// unresumable.
SSL_shutdown(ssl_.get());
ssl_.reset();
}
}
// static
const SSL_PRIVATE_KEY_METHOD
SSLServerContextImpl::SocketImpl::kPrivateKeyMethod = {
&SSLServerContextImpl::SocketImpl::PrivateKeySignCallback,
&SSLServerContextImpl::SocketImpl::PrivateKeyDecryptCallback,
&SSLServerContextImpl::SocketImpl::PrivateKeyCompleteCallback,
};
// static
ssl_private_key_result_t
SSLServerContextImpl::SocketImpl::PrivateKeySignCallback(SSL* ssl,
uint8_t* out,
size_t* out_len,
size_t max_out,
uint16_t algorithm,
const uint8_t* in,
size_t in_len) {
return FromSSL(ssl)->PrivateKeySignCallback(
algorithm,
// SAFETY:
// https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#ssl_private_key_method_st
// `ssl_private_key_method_st::sign` implies that the value of `in_len`
// is equal to the actual size of `in`.
UNSAFE_BUFFERS(base::span(in, in_len)));
}
// static
ssl_private_key_result_t
SSLServerContextImpl::SocketImpl::PrivateKeyDecryptCallback(SSL* ssl,
uint8_t* out,
size_t* out_len,
size_t max_out,
const uint8_t* in,
size_t in_len) {
// Decrypt is not supported.
return ssl_private_key_failure;
}
// static
ssl_private_key_result_t
SSLServerContextImpl::SocketImpl::PrivateKeyCompleteCallback(SSL* ssl,
uint8_t* out,
size_t* out_len,
size_t max_out) {
return FromSSL(ssl)->PrivateKeyCompleteCallback(
// SAFETY:
// https://commondatastorage.googleapis.com/chromium-boringssl-docs/ssl.h.html#ssl_private_key_method_st
// The comment of `ssl_private_key_method_st::complete` indicates that
// `max_out` is the actual size of the buffer.
UNSAFE_BUFFERS(base::span(out, max_out)), out_len);
}
ssl_private_key_result_t
SSLServerContextImpl::SocketImpl::PrivateKeySignCallback(
uint16_t algorithm,
base::span<const uint8_t> input) {
DCHECK(context_);
DCHECK(context_->private_key_);
signature_result_ = ERR_IO_PENDING;
context_->private_key_->Sign(
algorithm, input,
base::BindOnce(&SSLServerContextImpl::SocketImpl::OnPrivateKeyComplete,
weak_factory_.GetWeakPtr()));
return ssl_private_key_retry;
}
ssl_private_key_result_t
SSLServerContextImpl::SocketImpl::PrivateKeyCompleteCallback(
base::span<uint8_t> buf,
size_t* out_len) {
if (signature_result_ == ERR_IO_PENDING)
return ssl_private_key_retry;
if (signature_result_ != OK) {
OpenSSLPutNetError(FROM_HERE, signature_result_);
return ssl_private_key_failure;
}
if (signature_.size() > buf.size()) {
OpenSSLPutNetError(FROM_HERE, ERR_SSL_CLIENT_AUTH_SIGNATURE_FAILED);
return ssl_private_key_failure;
}
buf.copy_prefix_from(signature_);
*out_len = signature_.size();
signature_.clear();
return ssl_private_key_success;
}
void SSLServerContextImpl::SocketImpl::OnPrivateKeyComplete(
Error error,
const std::vector<uint8_t>& signature) {
DCHECK_EQ(ERR_IO_PENDING, signature_result_);
DCHECK(signature_.empty());
signature_result_ = error;
if (signature_result_ == OK)
signature_ = signature;
OnHandshakeIOComplete(ERR_IO_PENDING);
}
// static
int SSLServerContextImpl::SocketImpl::ALPNSelectCallback(SSL* ssl,
const uint8_t** out,
uint8_t* out_len,
const uint8_t* in,
unsigned in_len,
void* arg) {
SSLServerContextImpl::SocketImpl* socket = FromSSL(ssl);
// Iterate over the server protocols in preference order.
for (NextProto server_proto :
socket->context_->ssl_server_config_.alpn_protos) {
const char* server_proto_str = NextProtoToString(server_proto);
// See if the client advertised the corresponding protocol.
CBS cbs;
CBS_init(&cbs, in, in_len);
while (CBS_len(&cbs) != 0) {
CBS client_proto;
if (!CBS_get_u8_length_prefixed(&cbs, &client_proto)) {
return SSL_TLSEXT_ERR_NOACK;
}
if (std::string_view(
reinterpret_cast<const char*>(CBS_data(&client_proto)),
CBS_len(&client_proto)) == server_proto_str) {
*out = CBS_data(&client_proto);
*out_len = CBS_len(&client_proto);
const auto& application_settings =
socket->context_->ssl_server_config_.application_settings;
auto it = application_settings.find(server_proto);
if (it != application_settings.end()) {
const std::vector<uint8_t>& data = it->second;
SSL_add_application_settings(ssl, CBS_data(&client_proto),
CBS_len(&client_proto), data.data(),
data.size());
}
return SSL_TLSEXT_ERR_OK;
}
}
}
return SSL_TLSEXT_ERR_NOACK;
}
ssl_select_cert_result_t
SSLServerContextImpl::SocketImpl::SelectCertificateCallback(
const SSL_CLIENT_HELLO* client_hello) {
SSLServerContextImpl::SocketImpl* socket = FromSSL(client_hello->ssl);
const SSLServerConfig& config = socket->context_->ssl_server_config_;
if (!config.client_hello_callback_for_testing.is_null() &&
!config.client_hello_callback_for_testing.Run(client_hello)) {
return ssl_select_cert_error;
}
return ssl_select_cert_success;
}
int SSLServerContextImpl::SocketImpl::Handshake(
CompletionOnceCallback callback) {
net_log_.BeginEvent(NetLogEventType::SSL_SERVER_HANDSHAKE);
// Set up new ssl object.
int rv = Init();
if (rv != OK) {
LOG(ERROR) << "Failed to initialize OpenSSL: rv=" << rv;
net_log_.EndEventWithNetErrorCode(NetLogEventType::SSL_SERVER_HANDSHAKE,
rv);
return rv;
}
// Set SSL to server mode. Handshake happens in the loop below.
SSL_set_accept_state(ssl_.get());
GotoState(STATE_HANDSHAKE);
rv = DoHandshakeLoop(OK);
if (rv == ERR_IO_PENDING) {
user_handshake_callback_ = std::move(callback);
} else {
net_log_.EndEventWithNetErrorCode(NetLogEventType::SSL_SERVER_HANDSHAKE,
rv);
}
return rv > OK ? OK : rv;
}
int SSLServerContextImpl::SocketImpl::ExportKeyingMaterial(
std::string_view label,
std::optional<base::span<const uint8_t>> context,
base::span<uint8_t> out) {
DCHECK(base::IsStringASCII(label));
if (!IsConnected())
return ERR_SOCKET_NOT_CONNECTED;
crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
int rv = SSL_export_keying_material(
ssl_.get(), out.data(), out.size(), label.data(), label.size(),
context.has_value() ? context->data() : nullptr,
context.has_value() ? context->size() : 0, context.has_value());
if (rv != 1) {
int ssl_error = SSL_get_error(ssl_.get(), rv);
LOG(ERROR) << "Failed to export keying material;"
<< " returned " << rv << ", SSL error code " << ssl_error;
return MapOpenSSLError(ssl_error, err_tracer);
}
return OK;
}
int SSLServerContextImpl::SocketImpl::Read(IOBuffer* buf,
int buf_len,
CompletionOnceCallback callback) {
int rv = ReadIfReady(buf, buf_len, std::move(callback));
if (rv == ERR_IO_PENDING) {
user_read_buf_ = buf;
user_read_buf_len_ = buf_len;
}
return rv;
}
int SSLServerContextImpl::SocketImpl::ReadIfReady(
IOBuffer* buf,
int buf_len,
CompletionOnceCallback callback) {
DCHECK(user_read_callback_.is_null());
DCHECK(user_handshake_callback_.is_null());
DCHECK(!user_read_buf_);
DCHECK(!callback.is_null());
DCHECK(completed_handshake_);
int rv = DoPayloadRead(buf, buf_len);
if (rv == ERR_IO_PENDING) {
user_read_callback_ = std::move(callback);
}
return rv;
}
int SSLServerContextImpl::SocketImpl::CancelReadIfReady() {
DCHECK(user_read_callback_);
DCHECK(!user_read_buf_);
// Cancel |user_read_callback_|, because caller does not expect the callback
// to be invoked after they have canceled the ReadIfReady.
//
// We do not pass the signal on to |stream_socket_| or |transport_adapter_|.
// When it completes, it will signal OnReadReady(), which will notice there is
// no read operation to progress and skip it. Unlike with SSLClientSocket,
// SSL and transport reads are more aligned, but this avoids making
// assumptions or breaking the SocketBIOAdapter's state.
user_read_callback_.Reset();
return OK;
}
int SSLServerContextImpl::SocketImpl::Write(
IOBuffer* buf,
int buf_len,
CompletionOnceCallback callback,
const NetworkTrafficAnnotationTag& traffic_annotation) {
DCHECK(user_write_callback_.is_null());
DCHECK(!user_write_buf_);
DCHECK(!callback.is_null());
user_write_buf_ = buf;
user_write_buf_len_ = buf_len;
int rv = DoPayloadWrite();
if (rv == ERR_IO_PENDING) {
user_write_callback_ = std::move(callback);
} else {
user_write_buf_ = nullptr;
user_write_buf_len_ = 0;
}
return rv;
}
int SSLServerContextImpl::SocketImpl::SetReceiveBufferSize(int32_t size) {
return transport_socket_->SetReceiveBufferSize(size);
}
int SSLServerContextImpl::SocketImpl::SetSendBufferSize(int32_t size) {
return transport_socket_->SetSendBufferSize(size);
}
int SSLServerContextImpl::SocketImpl::Connect(CompletionOnceCallback callback) {
NOTIMPLEMENTED();
return ERR_NOT_IMPLEMENTED;
}
void SSLServerContextImpl::SocketImpl::Disconnect() {
transport_socket_->Disconnect();
}
bool SSLServerContextImpl::SocketImpl::IsConnected() const {
// TODO(wtc): Find out if we should check transport_socket_->IsConnected()
// as well.
return completed_handshake_;
}
bool SSLServerContextImpl::SocketImpl::IsConnectedAndIdle() const {
return completed_handshake_ && transport_socket_->IsConnectedAndIdle();
}
int SSLServerContextImpl::SocketImpl::GetPeerAddress(
IPEndPoint* address) const {
if (!IsConnected())
return ERR_SOCKET_NOT_CONNECTED;
return transport_socket_->GetPeerAddress(address);
}
int SSLServerContextImpl::SocketImpl::GetLocalAddress(
IPEndPoint* address) const {
if (!IsConnected())
return ERR_SOCKET_NOT_CONNECTED;
return transport_socket_->GetLocalAddress(address);
}
const NetLogWithSource& SSLServerContextImpl::SocketImpl::NetLog() const {
return net_log_;
}
bool SSLServerContextImpl::SocketImpl::WasEverUsed() const {
return transport_socket_->WasEverUsed();
}
NextProto SSLServerContextImpl::SocketImpl::GetNegotiatedProtocol() const {
return negotiated_protocol_;
}
std::optional<std::string_view>
SSLServerContextImpl::SocketImpl::GetPeerApplicationSettings() const {
if (!SSL_has_application_settings(ssl_.get())) {
return std::nullopt;
}
const uint8_t* out_data;
size_t out_len;
SSL_get0_peer_application_settings(ssl_.get(), &out_data, &out_len);
return std::string_view{reinterpret_cast<const char*>(out_data), out_len};
}
bool SSLServerContextImpl::SocketImpl::GetSSLInfo(SSLInfo* ssl_info) {
*ssl_info = SSLInfo();
if (!completed_handshake_)
return false;
ssl_info->cert = client_cert_;
const SSL_CIPHER* cipher = SSL_get_current_cipher(ssl_.get());
CHECK(cipher);
SSLConnectionStatusSetCipherSuite(SSL_CIPHER_get_protocol_id(cipher),
&ssl_info->connection_status);
SSLConnectionStatusSetVersion(GetNetSSLVersion(ssl_.get()),
&ssl_info->connection_status);
ssl_info->early_data_received = early_data_received_;
ssl_info->early_data_accepted = SSL_early_data_accepted(ssl_.get());
ssl_info->encrypted_client_hello = SSL_ech_accepted(ssl_.get());
ssl_info->handshake_type = SSL_session_reused(ssl_.get())
? SSLInfo::HANDSHAKE_RESUME
: SSLInfo::HANDSHAKE_FULL;
ssl_info->peer_signature_algorithm =
SSL_get_peer_signature_algorithm(ssl_.get());
return true;
}
int64_t SSLServerContextImpl::SocketImpl::GetTotalReceivedBytes() const {
return transport_socket_->GetTotalReceivedBytes();
}
void SSLServerContextImpl::SocketImpl::ApplySocketTag(const SocketTag& tag) {
NOTIMPLEMENTED();
}
void SSLServerContextImpl::SocketImpl::OnReadReady() {
if (next_handshake_state_ == STATE_HANDSHAKE) {
// In handshake phase. The parameter to OnHandshakeIOComplete is unused.
OnHandshakeIOComplete(OK);
return;
}
// BoringSSL does not support renegotiation as a server, so the only other
// operation blocked on Read is DoPayloadRead.
if (!user_read_buf_) {
if (!user_read_callback_.is_null()) {
DoReadCallback(OK);
}
return;
}
int rv = DoPayloadRead(user_read_buf_.get(), user_read_buf_len_);
if (rv != ERR_IO_PENDING)
DoReadCallback(rv);
}
void SSLServerContextImpl::SocketImpl::OnWriteReady() {
if (next_handshake_state_ == STATE_HANDSHAKE) {
// In handshake phase. The parameter to OnHandshakeIOComplete is unused.
OnHandshakeIOComplete(OK);
return;
}
// BoringSSL does not support renegotiation as a server, so the only other
// operation blocked on Read is DoPayloadWrite.
if (!user_write_buf_)
return;
int rv = DoPayloadWrite();
if (rv != ERR_IO_PENDING)
DoWriteCallback(rv);
}
void SSLServerContextImpl::SocketImpl::OnHandshakeIOComplete(int result) {
int rv = DoHandshakeLoop(result);
if (rv == ERR_IO_PENDING)
return;
net_log_.EndEventWithNetErrorCode(NetLogEventType::SSL_SERVER_HANDSHAKE, rv);
if (!user_handshake_callback_.is_null())
DoHandshakeCallback(rv);
}
int SSLServerContextImpl::SocketImpl::DoPayloadRead(IOBuffer* buf,
int buf_len) {
DCHECK(completed_handshake_);
DCHECK_EQ(STATE_NONE, next_handshake_state_);
DCHECK(buf);
DCHECK_GT(buf_len, 0);
crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
int rv = SSL_read(ssl_.get(), buf->data(), buf_len);
if (rv >= 0) {
if (SSL_in_early_data(ssl_.get()))
early_data_received_ = true;
return rv;
}
int ssl_error = SSL_get_error(ssl_.get(), rv);
OpenSSLErrorInfo error_info;
int net_error =
MapOpenSSLErrorWithDetails(ssl_error, err_tracer, &error_info);
if (net_error != ERR_IO_PENDING) {
NetLogOpenSSLError(net_log_, NetLogEventType::SSL_READ_ERROR, net_error,
ssl_error, error_info);
}
return net_error;
}
int SSLServerContextImpl::SocketImpl::DoPayloadWrite() {
DCHECK(completed_handshake_);
DCHECK_EQ(STATE_NONE, next_handshake_state_);
DCHECK(user_write_buf_);
crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
int rv = SSL_write(ssl_.get(), user_write_buf_->data(), user_write_buf_len_);
if (rv >= 0)
return rv;
int ssl_error = SSL_get_error(ssl_.get(), rv);
OpenSSLErrorInfo error_info;
int net_error =
MapOpenSSLErrorWithDetails(ssl_error, err_tracer, &error_info);
if (net_error != ERR_IO_PENDING) {
NetLogOpenSSLError(net_log_, NetLogEventType::SSL_WRITE_ERROR, net_error,
ssl_error, error_info);
}
return net_error;
}
int SSLServerContextImpl::SocketImpl::DoHandshakeLoop(int last_io_result) {
int rv = last_io_result;
do {
// Default to STATE_NONE for next state.
// (This is a quirk carried over from the windows
// implementation. It makes reading the logs a bit harder.)
// State handlers can and often do call GotoState just
// to stay in the current state.
State state = next_handshake_state_;
GotoState(STATE_NONE);
switch (state) {
case STATE_HANDSHAKE:
rv = DoHandshake();
break;
case STATE_NONE:
default:
rv = ERR_UNEXPECTED;
LOG(DFATAL) << "unexpected state " << state;
break;
}
} while (rv != ERR_IO_PENDING && next_handshake_state_ != STATE_NONE);
return rv;
}
int SSLServerContextImpl::SocketImpl::DoHandshake() {
crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
int net_error = OK;
int rv = SSL_do_handshake(ssl_.get());
if (rv == 1) {
const STACK_OF(CRYPTO_BUFFER)* certs =
SSL_get0_peer_certificates(ssl_.get());
if (certs) {
client_cert_ = x509_util::CreateX509CertificateFromBuffers(certs);
if (!client_cert_)
return ERR_SSL_CLIENT_AUTH_CERT_BAD_FORMAT;
}
const uint8_t* alpn_proto = nullptr;
unsigned alpn_len = 0;
SSL_get0_alpn_selected(ssl_.get(), &alpn_proto, &alpn_len);
if (alpn_len > 0) {
std::string_view proto(reinterpret_cast<const char*>(alpn_proto),
alpn_len);
negotiated_protocol_ = NextProtoFromString(proto);
}
if (context_->ssl_server_config_.alert_after_handshake_for_testing) {
SSL_send_fatal_alert(ssl_.get(),
context_->ssl_server_config_
.alert_after_handshake_for_testing.value());
return ERR_FAILED;
}
completed_handshake_ = true;
} else {
int ssl_error = SSL_get_error(ssl_.get(), rv);
if (ssl_error == SSL_ERROR_WANT_PRIVATE_KEY_OPERATION) {
DCHECK(context_->private_key_);
GotoState(STATE_HANDSHAKE);
return ERR_IO_PENDING;
}
OpenSSLErrorInfo error_info;
net_error = MapOpenSSLErrorWithDetails(ssl_error, err_tracer, &error_info);
// SSL_R_CERTIFICATE_VERIFY_FAILED's mapping is different between client and
// server.
if (ERR_GET_LIB(error_info.error_code) == ERR_LIB_SSL &&
ERR_GET_REASON(error_info.error_code) ==
SSL_R_CERTIFICATE_VERIFY_FAILED) {
net_error = ERR_BAD_SSL_CLIENT_AUTH_CERT;
}
// If not done, stay in this state
if (net_error == ERR_IO_PENDING) {
GotoState(STATE_HANDSHAKE);
} else {
LOG(ERROR) << "handshake failed; returned " << rv << ", SSL error code "
<< ssl_error << ", net_error " << net_error;
NetLogOpenSSLError(net_log_, NetLogEventType::SSL_HANDSHAKE_ERROR,
net_error, ssl_error, error_info);
}
}
return net_error;
}
void SSLServerContextImpl::SocketImpl::DoHandshakeCallback(int rv) {
DCHECK_NE(rv, ERR_IO_PENDING);
std::move(user_handshake_callback_).Run(rv > OK ? OK : rv);
}
void SSLServerContextImpl::SocketImpl::DoReadCallback(int rv) {
DCHECK(rv != ERR_IO_PENDING);
DCHECK(!user_read_callback_.is_null());
user_read_buf_ = nullptr;
user_read_buf_len_ = 0;
std::move(user_read_callback_).Run(rv);
}
void SSLServerContextImpl::SocketImpl::DoWriteCallback(int rv) {
DCHECK(rv != ERR_IO_PENDING);
DCHECK(!user_write_callback_.is_null());
user_write_buf_ = nullptr;
user_write_buf_len_ = 0;
std::move(user_write_callback_).Run(rv);
}
int SSLServerContextImpl::SocketImpl::Init() {
static const int kBufferSize = 17 * 1024;
crypto::OpenSSLErrStackTracer err_tracer(FROM_HERE);
ssl_.reset(SSL_new(context_->ssl_ctx_.get()));
if (!ssl_ || !SSL_set_app_data(ssl_.get(), this)) {
return ERR_UNEXPECTED;
}
SSL_set_shed_handshake_config(ssl_.get(), 1);
std::vector<uint16_t> signing_algorithm_prefs;
if (context_->ssl_server_config_.signature_algorithm_for_testing
.has_value()) {
signing_algorithm_prefs.emplace_back(
*context_->ssl_server_config_.signature_algorithm_for_testing);
} else if (context_->private_key_) {
signing_algorithm_prefs = context_->private_key_->GetAlgorithmPreferences();
}
const SSL_PRIVATE_KEY_METHOD* custom_key = nullptr;
if (context_->pkey_) {
DCHECK(!context_->private_key_);
} else {
DCHECK(context_->private_key_);
custom_key = &kPrivateKeyMethod;
}
// If a Trust Anchor ID for the intermediate certificate was provided,
// configure an alternative, shorter chain that omits the intermediate.
if (!context_->ssl_server_config_.intermediate_trust_anchor_id.empty()) {
// The current Trust Anchor IDs API only allows configuring a Trust Anchor
// ID for a single intermediate certificate.
DCHECK_EQ(context_->cert_chain_.size(), 2u);
std::vector<bssl::UniquePtr<CRYPTO_BUFFER>> elided_chain;
elided_chain.emplace_back(bssl::UpRef(context_->cert_chain_[0]));
if (!ConfigureSSLCredential(
ssl_.get(), elided_chain, context_->pkey_.get(), custom_key,
signing_algorithm_prefs, context_->ssl_server_config_.ocsp_response,
context_->ssl_server_config_.signed_cert_timestamp_list,
context_->ssl_server_config_.intermediate_trust_anchor_id)) {
return ERR_UNEXPECTED;
}
}
// Set the full (un-elided) certificate chain and private key.
if (!ConfigureSSLCredential(
ssl_.get(), context_->cert_chain_, context_->pkey_.get(), custom_key,
signing_algorithm_prefs, context_->ssl_server_config_.ocsp_response,
context_->ssl_server_config_.signed_cert_timestamp_list,
/*trust_anchor_id=*/{})) {
return ERR_UNEXPECTED;
}
const std::vector<int>& curves =
context_->ssl_server_config_.curves_for_testing;
if (!curves.empty()) {
CHECK(SSL_set1_curves(ssl_.get(), curves.data(), curves.size()));
}
transport_adapter_ = std::make_unique<SocketBIOAdapter>(
transport_socket_.get(), kBufferSize, kBufferSize, this);
BIO* transport_bio = transport_adapter_->bio();
BIO_up_ref(transport_bio); // SSL_set0_rbio takes ownership.
SSL_set0_rbio(ssl_.get(), transport_bio);
BIO_up_ref(transport_bio); // SSL_set0_wbio takes ownership.
SSL_set0_wbio(ssl_.get(), transport_bio);
return OK;
}
SSLServerContextImpl::SocketImpl* SSLServerContextImpl::SocketImpl::FromSSL(
SSL* ssl) {
SocketImpl* socket = reinterpret_cast<SocketImpl*>(SSL_get_app_data(ssl));
DCHECK(socket);
return socket;
}
// static
ssl_verify_result_t SSLServerContextImpl::SocketImpl::CertVerifyCallback(
SSL* ssl,
uint8_t* out_alert) {
return FromSSL(ssl)->CertVerifyCallbackImpl(out_alert);
}
ssl_verify_result_t SSLServerContextImpl::SocketImpl::CertVerifyCallbackImpl(
uint8_t* out_alert) {
ClientCertVerifier* verifier =
context_->ssl_server_config_.client_cert_verifier;
// If a verifier was not supplied, all certificates are accepted.
if (!verifier)
return ssl_verify_ok;
scoped_refptr<X509Certificate> client_cert =
x509_util::CreateX509CertificateFromBuffers(
SSL_get0_peer_certificates(ssl_.get()));
if (!client_cert) {
*out_alert = SSL_AD_BAD_CERTIFICATE;
return ssl_verify_invalid;
}
// TODO(davidben): Support asynchronous verifiers. http://crbug.com/347402
std::unique_ptr<ClientCertVerifier::Request> ignore_async;
int res = verifier->Verify(client_cert.get(), CompletionOnceCallback(),
&ignore_async);
DCHECK_NE(res, ERR_IO_PENDING);
if (res != OK) {
// TODO(davidben): Map from certificate verification failure to alert.
*out_alert = SSL_AD_CERTIFICATE_UNKNOWN;
return ssl_verify_invalid;
}
return ssl_verify_ok;
}
std::unique_ptr<SSLServerContext> CreateSSLServerContext(
X509Certificate* certificate,
EVP_PKEY* pkey,
const SSLServerConfig& ssl_server_config) {
return std::make_unique<SSLServerContextImpl>(certificate, pkey,
ssl_server_config);
}
std::unique_ptr<SSLServerContext> CreateSSLServerContext(
base::span<const bssl::UniquePtr<CRYPTO_BUFFER>> cert_chain,
EVP_PKEY* pkey,
const SSLServerConfig& ssl_server_config) {
std::vector<bssl::UniquePtr<CRYPTO_BUFFER>> copied_cert_chain;
copied_cert_chain.reserve(cert_chain.size());
for (const auto& handle : cert_chain) {
copied_cert_chain.push_back(bssl::UpRef(handle.get()));
}
return std::make_unique<SSLServerContextImpl>(std::move(copied_cert_chain),
pkey, ssl_server_config);
}
std::unique_ptr<SSLServerContext> CreateSSLServerContext(
X509Certificate* certificate,
const crypto::RSAPrivateKey& key,
const SSLServerConfig& ssl_server_config) {
return std::make_unique<SSLServerContextImpl>(certificate, key.key(),
ssl_server_config);
}
std::unique_ptr<SSLServerContext> CreateSSLServerContext(
X509Certificate* certificate,
scoped_refptr<SSLPrivateKey> key,
const SSLServerConfig& ssl_config) {
return std::make_unique<SSLServerContextImpl>(certificate, key, ssl_config);
}
SSLServerContextImpl::SSLServerContextImpl(
X509Certificate* certificate,
scoped_refptr<net::SSLPrivateKey> key,
const SSLServerConfig& ssl_server_config)
: ssl_server_config_(ssl_server_config),
cert_chain_(ChainFromX509Certificate(certificate)),
private_key_(key) {
CHECK(private_key_);
Init();
}
SSLServerContextImpl::SSLServerContextImpl(
X509Certificate* certificate,
EVP_PKEY* pkey,
const SSLServerConfig& ssl_server_config)
: SSLServerContextImpl(ChainFromX509Certificate(certificate),
pkey,
ssl_server_config) {}
SSLServerContextImpl::SSLServerContextImpl(
std::vector<bssl::UniquePtr<CRYPTO_BUFFER>> cert_chain,
EVP_PKEY* pkey,
const SSLServerConfig& ssl_server_config)
: ssl_server_config_(ssl_server_config),
cert_chain_(std::move(cert_chain)) {
CHECK(pkey);
pkey_ = bssl::UpRef(pkey);
Init();
}
void SSLServerContextImpl::Init() {
ssl_ctx_.reset(SSL_CTX_new(TLS_with_buffers_method()));
SSL_CTX_set_session_cache_mode(ssl_ctx_.get(), SSL_SESS_CACHE_SERVER);
uint8_t session_ctx_id = 0;
SSL_CTX_set_session_id_context(ssl_ctx_.get(), &session_ctx_id,
sizeof(session_ctx_id));
// Deduplicate all certificates minted from the SSL_CTX in memory.
SSL_CTX_set0_buffer_pool(ssl_ctx_.get(), x509_util::GetBufferPool());
int verify_mode = 0;
switch (ssl_server_config_.client_cert_type) {
case SSLServerConfig::ClientCertType::REQUIRE_CLIENT_CERT:
verify_mode |= SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
[[fallthrough]];
case SSLServerConfig::ClientCertType::OPTIONAL_CLIENT_CERT:
verify_mode |= SSL_VERIFY_PEER;
SSL_CTX_set_custom_verify(ssl_ctx_.get(), verify_mode,
SocketImpl::CertVerifyCallback);
break;
case SSLServerConfig::ClientCertType::NO_CLIENT_CERT:
break;
}
SSL_CTX_set_early_data_enabled(ssl_ctx_.get(),
ssl_server_config_.early_data_enabled);
// TLS versions before TLS 1.2 are no longer supported.
CHECK_LE(TLS1_2_VERSION, ssl_server_config_.version_min);
CHECK_LE(TLS1_2_VERSION, ssl_server_config_.version_max);
CHECK(SSL_CTX_set_min_proto_version(ssl_ctx_.get(),
ssl_server_config_.version_min));
CHECK(SSL_CTX_set_max_proto_version(ssl_ctx_.get(),
ssl_server_config_.version_max));
// OpenSSL defaults some options to on, others to off. To avoid ambiguity,
// set everything we care about to an absolute value.
SslSetClearMask options;
options.ConfigureFlag(SSL_OP_NO_COMPRESSION, true);
SSL_CTX_set_options(ssl_ctx_.get(), options.set_mask);
SSL_CTX_clear_options(ssl_ctx_.get(), options.clear_mask);
// Same as above, this time for the SSL mode.
SslSetClearMask mode;
mode.ConfigureFlag(SSL_MODE_RELEASE_BUFFERS, true);
SSL_CTX_set_mode(ssl_ctx_.get(), mode.set_mask);
SSL_CTX_clear_mode(ssl_ctx_.get(), mode.clear_mask);
if (ssl_server_config_.cipher_suite_for_testing.has_value()) {
const SSL_CIPHER* cipher =
SSL_get_cipher_by_value(*ssl_server_config_.cipher_suite_for_testing);
CHECK(cipher);
CHECK(SSL_CTX_set_strict_cipher_list(ssl_ctx_.get(),
SSL_CIPHER_get_name(cipher)));
} else {
// Use BoringSSL defaults, but disable 3DES and HMAC-SHA1 ciphers in ECDSA.
// These are the remaining CBC-mode ECDSA ciphers.
std::string command("ALL:!aPSK:!ECDSA+SHA1:!3DES");
// SSLPrivateKey only supports ECDHE-based ciphers because it lacks decrypt.
if (ssl_server_config_.require_ecdhe || (!pkey_ && private_key_))
command.append(":!kRSA");
// Remove any disabled ciphers.
for (uint16_t id : ssl_server_config_.disabled_cipher_suites) {
const SSL_CIPHER* cipher = SSL_get_cipher_by_value(id);
if (cipher) {
command.append(":!");
command.append(SSL_CIPHER_get_name(cipher));
}
}
CHECK(SSL_CTX_set_strict_cipher_list(ssl_ctx_.get(), command.c_str()));
}
if (ssl_server_config_.client_cert_type !=
SSLServerConfig::ClientCertType::NO_CLIENT_CERT) {
if (!ssl_server_config_.cert_authorities.empty()) {
bssl::UniquePtr<STACK_OF(CRYPTO_BUFFER)> stack(
sk_CRYPTO_BUFFER_new_null());
for (const auto& authority : ssl_server_config_.cert_authorities) {
sk_CRYPTO_BUFFER_push(
stack.get(), x509_util::CreateCryptoBuffer(authority).release());
}
SSL_CTX_set0_client_CAs(ssl_ctx_.get(), stack.release());
}
if (!ssl_server_config_.client_cert_signature_algorithms.empty()) {
CHECK(SSL_CTX_set_verify_algorithm_prefs(
ssl_ctx_.get(),
ssl_server_config_.client_cert_signature_algorithms.data(),
ssl_server_config_.client_cert_signature_algorithms.size()));
}
}
SSL_CTX_set_alpn_select_cb(ssl_ctx_.get(), &SocketImpl::ALPNSelectCallback,
nullptr);
if (!ssl_server_config_.ocsp_response.empty()) {
SSL_CTX_set_ocsp_response(ssl_ctx_.get(),
ssl_server_config_.ocsp_response.data(),
ssl_server_config_.ocsp_response.size());
}
if (!ssl_server_config_.signed_cert_timestamp_list.empty()) {
SSL_CTX_set_signed_cert_timestamp_list(
ssl_ctx_.get(), ssl_server_config_.signed_cert_timestamp_list.data(),
ssl_server_config_.signed_cert_timestamp_list.size());
}
if (ssl_server_config_.ech_keys) {
CHECK(SSL_CTX_set1_ech_keys(ssl_ctx_.get(),
ssl_server_config_.ech_keys.get()));
}
SSL_CTX_set_select_certificate_cb(ssl_ctx_.get(),
&SocketImpl::SelectCertificateCallback);
}
SSLServerContextImpl::~SSLServerContextImpl() = default;
std::unique_ptr<SSLServerSocket> SSLServerContextImpl::CreateSSLServerSocket(
std::unique_ptr<StreamSocket> socket) {
return std::make_unique<SocketImpl>(this, std::move(socket));
}
} // namespace net
|