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