lib/stream-ssl.c

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