lib/stream-ssl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "stream-ssl.h"
  19 #include "dhparams.h"
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <inttypes.h>
  23 #include <string.h>
  24 #include <sys/types.h>
  25 #include <sys/socket.h>
  26 #include <netinet/tcp.h>
  27 #include <openssl/err.h>
  28 #include <openssl/rand.h>
  29 #include <openssl/ssl.h>
  30 #include <openssl/x509v3.h>
  31 #include <poll.h>
  32 #include <fcntl.h>
  33 #include <sys/stat.h>
  34 #include <unistd.h>
  35 #include "coverage.h"
  36 #include "dynamic-string.h"
  37 #include "entropy.h"
  38 #include "ofpbuf.h"
  39 #include "openflow/openflow.h"
  40 #include "packets.h"
  41 #include "poll-loop.h"
  42 #include "shash.h"
  43 #include "socket-util.h"
  44 #include "util.h"
  45 #include "stream-provider.h"
  46 #include "stream.h"
  47 #include "timeval.h"
  48 #include "vlog.h"
  49
  50 #ifdef _WIN32
  51 /* Ref: https://www.openssl.org/support/faq.html#PROG2
  52  * Your application must link against the same version of the Win32 C-Runtime
  53  * against which your openssl libraries were linked.  The default version for
  54  * OpenSSL is /MD - "Multithreaded DLL". If we compile Open vSwitch with
  55  * something other than /MD, instead of re-compiling OpenSSL
  56  * toolkit, openssl/applink.c can be #included. Also, it is important
  57  * to add CRYPTO_malloc_init prior first call to OpenSSL.
  58  *
  59  * XXX: The behavior of the following #include when Open vSwitch is
  60  * compiled with /MD is not tested. */
  61 #include <openssl/applink.c>
  62 #define SHUT_RDWR SD_BOTH
  63 #endif
  64
  65 VLOG_DEFINE_THIS_MODULE(stream_ssl);
  66
  67 /* Active SSL. */
  68
  69 enum ssl_state {
  70     STATE_TCP_CONNECTING,
  71     STATE_SSL_CONNECTING
  72 };
  73
  74 enum session_type {
  75     CLIENT,
  76     SERVER
  77 };
  78
  79 struct ssl_stream
  80 {
  81     struct stream stream;
  82     enum ssl_state state;
  83     enum session_type type;
  84     int fd;
  85     HANDLE wevent;
  86     SSL *ssl;
  87     struct ofpbuf *txbuf;
  88     unsigned int session_nr;
  89
  90     /* rx_want and tx_want record the result of the last call to SSL_read()
  91      * and SSL_write(), respectively:
  92      *
  93      *    - If the call reported that data needed to be read from the file
  94      *      descriptor, the corresponding member is set to SSL_READING.
  95      *
  96      *    - If the call reported that data needed to be written to the file
  97      *      descriptor, the corresponding member is set to SSL_WRITING.
  98      *
  99      *    - Otherwise, the member is set to SSL_NOTHING, indicating that the
 100      *      call completed successfully (or with an error) and that there is no
 101      *      need to block.
 102      *
 103      * These are needed because there is no way to ask OpenSSL what a data read
 104      * or write would require without giving it a buffer to receive into or
 105      * data to send, respectively.  (Note that the SSL_want() status is
 106      * overwritten by each SSL_read() or SSL_write() call, so we can't rely on
 107      * its value.)
 108      *
 109      * A single call to SSL_read() or SSL_write() can perform both reading
 110      * and writing and thus invalidate not one of these values but actually
 111      * both.  Consider this situation, for example:
 112      *
 113      *    - SSL_write() blocks on a read, so tx_want gets SSL_READING.
 114      *
 115      *    - SSL_read() laters succeeds reading from 'fd' and clears out the
 116      *      whole receive buffer, so rx_want gets SSL_READING.
 117      *
 118      *    - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
 119      *      and blocks.
 120      *
 121      *    - Now we're stuck blocking until the peer sends us data, even though
 122      *      SSL_write() could now succeed, which could easily be a deadlock
 123      *      condition.
 124      *
 125      * On the other hand, we can't reset both tx_want and rx_want on every call
 126      * to SSL_read() or SSL_write(), because that would produce livelock,
 127      * e.g. in this situation:
 128      *
 129      *    - SSL_write() blocks, so tx_want gets SSL_READING or SSL_WRITING.
 130      *
 131      *    - SSL_read() blocks, so rx_want gets SSL_READING or SSL_WRITING,
 132      *      but tx_want gets reset to SSL_NOTHING.
 133      *
 134      *    - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
 135      *      and blocks.
 136      *
 137      *    - Client wakes up immediately since SSL_NOTHING in tx_want indicates
 138      *      that no blocking is necessary.
 139      *
 140      * The solution we adopt here is to set tx_want to SSL_NOTHING after
 141      * calling SSL_read() only if the SSL state of the connection changed,
 142      * which indicates that an SSL-level renegotiation made some progress, and
 143      * similarly for rx_want and SSL_write().  This prevents both the
 144      * deadlock and livelock situations above.
 145      */
 146     int rx_want, tx_want;
 147
 148     /* A few bytes of header data in case SSL negotiation fails. */
 149     uint8_t head[2];
 150     short int n_head;
 151 };
 152
 153 /* SSL context created by ssl_init(). */
 154 static SSL_CTX *ctx;
 155
 156 struct ssl_config_file {
 157     bool read;                  /* Whether the file was successfully read. */
 158     char *file_name;            /* Configured file name, if any. */
 159     struct timespec mtime;      /* File mtime as of last time we read it. */
 160 };
 161
 162 /* SSL configuration files. */
 163 static struct ssl_config_file private_key;
 164 static struct ssl_config_file certificate;
 165 static struct ssl_config_file ca_cert;
 166
 167 /* Ordinarily, the SSL client and server verify each other's certificates using
 168  * a CA certificate.  Setting this to false disables this behavior.  (This is a
 169  * security risk.) */
 170 static bool verify_peer_cert = true;
 171
 172 /* Ordinarily, we require a CA certificate for the peer to be locally
 173  * available.  We can, however, bootstrap the CA certificate from the peer at
 174  * the beginning of our first connection then use that certificate on all
 175  * subsequent connections, saving it to a file for use in future runs also.  In
 176  * this case, 'bootstrap_ca_cert' is true. */
 177 static bool bootstrap_ca_cert;
 178
 179 /* Session number.  Used in debug logging messages to uniquely identify a
 180  * session. */
 181 static unsigned int next_session_nr;
 182
 183 /* Who knows what can trigger various SSL errors, so let's throttle them down
 184  * quite a bit. */
 185 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
 186
 187 static int ssl_init(void);
 188 static int do_ssl_init(void);
 189 static bool ssl_wants_io(int ssl_error);
 190 static void ssl_close(struct stream *);
 191 static void ssl_clear_txbuf(struct ssl_stream *);
 192 static void interpret_queued_ssl_error(const char *function);
 193 static int interpret_ssl_error(const char *function, int ret, int error,
 194                                int *want);
 195 static DH *tmp_dh_callback(SSL *ssl, int is_export OVS_UNUSED, int keylength);
 196 static void log_ca_cert(const char *file_name, X509 *cert);
 197 static void stream_ssl_set_ca_cert_file__(const char *file_name,
 198                                           bool bootstrap, bool force);
 199 static void ssl_protocol_cb(int write_p, int version, int content_type,
 200                             const void *, size_t, SSL *, void *sslv_);
 201 static bool update_ssl_config(struct ssl_config_file *, const char *file_name);
 202 static int sock_errno(void);
 203 static void clear_handle(int fd, HANDLE wevent);
 204
 205 static short int
 206 want_to_poll_events(int want)
 207 {
 208     switch (want) {
 209     case SSL_NOTHING:
 210         OVS_NOT_REACHED();
 211
 212     case SSL_READING:
 213         return POLLIN;
 214
 215     case SSL_WRITING:
 216         return POLLOUT;
 217
 218     default:
 219         OVS_NOT_REACHED();
 220     }
 221 }
 222
 223 static int
 224 setsockopt_tcp_nodelay(int fd)
 225 {
 226     int on = 1;
 227     int retval;
 228
 229     retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
 230     if (retval) {
 231         retval = sock_errno();
 232         VLOG_ERR("setsockopt(TCP_NODELAY): %s", sock_strerror(retval));
 233     }
 234     return retval;
 235 }
 236
 237 static int
 238 new_ssl_stream(const char *name, int fd, enum session_type type,
 239                enum ssl_state state, struct stream **streamp)
 240 {
 241     struct sockaddr_storage local;
 242     socklen_t local_len = sizeof local;
 243     struct ssl_stream *sslv;
 244     SSL *ssl = NULL;
 245     int retval;
 246
 247     /* Check for all the needful configuration. */
 248     retval = 0;
 249     if (!private_key.read) {
 250         VLOG_ERR("Private key must be configured to use SSL");
 251         retval = ENOPROTOOPT;
 252     }
 253     if (!certificate.read) {
 254         VLOG_ERR("Certificate must be configured to use SSL");
 255         retval = ENOPROTOOPT;
 256     }
 257     if (!ca_cert.read && verify_peer_cert && !bootstrap_ca_cert) {
 258         VLOG_ERR("CA certificate must be configured to use SSL");
 259         retval = ENOPROTOOPT;
 260     }
 261     if (!retval && !SSL_CTX_check_private_key(ctx)) {
 262         VLOG_ERR("Private key does not match certificate public key: %s",
 263                  ERR_error_string(ERR_get_error(), NULL));
 264         retval = ENOPROTOOPT;
 265     }
 266     if (retval) {
 267         goto error;
 268     }
 269
 270     /* Get the local IP and port information */
 271     retval = getsockname(fd, (struct sockaddr *) &local, &local_len);
 272     if (retval) {
 273         memset(&local, 0, sizeof local);
 274     }
 275
 276     /* Disable Nagle.
 277      * On windows platforms, this can only be called upon TCP connected.
 278      */
 279     if (state == STATE_SSL_CONNECTING) {
 280         retval = setsockopt_tcp_nodelay(fd);
 281         if (retval) {
 282             goto error;
 283         }
 284     }
 285
 286     /* Create and configure OpenSSL stream. */
 287     ssl = SSL_new(ctx);
 288     if (ssl == NULL) {
 289         VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
 290         retval = ENOPROTOOPT;
 291         goto error;
 292     }
 293     if (SSL_set_fd(ssl, fd) == 0) {
 294         VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
 295         retval = ENOPROTOOPT;
 296         goto error;
 297     }
 298     if (!verify_peer_cert || (bootstrap_ca_cert && type == CLIENT)) {
 299         SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL);
 300     }
 301
 302     /* Create and return the ssl_stream. */
 303     sslv = xmalloc(sizeof *sslv);
 304     stream_init(&sslv->stream, &ssl_stream_class, EAGAIN, name);
 305     sslv->state = state;
 306     sslv->type = type;
 307     sslv->fd = fd;
 308 #ifdef _WIN32
 309     sslv->wevent = CreateEvent(NULL, FALSE, FALSE, NULL);
 310 #else
 311     sslv->wevent = 0;
 312 #endif
 313     sslv->ssl = ssl;
 314     sslv->txbuf = NULL;
 315     sslv->rx_want = sslv->tx_want = SSL_NOTHING;
 316     sslv->session_nr = next_session_nr++;
 317     sslv->n_head = 0;
 318
 319     if (VLOG_IS_DBG_ENABLED()) {
 320         SSL_set_msg_callback(ssl, ssl_protocol_cb);
 321         SSL_set_msg_callback_arg(ssl, sslv);
 322     }
 323
 324     *streamp = &sslv->stream;
 325     return 0;
 326
 327 error:
 328     if (ssl) {
 329         SSL_free(ssl);
 330     }
 331     closesocket(fd);
 332     return retval;
 333 }
 334
 335 static struct ssl_stream *
 336 ssl_stream_cast(struct stream *stream)
 337 {
 338     stream_assert_class(stream, &ssl_stream_class);
 339     return CONTAINER_OF(stream, struct ssl_stream, stream);
 340 }
 341
 342 static int
 343 ssl_open(const char *name, char *suffix, struct stream **streamp, uint8_t dscp)
 344 {
 345     int error, fd;
 346
 347     error = ssl_init();
 348     if (error) {
 349         return error;
 350     }
 351
 352     error = inet_open_active(SOCK_STREAM, suffix, OFP_OLD_PORT, NULL, &fd,
 353                              dscp);
 354     if (fd >= 0) {
 355         int state = error ? STATE_TCP_CONNECTING : STATE_SSL_CONNECTING;
 356         return new_ssl_stream(name, fd, CLIENT, state, streamp);
 357     } else {
 358         VLOG_ERR("%s: connect: %s", name, ovs_strerror(error));
 359         return error;
 360     }
 361 }
 362
 363 static int
 364 do_ca_cert_bootstrap(struct stream *stream)
 365 {
 366     struct ssl_stream *sslv = ssl_stream_cast(stream);
 367     STACK_OF(X509) *chain;
 368     X509 *cert;
 369     FILE *file;
 370     int error;
 371     int fd;
 372
 373     chain = SSL_get_peer_cert_chain(sslv->ssl);
 374     if (!chain || !sk_X509_num(chain)) {
 375         VLOG_ERR("could not bootstrap CA cert: no certificate presented by "
 376                  "peer");
 377         return EPROTO;
 378     }
 379     cert = sk_X509_value(chain, sk_X509_num(chain) - 1);
 380
 381     /* Check that 'cert' is self-signed.  Otherwise it is not a CA
 382      * certificate and we should not attempt to use it as one. */
 383     error = X509_check_issued(cert, cert);
 384     if (error) {
 385         VLOG_ERR("could not bootstrap CA cert: obtained certificate is "
 386                  "not self-signed (%s)",
 387                  X509_verify_cert_error_string(error));
 388         if (sk_X509_num(chain) < 2) {
 389             VLOG_ERR("only one certificate was received, so probably the peer "
 390                      "is not configured to send its CA certificate");
 391         }
 392         return EPROTO;
 393     }
 394
 395     fd = open(ca_cert.file_name, O_CREAT | O_EXCL | O_WRONLY, 0444);
 396     if (fd < 0) {
 397         if (errno == EEXIST) {
 398             VLOG_INFO_RL(&rl, "reading CA cert %s created by another process",
 399                          ca_cert.file_name);
 400             stream_ssl_set_ca_cert_file__(ca_cert.file_name, true, true);
 401             return EPROTO;
 402         } else {
 403             VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
 404                      ca_cert.file_name, ovs_strerror(errno));
 405             return errno;
 406         }
 407     }
 408
 409     file = fdopen(fd, "w");
 410     if (!file) {
 411         error = errno;
 412         VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
 413                  ovs_strerror(error));
 414         unlink(ca_cert.file_name);
 415         return error;
 416     }
 417
 418     if (!PEM_write_X509(file, cert)) {
 419         VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
 420                  "%s", ca_cert.file_name,
 421                  ERR_error_string(ERR_get_error(), NULL));
 422         fclose(file);
 423         unlink(ca_cert.file_name);
 424         return EIO;
 425     }
 426
 427     if (fclose(file)) {
 428         error = errno;
 429         VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
 430                  ca_cert.file_name, ovs_strerror(error));
 431         unlink(ca_cert.file_name);
 432         return error;
 433     }
 434
 435     VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert.file_name);
 436     log_ca_cert(ca_cert.file_name, cert);
 437     bootstrap_ca_cert = false;
 438     ca_cert.read = true;
 439
 440     /* SSL_CTX_add_client_CA makes a copy of cert's relevant data. */
 441     SSL_CTX_add_client_CA(ctx, cert);
 442
 443     /* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
 444      * 'cert' is owned by sslv->ssl, so we need to duplicate it. */
 445     cert = X509_dup(cert);
 446     if (!cert) {
 447         out_of_memory();
 448     }
 449     SSL_CTX_set_cert_store(ctx, X509_STORE_new());
 450     if (SSL_CTX_load_verify_locations(ctx, ca_cert.file_name, NULL) != 1) {
 451         VLOG_ERR("SSL_CTX_load_verify_locations: %s",
 452                  ERR_error_string(ERR_get_error(), NULL));
 453         return EPROTO;
 454     }
 455     VLOG_INFO("killing successful connection to retry using CA cert");
 456     return EPROTO;
 457 }
 458
 459 static int
 460 ssl_connect(struct stream *stream)
 461 {
 462     struct ssl_stream *sslv = ssl_stream_cast(stream);
 463     int retval;
 464
 465     switch (sslv->state) {
 466     case STATE_TCP_CONNECTING:
 467         retval = check_connection_completion(sslv->fd);
 468         if (retval) {
 469             return retval;
 470         }
 471         sslv->state = STATE_SSL_CONNECTING;
 472         retval = setsockopt_tcp_nodelay(sslv->fd);
 473         if (retval) {
 474             return retval;
 475         }
 476         /* Fall through. */
 477
 478     case STATE_SSL_CONNECTING:
 479         /* Capture the first few bytes of received data so that we can guess
 480          * what kind of funny data we've been sent if SSL negotiation fails. */
 481         if (sslv->n_head <= 0) {
 482             sslv->n_head = recv(sslv->fd, sslv->head, sizeof sslv->head,
 483                                 MSG_PEEK);
 484         }
 485
 486         retval = (sslv->type == CLIENT
 487                    ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
 488         if (retval != 1) {
 489             int error = SSL_get_error(sslv->ssl, retval);
 490             if (retval < 0 && ssl_wants_io(error)) {
 491                 return EAGAIN;
 492             } else {
 493                 int unused;
 494
 495                 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
 496                                      : "SSL_accept"), retval, error, &unused);
 497                 shutdown(sslv->fd, SHUT_RDWR);
 498                 stream_report_content(sslv->head, sslv->n_head, STREAM_SSL,
 499                                       THIS_MODULE, stream_get_name(stream));
 500                 return EPROTO;
 501             }
 502         } else if (bootstrap_ca_cert) {
 503             return do_ca_cert_bootstrap(stream);
 504         } else if (verify_peer_cert
 505                    && ((SSL_get_verify_mode(sslv->ssl)
 506                        & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
 507                        != SSL_VERIFY_PEER)) {
 508             /* Two or more SSL connections completed at the same time while we
 509              * were in bootstrap mode.  Only one of these can finish the
 510              * bootstrap successfully.  The other one(s) must be rejected
 511              * because they were not verified against the bootstrapped CA
 512              * certificate.  (Alternatively we could verify them against the CA
 513              * certificate, but that's more trouble than it's worth.  These
 514              * connections will succeed the next time they retry, assuming that
 515              * they have a certificate against the correct CA.) */
 516             VLOG_INFO("rejecting SSL connection during bootstrap race window");
 517             return EPROTO;
 518         } else {
 519             return 0;
 520         }
 521     }
 522
 523     OVS_NOT_REACHED();
 524 }
 525
 526 static void
 527 ssl_close(struct stream *stream)
 528 {
 529     struct ssl_stream *sslv = ssl_stream_cast(stream);
 530     ssl_clear_txbuf(sslv);
 531
 532     /* Attempt clean shutdown of the SSL connection.  This will work most of
 533      * the time, as long as the kernel send buffer has some free space and the
 534      * SSL connection isn't renegotiating, etc.  That has to be good enough,
 535      * since we don't have any way to continue the close operation in the
 536      * background. */
 537     SSL_shutdown(sslv->ssl);
 538
 539     /* SSL_shutdown() might have signaled an error, in which case we need to
 540      * flush it out of the OpenSSL error queue or the next OpenSSL operation
 541      * will falsely signal an error. */
 542     ERR_clear_error();
 543
 544     SSL_free(sslv->ssl);
 545     clear_handle(sslv->fd, sslv->wevent);
 546     closesocket(sslv->fd);
 547     free(sslv);
 548 }
 549
 550 static void
 551 interpret_queued_ssl_error(const char *function)
 552 {
 553     int queued_error = ERR_get_error();
 554     if (queued_error != 0) {
 555         VLOG_WARN_RL(&rl, "%s: %s",
 556                      function, ERR_error_string(queued_error, NULL));
 557     } else {
 558         VLOG_ERR_RL(&rl, "%s: SSL_ERROR_SSL without queued error", function);
 559     }
 560 }
 561
 562 static int
 563 interpret_ssl_error(const char *function, int ret, int error,
 564                     int *want)
 565 {
 566     *want = SSL_NOTHING;
 567
 568     switch (error) {
 569     case SSL_ERROR_NONE:
 570         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_NONE", function);
 571         break;
 572
 573     case SSL_ERROR_ZERO_RETURN:
 574         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_ZERO_RETURN", function);
 575         break;
 576
 577     case SSL_ERROR_WANT_READ:
 578         *want = SSL_READING;
 579         return EAGAIN;
 580
 581     case SSL_ERROR_WANT_WRITE:
 582         *want = SSL_WRITING;
 583         return EAGAIN;
 584
 585     case SSL_ERROR_WANT_CONNECT:
 586         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_CONNECT", function);
 587         break;
 588
 589     case SSL_ERROR_WANT_ACCEPT:
 590         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
 591         break;
 592
 593     case SSL_ERROR_WANT_X509_LOOKUP:
 594         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP",
 595                     function);
 596         break;
 597
 598     case SSL_ERROR_SYSCALL: {
 599         int queued_error = ERR_get_error();
 600         if (queued_error == 0) {
 601             if (ret < 0) {
 602                 int status = errno;
 603                 VLOG_WARN_RL(&rl, "%s: system error (%s)",
 604                              function, ovs_strerror(status));
 605                 return status;
 606             } else {
 607                 VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close",
 608                              function);
 609                 return EPROTO;
 610             }
 611         } else {
 612             VLOG_WARN_RL(&rl, "%s: %s",
 613                          function, ERR_error_string(queued_error, NULL));
 614             break;
 615         }
 616     }
 617
 618     case SSL_ERROR_SSL:
 619         interpret_queued_ssl_error(function);
 620         break;
 621
 622     default:
 623         VLOG_ERR_RL(&rl, "%s: bad SSL error code %d", function, error);
 624         break;
 625     }
 626     return EIO;
 627 }
 628
 629 static ssize_t
 630 ssl_recv(struct stream *stream, void *buffer, size_t n)
 631 {
 632     struct ssl_stream *sslv = ssl_stream_cast(stream);
 633     int old_state;
 634     ssize_t ret;
 635
 636     /* Behavior of zero-byte SSL_read is poorly defined. */
 637     ovs_assert(n > 0);
 638
 639     old_state = SSL_get_state(sslv->ssl);
 640     ret = SSL_read(sslv->ssl, buffer, n);
 641     if (old_state != SSL_get_state(sslv->ssl)) {
 642         sslv->tx_want = SSL_NOTHING;
 643     }
 644     sslv->rx_want = SSL_NOTHING;
 645
 646     if (ret > 0) {
 647         return ret;
 648     } else {
 649         int error = SSL_get_error(sslv->ssl, ret);
 650         if (error == SSL_ERROR_ZERO_RETURN) {
 651             return 0;
 652         } else {
 653             return -interpret_ssl_error("SSL_read", ret, error,
 654                                         &sslv->rx_want);
 655         }
 656     }
 657 }
 658
 659 static void
 660 ssl_clear_txbuf(struct ssl_stream *sslv)
 661 {
 662     ofpbuf_delete(sslv->txbuf);
 663     sslv->txbuf = NULL;
 664 }
 665
 666 static int
 667 ssl_do_tx(struct stream *stream)
 668 {
 669     struct ssl_stream *sslv = ssl_stream_cast(stream);
 670
 671     for (;;) {
 672         int old_state = SSL_get_state(sslv->ssl);
 673         int ret = SSL_write(sslv->ssl,
 674                             ofpbuf_data(sslv->txbuf), ofpbuf_size(sslv->txbuf));
 675         if (old_state != SSL_get_state(sslv->ssl)) {
 676             sslv->rx_want = SSL_NOTHING;
 677         }
 678         sslv->tx_want = SSL_NOTHING;
 679         if (ret > 0) {
 680             ofpbuf_pull(sslv->txbuf, ret);
 681             if (ofpbuf_size(sslv->txbuf) == 0) {
 682                 return 0;
 683             }
 684         } else {
 685             int ssl_error = SSL_get_error(sslv->ssl, ret);
 686             if (ssl_error == SSL_ERROR_ZERO_RETURN) {
 687                 VLOG_WARN_RL(&rl, "SSL_write: connection closed");
 688                 return EPIPE;
 689             } else {
 690                 return interpret_ssl_error("SSL_write", ret, ssl_error,
 691                                            &sslv->tx_want);
 692             }
 693         }
 694     }
 695 }
 696
 697 static ssize_t
 698 ssl_send(struct stream *stream, const void *buffer, size_t n)
 699 {
 700     struct ssl_stream *sslv = ssl_stream_cast(stream);
 701
 702     if (sslv->txbuf) {
 703         return -EAGAIN;
 704     } else {
 705         int error;
 706
 707         sslv->txbuf = ofpbuf_clone_data(buffer, n);
 708         error = ssl_do_tx(stream);
 709         switch (error) {
 710         case 0:
 711             ssl_clear_txbuf(sslv);
 712             return n;
 713         case EAGAIN:
 714             return n;
 715         default:
 716             sslv->txbuf = NULL;
 717             return -error;
 718         }
 719     }
 720 }
 721
 722 static void
 723 ssl_run(struct stream *stream)
 724 {
 725     struct ssl_stream *sslv = ssl_stream_cast(stream);
 726
 727     if (sslv->txbuf && ssl_do_tx(stream) != EAGAIN) {
 728         ssl_clear_txbuf(sslv);
 729     }
 730 }
 731
 732 static void
 733 ssl_run_wait(struct stream *stream)
 734 {
 735     struct ssl_stream *sslv = ssl_stream_cast(stream);
 736
 737     if (sslv->tx_want != SSL_NOTHING) {
 738         poll_fd_wait_event(sslv->fd, sslv->wevent,
 739                            want_to_poll_events(sslv->tx_want));
 740     }
 741 }
 742
 743 static void
 744 ssl_wait(struct stream *stream, enum stream_wait_type wait)
 745 {
 746     struct ssl_stream *sslv = ssl_stream_cast(stream);
 747
 748     switch (wait) {
 749     case STREAM_CONNECT:
 750         if (stream_connect(stream) != EAGAIN) {
 751             poll_immediate_wake();
 752         } else {
 753             switch (sslv->state) {
 754             case STATE_TCP_CONNECTING:
 755                 poll_fd_wait_event(sslv->fd, sslv->wevent, POLLOUT);
 756                 break;
 757
 758             case STATE_SSL_CONNECTING:
 759                 /* ssl_connect() called SSL_accept() or SSL_connect(), which
 760                  * set up the status that we test here. */
 761                 poll_fd_wait_event(sslv->fd, sslv->wevent,
 762                                    want_to_poll_events(SSL_want(sslv->ssl)));
 763                 break;
 764
 765             default:
 766                 OVS_NOT_REACHED();
 767             }
 768         }
 769         break;
 770
 771     case STREAM_RECV:
 772         if (sslv->rx_want != SSL_NOTHING) {
 773             poll_fd_wait_event(sslv->fd, sslv->wevent,
 774                                want_to_poll_events(sslv->rx_want));
 775         } else {
 776             poll_immediate_wake();
 777         }
 778         break;
 779
 780     case STREAM_SEND:
 781         if (!sslv->txbuf) {
 782             /* We have room in our tx queue. */
 783             poll_immediate_wake();
 784         } else {
 785             /* stream_run_wait() will do the right thing; don't bother with
 786              * redundancy. */
 787         }
 788         break;
 789
 790     default:
 791         OVS_NOT_REACHED();
 792     }
 793 }
 794
 795 const struct stream_class ssl_stream_class = {
 796     "ssl",                      /* name */
 797     true,                       /* needs_probes */
 798     ssl_open,                   /* open */
 799     ssl_close,                  /* close */
 800     ssl_connect,                /* connect */
 801     ssl_recv,                   /* recv */
 802     ssl_send,                   /* send */
 803     ssl_run,                    /* run */
 804     ssl_run_wait,               /* run_wait */
 805     ssl_wait,                   /* wait */
 806 };
 807 \f
 808 /* Passive SSL. */
 809
 810 struct pssl_pstream
 811 {
 812     struct pstream pstream;
 813     int fd;
 814     HANDLE wevent;
 815 };
 816
 817 const struct pstream_class pssl_pstream_class;
 818
 819 static struct pssl_pstream *
 820 pssl_pstream_cast(struct pstream *pstream)
 821 {
 822     pstream_assert_class(pstream, &pssl_pstream_class);
 823     return CONTAINER_OF(pstream, struct pssl_pstream, pstream);
 824 }
 825
 826 static int
 827 pssl_open(const char *name OVS_UNUSED, char *suffix, struct pstream **pstreamp,
 828           uint8_t dscp)
 829 {
 830     char bound_name[SS_NTOP_BUFSIZE + 16];
 831     char addrbuf[SS_NTOP_BUFSIZE];
 832     struct sockaddr_storage ss;
 833     struct pssl_pstream *pssl;
 834     uint16_t port;
 835     int retval;
 836     int fd;
 837
 838     retval = ssl_init();
 839     if (retval) {
 840         return retval;
 841     }
 842
 843     fd = inet_open_passive(SOCK_STREAM, suffix, OFP_OLD_PORT, &ss, dscp, true);
 844     if (fd < 0) {
 845         return -fd;
 846     }
 847
 848     port = ss_get_port(&ss);
 849     snprintf(bound_name, sizeof bound_name, "ptcp:%"PRIu16":%s",
 850              port, ss_format_address(&ss, addrbuf, sizeof addrbuf));
 851
 852     pssl = xmalloc(sizeof *pssl);
 853     pstream_init(&pssl->pstream, &pssl_pstream_class, bound_name);
 854     pstream_set_bound_port(&pssl->pstream, htons(port));
 855     pssl->fd = fd;
 856 #ifdef _WIN32
 857     pssl->wevent = CreateEvent(NULL, FALSE, FALSE, NULL);
 858 #else
 859     pssl->wevent = 0;
 860 #endif
 861     *pstreamp = &pssl->pstream;
 862     return 0;
 863 }
 864
 865 static void
 866 pssl_close(struct pstream *pstream)
 867 {
 868     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 869     clear_handle(pssl->fd, pssl->wevent);
 870     closesocket(pssl->fd);
 871     free(pssl);
 872 }
 873
 874 static int
 875 pssl_accept(struct pstream *pstream, struct stream **new_streamp)
 876 {
 877     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 878     char name[SS_NTOP_BUFSIZE + 16];
 879     char addrbuf[SS_NTOP_BUFSIZE];
 880     struct sockaddr_storage ss;
 881     socklen_t ss_len = sizeof ss;
 882     int new_fd;
 883     int error;
 884
 885     new_fd = accept(pssl->fd, (struct sockaddr *) &ss, &ss_len);
 886     if (new_fd < 0) {
 887         error = sock_errno();
 888 #ifdef _WIN32
 889         if (error == WSAEWOULDBLOCK) {
 890             error = EAGAIN;
 891         }
 892 #endif
 893         if (error != EAGAIN) {
 894             VLOG_DBG_RL(&rl, "accept: %s", sock_strerror(error));
 895         }
 896         return error;
 897     }
 898
 899     error = set_nonblocking(new_fd);
 900     if (error) {
 901         closesocket(new_fd);
 902         return error;
 903     }
 904
 905     snprintf(name, sizeof name, "tcp:%s:%"PRIu16,
 906              ss_format_address(&ss, addrbuf, sizeof addrbuf),
 907              ss_get_port(&ss));
 908     return new_ssl_stream(name, new_fd, SERVER, STATE_SSL_CONNECTING,
 909                           new_streamp);
 910 }
 911
 912 static void
 913 pssl_wait(struct pstream *pstream)
 914 {
 915     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 916     poll_fd_wait_event(pssl->fd, pssl->wevent, POLLIN);
 917 }
 918
 919 static int
 920 pssl_set_dscp(struct pstream *pstream, uint8_t dscp)
 921 {
 922     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 923     return set_dscp(pssl->fd, dscp);
 924 }
 925
 926 const struct pstream_class pssl_pstream_class = {
 927     "pssl",
 928     true,
 929     pssl_open,
 930     pssl_close,
 931     pssl_accept,
 932     pssl_wait,
 933     pssl_set_dscp,
 934 };
 935 \f
 936 /*
 937  * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
 938  * OpenSSL is requesting that we call it back when the socket is ready for read
 939  * or writing, respectively.
 940  */
 941 static bool
 942 ssl_wants_io(int ssl_error)
 943 {
 944     return (ssl_error == SSL_ERROR_WANT_WRITE
 945             || ssl_error == SSL_ERROR_WANT_READ);
 946 }
 947
 948 static int
 949 ssl_init(void)
 950 {
 951     static int init_status = -1;
 952     if (init_status < 0) {
 953         init_status = do_ssl_init();
 954         ovs_assert(init_status >= 0);
 955     }
 956     return init_status;
 957 }
 958
 959 static int
 960 do_ssl_init(void)
 961 {
 962     SSL_METHOD *method;
 963
 964 #ifdef _WIN32
 965     /* The following call is needed if we "#include <openssl/applink.c>". */
 966     CRYPTO_malloc_init();
 967 #endif
 968     SSL_library_init();
 969     SSL_load_error_strings();
 970
 971     if (!RAND_status()) {
 972         /* We occasionally see OpenSSL fail to seed its random number generator
 973          * in heavily loaded hypervisors.  I suspect the following scenario:
 974          *
 975          * 1. OpenSSL calls read() to get 32 bytes from /dev/urandom.
 976          * 2. The kernel generates 10 bytes of randomness and copies it out.
 977          * 3. A signal arrives (perhaps SIGALRM).
 978          * 4. The kernel interrupts the system call to service the signal.
 979          * 5. Userspace gets 10 bytes of entropy.
 980          * 6. OpenSSL doesn't read again to get the final 22 bytes.  Therefore
 981          *    OpenSSL doesn't have enough entropy to consider itself
 982          *    initialized.
 983          *
 984          * The only part I'm not entirely sure about is #6, because the OpenSSL
 985          * code is so hard to read. */
 986         uint8_t seed[32];
 987         int retval;
 988
 989         VLOG_WARN("OpenSSL random seeding failed, reseeding ourselves");
 990
 991         retval = get_entropy(seed, sizeof seed);
 992         if (retval) {
 993             VLOG_ERR("failed to obtain entropy (%s)",
 994                      ovs_retval_to_string(retval));
 995             return retval > 0 ? retval : ENOPROTOOPT;
 996         }
 997
 998         RAND_seed(seed, sizeof seed);
 999     }
1000
1001     /* OpenSSL has a bunch of "connection methods": SSLv2_method(),
1002      * SSLv3_method(), TLSv1_method(), SSLv23_method(), ...  Most of these
1003      * support exactly one version of SSL, e.g. TLSv1_method() supports TLSv1
1004      * only, not any earlier *or later* version.  The only exception is
1005      * SSLv23_method(), which in fact supports *any* version of SSL and TLS.
1006      * We don't want SSLv2 or SSLv3 support, so we turn it off below with
1007      * SSL_CTX_set_options().
1008      *
1009      * The cast is needed to avoid a warning with newer versions of OpenSSL in
1010      * which SSLv23_method() returns a "const" pointer. */
1011     method = CONST_CAST(SSL_METHOD *, SSLv23_method());
1012     if (method == NULL) {
1013         VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
1014         return ENOPROTOOPT;
1015     }
1016
1017     ctx = SSL_CTX_new(method);
1018     if (ctx == NULL) {
1019         VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
1020         return ENOPROTOOPT;
1021     }
1022     SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
1023     SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
1024     SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
1025     SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
1026     SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1027                        NULL);
1028
1029     return 0;
1030 }
1031
1032 static DH *
1033 tmp_dh_callback(SSL *ssl OVS_UNUSED, int is_export OVS_UNUSED, int keylength)
1034 {
1035     struct dh {
1036         int keylength;
1037         DH *dh;
1038         DH *(*constructor)(void);
1039     };
1040
1041     static struct dh dh_table[] = {
1042         {1024, NULL, get_dh1024},
1043         {2048, NULL, get_dh2048},
1044         {4096, NULL, get_dh4096},
1045     };
1046
1047     struct dh *dh;
1048
1049     for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
1050         if (dh->keylength == keylength) {
1051             if (!dh->dh) {
1052                 dh->dh = dh->constructor();
1053                 if (!dh->dh) {
1054                     out_of_memory();
1055                 }
1056             }
1057             return dh->dh;
1058         }
1059     }
1060     VLOG_ERR_RL(&rl, "no Diffie-Hellman parameters for key length %d",
1061                 keylength);
1062     return NULL;
1063 }
1064
1065 /* Returns true if SSL is at least partially configured. */
1066 bool
1067 stream_ssl_is_configured(void)
1068 {
1069     return private_key.file_name || certificate.file_name || ca_cert.file_name;
1070 }
1071
1072 static bool
1073 update_ssl_config(struct ssl_config_file *config, const char *file_name)
1074 {
1075     struct timespec mtime;
1076     int error;
1077
1078     if (ssl_init() || !file_name) {
1079         return false;
1080     }
1081
1082     /* If the file name hasn't changed and neither has the file contents, stop
1083      * here. */
1084     error = get_mtime(file_name, &mtime);
1085     if (error && error != ENOENT) {
1086         VLOG_ERR_RL(&rl, "%s: stat failed (%s)",
1087                     file_name, ovs_strerror(error));
1088     }
1089     if (config->file_name
1090         && !strcmp(config->file_name, file_name)
1091         && mtime.tv_sec == config->mtime.tv_sec
1092         && mtime.tv_nsec == config->mtime.tv_nsec) {
1093         return false;
1094     }
1095
1096     /* Update 'config'. */
1097     config->mtime = mtime;
1098     if (file_name != config->file_name) {
1099         free(config->file_name);
1100         config->file_name = xstrdup(file_name);
1101     }
1102     return true;
1103 }
1104
1105 static void
1106 stream_ssl_set_private_key_file__(const char *file_name)
1107 {
1108     if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) == 1) {
1109         private_key.read = true;
1110     } else {
1111         VLOG_ERR("SSL_use_PrivateKey_file: %s",
1112                  ERR_error_string(ERR_get_error(), NULL));
1113     }
1114 }
1115
1116 void
1117 stream_ssl_set_private_key_file(const char *file_name)
1118 {
1119     if (update_ssl_config(&private_key, file_name)) {
1120         stream_ssl_set_private_key_file__(file_name);
1121     }
1122 }
1123
1124 static void
1125 stream_ssl_set_certificate_file__(const char *file_name)
1126 {
1127     if (SSL_CTX_use_certificate_chain_file(ctx, file_name) == 1) {
1128         certificate.read = true;
1129     } else {
1130         VLOG_ERR("SSL_use_certificate_file: %s",
1131                  ERR_error_string(ERR_get_error(), NULL));
1132     }
1133 }
1134
1135 void
1136 stream_ssl_set_certificate_file(const char *file_name)
1137 {
1138     if (update_ssl_config(&certificate, file_name)) {
1139         stream_ssl_set_certificate_file__(file_name);
1140     }
1141 }
1142
1143 /* Sets the private key and certificate files in one operation.  Use this
1144  * interface, instead of calling stream_ssl_set_private_key_file() and
1145  * stream_ssl_set_certificate_file() individually, in the main loop of a
1146  * long-running program whose key and certificate might change at runtime.
1147  *
1148  * This is important because of OpenSSL's behavior.  If an OpenSSL context
1149  * already has a certificate, and stream_ssl_set_private_key_file() is called
1150  * to install a new private key, OpenSSL will report an error because the new
1151  * private key does not match the old certificate.  The other order, of setting
1152  * a new certificate, then setting a new private key, does work.
1153  *
1154  * If this were the only problem, calling stream_ssl_set_certificate_file()
1155  * before stream_ssl_set_private_key_file() would fix it.  But, if the private
1156  * key is changed before the certificate (e.g. someone "scp"s or "mv"s the new
1157  * private key in place before the certificate), then OpenSSL would reject that
1158  * change, and then the change of certificate would succeed, but there would be
1159  * no associated private key (because it had only changed once and therefore
1160  * there was no point in re-reading it).
1161  *
1162  * This function avoids both problems by, whenever either the certificate or
1163  * the private key file changes, re-reading both of them, in the correct order.
1164  */
1165 void
1166 stream_ssl_set_key_and_cert(const char *private_key_file,
1167                             const char *certificate_file)
1168 {
1169     if (update_ssl_config(&private_key, private_key_file)
1170         || update_ssl_config(&certificate, certificate_file)) {
1171         stream_ssl_set_certificate_file__(certificate_file);
1172         stream_ssl_set_private_key_file__(private_key_file);
1173     }
1174 }
1175
1176 /* Reads the X509 certificate or certificates in file 'file_name'.  On success,
1177  * stores the address of the first element in an array of pointers to
1178  * certificates in '*certs' and the number of certificates in the array in
1179  * '*n_certs', and returns 0.  On failure, stores a null pointer in '*certs', 0
1180  * in '*n_certs', and returns a positive errno value.
1181  *
1182  * The caller is responsible for freeing '*certs'. */
1183 static int
1184 read_cert_file(const char *file_name, X509 ***certs, size_t *n_certs)
1185 {
1186     FILE *file;
1187     size_t allocated_certs = 0;
1188
1189     *certs = NULL;
1190     *n_certs = 0;
1191
1192     file = fopen(file_name, "r");
1193     if (!file) {
1194         VLOG_ERR("failed to open %s for reading: %s",
1195                  file_name, ovs_strerror(errno));
1196         return errno;
1197     }
1198
1199     for (;;) {
1200         X509 *certificate;
1201         int c;
1202
1203         /* Read certificate from file. */
1204         certificate = PEM_read_X509(file, NULL, NULL, NULL);
1205         if (!certificate) {
1206             size_t i;
1207
1208             VLOG_ERR("PEM_read_X509 failed reading %s: %s",
1209                      file_name, ERR_error_string(ERR_get_error(), NULL));
1210             for (i = 0; i < *n_certs; i++) {
1211                 X509_free((*certs)[i]);
1212             }
1213             free(*certs);
1214             *certs = NULL;
1215             *n_certs = 0;
1216             return EIO;
1217         }
1218
1219         /* Add certificate to array. */
1220         if (*n_certs >= allocated_certs) {
1221             *certs = x2nrealloc(*certs, &allocated_certs, sizeof **certs);
1222         }
1223         (*certs)[(*n_certs)++] = certificate;
1224
1225         /* Are there additional certificates in the file? */
1226         do {
1227             c = getc(file);
1228         } while (isspace(c));
1229         if (c == EOF) {
1230             break;
1231         }
1232         ungetc(c, file);
1233     }
1234     fclose(file);
1235     return 0;
1236 }
1237
1238
1239 /* Sets 'file_name' as the name of a file containing one or more X509
1240  * certificates to send to the peer.  Typical use in OpenFlow is to send the CA
1241  * certificate to the peer, which enables a switch to pick up the controller's
1242  * CA certificate on its first connection. */
1243 void
1244 stream_ssl_set_peer_ca_cert_file(const char *file_name)
1245 {
1246     X509 **certs;
1247     size_t n_certs;
1248     size_t i;
1249
1250     if (ssl_init()) {
1251         return;
1252     }
1253
1254     if (!read_cert_file(file_name, &certs, &n_certs)) {
1255         for (i = 0; i < n_certs; i++) {
1256             if (SSL_CTX_add_extra_chain_cert(ctx, certs[i]) != 1) {
1257                 VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s",
1258                          ERR_error_string(ERR_get_error(), NULL));
1259             }
1260         }
1261         free(certs);
1262     }
1263 }
1264
1265 /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */
1266 static void
1267 log_ca_cert(const char *file_name, X509 *cert)
1268 {
1269     unsigned char digest[EVP_MAX_MD_SIZE];
1270     unsigned int n_bytes;
1271     struct ds fp;
1272     char *subject;
1273
1274     ds_init(&fp);
1275     if (!X509_digest(cert, EVP_sha1(), digest, &n_bytes)) {
1276         ds_put_cstr(&fp, "<out of memory>");
1277     } else {
1278         unsigned int i;
1279         for (i = 0; i < n_bytes; i++) {
1280             if (i) {
1281                 ds_put_char(&fp, ':');
1282             }
1283             ds_put_format(&fp, "%02x", digest[i]);
1284         }
1285     }
1286     subject = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
1287     VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name,
1288               subject ? subject : "<out of memory>", ds_cstr(&fp));
1289     OPENSSL_free(subject);
1290     ds_destroy(&fp);
1291 }
1292
1293 static void
1294 stream_ssl_set_ca_cert_file__(const char *file_name,
1295                               bool bootstrap, bool force)
1296 {
1297     X509 **certs;
1298     size_t n_certs;
1299     struct stat s;
1300
1301     if (!update_ssl_config(&ca_cert, file_name) && !force) {
1302         return;
1303     }
1304
1305     if (!strcmp(file_name, "none")) {
1306         verify_peer_cert = false;
1307         VLOG_WARN("Peer certificate validation disabled "
1308                   "(this is a security risk)");
1309     } else if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
1310         bootstrap_ca_cert = true;
1311     } else if (!read_cert_file(file_name, &certs, &n_certs)) {
1312         size_t i;
1313
1314         /* Set up list of CAs that the server will accept from the client. */
1315         for (i = 0; i < n_certs; i++) {
1316             /* SSL_CTX_add_client_CA makes a copy of the relevant data. */
1317             if (SSL_CTX_add_client_CA(ctx, certs[i]) != 1) {
1318                 VLOG_ERR("failed to add client certificate %"PRIuSIZE" from %s: %s",
1319                          i, file_name,
1320                          ERR_error_string(ERR_get_error(), NULL));
1321             } else {
1322                 log_ca_cert(file_name, certs[i]);
1323             }
1324             X509_free(certs[i]);
1325         }
1326         free(certs);
1327
1328         /* Set up CAs for OpenSSL to trust in verifying the peer's
1329          * certificate. */
1330         SSL_CTX_set_cert_store(ctx, X509_STORE_new());
1331         if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
1332             VLOG_ERR("SSL_CTX_load_verify_locations: %s",
1333                      ERR_error_string(ERR_get_error(), NULL));
1334             return;
1335         }
1336
1337         bootstrap_ca_cert = false;
1338     }
1339     ca_cert.read = true;
1340 }
1341
1342 /* Sets 'file_name' as the name of the file from which to read the CA
1343  * certificate used to verify the peer within SSL connections.  If 'bootstrap'
1344  * is false, the file must exist.  If 'bootstrap' is false, then the file is
1345  * read if it is exists; if it does not, then it will be created from the CA
1346  * certificate received from the peer on the first SSL connection. */
1347 void
1348 stream_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
1349 {
1350     stream_ssl_set_ca_cert_file__(file_name, bootstrap, false);
1351 }
1352 \f
1353 /* SSL protocol logging. */
1354
1355 static const char *
1356 ssl_alert_level_to_string(uint8_t type)
1357 {
1358     switch (type) {
1359     case 1: return "warning";
1360     case 2: return "fatal";
1361     default: return "<unknown>";
1362     }
1363 }
1364
1365 static const char *
1366 ssl_alert_description_to_string(uint8_t type)
1367 {
1368     switch (type) {
1369     case 0: return "close_notify";
1370     case 10: return "unexpected_message";
1371     case 20: return "bad_record_mac";
1372     case 21: return "decryption_failed";
1373     case 22: return "record_overflow";
1374     case 30: return "decompression_failure";
1375     case 40: return "handshake_failure";
1376     case 42: return "bad_certificate";
1377     case 43: return "unsupported_certificate";
1378     case 44: return "certificate_revoked";
1379     case 45: return "certificate_expired";
1380     case 46: return "certificate_unknown";
1381     case 47: return "illegal_parameter";
1382     case 48: return "unknown_ca";
1383     case 49: return "access_denied";
1384     case 50: return "decode_error";
1385     case 51: return "decrypt_error";
1386     case 60: return "export_restriction";
1387     case 70: return "protocol_version";
1388     case 71: return "insufficient_security";
1389     case 80: return "internal_error";
1390     case 90: return "user_canceled";
1391     case 100: return "no_renegotiation";
1392     default: return "<unknown>";
1393     }
1394 }
1395
1396 static const char *
1397 ssl_handshake_type_to_string(uint8_t type)
1398 {
1399     switch (type) {
1400     case 0: return "hello_request";
1401     case 1: return "client_hello";
1402     case 2: return "server_hello";
1403     case 11: return "certificate";
1404     case 12: return "server_key_exchange";
1405     case 13: return "certificate_request";
1406     case 14: return "server_hello_done";
1407     case 15: return "certificate_verify";
1408     case 16: return "client_key_exchange";
1409     case 20: return "finished";
1410     default: return "<unknown>";
1411     }
1412 }
1413
1414 static void
1415 ssl_protocol_cb(int write_p, int version OVS_UNUSED, int content_type,
1416                 const void *buf_, size_t len, SSL *ssl OVS_UNUSED, void *sslv_)
1417 {
1418     const struct ssl_stream *sslv = sslv_;
1419     const uint8_t *buf = buf_;
1420     struct ds details;
1421
1422     if (!VLOG_IS_DBG_ENABLED()) {
1423         return;
1424     }
1425
1426     ds_init(&details);
1427     if (content_type == 20) {
1428         ds_put_cstr(&details, "change_cipher_spec");
1429     } else if (content_type == 21) {
1430         ds_put_format(&details, "alert: %s, %s",
1431                       ssl_alert_level_to_string(buf[0]),
1432                       ssl_alert_description_to_string(buf[1]));
1433     } else if (content_type == 22) {
1434         ds_put_format(&details, "handshake: %s",
1435                       ssl_handshake_type_to_string(buf[0]));
1436     } else {
1437         ds_put_format(&details, "type %d", content_type);
1438     }
1439
1440     VLOG_DBG("%s%u%s%s %s (%"PRIuSIZE" bytes)",
1441              sslv->type == CLIENT ? "client" : "server",
1442              sslv->session_nr, write_p ? "-->" : "<--",
1443              stream_get_name(&sslv->stream), ds_cstr(&details), len);
1444
1445     ds_destroy(&details);
1446 }
1447
1448 static void
1449 clear_handle(int fd OVS_UNUSED, HANDLE wevent OVS_UNUSED)
1450 {
1451 #ifdef _WIN32
1452     if (fd) {
1453         WSAEventSelect(fd, NULL, 0);
1454     }
1455     if (wevent) {
1456         CloseHandle(wevent);
1457     }
1458 #endif
1459 }