lib/stream-ssl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   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 <assert.h>
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <inttypes.h>
  24 #include <string.h>
  25 #include <netinet/tcp.h>
  26 #include <openssl/err.h>
  27 #include <openssl/ssl.h>
  28 #include <openssl/x509v3.h>
  29 #include <poll.h>
  30 #include <sys/fcntl.h>
  31 #include <sys/stat.h>
  32 #include <unistd.h>
  33 #include "dynamic-string.h"
  34 #include "leak-checker.h"
  35 #include "ofpbuf.h"
  36 #include "openflow/openflow.h"
  37 #include "packets.h"
  38 #include "poll-loop.h"
  39 #include "socket-util.h"
  40 #include "socket-util.h"
  41 #include "util.h"
  42 #include "stream-provider.h"
  43 #include "stream.h"
  44
  45 #include "vlog.h"
  46 #define THIS_MODULE VLM_stream_ssl
  47
  48 /* Active SSL. */
  49
  50 enum ssl_state {
  51     STATE_TCP_CONNECTING,
  52     STATE_SSL_CONNECTING
  53 };
  54
  55 enum session_type {
  56     CLIENT,
  57     SERVER
  58 };
  59
  60 struct ssl_stream
  61 {
  62     struct stream stream;
  63     enum ssl_state state;
  64     int connect_error;
  65     enum session_type type;
  66     int fd;
  67     SSL *ssl;
  68     struct ofpbuf *txbuf;
  69
  70     /* rx_want and tx_want record the result of the last call to SSL_read()
  71      * and SSL_write(), respectively:
  72      *
  73      *    - If the call reported that data needed to be read from the file
  74      *      descriptor, the corresponding member is set to SSL_READING.
  75      *
  76      *    - If the call reported that data needed to be written to the file
  77      *      descriptor, the corresponding member is set to SSL_WRITING.
  78      *
  79      *    - Otherwise, the member is set to SSL_NOTHING, indicating that the
  80      *      call completed successfully (or with an error) and that there is no
  81      *      need to block.
  82      *
  83      * These are needed because there is no way to ask OpenSSL what a data read
  84      * or write would require without giving it a buffer to receive into or
  85      * data to send, respectively.  (Note that the SSL_want() status is
  86      * overwritten by each SSL_read() or SSL_write() call, so we can't rely on
  87      * its value.)
  88      *
  89      * A single call to SSL_read() or SSL_write() can perform both reading
  90      * and writing and thus invalidate not one of these values but actually
  91      * both.  Consider this situation, for example:
  92      *
  93      *    - SSL_write() blocks on a read, so tx_want gets SSL_READING.
  94      *
  95      *    - SSL_read() laters succeeds reading from 'fd' and clears out the
  96      *      whole receive buffer, so rx_want gets SSL_READING.
  97      *
  98      *    - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
  99      *      and blocks.
 100      *
 101      *    - Now we're stuck blocking until the peer sends us data, even though
 102      *      SSL_write() could now succeed, which could easily be a deadlock
 103      *      condition.
 104      *
 105      * On the other hand, we can't reset both tx_want and rx_want on every call
 106      * to SSL_read() or SSL_write(), because that would produce livelock,
 107      * e.g. in this situation:
 108      *
 109      *    - SSL_write() blocks, so tx_want gets SSL_READING or SSL_WRITING.
 110      *
 111      *    - SSL_read() blocks, so rx_want gets SSL_READING or SSL_WRITING,
 112      *      but tx_want gets reset to SSL_NOTHING.
 113      *
 114      *    - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
 115      *      and blocks.
 116      *
 117      *    - Client wakes up immediately since SSL_NOTHING in tx_want indicates
 118      *      that no blocking is necessary.
 119      *
 120      * The solution we adopt here is to set tx_want to SSL_NOTHING after
 121      * calling SSL_read() only if the SSL state of the connection changed,
 122      * which indicates that an SSL-level renegotiation made some progress, and
 123      * similarly for rx_want and SSL_write().  This prevents both the
 124      * deadlock and livelock situations above.
 125      */
 126     int rx_want, tx_want;
 127 };
 128
 129 /* SSL context created by ssl_init(). */
 130 static SSL_CTX *ctx;
 131
 132 /* Required configuration. */
 133 static bool has_private_key, has_certificate, has_ca_cert;
 134
 135 /* Ordinarily, we require a CA certificate for the peer to be locally
 136  * available.  'has_ca_cert' is true when this is the case, and neither of the
 137  * following variables matter.
 138  *
 139  * We can, however, bootstrap the CA certificate from the peer at the beginning
 140  * of our first connection then use that certificate on all subsequent
 141  * connections, saving it to a file for use in future runs also.  In this case,
 142  * 'has_ca_cert' is false, 'bootstrap_ca_cert' is true, and 'ca_cert_file'
 143  * names the file to be saved. */
 144 static bool bootstrap_ca_cert;
 145 static char *ca_cert_file;
 146
 147 /* Who knows what can trigger various SSL errors, so let's throttle them down
 148  * quite a bit. */
 149 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
 150
 151 static int ssl_init(void);
 152 static int do_ssl_init(void);
 153 static bool ssl_wants_io(int ssl_error);
 154 static void ssl_close(struct stream *);
 155 static void ssl_clear_txbuf(struct ssl_stream *);
 156 static int interpret_ssl_error(const char *function, int ret, int error,
 157                                int *want);
 158 static DH *tmp_dh_callback(SSL *ssl, int is_export OVS_UNUSED, int keylength);
 159 static void log_ca_cert(const char *file_name, X509 *cert);
 160
 161 static short int
 162 want_to_poll_events(int want)
 163 {
 164     switch (want) {
 165     case SSL_NOTHING:
 166         NOT_REACHED();
 167
 168     case SSL_READING:
 169         return POLLIN;
 170
 171     case SSL_WRITING:
 172         return POLLOUT;
 173
 174     default:
 175         NOT_REACHED();
 176     }
 177 }
 178
 179 static int
 180 new_ssl_stream(const char *name, int fd, enum session_type type,
 181               enum ssl_state state, const struct sockaddr_in *remote,
 182               struct stream **streamp)
 183 {
 184     struct sockaddr_in local;
 185     socklen_t local_len = sizeof local;
 186     struct ssl_stream *sslv;
 187     SSL *ssl = NULL;
 188     int on = 1;
 189     int retval;
 190
 191     /* Check for all the needful configuration. */
 192     retval = 0;
 193     if (!has_private_key) {
 194         VLOG_ERR("Private key must be configured to use SSL");
 195         retval = ENOPROTOOPT;
 196     }
 197     if (!has_certificate) {
 198         VLOG_ERR("Certificate must be configured to use SSL");
 199         retval = ENOPROTOOPT;
 200     }
 201     if (!has_ca_cert && !bootstrap_ca_cert) {
 202         VLOG_ERR("CA certificate must be configured to use SSL");
 203         retval = ENOPROTOOPT;
 204     }
 205     if (!SSL_CTX_check_private_key(ctx)) {
 206         VLOG_ERR("Private key does not match certificate public key: %s",
 207                  ERR_error_string(ERR_get_error(), NULL));
 208         retval = ENOPROTOOPT;
 209     }
 210     if (retval) {
 211         goto error;
 212     }
 213
 214     /* Get the local IP and port information */
 215     retval = getsockname(fd, (struct sockaddr *) &local, &local_len);
 216     if (retval) {
 217         memset(&local, 0, sizeof local);
 218     }
 219
 220     /* Disable Nagle. */
 221     retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
 222     if (retval) {
 223         VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
 224         retval = errno;
 225         goto error;
 226     }
 227
 228     /* Create and configure OpenSSL stream. */
 229     ssl = SSL_new(ctx);
 230     if (ssl == NULL) {
 231         VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
 232         retval = ENOPROTOOPT;
 233         goto error;
 234     }
 235     if (SSL_set_fd(ssl, fd) == 0) {
 236         VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
 237         retval = ENOPROTOOPT;
 238         goto error;
 239     }
 240     if (bootstrap_ca_cert && type == CLIENT) {
 241         SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL);
 242     }
 243
 244     /* Create and return the ssl_stream. */
 245     sslv = xmalloc(sizeof *sslv);
 246     stream_init(&sslv->stream, &ssl_stream_class, EAGAIN, name);
 247     stream_set_remote_ip(&sslv->stream, remote->sin_addr.s_addr);
 248     stream_set_remote_port(&sslv->stream, remote->sin_port);
 249     stream_set_local_ip(&sslv->stream, local.sin_addr.s_addr);
 250     stream_set_local_port(&sslv->stream, local.sin_port);
 251     sslv->state = state;
 252     sslv->type = type;
 253     sslv->fd = fd;
 254     sslv->ssl = ssl;
 255     sslv->txbuf = NULL;
 256     sslv->rx_want = sslv->tx_want = SSL_NOTHING;
 257     *streamp = &sslv->stream;
 258     return 0;
 259
 260 error:
 261     if (ssl) {
 262         SSL_free(ssl);
 263     }
 264     close(fd);
 265     return retval;
 266 }
 267
 268 static struct ssl_stream *
 269 ssl_stream_cast(struct stream *stream)
 270 {
 271     stream_assert_class(stream, &ssl_stream_class);
 272     return CONTAINER_OF(stream, struct ssl_stream, stream);
 273 }
 274
 275 static int
 276 ssl_open(const char *name, char *suffix, struct stream **streamp)
 277 {
 278     struct sockaddr_in sin;
 279     int error, fd;
 280
 281     error = ssl_init();
 282     if (error) {
 283         return error;
 284     }
 285
 286     error = inet_open_active(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin, &fd);
 287     if (fd >= 0) {
 288         int state = error ? STATE_TCP_CONNECTING : STATE_SSL_CONNECTING;
 289         return new_ssl_stream(name, fd, CLIENT, state, &sin, streamp);
 290     } else {
 291         VLOG_ERR("%s: connect: %s", name, strerror(error));
 292         return error;
 293     }
 294 }
 295
 296 static int
 297 do_ca_cert_bootstrap(struct stream *stream)
 298 {
 299     struct ssl_stream *sslv = ssl_stream_cast(stream);
 300     STACK_OF(X509) *chain;
 301     X509 *ca_cert;
 302     FILE *file;
 303     int error;
 304     int fd;
 305
 306     chain = SSL_get_peer_cert_chain(sslv->ssl);
 307     if (!chain || !sk_X509_num(chain)) {
 308         VLOG_ERR("could not bootstrap CA cert: no certificate presented by "
 309                  "peer");
 310         return EPROTO;
 311     }
 312     ca_cert = sk_X509_value(chain, sk_X509_num(chain) - 1);
 313
 314     /* Check that 'ca_cert' is self-signed.  Otherwise it is not a CA
 315      * certificate and we should not attempt to use it as one. */
 316     error = X509_check_issued(ca_cert, ca_cert);
 317     if (error) {
 318         VLOG_ERR("could not bootstrap CA cert: obtained certificate is "
 319                  "not self-signed (%s)",
 320                  X509_verify_cert_error_string(error));
 321         if (sk_X509_num(chain) < 2) {
 322             VLOG_ERR("only one certificate was received, so probably the peer "
 323                      "is not configured to send its CA certificate");
 324         }
 325         return EPROTO;
 326     }
 327
 328     fd = open(ca_cert_file, O_CREAT | O_EXCL | O_WRONLY, 0444);
 329     if (fd < 0) {
 330         if (errno == EEXIST) {
 331             VLOG_INFO("reading CA cert %s created by another process",
 332                       ca_cert_file);
 333             stream_ssl_set_ca_cert_file(ca_cert_file, true);
 334             return EPROTO;
 335         } else {
 336             VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
 337                      ca_cert_file, strerror(errno));
 338             return errno;
 339         }
 340     }
 341
 342     file = fdopen(fd, "w");
 343     if (!file) {
 344         int error = errno;
 345         VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
 346                  strerror(error));
 347         unlink(ca_cert_file);
 348         return error;
 349     }
 350
 351     if (!PEM_write_X509(file, ca_cert)) {
 352         VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
 353                  "%s", ca_cert_file, ERR_error_string(ERR_get_error(), NULL));
 354         fclose(file);
 355         unlink(ca_cert_file);
 356         return EIO;
 357     }
 358
 359     if (fclose(file)) {
 360         int error = errno;
 361         VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
 362                  ca_cert_file, strerror(error));
 363         unlink(ca_cert_file);
 364         return error;
 365     }
 366
 367     VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert_file);
 368     log_ca_cert(ca_cert_file, ca_cert);
 369     bootstrap_ca_cert = false;
 370     has_ca_cert = true;
 371
 372     /* SSL_CTX_add_client_CA makes a copy of ca_cert's relevant data. */
 373     SSL_CTX_add_client_CA(ctx, ca_cert);
 374
 375     /* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
 376      * 'ca_cert' is owned by sslv->ssl, so we need to duplicate it. */
 377     ca_cert = X509_dup(ca_cert);
 378     if (!ca_cert) {
 379         out_of_memory();
 380     }
 381     if (SSL_CTX_load_verify_locations(ctx, ca_cert_file, NULL) != 1) {
 382         VLOG_ERR("SSL_CTX_load_verify_locations: %s",
 383                  ERR_error_string(ERR_get_error(), NULL));
 384         return EPROTO;
 385     }
 386     VLOG_INFO("killing successful connection to retry using CA cert");
 387     return EPROTO;
 388 }
 389
 390 static int
 391 ssl_connect(struct stream *stream)
 392 {
 393     struct ssl_stream *sslv = ssl_stream_cast(stream);
 394     int retval;
 395
 396     switch (sslv->state) {
 397     case STATE_TCP_CONNECTING:
 398         retval = check_connection_completion(sslv->fd);
 399         if (retval) {
 400             return retval;
 401         }
 402         sslv->state = STATE_SSL_CONNECTING;
 403         /* Fall through. */
 404
 405     case STATE_SSL_CONNECTING:
 406         retval = (sslv->type == CLIENT
 407                    ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
 408         if (retval != 1) {
 409             int error = SSL_get_error(sslv->ssl, retval);
 410             if (retval < 0 && ssl_wants_io(error)) {
 411                 return EAGAIN;
 412             } else {
 413                 int unused;
 414                 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
 415                                      : "SSL_accept"), retval, error, &unused);
 416                 shutdown(sslv->fd, SHUT_RDWR);
 417                 return EPROTO;
 418             }
 419         } else if (bootstrap_ca_cert) {
 420             return do_ca_cert_bootstrap(stream);
 421         } else if ((SSL_get_verify_mode(sslv->ssl)
 422                     & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
 423                    != SSL_VERIFY_PEER) {
 424             /* Two or more SSL connections completed at the same time while we
 425              * were in bootstrap mode.  Only one of these can finish the
 426              * bootstrap successfully.  The other one(s) must be rejected
 427              * because they were not verified against the bootstrapped CA
 428              * certificate.  (Alternatively we could verify them against the CA
 429              * certificate, but that's more trouble than it's worth.  These
 430              * connections will succeed the next time they retry, assuming that
 431              * they have a certificate against the correct CA.) */
 432             VLOG_ERR("rejecting SSL connection during bootstrap race window");
 433             return EPROTO;
 434         } else {
 435             return 0;
 436         }
 437     }
 438
 439     NOT_REACHED();
 440 }
 441
 442 static void
 443 ssl_close(struct stream *stream)
 444 {
 445     struct ssl_stream *sslv = ssl_stream_cast(stream);
 446     ssl_clear_txbuf(sslv);
 447
 448     /* Attempt clean shutdown of the SSL connection.  This will work most of
 449      * the time, as long as the kernel send buffer has some free space and the
 450      * SSL connection isn't renegotiating, etc.  That has to be good enough,
 451      * since we don't have any way to continue the close operation in the
 452      * background. */
 453     SSL_shutdown(sslv->ssl);
 454
 455     SSL_free(sslv->ssl);
 456     close(sslv->fd);
 457     free(sslv);
 458 }
 459
 460 static int
 461 interpret_ssl_error(const char *function, int ret, int error,
 462                     int *want)
 463 {
 464     *want = SSL_NOTHING;
 465
 466     switch (error) {
 467     case SSL_ERROR_NONE:
 468         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_NONE", function);
 469         break;
 470
 471     case SSL_ERROR_ZERO_RETURN:
 472         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_ZERO_RETURN", function);
 473         break;
 474
 475     case SSL_ERROR_WANT_READ:
 476         *want = SSL_READING;
 477         return EAGAIN;
 478
 479     case SSL_ERROR_WANT_WRITE:
 480         *want = SSL_WRITING;
 481         return EAGAIN;
 482
 483     case SSL_ERROR_WANT_CONNECT:
 484         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_CONNECT", function);
 485         break;
 486
 487     case SSL_ERROR_WANT_ACCEPT:
 488         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
 489         break;
 490
 491     case SSL_ERROR_WANT_X509_LOOKUP:
 492         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP",
 493                     function);
 494         break;
 495
 496     case SSL_ERROR_SYSCALL: {
 497         int queued_error = ERR_get_error();
 498         if (queued_error == 0) {
 499             if (ret < 0) {
 500                 int status = errno;
 501                 VLOG_WARN_RL(&rl, "%s: system error (%s)",
 502                              function, strerror(status));
 503                 return status;
 504             } else {
 505                 VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close",
 506                              function);
 507                 return EPROTO;
 508             }
 509         } else {
 510             VLOG_WARN_RL(&rl, "%s: %s",
 511                          function, ERR_error_string(queued_error, NULL));
 512             break;
 513         }
 514     }
 515
 516     case SSL_ERROR_SSL: {
 517         int queued_error = ERR_get_error();
 518         if (queued_error != 0) {
 519             VLOG_WARN_RL(&rl, "%s: %s",
 520                          function, ERR_error_string(queued_error, NULL));
 521         } else {
 522             VLOG_ERR_RL(&rl, "%s: SSL_ERROR_SSL without queued error",
 523                         function);
 524         }
 525         break;
 526     }
 527
 528     default:
 529         VLOG_ERR_RL(&rl, "%s: bad SSL error code %d", function, error);
 530         break;
 531     }
 532     return EIO;
 533 }
 534
 535 static ssize_t
 536 ssl_recv(struct stream *stream, void *buffer, size_t n)
 537 {
 538     struct ssl_stream *sslv = ssl_stream_cast(stream);
 539     int old_state;
 540     ssize_t ret;
 541
 542     /* Behavior of zero-byte SSL_read is poorly defined. */
 543     assert(n > 0);
 544
 545     old_state = SSL_get_state(sslv->ssl);
 546     ret = SSL_read(sslv->ssl, buffer, n);
 547     if (old_state != SSL_get_state(sslv->ssl)) {
 548         sslv->tx_want = SSL_NOTHING;
 549     }
 550     sslv->rx_want = SSL_NOTHING;
 551
 552     if (ret > 0) {
 553         return ret;
 554     } else {
 555         int error = SSL_get_error(sslv->ssl, ret);
 556         if (error == SSL_ERROR_ZERO_RETURN) {
 557             return 0;
 558         } else {
 559             return -interpret_ssl_error("SSL_read", ret, error,
 560                                         &sslv->rx_want);
 561         }
 562     }
 563 }
 564
 565 static void
 566 ssl_clear_txbuf(struct ssl_stream *sslv)
 567 {
 568     ofpbuf_delete(sslv->txbuf);
 569     sslv->txbuf = NULL;
 570 }
 571
 572 static int
 573 ssl_do_tx(struct stream *stream)
 574 {
 575     struct ssl_stream *sslv = ssl_stream_cast(stream);
 576
 577     for (;;) {
 578         int old_state = SSL_get_state(sslv->ssl);
 579         int ret = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
 580         if (old_state != SSL_get_state(sslv->ssl)) {
 581             sslv->rx_want = SSL_NOTHING;
 582         }
 583         sslv->tx_want = SSL_NOTHING;
 584         if (ret > 0) {
 585             ofpbuf_pull(sslv->txbuf, ret);
 586             if (sslv->txbuf->size == 0) {
 587                 return 0;
 588             }
 589         } else {
 590             int ssl_error = SSL_get_error(sslv->ssl, ret);
 591             if (ssl_error == SSL_ERROR_ZERO_RETURN) {
 592                 VLOG_WARN_RL(&rl, "SSL_write: connection closed");
 593                 return EPIPE;
 594             } else {
 595                 return interpret_ssl_error("SSL_write", ret, ssl_error,
 596                                            &sslv->tx_want);
 597             }
 598         }
 599     }
 600 }
 601
 602 static ssize_t
 603 ssl_send(struct stream *stream, const void *buffer, size_t n)
 604 {
 605     struct ssl_stream *sslv = ssl_stream_cast(stream);
 606
 607     if (sslv->txbuf) {
 608         return -EAGAIN;
 609     } else {
 610         int error;
 611
 612         sslv->txbuf = ofpbuf_clone_data(buffer, n);
 613         error = ssl_do_tx(stream);
 614         switch (error) {
 615         case 0:
 616             ssl_clear_txbuf(sslv);
 617             return n;
 618         case EAGAIN:
 619             leak_checker_claim(buffer);
 620             return n;
 621         default:
 622             sslv->txbuf = NULL;
 623             return -error;
 624         }
 625     }
 626 }
 627
 628 static void
 629 ssl_run(struct stream *stream)
 630 {
 631     struct ssl_stream *sslv = ssl_stream_cast(stream);
 632
 633     if (sslv->txbuf && ssl_do_tx(stream) != EAGAIN) {
 634         ssl_clear_txbuf(sslv);
 635     }
 636 }
 637
 638 static void
 639 ssl_run_wait(struct stream *stream)
 640 {
 641     struct ssl_stream *sslv = ssl_stream_cast(stream);
 642
 643     if (sslv->tx_want != SSL_NOTHING) {
 644         poll_fd_wait(sslv->fd, want_to_poll_events(sslv->tx_want));
 645     }
 646 }
 647
 648 static void
 649 ssl_wait(struct stream *stream, enum stream_wait_type wait)
 650 {
 651     struct ssl_stream *sslv = ssl_stream_cast(stream);
 652
 653     switch (wait) {
 654     case STREAM_CONNECT:
 655         if (stream_connect(stream) != EAGAIN) {
 656             poll_immediate_wake();
 657         } else {
 658             switch (sslv->state) {
 659             case STATE_TCP_CONNECTING:
 660                 poll_fd_wait(sslv->fd, POLLOUT);
 661                 break;
 662
 663             case STATE_SSL_CONNECTING:
 664                 /* ssl_connect() called SSL_accept() or SSL_connect(), which
 665                  * set up the status that we test here. */
 666                 poll_fd_wait(sslv->fd,
 667                              want_to_poll_events(SSL_want(sslv->ssl)));
 668                 break;
 669
 670             default:
 671                 NOT_REACHED();
 672             }
 673         }
 674         break;
 675
 676     case STREAM_RECV:
 677         if (sslv->rx_want != SSL_NOTHING) {
 678             poll_fd_wait(sslv->fd, want_to_poll_events(sslv->rx_want));
 679         } else {
 680             poll_immediate_wake();
 681         }
 682         break;
 683
 684     case STREAM_SEND:
 685         if (!sslv->txbuf) {
 686             /* We have room in our tx queue. */
 687             poll_immediate_wake();
 688         } else {
 689             /* stream_run_wait() will do the right thing; don't bother with
 690              * redundancy. */
 691         }
 692         break;
 693
 694     default:
 695         NOT_REACHED();
 696     }
 697 }
 698
 699 struct stream_class ssl_stream_class = {
 700     "ssl",                      /* name */
 701     ssl_open,                   /* open */
 702     ssl_close,                  /* close */
 703     ssl_connect,                /* connect */
 704     ssl_recv,                   /* recv */
 705     ssl_send,                   /* send */
 706     ssl_run,                    /* run */
 707     ssl_run_wait,               /* run_wait */
 708     ssl_wait,                   /* wait */
 709 };
 710 \f
 711 /* Passive SSL. */
 712
 713 struct pssl_pstream
 714 {
 715     struct pstream pstream;
 716     int fd;
 717 };
 718
 719 struct pstream_class pssl_pstream_class;
 720
 721 static struct pssl_pstream *
 722 pssl_pstream_cast(struct pstream *pstream)
 723 {
 724     pstream_assert_class(pstream, &pssl_pstream_class);
 725     return CONTAINER_OF(pstream, struct pssl_pstream, pstream);
 726 }
 727
 728 static int
 729 pssl_open(const char *name OVS_UNUSED, char *suffix, struct pstream **pstreamp)
 730 {
 731     struct pssl_pstream *pssl;
 732     struct sockaddr_in sin;
 733     char bound_name[128];
 734     int retval;
 735     int fd;
 736
 737     retval = ssl_init();
 738     if (retval) {
 739         return retval;
 740     }
 741
 742     fd = inet_open_passive(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin);
 743     if (fd < 0) {
 744         return -fd;
 745     }
 746     sprintf(bound_name, "pssl:%"PRIu16":"IP_FMT,
 747             ntohs(sin.sin_port), IP_ARGS(&sin.sin_addr.s_addr));
 748
 749     pssl = xmalloc(sizeof *pssl);
 750     pstream_init(&pssl->pstream, &pssl_pstream_class, bound_name);
 751     pssl->fd = fd;
 752     *pstreamp = &pssl->pstream;
 753     return 0;
 754 }
 755
 756 static void
 757 pssl_close(struct pstream *pstream)
 758 {
 759     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 760     close(pssl->fd);
 761     free(pssl);
 762 }
 763
 764 static int
 765 pssl_accept(struct pstream *pstream, struct stream **new_streamp)
 766 {
 767     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 768     struct sockaddr_in sin;
 769     socklen_t sin_len = sizeof sin;
 770     char name[128];
 771     int new_fd;
 772     int error;
 773
 774     new_fd = accept(pssl->fd, &sin, &sin_len);
 775     if (new_fd < 0) {
 776         int error = errno;
 777         if (error != EAGAIN) {
 778             VLOG_DBG_RL(&rl, "accept: %s", strerror(error));
 779         }
 780         return error;
 781     }
 782
 783     error = set_nonblocking(new_fd);
 784     if (error) {
 785         close(new_fd);
 786         return error;
 787     }
 788
 789     sprintf(name, "ssl:"IP_FMT, IP_ARGS(&sin.sin_addr));
 790     if (sin.sin_port != htons(OFP_SSL_PORT)) {
 791         sprintf(strchr(name, '\0'), ":%"PRIu16, ntohs(sin.sin_port));
 792     }
 793     return new_ssl_stream(name, new_fd, SERVER, STATE_SSL_CONNECTING, &sin,
 794                          new_streamp);
 795 }
 796
 797 static void
 798 pssl_wait(struct pstream *pstream)
 799 {
 800     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 801     poll_fd_wait(pssl->fd, POLLIN);
 802 }
 803
 804 struct pstream_class pssl_pstream_class = {
 805     "pssl",
 806     pssl_open,
 807     pssl_close,
 808     pssl_accept,
 809     pssl_wait,
 810 };
 811 \f
 812 /*
 813  * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
 814  * OpenSSL is requesting that we call it back when the socket is ready for read
 815  * or writing, respectively.
 816  */
 817 static bool
 818 ssl_wants_io(int ssl_error)
 819 {
 820     return (ssl_error == SSL_ERROR_WANT_WRITE
 821             || ssl_error == SSL_ERROR_WANT_READ);
 822 }
 823
 824 static int
 825 ssl_init(void)
 826 {
 827     static int init_status = -1;
 828     if (init_status < 0) {
 829         init_status = do_ssl_init();
 830         assert(init_status >= 0);
 831     }
 832     return init_status;
 833 }
 834
 835 static int
 836 do_ssl_init(void)
 837 {
 838     SSL_METHOD *method;
 839
 840     SSL_library_init();
 841     SSL_load_error_strings();
 842
 843     method = TLSv1_method();
 844     if (method == NULL) {
 845         VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
 846         return ENOPROTOOPT;
 847     }
 848
 849     ctx = SSL_CTX_new(method);
 850     if (ctx == NULL) {
 851         VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
 852         return ENOPROTOOPT;
 853     }
 854     SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
 855     SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
 856     SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 857     SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
 858     SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
 859                        NULL);
 860
 861     return 0;
 862 }
 863
 864 static DH *
 865 tmp_dh_callback(SSL *ssl OVS_UNUSED, int is_export OVS_UNUSED, int keylength)
 866 {
 867     struct dh {
 868         int keylength;
 869         DH *dh;
 870         DH *(*constructor)(void);
 871     };
 872
 873     static struct dh dh_table[] = {
 874         {1024, NULL, get_dh1024},
 875         {2048, NULL, get_dh2048},
 876         {4096, NULL, get_dh4096},
 877     };
 878
 879     struct dh *dh;
 880
 881     for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
 882         if (dh->keylength == keylength) {
 883             if (!dh->dh) {
 884                 dh->dh = dh->constructor();
 885                 if (!dh->dh) {
 886                     ovs_fatal(ENOMEM, "out of memory constructing "
 887                               "Diffie-Hellman parameters");
 888                 }
 889             }
 890             return dh->dh;
 891         }
 892     }
 893     VLOG_ERR_RL(&rl, "no Diffie-Hellman parameters for key length %d",
 894                 keylength);
 895     return NULL;
 896 }
 897
 898 /* Returns true if SSL is at least partially configured. */
 899 bool
 900 stream_ssl_is_configured(void)
 901 {
 902     return has_private_key || has_certificate || has_ca_cert;
 903 }
 904
 905 void
 906 stream_ssl_set_private_key_file(const char *file_name)
 907 {
 908     if (ssl_init()) {
 909         return;
 910     }
 911     if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
 912         VLOG_ERR("SSL_use_PrivateKey_file: %s",
 913                  ERR_error_string(ERR_get_error(), NULL));
 914         return;
 915     }
 916     has_private_key = true;
 917 }
 918
 919 void
 920 stream_ssl_set_certificate_file(const char *file_name)
 921 {
 922     if (ssl_init()) {
 923         return;
 924     }
 925     if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
 926         VLOG_ERR("SSL_use_certificate_file: %s",
 927                  ERR_error_string(ERR_get_error(), NULL));
 928         return;
 929     }
 930     has_certificate = true;
 931 }
 932
 933 /* Reads the X509 certificate or certificates in file 'file_name'.  On success,
 934  * stores the address of the first element in an array of pointers to
 935  * certificates in '*certs' and the number of certificates in the array in
 936  * '*n_certs', and returns 0.  On failure, stores a null pointer in '*certs', 0
 937  * in '*n_certs', and returns a positive errno value.
 938  *
 939  * The caller is responsible for freeing '*certs'. */
 940 static int
 941 read_cert_file(const char *file_name, X509 ***certs, size_t *n_certs)
 942 {
 943     FILE *file;
 944     size_t allocated_certs = 0;
 945
 946     *certs = NULL;
 947     *n_certs = 0;
 948
 949     file = fopen(file_name, "r");
 950     if (!file) {
 951         VLOG_ERR("failed to open %s for reading: %s",
 952                  file_name, strerror(errno));
 953         return errno;
 954     }
 955
 956     for (;;) {
 957         X509 *certificate;
 958         int c;
 959
 960         /* Read certificate from file. */
 961         certificate = PEM_read_X509(file, NULL, NULL, NULL);
 962         if (!certificate) {
 963             size_t i;
 964
 965             VLOG_ERR("PEM_read_X509 failed reading %s: %s",
 966                      file_name, ERR_error_string(ERR_get_error(), NULL));
 967             for (i = 0; i < *n_certs; i++) {
 968                 X509_free((*certs)[i]);
 969             }
 970             free(*certs);
 971             *certs = NULL;
 972             *n_certs = 0;
 973             return EIO;
 974         }
 975
 976         /* Add certificate to array. */
 977         if (*n_certs >= allocated_certs) {
 978             *certs = x2nrealloc(*certs, &allocated_certs, sizeof **certs);
 979         }
 980         (*certs)[(*n_certs)++] = certificate;
 981
 982         /* Are there additional certificates in the file? */
 983         do {
 984             c = getc(file);
 985         } while (isspace(c));
 986         if (c == EOF) {
 987             break;
 988         }
 989         ungetc(c, file);
 990     }
 991     fclose(file);
 992     return 0;
 993 }
 994
 995
 996 /* Sets 'file_name' as the name of a file containing one or more X509
 997  * certificates to send to the peer.  Typical use in OpenFlow is to send the CA
 998  * certificate to the peer, which enables a switch to pick up the controller's
 999  * CA certificate on its first connection. */
