1 /* Copyright (C) 2008 Board of Trustees, Leland Stanford Jr. University.
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to
5 * deal in the Software without restriction, including without limitation the
6 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7 * sell copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22 #include "vconn-ssl.h"
26 #include <netinet/tcp.h>
27 #include <openssl/err.h>
28 #include <openssl/ssl.h>
32 #include "socket-util.h"
35 #include "ofp-print.h"
39 #define THIS_MODULE VLM_vconn_ssl
58 enum session_type type;
65 /* SSL context created by ssl_init(). */
68 /* Required configuration. */
69 static bool has_private_key, has_certificate, has_ca_cert;
71 static int ssl_init(void);
72 static int do_ssl_init(void);
73 static void connect_completed(struct ssl_vconn *, int error);
74 static bool ssl_wants_io(int ssl_error);
75 static void ssl_close(struct vconn *);
76 static bool state_machine(struct ssl_vconn *sslv);
77 static DH *tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength);
80 new_ssl_vconn(const char *name, int fd, enum session_type type,
81 struct vconn **vconnp)
83 struct ssl_vconn *sslv;
88 /* Check for all the needful configuration. */
89 if (!has_private_key) {
90 VLOG_ERR("Private key must be configured to use SSL");
93 if (!has_certificate) {
94 VLOG_ERR("Certificate must be configured to use SSL");
98 VLOG_ERR("CA certificate must be configured to use SSL");
101 if (!SSL_CTX_check_private_key(ctx)) {
102 VLOG_ERR("Private key does not match certificate public key");
106 /* Make 'fd' non-blocking and disable Nagle. */
107 retval = set_nonblocking(fd);
109 VLOG_ERR("%s: set_nonblocking: %s", name, strerror(retval));
113 retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
115 VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
120 /* Create and configure OpenSSL stream. */
123 VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
127 if (SSL_set_fd(ssl, fd) == 0) {
128 VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
132 /* Create and return the ssl_vconn. */
133 sslv = xmalloc(sizeof *sslv);
134 sslv->vconn.class = &ssl_vconn_class;
135 sslv->state = STATE_SSL_CONNECTING;
141 *vconnp = &sslv->vconn;
152 static struct ssl_vconn *
153 ssl_vconn_cast(struct vconn *vconn)
155 assert(vconn->class == &ssl_vconn_class);
156 return CONTAINER_OF(vconn, struct ssl_vconn, vconn);
160 ssl_open(const char *name, char *suffix, struct vconn **vconnp)
162 char *save_ptr, *host_name, *port_string;
163 struct sockaddr_in sin;
172 /* Glibc 2.7 has a bug in strtok_r when compiling with optimization that
173 * can cause segfaults here:
174 * http://sources.redhat.com/bugzilla/show_bug.cgi?id=5614.
175 * Using "::" instead of the obvious ":" works around it. */
176 host_name = strtok_r(suffix, "::", &save_ptr);
177 port_string = strtok_r(NULL, "::", &save_ptr);
179 fatal(0, "%s: bad peer name format", name);
182 memset(&sin, 0, sizeof sin);
183 sin.sin_family = AF_INET;
184 if (lookup_ip(host_name, &sin.sin_addr)) {
187 sin.sin_port = htons(port_string && *port_string ? atoi(port_string)
191 fd = socket(AF_INET, SOCK_STREAM, 0);
193 VLOG_ERR("%s: socket: %s", name, strerror(errno));
197 /* Connect socket (blocking). */
198 retval = connect(fd, (struct sockaddr *) &sin, sizeof sin);
201 VLOG_ERR("%s: connect: %s", name, strerror(error));
206 /* Make an ssl_vconn for the socket. */
207 return new_ssl_vconn(name, fd, CLIENT, vconnp);
211 ssl_close(struct vconn *vconn)
213 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
220 ssl_want_io_to_events(SSL *ssl, short int *events)
222 if (SSL_want_read(ssl)) {
225 } else if (SSL_want_write(ssl)) {
234 ssl_prepoll(struct vconn *vconn, int want, struct pollfd *pfd)
236 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
238 if (!state_machine(sslv)) {
239 switch (sslv->state) {
240 case STATE_SSL_CONNECTING:
241 if (!ssl_want_io_to_events(sslv->ssl, &pfd->events)) {
242 /* state_machine() should have transitioned us away to another
250 } else if (sslv->connect_error) {
253 } else if (!ssl_want_io_to_events(sslv->ssl, &pfd->events)) {
254 if (want & WANT_RECV) {
255 pfd->events |= POLLIN;
257 if (want & WANT_SEND || sslv->txbuf) {
258 pfd->events |= POLLOUT;
265 ssl_postpoll(struct vconn *vconn, short int *revents)
267 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
268 if (!state_machine(sslv)) {
270 } else if (sslv->connect_error) {
272 } else if (*revents & POLLOUT && sslv->txbuf) {
273 ssize_t n = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
275 buffer_pull(sslv->txbuf, n);
276 if (sslv->txbuf->size == 0) {
277 buffer_delete(sslv->txbuf);
282 *revents &= ~POLLOUT;
288 interpret_ssl_error(const char *function, int ret, int error)
292 VLOG_ERR("%s: unexpected SSL_ERROR_NONE", function);
295 case SSL_ERROR_ZERO_RETURN:
296 VLOG_ERR("%s: unexpected SSL_ERROR_ZERO_RETURN", function);
299 case SSL_ERROR_WANT_READ:
300 case SSL_ERROR_WANT_WRITE:
303 case SSL_ERROR_WANT_CONNECT:
304 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_CONNECT", function);
307 case SSL_ERROR_WANT_ACCEPT:
308 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
311 case SSL_ERROR_WANT_X509_LOOKUP:
312 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_X509_LOOKUP", function);
315 case SSL_ERROR_SYSCALL: {
316 int queued_error = ERR_get_error();
317 if (queued_error == 0) {
320 VLOG_WARN("%s: system error (%s)", function, strerror(status));
323 VLOG_WARN("%s: unexpected SSL connection close", function);
327 VLOG_DBG("%s: %s", function, ERR_error_string(queued_error, NULL));
332 case SSL_ERROR_SSL: {
333 int queued_error = ERR_get_error();
334 if (queued_error != 0) {
335 VLOG_DBG("%s: %s", function, ERR_error_string(queued_error, NULL));
337 VLOG_ERR("%s: SSL_ERROR_SSL without queued error", function);
343 VLOG_ERR("%s: bad SSL error code %d", function, error);
350 ssl_recv(struct vconn *vconn, struct buffer **bufferp)
352 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
357 if (!state_machine(sslv)) {
359 } else if (sslv->connect_error) {
360 return sslv->connect_error;
363 if (sslv->rxbuf == NULL) {
364 sslv->rxbuf = buffer_new(1564);
369 if (sizeof(struct ofp_header) > rx->size) {
370 want_bytes = sizeof(struct ofp_header) - rx->size;
372 struct ofp_header *oh = rx->data;
373 size_t length = ntohs(oh->length);
374 if (length < sizeof(struct ofp_header)) {
375 VLOG_ERR("received too-short ofp_header (%zu bytes)", length);
378 want_bytes = length - rx->size;
380 buffer_reserve_tailroom(rx, want_bytes);
382 /* Behavior of zero-byte SSL_read is poorly defined. */
383 assert(want_bytes > 0);
385 ret = SSL_read(sslv->ssl, buffer_tail(rx), want_bytes);
388 if (ret == want_bytes) {
389 if (rx->size > sizeof(struct ofp_header)) {
399 int error = SSL_get_error(sslv->ssl, ret);
400 if (error == SSL_ERROR_ZERO_RETURN) {
401 /* Connection closed (EOF). */
403 VLOG_WARN("SSL_read: unexpected connection close");
409 return interpret_ssl_error("SSL_read", ret, error);
415 ssl_send(struct vconn *vconn, struct buffer *buffer)
417 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
420 if (!state_machine(sslv)) {
422 } else if (sslv->connect_error) {
423 return sslv->connect_error;
430 ret = SSL_write(sslv->ssl, buffer->data, buffer->size);
432 if (ret == buffer->size) {
433 buffer_delete(buffer);
435 sslv->txbuf = buffer;
436 buffer_pull(buffer, ret);
440 int error = SSL_get_error(sslv->ssl, ret);
441 if (error == SSL_ERROR_ZERO_RETURN) {
442 /* Connection closed (EOF). */
443 VLOG_WARN("SSL_write: connection close");
446 return interpret_ssl_error("SSL_write", ret, error);
451 struct vconn_class ssl_vconn_class = {
455 .prepoll = ssl_prepoll,
456 .postpoll = ssl_postpoll,
469 static struct pssl_vconn *
470 pssl_vconn_cast(struct vconn *vconn)
472 assert(vconn->class == &pssl_vconn_class);
473 return CONTAINER_OF(vconn, struct pssl_vconn, vconn);
477 pssl_open(const char *name, char *suffix, struct vconn **vconnp)
479 struct sockaddr_in sin;
480 struct pssl_vconn *pssl;
483 unsigned int yes = 1;
491 fd = socket(AF_INET, SOCK_STREAM, 0);
494 VLOG_ERR("%s: socket: %s", name, strerror(error));
498 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
500 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", name, strerror(errno));
504 memset(&sin, 0, sizeof sin);
505 sin.sin_family = AF_INET;
506 sin.sin_addr.s_addr = htonl(INADDR_ANY);
507 sin.sin_port = htons(atoi(suffix) ? atoi(suffix) : OFP_SSL_PORT);
508 retval = bind(fd, (struct sockaddr *) &sin, sizeof sin);
511 VLOG_ERR("%s: bind: %s", name, strerror(error));
516 retval = listen(fd, 10);
519 VLOG_ERR("%s: listen: %s", name, strerror(error));
524 retval = set_nonblocking(fd);
526 VLOG_ERR("%s: set_nonblocking: %s", name, strerror(retval));
531 pssl = xmalloc(sizeof *pssl);
532 pssl->vconn.class = &pssl_vconn_class;
534 *vconnp = &pssl->vconn;
539 pssl_close(struct vconn *vconn)
541 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
547 pssl_prepoll(struct vconn *vconn, int want, struct pollfd *pfd)
549 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
551 if (want & WANT_ACCEPT) {
552 pfd->events |= POLLIN;
558 pssl_accept(struct vconn *vconn, struct vconn **new_vconnp)
560 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
563 new_fd = accept(pssl->fd, NULL, NULL);
566 if (error != EAGAIN) {
567 VLOG_DBG("pssl: accept: %s", strerror(error));
572 return new_ssl_vconn("ssl" /* FIXME */, new_fd, SERVER, new_vconnp);
575 struct vconn_class pssl_vconn_class = {
579 .prepoll = pssl_prepoll,
580 .accept = pssl_accept,
584 * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
585 * OpenSSL is requesting that we call it back when the socket is ready for read
586 * or writing (respectively.
589 ssl_wants_io(int ssl_error)
591 return (ssl_error == SSL_ERROR_WANT_WRITE
592 || ssl_error == SSL_ERROR_WANT_READ);
598 static int init_status = -1;
599 if (init_status < 0) {
600 init_status = do_ssl_init();
601 assert(init_status >= 0);
612 SSL_load_error_strings();
614 method = TLSv1_method();
615 if (method == NULL) {
616 VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
620 ctx = SSL_CTX_new(method);
622 VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
625 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
626 SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
627 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
628 SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
629 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
636 state_machine(struct ssl_vconn *sslv)
638 if (sslv->state == STATE_SSL_CONNECTING) {
639 int ret = (sslv->type == CLIENT
640 ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
642 int error = SSL_get_error(sslv->ssl, ret);
643 if (ret < 0 && ssl_wants_io(error)) {
644 /* Stay in this state to repeat the SSL_connect later. */
647 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
648 : "SSL_accept"), ret, error);
649 shutdown(sslv->fd, SHUT_RDWR);
650 connect_completed(sslv, EPROTO);
653 connect_completed(sslv, 0);
656 return sslv->state == STATE_CONNECTED;
660 connect_completed(struct ssl_vconn *sslv, int error)
662 sslv->state = STATE_CONNECTED;
663 sslv->connect_error = error;
667 tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength)
672 DH *(*constructor)(void);
675 static struct dh dh_table[] = {
676 {2048, NULL, get_dh2048},
677 {4096, NULL, get_dh4096},
682 for (dh = dh_table; dh < &dh[ARRAY_SIZE(dh_table)]; dh++) {
683 if (dh->keylength == keylength) {
685 dh->dh = dh->constructor();
687 fatal(ENOMEM, "out of memory constructing "
688 "Diffie-Hellman parameters");
694 VLOG_ERR("no Diffie-Hellman parameters for key length %d", keylength);
699 vconn_ssl_set_private_key_file(const char *file_name)
704 if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
705 VLOG_ERR("SSL_use_PrivateKey_file: %s",
706 ERR_error_string(ERR_get_error(), NULL));
709 has_private_key = true;
713 vconn_ssl_set_certificate_file(const char *file_name)
718 if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
719 VLOG_ERR("SSL_use_certificate_file: %s",
720 ERR_error_string(ERR_get_error(), NULL));
723 has_certificate = true;
727 vconn_ssl_set_ca_cert_file(const char *file_name)
729 STACK_OF(X509_NAME) *ca_list;
735 /* Set up list of CAs that the server will accept from the client. */
736 ca_list = SSL_load_client_CA_file(file_name);
737 if (ca_list == NULL) {
738 VLOG_ERR("SSL_load_client_CA_file: %s",
739 ERR_error_string(ERR_get_error(), NULL));
742 SSL_CTX_set_client_CA_list(ctx, ca_list);
744 /* Set up CAs for OpenSSL to trust in verifying the peer's certificate. */
745 if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
746 VLOG_ERR("SSL_load_verify_locations: %s",
747 ERR_error_string(ERR_get_error(), NULL));