lib/stream-ssl.c

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