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