lib/vconn-ssl.c

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