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
;
70 /* rx_want and tx_want record the result of the last call to SSL_read()
71 * and SSL_write(), respectively:
73 * - If the call reported that data needed to be read from the file
74 * descriptor, the corresponding member is set to SSL_READING.
76 * - If the call reported that data needed to be written to the file
77 * descriptor, the corresponding member is set to SSL_WRITING.
79 * - Otherwise, the member is set to SSL_NOTHING, indicating that the
80 * call completed successfully (or with an error) and that there is no
83 * These are needed because there is no way to ask OpenSSL what a data read
84 * or write would require without giving it a buffer to receive into or
85 * data to send, respectively. (Note that the SSL_want() status is
86 * overwritten by each SSL_read() or SSL_write() call, so we can't rely on
89 * A single call to SSL_read() or SSL_write() can perform both reading
90 * and writing and thus invalidate not one of these values but actually
91 * both. Consider this situation, for example:
93 * - SSL_write() blocks on a read, so tx_want gets SSL_READING.
95 * - SSL_read() laters succeeds reading from 'fd' and clears out the
96 * whole receive buffer, so rx_want gets SSL_READING.
98 * - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
101 * - Now we're stuck blocking until the peer sends us data, even though
102 * SSL_write() could now succeed, which could easily be a deadlock
105 * On the other hand, we can't reset both tx_want and rx_want on every call
106 * to SSL_read() or SSL_write(), because that would produce livelock,
107 * e.g. in this situation:
109 * - SSL_write() blocks, so tx_want gets SSL_READING or SSL_WRITING.
111 * - SSL_read() blocks, so rx_want gets SSL_READING or SSL_WRITING,
112 * but tx_want gets reset to SSL_NOTHING.
114 * - Client calls stream_wait(STREAM_RECV) and stream_wait(STREAM_SEND)
117 * - Client wakes up immediately since SSL_NOTHING in tx_want indicates
118 * that no blocking is necessary.
120 * The solution we adopt here is to set tx_want to SSL_NOTHING after
121 * calling SSL_read() only if the SSL state of the connection changed,
122 * which indicates that an SSL-level renegotiation made some progress, and
123 * similarly for rx_want and SSL_write(). This prevents both the
124 * deadlock and livelock situations above.
126 int rx_want
, tx_want
;
129 /* SSL context created by ssl_init(). */
132 struct ssl_config_file
{
133 bool read
; /* Whether the file was successfully read. */
134 char *file_name
; /* Configured file name, if any. */
135 struct timespec mtime
; /* File mtime as of last time we read it. */
138 /* SSL configuration files. */
139 static struct ssl_config_file private_key
;
140 static struct ssl_config_file certificate
;
141 static struct ssl_config_file ca_cert
;
143 /* Ordinarily, the SSL client and server verify each other's certificates using
144 * a CA certificate. Setting this to false disables this behavior. (This is a
146 static bool verify_peer_cert
= true;
148 /* Ordinarily, we require a CA certificate for the peer to be locally
149 * available. We can, however, bootstrap the CA certificate from the peer at
150 * the beginning of our first connection then use that certificate on all
151 * subsequent connections, saving it to a file for use in future runs also. In
152 * this case, 'bootstrap_ca_cert' is true. */
153 static bool bootstrap_ca_cert
;
155 /* Who knows what can trigger various SSL errors, so let's throttle them down
157 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(10, 25);
159 static int ssl_init(void);
160 static int do_ssl_init(void);
161 static bool ssl_wants_io(int ssl_error
);
162 static void ssl_close(struct stream
*);
163 static void ssl_clear_txbuf(struct ssl_stream
*);
164 static int interpret_ssl_error(const char *function
, int ret
, int error
,
166 static DH
*tmp_dh_callback(SSL
*ssl
, int is_export OVS_UNUSED
, int keylength
);
167 static void log_ca_cert(const char *file_name
, X509
*cert
);
168 static void stream_ssl_set_ca_cert_file__(const char *file_name
,
172 want_to_poll_events(int want
)
190 new_ssl_stream(const char *name
, int fd
, enum session_type type
,
191 enum ssl_state state
, const struct sockaddr_in
*remote
,
192 struct stream
**streamp
)
194 struct sockaddr_in local
;
195 socklen_t local_len
= sizeof local
;
196 struct ssl_stream
*sslv
;
201 /* Check for all the needful configuration. */
203 if (!private_key
.read
) {
204 VLOG_ERR("Private key must be configured to use SSL");
205 retval
= ENOPROTOOPT
;
207 if (!certificate
.read
) {
208 VLOG_ERR("Certificate must be configured to use SSL");
209 retval
= ENOPROTOOPT
;
211 if (!ca_cert
.read
&& verify_peer_cert
&& !bootstrap_ca_cert
) {
212 VLOG_ERR("CA certificate must be configured to use SSL");
213 retval
= ENOPROTOOPT
;
215 if (!SSL_CTX_check_private_key(ctx
)) {
216 VLOG_ERR("Private key does not match certificate public key: %s",
217 ERR_error_string(ERR_get_error(), NULL
));
218 retval
= ENOPROTOOPT
;
224 /* Get the local IP and port information */
225 retval
= getsockname(fd
, (struct sockaddr
*) &local
, &local_len
);
227 memset(&local
, 0, sizeof local
);
231 retval
= setsockopt(fd
, IPPROTO_TCP
, TCP_NODELAY
, &on
, sizeof on
);
233 VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name
, strerror(errno
));
238 /* Create and configure OpenSSL stream. */
241 VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL
));
242 retval
= ENOPROTOOPT
;
245 if (SSL_set_fd(ssl
, fd
) == 0) {
246 VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL
));
247 retval
= ENOPROTOOPT
;
250 if (!verify_peer_cert
|| (bootstrap_ca_cert
&& type
== CLIENT
)) {
251 SSL_set_verify(ssl
, SSL_VERIFY_NONE
, NULL
);
254 /* Create and return the ssl_stream. */
255 sslv
= xmalloc(sizeof *sslv
);
256 stream_init(&sslv
->stream
, &ssl_stream_class
, EAGAIN
, name
);
257 stream_set_remote_ip(&sslv
->stream
, remote
->sin_addr
.s_addr
);
258 stream_set_remote_port(&sslv
->stream
, remote
->sin_port
);
259 stream_set_local_ip(&sslv
->stream
, local
.sin_addr
.s_addr
);
260 stream_set_local_port(&sslv
->stream
, local
.sin_port
);
266 sslv
->rx_want
= sslv
->tx_want
= SSL_NOTHING
;
267 *streamp
= &sslv
->stream
;
278 static struct ssl_stream
*
279 ssl_stream_cast(struct stream
*stream
)
281 stream_assert_class(stream
, &ssl_stream_class
);
282 return CONTAINER_OF(stream
, struct ssl_stream
, stream
);
286 ssl_open(const char *name
, char *suffix
, struct stream
**streamp
)
288 struct sockaddr_in sin
;
296 error
= inet_open_active(SOCK_STREAM
, suffix
, OFP_SSL_PORT
, &sin
, &fd
);
298 int state
= error
? STATE_TCP_CONNECTING
: STATE_SSL_CONNECTING
;
299 return new_ssl_stream(name
, fd
, CLIENT
, state
, &sin
, streamp
);
301 VLOG_ERR("%s: connect: %s", name
, strerror(error
));
307 do_ca_cert_bootstrap(struct stream
*stream
)
309 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
310 STACK_OF(X509
) *chain
;
316 chain
= SSL_get_peer_cert_chain(sslv
->ssl
);
317 if (!chain
|| !sk_X509_num(chain
)) {
318 VLOG_ERR("could not bootstrap CA cert: no certificate presented by "
322 cert
= sk_X509_value(chain
, sk_X509_num(chain
) - 1);
324 /* Check that 'cert' is self-signed. Otherwise it is not a CA
325 * certificate and we should not attempt to use it as one. */
326 error
= X509_check_issued(cert
, cert
);
328 VLOG_ERR("could not bootstrap CA cert: obtained certificate is "
329 "not self-signed (%s)",
330 X509_verify_cert_error_string(error
));
331 if (sk_X509_num(chain
) < 2) {
332 VLOG_ERR("only one certificate was received, so probably the peer "
333 "is not configured to send its CA certificate");
338 fd
= open(ca_cert
.file_name
, O_CREAT
| O_EXCL
| O_WRONLY
, 0444);
340 if (errno
== EEXIST
) {
341 VLOG_INFO("reading CA cert %s created by another process",
343 stream_ssl_set_ca_cert_file(ca_cert
.file_name
, true);
346 VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
347 ca_cert
.file_name
, strerror(errno
));
352 file
= fdopen(fd
, "w");
355 VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
357 unlink(ca_cert
.file_name
);
361 if (!PEM_write_X509(file
, cert
)) {
362 VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
363 "%s", ca_cert
.file_name
,
364 ERR_error_string(ERR_get_error(), NULL
));
366 unlink(ca_cert
.file_name
);
372 VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
373 ca_cert
.file_name
, strerror(error
));
374 unlink(ca_cert
.file_name
);
378 VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert
.file_name
);
379 log_ca_cert(ca_cert
.file_name
, cert
);
380 bootstrap_ca_cert
= false;
383 /* SSL_CTX_add_client_CA makes a copy of cert's relevant data. */
384 SSL_CTX_add_client_CA(ctx
, cert
);
386 /* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
387 * 'cert' is owned by sslv->ssl, so we need to duplicate it. */
388 cert
= X509_dup(cert
);
392 if (SSL_CTX_load_verify_locations(ctx
, ca_cert
.file_name
, NULL
) != 1) {
393 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
394 ERR_error_string(ERR_get_error(), NULL
));
397 VLOG_INFO("killing successful connection to retry using CA cert");
402 ssl_connect(struct stream
*stream
)
404 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
407 switch (sslv
->state
) {
408 case STATE_TCP_CONNECTING
:
409 retval
= check_connection_completion(sslv
->fd
);
413 sslv
->state
= STATE_SSL_CONNECTING
;
416 case STATE_SSL_CONNECTING
:
417 retval
= (sslv
->type
== CLIENT
418 ? SSL_connect(sslv
->ssl
) : SSL_accept(sslv
->ssl
));
420 int error
= SSL_get_error(sslv
->ssl
, retval
);
421 if (retval
< 0 && ssl_wants_io(error
)) {
425 interpret_ssl_error((sslv
->type
== CLIENT
? "SSL_connect"
426 : "SSL_accept"), retval
, error
, &unused
);
427 shutdown(sslv
->fd
, SHUT_RDWR
);
430 } else if (bootstrap_ca_cert
) {
431 return do_ca_cert_bootstrap(stream
);
432 } else if (verify_peer_cert
433 && ((SSL_get_verify_mode(sslv
->ssl
)
434 & (SSL_VERIFY_NONE
| SSL_VERIFY_PEER
))
435 != SSL_VERIFY_PEER
)) {
436 /* Two or more SSL connections completed at the same time while we
437 * were in bootstrap mode. Only one of these can finish the
438 * bootstrap successfully. The other one(s) must be rejected
439 * because they were not verified against the bootstrapped CA
440 * certificate. (Alternatively we could verify them against the CA
441 * certificate, but that's more trouble than it's worth. These
442 * connections will succeed the next time they retry, assuming that
443 * they have a certificate against the correct CA.) */
444 VLOG_ERR("rejecting SSL connection during bootstrap race window");
455 ssl_close(struct stream
*stream
)
457 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
458 ssl_clear_txbuf(sslv
);
460 /* Attempt clean shutdown of the SSL connection. This will work most of
461 * the time, as long as the kernel send buffer has some free space and the
462 * SSL connection isn't renegotiating, etc. That has to be good enough,
463 * since we don't have any way to continue the close operation in the
465 SSL_shutdown(sslv
->ssl
);
473 interpret_ssl_error(const char *function
, int ret
, int error
,
480 VLOG_ERR_RL(&rl
, "%s: unexpected SSL_ERROR_NONE", function
);
483 case SSL_ERROR_ZERO_RETURN
:
484 VLOG_ERR_RL(&rl
, "%s: unexpected SSL_ERROR_ZERO_RETURN", function
);
487 case SSL_ERROR_WANT_READ
:
491 case SSL_ERROR_WANT_WRITE
:
495 case SSL_ERROR_WANT_CONNECT
:
496 VLOG_ERR_RL(&rl
, "%s: unexpected SSL_ERROR_WANT_CONNECT", function
);
499 case SSL_ERROR_WANT_ACCEPT
:
500 VLOG_ERR_RL(&rl
, "%s: unexpected SSL_ERROR_WANT_ACCEPT", function
);
503 case SSL_ERROR_WANT_X509_LOOKUP
:
504 VLOG_ERR_RL(&rl
, "%s: unexpected SSL_ERROR_WANT_X509_LOOKUP",
508 case SSL_ERROR_SYSCALL
: {
509 int queued_error
= ERR_get_error();
510 if (queued_error
== 0) {
513 VLOG_WARN_RL(&rl
, "%s: system error (%s)",
514 function
, strerror(status
));
517 VLOG_WARN_RL(&rl
, "%s: unexpected SSL connection close",
522 VLOG_WARN_RL(&rl
, "%s: %s",
523 function
, ERR_error_string(queued_error
, NULL
));
528 case SSL_ERROR_SSL
: {
529 int queued_error
= ERR_get_error();
530 if (queued_error
!= 0) {
531 VLOG_WARN_RL(&rl
, "%s: %s",
532 function
, ERR_error_string(queued_error
, NULL
));
534 VLOG_ERR_RL(&rl
, "%s: SSL_ERROR_SSL without queued error",
541 VLOG_ERR_RL(&rl
, "%s: bad SSL error code %d", function
, error
);
548 ssl_recv(struct stream
*stream
, void *buffer
, size_t n
)
550 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
554 /* Behavior of zero-byte SSL_read is poorly defined. */
557 old_state
= SSL_get_state(sslv
->ssl
);
558 ret
= SSL_read(sslv
->ssl
, buffer
, n
);
559 if (old_state
!= SSL_get_state(sslv
->ssl
)) {
560 sslv
->tx_want
= SSL_NOTHING
;
562 sslv
->rx_want
= SSL_NOTHING
;
567 int error
= SSL_get_error(sslv
->ssl
, ret
);
568 if (error
== SSL_ERROR_ZERO_RETURN
) {
571 return -interpret_ssl_error("SSL_read", ret
, error
,
578 ssl_clear_txbuf(struct ssl_stream
*sslv
)
580 ofpbuf_delete(sslv
->txbuf
);
585 ssl_do_tx(struct stream
*stream
)
587 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
590 int old_state
= SSL_get_state(sslv
->ssl
);
591 int ret
= SSL_write(sslv
->ssl
, sslv
->txbuf
->data
, sslv
->txbuf
->size
);
592 if (old_state
!= SSL_get_state(sslv
->ssl
)) {
593 sslv
->rx_want
= SSL_NOTHING
;
595 sslv
->tx_want
= SSL_NOTHING
;
597 ofpbuf_pull(sslv
->txbuf
, ret
);
598 if (sslv
->txbuf
->size
== 0) {
602 int ssl_error
= SSL_get_error(sslv
->ssl
, ret
);
603 if (ssl_error
== SSL_ERROR_ZERO_RETURN
) {
604 VLOG_WARN_RL(&rl
, "SSL_write: connection closed");
607 return interpret_ssl_error("SSL_write", ret
, ssl_error
,
615 ssl_send(struct stream
*stream
, const void *buffer
, size_t n
)
617 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
624 sslv
->txbuf
= ofpbuf_clone_data(buffer
, n
);
625 error
= ssl_do_tx(stream
);
628 ssl_clear_txbuf(sslv
);
631 leak_checker_claim(buffer
);
641 ssl_run(struct stream
*stream
)
643 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
645 if (sslv
->txbuf
&& ssl_do_tx(stream
) != EAGAIN
) {
646 ssl_clear_txbuf(sslv
);
651 ssl_run_wait(struct stream
*stream
)
653 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
655 if (sslv
->tx_want
!= SSL_NOTHING
) {
656 poll_fd_wait(sslv
->fd
, want_to_poll_events(sslv
->tx_want
));
661 ssl_wait(struct stream
*stream
, enum stream_wait_type wait
)
663 struct ssl_stream
*sslv
= ssl_stream_cast(stream
);
667 if (stream_connect(stream
) != EAGAIN
) {
668 poll_immediate_wake();
670 switch (sslv
->state
) {
671 case STATE_TCP_CONNECTING
:
672 poll_fd_wait(sslv
->fd
, POLLOUT
);
675 case STATE_SSL_CONNECTING
:
676 /* ssl_connect() called SSL_accept() or SSL_connect(), which
677 * set up the status that we test here. */
678 poll_fd_wait(sslv
->fd
,
679 want_to_poll_events(SSL_want(sslv
->ssl
)));
689 if (sslv
->rx_want
!= SSL_NOTHING
) {
690 poll_fd_wait(sslv
->fd
, want_to_poll_events(sslv
->rx_want
));
692 poll_immediate_wake();
698 /* We have room in our tx queue. */
699 poll_immediate_wake();
701 /* stream_run_wait() will do the right thing; don't bother with
711 struct stream_class ssl_stream_class
= {
714 ssl_close
, /* close */
715 ssl_connect
, /* connect */
719 ssl_run_wait
, /* run_wait */
727 struct pstream pstream
;
731 struct pstream_class pssl_pstream_class
;
733 static struct pssl_pstream
*
734 pssl_pstream_cast(struct pstream
*pstream
)
736 pstream_assert_class(pstream
, &pssl_pstream_class
);
737 return CONTAINER_OF(pstream
, struct pssl_pstream
, pstream
);
741 pssl_open(const char *name OVS_UNUSED
, char *suffix
, struct pstream
**pstreamp
)
743 struct pssl_pstream
*pssl
;
744 struct sockaddr_in sin
;
745 char bound_name
[128];
754 fd
= inet_open_passive(SOCK_STREAM
, suffix
, OFP_SSL_PORT
, &sin
);
758 sprintf(bound_name
, "pssl:%"PRIu16
":"IP_FMT
,
759 ntohs(sin
.sin_port
), IP_ARGS(&sin
.sin_addr
.s_addr
));
761 pssl
= xmalloc(sizeof *pssl
);
762 pstream_init(&pssl
->pstream
, &pssl_pstream_class
, bound_name
);
764 *pstreamp
= &pssl
->pstream
;
769 pssl_close(struct pstream
*pstream
)
771 struct pssl_pstream
*pssl
= pssl_pstream_cast(pstream
);
777 pssl_accept(struct pstream
*pstream
, struct stream
**new_streamp
)
779 struct pssl_pstream
*pssl
= pssl_pstream_cast(pstream
);
780 struct sockaddr_in sin
;
781 socklen_t sin_len
= sizeof sin
;
786 new_fd
= accept(pssl
->fd
, &sin
, &sin_len
);
789 if (error
!= EAGAIN
) {
790 VLOG_DBG_RL(&rl
, "accept: %s", strerror(error
));
795 error
= set_nonblocking(new_fd
);
801 sprintf(name
, "ssl:"IP_FMT
, IP_ARGS(&sin
.sin_addr
));
802 if (sin
.sin_port
!= htons(OFP_SSL_PORT
)) {
803 sprintf(strchr(name
, '\0'), ":%"PRIu16
, ntohs(sin
.sin_port
));
805 return new_ssl_stream(name
, new_fd
, SERVER
, STATE_SSL_CONNECTING
, &sin
,
810 pssl_wait(struct pstream
*pstream
)
812 struct pssl_pstream
*pssl
= pssl_pstream_cast(pstream
);
813 poll_fd_wait(pssl
->fd
, POLLIN
);
816 struct pstream_class pssl_pstream_class
= {
825 * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
826 * OpenSSL is requesting that we call it back when the socket is ready for read
827 * or writing, respectively.
830 ssl_wants_io(int ssl_error
)
832 return (ssl_error
== SSL_ERROR_WANT_WRITE
833 || ssl_error
== SSL_ERROR_WANT_READ
);
839 static int init_status
= -1;
840 if (init_status
< 0) {
841 init_status
= do_ssl_init();
842 assert(init_status
>= 0);
853 SSL_load_error_strings();
855 method
= TLSv1_method();
856 if (method
== NULL
) {
857 VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL
));
861 ctx
= SSL_CTX_new(method
);
863 VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL
));
866 SSL_CTX_set_options(ctx
, SSL_OP_NO_SSLv2
| SSL_OP_NO_SSLv3
);
867 SSL_CTX_set_tmp_dh_callback(ctx
, tmp_dh_callback
);
868 SSL_CTX_set_mode(ctx
, SSL_MODE_ENABLE_PARTIAL_WRITE
);
869 SSL_CTX_set_mode(ctx
, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER
);
870 SSL_CTX_set_verify(ctx
, SSL_VERIFY_PEER
| SSL_VERIFY_FAIL_IF_NO_PEER_CERT
,
877 tmp_dh_callback(SSL
*ssl OVS_UNUSED
, int is_export OVS_UNUSED
, int keylength
)
882 DH
*(*constructor
)(void);
885 static struct dh dh_table
[] = {
886 {1024, NULL
, get_dh1024
},
887 {2048, NULL
, get_dh2048
},
888 {4096, NULL
, get_dh4096
},
893 for (dh
= dh_table
; dh
< &dh_table
[ARRAY_SIZE(dh_table
)]; dh
++) {
894 if (dh
->keylength
== keylength
) {
896 dh
->dh
= dh
->constructor();
898 ovs_fatal(ENOMEM
, "out of memory constructing "
899 "Diffie-Hellman parameters");
905 VLOG_ERR_RL(&rl
, "no Diffie-Hellman parameters for key length %d",
910 /* Returns true if SSL is at least partially configured. */
912 stream_ssl_is_configured(void)
914 return private_key
.file_name
|| certificate
.file_name
|| ca_cert
.file_name
;
918 update_ssl_config(struct ssl_config_file
*config
, const char *file_name
)
920 struct timespec mtime
;
922 if (ssl_init() || !file_name
) {
926 /* If the file name hasn't changed and neither has the file contents, stop
928 get_mtime(file_name
, &mtime
);
929 if (config
->file_name
930 && !strcmp(config
->file_name
, file_name
)
931 && mtime
.tv_sec
== config
->mtime
.tv_sec
932 && mtime
.tv_nsec
== config
->mtime
.tv_nsec
) {
936 /* Update 'config'. */
937 config
->mtime
= mtime
;
938 if (file_name
!= config
->file_name
) {
939 free(config
->file_name
);
940 config
->file_name
= xstrdup(file_name
);
946 stream_ssl_set_private_key_file(const char *file_name
)
948 if (!update_ssl_config(&private_key
, file_name
)) {
951 if (SSL_CTX_use_PrivateKey_file(ctx
, file_name
, SSL_FILETYPE_PEM
) != 1) {
952 VLOG_ERR("SSL_use_PrivateKey_file: %s",
953 ERR_error_string(ERR_get_error(), NULL
));
956 private_key
.read
= true;
960 stream_ssl_set_certificate_file(const char *file_name
)
962 if (!update_ssl_config(&certificate
, file_name
)) {
965 if (SSL_CTX_use_certificate_chain_file(ctx
, file_name
) != 1) {
966 VLOG_ERR("SSL_use_certificate_file: %s",
967 ERR_error_string(ERR_get_error(), NULL
));
970 certificate
.read
= true;
973 /* Reads the X509 certificate or certificates in file 'file_name'. On success,
974 * stores the address of the first element in an array of pointers to
975 * certificates in '*certs' and the number of certificates in the array in
976 * '*n_certs', and returns 0. On failure, stores a null pointer in '*certs', 0
977 * in '*n_certs', and returns a positive errno value.
979 * The caller is responsible for freeing '*certs'. */
981 read_cert_file(const char *file_name
, X509
***certs
, size_t *n_certs
)
984 size_t allocated_certs
= 0;
989 file
= fopen(file_name
, "r");
991 VLOG_ERR("failed to open %s for reading: %s",
992 file_name
, strerror(errno
));
1000 /* Read certificate from file. */
1001 certificate
= PEM_read_X509(file
, NULL
, NULL
, NULL
);
1005 VLOG_ERR("PEM_read_X509 failed reading %s: %s",
1006 file_name
, ERR_error_string(ERR_get_error(), NULL
));
1007 for (i
= 0; i
< *n_certs
; i
++) {
1008 X509_free((*certs
)[i
]);
1016 /* Add certificate to array. */
1017 if (*n_certs
>= allocated_certs
) {
1018 *certs
= x2nrealloc(*certs
, &allocated_certs
, sizeof **certs
);
1020 (*certs
)[(*n_certs
)++] = certificate
;
1022 /* Are there additional certificates in the file? */
1025 } while (isspace(c
));
1036 /* Sets 'file_name' as the name of a file containing one or more X509
1037 * certificates to send to the peer. Typical use in OpenFlow is to send the CA
1038 * certificate to the peer, which enables a switch to pick up the controller's
1039 * CA certificate on its first connection. */
1041 stream_ssl_set_peer_ca_cert_file(const char *file_name
)
1051 if (!read_cert_file(file_name
, &certs
, &n_certs
)) {
1052 for (i
= 0; i
< n_certs
; i
++) {
1053 if (SSL_CTX_add_extra_chain_cert(ctx
, certs
[i
]) != 1) {
1054 VLOG_ERR("SSL_CTX_add_extra_chain_cert: %s",
1055 ERR_error_string(ERR_get_error(), NULL
));
1062 /* Logs fingerprint of CA certificate 'cert' obtained from 'file_name'. */
1064 log_ca_cert(const char *file_name
, X509
*cert
)
1066 unsigned char digest
[EVP_MAX_MD_SIZE
];
1067 unsigned int n_bytes
;
1072 if (!X509_digest(cert
, EVP_sha1(), digest
, &n_bytes
)) {
1073 ds_put_cstr(&fp
, "<out of memory>");
1076 for (i
= 0; i
< n_bytes
; i
++) {
1078 ds_put_char(&fp
, ':');
1080 ds_put_format(&fp
, "%02hhx", digest
[i
]);
1083 subject
= X509_NAME_oneline(X509_get_subject_name(cert
), NULL
, 0);
1084 VLOG_INFO("Trusting CA cert from %s (%s) (fingerprint %s)", file_name
,
1085 subject
? subject
: "<out of memory>", ds_cstr(&fp
));
1091 stream_ssl_set_ca_cert_file__(const char *file_name
, bool bootstrap
)
1097 if (!strcmp(file_name
, "none")) {
1098 verify_peer_cert
= false;
1099 VLOG_WARN("Peer certificate validation disabled "
1100 "(this is a security risk)");
1101 } else if (bootstrap
&& stat(file_name
, &s
) && errno
== ENOENT
) {
1102 bootstrap_ca_cert
= true;
1103 } else if (!read_cert_file(file_name
, &certs
, &n_certs
)) {
1106 /* Set up list of CAs that the server will accept from the client. */
1107 for (i
= 0; i
< n_certs
; i
++) {
1108 /* SSL_CTX_add_client_CA makes a copy of the relevant data. */
1109 if (SSL_CTX_add_client_CA(ctx
, certs
[i
]) != 1) {
1110 VLOG_ERR("failed to add client certificate %d from %s: %s",
1112 ERR_error_string(ERR_get_error(), NULL
));
1114 log_ca_cert(file_name
, certs
[i
]);
1116 X509_free(certs
[i
]);
1120 /* Set up CAs for OpenSSL to trust in verifying the peer's
1122 if (SSL_CTX_load_verify_locations(ctx
, file_name
, NULL
) != 1) {
1123 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
1124 ERR_error_string(ERR_get_error(), NULL
));
1128 bootstrap_ca_cert
= false;
1130 ca_cert
.read
= true;
1133 /* Sets 'file_name' as the name of the file from which to read the CA
1134 * certificate used to verify the peer within SSL connections. If 'bootstrap'
1135 * is false, the file must exist. If 'bootstrap' is false, then the file is
1136 * read if it is exists; if it does not, then it will be created from the CA
1137 * certificate received from the peer on the first SSL connection. */
1139 stream_ssl_set_ca_cert_file(const char *file_name
, bool bootstrap
)
1141 if (!update_ssl_config(&ca_cert
, file_name
)) {
1145 stream_ssl_set_ca_cert_file__(file_name
, bootstrap
);