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"
27 #include <netinet/tcp.h>
28 #include <openssl/err.h>
29 #include <openssl/ssl.h>
33 #include "socket-util.h"
36 #include "poll-loop.h"
37 #include "ofp-print.h"
38 #include "socket-util.h"
42 #define THIS_MODULE VLM_vconn_ssl
61 enum session_type type;
66 struct poll_waiter *tx_waiter;
69 /* SSL context created by ssl_init(). */
72 /* Required configuration. */
73 static bool has_private_key, has_certificate, has_ca_cert;
75 static int ssl_init(void);
76 static int do_ssl_init(void);
77 static bool ssl_wants_io(int ssl_error);
78 static void ssl_close(struct vconn *);
79 static int interpret_ssl_error(const char *function, int ret, int error);
80 static void ssl_do_tx(int fd, short int revents, void *vconn_);
81 static DH *tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength);
84 new_ssl_vconn(const char *name, int fd, enum session_type type,
85 enum ssl_state state, struct vconn **vconnp)
87 struct ssl_vconn *sslv;
92 /* Check for all the needful configuration. */
93 if (!has_private_key) {
94 VLOG_ERR("Private key must be configured to use SSL");
97 if (!has_certificate) {
98 VLOG_ERR("Certificate must be configured to use SSL");
102 VLOG_ERR("CA certificate must be configured to use SSL");
105 if (!SSL_CTX_check_private_key(ctx)) {
106 VLOG_ERR("Private key does not match certificate public key");
111 retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
113 VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
118 /* Create and configure OpenSSL stream. */
121 VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
125 if (SSL_set_fd(ssl, fd) == 0) {
126 VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
130 /* Create and return the ssl_vconn. */
131 sslv = xmalloc(sizeof *sslv);
132 sslv->vconn.class = &ssl_vconn_class;
133 sslv->vconn.connect_status = EAGAIN;
140 sslv->tx_waiter = NULL;
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));
196 retval = set_nonblocking(fd);
202 /* Connect socket. */
203 retval = connect(fd, (struct sockaddr *) &sin, sizeof sin);
205 if (errno == EINPROGRESS) {
206 return new_ssl_vconn(name, fd, CLIENT, STATE_TCP_CONNECTING,
210 VLOG_ERR("%s: connect: %s", name, strerror(error));
215 return new_ssl_vconn(name, fd, CLIENT, STATE_SSL_CONNECTING,
221 ssl_connect(struct vconn *vconn)
223 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
226 switch (sslv->state) {
227 case STATE_TCP_CONNECTING:
228 retval = check_connection_completion(sslv->fd);
232 sslv->state = STATE_SSL_CONNECTING;
235 case STATE_SSL_CONNECTING:
236 retval = (sslv->type == CLIENT
237 ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
239 int error = SSL_get_error(sslv->ssl, retval);
240 if (retval < 0 && ssl_wants_io(error)) {
243 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
244 : "SSL_accept"), retval, error);
245 shutdown(sslv->fd, SHUT_RDWR);
257 ssl_close(struct vconn *vconn)
259 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
260 poll_cancel(sslv->tx_waiter);
267 interpret_ssl_error(const char *function, int ret, int error)
271 VLOG_ERR("%s: unexpected SSL_ERROR_NONE", function);
274 case SSL_ERROR_ZERO_RETURN:
275 VLOG_ERR("%s: unexpected SSL_ERROR_ZERO_RETURN", function);
278 case SSL_ERROR_WANT_READ:
279 case SSL_ERROR_WANT_WRITE:
282 case SSL_ERROR_WANT_CONNECT:
283 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_CONNECT", function);
286 case SSL_ERROR_WANT_ACCEPT:
287 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
290 case SSL_ERROR_WANT_X509_LOOKUP:
291 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_X509_LOOKUP", function);
294 case SSL_ERROR_SYSCALL: {
295 int queued_error = ERR_get_error();
296 if (queued_error == 0) {
299 VLOG_WARN("%s: system error (%s)", function, strerror(status));
302 VLOG_WARN("%s: unexpected SSL connection close", function);
306 VLOG_DBG("%s: %s", function, ERR_error_string(queued_error, NULL));
311 case SSL_ERROR_SSL: {
312 int queued_error = ERR_get_error();
313 if (queued_error != 0) {
314 VLOG_DBG("%s: %s", function, ERR_error_string(queued_error, NULL));
316 VLOG_ERR("%s: SSL_ERROR_SSL without queued error", function);
322 VLOG_ERR("%s: bad SSL error code %d", function, error);
329 ssl_recv(struct vconn *vconn, struct buffer **bufferp)
331 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
336 if (sslv->rxbuf == NULL) {
337 sslv->rxbuf = buffer_new(1564);
342 if (sizeof(struct ofp_header) > rx->size) {
343 want_bytes = sizeof(struct ofp_header) - rx->size;
345 struct ofp_header *oh = rx->data;
346 size_t length = ntohs(oh->length);
347 if (length < sizeof(struct ofp_header)) {
348 VLOG_ERR("received too-short ofp_header (%zu bytes)", length);
351 want_bytes = length - rx->size;
353 buffer_reserve_tailroom(rx, want_bytes);
355 /* Behavior of zero-byte SSL_read is poorly defined. */
356 assert(want_bytes > 0);
358 ret = SSL_read(sslv->ssl, buffer_tail(rx), want_bytes);
361 if (ret == want_bytes) {
362 if (rx->size > sizeof(struct ofp_header)) {
372 int error = SSL_get_error(sslv->ssl, ret);
373 if (error == SSL_ERROR_ZERO_RETURN) {
374 /* Connection closed (EOF). */
376 VLOG_WARN("SSL_read: unexpected connection close");
382 return interpret_ssl_error("SSL_read", ret, error);
388 ssl_clear_txbuf(struct ssl_vconn *sslv)
390 buffer_delete(sslv->txbuf);
392 sslv->tx_waiter = NULL;
396 ssl_register_tx_waiter(struct vconn *vconn)
398 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
399 short int events = SSL_want_read(sslv->ssl) ? POLLIN : POLLOUT;
400 sslv->tx_waiter = poll_fd_callback(sslv->fd, events, ssl_do_tx, vconn);
404 ssl_do_tx(int fd UNUSED, short int revents UNUSED, void *vconn_)
406 struct vconn *vconn = vconn_;
407 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
408 int ret = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
410 buffer_pull(sslv->txbuf, ret);
411 if (sslv->txbuf->size == 0) {
412 ssl_clear_txbuf(sslv);
416 int error = SSL_get_error(sslv->ssl, ret);
417 if (error == SSL_ERROR_ZERO_RETURN) {
418 /* Connection closed (EOF). */
419 VLOG_WARN("SSL_write: connection close");
420 } else if (interpret_ssl_error("SSL_write", ret, error) != EAGAIN) {
421 ssl_clear_txbuf(sslv);
425 ssl_register_tx_waiter(vconn);
429 ssl_send(struct vconn *vconn, struct buffer *buffer)
431 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
438 ret = SSL_write(sslv->ssl, buffer->data, buffer->size);
440 if (ret == buffer->size) {
441 buffer_delete(buffer);
443 sslv->txbuf = buffer;
444 buffer_pull(buffer, ret);
445 ssl_register_tx_waiter(vconn);
449 int error = SSL_get_error(sslv->ssl, ret);
450 if (error == SSL_ERROR_ZERO_RETURN) {
451 /* Connection closed (EOF). */
452 VLOG_WARN("SSL_write: connection close");
455 return interpret_ssl_error("SSL_write", ret, error);
461 ssl_needs_wait(struct ssl_vconn *sslv)
463 if (SSL_want_read(sslv->ssl)) {
464 poll_fd_wait(sslv->fd, POLLIN, NULL);
466 } else if (SSL_want_write(sslv->ssl)) {
467 poll_fd_wait(sslv->fd, POLLOUT, NULL);
475 ssl_wait(struct vconn *vconn, enum vconn_wait_type wait)
477 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
481 if (vconn_connect(vconn) != EAGAIN) {
482 poll_immediate_wake();
483 } else if (sslv->state == STATE_TCP_CONNECTING) {
484 poll_fd_wait(sslv->fd, POLLOUT, NULL);
485 } else if (!ssl_needs_wait(sslv)) {
491 if (!ssl_needs_wait(sslv)) {
492 if (SSL_pending(sslv->ssl)) {
493 poll_immediate_wake();
495 poll_fd_wait(sslv->fd, POLLIN, NULL);
501 if (!sslv->txbuf && !ssl_needs_wait(sslv)) {
502 poll_fd_wait(sslv->fd, POLLOUT, NULL);
511 struct vconn_class ssl_vconn_class = {
515 .connect = ssl_connect,
529 static struct pssl_vconn *
530 pssl_vconn_cast(struct vconn *vconn)
532 assert(vconn->class == &pssl_vconn_class);
533 return CONTAINER_OF(vconn, struct pssl_vconn, vconn);
537 pssl_open(const char *name, char *suffix, struct vconn **vconnp)
539 struct sockaddr_in sin;
540 struct pssl_vconn *pssl;
543 unsigned int yes = 1;
551 fd = socket(AF_INET, SOCK_STREAM, 0);
554 VLOG_ERR("%s: socket: %s", name, strerror(error));
558 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
560 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", name, strerror(errno));
564 memset(&sin, 0, sizeof sin);
565 sin.sin_family = AF_INET;
566 sin.sin_addr.s_addr = htonl(INADDR_ANY);
567 sin.sin_port = htons(atoi(suffix) ? atoi(suffix) : OFP_SSL_PORT);
568 retval = bind(fd, (struct sockaddr *) &sin, sizeof sin);
571 VLOG_ERR("%s: bind: %s", name, strerror(error));
576 retval = listen(fd, 10);
579 VLOG_ERR("%s: listen: %s", name, strerror(error));
584 retval = set_nonblocking(fd);
590 pssl = xmalloc(sizeof *pssl);
591 pssl->vconn.class = &pssl_vconn_class;
592 pssl->vconn.connect_status = 0;
594 *vconnp = &pssl->vconn;
599 pssl_close(struct vconn *vconn)
601 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
607 pssl_accept(struct vconn *vconn, struct vconn **new_vconnp)
609 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
613 new_fd = accept(pssl->fd, NULL, NULL);
616 if (error != EAGAIN) {
617 VLOG_DBG("accept: %s", strerror(error));
622 error = set_nonblocking(new_fd);
628 return new_ssl_vconn("ssl" /* FIXME */, new_fd,
629 SERVER, STATE_SSL_CONNECTING, new_vconnp);
633 pssl_wait(struct vconn *vconn, enum vconn_wait_type wait)
635 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
636 assert(wait == WAIT_ACCEPT);
637 poll_fd_wait(pssl->fd, POLLIN, NULL);
640 struct vconn_class pssl_vconn_class = {
644 .accept = pssl_accept,
649 * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
650 * OpenSSL is requesting that we call it back when the socket is ready for read
651 * or writing, respectively.
654 ssl_wants_io(int ssl_error)
656 return (ssl_error == SSL_ERROR_WANT_WRITE
657 || ssl_error == SSL_ERROR_WANT_READ);
663 static int init_status = -1;
664 if (init_status < 0) {
665 init_status = do_ssl_init();
666 assert(init_status >= 0);
677 SSL_load_error_strings();
679 method = TLSv1_method();
680 if (method == NULL) {
681 VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
685 ctx = SSL_CTX_new(method);
687 VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
690 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
691 SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
692 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
693 SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
694 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
701 tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength)
706 DH *(*constructor)(void);
709 static struct dh dh_table[] = {
710 {1024, NULL, get_dh1024},
711 {2048, NULL, get_dh2048},
712 {4096, NULL, get_dh4096},
717 for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
718 if (dh->keylength == keylength) {
720 dh->dh = dh->constructor();
722 fatal(ENOMEM, "out of memory constructing "
723 "Diffie-Hellman parameters");
729 VLOG_ERR("no Diffie-Hellman parameters for key length %d", keylength);
734 vconn_ssl_set_private_key_file(const char *file_name)
739 if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
740 VLOG_ERR("SSL_use_PrivateKey_file: %s",
741 ERR_error_string(ERR_get_error(), NULL));
744 has_private_key = true;
748 vconn_ssl_set_certificate_file(const char *file_name)
753 if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
754 VLOG_ERR("SSL_use_certificate_file: %s",
755 ERR_error_string(ERR_get_error(), NULL));
758 has_certificate = true;
762 vconn_ssl_set_ca_cert_file(const char *file_name)
764 STACK_OF(X509_NAME) *ca_list;
770 /* Set up list of CAs that the server will accept from the client. */
771 ca_list = SSL_load_client_CA_file(file_name);
772 if (ca_list == NULL) {
773 VLOG_ERR("SSL_load_client_CA_file: %s",
774 ERR_error_string(ERR_get_error(), NULL));
777 SSL_CTX_set_client_CA_list(ctx, ca_list);
779 /* Set up CAs for OpenSSL to trust in verifying the peer's certificate. */
780 if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
781 VLOG_ERR("SSL_load_verify_locations: %s",
782 ERR_error_string(ERR_get_error(), NULL));