2 * Copyright (c) 2008, 2009 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
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 *remote,
185 struct vconn **vconnp)
187 struct sockaddr_in local;
188 socklen_t local_len = sizeof local;
189 struct ssl_vconn *sslv;
194 /* Check for all the needful configuration. */
196 if (!has_private_key) {
197 VLOG_ERR("Private key must be configured to use SSL");
198 retval = ENOPROTOOPT;
200 if (!has_certificate) {
201 VLOG_ERR("Certificate must be configured to use SSL");
202 retval = ENOPROTOOPT;
204 if (!has_ca_cert && !bootstrap_ca_cert) {
205 VLOG_ERR("CA certificate must be configured to use SSL");
206 retval = ENOPROTOOPT;
208 if (!SSL_CTX_check_private_key(ctx)) {
209 VLOG_ERR("Private key does not match certificate public key: %s",
210 ERR_error_string(ERR_get_error(), NULL));
211 retval = ENOPROTOOPT;
217 /* Get the local IP and port information */
218 retval = getsockname(fd, (struct sockaddr *) &local, &local_len);
220 memset(&local, 0, sizeof local);
224 retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
226 VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
231 /* Create and configure OpenSSL stream. */
234 VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
235 retval = ENOPROTOOPT;
238 if (SSL_set_fd(ssl, fd) == 0) {
239 VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
240 retval = ENOPROTOOPT;
243 if (bootstrap_ca_cert && type == CLIENT) {
244 SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL);
247 /* Create and return the ssl_vconn. */
248 sslv = xmalloc(sizeof *sslv);
249 vconn_init(&sslv->vconn, &ssl_vconn_class, EAGAIN, name, true);
250 vconn_set_remote_ip(&sslv->vconn, remote->sin_addr.s_addr);
251 vconn_set_remote_port(&sslv->vconn, remote->sin_port);
252 vconn_set_local_ip(&sslv->vconn, local.sin_addr.s_addr);
253 vconn_set_local_port(&sslv->vconn, local.sin_port);
260 sslv->tx_waiter = NULL;
261 sslv->rx_want = sslv->tx_want = SSL_NOTHING;
262 *vconnp = &sslv->vconn;
273 static struct ssl_vconn *
274 ssl_vconn_cast(struct vconn *vconn)
276 vconn_assert_class(vconn, &ssl_vconn_class);
277 return CONTAINER_OF(vconn, struct ssl_vconn, vconn);
281 ssl_open(const char *name, char *suffix, struct vconn **vconnp)
283 char *save_ptr, *host_name, *port_string;
284 struct sockaddr_in sin;
293 host_name = strtok_r(suffix, ":", &save_ptr);
294 port_string = strtok_r(NULL, ":", &save_ptr);
296 ovs_error(0, "%s: bad peer name format", name);
300 memset(&sin, 0, sizeof sin);
301 sin.sin_family = AF_INET;
302 if (lookup_ip(host_name, &sin.sin_addr)) {
305 sin.sin_port = htons(port_string && *port_string ? atoi(port_string)
309 fd = socket(AF_INET, SOCK_STREAM, 0);
311 VLOG_ERR("%s: socket: %s", name, strerror(errno));
314 retval = set_nonblocking(fd);
320 /* Connect socket. */
321 retval = connect(fd, (struct sockaddr *) &sin, sizeof sin);
323 if (errno == EINPROGRESS) {
324 return new_ssl_vconn(name, fd, CLIENT, STATE_TCP_CONNECTING,
328 VLOG_ERR("%s: connect: %s", name, strerror(error));
333 return new_ssl_vconn(name, fd, CLIENT, STATE_SSL_CONNECTING,
339 do_ca_cert_bootstrap(struct vconn *vconn)
341 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
342 STACK_OF(X509) *chain;
348 chain = SSL_get_peer_cert_chain(sslv->ssl);
349 if (!chain || !sk_X509_num(chain)) {
350 VLOG_ERR("could not bootstrap CA cert: no certificate presented by "
354 ca_cert = sk_X509_value(chain, sk_X509_num(chain) - 1);
356 /* Check that 'ca_cert' is self-signed. Otherwise it is not a CA
357 * certificate and we should not attempt to use it as one. */
358 error = X509_check_issued(ca_cert, ca_cert);
360 VLOG_ERR("could not bootstrap CA cert: obtained certificate is "
361 "not self-signed (%s)",
362 X509_verify_cert_error_string(error));
363 if (sk_X509_num(chain) < 2) {
364 VLOG_ERR("only one certificate was received, so probably the peer "
365 "is not configured to send its CA certificate");
370 fd = open(ca_cert_file, O_CREAT | O_EXCL | O_WRONLY, 0444);
372 VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
373 ca_cert_file, strerror(errno));
377 file = fdopen(fd, "w");
380 VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
382 unlink(ca_cert_file);
386 if (!PEM_write_X509(file, ca_cert)) {
387 VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
388 "%s", ca_cert_file, ERR_error_string(ERR_get_error(), NULL));
390 unlink(ca_cert_file);
396 VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
397 ca_cert_file, strerror(error));
398 unlink(ca_cert_file);
402 VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert_file);
403 log_ca_cert(ca_cert_file, ca_cert);
404 bootstrap_ca_cert = false;
407 /* SSL_CTX_add_client_CA makes a copy of ca_cert's relevant data. */
408 SSL_CTX_add_client_CA(ctx, ca_cert);
410 /* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
411 * 'ca_cert' is owned by sslv->ssl, so we need to duplicate it. */
412 ca_cert = X509_dup(ca_cert);
416 if (SSL_CTX_load_verify_locations(ctx, ca_cert_file, NULL) != 1) {
417 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
418 ERR_error_string(ERR_get_error(), NULL));
421 VLOG_INFO("killing successful connection to retry using CA cert");
426 ssl_connect(struct vconn *vconn)
428 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
431 switch (sslv->state) {
432 case STATE_TCP_CONNECTING:
433 retval = check_connection_completion(sslv->fd);
437 sslv->state = STATE_SSL_CONNECTING;
440 case STATE_SSL_CONNECTING:
441 retval = (sslv->type == CLIENT
442 ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
444 int error = SSL_get_error(sslv->ssl, retval);
445 if (retval < 0 && ssl_wants_io(error)) {
449 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
450 : "SSL_accept"), retval, error, &unused);
451 shutdown(sslv->fd, SHUT_RDWR);
454 } else if (bootstrap_ca_cert) {
455 return do_ca_cert_bootstrap(vconn);
456 } else if ((SSL_get_verify_mode(sslv->ssl)
457 & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
458 != SSL_VERIFY_PEER) {
459 /* Two or more SSL connections completed at the same time while we
460 * were in bootstrap mode. Only one of these can finish the
461 * bootstrap successfully. The other one(s) must be rejected
462 * because they were not verified against the bootstrapped CA
463 * certificate. (Alternatively we could verify them against the CA
464 * certificate, but that's more trouble than it's worth. These
465 * connections will succeed the next time they retry, assuming that
466 * they have a certificate against the correct CA.) */
467 VLOG_ERR("rejecting SSL connection during bootstrap race window");
478 ssl_close(struct vconn *vconn)
480 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
481 poll_cancel(sslv->tx_waiter);
482 ssl_clear_txbuf(sslv);
483 ofpbuf_delete(sslv->rxbuf);
490 interpret_ssl_error(const char *function, int ret, int error,
497 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_NONE", function);
500 case SSL_ERROR_ZERO_RETURN:
501 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_ZERO_RETURN", function);
504 case SSL_ERROR_WANT_READ:
508 case SSL_ERROR_WANT_WRITE:
512 case SSL_ERROR_WANT_CONNECT:
513 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_CONNECT", function);
516 case SSL_ERROR_WANT_ACCEPT:
517 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
520 case SSL_ERROR_WANT_X509_LOOKUP:
521 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP",
525 case SSL_ERROR_SYSCALL: {
526 int queued_error = ERR_get_error();
527 if (queued_error == 0) {
530 VLOG_WARN_RL(&rl, "%s: system error (%s)",
531 function, strerror(status));
534 VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close",
539 VLOG_WARN_RL(&rl, "%s: %s",
540 function, ERR_error_string(queued_error, NULL));
545 case SSL_ERROR_SSL: {
546 int queued_error = ERR_get_error();
547 if (queued_error != 0) {
548 VLOG_WARN_RL(&rl, "%s: %s",
549 function, ERR_error_string(queued_error, NULL));
551 VLOG_ERR_RL(&rl, "%s: SSL_ERROR_SSL without queued error",
558 VLOG_ERR_RL(&rl, "%s: bad SSL error code %d", function, error);
565 ssl_recv(struct vconn *vconn, struct ofpbuf **bufferp)
567 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
573 if (sslv->rxbuf == NULL) {
574 sslv->rxbuf = ofpbuf_new(1564);
579 if (sizeof(struct ofp_header) > rx->size) {
580 want_bytes = sizeof(struct ofp_header) - rx->size;
582 struct ofp_header *oh = rx->data;
583 size_t length = ntohs(oh->length);
584 if (length < sizeof(struct ofp_header)) {
585 VLOG_ERR_RL(&rl, "received too-short ofp_header (%zu bytes)",
589 want_bytes = length - rx->size;
596 ofpbuf_prealloc_tailroom(rx, want_bytes);
598 /* Behavior of zero-byte SSL_read is poorly defined. */
599 assert(want_bytes > 0);
601 old_state = SSL_get_state(sslv->ssl);
602 ret = SSL_read(sslv->ssl, ofpbuf_tail(rx), want_bytes);
603 if (old_state != SSL_get_state(sslv->ssl)) {
604 sslv->tx_want = SSL_NOTHING;
605 if (sslv->tx_waiter) {
606 poll_cancel(sslv->tx_waiter);
607 ssl_tx_poll_callback(sslv->fd, POLLIN, vconn);
610 sslv->rx_want = SSL_NOTHING;
614 if (ret == want_bytes) {
615 if (rx->size > sizeof(struct ofp_header)) {
625 int error = SSL_get_error(sslv->ssl, ret);
626 if (error == SSL_ERROR_ZERO_RETURN) {
627 /* Connection closed (EOF). */
629 VLOG_WARN_RL(&rl, "SSL_read: unexpected connection close");
635 return interpret_ssl_error("SSL_read", ret, error, &sslv->rx_want);
641 ssl_clear_txbuf(struct ssl_vconn *sslv)
643 ofpbuf_delete(sslv->txbuf);
645 sslv->tx_waiter = NULL;
649 ssl_register_tx_waiter(struct vconn *vconn)
651 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
652 sslv->tx_waiter = poll_fd_callback(sslv->fd,
653 want_to_poll_events(sslv->tx_want),
654 ssl_tx_poll_callback, vconn);
658 ssl_do_tx(struct vconn *vconn)
660 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
663 int old_state = SSL_get_state(sslv->ssl);
664 int ret = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
665 if (old_state != SSL_get_state(sslv->ssl)) {
666 sslv->rx_want = SSL_NOTHING;
668 sslv->tx_want = SSL_NOTHING;
670 ofpbuf_pull(sslv->txbuf, ret);
671 if (sslv->txbuf->size == 0) {
675 int ssl_error = SSL_get_error(sslv->ssl, ret);
676 if (ssl_error == SSL_ERROR_ZERO_RETURN) {
677 VLOG_WARN_RL(&rl, "SSL_write: connection closed");
680 return interpret_ssl_error("SSL_write", ret, ssl_error,
688 ssl_tx_poll_callback(int fd UNUSED, short int revents UNUSED, void *vconn_)
690 struct vconn *vconn = vconn_;
691 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
692 int error = ssl_do_tx(vconn);
693 if (error != EAGAIN) {
694 ssl_clear_txbuf(sslv);
696 ssl_register_tx_waiter(vconn);
701 ssl_send(struct vconn *vconn, struct ofpbuf *buffer)
703 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
710 sslv->txbuf = buffer;
711 error = ssl_do_tx(vconn);
714 ssl_clear_txbuf(sslv);
717 leak_checker_claim(buffer);
718 ssl_register_tx_waiter(vconn);
728 ssl_wait(struct vconn *vconn, enum vconn_wait_type wait)
730 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
734 if (vconn_connect(vconn) != EAGAIN) {
735 poll_immediate_wake();
737 switch (sslv->state) {
738 case STATE_TCP_CONNECTING:
739 poll_fd_wait(sslv->fd, POLLOUT);
742 case STATE_SSL_CONNECTING:
743 /* ssl_connect() called SSL_accept() or SSL_connect(), which
744 * set up the status that we test here. */
745 poll_fd_wait(sslv->fd,
746 want_to_poll_events(SSL_want(sslv->ssl)));
756 if (sslv->rx_want != SSL_NOTHING) {
757 poll_fd_wait(sslv->fd, want_to_poll_events(sslv->rx_want));
759 poll_immediate_wake();
765 /* We have room in our tx queue. */
766 poll_immediate_wake();
768 /* The call to ssl_tx_poll_callback() will wake us up. */
777 struct vconn_class ssl_vconn_class = {
780 ssl_close, /* close */
781 ssl_connect, /* connect */
791 struct pvconn pvconn;
795 struct pvconn_class pssl_pvconn_class;
797 static struct pssl_pvconn *
798 pssl_pvconn_cast(struct pvconn *pvconn)
800 pvconn_assert_class(pvconn, &pssl_pvconn_class);
801 return CONTAINER_OF(pvconn, struct pssl_pvconn, pvconn);
805 pssl_open(const char *name, char *suffix, struct pvconn **pvconnp)
807 struct sockaddr_in sin;
808 struct pssl_pvconn *pssl;
811 unsigned int yes = 1;
819 fd = socket(AF_INET, SOCK_STREAM, 0);
822 VLOG_ERR("%s: socket: %s", name, strerror(error));
826 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
828 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", name, strerror(errno));
832 memset(&sin, 0, sizeof sin);
833 sin.sin_family = AF_INET;
834 sin.sin_addr.s_addr = htonl(INADDR_ANY);
835 sin.sin_port = htons(atoi(suffix) ? atoi(suffix) : OFP_SSL_PORT);
836 retval = bind(fd, (struct sockaddr *) &sin, sizeof sin);
839 VLOG_ERR("%s: bind: %s", name, strerror(error));
844 retval = listen(fd, 10);
847 VLOG_ERR("%s: listen: %s", name, strerror(error));
852 retval = set_nonblocking(fd);
858 pssl = xmalloc(sizeof *pssl);
859 pvconn_init(&pssl->pvconn, &pssl_pvconn_class, name);
861 *pvconnp = &pssl->pvconn;
866 pssl_close(struct pvconn *pvconn)
868 struct pssl_pvconn *pssl = pssl_pvconn_cast(pvconn);
874 pssl_accept(struct pvconn *pvconn, struct vconn **new_vconnp)
876 struct pssl_pvconn *pssl = pssl_pvconn_cast(pvconn);
877 struct sockaddr_in sin;
878 socklen_t sin_len = sizeof sin;
883 new_fd = accept(pssl->fd, &sin, &sin_len);
886 if (error != EAGAIN) {
887 VLOG_DBG_RL(&rl, "accept: %s", strerror(error));
892 error = set_nonblocking(new_fd);
898 sprintf(name, "ssl:"IP_FMT, IP_ARGS(&sin.sin_addr));
899 if (sin.sin_port != htons(OFP_SSL_PORT)) {
900 sprintf(strchr(name, '\0'), ":%"PRIu16, ntohs(sin.sin_port));
902 return new_ssl_vconn(name, new_fd, SERVER, STATE_SSL_CONNECTING, &sin,
907 pssl_wait(struct pvconn *pvconn)
909 struct pssl_pvconn *pssl = pssl_pvconn_cast(pvconn);
910 poll_fd_wait(pssl->fd, POLLIN);
913 struct pvconn_class pssl_pvconn_class = {
922 * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
923 * OpenSSL is requesting that we call it back when the socket is ready for read
924 * or writing, respectively.
927 ssl_wants_io(int ssl_error)
929 return (ssl_error == SSL_ERROR_WANT_WRITE
930 || ssl_error == SSL_ERROR_WANT_READ);
936 static int init_status = -1;
937 if (init_status < 0) {
938 init_status = do_ssl_init();
939 assert(init_status >= 0);
950 SSL_load_error_strings();
952 method = TLSv1_method();
953 if (method == NULL) {
954 VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
958 ctx = SSL_CTX_new(method);
960 VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
963 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
964 SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
965 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
966 SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
967 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
974 tmp_dh_callback(SSL *ssl UNUSED, int is_export UNUSED, int keylength)
979 DH *(*constructor)(void);
982 static struct dh dh_table[] = {
983 {1024, NULL, get_dh1024},
984 {2048, NULL, get_dh2048},
985 {4096, NULL, get_dh4096},
990 for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
991 if (dh->keylength == keylength) {
993 dh->dh = dh->constructor();
995 ovs_fatal(ENOMEM, "out of memory constructing "
996 "Diffie-Hellman parameters");
1002 VLOG_ERR_RL(&rl, "no Diffie-Hellman parameters for key length %d",
1007 /* Returns true if SSL is at least partially configured. */
1009 vconn_ssl_is_configured(void)
1011 return has_private_key || has_certificate || has_ca_cert;
1015 vconn_ssl_set_private_key_file(const char *file_name)
1020 if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
1021 VLOG_ERR("SSL_use_PrivateKey_file: %s",
1022 ERR_error_string(ERR_get_error(), NULL));
1025 has_private_key = true;
1029 vconn_ssl_set_certificate_file(const char *file_name)
1034 if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
1035 VLOG_ERR("SSL_use_certificate_file: %s",
1036 ERR_error_string(ERR_get_error(), NULL));
1039 has_certificate = true;
1042 /* Reads the X509 certificate or certificates in file 'file_name'. On success,
1043 * stores the address of the first element in an array of pointers to
1044 * certificates in '*certs' and the number of certificates in the array in
1045 * '*n_certs', and returns 0. On failure, stores a null pointer in '*certs', 0
1046 * in '*n_certs', and returns a positive errno value.
1048 * The caller is responsible for freeing '*certs'. */
1050 read_cert_file(const char *file_name, X509 ***certs, size_t *n_certs)
1053 size_t allocated_certs = 0;
1058 file = fopen(file_name, "r");
1060 VLOG_ERR("failed to open %s for reading: %s",
1061 file_name, strerror(errno));
1069 /* Read certificate from file. */
1070 certificate = PEM_read_X509(file, NULL, NULL, NULL);
1074 VLOG_ERR("PEM_read_X509 failed reading %s: %s",
1075 file_name, ERR_error_string(ERR_get_error(), NULL));
1076 for (i = 0; i < *n_certs; i++) {
1077 X509_free((*certs)[i]);
1085 /* Add certificate to array. */
1086 if (*n_certs >= allocated_certs) {
1087 *certs = x2nrealloc(*certs, &allocated_certs, sizeof **certs);
1089 (*certs)[(*n_certs)++] = certificate;
1091 /* Are there additional certificates in the file? */
1094 } while (isspace(c));
1105 /* Sets 'file_name' as the name of a file containing one or more X509
1106 * certificates to send to the peer. Typical use in OpenFlow is to send the CA
1107 * certificate to the peer, which enables a switch to pick up the controller's
1108 * CA certificate on its first connection. */
1110 vconn_ssl_set_peer_ca_cert_file(const char *file_name)
1120 if (!read_cert_file(file_name, &certs, &n_certs)) {
1121 for (i = 0; i < n_certs; i++) {
1122 if (SSL_CTX_add_extra_chain_cert(ctx, certs[i]) != 1) {
1123 VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s",
1124 ERR_error_string(ERR_get_error(), NULL));
1131 /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */
1133 log_ca_cert(const char *file_name, X509 *cert)
1135 unsigned char digest[EVP_MAX_MD_SIZE];
1136 unsigned int n_bytes;
1141 if (!X509_digest(cert, EVP_sha1(), digest, &n_bytes)) {
1142 ds_put_cstr(&fp, "<out of memory>");
1145 for (i = 0; i < n_bytes; i++) {
1147 ds_put_char(&fp, ':');
1149 ds_put_format(&fp, "%02hhx", digest[i]);
1152 subject = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
1153 VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name,
1154 subject ? subject : "<out of memory>", ds_cstr(&fp));
1159 /* Sets 'file_name' as the name of the file from which to read the CA
1160 * certificate used to verify the peer within SSL connections. If 'bootstrap'
1161 * is false, the file must exist. If 'bootstrap' is false, then the file is
1162 * read if it is exists; if it does not, then it will be created from the CA
1163 * certificate received from the peer on the first SSL connection. */
1165 vconn_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
1175 if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
1176 bootstrap_ca_cert = true;
1177 ca_cert_file = xstrdup(file_name);
1178 } else if (!read_cert_file(file_name, &certs, &n_certs)) {
1181 /* Set up list of CAs that the server will accept from the client. */
1182 for (i = 0; i < n_certs; i++) {
1183 /* SSL_CTX_add_client_CA makes a copy of the relevant data. */
1184 if (SSL_CTX_add_client_CA(ctx, certs[i]) != 1) {
1185 VLOG_ERR("failed to add client certificate %d from %s: %s",
1187 ERR_error_string(ERR_get_error(), NULL));
1189 log_ca_cert(file_name, certs[i]);
1191 X509_free(certs[i]);
1194 /* Set up CAs for OpenSSL to trust in verifying the peer's
1196 if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
1197 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
1198 ERR_error_string(ERR_get_error(), NULL));