2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <folly/io/async/ssl/OpenSSLUtils.h>
19 #include <glog/logging.h>
21 #include <unordered_map>
23 #include <folly/ScopeGuard.h>
24 #include <folly/portability/Sockets.h>
27 #ifdef OPENSSL_IS_BORINGSSL
28 // BoringSSL doesn't (as of May 2016) export the equivalent
29 // of BIO_sock_should_retry, so this is one way around it :(
30 static int boringssl_bio_fd_should_retry(int err);
38 bool OpenSSLUtils::getTLSMasterKey(
39 const SSL_SESSION* session,
40 MutableByteRange keyOut) {
41 #if FOLLY_OPENSSL_IS_101 || FOLLY_OPENSSL_IS_102
43 session->master_key_length == static_cast<int>(keyOut.size())) {
44 auto masterKey = session->master_key;
46 masterKey, masterKey + session->master_key_length, keyOut.begin());
50 (SSL_SESSION*)session;
51 (MutableByteRange) keyOut;
56 bool OpenSSLUtils::getTLSClientRandom(
58 MutableByteRange randomOut) {
59 #if FOLLY_OPENSSL_IS_101 || FOLLY_OPENSSL_IS_102
60 if ((SSL_version(ssl) >> 8) == TLS1_VERSION_MAJOR && ssl->s3 &&
61 randomOut.size() == SSL3_RANDOM_SIZE) {
62 auto clientRandom = ssl->s3->client_random;
63 std::copy(clientRandom, clientRandom + SSL3_RANDOM_SIZE, randomOut.begin());
68 (MutableByteRange) randomOut;
73 bool OpenSSLUtils::getPeerAddressFromX509StoreCtx(X509_STORE_CTX* ctx,
74 sockaddr_storage* addrStorage,
76 // Grab the ssl idx and then the ssl object so that we can get the peer
77 // name to compare against the ips in the subjectAltName
78 auto sslIdx = SSL_get_ex_data_X509_STORE_CTX_idx();
79 auto ssl = reinterpret_cast<SSL*>(X509_STORE_CTX_get_ex_data(ctx, sslIdx));
80 int fd = SSL_get_fd(ssl);
82 LOG(ERROR) << "Inexplicably couldn't get fd from SSL";
86 *addrLen = sizeof(*addrStorage);
87 if (getpeername(fd, reinterpret_cast<sockaddr*>(addrStorage), addrLen) != 0) {
88 PLOG(ERROR) << "Unable to get peer name";
91 CHECK(*addrLen <= sizeof(*addrStorage));
95 bool OpenSSLUtils::validatePeerCertNames(X509* cert,
97 socklen_t /* addrLen */) {
98 // Try to extract the names within the SAN extension from the certificate
99 auto altNames = reinterpret_cast<STACK_OF(GENERAL_NAME)*>(
100 X509_get_ext_d2i(cert, NID_subject_alt_name, nullptr, nullptr));
102 if (altNames != nullptr) {
103 sk_GENERAL_NAME_pop_free(altNames, GENERAL_NAME_free);
106 if (altNames == nullptr) {
107 LOG(WARNING) << "No subjectAltName provided and we only support ip auth";
111 const sockaddr_in* addr4 = nullptr;
112 const sockaddr_in6* addr6 = nullptr;
113 if (addr != nullptr) {
114 if (addr->sa_family == AF_INET) {
115 addr4 = reinterpret_cast<const sockaddr_in*>(addr);
116 } else if (addr->sa_family == AF_INET6) {
117 addr6 = reinterpret_cast<const sockaddr_in6*>(addr);
119 LOG(FATAL) << "Unsupported sockaddr family: " << addr->sa_family;
123 for (int i = 0; i < sk_GENERAL_NAME_num(altNames); i++) {
124 auto name = sk_GENERAL_NAME_value(altNames, i);
125 if ((addr4 != nullptr || addr6 != nullptr) && name->type == GEN_IPADD) {
126 // Extra const-ness for paranoia
127 unsigned char const* const rawIpStr = name->d.iPAddress->data;
128 size_t const rawIpLen = size_t(name->d.iPAddress->length);
130 if (rawIpLen == 4 && addr4 != nullptr) {
131 if (::memcmp(rawIpStr, &addr4->sin_addr, rawIpLen) == 0) {
134 } else if (rawIpLen == 16 && addr6 != nullptr) {
135 if (::memcmp(rawIpStr, &addr6->sin6_addr, rawIpLen) == 0) {
138 } else if (rawIpLen != 4 && rawIpLen != 16) {
139 LOG(WARNING) << "Unexpected IP length: " << rawIpLen;
144 LOG(WARNING) << "Unable to match client cert against alt name ip";
148 static std::unordered_map<uint16_t, std::string> getOpenSSLCipherNames() {
149 std::unordered_map<uint16_t, std::string> ret;
150 SSL_CTX* ctx = nullptr;
153 const SSL_METHOD* meth = SSLv23_server_method();
154 OpenSSL_add_ssl_algorithms();
156 if ((ctx = SSL_CTX_new(meth)) == nullptr) {
163 if ((ssl = SSL_new(ctx)) == nullptr) {
170 STACK_OF(SSL_CIPHER)* sk = SSL_get_ciphers(ssl);
171 for (int i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
172 const SSL_CIPHER* c = sk_SSL_CIPHER_value(sk, i);
173 unsigned long id = SSL_CIPHER_get_id(c);
174 // OpenSSL 1.0.2 and prior does weird things such as stuff the SSL/TLS
175 // version into the top 16 bits. Let's ignore those for now. This is
176 // BoringSSL compatible (their id can be cast as uint16_t)
177 uint16_t cipherCode = id & 0xffffL;
178 ret[cipherCode] = SSL_CIPHER_get_name(c);
183 const std::string& OpenSSLUtils::getCipherName(uint16_t cipherCode) {
184 // Having this in a hash map saves the binary search inside OpenSSL
185 static std::unordered_map<uint16_t, std::string> cipherCodeToName(
186 getOpenSSLCipherNames());
188 const auto& iter = cipherCodeToName.find(cipherCode);
189 if (iter != cipherCodeToName.end()) {
192 static std::string empty("");
197 void OpenSSLUtils::setSSLInitialCtx(SSL* ssl, SSL_CTX* ctx) {
200 #if !FOLLY_OPENSSL_IS_110 && !defined(OPENSSL_NO_TLSEXT)
202 ssl->initial_ctx = ctx;
207 SSL_CTX* OpenSSLUtils::getSSLInitialCtx(SSL* ssl) {
209 #if !FOLLY_OPENSSL_IS_110 && !defined(OPENSSL_NO_TLSEXT)
211 return ssl->initial_ctx;
217 BioMethodUniquePtr OpenSSLUtils::newSocketBioMethod() {
218 BIO_METHOD* newmeth = nullptr;
219 #if FOLLY_OPENSSL_IS_110
220 if (!(newmeth = BIO_meth_new(BIO_TYPE_SOCKET, "socket_bio_method"))) {
223 auto meth = const_cast<BIO_METHOD*>(BIO_s_socket());
224 BIO_meth_set_create(newmeth, BIO_meth_get_create(meth));
225 BIO_meth_set_destroy(newmeth, BIO_meth_get_destroy(meth));
226 BIO_meth_set_ctrl(newmeth, BIO_meth_get_ctrl(meth));
227 BIO_meth_set_callback_ctrl(newmeth, BIO_meth_get_callback_ctrl(meth));
228 BIO_meth_set_read(newmeth, BIO_meth_get_read(meth));
229 BIO_meth_set_write(newmeth, BIO_meth_get_write(meth));
230 BIO_meth_set_gets(newmeth, BIO_meth_get_gets(meth));
231 BIO_meth_set_puts(newmeth, BIO_meth_get_puts(meth));
233 if (!(newmeth = (BIO_METHOD*)OPENSSL_malloc(sizeof(BIO_METHOD)))) {
236 memcpy(newmeth, BIO_s_socket(), sizeof(BIO_METHOD));
239 return BioMethodUniquePtr(newmeth);
242 bool OpenSSLUtils::setCustomBioReadMethod(
244 int (*meth)(BIO*, char*, int)) {
246 ret = (BIO_meth_set_read(bioMeth, meth) == 1);
250 bool OpenSSLUtils::setCustomBioWriteMethod(
252 int (*meth)(BIO*, const char*, int)) {
254 ret = (BIO_meth_set_write(bioMeth, meth) == 1);
258 int OpenSSLUtils::getBioShouldRetryWrite(int r) {
260 #ifdef OPENSSL_IS_BORINGSSL
261 ret = boringssl_bio_fd_should_retry(r);
263 ret = BIO_sock_should_retry(r);
268 void OpenSSLUtils::setBioAppData(BIO* b, void* ptr) {
269 #ifdef OPENSSL_IS_BORINGSSL
270 BIO_set_callback_arg(b, static_cast<char*>(ptr));
272 BIO_set_app_data(b, ptr);
276 void* OpenSSLUtils::getBioAppData(BIO* b) {
277 #ifdef OPENSSL_IS_BORINGSSL
278 return BIO_get_callback_arg(b);
280 return BIO_get_app_data(b);
284 int OpenSSLUtils::getBioFd(BIO* b, int* fd) {
286 int ret = portability::sockets::socket_to_fd((SOCKET)BIO_get_fd(b, fd));
292 return BIO_get_fd(b, fd);
296 void OpenSSLUtils::setBioFd(BIO* b, int fd, int flags) {
298 SOCKET socket = portability::sockets::fd_to_socket(fd);
299 // Internally OpenSSL uses this as an int for reasons completely
300 // beyond any form of sanity, so we do the cast ourselves to avoid
301 // the warnings that would be generated.
302 int sock = int(socket);
306 BIO_set_fd(b, sock, flags);
313 #ifdef OPENSSL_IS_BORINGSSL
315 static int boringssl_bio_fd_non_fatal_error(int err) {
318 err == EWOULDBLOCK ||
320 #ifdef WSAEWOULDBLOCK
321 err == WSAEWOULDBLOCK ||
336 err == EINPROGRESS ||
347 #if defined(OPENSSL_WINDOWS)
350 #pragma warning(push, 3)
354 int boringssl_bio_fd_should_retry(int i) {
356 return boringssl_bio_fd_non_fatal_error((int)GetLastError());
361 #else // !OPENSSL_WINDOWS
364 int boringssl_bio_fd_should_retry(int i) {
366 return boringssl_bio_fd_non_fatal_error(errno);
370 #endif // OPENSSL_WINDOWS
372 #endif // OEPNSSL_IS_BORINGSSL