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 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         VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
 331                  ca_cert_file, strerror(errno));
 332         return errno;
 333     }
 334
 335     file = fdopen(fd, "w");
 336     if (!file) {
 337         int error = errno;
 338         VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
 339                  strerror(error));
 340         unlink(ca_cert_file);
 341         return error;
 342     }
 343
 344     if (!PEM_write_X509(file, ca_cert)) {
 345         VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
 346                  "%s", ca_cert_file, ERR_error_string(ERR_get_error(), NULL));
 347         fclose(file);
 348         unlink(ca_cert_file);
 349         return EIO;
 350     }
 351
 352     if (fclose(file)) {
 353         int error = errno;
 354         VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
 355                  ca_cert_file, strerror(error));
 356         unlink(ca_cert_file);
 357         return error;
 358     }
 359
 360     VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert_file);
 361     log_ca_cert(ca_cert_file, ca_cert);
 362     bootstrap_ca_cert = false;
 363     has_ca_cert = true;
 364
 365     /* SSL_CTX_add_client_CA makes a copy of ca_cert's relevant data. */
 366     SSL_CTX_add_client_CA(ctx, ca_cert);
 367
 368     /* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
 369      * 'ca_cert' is owned by sslv->ssl, so we need to duplicate it. */
 370     ca_cert = X509_dup(ca_cert);
 371     if (!ca_cert) {
 372         out_of_memory();
 373     }
 374     if (SSL_CTX_load_verify_locations(ctx, ca_cert_file, NULL) != 1) {
 375         VLOG_ERR("SSL_CTX_load_verify_locations: %s",
 376                  ERR_error_string(ERR_get_error(), NULL));
 377         return EPROTO;
 378     }
 379     VLOG_INFO("killing successful connection to retry using CA cert");
 380     return EPROTO;
 381 }
 382
 383 static int
 384 ssl_connect(struct stream *stream)
 385 {
 386     struct ssl_stream *sslv = ssl_stream_cast(stream);
 387     int retval;
 388
 389     switch (sslv->state) {
 390     case STATE_TCP_CONNECTING:
 391         retval = check_connection_completion(sslv->fd);
 392         if (retval) {
 393             return retval;
 394         }
 395         sslv->state = STATE_SSL_CONNECTING;
 396         /* Fall through. */
 397
 398     case STATE_SSL_CONNECTING:
 399         retval = (sslv->type == CLIENT
 400                    ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
 401         if (retval != 1) {
 402             int error = SSL_get_error(sslv->ssl, retval);
 403             if (retval < 0 && ssl_wants_io(error)) {
 404                 return EAGAIN;
 405             } else {
 406                 int unused;
 407                 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
 408                                      : "SSL_accept"), retval, error, &unused);
 409                 shutdown(sslv->fd, SHUT_RDWR);
 410                 return EPROTO;
 411             }
 412         } else if (bootstrap_ca_cert) {
 413             return do_ca_cert_bootstrap(stream);
 414         } else if ((SSL_get_verify_mode(sslv->ssl)
 415                     & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
 416                    != SSL_VERIFY_PEER) {
 417             /* Two or more SSL connections completed at the same time while we
 418              * were in bootstrap mode.  Only one of these can finish the
 419              * bootstrap successfully.  The other one(s) must be rejected
 420              * because they were not verified against the bootstrapped CA
 421              * certificate.  (Alternatively we could verify them against the CA
 422              * certificate, but that's more trouble than it's worth.  These
 423              * connections will succeed the next time they retry, assuming that
 424              * they have a certificate against the correct CA.) */
 425             VLOG_ERR("rejecting SSL connection during bootstrap race window");
 426             return EPROTO;
 427         } else {
 428             return 0;
 429         }
 430     }
 431
 432     NOT_REACHED();
 433 }
 434
 435 static void
 436 ssl_close(struct stream *stream)
 437 {
 438     struct ssl_stream *sslv = ssl_stream_cast(stream);
 439     ssl_clear_txbuf(sslv);
 440
 441     /* Attempt clean shutdown of the SSL connection.  This will work most of
 442      * the time, as long as the kernel send buffer has some free space and the
 443      * SSL connection isn't renegotiating, etc.  That has to be good enough,
 444      * since we don't have any way to continue the close operation in the
 445      * background. */
 446     SSL_shutdown(sslv->ssl);
 447
 448     SSL_free(sslv->ssl);
 449     close(sslv->fd);
 450     free(sslv);
 451 }
 452
 453 static int
 454 interpret_ssl_error(const char *function, int ret, int error,
 455                     int *want)
 456 {
 457     *want = SSL_NOTHING;
 458
 459     switch (error) {
 460     case SSL_ERROR_NONE:
 461         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_NONE", function);
 462         break;
 463
 464     case SSL_ERROR_ZERO_RETURN:
 465         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_ZERO_RETURN", function);
 466         break;
 467
 468     case SSL_ERROR_WANT_READ:
 469         *want = SSL_READING;
 470         return EAGAIN;
 471
 472     case SSL_ERROR_WANT_WRITE:
 473         *want = SSL_WRITING;
 474         return EAGAIN;
 475
 476     case SSL_ERROR_WANT_CONNECT:
 477         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_CONNECT", function);
 478         break;
 479
 480     case SSL_ERROR_WANT_ACCEPT:
 481         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
 482         break;
 483
 484     case SSL_ERROR_WANT_X509_LOOKUP:
 485         VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP",
 486                     function);
 487         break;
 488
 489     case SSL_ERROR_SYSCALL: {
 490         int queued_error = ERR_get_error();
 491         if (queued_error == 0) {
 492             if (ret < 0) {
 493                 int status = errno;
 494                 VLOG_WARN_RL(&rl, "%s: system error (%s)",
 495                              function, strerror(status));
 496                 return status;
 497             } else {
 498                 VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close",
 499                              function);
 500                 return EPROTO;
 501             }
 502         } else {
 503             VLOG_WARN_RL(&rl, "%s: %s",
 504                          function, ERR_error_string(queued_error, NULL));
 505             break;
 506         }
 507     }
 508
 509     case SSL_ERROR_SSL: {
 510         int queued_error = ERR_get_error();
 511         if (queued_error != 0) {
 512             VLOG_WARN_RL(&rl, "%s: %s",
 513                          function, ERR_error_string(queued_error, NULL));
 514         } else {
 515             VLOG_ERR_RL(&rl, "%s: SSL_ERROR_SSL without queued error",
 516                         function);
 517         }
 518         break;
 519     }
 520
 521     default:
 522         VLOG_ERR_RL(&rl, "%s: bad SSL error code %d", function, error);
 523         break;
 524     }
 525     return EIO;
 526 }
 527
 528 static ssize_t
 529 ssl_recv(struct stream *stream, void *buffer, size_t n)
 530 {
 531     struct ssl_stream *sslv = ssl_stream_cast(stream);
 532     int old_state;
 533     ssize_t ret;
 534
 535     /* Behavior of zero-byte SSL_read is poorly defined. */
 536     assert(n > 0);
 537
 538     old_state = SSL_get_state(sslv->ssl);
 539     ret = SSL_read(sslv->ssl, buffer, n);
 540     if (old_state != SSL_get_state(sslv->ssl)) {
 541         sslv->tx_want = SSL_NOTHING;
 542     }
 543     sslv->rx_want = SSL_NOTHING;
 544
 545     if (ret > 0) {
 546         return ret;
 547     } else {
 548         int error = SSL_get_error(sslv->ssl, ret);
 549         if (error == SSL_ERROR_ZERO_RETURN) {
 550             return 0;
 551         } else {
 552             return interpret_ssl_error("SSL_read", ret, error, &sslv->rx_want);
 553         }
 554     }
 555 }
 556
 557 static void
 558 ssl_clear_txbuf(struct ssl_stream *sslv)
 559 {
 560     ofpbuf_delete(sslv->txbuf);
 561     sslv->txbuf = NULL;
 562 }
 563
 564 static int
 565 ssl_do_tx(struct stream *stream)
 566 {
 567     struct ssl_stream *sslv = ssl_stream_cast(stream);
 568
 569     for (;;) {
 570         int old_state = SSL_get_state(sslv->ssl);
 571         int ret = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
 572         if (old_state != SSL_get_state(sslv->ssl)) {
 573             sslv->rx_want = SSL_NOTHING;
 574         }
 575         sslv->tx_want = SSL_NOTHING;
 576         if (ret > 0) {
 577             ofpbuf_pull(sslv->txbuf, ret);
 578             if (sslv->txbuf->size == 0) {
 579                 return 0;
 580             }
 581         } else {
 582             int ssl_error = SSL_get_error(sslv->ssl, ret);
 583             if (ssl_error == SSL_ERROR_ZERO_RETURN) {
 584                 VLOG_WARN_RL(&rl, "SSL_write: connection closed");
 585                 return EPIPE;
 586             } else {
 587                 return interpret_ssl_error("SSL_write", ret, ssl_error,
 588                                            &sslv->tx_want);
 589             }
 590         }
 591     }
 592 }
 593
 594 static ssize_t
 595 ssl_send(struct stream *stream, const void *buffer, size_t n)
 596 {
 597     struct ssl_stream *sslv = ssl_stream_cast(stream);
 598
 599     if (sslv->txbuf) {
 600         return EAGAIN;
 601     } else {
 602         int error;
 603
 604         sslv->txbuf = ofpbuf_clone_data(buffer, n);
 605         error = ssl_do_tx(stream);
 606         switch (error) {
 607         case 0:
 608             ssl_clear_txbuf(sslv);
 609             return 0;
 610         case EAGAIN:
 611             leak_checker_claim(buffer);
 612             return 0;
 613         default:
 614             sslv->txbuf = NULL;
 615             return error;
 616         }
 617     }
 618 }
 619
 620 static void
 621 ssl_run(struct stream *stream)
 622 {
 623     struct ssl_stream *sslv = ssl_stream_cast(stream);
 624
 625     if (sslv->txbuf && ssl_do_tx(stream) != EAGAIN) {
 626         ssl_clear_txbuf(sslv);
 627     }
 628 }
 629
 630 static void
 631 ssl_run_wait(struct stream *stream)
 632 {
 633     struct ssl_stream *sslv = ssl_stream_cast(stream);
 634
 635     if (sslv->tx_want != SSL_NOTHING) {
 636         poll_fd_wait(sslv->fd, want_to_poll_events(sslv->tx_want));
 637     }
 638 }
 639
 640 static void
 641 ssl_wait(struct stream *stream, enum stream_wait_type wait)
 642 {
 643     struct ssl_stream *sslv = ssl_stream_cast(stream);
 644
 645     switch (wait) {
 646     case STREAM_CONNECT:
 647         if (stream_connect(stream) != EAGAIN) {
 648             poll_immediate_wake();
 649         } else {
 650             switch (sslv->state) {
 651             case STATE_TCP_CONNECTING:
 652                 poll_fd_wait(sslv->fd, POLLOUT);
 653                 break;
 654
 655             case STATE_SSL_CONNECTING:
 656                 /* ssl_connect() called SSL_accept() or SSL_connect(), which
 657                  * set up the status that we test here. */
 658                 poll_fd_wait(sslv->fd,
 659                              want_to_poll_events(SSL_want(sslv->ssl)));
 660                 break;
 661
 662             default:
 663                 NOT_REACHED();
 664             }
 665         }
 666         break;
 667
 668     case STREAM_RECV:
 669         if (sslv->rx_want != SSL_NOTHING) {
 670             poll_fd_wait(sslv->fd, want_to_poll_events(sslv->rx_want));
 671         } else {
 672             poll_immediate_wake();
 673         }
 674         break;
 675
 676     case STREAM_SEND:
 677         if (!sslv->txbuf) {
 678             /* We have room in our tx queue. */
 679             poll_immediate_wake();
 680         } else {
 681             /* stream_run_wait() will do the right thing; don't bother with
 682              * redundancy. */
 683         }
 684         break;
 685
 686     default:
 687         NOT_REACHED();
 688     }
 689 }
 690
 691 struct stream_class ssl_stream_class = {
 692     "ssl",                      /* name */
 693     ssl_open,                   /* open */
 694     ssl_close,                  /* close */
 695     ssl_connect,                /* connect */
 696     ssl_recv,                   /* recv */
 697     ssl_send,                   /* send */
 698     ssl_run,                    /* run */
 699     ssl_run_wait,               /* run_wait */
 700     ssl_wait,                   /* wait */
 701 };
 702 \f
 703 /* Passive SSL. */
 704
 705 struct pssl_pstream
 706 {
 707     struct pstream pstream;
 708     int fd;
 709 };
 710
 711 struct pstream_class pssl_pstream_class;
 712
 713 static struct pssl_pstream *
 714 pssl_pstream_cast(struct pstream *pstream)
 715 {
 716     pstream_assert_class(pstream, &pssl_pstream_class);
 717     return CONTAINER_OF(pstream, struct pssl_pstream, pstream);
 718 }
 719
 720 static int
 721 pssl_open(const char *name UNUSED, char *suffix, struct pstream **pstreamp)
 722 {
 723     struct pssl_pstream *pssl;
 724     struct sockaddr_in sin;
 725     char bound_name[128];
 726     int retval;
 727     int fd;
 728
 729     retval = ssl_init();
 730     if (retval) {
 731         return retval;
 732     }
 733
 734     fd = inet_open_passive(SOCK_STREAM, suffix, OFP_SSL_PORT, NULL);
 735     if (fd < 0) {
 736         return -fd;
 737     }
 738     sprintf(bound_name, "pssl:%"PRIu16":"IP_FMT,
 739             ntohs(sin.sin_port), IP_ARGS(&sin.sin_addr.s_addr));
 740
 741     pssl = xmalloc(sizeof *pssl);
 742     pstream_init(&pssl->pstream, &pssl_pstream_class, bound_name);
 743     pssl->fd = fd;
 744     *pstreamp = &pssl->pstream;
 745     return 0;
 746 }
 747
 748 static void
 749 pssl_close(struct pstream *pstream)
 750 {
 751     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 752     close(pssl->fd);
 753     free(pssl);
 754 }
 755
 756 static int
 757 pssl_accept(struct pstream *pstream, struct stream **new_streamp)
 758 {
 759     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 760     struct sockaddr_in sin;
 761     socklen_t sin_len = sizeof sin;
 762     char name[128];
 763     int new_fd;
 764     int error;
 765
 766     new_fd = accept(pssl->fd, &sin, &sin_len);
 767     if (new_fd < 0) {
 768         int error = errno;
 769         if (error != EAGAIN) {
 770             VLOG_DBG_RL(&rl, "accept: %s", strerror(error));
 771         }
 772         return error;
 773     }
 774
 775     error = set_nonblocking(new_fd);
 776     if (error) {
 777         close(new_fd);
 778         return error;
 779     }
 780
 781     sprintf(name, "ssl:"IP_FMT, IP_ARGS(&sin.sin_addr));
 782     if (sin.sin_port != htons(OFP_SSL_PORT)) {
 783         sprintf(strchr(name, '\0'), ":%"PRIu16, ntohs(sin.sin_port));
 784     }
 785     return new_ssl_stream(name, new_fd, SERVER, STATE_SSL_CONNECTING, &sin,
 786                          new_streamp);
 787 }
 788
 789 static void
 790 pssl_wait(struct pstream *pstream)
 791 {
 792     struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
 793     poll_fd_wait(pssl->fd, POLLIN);
 794 }
 795
 796 struct pstream_class pssl_pstream_class = {
 797     "pssl",
 798     pssl_open,
 799     pssl_close,
 800     pssl_accept,
 801     pssl_wait,
 802 };
 803 \f
 804 /*
 805  * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
 806  * OpenSSL is requesting that we call it back when the socket is ready for read
 807  * or writing, respectively.
 808  */
 809 static bool
 810 ssl_wants_io(int ssl_error)
 811 {
 812     return (ssl_error == SSL_ERROR_WANT_WRITE
 813             || ssl_error == SSL_ERROR_WANT_READ);
 814 }
 815
 816 static int
 817 ssl_init(void)
 818 {
 819     static int init_status = -1;
 820     if (init_status < 0) {
 821         init_status = do_ssl_init();
 822         assert(init_status >= 0);
 823     }
 824     return init_status;
 825 }
 826
 827 static int
 828 do_ssl_init(void)
 829 {
 830     SSL_METHOD *method;
 831
 832     SSL_library_init();
 833     SSL_load_error_strings();
 834
 835     method = TLSv1_method();
 836     if (method == NULL) {
 837         VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
 838         return ENOPROTOOPT;
 839     }
 840
 841     ctx = SSL_CTX_new(method);
 842     if (ctx == NULL) {
 843         VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
 844         return ENOPROTOOPT;
 845     }
 846     SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
 847     SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
 848     SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 849     SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
 850     SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
 851                        NULL);
 852
 853     return 0;
 854 }
 855
 856 static DH *
 857 tmp_dh_callback(SSL *ssl UNUSED, int is_export UNUSED, int keylength)
 858 {
 859     struct dh {
 860         int keylength;
 861         DH *dh;
 862         DH *(*constructor)(void);
 863     };
 864
 865     static struct dh dh_table[] = {
 866         {1024, NULL, get_dh1024},
 867         {2048, NULL, get_dh2048},
 868         {4096, NULL, get_dh4096},
 869     };
 870
 871     struct dh *dh;
 872
 873     for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
 874         if (dh->keylength == keylength) {
 875             if (!dh->dh) {
 876                 dh->dh = dh->constructor();
 877                 if (!dh->dh) {
 878                     ovs_fatal(ENOMEM, "out of memory constructing "
 879                               "Diffie-Hellman parameters");
 880                 }
 881             }
 882             return dh->dh;
 883         }
 884     }
 885     VLOG_ERR_RL(&rl, "no Diffie-Hellman parameters for key length %d",
 886                 keylength);
 887     return NULL;
 888 }
 889
 890 /* Returns true if SSL is at least partially configured. */
 891 bool
 892 stream_ssl_is_configured(void)
 893 {
 894     return has_private_key || has_certificate || has_ca_cert;
 895 }
 896
 897 void
 898 stream_ssl_set_private_key_file(const char *file_name)
 899 {
 900     if (ssl_init()) {
 901         return;
 902     }
 903     if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
 904         VLOG_ERR("SSL_use_PrivateKey_file: %s",
 905                  ERR_error_string(ERR_get_error(), NULL));
 906         return;
 907     }
 908     has_private_key = true;
 909 }
 910
 911 void
 912 stream_ssl_set_certificate_file(const char *file_name)
 913 {
 914     if (ssl_init()) {
 915         return;
 916     }
 917     if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
 918         VLOG_ERR("SSL_use_certificate_file: %s",
 919                  ERR_error_string(ERR_get_error(), NULL));
 920         return;
 921     }
 922     has_certificate = true;
 923 }
 924
 925 /* Reads the X509 certificate or certificates in file 'file_name'.  On success,
 926  * stores the address of the first element in an array of pointers to
 927  * certificates in '*certs' and the number of certificates in the array in
 928  * '*n_certs', and returns 0.  On failure, stores a null pointer in '*certs', 0
 929  * in '*n_certs', and returns a positive errno value.
 930  *
 931  * The caller is responsible for freeing '*certs'. */
 932 static int
 933 read_cert_file(const char *file_name, X509 ***certs, size_t *n_certs)
 934 {
 935     FILE *file;
 936     size_t allocated_certs = 0;
 937
 938     *certs = NULL;
 939     *n_certs = 0;
 940
 941     file = fopen(file_name, "r");
 942     if (!file) {
 943         VLOG_ERR("failed to open %s for reading: %s",
 944                  file_name, strerror(errno));
 945         return errno;
 946     }
 947
 948     for (;;) {
 949         X509 *certificate;
 950         int c;
 951
 952         /* Read certificate from file. */
 953         certificate = PEM_read_X509(file, NULL, NULL, NULL);
 954         if (!certificate) {
 955             size_t i;
 956
 957             VLOG_ERR("PEM_read_X509 failed reading %s: %s",
 958                      file_name, ERR_error_string(ERR_get_error(), NULL));
 959             for (i = 0; i < *n_certs; i++) {
 960                 X509_free((*certs)[i]);
 961             }
 962             free(*certs);
 963             *certs = NULL;
 964             *n_certs = 0;
 965             return EIO;
 966         }
 967
 968         /* Add certificate to array. */
 969         if (*n_certs >= allocated_certs) {
 970             *certs = x2nrealloc(*certs, &allocated_certs, sizeof **certs);
 971         }
 972         (*certs)[(*n_certs)++] = certificate;
 973
 974         /* Are there additional certificates in the file? */
 975         do {
 976             c = getc(file);
 977         } while (isspace(c));
 978         if (c == EOF) {
 979             break;
 980         }
 981         ungetc(c, file);
 982     }
 983     fclose(file);
 984     return 0;
 985 }
 986
 987
 988 /* Sets 'file_name' as the name of a file containing one or more X509
 989  * certificates to send to the peer.  Typical use in OpenFlow is to send the CA
 990  * certificate to the peer, which enables a switch to pick up the controller's
 991  * CA certificate on its first connection. */
 992 void
 993 stream_ssl_set_peer_ca_cert_file(const char *file_name)
 994 {
 995     X509 **certs;
 996     size_t n_certs;
 997     size_t i;
 998
 999     if (ssl_init()) {
1000         return;
1001     }
1002
1003     if (!read_cert_file(file_name, &certs, &n_certs)) {
1004         for (i = 0; i < n_certs; i++) {
1005             if (SSL_CTX_add_extra_chain_cert(ctx, certs[i]) != 1) {
1006                 VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s",
1007                          ERR_error_string(ERR_get_error(), NULL));
1008             }
1009         }
1010         free(certs);
1011     }
1012 }
1013
1014 /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */
1015 static void
1016 log_ca_cert(const char *file_name, X509 *cert)
1017 {
1018     unsigned char digest[EVP_MAX_MD_SIZE];
1019     unsigned int n_bytes;
1020     struct ds fp;
1021     char *subject;
1022
1023     ds_init(&fp);
1024     if (!X509_digest(cert, EVP_sha1(), digest, &n_bytes)) {
1025         ds_put_cstr(&fp, "<out of memory>");
1026     } else {
1027         unsigned int i;
1028         for (i = 0; i < n_bytes; i++) {
1029             if (i) {
1030                 ds_put_char(&fp, ':');
1031             }
1032             ds_put_format(&fp, "%02hhx", digest[i]);
1033         }
1034     }
1035     subject = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
1036     VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name,
1037               subject ? subject : "<out of memory>", ds_cstr(&fp));
1038     free(subject);
1039     ds_destroy(&fp);
1040 }
1041
1042 /* Sets 'file_name' as the name of the file from which to read the CA
1043  * certificate used to verify the peer within SSL connections.  If 'bootstrap'
1044  * is false, the file must exist.  If 'bootstrap' is false, then the file is
1045  * read if it is exists; if it does not, then it will be created from the CA
1046  * certificate received from the peer on the first SSL connection. */
1047 void
1048 stream_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
1049 {
1050     X509 **certs;
1051     size_t n_certs;
1052     struct stat s;
1053
1054     if (ssl_init()) {
1055         return;
1056     }
1057
1058     if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
1059         bootstrap_ca_cert = true;
1060         ca_cert_file = xstrdup(file_name);
1061     } else if (!read_cert_file(file_name, &certs, &n_certs)) {
1062         size_t i;
1063
1064         /* Set up list of CAs that the server will accept from the client. */
1065         for (i = 0; i < n_certs; i++) {
1066             /* SSL_CTX_add_client_CA makes a copy of the relevant data. */
1067             if (SSL_CTX_add_client_CA(ctx, certs[i]) != 1) {
1068                 VLOG_ERR("failed to add client certificate %d from %s: %s",
1069                          i, file_name,
1070                          ERR_error_string(ERR_get_error(), NULL));
1071             } else {
1072                 log_ca_cert(file_name, certs[i]);
1073             }
1074             X509_free(certs[i]);
1075         }
1076
1077         /* Set up CAs for OpenSSL to trust in verifying the peer's
1078          * certificate. */
1079         if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
1080             VLOG_ERR("SSL_CTX_load_verify_locations: %s",
1081                      ERR_error_string(ERR_get_error(), NULL));
1082             return;
1083         }
1084
1085         has_ca_cert = true;
1086     }
1087 }