lib/stream-ssl.c

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