2 * Copyright (c) 2008, 2009, 2010 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 "stream-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"
41 #include "stream-provider.h"
46 #define THIS_MODULE VLM_stream_ssl
65 enum session_type type;
69 unsigned int session_nr;
71 /* rx_want and tx_want record the result of the last call to SSL_read()
72 * and SSL_write(), respectively:
74 * - If the call reported that data needed to be read from the file
75 * descriptor, the corresponding member is set to SSL_READING.
77 * - If the call reported that data needed to be written to the file
78 * descriptor, the corresponding member is set to SSL_WRITING.
80 * - Otherwise, the member is set to SSL_NOTHING, indicating that the
81 * call completed successfully (or with an error) and that there is no
84 * These are needed because there is no way to ask OpenSSL what a data read
85 * or write would require without giving it a buffer to receive into or
86 * data to send, respectively. (Note that the SSL_want() status is
87 * overwritten by each SSL_read() or SSL_write() call, so we can't rely on
90 * A single call to SSL_read() or SSL_write() can perform both reading
91 * and writing and thus invalidate not one of these values but actually
92 * both. Consider this situation, for example:
94 * - SSL_write() blocks on a read, so tx_want gets SSL_READING.
96 * - SSL_read() laters succeeds reading from 'fd' and clears out the
97 * whole receive buffer, so rx_want gets SSL_READING.
99 * - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
102 * - Now we're stuck blocking until the peer sends us data, even though
103 * SSL_write() could now succeed, which could easily be a deadlock
106 * On the other hand, we can't reset both tx_want and rx_want on every call
107 * to SSL_read() or SSL_write(), because that would produce livelock,
108 * e.g. in this situation:
110 * - SSL_write() blocks, so tx_want gets SSL_READING or SSL_WRITING.
112 * - SSL_read() blocks, so rx_want gets SSL_READING or SSL_WRITING,
113 * but tx_want gets reset to SSL_NOTHING.
115 * - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
118 * - Client wakes up immediately since SSL_NOTHING in tx_want indicates
119 * that no blocking is necessary.
121 * The solution we adopt here is to set tx_want to SSL_NOTHING after
122 * calling SSL_read() only if the SSL state of the connection changed,
123 * which indicates that an SSL-level renegotiation made some progress, and
124 * similarly for rx_want and SSL_write(). This prevents both the
125 * deadlock and livelock situations above.
127 int rx_want, tx_want;
129 /* A few bytes of header data in case SSL negotiation fails. */
134 /* SSL context created by ssl_init(). */
137 struct ssl_config_file {
138 bool read; /* Whether the file was successfully read. */
139 char *file_name; /* Configured file name, if any. */
140 struct timespec mtime; /* File mtime as of last time we read it. */
143 /* SSL configuration files. */
144 static struct ssl_config_file private_key;
145 static struct ssl_config_file certificate;
146 static struct ssl_config_file ca_cert;
148 /* Ordinarily, the SSL client and server verify each other's certificates using
149 * a CA certificate. Setting this to false disables this behavior. (This is a
151 static bool verify_peer_cert = true;
153 /* Ordinarily, we require a CA certificate for the peer to be locally
154 * available. We can, however, bootstrap the CA certificate from the peer at
155 * the beginning of our first connection then use that certificate on all
156 * subsequent connections, saving it to a file for use in future runs also. In
157 * this case, 'bootstrap_ca_cert' is true. */
158 static bool bootstrap_ca_cert;
160 /* Session number. Used in debug logging messages to uniquely identify a
162 static unsigned int next_session_nr;
164 /* Who knows what can trigger various SSL errors, so let's throttle them down
166 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
168 static int ssl_init(void);
169 static int do_ssl_init(void);
170 static bool ssl_wants_io(int ssl_error);
171 static void ssl_close(struct stream *);
172 static void ssl_clear_txbuf(struct ssl_stream *);
173 static int interpret_ssl_error(const char *function, int ret, int error,
175 static DH *tmp_dh_callback(SSL *ssl, int is_export OVS_UNUSED, int keylength);
176 static void log_ca_cert(const char *file_name, X509 *cert);
177 static void stream_ssl_set_ca_cert_file__(const char *file_name,
179 static void ssl_protocol_cb(int write_p, int version, int content_type,
180 const void *, size_t, SSL *, void *sslv_);
183 want_to_poll_events(int want)
201 new_ssl_stream(const char *name, int fd, enum session_type type,
202 enum ssl_state state, const struct sockaddr_in *remote,
203 struct stream **streamp)
205 struct sockaddr_in local;
206 socklen_t local_len = sizeof local;
207 struct ssl_stream *sslv;
212 /* Check for all the needful configuration. */
214 if (!private_key.read) {
215 VLOG_ERR("Private key must be configured to use SSL");
216 retval = ENOPROTOOPT;
218 if (!certificate.read) {
219 VLOG_ERR("Certificate must be configured to use SSL");
220 retval = ENOPROTOOPT;
222 if (!ca_cert.read && verify_peer_cert && !bootstrap_ca_cert) {
223 VLOG_ERR("CA certificate must be configured to use SSL");
224 retval = ENOPROTOOPT;
226 if (!SSL_CTX_check_private_key(ctx)) {
227 VLOG_ERR("Private key does not match certificate public key: %s",
228 ERR_error_string(ERR_get_error(), NULL));
229 retval = ENOPROTOOPT;
235 /* Get the local IP and port information */
236 retval = getsockname(fd, (struct sockaddr *) &local, &local_len);
238 memset(&local, 0, sizeof local);
242 retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
244 VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
249 /* Create and configure OpenSSL stream. */
252 VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
253 retval = ENOPROTOOPT;
256 if (SSL_set_fd(ssl, fd) == 0) {
257 VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
258 retval = ENOPROTOOPT;
261 if (!verify_peer_cert || (bootstrap_ca_cert && type == CLIENT)) {
262 SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL);
265 /* Create and return the ssl_stream. */
266 sslv = xmalloc(sizeof *sslv);
267 stream_init(&sslv->stream, &ssl_stream_class, EAGAIN, name);
268 stream_set_remote_ip(&sslv->stream, remote->sin_addr.s_addr);
269 stream_set_remote_port(&sslv->stream, remote->sin_port);
270 stream_set_local_ip(&sslv->stream, local.sin_addr.s_addr);
271 stream_set_local_port(&sslv->stream, local.sin_port);
277 sslv->rx_want = sslv->tx_want = SSL_NOTHING;
278 sslv->session_nr = next_session_nr++;
281 if (VLOG_IS_DBG_ENABLED()) {
282 SSL_set_msg_callback(ssl, ssl_protocol_cb);
283 SSL_set_msg_callback_arg(ssl, sslv);
286 *streamp = &sslv->stream;
297 static struct ssl_stream *
298 ssl_stream_cast(struct stream *stream)
300 stream_assert_class(stream, &ssl_stream_class);
301 return CONTAINER_OF(stream, struct ssl_stream, stream);
305 ssl_open(const char *name, char *suffix, struct stream **streamp)
307 struct sockaddr_in sin;
315 error = inet_open_active(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin, &fd);
317 int state = error ? STATE_TCP_CONNECTING : STATE_SSL_CONNECTING;
318 return new_ssl_stream(name, fd, CLIENT, state, &sin, streamp);
320 VLOG_ERR("%s: connect: %s", name, strerror(error));
326 do_ca_cert_bootstrap(struct stream *stream)
328 struct ssl_stream *sslv = ssl_stream_cast(stream);
329 STACK_OF(X509) *chain;
335 chain = SSL_get_peer_cert_chain(sslv->ssl);
336 if (!chain || !sk_X509_num(chain)) {
337 VLOG_ERR("could not bootstrap CA cert: no certificate presented by "
341 cert = sk_X509_value(chain, sk_X509_num(chain) - 1);
343 /* Check that 'cert' is self-signed. Otherwise it is not a CA
344 * certificate and we should not attempt to use it as one. */
345 error = X509_check_issued(cert, cert);
347 VLOG_ERR("could not bootstrap CA cert: obtained certificate is "
348 "not self-signed (%s)",
349 X509_verify_cert_error_string(error));
350 if (sk_X509_num(chain) < 2) {
351 VLOG_ERR("only one certificate was received, so probably the peer "
352 "is not configured to send its CA certificate");
357 fd = open(ca_cert.file_name, O_CREAT | O_EXCL | O_WRONLY, 0444);
359 if (errno == EEXIST) {
360 VLOG_INFO("reading CA cert %s created by another process",
362 stream_ssl_set_ca_cert_file(ca_cert.file_name, true);
365 VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
366 ca_cert.file_name, strerror(errno));
371 file = fdopen(fd, "w");
374 VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
376 unlink(ca_cert.file_name);
380 if (!PEM_write_X509(file, cert)) {
381 VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
382 "%s", ca_cert.file_name,
383 ERR_error_string(ERR_get_error(), NULL));
385 unlink(ca_cert.file_name);
391 VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
392 ca_cert.file_name, strerror(error));
393 unlink(ca_cert.file_name);
397 VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert.file_name);
398 log_ca_cert(ca_cert.file_name, cert);
399 bootstrap_ca_cert = false;
402 /* SSL_CTX_add_client_CA makes a copy of cert's relevant data. */
403 SSL_CTX_add_client_CA(ctx, cert);
405 /* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
406 * 'cert' is owned by sslv->ssl, so we need to duplicate it. */
407 cert = X509_dup(cert);
411 if (SSL_CTX_load_verify_locations(ctx, ca_cert.file_name, NULL) != 1) {
412 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
413 ERR_error_string(ERR_get_error(), NULL));
416 VLOG_INFO("killing successful connection to retry using CA cert");
421 ssl_connect(struct stream *stream)
423 struct ssl_stream *sslv = ssl_stream_cast(stream);
426 switch (sslv->state) {
427 case STATE_TCP_CONNECTING:
428 retval = check_connection_completion(sslv->fd);
432 sslv->state = STATE_SSL_CONNECTING;
435 case STATE_SSL_CONNECTING:
436 /* Capture the first few bytes of received data so that we can guess
437 * what kind of funny data we've been sent if SSL negotation fails. */
438 if (sslv->n_head <= 0) {
439 sslv->n_head = recv(sslv->fd, sslv->head, sizeof sslv->head,
443 retval = (sslv->type == CLIENT
444 ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
446 int error = SSL_get_error(sslv->ssl, retval);
447 if (retval < 0 && ssl_wants_io(error)) {
451 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
452 : "SSL_accept"), retval, error, &unused);
453 shutdown(sslv->fd, SHUT_RDWR);
454 stream_report_content(sslv->head, sslv->n_head, STREAM_SSL,
455 THIS_MODULE, stream_get_name(stream));
458 } else if (bootstrap_ca_cert) {
459 return do_ca_cert_bootstrap(stream);
460 } else if (verify_peer_cert
461 && ((SSL_get_verify_mode(sslv->ssl)
462 & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
463 != SSL_VERIFY_PEER)) {
464 /* Two or more SSL connections completed at the same time while we
465 * were in bootstrap mode. Only one of these can finish the
466 * bootstrap successfully. The other one(s) must be rejected
467 * because they were not verified against the bootstrapped CA
468 * certificate. (Alternatively we could verify them against the CA
469 * certificate, but that's more trouble than it's worth. These
470 * connections will succeed the next time they retry, assuming that
471 * they have a certificate against the correct CA.) */
472 VLOG_ERR("rejecting SSL connection during bootstrap race window");
483 ssl_close(struct stream *stream)
485 struct ssl_stream *sslv = ssl_stream_cast(stream);
486 ssl_clear_txbuf(sslv);
488 /* Attempt clean shutdown of the SSL connection. This will work most of
489 * the time, as long as the kernel send buffer has some free space and the
490 * SSL connection isn't renegotiating, etc. That has to be good enough,
491 * since we don't have any way to continue the close operation in the
493 SSL_shutdown(sslv->ssl);
495 /* SSL_shutdown() might have signaled an error, in which case we need to
496 * flush it out of the OpenSSL error queue or the next OpenSSL operation
497 * will falsely signal an error. */
506 interpret_ssl_error(const char *function, int ret, int error,
513 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_NONE", function);
516 case SSL_ERROR_ZERO_RETURN:
517 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_ZERO_RETURN", function);
520 case SSL_ERROR_WANT_READ:
524 case SSL_ERROR_WANT_WRITE:
528 case SSL_ERROR_WANT_CONNECT:
529 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_CONNECT", function);
532 case SSL_ERROR_WANT_ACCEPT:
533 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
536 case SSL_ERROR_WANT_X509_LOOKUP:
537 VLOG_ERR_RL(&rl, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP",
541 case SSL_ERROR_SYSCALL: {
542 int queued_error = ERR_get_error();
543 if (queued_error == 0) {
546 VLOG_WARN_RL(&rl, "%s: system error (%s)",
547 function, strerror(status));
550 VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close",
555 VLOG_WARN_RL(&rl, "%s: %s",
556 function, ERR_error_string(queued_error, NULL));
561 case SSL_ERROR_SSL: {
562 int queued_error = ERR_get_error();
563 if (queued_error != 0) {
564 VLOG_WARN_RL(&rl, "%s: %s",
565 function, ERR_error_string(queued_error, NULL));
567 VLOG_ERR_RL(&rl, "%s: SSL_ERROR_SSL without queued error",
574 VLOG_ERR_RL(&rl, "%s: bad SSL error code %d", function, error);
581 ssl_recv(struct stream *stream, void *buffer, size_t n)
583 struct ssl_stream *sslv = ssl_stream_cast(stream);
587 /* Behavior of zero-byte SSL_read is poorly defined. */
590 old_state = SSL_get_state(sslv->ssl);
591 ret = SSL_read(sslv->ssl, buffer, n);
592 if (old_state != SSL_get_state(sslv->ssl)) {
593 sslv->tx_want = SSL_NOTHING;
595 sslv->rx_want = SSL_NOTHING;
600 int error = SSL_get_error(sslv->ssl, ret);
601 if (error == SSL_ERROR_ZERO_RETURN) {
604 return -interpret_ssl_error("SSL_read", ret, error,
611 ssl_clear_txbuf(struct ssl_stream *sslv)
613 ofpbuf_delete(sslv->txbuf);
618 ssl_do_tx(struct stream *stream)
620 struct ssl_stream *sslv = ssl_stream_cast(stream);
623 int old_state = SSL_get_state(sslv->ssl);
624 int ret = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
625 if (old_state != SSL_get_state(sslv->ssl)) {
626 sslv->rx_want = SSL_NOTHING;
628 sslv->tx_want = SSL_NOTHING;
630 ofpbuf_pull(sslv->txbuf, ret);
631 if (sslv->txbuf->size == 0) {
635 int ssl_error = SSL_get_error(sslv->ssl, ret);
636 if (ssl_error == SSL_ERROR_ZERO_RETURN) {
637 VLOG_WARN_RL(&rl, "SSL_write: connection closed");
640 return interpret_ssl_error("SSL_write", ret, ssl_error,
648 ssl_send(struct stream *stream, const void *buffer, size_t n)
650 struct ssl_stream *sslv = ssl_stream_cast(stream);
657 sslv->txbuf = ofpbuf_clone_data(buffer, n);
658 error = ssl_do_tx(stream);
661 ssl_clear_txbuf(sslv);
664 leak_checker_claim(buffer);
674 ssl_run(struct stream *stream)
676 struct ssl_stream *sslv = ssl_stream_cast(stream);
678 if (sslv->txbuf && ssl_do_tx(stream) != EAGAIN) {
679 ssl_clear_txbuf(sslv);
684 ssl_run_wait(struct stream *stream)
686 struct ssl_stream *sslv = ssl_stream_cast(stream);
688 if (sslv->tx_want != SSL_NOTHING) {
689 poll_fd_wait(sslv->fd, want_to_poll_events(sslv->tx_want));
694 ssl_wait(struct stream *stream, enum stream_wait_type wait)
696 struct ssl_stream *sslv = ssl_stream_cast(stream);
700 if (stream_connect(stream) != EAGAIN) {
701 poll_immediate_wake();
703 switch (sslv->state) {
704 case STATE_TCP_CONNECTING:
705 poll_fd_wait(sslv->fd, POLLOUT);
708 case STATE_SSL_CONNECTING:
709 /* ssl_connect() called SSL_accept() or SSL_connect(), which
710 * set up the status that we test here. */
711 poll_fd_wait(sslv->fd,
712 want_to_poll_events(SSL_want(sslv->ssl)));
722 if (sslv->rx_want != SSL_NOTHING) {
723 poll_fd_wait(sslv->fd, want_to_poll_events(sslv->rx_want));
725 poll_immediate_wake();
731 /* We have room in our tx queue. */
732 poll_immediate_wake();
734 /* stream_run_wait() will do the right thing; don't bother with
744 struct stream_class ssl_stream_class = {
747 ssl_close, /* close */
748 ssl_connect, /* connect */
752 ssl_run_wait, /* run_wait */
760 struct pstream pstream;
764 struct pstream_class pssl_pstream_class;
766 static struct pssl_pstream *
767 pssl_pstream_cast(struct pstream *pstream)
769 pstream_assert_class(pstream, &pssl_pstream_class);
770 return CONTAINER_OF(pstream, struct pssl_pstream, pstream);
774 pssl_open(const char *name OVS_UNUSED, char *suffix, struct pstream **pstreamp)
776 struct pssl_pstream *pssl;
777 struct sockaddr_in sin;
778 char bound_name[128];
787 fd = inet_open_passive(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin);
791 sprintf(bound_name, "pssl:%"PRIu16":"IP_FMT,
792 ntohs(sin.sin_port), IP_ARGS(&sin.sin_addr.s_addr));
794 pssl = xmalloc(sizeof *pssl);
795 pstream_init(&pssl->pstream, &pssl_pstream_class, bound_name);
797 *pstreamp = &pssl->pstream;
802 pssl_close(struct pstream *pstream)
804 struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
810 pssl_accept(struct pstream *pstream, struct stream **new_streamp)
812 struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
813 struct sockaddr_in sin;
814 socklen_t sin_len = sizeof sin;
819 new_fd = accept(pssl->fd, &sin, &sin_len);
822 if (error != EAGAIN) {
823 VLOG_DBG_RL(&rl, "accept: %s", strerror(error));
828 error = set_nonblocking(new_fd);
834 sprintf(name, "ssl:"IP_FMT, IP_ARGS(&sin.sin_addr));
835 if (sin.sin_port != htons(OFP_SSL_PORT)) {
836 sprintf(strchr(name, '\0'), ":%"PRIu16, ntohs(sin.sin_port));
838 return new_ssl_stream(name, new_fd, SERVER, STATE_SSL_CONNECTING, &sin,
843 pssl_wait(struct pstream *pstream)
845 struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
846 poll_fd_wait(pssl->fd, POLLIN);
849 struct pstream_class pssl_pstream_class = {
858 * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
859 * OpenSSL is requesting that we call it back when the socket is ready for read
860 * or writing, respectively.
863 ssl_wants_io(int ssl_error)
865 return (ssl_error == SSL_ERROR_WANT_WRITE
866 || ssl_error == SSL_ERROR_WANT_READ);
872 static int init_status = -1;
873 if (init_status < 0) {
874 init_status = do_ssl_init();
875 assert(init_status >= 0);
886 SSL_load_error_strings();
888 method = TLSv1_method();
889 if (method == NULL) {
890 VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
894 ctx = SSL_CTX_new(method);
896 VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
899 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
900 SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
901 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
902 SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
903 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
910 tmp_dh_callback(SSL *ssl OVS_UNUSED, int is_export OVS_UNUSED, int keylength)
915 DH *(*constructor)(void);
918 static struct dh dh_table[] = {
919 {1024, NULL, get_dh1024},
920 {2048, NULL, get_dh2048},
921 {4096, NULL, get_dh4096},
926 for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
927 if (dh->keylength == keylength) {
929 dh->dh = dh->constructor();
931 ovs_fatal(ENOMEM, "out of memory constructing "
932 "Diffie-Hellman parameters");
938 VLOG_ERR_RL(&rl, "no Diffie-Hellman parameters for key length %d",
943 /* Returns true if SSL is at least partially configured. */
945 stream_ssl_is_configured(void)
947 return private_key.file_name || certificate.file_name || ca_cert.file_name;
951 update_ssl_config(struct ssl_config_file *config, const char *file_name)
953 struct timespec mtime;
955 if (ssl_init() || !file_name) {
959 /* If the file name hasn't changed and neither has the file contents, stop
961 get_mtime(file_name, &mtime);
962 if (config->file_name
963 && !strcmp(config->file_name, file_name)
964 && mtime.tv_sec == config->mtime.tv_sec
965 && mtime.tv_nsec == config->mtime.tv_nsec) {
969 /* Update 'config'. */
970 config->mtime = mtime;
971 if (file_name != config->file_name) {
972 free(config->file_name);
973 config->file_name = xstrdup(file_name);
979 stream_ssl_set_private_key_file(const char *file_name)
981 if (!update_ssl_config(&private_key, file_name)) {
984 if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
985 VLOG_ERR("SSL_use_PrivateKey_file: %s",
986 ERR_error_string(ERR_get_error(), NULL));
989 private_key.read = true;
993 stream_ssl_set_certificate_file(const char *file_name)
995 if (!update_ssl_config(&certificate, file_name)) {
998 if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
999 VLOG_ERR("SSL_use_certificate_file: %s",
1000 ERR_error_string(ERR_get_error(), NULL));
1003 certificate.read = true;
1006 /* Reads the X509 certificate or certificates in file 'file_name'. On success,
1007 * stores the address of the first element in an array of pointers to
1008 * certificates in '*certs' and the number of certificates in the array in
1009 * '*n_certs', and returns 0. On failure, stores a null pointer in '*certs', 0
1010 * in '*n_certs', and returns a positive errno value.
1012 * The caller is responsible for freeing '*certs'. */
1014 read_cert_file(const char *file_name, X509 ***certs, size_t *n_certs)
1017 size_t allocated_certs = 0;
1022 file = fopen(file_name, "r");
1024 VLOG_ERR("failed to open %s for reading: %s",
1025 file_name, strerror(errno));
1033 /* Read certificate from file. */
1034 certificate = PEM_read_X509(file, NULL, NULL, NULL);
1038 VLOG_ERR("PEM_read_X509 failed reading %s: %s",
1039 file_name, ERR_error_string(ERR_get_error(), NULL));
1040 for (i = 0; i < *n_certs; i++) {
1041 X509_free((*certs)[i]);
1049 /* Add certificate to array. */
1050 if (*n_certs >= allocated_certs) {
1051 *certs = x2nrealloc(*certs, &allocated_certs, sizeof **certs);
1053 (*certs)[(*n_certs)++] = certificate;
1055 /* Are there additional certificates in the file? */
1058 } while (isspace(c));
1069 /* Sets 'file_name' as the name of a file containing one or more X509
1070 * certificates to send to the peer. Typical use in OpenFlow is to send the CA
1071 * certificate to the peer, which enables a switch to pick up the controller's
1072 * CA certificate on its first connection. */
1074 stream_ssl_set_peer_ca_cert_file(const char *file_name)
1084 if (!read_cert_file(file_name, &certs, &n_certs)) {
1085 for (i = 0; i < n_certs; i++) {
1086 if (SSL_CTX_add_extra_chain_cert(ctx, certs[i]) != 1) {
1087 VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s",
1088 ERR_error_string(ERR_get_error(), NULL));
1095 /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */
1097 log_ca_cert(const char *file_name, X509 *cert)
1099 unsigned char digest[EVP_MAX_MD_SIZE];
1100 unsigned int n_bytes;
1105 if (!X509_digest(cert, EVP_sha1(), digest, &n_bytes)) {
1106 ds_put_cstr(&fp, "<out of memory>");
1109 for (i = 0; i < n_bytes; i++) {
1111 ds_put_char(&fp, ':');
1113 ds_put_format(&fp, "%02hhx", digest[i]);
1116 subject = X509_NAME_oneline(X509_get_subject_name(cert), NULL, 0);
1117 VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name,
1118 subject ? subject : "<out of memory>", ds_cstr(&fp));
1124 stream_ssl_set_ca_cert_file__(const char *file_name, bool bootstrap)
1130 if (!strcmp(file_name, "none")) {
1131 verify_peer_cert = false;
1132 VLOG_WARN("Peer certificate validation disabled "
1133 "(this is a security risk)");
1134 } else if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
1135 bootstrap_ca_cert = true;
1136 } else if (!read_cert_file(file_name, &certs, &n_certs)) {
1139 /* Set up list of CAs that the server will accept from the client. */
1140 for (i = 0; i < n_certs; i++) {
1141 /* SSL_CTX_add_client_CA makes a copy of the relevant data. */
1142 if (SSL_CTX_add_client_CA(ctx, certs[i]) != 1) {
1143 VLOG_ERR("failed to add client certificate %d from %s: %s",
1145 ERR_error_string(ERR_get_error(), NULL));
1147 log_ca_cert(file_name, certs[i]);
1149 X509_free(certs[i]);
1153 /* Set up CAs for OpenSSL to trust in verifying the peer's
1155 if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
1156 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
1157 ERR_error_string(ERR_get_error(), NULL));
1161 bootstrap_ca_cert = false;
1163 ca_cert.read = true;
1166 /* Sets 'file_name' as the name of the file from which to read the CA
1167 * certificate used to verify the peer within SSL connections. If 'bootstrap'
1168 * is false, the file must exist. If 'bootstrap' is false, then the file is
1169 * read if it is exists; if it does not, then it will be created from the CA
1170 * certificate received from the peer on the first SSL connection. */
1172 stream_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
1174 if (!update_ssl_config(&ca_cert, file_name)) {
1178 stream_ssl_set_ca_cert_file__(file_name, bootstrap);
1181 /* SSL protocol logging. */
1184 ssl_alert_level_to_string(uint8_t type)
1187 case 1: return "warning";
1188 case 2: return "fatal";
1189 default: return "<unknown>";
1194 ssl_alert_description_to_string(uint8_t type)
1197 case 0: return "close_notify";
1198 case 10: return "unexpected_message";
1199 case 20: return "bad_record_mac";
1200 case 21: return "decryption_failed";
1201 case 22: return "record_overflow";
1202 case 30: return "decompression_failure";
1203 case 40: return "handshake_failure";
1204 case 42: return "bad_certificate";
1205 case 43: return "unsupported_certificate";
1206 case 44: return "certificate_revoked";
1207 case 45: return "certificate_expired";
1208 case 46: return "certificate_unknown";
1209 case 47: return "illegal_parameter";
1210 case 48: return "unknown_ca";
1211 case 49: return "access_denied";
1212 case 50: return "decode_error";
1213 case 51: return "decrypt_error";
1214 case 60: return "export_restriction";
1215 case 70: return "protocol_version";
1216 case 71: return "insufficient_security";
1217 case 80: return "internal_error";
1218 case 90: return "user_canceled";
1219 case 100: return "no_renegotiation";
1220 default: return "<unknown>";
1225 ssl_handshake_type_to_string(uint8_t type)
1228 case 0: return "hello_request";
1229 case 1: return "client_hello";
1230 case 2: return "server_hello";
1231 case 11: return "certificate";
1232 case 12: return "server_key_exchange";
1233 case 13: return "certificate_request";
1234 case 14: return "server_hello_done";
1235 case 15: return "certificate_verify";
1236 case 16: return "client_key_exchange";
1237 case 20: return "finished";
1238 default: return "<unknown>";
1243 ssl_protocol_cb(int write_p, int version OVS_UNUSED, int content_type,
1244 const void *buf_, size_t len, SSL *ssl OVS_UNUSED, void *sslv_)
1246 const struct ssl_stream *sslv = sslv_;
1247 const uint8_t *buf = buf_;
1250 if (!VLOG_IS_DBG_ENABLED()) {
1255 if (content_type == 20) {
1256 ds_put_cstr(&details, "change_cipher_spec");
1257 } else if (content_type == 21) {
1258 ds_put_format(&details, "alert: %s, %s",
1259 ssl_alert_level_to_string(buf[0]),
1260 ssl_alert_description_to_string(buf[1]));
1261 } else if (content_type == 22) {
1262 ds_put_format(&details, "handshake: %s",
1263 ssl_handshake_type_to_string(buf[0]));
1265 ds_put_format(&details, "type %d", content_type);
1268 VLOG_DBG("%s%u%s%s %s (%zu bytes)",
1269 sslv->type == CLIENT ? "client" : "server",
1270 sslv->session_nr, write_p ? "-->" : "<--",
1271 stream_get_name(&sslv->stream), ds_cstr(&details), len);
1273 ds_destroy(&details);