1000 void
1001 stream_ssl_set_peer_ca_cert_file(const char *file_name)
1002 {
1003     X509 **certs;
1004     size_t n_certs;
1005     size_t i;
1006
1007     if (ssl_init()) {
1008         return;
1009     }
1010
1011     if (!read_cert_file(file_name, &certs, &n_certs)) {
1012         for (i = 0; i < n_certs; i++) {
1013             if (SSL_CTX_add_extra_chain_cert(ctx, certs[i]) != 1) {
1014                 VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s",
1015                          ERR_error_string(ERR_get_error(), NULL));
1016             }
1017         }
1018         free(certs);
1019     }
1020 }
1021
1022 /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */
1023 static void
1024 log_ca_cert(const char *file_name, X509 *cert)
1025 {
1026     unsigned char digest[EVP_MAX_MD_SIZE];
1027     unsigned int n_bytes;
1028     struct ds fp;
1029     char *subject;
1030
1031     ds_init(&fp);
1032     if (!X509_digest(cert, EVP_sha1(), digest, &n_bytes)) {
1033         ds_put_cstr(&fp, "<out of memory>");
1034     } else {
1035         unsigned int i;
1036         for (i = 0; i < n_bytes; i++) {
1037             if (i) {
1038                 ds_put_char(&fp, ':');
1039             }
1040             ds_put_format(&fp, "%02hhx", digest[i]);
1041         }
1042     }
1043     subject = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
1044     VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name,
1045               subject ? subject : "<out of memory>", ds_cstr(&fp));
1046     free(subject);
1047     ds_destroy(&fp);
1048 }
1049
1050 /* Sets 'file_name' as the name of the file from which to read the CA
1051  * certificate used to verify the peer within SSL connections.  If 'bootstrap'
1052  * is false, the file must exist.  If 'bootstrap' is false, then the file is
1053  * read if it is exists; if it does not, then it will be created from the CA
1054  * certificate received from the peer on the first SSL connection. */
1055 void
1056 stream_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
1057 {
1058     X509 **certs;
1059     size_t n_certs;
1060     struct stat s;
1061
1062     if (ssl_init()) {
1063         return;
1064     }
1065
1066     if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
1067         bootstrap_ca_cert = true;
1068         ca_cert_file = xstrdup(file_name);
1069     } else if (!read_cert_file(file_name, &certs, &n_certs)) {
1070         size_t i;
1071
1072         /* Set up list of CAs that the server will accept from the client. */
1073         for (i = 0; i < n_certs; i++) {
1074             /* SSL_CTX_add_client_CA makes a copy of the relevant data. */
1075             if (SSL_CTX_add_client_CA(ctx, certs[i]) != 1) {
1076                 VLOG_ERR("failed to add client certificate %d from %s: %s",
1077                          i, file_name,
1078                          ERR_error_string(ERR_get_error(), NULL));
1079             } else {
1080                 log_ca_cert(file_name, certs[i]);
1081             }
1082             X509_free(certs[i]);
1083         }
1084         free(certs);
1085
1086         /* Set up CAs for OpenSSL to trust in verifying the peer's
1087          * certificate. */
1088         if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
1089             VLOG_ERR("SSL_CTX_load_verify_locations: %s",
1090                      ERR_error_string(ERR_get_error(), NULL));
1091             return;
1092         }
1093
1094         has_ca_cert = true;
1095     }
1096 }