/*
- * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <config.h>
#include "stream-ssl.h"
#include "dhparams.h"
-#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <inttypes.h>
#include <string.h>
+#include <sys/types.h>
+#include <sys/socket.h>
#include <netinet/tcp.h>
#include <openssl/err.h>
+#include <openssl/rand.h>
#include <openssl/ssl.h>
#include <openssl/x509v3.h>
#include <poll.h>
#include <unistd.h>
#include "coverage.h"
#include "dynamic-string.h"
-#include "leak-checker.h"
+#include "entropy.h"
#include "ofpbuf.h"
#include "openflow/openflow.h"
#include "packets.h"
VLOG_DEFINE_THIS_MODULE(stream_ssl);
-COVERAGE_DEFINE(ssl_session);
-COVERAGE_DEFINE(ssl_session_reused);
-
/* Active SSL. */
enum ssl_state {
/* SSL context created by ssl_init(). */
static SSL_CTX *ctx;
-/* Maps from stream target (e.g. "127.0.0.1:1234") to SSL_SESSION *. The
- * sessions are those from the last SSL connection to the given target.
- * OpenSSL caches server-side sessions internally, so this cache is only used
- * for client connections.
- *
- * The stream_ssl module owns a reference to each of the sessions in this
- * table, so they must be freed with SSL_SESSION_free() when they are no
- * longer needed. */
-static struct shash client_sessions = SHASH_INITIALIZER(&client_sessions);
-
-/* Maximum number of client sessions to cache. Ordinarily I'd expect that one
- * session would be sufficient but this should cover it. */
-#define MAX_CLIENT_SESSION_CACHE 16
-
struct ssl_config_file {
bool read; /* Whether the file was successfully read. */
char *file_name; /* Configured file name, if any. */
static DH *tmp_dh_callback(SSL *ssl, int is_export OVS_UNUSED, int keylength);
static void log_ca_cert(const char *file_name, X509 *cert);
static void stream_ssl_set_ca_cert_file__(const char *file_name,
- bool bootstrap);
+ bool bootstrap, bool force);
static void ssl_protocol_cb(int write_p, int version, int content_type,
const void *, size_t, SSL *, void *sslv_);
+static bool update_ssl_config(struct ssl_config_file *, const char *file_name);
static short int
want_to_poll_events(int want)
static int
new_ssl_stream(const char *name, int fd, enum session_type type,
- enum ssl_state state, const struct sockaddr_in *remote,
- struct stream **streamp)
+ enum ssl_state state, const struct sockaddr_in *remote,
+ struct stream **streamp)
{
struct sockaddr_in local;
socklen_t local_len = sizeof local;
VLOG_ERR("CA certificate must be configured to use SSL");
retval = ENOPROTOOPT;
}
- if (!SSL_CTX_check_private_key(ctx)) {
+ if (!retval && !SSL_CTX_check_private_key(ctx)) {
VLOG_ERR("Private key does not match certificate public key: %s",
ERR_error_string(ERR_get_error(), NULL));
retval = ENOPROTOOPT;
/* Disable Nagle. */
retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
if (retval) {
- VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
+ VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, ovs_strerror(errno));
retval = errno;
goto error;
}
if (!verify_peer_cert || (bootstrap_ca_cert && type == CLIENT)) {
SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL);
}
- if (type == CLIENT) {
- /* Grab SSL session information from the cache. */
- SSL_SESSION *session = shash_find_data(&client_sessions, name);
- if (session && SSL_set_session(ssl, session) != 1) {
- interpret_queued_ssl_error("SSL_set_session");
- }
- }
/* Create and return the ssl_stream. */
sslv = xmalloc(sizeof *sslv);
}
static int
-ssl_open(const char *name, char *suffix, struct stream **streamp)
+ssl_open(const char *name, char *suffix, struct stream **streamp, uint8_t dscp)
{
struct sockaddr_in sin;
int error, fd;
return error;
}
- error = inet_open_active(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin, &fd);
+ error = inet_open_active(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin, &fd,
+ dscp);
if (fd >= 0) {
int state = error ? STATE_TCP_CONNECTING : STATE_SSL_CONNECTING;
return new_ssl_stream(name, fd, CLIENT, state, &sin, streamp);
} else {
- VLOG_ERR("%s: connect: %s", name, strerror(error));
+ VLOG_ERR("%s: connect: %s", name, ovs_strerror(error));
return error;
}
}
fd = open(ca_cert.file_name, O_CREAT | O_EXCL | O_WRONLY, 0444);
if (fd < 0) {
if (errno == EEXIST) {
- VLOG_INFO("reading CA cert %s created by another process",
- ca_cert.file_name);
- stream_ssl_set_ca_cert_file(ca_cert.file_name, true);
+ VLOG_INFO_RL(&rl, "reading CA cert %s created by another process",
+ ca_cert.file_name);
+ stream_ssl_set_ca_cert_file__(ca_cert.file_name, true, true);
return EPROTO;
} else {
VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
- ca_cert.file_name, strerror(errno));
+ ca_cert.file_name, ovs_strerror(errno));
return errno;
}
}
if (!file) {
error = errno;
VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
- strerror(error));
+ ovs_strerror(error));
unlink(ca_cert.file_name);
return error;
}
if (fclose(file)) {
error = errno;
VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
- ca_cert.file_name, strerror(error));
+ ca_cert.file_name, ovs_strerror(error));
unlink(ca_cert.file_name);
return error;
}
if (!cert) {
out_of_memory();
}
+ SSL_CTX_set_cert_store(ctx, X509_STORE_new());
if (SSL_CTX_load_verify_locations(ctx, ca_cert.file_name, NULL) != 1) {
VLOG_ERR("SSL_CTX_load_verify_locations: %s",
ERR_error_string(ERR_get_error(), NULL));
return EPROTO;
}
-static void
-ssl_delete_session(struct shash_node *node)
-{
- SSL_SESSION *session = node->data;
- SSL_SESSION_free(session);
- shash_delete(&client_sessions, node);
-}
-
-/* Find and free any previously cached session for 'stream''s target. */
-static void
-ssl_flush_session(struct stream *stream)
-{
- struct shash_node *node;
-
- node = shash_find(&client_sessions, stream_get_name(stream));
- if (node) {
- ssl_delete_session(node);
- }
-}
-
-/* Add 'stream''s session to the cache for its target, so that it will be
- * reused for future SSL connections to the same target. */
-static void
-ssl_cache_session(struct stream *stream)
-{
- struct ssl_stream *sslv = ssl_stream_cast(stream);
- SSL_SESSION *session;
-
- /* Get session from stream. */
- session = SSL_get1_session(sslv->ssl);
- if (session) {
- SSL_SESSION *old_session;
-
- old_session = shash_replace(&client_sessions, stream_get_name(stream),
- session);
- if (old_session) {
- /* Free the session that we replaced. (We might actually have
- * session == old_session, but either way we have to free it to
- * avoid leaking a reference.) */
- SSL_SESSION_free(old_session);
- } else if (shash_count(&client_sessions) > MAX_CLIENT_SESSION_CACHE) {
- for (;;) {
- struct shash_node *node = shash_random_node(&client_sessions);
- if (node->data != session) {
- ssl_delete_session(node);
- break;
- }
- }
- }
- }
-}
-
static int
ssl_connect(struct stream *stream)
{
case STATE_SSL_CONNECTING:
/* Capture the first few bytes of received data so that we can guess
- * what kind of funny data we've been sent if SSL negotation fails. */
+ * what kind of funny data we've been sent if SSL negotiation fails. */
if (sslv->n_head <= 0) {
sslv->n_head = recv(sslv->fd, sslv->head, sizeof sslv->head,
MSG_PEEK);
} else {
int unused;
- if (sslv->type == CLIENT) {
- /* Delete any cached session for this stream's target.
- * Otherwise a single error causes recurring errors that
- * don't resolve until the SSL client or server is
- * restarted. (It can take dozens of reused connections to
- * see this behavior, so this is difficult to test.) If we
- * delete the session on the first error, though, the error
- * only occurs once and then resolves itself. */
- ssl_flush_session(stream);
- }
-
interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
: "SSL_accept"), retval, error, &unused);
shutdown(sslv->fd, SHUT_RDWR);
* certificate, but that's more trouble than it's worth. These
* connections will succeed the next time they retry, assuming that
* they have a certificate against the correct CA.) */
- VLOG_ERR("rejecting SSL connection during bootstrap race window");
+ VLOG_INFO("rejecting SSL connection during bootstrap race window");
return EPROTO;
} else {
- /* Statistics. */
- COVERAGE_INC(ssl_session);
- if (SSL_session_reused(sslv->ssl)) {
- COVERAGE_INC(ssl_session_reused);
- }
return 0;
}
}
* background. */
SSL_shutdown(sslv->ssl);
- ssl_cache_session(stream);
-
/* SSL_shutdown() might have signaled an error, in which case we need to
* flush it out of the OpenSSL error queue or the next OpenSSL operation
* will falsely signal an error. */
if (ret < 0) {
int status = errno;
VLOG_WARN_RL(&rl, "%s: system error (%s)",
- function, strerror(status));
+ function, ovs_strerror(status));
return status;
} else {
VLOG_WARN_RL(&rl, "%s: unexpected SSL connection close",
ssize_t ret;
/* Behavior of zero-byte SSL_read is poorly defined. */
- assert(n > 0);
+ ovs_assert(n > 0);
old_state = SSL_get_state(sslv->ssl);
ret = SSL_read(sslv->ssl, buffer, n);
ssl_clear_txbuf(sslv);
return n;
case EAGAIN:
- leak_checker_claim(buffer);
return n;
default:
sslv->txbuf = NULL;
}
}
-struct stream_class ssl_stream_class = {
+const struct stream_class ssl_stream_class = {
"ssl", /* name */
+ true, /* needs_probes */
ssl_open, /* open */
ssl_close, /* close */
ssl_connect, /* connect */
int fd;
};
-struct pstream_class pssl_pstream_class;
+const struct pstream_class pssl_pstream_class;
static struct pssl_pstream *
pssl_pstream_cast(struct pstream *pstream)
}
static int
-pssl_open(const char *name OVS_UNUSED, char *suffix, struct pstream **pstreamp)
+pssl_open(const char *name OVS_UNUSED, char *suffix, struct pstream **pstreamp,
+ uint8_t dscp)
{
struct pssl_pstream *pssl;
struct sockaddr_in sin;
return retval;
}
- fd = inet_open_passive(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin);
+ fd = inet_open_passive(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin, dscp);
if (fd < 0) {
return -fd;
}
sprintf(bound_name, "pssl:%"PRIu16":"IP_FMT,
- ntohs(sin.sin_port), IP_ARGS(&sin.sin_addr.s_addr));
+ ntohs(sin.sin_port), IP_ARGS(sin.sin_addr.s_addr));
pssl = xmalloc(sizeof *pssl);
pstream_init(&pssl->pstream, &pssl_pstream_class, bound_name);
+ pstream_set_bound_port(&pssl->pstream, sin.sin_port);
pssl->fd = fd;
*pstreamp = &pssl->pstream;
return 0;
int new_fd;
int error;
- new_fd = accept(pssl->fd, &sin, &sin_len);
+ new_fd = accept(pssl->fd, (struct sockaddr *) &sin, &sin_len);
if (new_fd < 0) {
error = errno;
if (error != EAGAIN) {
- VLOG_DBG_RL(&rl, "accept: %s", strerror(error));
+ VLOG_DBG_RL(&rl, "accept: %s", ovs_strerror(error));
}
return error;
}
return error;
}
- sprintf(name, "ssl:"IP_FMT, IP_ARGS(&sin.sin_addr));
+ sprintf(name, "ssl:"IP_FMT, IP_ARGS(sin.sin_addr.s_addr));
if (sin.sin_port != htons(OFP_SSL_PORT)) {
sprintf(strchr(name, '\0'), ":%"PRIu16, ntohs(sin.sin_port));
}
return new_ssl_stream(name, new_fd, SERVER, STATE_SSL_CONNECTING, &sin,
- new_streamp);
+ new_streamp);
}
static void
poll_fd_wait(pssl->fd, POLLIN);
}
-struct pstream_class pssl_pstream_class = {
+static int
+pssl_set_dscp(struct pstream *pstream, uint8_t dscp)
+{
+ struct pssl_pstream *pssl = pssl_pstream_cast(pstream);
+ return set_dscp(pssl->fd, dscp);
+}
+
+const struct pstream_class pssl_pstream_class = {
"pssl",
+ true,
pssl_open,
pssl_close,
pssl_accept,
pssl_wait,
+ pssl_set_dscp,
};
\f
/*
static int init_status = -1;
if (init_status < 0) {
init_status = do_ssl_init();
- assert(init_status >= 0);
+ ovs_assert(init_status >= 0);
}
return init_status;
}
SSL_library_init();
SSL_load_error_strings();
+ if (!RAND_status()) {
+ /* We occasionally see OpenSSL fail to seed its random number generator
+ * in heavily loaded hypervisors. I suspect the following scenario:
+ *
+ * 1. OpenSSL calls read() to get 32 bytes from /dev/urandom.
+ * 2. The kernel generates 10 bytes of randomness and copies it out.
+ * 3. A signal arrives (perhaps SIGALRM).
+ * 4. The kernel interrupts the system call to service the signal.
+ * 5. Userspace gets 10 bytes of entropy.
+ * 6. OpenSSL doesn't read again to get the final 22 bytes. Therefore
+ * OpenSSL doesn't have enough entropy to consider itself
+ * initialized.
+ *
+ * The only part I'm not entirely sure about is #6, because the OpenSSL
+ * code is so hard to read. */
+ uint8_t seed[32];
+ int retval;
+
+ VLOG_WARN("OpenSSL random seeding failed, reseeding ourselves");
+
+ retval = get_entropy(seed, sizeof seed);
+ if (retval) {
+ VLOG_ERR("failed to obtain entropy (%s)",
+ ovs_retval_to_string(retval));
+ return retval > 0 ? retval : ENOPROTOOPT;
+ }
+
+ RAND_seed(seed, sizeof seed);
+ }
+
/* New OpenSSL changed TLSv1_method() to return a "const" pointer, so the
* cast is needed to avoid a warning with those newer versions. */
- method = (SSL_METHOD *) TLSv1_method();
+ method = CONST_CAST(SSL_METHOD *, TLSv1_method());
if (method == NULL) {
VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
return ENOPROTOOPT;
SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
NULL);
- /* We have to set a session context ID string in 'ctx' because OpenSSL
- * otherwise refuses to use a cached session on the server side when
- * SSL_VERIFY_PEER is set. And it not only refuses to use the cached
- * session, it actually generates an error and kills the connection.
- * According to a comment in ssl_get_prev_session() in OpenSSL's
- * ssl/ssl_sess.c, this is intentional behavior.
- *
- * Any context string is OK, as long as one is set. */
- SSL_CTX_set_session_id_context(ctx, (const unsigned char *) PACKAGE,
- strlen(PACKAGE));
-
return 0;
}
if (!dh->dh) {
dh->dh = dh->constructor();
if (!dh->dh) {
- ovs_fatal(ENOMEM, "out of memory constructing "
- "Diffie-Hellman parameters");
+ out_of_memory();
}
}
return dh->dh;
update_ssl_config(struct ssl_config_file *config, const char *file_name)
{
struct timespec mtime;
+ int error;
if (ssl_init() || !file_name) {
return false;
/* If the file name hasn't changed and neither has the file contents, stop
* here. */
- get_mtime(file_name, &mtime);
+ error = get_mtime(file_name, &mtime);
+ if (error && error != ENOENT) {
+ VLOG_ERR_RL(&rl, "%s: stat failed (%s)",
+ file_name, ovs_strerror(error));
+ }
if (config->file_name
&& !strcmp(config->file_name, file_name)
&& mtime.tv_sec == config->mtime.tv_sec
file = fopen(file_name, "r");
if (!file) {
VLOG_ERR("failed to open %s for reading: %s",
- file_name, strerror(errno));
+ file_name, ovs_strerror(errno));
return errno;
}
}
static void
-stream_ssl_set_ca_cert_file__(const char *file_name, bool bootstrap)
+stream_ssl_set_ca_cert_file__(const char *file_name,
+ bool bootstrap, bool force)
{
X509 **certs;
size_t n_certs;
struct stat s;
+ if (!update_ssl_config(&ca_cert, file_name) && !force) {
+ return;
+ }
+
if (!strcmp(file_name, "none")) {
verify_peer_cert = false;
VLOG_WARN("Peer certificate validation disabled "
/* Set up CAs for OpenSSL to trust in verifying the peer's
* certificate. */
+ SSL_CTX_set_cert_store(ctx, X509_STORE_new());
if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
VLOG_ERR("SSL_CTX_load_verify_locations: %s",
ERR_error_string(ERR_get_error(), NULL));
void
stream_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
{
- if (!update_ssl_config(&ca_cert, file_name)) {
- return;
- }
-
- stream_ssl_set_ca_cert_file__(file_name, bootstrap);
+ stream_ssl_set_ca_cert_file__(file_name, bootstrap, false);
}
\f
/* SSL protocol logging. */