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