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