2 * Copyright (c) 2008, 2009 Nicira Networks.
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 #include "vconn-ssl.h"
25 #include <netinet/tcp.h>
26 #include <openssl/err.h>
27 #include <openssl/ssl.h>
28 #include <openssl/x509v3.h>
30 #include <sys/fcntl.h>
33 #include "dynamic-string.h"
34 #include "leak-checker.h"
36 #include "openflow/openflow.h"
38 #include "poll-loop.h"
39 #include "socket-util.h"
40 #include "socket-util.h"
42 #include "vconn-provider.h"
46 #define THIS_MODULE VLM_vconn_ssl
65 enum session_type type;
70 struct poll_waiter *tx_waiter;
72 /* rx_want and tx_want record the result of the last call to SSL_read()
73 * and SSL_write(), respectively:
75 * - If the call reported that data needed to be read from the file
76 * descriptor, the corresponding member is set to SSL_READING.
78 * - If the call reported that data needed to be written to the file
79 * descriptor, the corresponding member is set to SSL_WRITING.
81 * - Otherwise, the member is set to SSL_NOTHING, indicating that the
82 * call completed successfully (or with an error) and that there is no
85 * These are needed because there is no way to ask OpenSSL what a data read
86 * or write would require without giving it a buffer to receive into or
87 * data to send, respectively. (Note that the SSL_want() status is
88 * overwritten by each SSL_read() or SSL_write() call, so we can't rely on
91 * A single call to SSL_read() or SSL_write() can perform both reading
92 * and writing and thus invalidate not one of these values but actually
93 * both. Consider this situation, for example:
95 * - SSL_write() blocks on a read, so tx_want gets SSL_READING.
97 * - SSL_read() laters succeeds reading from 'fd' and clears out the
98 * whole receive buffer, so rx_want gets SSL_READING.
100 * - Client calls vconn_wait(WAIT_RECV) and vconn_wait(WAIT_SEND) and
103 * - Now we're stuck blocking until the peer sends us data, even though
104 * SSL_write() could now succeed, which could easily be a deadlock
107 * On the other hand, we can't reset both tx_want and rx_want on every call
108 * to SSL_read() or SSL_write(), because that would produce livelock,
109 * e.g. in this situation:
111 * - SSL_write() blocks, so tx_want gets SSL_READING or SSL_WRITING.
113 * - SSL_read() blocks, so rx_want gets SSL_READING or SSL_WRITING,
114 * but tx_want gets reset to SSL_NOTHING.
116 * - Client calls vconn_wait(WAIT_RECV) and vconn_wait(WAIT_SEND) and
119 * - Client wakes up immediately since SSL_NOTHING in tx_want indicates
120 * that no blocking is necessary.
122 * The solution we adopt here is to set tx_want to SSL_NOTHING after
123 * calling SSL_read() only if the SSL state of the connection changed,
124 * which indicates that an SSL-level renegotiation made some progress, and
125 * similarly for rx_want and SSL_write(). This prevents both the
126 * deadlock and livelock situations above.
128 int rx_want, tx_want;
131 /* SSL context created by ssl_init(). */
134 /* Required configuration. */
135 static bool has_private_key, has_certificate, has_ca_cert;
137 /* Ordinarily, we require a CA certificate for the peer to be locally
138 * available. 'has_ca_cert' is true when this is the case, and neither of the
139 * following variables matter.
141 * We can, however, bootstrap the CA certificate from the peer at the beginning
142 * of our first connection then use that certificate on all subsequent
143 * connections, saving it to a file for use in future runs also. In this case,
144 * 'has_ca_cert' is false, 'bootstrap_ca_cert' is true, and 'ca_cert_file'
145 * names the file to be saved. */
146 static bool bootstrap_ca_cert;
147 static char *ca_cert_file;
149 /* Who knows what can trigger various SSL errors, so let's throttle them down
151 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
153 static int ssl_init(void);
154 static int do_ssl_init(void);
155 static bool ssl_wants_io(int ssl_error);
156 static void ssl_close(struct vconn *);
157 static void ssl_clear_txbuf(struct ssl_vconn *);
158 static int interpret_ssl_error(const char *function, int ret, int error,
160 static void ssl_tx_poll_callback(int fd, short int revents, void *vconn_);
161 static DH *tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength);
162 static void log_ca_cert(const char *file_name, X509 *cert);
165 want_to_poll_events(int want)
183 new_ssl_vconn(const char *name, int fd, enum session_type type,
184 enum ssl_state state, const struct sockaddr_in *sin,
185 struct vconn **vconnp)
187 struct ssl_vconn *sslv;
192 /* Check for all the needful configuration. */
194 if (!has_private_key) {
195 VLOG_ERR("Private key must be configured to use SSL");
196 retval = ENOPROTOOPT;
198 if (!has_certificate) {
199 VLOG_ERR("Certificate must be configured to use SSL");
200 retval = ENOPROTOOPT;
202 if (!has_ca_cert && !bootstrap_ca_cert) {
203 VLOG_ERR("CA certificate must be configured to use SSL");
204 retval = ENOPROTOOPT;
206 if (!SSL_CTX_check_private_key(ctx)) {
207 VLOG_ERR("Private key does not match certificate public key: %s",
208 ERR_error_string(ERR_get_error(), NULL));
209 retval = ENOPROTOOPT;
216 retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
218 VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
223 /* Create and configure OpenSSL stream. */
226 VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
227 retval = ENOPROTOOPT;
230 if (SSL_set_fd(ssl, fd) == 0) {
231 VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
232 retval = ENOPROTOOPT;
235 if (bootstrap_ca_cert && type == CLIENT) {
236 SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL);
239 /* Create and return the ssl_vconn. */
240 sslv = xmalloc(sizeof *sslv);
241 vconn_init(&sslv->vconn, &ssl_vconn_class, EAGAIN, sin->sin_addr.s_addr,
249 sslv->tx_waiter = NULL;
250 sslv->rx_want = sslv->tx_want = SSL_NOTHING;
251 *vconnp = &sslv->vconn;
262 static struct ssl_vconn *
263 ssl_vconn_cast(struct vconn *vconn)
265 vconn_assert_class(vconn, &ssl_vconn_class);
266 return CONTAINER_OF(vconn, struct ssl_vconn, vconn);
270 ssl_open(const char *name, char *suffix, struct vconn **vconnp)
272 char *save_ptr, *host_name, *port_string;
273 struct sockaddr_in sin;
282 /* Glibc 2.7 has a bug in strtok_r when compiling with optimization that
283 * can cause segfaults here:
284 * http://sources.redhat.com/bugzilla/show_bug.cgi?id=5614.
285 * Using "::" instead of the obvious ":" works around it. */
286 host_name = strtok_r(suffix, "::", &save_ptr);
287 port_string = strtok_r(NULL, "::", &save_ptr);
289 ovs_error(0, "%s: bad peer name format", name);
293 memset(&sin, 0, sizeof sin);
294 sin.sin_family = AF_INET;
295 if (lookup_ip(host_name, &sin.sin_addr)) {
298 sin.sin_port = htons(port_string && *port_string ? atoi(port_string)
302 fd = socket(AF_INET, SOCK_STREAM, 0);
304 VLOG_ERR("%s: socket: %s", name, strerror(errno));
307 retval = set_nonblocking(fd);
313 /* Connect socket. */
314 retval = connect(fd, (struct sockaddr *) &sin, sizeof sin);
316 if (errno == EINPROGRESS) {
317 return new_ssl_vconn(name, fd, CLIENT, STATE_TCP_CONNECTING,
321 VLOG_ERR("%s: connect: %s", name, strerror(error));
326 return new_ssl_vconn(name, fd, CLIENT, STATE_SSL_CONNECTING,
332 do_ca_cert_bootstrap(struct vconn *vconn)
334 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
335 STACK_OF(X509) *chain;
341 chain = SSL_get_peer_cert_chain(sslv->ssl);
342 if (!chain || !sk_X509_num(chain)) {
343 VLOG_ERR("could not bootstrap CA cert: no certificate presented by "
347 ca_cert = sk_X509_value(chain, sk_X509_num(chain) - 1);
349 /* Check that 'ca_cert' is self-signed. Otherwise it is not a CA
350 * certificate and we should not attempt to use it as one. */
351 error = X509_check_issued(ca_cert, ca_cert);
353 VLOG_ERR("could not bootstrap CA cert: obtained certificate is "
354 "not self-signed (%s)",
355 X509_verify_cert_error_string(error));
356 if (sk_X509_num(chain) < 2) {
357 VLOG_ERR("only one certificate was received, so probably the peer "
358 "is not configured to send its CA certificate");
363 fd = open(ca_cert_file, O_CREAT | O_EXCL | O_WRONLY, 0444);
365 VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
366 ca_cert_file, strerror(errno));
370 file = fdopen(fd, "w");
373 VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
375 unlink(ca_cert_file);
379 if (!PEM_write_X509(file, ca_cert)) {
380 VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
381 "%s", ca_cert_file, ERR_error_string(ERR_get_error(), NULL));
383 unlink(ca_cert_file);
389 VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
390 ca_cert_file, strerror(error));
391 unlink(ca_cert_file);
395 VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert_file);
396 log_ca_cert(ca_cert_file, ca_cert);
397 bootstrap_ca_cert = false;
400 /* SSL_CTX_add_client_CA makes a copy of ca_cert's relevant data. */
401 SSL_CTX_add_client_CA(ctx, ca_cert);
403 /* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
404 * 'ca_cert' is owned by sslv->ssl, so we need to duplicate it. */
405 ca_cert = X509_dup(ca_cert);
409 if (SSL_CTX_load_verify_locations(ctx, ca_cert_file, NULL) != 1) {
410 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
411 ERR_error_string(ERR_get_error(), NULL));
414 VLOG_INFO("killing successful connection to retry using CA cert");
419 ssl_connect(struct vconn *vconn)
421 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
424 switch (sslv->state) {
425 case STATE_TCP_CONNECTING:
426 retval = check_connection_completion(sslv->fd);
430 sslv->state = STATE_SSL_CONNECTING;
433 case STATE_SSL_CONNECTING:
434 retval = (sslv->type == CLIENT
435 ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
437 int error = SSL_get_error(sslv->ssl, retval);
438 if (retval < 0 && ssl_wants_io(error)) {
442 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
443 : "SSL_accept"), retval, error, &unused);
444 shutdown(sslv->fd, SHUT_RDWR);
447 } else if (bootstrap_ca_cert) {
448 return do_ca_cert_bootstrap(vconn);
449 } else if ((SSL_get_verify_mode(sslv->ssl)
450 & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
451 != SSL_VERIFY_PEER) {
452 /* Two or more SSL connections completed at the same time while we
453 * were in bootstrap mode. Only one of these can finish the
454 * bootstrap successfully. The other one(s) must be rejected
455 * because they were not verified against the bootstrapped CA
456 * certificate. (Alternatively we could verify them against the CA
457 * certificate, but that's more trouble than it's worth. These
458 * connections will succeed the next time they retry, assuming that
459 * they have a certificate against the correct CA.) */
460 VLOG_ERR("rejecting SSL connection during bootstrap race window");
471 ssl_close(struct vconn *vconn)
473 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
474 poll_cancel(sslv->tx_waiter);
475 ssl_clear_txbuf(sslv);
476 ofpbuf_delete(sslv->rxbuf);
483 interpret_ssl_error(const char *function, int ret, int error,
490 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_NONE", function);
493 case SSL_ERROR_ZERO_RETURN:
494 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_ZERO_RETURN", function);
497 case SSL_ERROR_WANT_READ:
501 case SSL_ERROR_WANT_WRITE:
505 case SSL_ERROR_WANT_CONNECT:
506 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_CONNECT", function);
509 case SSL_ERROR_WANT_ACCEPT:
510 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
513 case SSL_ERROR_WANT_X509_LOOKUP:
514 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP",
518 case SSL_ERROR_SYSCALL: {
519 int queued_error = ERR_get_error();
520 if (queued_error == 0) {
523 VLOG_WARN_RL(&rl, "%s: system error (%s)",
524 function, strerror(status));
527 VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close",
532 VLOG_WARN_RL(&rl, "%s: %s",
533 function, ERR_error_string(queued_error, NULL));
538 case SSL_ERROR_SSL: {
539 int queued_error = ERR_get_error();
540 if (queued_error != 0) {
541 VLOG_WARN_RL(&rl, "%s: %s",
542 function, ERR_error_string(queued_error, NULL));
544 VLOG_ERR_RL(&rl, "%s: SSL_ERROR_SSL without queued error",
551 VLOG_ERR_RL(&rl, "%s: bad SSL error code %d", function, error);
558 ssl_recv(struct vconn *vconn, struct ofpbuf **bufferp)
560 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
566 if (sslv->rxbuf == NULL) {
567 sslv->rxbuf = ofpbuf_new(1564);
572 if (sizeof(struct ofp_header) > rx->size) {
573 want_bytes = sizeof(struct ofp_header) - rx->size;
575 struct ofp_header *oh = rx->data;
576 size_t length = ntohs(oh->length);
577 if (length < sizeof(struct ofp_header)) {
578 VLOG_ERR_RL(&rl, "received too-short ofp_header (%zu bytes)",
582 want_bytes = length - rx->size;
589 ofpbuf_prealloc_tailroom(rx, want_bytes);
591 /* Behavior of zero-byte SSL_read is poorly defined. */
592 assert(want_bytes > 0);
594 old_state = SSL_get_state(sslv->ssl);
595 ret = SSL_read(sslv->ssl, ofpbuf_tail(rx), want_bytes);
596 if (old_state != SSL_get_state(sslv->ssl)) {
597 sslv->tx_want = SSL_NOTHING;
598 if (sslv->tx_waiter) {
599 poll_cancel(sslv->tx_waiter);
600 ssl_tx_poll_callback(sslv->fd, POLLIN, vconn);
603 sslv->rx_want = SSL_NOTHING;
607 if (ret == want_bytes) {
608 if (rx->size > sizeof(struct ofp_header)) {
618 int error = SSL_get_error(sslv->ssl, ret);
619 if (error == SSL_ERROR_ZERO_RETURN) {
620 /* Connection closed (EOF). */
622 VLOG_WARN_RL(&rl, "SSL_read: unexpected connection close");
628 return interpret_ssl_error("SSL_read", ret, error, &sslv->rx_want);
634 ssl_clear_txbuf(struct ssl_vconn *sslv)
636 ofpbuf_delete(sslv->txbuf);
638 sslv->tx_waiter = NULL;
642 ssl_register_tx_waiter(struct vconn *vconn)
644 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
645 sslv->tx_waiter = poll_fd_callback(sslv->fd,
646 want_to_poll_events(sslv->tx_want),
647 ssl_tx_poll_callback, vconn);
651 ssl_do_tx(struct vconn *vconn)
653 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
656 int old_state = SSL_get_state(sslv->ssl);
657 int ret = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
658 if (old_state != SSL_get_state(sslv->ssl)) {
659 sslv->rx_want = SSL_NOTHING;
661 sslv->tx_want = SSL_NOTHING;
663 ofpbuf_pull(sslv->txbuf, ret);
664 if (sslv->txbuf->size == 0) {
668 int ssl_error = SSL_get_error(sslv->ssl, ret);
669 if (ssl_error == SSL_ERROR_ZERO_RETURN) {
670 VLOG_WARN_RL(&rl, "SSL_write: connection closed");
673 return interpret_ssl_error("SSL_write", ret, ssl_error,
681 ssl_tx_poll_callback(int fd UNUSED, short int revents UNUSED, void *vconn_)
683 struct vconn *vconn = vconn_;
684 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
685 int error = ssl_do_tx(vconn);
686 if (error != EAGAIN) {
687 ssl_clear_txbuf(sslv);
689 ssl_register_tx_waiter(vconn);
694 ssl_send(struct vconn *vconn, struct ofpbuf *buffer)
696 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
703 sslv->txbuf = buffer;
704 error = ssl_do_tx(vconn);
707 ssl_clear_txbuf(sslv);
710 leak_checker_claim(buffer);
711 ssl_register_tx_waiter(vconn);
721 ssl_wait(struct vconn *vconn, enum vconn_wait_type wait)
723 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
727 if (vconn_connect(vconn) != EAGAIN) {
728 poll_immediate_wake();
730 switch (sslv->state) {
731 case STATE_TCP_CONNECTING:
732 poll_fd_wait(sslv->fd, POLLOUT);
735 case STATE_SSL_CONNECTING:
736 /* ssl_connect() called SSL_accept() or SSL_connect(), which
737 * set up the status that we test here. */
738 poll_fd_wait(sslv->fd,
739 want_to_poll_events(SSL_want(sslv->ssl)));
749 if (sslv->rx_want != SSL_NOTHING) {
750 poll_fd_wait(sslv->fd, want_to_poll_events(sslv->rx_want));
752 poll_immediate_wake();
758 /* We have room in our tx queue. */
759 poll_immediate_wake();
761 /* The call to ssl_tx_poll_callback() will wake us up. */
770 struct vconn_class ssl_vconn_class = {
773 ssl_close, /* close */
774 ssl_connect, /* connect */
784 struct pvconn pvconn;
788 struct pvconn_class pssl_pvconn_class;
790 static struct pssl_pvconn *
791 pssl_pvconn_cast(struct pvconn *pvconn)
793 pvconn_assert_class(pvconn, &pssl_pvconn_class);
794 return CONTAINER_OF(pvconn, struct pssl_pvconn, pvconn);
798 pssl_open(const char *name, char *suffix, struct pvconn **pvconnp)
800 struct sockaddr_in sin;
801 struct pssl_pvconn *pssl;
804 unsigned int yes = 1;
812 fd = socket(AF_INET, SOCK_STREAM, 0);
815 VLOG_ERR("%s: socket: %s", name, strerror(error));
819 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
821 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", name, strerror(errno));
825 memset(&sin, 0, sizeof sin);
826 sin.sin_family = AF_INET;
827 sin.sin_addr.s_addr = htonl(INADDR_ANY);
828 sin.sin_port = htons(atoi(suffix) ? atoi(suffix) : OFP_SSL_PORT);
829 retval = bind(fd, (struct sockaddr *) &sin, sizeof sin);
832 VLOG_ERR("%s: bind: %s", name, strerror(error));
837 retval = listen(fd, 10);
840 VLOG_ERR("%s: listen: %s", name, strerror(error));
845 retval = set_nonblocking(fd);
851 pssl = xmalloc(sizeof *pssl);
852 pvconn_init(&pssl->pvconn, &pssl_pvconn_class, name);
854 *pvconnp = &pssl->pvconn;
859 pssl_close(struct pvconn *pvconn)
861 struct pssl_pvconn *pssl = pssl_pvconn_cast(pvconn);
867 pssl_accept(struct pvconn *pvconn, struct vconn **new_vconnp)
869 struct pssl_pvconn *pssl = pssl_pvconn_cast(pvconn);
870 struct sockaddr_in sin;
871 socklen_t sin_len = sizeof sin;
876 new_fd = accept(pssl->fd, &sin, &sin_len);
879 if (error != EAGAIN) {
880 VLOG_DBG_RL(&rl, "accept: %s", strerror(error));
885 error = set_nonblocking(new_fd);
891 sprintf(name, "ssl:"IP_FMT, IP_ARGS(&sin.sin_addr));
892 if (sin.sin_port != htons(OFP_SSL_PORT)) {
893 sprintf(strchr(name, '\0'), ":%"PRIu16, ntohs(sin.sin_port));
895 return new_ssl_vconn(name, new_fd, SERVER, STATE_SSL_CONNECTING, &sin,
900 pssl_wait(struct pvconn *pvconn)
902 struct pssl_pvconn *pssl = pssl_pvconn_cast(pvconn);
903 poll_fd_wait(pssl->fd, POLLIN);
906 struct pvconn_class pssl_pvconn_class = {
915 * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
916 * OpenSSL is requesting that we call it back when the socket is ready for read
917 * or writing, respectively.
920 ssl_wants_io(int ssl_error)
922 return (ssl_error == SSL_ERROR_WANT_WRITE
923 || ssl_error == SSL_ERROR_WANT_READ);
929 static int init_status = -1;
930 if (init_status < 0) {
931 init_status = do_ssl_init();
932 assert(init_status >= 0);
943 SSL_load_error_strings();
945 method = TLSv1_method();
946 if (method == NULL) {
947 VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
951 ctx = SSL_CTX_new(method);
953 VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
956 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
957 SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
958 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
959 SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
960 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
967 tmp_dh_callback(SSL *ssl UNUSED, int is_export UNUSED, int keylength)
972 DH *(*constructor)(void);
975 static struct dh dh_table[] = {
976 {1024, NULL, get_dh1024},
977 {2048, NULL, get_dh2048},
978 {4096, NULL, get_dh4096},
983 for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
984 if (dh->keylength == keylength) {
986 dh->dh = dh->constructor();
988 ovs_fatal(ENOMEM, "out of memory constructing "
989 "Diffie-Hellman parameters");
995 VLOG_ERR_RL(&rl, "no Diffie-Hellman parameters for key length %d",
1000 /* Returns true if SSL is at least partially configured. */
1002 vconn_ssl_is_configured(void)
1004 return has_private_key || has_certificate || has_ca_cert;
1008 vconn_ssl_set_private_key_file(const char *file_name)
1013 if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
1014 VLOG_ERR("SSL_use_PrivateKey_file: %s",
1015 ERR_error_string(ERR_get_error(), NULL));
1018 has_private_key = true;
1022 vconn_ssl_set_certificate_file(const char *file_name)
1027 if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
1028 VLOG_ERR("SSL_use_certificate_file: %s",
1029 ERR_error_string(ERR_get_error(), NULL));
1032 has_certificate = true;
1035 /* Reads the X509 certificate or certificates in file 'file_name'. On success,
1036 * stores the address of the first element in an array of pointers to
1037 * certificates in '*certs' and the number of certificates in the array in
1038 * '*n_certs', and returns 0. On failure, stores a null pointer in '*certs', 0
1039 * in '*n_certs', and returns a positive errno value.
1041 * The caller is responsible for freeing '*certs'. */
1043 read_cert_file(const char *file_name, X509 ***certs, size_t *n_certs)
1046 size_t allocated_certs = 0;
1051 file = fopen(file_name, "r");
1053 VLOG_ERR("failed to open %s for reading: %s",
1054 file_name, strerror(errno));
1062 /* Read certificate from file. */
1063 certificate = PEM_read_X509(file, NULL, NULL, NULL);
1067 VLOG_ERR("PEM_read_X509 failed reading %s: %s",
1068 file_name, ERR_error_string(ERR_get_error(), NULL));
1069 for (i = 0; i < *n_certs; i++) {
1070 X509_free((*certs)[i]);
1078 /* Add certificate to array. */
1079 if (*n_certs >= allocated_certs) {
1080 *certs = x2nrealloc(*certs, &allocated_certs, sizeof **certs);
1082 (*certs)[(*n_certs)++] = certificate;
1084 /* Are there additional certificates in the file? */
1087 } while (isspace(c));
1098 /* Sets 'file_name' as the name of a file containing one or more X509
1099 * certificates to send to the peer. Typical use in OpenFlow is to send the CA
1100 * certificate to the peer, which enables a switch to pick up the controller's
1101 * CA certificate on its first connection. */
1103 vconn_ssl_set_peer_ca_cert_file(const char *file_name)
1113 if (!read_cert_file(file_name, &certs, &n_certs)) {
1114 for (i = 0; i < n_certs; i++) {
1115 if (SSL_CTX_add_extra_chain_cert(ctx, certs[i]) != 1) {
1116 VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s",
1117 ERR_error_string(ERR_get_error(), NULL));
1124 /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */
1126 log_ca_cert(const char *file_name, X509 *cert)
1128 unsigned char digest[EVP_MAX_MD_SIZE];
1129 unsigned int n_bytes;
1134 if (!X509_digest(cert, EVP_sha1(), digest, &n_bytes)) {
1135 ds_put_cstr(&fp, "<out of memory>");
1138 for (i = 0; i < n_bytes; i++) {
1140 ds_put_char(&fp, ':');
1142 ds_put_format(&fp, "%02hhx", digest[i]);
1145 subject = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
1146 VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name,
1147 subject ? subject : "<out of memory>", ds_cstr(&fp));
1152 /* Sets 'file_name' as the name of the file from which to read the CA
1153 * certificate used to verify the peer within SSL connections. If 'bootstrap'
1154 * is false, the file must exist. If 'bootstrap' is false, then the file is
1155 * read if it is exists; if it does not, then it will be created from the CA
1156 * certificate received from the peer on the first SSL connection. */
1158 vconn_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
1168 if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
1169 bootstrap_ca_cert = true;
1170 ca_cert_file = xstrdup(file_name);
1171 } else if (!read_cert_file(file_name, &certs, &n_certs)) {
1174 /* Set up list of CAs that the server will accept from the client. */
1175 for (i = 0; i < n_certs; i++) {
1176 /* SSL_CTX_add_client_CA makes a copy of the relevant data. */
1177 if (SSL_CTX_add_client_CA(ctx, certs[i]) != 1) {
1178 VLOG_ERR("failed to add client certificate %d from %s: %s",
1180 ERR_error_string(ERR_get_error(), NULL));
1182 log_ca_cert(file_name, certs[i]);
1184 X509_free(certs[i]);
1187 /* Set up CAs for OpenSSL to trust in verifying the peer's
1189 if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
1190 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
1191 ERR_error_string(ERR_get_error(), NULL));