/*
- * Copyright (c) 2008, 2009 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010 Nicira Networks.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include "util.h"
#include "stream-provider.h"
#include "stream.h"
+#include "timeval.h"
#include "vlog.h"
#define THIS_MODULE VLM_stream_ssl
/* SSL context created by ssl_init(). */
static SSL_CTX *ctx;
-/* Required configuration. */
-static bool has_private_key, has_certificate, has_ca_cert;
+struct ssl_config_file {
+ bool read; /* Whether the file was successfully read. */
+ char *file_name; /* Configured file name, if any. */
+ struct timespec mtime; /* File mtime as of last time we read it. */
+};
+
+/* SSL configuration files. */
+static struct ssl_config_file private_key;
+static struct ssl_config_file certificate;
+static struct ssl_config_file ca_cert;
/* Ordinarily, we require a CA certificate for the peer to be locally
- * available. 'has_ca_cert' is true when this is the case, and neither of the
- * following variables matter.
- *
- * We can, however, bootstrap the CA certificate from the peer at the beginning
- * of our first connection then use that certificate on all subsequent
- * connections, saving it to a file for use in future runs also. In this case,
- * 'has_ca_cert' is false, 'bootstrap_ca_cert' is true, and 'ca_cert_file'
- * names the file to be saved. */
+ * available. We can, however, bootstrap the CA certificate from the peer at
+ * the beginning of our first connection then use that certificate on all
+ * subsequent connections, saving it to a file for use in future runs also. In
+ * this case, 'bootstrap_ca_cert' is true. */
static bool bootstrap_ca_cert;
-static char *ca_cert_file;
/* Who knows what can trigger various SSL errors, so let's throttle them down
* quite a bit. */
static void ssl_clear_txbuf(struct ssl_stream *);
static int interpret_ssl_error(const char *function, int ret, int error,
int *want);
-static DH *tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength);
+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);
static short int
want_to_poll_events(int want)
/* Check for all the needful configuration. */
retval = 0;
- if (!has_private_key) {
+ if (!private_key.read) {
VLOG_ERR("Private key must be configured to use SSL");
retval = ENOPROTOOPT;
}
- if (!has_certificate) {
+ if (!certificate.read) {
VLOG_ERR("Certificate must be configured to use SSL");
retval = ENOPROTOOPT;
}
- if (!has_ca_cert && !bootstrap_ca_cert) {
+ if (!ca_cert.read && !bootstrap_ca_cert) {
VLOG_ERR("CA certificate must be configured to use SSL");
retval = ENOPROTOOPT;
}
{
struct ssl_stream *sslv = ssl_stream_cast(stream);
STACK_OF(X509) *chain;
- X509 *ca_cert;
+ X509 *cert;
FILE *file;
int error;
int fd;
"peer");
return EPROTO;
}
- ca_cert = sk_X509_value(chain, sk_X509_num(chain) - 1);
+ cert = sk_X509_value(chain, sk_X509_num(chain) - 1);
- /* Check that 'ca_cert' is self-signed. Otherwise it is not a CA
+ /* Check that 'cert' is self-signed. Otherwise it is not a CA
* certificate and we should not attempt to use it as one. */
- error = X509_check_issued(ca_cert, ca_cert);
+ error = X509_check_issued(cert, cert);
if (error) {
VLOG_ERR("could not bootstrap CA cert: obtained certificate is "
"not self-signed (%s)",
return EPROTO;
}
- fd = open(ca_cert_file, O_CREAT | O_EXCL | O_WRONLY, 0444);
+ fd = open(ca_cert.file_name, O_CREAT | O_EXCL | O_WRONLY, 0444);
if (fd < 0) {
- VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
- ca_cert_file, strerror(errno));
- return errno;
+ if (errno == EEXIST) {
+ VLOG_INFO("CA cert %s created by another process",
+ ca_cert.file_name);
+ /* We'll read it the next time around the main loop because
+ * update_ssl_config() will see that it now exists. */
+ return EPROTO;
+ } else {
+ VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
+ ca_cert.file_name, strerror(errno));
+ return errno;
+ }
}
file = fdopen(fd, "w");
int error = errno;
VLOG_ERR("could not bootstrap CA cert: fdopen failed: %s",
strerror(error));
- unlink(ca_cert_file);
+ unlink(ca_cert.file_name);
return error;
}
- if (!PEM_write_X509(file, ca_cert)) {
+ if (!PEM_write_X509(file, cert)) {
VLOG_ERR("could not bootstrap CA cert: PEM_write_X509 to %s failed: "
- "%s", ca_cert_file, ERR_error_string(ERR_get_error(), NULL));
+ "%s", ca_cert.file_name,
+ ERR_error_string(ERR_get_error(), NULL));
fclose(file);
- unlink(ca_cert_file);
+ unlink(ca_cert.file_name);
return EIO;
}
if (fclose(file)) {
int error = errno;
VLOG_ERR("could not bootstrap CA cert: writing %s failed: %s",
- ca_cert_file, strerror(error));
- unlink(ca_cert_file);
+ ca_cert.file_name, strerror(error));
+ unlink(ca_cert.file_name);
return error;
}
- VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert_file);
- log_ca_cert(ca_cert_file, ca_cert);
+ VLOG_INFO("successfully bootstrapped CA cert to %s", ca_cert.file_name);
+ log_ca_cert(ca_cert.file_name, cert);
bootstrap_ca_cert = false;
- has_ca_cert = true;
+ ca_cert.read = true;
- /* SSL_CTX_add_client_CA makes a copy of ca_cert's relevant data. */
- SSL_CTX_add_client_CA(ctx, ca_cert);
+ /* SSL_CTX_add_client_CA makes a copy of cert's relevant data. */
+ SSL_CTX_add_client_CA(ctx, cert);
/* SSL_CTX_use_certificate() takes ownership of the certificate passed in.
- * 'ca_cert' is owned by sslv->ssl, so we need to duplicate it. */
- ca_cert = X509_dup(ca_cert);
- if (!ca_cert) {
+ * 'cert' is owned by sslv->ssl, so we need to duplicate it. */
+ cert = X509_dup(cert);
+ if (!cert) {
out_of_memory();
}
- if (SSL_CTX_load_verify_locations(ctx, ca_cert_file, NULL) != 1) {
+ 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;
{
struct ssl_stream *sslv = ssl_stream_cast(stream);
ssl_clear_txbuf(sslv);
+
+ /* Attempt clean shutdown of the SSL connection. This will work most of
+ * the time, as long as the kernel send buffer has some free space and the
+ * SSL connection isn't renegotiating, etc. That has to be good enough,
+ * since we don't have any way to continue the close operation in the
+ * background. */
+ SSL_shutdown(sslv->ssl);
+
SSL_free(sslv->ssl);
close(sslv->fd);
free(sslv);
if (error == SSL_ERROR_ZERO_RETURN) {
return 0;
} else {
- return interpret_ssl_error("SSL_read", ret, error, &sslv->rx_want);
+ return -interpret_ssl_error("SSL_read", ret, error,
+ &sslv->rx_want);
}
}
}
struct ssl_stream *sslv = ssl_stream_cast(stream);
if (sslv->txbuf) {
- return EAGAIN;
+ return -EAGAIN;
} else {
int error;
switch (error) {
case 0:
ssl_clear_txbuf(sslv);
- return 0;
+ return n;
case EAGAIN:
leak_checker_claim(buffer);
- return 0;
+ return n;
default:
sslv->txbuf = NULL;
- return error;
+ return -error;
}
}
}
}
static int
-pssl_open(const char *name, char *suffix, struct pstream **pstreamp)
+pssl_open(const char *name OVS_UNUSED, char *suffix, struct pstream **pstreamp)
{
struct pssl_pstream *pssl;
+ struct sockaddr_in sin;
+ char bound_name[128];
int retval;
int fd;
return retval;
}
- fd = inet_open_passive(SOCK_STREAM, suffix, OFP_SSL_PORT);
+ fd = inet_open_passive(SOCK_STREAM, suffix, OFP_SSL_PORT, &sin);
if (fd < 0) {
return -fd;
}
+ sprintf(bound_name, "pssl:%"PRIu16":"IP_FMT,
+ ntohs(sin.sin_port), IP_ARGS(&sin.sin_addr.s_addr));
pssl = xmalloc(sizeof *pssl);
- pstream_init(&pssl->pstream, &pssl_pstream_class, name);
+ pstream_init(&pssl->pstream, &pssl_pstream_class, bound_name);
pssl->fd = fd;
*pstreamp = &pssl->pstream;
return 0;
}
static DH *
-tmp_dh_callback(SSL *ssl UNUSED, int is_export UNUSED, int keylength)
+tmp_dh_callback(SSL *ssl OVS_UNUSED, int is_export OVS_UNUSED, int keylength)
{
struct dh {
int keylength;
bool
stream_ssl_is_configured(void)
{
- return has_private_key || has_certificate || has_ca_cert;
+ return private_key.file_name || certificate.file_name || ca_cert.file_name;
+}
+
+static void
+get_mtime(const char *file_name, struct timespec *mtime)
+{
+ struct stat s;
+
+ if (!stat(file_name, &s)) {
+ mtime->tv_sec = s.st_mtime;
+
+#if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
+ mtime->tv_nsec = s.st_mtim.tv_nsec;
+#elif HAVE_STRUCT_STAT_ST_MTIMENSEC
+ mtime->tv_nsec = s.st_mtimensec;
+#else
+ mtime->tv_nsec = 0;
+#endif
+ } else {
+ mtime->tv_sec = mtime->tv_nsec = 0;
+ }
+}
+
+static bool
+update_ssl_config(struct ssl_config_file *config, const char *file_name)
+{
+ struct timespec mtime;
+
+ 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);
+ if (config->file_name
+ && !strcmp(config->file_name, file_name)
+ && mtime.tv_sec == config->mtime.tv_sec
+ && mtime.tv_nsec == config->mtime.tv_nsec) {
+ return false;
+ }
+
+ config->mtime = mtime;
+ free(config->file_name);
+ config->file_name = xstrdup(file_name);
+ return true;
}
void
stream_ssl_set_private_key_file(const char *file_name)
{
- if (ssl_init()) {
+ if (!update_ssl_config(&private_key, file_name)) {
return;
}
if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
ERR_error_string(ERR_get_error(), NULL));
return;
}
- has_private_key = true;
+ private_key.read = true;
}
void
stream_ssl_set_certificate_file(const char *file_name)
{
- if (ssl_init()) {
+ if (!update_ssl_config(&certificate, file_name)) {
return;
}
if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
ERR_error_string(ERR_get_error(), NULL));
return;
}
- has_certificate = true;
+ certificate.read = true;
}
/* Reads the X509 certificate or certificates in file 'file_name'. On success,
ds_destroy(&fp);
}
-/* Sets 'file_name' as the name of the file from which to read the CA
- * certificate used to verify the peer within SSL connections. If 'bootstrap'
- * is false, the file must exist. If 'bootstrap' is false, then the file is
- * read if it is exists; if it does not, then it will be created from the CA
- * certificate received from the peer on the first SSL connection. */
-void
-stream_ssl_set_ca_cert_file(const char *file_name, bool bootstrap)
+static void
+stream_ssl_set_ca_cert_file__(const char *file_name, bool bootstrap)
{
X509 **certs;
size_t n_certs;
struct stat s;
- if (ssl_init()) {
- return;
- }
-
if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
bootstrap_ca_cert = true;
- ca_cert_file = xstrdup(file_name);
} else if (!read_cert_file(file_name, &certs, &n_certs)) {
size_t i;
}
X509_free(certs[i]);
}
+ free(certs);
/* Set up CAs for OpenSSL to trust in verifying the peer's
* certificate. */
return;
}
- has_ca_cert = true;
+ bootstrap_ca_cert = false;
}
+ ca_cert.read = true;
}
+
+/* Sets 'file_name' as the name of the file from which to read the CA
+ * certificate used to verify the peer within SSL connections. If 'bootstrap'
+ * is false, the file must exist. If 'bootstrap' is false, then the file is
+ * read if it is exists; if it does not, then it will be created from the CA
+ * certificate received from the peer on the first SSL connection. */
+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);
+}
+
+