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