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