#include "packets.h"
#include "poll-loop.h"
#include "socket-util.h"
-#include "socket-util.h"
#include "util.h"
#include "stream-provider.h"
#include "stream.h"
#include "timeval.h"
-
#include "vlog.h"
-#define THIS_MODULE VLM_stream_ssl
+
+VLOG_DEFINE_THIS_MODULE(stream_ssl)
/* Active SSL. */
int fd;
SSL *ssl;
struct ofpbuf *txbuf;
+ unsigned int session_nr;
/* rx_want and tx_want record the result of the last call to SSL_read()
* and SSL_write(), respectively:
* deadlock and livelock situations above.
*/
int rx_want, tx_want;
+
+ /* A few bytes of header data in case SSL negotiation fails. */
+ uint8_t head[2];
+ short int n_head;
};
/* SSL context created by ssl_init(). */
struct ssl_config_file {
bool read; /* Whether the file was successfully read. */
char *file_name; /* Configured file name, if any. */
- long long int next_retry; /* If 'file_name' but not 'read', next time to
- * retry reading. */
+ struct timespec mtime; /* File mtime as of last time we read it. */
};
/* SSL configuration files. */
static struct ssl_config_file certificate;
static struct ssl_config_file ca_cert;
+/* Ordinarily, the SSL client and server verify each other's certificates using
+ * a CA certificate. Setting this to false disables this behavior. (This is a
+ * security risk.) */
+static bool verify_peer_cert = true;
+
/* Ordinarily, we require a CA certificate for the peer to be locally
* available. We can, however, bootstrap the CA certificate from the peer at
* the beginning of our first connection then use that certificate on all
* this case, 'bootstrap_ca_cert' is true. */
static bool bootstrap_ca_cert;
+/* Session number. Used in debug logging messages to uniquely identify a
+ * session. */
+static unsigned int next_session_nr;
+
/* Who knows what can trigger various SSL errors, so let's throttle them down
* quite a bit. */
static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
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 void ssl_protocol_cb(int write_p, int version, int content_type,
+ const void *, size_t, SSL *, void *sslv_);
static short int
want_to_poll_events(int want)
VLOG_ERR("Certificate must be configured to use SSL");
retval = ENOPROTOOPT;
}
- if (!ca_cert.read && !bootstrap_ca_cert) {
+ if (!ca_cert.read && verify_peer_cert && !bootstrap_ca_cert) {
VLOG_ERR("CA certificate must be configured to use SSL");
retval = ENOPROTOOPT;
}
retval = ENOPROTOOPT;
goto error;
}
- if (bootstrap_ca_cert && type == CLIENT) {
+ if (!verify_peer_cert || (bootstrap_ca_cert && type == CLIENT)) {
SSL_set_verify(ssl, SSL_VERIFY_NONE, NULL);
}
sslv->ssl = ssl;
sslv->txbuf = NULL;
sslv->rx_want = sslv->tx_want = SSL_NOTHING;
+ sslv->session_nr = next_session_nr++;
+ sslv->n_head = 0;
+
+ if (VLOG_IS_DBG_ENABLED()) {
+ SSL_set_msg_callback(ssl, ssl_protocol_cb);
+ SSL_set_msg_callback_arg(ssl, sslv);
+ }
+
*streamp = &sslv->stream;
return 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);
+ stream_ssl_set_ca_cert_file(ca_cert.file_name, true);
return EPROTO;
} else {
VLOG_ERR("could not bootstrap CA cert: creating %s failed: %s",
/* Fall through. */
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. */
+ if (sslv->n_head <= 0) {
+ sslv->n_head = recv(sslv->fd, sslv->head, sizeof sslv->head,
+ MSG_PEEK);
+ }
+
retval = (sslv->type == CLIENT
? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
if (retval != 1) {
interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
: "SSL_accept"), retval, error, &unused);
shutdown(sslv->fd, SHUT_RDWR);
+ stream_report_content(sslv->head, sslv->n_head, STREAM_SSL,
+ THIS_MODULE, stream_get_name(stream));
return EPROTO;
}
} else if (bootstrap_ca_cert) {
return do_ca_cert_bootstrap(stream);
- } else if ((SSL_get_verify_mode(sslv->ssl)
- & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
- != SSL_VERIFY_PEER) {
+ } else if (verify_peer_cert
+ && ((SSL_get_verify_mode(sslv->ssl)
+ & (SSL_VERIFY_NONE | SSL_VERIFY_PEER))
+ != SSL_VERIFY_PEER)) {
/* Two or more SSL connections completed at the same time while we
* were in bootstrap mode. Only one of these can finish the
* bootstrap successfully. The other one(s) must be rejected
* background. */
SSL_shutdown(sslv->ssl);
+ /* 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. */
+ ERR_clear_error();
+
SSL_free(sslv->ssl);
close(sslv->fd);
free(sslv);
static bool
update_ssl_config(struct ssl_config_file *config, const char *file_name)
{
- if (ssl_init()
- || !file_name
- || (config->file_name
- && !strcmp(config->file_name, file_name)
- && time_msec() < config->next_retry)) {
+ 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->next_retry = time_msec() + 60 * 1000;
- free(config->file_name);
- config->file_name = xstrdup(file_name);
+ /* Update 'config'. */
+ config->mtime = mtime;
+ if (file_name != config->file_name) {
+ free(config->file_name);
+ config->file_name = xstrdup(file_name);
+ }
return true;
}
size_t n_certs;
struct stat s;
- if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
+ if (!strcmp(file_name, "none")) {
+ verify_peer_cert = false;
+ VLOG_WARN("Peer certificate validation disabled "
+ "(this is a security risk)");
+ } else if (bootstrap && stat(file_name, &s) && errno == ENOENT) {
bootstrap_ca_cert = true;
} else if (!read_cert_file(file_name, &certs, &n_certs)) {
size_t i;
stream_ssl_set_ca_cert_file__(file_name, bootstrap);
}
+\f
+/* SSL protocol logging. */
+
+static const char *
+ssl_alert_level_to_string(uint8_t type)
+{
+ switch (type) {
+ case 1: return "warning";
+ case 2: return "fatal";
+ default: return "<unknown>";
+ }
+}
+
+static const char *
+ssl_alert_description_to_string(uint8_t type)
+{
+ switch (type) {
+ case 0: return "close_notify";
+ case 10: return "unexpected_message";
+ case 20: return "bad_record_mac";
+ case 21: return "decryption_failed";
+ case 22: return "record_overflow";
+ case 30: return "decompression_failure";
+ case 40: return "handshake_failure";
+ case 42: return "bad_certificate";
+ case 43: return "unsupported_certificate";
+ case 44: return "certificate_revoked";
+ case 45: return "certificate_expired";
+ case 46: return "certificate_unknown";
+ case 47: return "illegal_parameter";
+ case 48: return "unknown_ca";
+ case 49: return "access_denied";
+ case 50: return "decode_error";
+ case 51: return "decrypt_error";
+ case 60: return "export_restriction";
+ case 70: return "protocol_version";
+ case 71: return "insufficient_security";
+ case 80: return "internal_error";
+ case 90: return "user_canceled";
+ case 100: return "no_renegotiation";
+ default: return "<unknown>";
+ }
+}
+
+static const char *
+ssl_handshake_type_to_string(uint8_t type)
+{
+ switch (type) {
+ case 0: return "hello_request";
+ case 1: return "client_hello";
+ case 2: return "server_hello";
+ case 11: return "certificate";
+ case 12: return "server_key_exchange";
+ case 13: return "certificate_request";
+ case 14: return "server_hello_done";
+ case 15: return "certificate_verify";
+ case 16: return "client_key_exchange";
+ case 20: return "finished";
+ default: return "<unknown>";
+ }
+}
+static void
+ssl_protocol_cb(int write_p, int version OVS_UNUSED, int content_type,
+ const void *buf_, size_t len, SSL *ssl OVS_UNUSED, void *sslv_)
+{
+ const struct ssl_stream *sslv = sslv_;
+ const uint8_t *buf = buf_;
+ struct ds details;
+
+ if (!VLOG_IS_DBG_ENABLED()) {
+ return;
+ }
+ ds_init(&details);
+ if (content_type == 20) {
+ ds_put_cstr(&details, "change_cipher_spec");
+ } else if (content_type == 21) {
+ ds_put_format(&details, "alert: %s, %s",
+ ssl_alert_level_to_string(buf[0]),
+ ssl_alert_description_to_string(buf[1]));
+ } else if (content_type == 22) {
+ ds_put_format(&details, "handshake: %s",
+ ssl_handshake_type_to_string(buf[0]));
+ } else {
+ ds_put_format(&details, "type %d", content_type);
+ }
+
+ VLOG_DBG("%s%u%s%s %s (%zu bytes)",
+ sslv->type == CLIENT ? "client" : "server",
+ sslv->session_nr, write_p ? "-->" : "<--",
+ stream_get_name(&sslv->stream), ds_cstr(&details), len);
+
+ ds_destroy(&details);
+}