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