1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
34 #include "vconn-ssl.h"
39 #include <netinet/tcp.h>
40 #include <openssl/err.h>
41 #include <openssl/ssl.h>
45 #include "socket-util.h"
48 #include "poll-loop.h"
49 #include "ofp-print.h"
50 #include "socket-util.h"
54 #define THIS_MODULE VLM_vconn_ssl
73 enum session_type type;
78 struct poll_waiter *tx_waiter;
81 /* SSL context created by ssl_init(). */
84 /* Required configuration. */
85 static bool has_private_key, has_certificate, has_ca_cert;
87 static int ssl_init(void);
88 static int do_ssl_init(void);
89 static bool ssl_wants_io(int ssl_error);
90 static void ssl_close(struct vconn *);
91 static int interpret_ssl_error(const char *function, int ret, int error);
92 static void ssl_do_tx(int fd, short int revents, void *vconn_);
93 static DH *tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength);
96 new_ssl_vconn(const char *name, int fd, enum session_type type,
97 enum ssl_state state, struct vconn **vconnp)
99 struct ssl_vconn *sslv;
104 /* Check for all the needful configuration. */
105 if (!has_private_key) {
106 VLOG_ERR("Private key must be configured to use SSL");
109 if (!has_certificate) {
110 VLOG_ERR("Certificate must be configured to use SSL");
114 VLOG_ERR("CA certificate must be configured to use SSL");
117 if (!SSL_CTX_check_private_key(ctx)) {
118 VLOG_ERR("Private key does not match certificate public key");
123 retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
125 VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
130 /* Create and configure OpenSSL stream. */
133 VLOG_ERR("SSL_new: %s", ERR_error_string(ERR_get_error(), NULL));
137 if (SSL_set_fd(ssl, fd) == 0) {
138 VLOG_ERR("SSL_set_fd: %s", ERR_error_string(ERR_get_error(), NULL));
142 /* Create and return the ssl_vconn. */
143 sslv = xmalloc(sizeof *sslv);
144 sslv->vconn.class = &ssl_vconn_class;
145 sslv->vconn.connect_status = EAGAIN;
152 sslv->tx_waiter = NULL;
153 *vconnp = &sslv->vconn;
164 static struct ssl_vconn *
165 ssl_vconn_cast(struct vconn *vconn)
167 assert(vconn->class == &ssl_vconn_class);
168 return CONTAINER_OF(vconn, struct ssl_vconn, vconn);
172 ssl_open(const char *name, char *suffix, struct vconn **vconnp)
174 char *save_ptr, *host_name, *port_string;
175 struct sockaddr_in sin;
184 /* Glibc 2.7 has a bug in strtok_r when compiling with optimization that
185 * can cause segfaults here:
186 * http://sources.redhat.com/bugzilla/show_bug.cgi?id=5614.
187 * Using "::" instead of the obvious ":" works around it. */
188 host_name = strtok_r(suffix, "::", &save_ptr);
189 port_string = strtok_r(NULL, "::", &save_ptr);
191 fatal(0, "%s: bad peer name format", name);
194 memset(&sin, 0, sizeof sin);
195 sin.sin_family = AF_INET;
196 if (lookup_ip(host_name, &sin.sin_addr)) {
199 sin.sin_port = htons(port_string && *port_string ? atoi(port_string)
203 fd = socket(AF_INET, SOCK_STREAM, 0);
205 VLOG_ERR("%s: socket: %s", name, strerror(errno));
208 retval = set_nonblocking(fd);
214 /* Connect socket. */
215 retval = connect(fd, (struct sockaddr *) &sin, sizeof sin);
217 if (errno == EINPROGRESS) {
218 return new_ssl_vconn(name, fd, CLIENT, STATE_TCP_CONNECTING,
222 VLOG_ERR("%s: connect: %s", name, strerror(error));
227 return new_ssl_vconn(name, fd, CLIENT, STATE_SSL_CONNECTING,
233 ssl_connect(struct vconn *vconn)
235 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
238 switch (sslv->state) {
239 case STATE_TCP_CONNECTING:
240 retval = check_connection_completion(sslv->fd);
244 sslv->state = STATE_SSL_CONNECTING;
247 case STATE_SSL_CONNECTING:
248 retval = (sslv->type == CLIENT
249 ? SSL_connect(sslv->ssl) : SSL_accept(sslv->ssl));
251 int error = SSL_get_error(sslv->ssl, retval);
252 if (retval < 0 && ssl_wants_io(error)) {
255 interpret_ssl_error((sslv->type == CLIENT ? "SSL_connect"
256 : "SSL_accept"), retval, error);
257 shutdown(sslv->fd, SHUT_RDWR);
269 ssl_close(struct vconn *vconn)
271 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
272 poll_cancel(sslv->tx_waiter);
279 interpret_ssl_error(const char *function, int ret, int error)
283 VLOG_ERR("%s: unexpected SSL_ERROR_NONE", function);
286 case SSL_ERROR_ZERO_RETURN:
287 VLOG_ERR("%s: unexpected SSL_ERROR_ZERO_RETURN", function);
290 case SSL_ERROR_WANT_READ:
291 case SSL_ERROR_WANT_WRITE:
294 case SSL_ERROR_WANT_CONNECT:
295 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_CONNECT", function);
298 case SSL_ERROR_WANT_ACCEPT:
299 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_ACCEPT", function);
302 case SSL_ERROR_WANT_X509_LOOKUP:
303 VLOG_ERR("%s: unexpected SSL_ERROR_WANT_X509_LOOKUP", function);
306 case SSL_ERROR_SYSCALL: {
307 int queued_error = ERR_get_error();
308 if (queued_error == 0) {
311 VLOG_WARN("%s: system error (%s)", function, strerror(status));
314 VLOG_WARN("%s: unexpected SSL connection close", function);
318 VLOG_DBG("%s: %s", function, ERR_error_string(queued_error, NULL));
323 case SSL_ERROR_SSL: {
324 int queued_error = ERR_get_error();
325 if (queued_error != 0) {
326 VLOG_DBG("%s: %s", function, ERR_error_string(queued_error, NULL));
328 VLOG_ERR("%s: SSL_ERROR_SSL without queued error", function);
334 VLOG_ERR("%s: bad SSL error code %d", function, error);
341 ssl_recv(struct vconn *vconn, struct buffer **bufferp)
343 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
348 if (sslv->rxbuf == NULL) {
349 sslv->rxbuf = buffer_new(1564);
354 if (sizeof(struct ofp_header) > rx->size) {
355 want_bytes = sizeof(struct ofp_header) - rx->size;
357 struct ofp_header *oh = rx->data;
358 size_t length = ntohs(oh->length);
359 if (length < sizeof(struct ofp_header)) {
360 VLOG_ERR("received too-short ofp_header (%zu bytes)", length);
363 want_bytes = length - rx->size;
370 buffer_reserve_tailroom(rx, want_bytes);
372 /* Behavior of zero-byte SSL_read is poorly defined. */
373 assert(want_bytes > 0);
375 ret = SSL_read(sslv->ssl, buffer_tail(rx), want_bytes);
378 if (ret == want_bytes) {
379 if (rx->size > sizeof(struct ofp_header)) {
389 int error = SSL_get_error(sslv->ssl, ret);
390 if (error == SSL_ERROR_ZERO_RETURN) {
391 /* Connection closed (EOF). */
393 VLOG_WARN("SSL_read: unexpected connection close");
399 return interpret_ssl_error("SSL_read", ret, error);
405 ssl_clear_txbuf(struct ssl_vconn *sslv)
407 buffer_delete(sslv->txbuf);
409 sslv->tx_waiter = NULL;
413 ssl_register_tx_waiter(struct vconn *vconn)
415 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
416 short int events = SSL_want_read(sslv->ssl) ? POLLIN : POLLOUT;
417 sslv->tx_waiter = poll_fd_callback(sslv->fd, events, ssl_do_tx, vconn);
421 ssl_do_tx(int fd UNUSED, short int revents UNUSED, void *vconn_)
423 struct vconn *vconn = vconn_;
424 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
425 int ret = SSL_write(sslv->ssl, sslv->txbuf->data, sslv->txbuf->size);
427 buffer_pull(sslv->txbuf, ret);
428 if (sslv->txbuf->size == 0) {
429 ssl_clear_txbuf(sslv);
433 int error = SSL_get_error(sslv->ssl, ret);
434 if (error == SSL_ERROR_ZERO_RETURN) {
435 /* Connection closed (EOF). */
436 VLOG_WARN("SSL_write: connection close");
437 } else if (interpret_ssl_error("SSL_write", ret, error) != EAGAIN) {
438 ssl_clear_txbuf(sslv);
442 ssl_register_tx_waiter(vconn);
446 ssl_send(struct vconn *vconn, struct buffer *buffer)
448 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
455 ret = SSL_write(sslv->ssl, buffer->data, buffer->size);
457 if (ret == buffer->size) {
458 buffer_delete(buffer);
460 sslv->txbuf = buffer;
461 buffer_pull(buffer, ret);
462 ssl_register_tx_waiter(vconn);
466 int error = SSL_get_error(sslv->ssl, ret);
467 if (error == SSL_ERROR_ZERO_RETURN) {
468 /* Connection closed (EOF). */
469 VLOG_WARN("SSL_write: connection close");
472 return interpret_ssl_error("SSL_write", ret, error);
478 ssl_needs_wait(struct ssl_vconn *sslv)
480 if (SSL_want_read(sslv->ssl)) {
481 poll_fd_wait(sslv->fd, POLLIN);
483 } else if (SSL_want_write(sslv->ssl)) {
484 poll_fd_wait(sslv->fd, POLLOUT);
492 ssl_wait(struct vconn *vconn, enum vconn_wait_type wait)
494 struct ssl_vconn *sslv = ssl_vconn_cast(vconn);
498 if (vconn_connect(vconn) != EAGAIN) {
499 poll_immediate_wake();
500 } else if (sslv->state == STATE_TCP_CONNECTING) {
501 poll_fd_wait(sslv->fd, POLLOUT);
502 } else if (!ssl_needs_wait(sslv)) {
508 if (!ssl_needs_wait(sslv)) {
509 if (SSL_pending(sslv->ssl)) {
510 poll_immediate_wake();
512 poll_fd_wait(sslv->fd, POLLIN);
518 if (!sslv->txbuf && !ssl_needs_wait(sslv)) {
519 poll_fd_wait(sslv->fd, POLLOUT);
528 struct vconn_class ssl_vconn_class = {
532 .connect = ssl_connect,
546 static struct pssl_vconn *
547 pssl_vconn_cast(struct vconn *vconn)
549 assert(vconn->class == &pssl_vconn_class);
550 return CONTAINER_OF(vconn, struct pssl_vconn, vconn);
554 pssl_open(const char *name, char *suffix, struct vconn **vconnp)
556 struct sockaddr_in sin;
557 struct pssl_vconn *pssl;
560 unsigned int yes = 1;
568 fd = socket(AF_INET, SOCK_STREAM, 0);
571 VLOG_ERR("%s: socket: %s", name, strerror(error));
575 if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
577 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", name, strerror(errno));
581 memset(&sin, 0, sizeof sin);
582 sin.sin_family = AF_INET;
583 sin.sin_addr.s_addr = htonl(INADDR_ANY);
584 sin.sin_port = htons(atoi(suffix) ? atoi(suffix) : OFP_SSL_PORT);
585 retval = bind(fd, (struct sockaddr *) &sin, sizeof sin);
588 VLOG_ERR("%s: bind: %s", name, strerror(error));
593 retval = listen(fd, 10);
596 VLOG_ERR("%s: listen: %s", name, strerror(error));
601 retval = set_nonblocking(fd);
607 pssl = xmalloc(sizeof *pssl);
608 pssl->vconn.class = &pssl_vconn_class;
609 pssl->vconn.connect_status = 0;
611 *vconnp = &pssl->vconn;
616 pssl_close(struct vconn *vconn)
618 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
624 pssl_accept(struct vconn *vconn, struct vconn **new_vconnp)
626 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
630 new_fd = accept(pssl->fd, NULL, NULL);
633 if (error != EAGAIN) {
634 VLOG_DBG("accept: %s", strerror(error));
639 error = set_nonblocking(new_fd);
645 return new_ssl_vconn("ssl" /* FIXME */, new_fd,
646 SERVER, STATE_SSL_CONNECTING, new_vconnp);
650 pssl_wait(struct vconn *vconn, enum vconn_wait_type wait)
652 struct pssl_vconn *pssl = pssl_vconn_cast(vconn);
653 assert(wait == WAIT_ACCEPT);
654 poll_fd_wait(pssl->fd, POLLIN);
657 struct vconn_class pssl_vconn_class = {
661 .accept = pssl_accept,
666 * Returns true if OpenSSL error is WANT_READ or WANT_WRITE, indicating that
667 * OpenSSL is requesting that we call it back when the socket is ready for read
668 * or writing, respectively.
671 ssl_wants_io(int ssl_error)
673 return (ssl_error == SSL_ERROR_WANT_WRITE
674 || ssl_error == SSL_ERROR_WANT_READ);
680 static int init_status = -1;
681 if (init_status < 0) {
682 init_status = do_ssl_init();
683 assert(init_status >= 0);
694 SSL_load_error_strings();
696 method = TLSv1_method();
697 if (method == NULL) {
698 VLOG_ERR("TLSv1_method: %s", ERR_error_string(ERR_get_error(), NULL));
702 ctx = SSL_CTX_new(method);
704 VLOG_ERR("SSL_CTX_new: %s", ERR_error_string(ERR_get_error(), NULL));
707 SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
708 SSL_CTX_set_tmp_dh_callback(ctx, tmp_dh_callback);
709 SSL_CTX_set_mode(ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
710 SSL_CTX_set_mode(ctx, SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER);
711 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
718 tmp_dh_callback(SSL *ssl, int is_export UNUSED, int keylength)
723 DH *(*constructor)(void);
726 static struct dh dh_table[] = {
727 {1024, NULL, get_dh1024},
728 {2048, NULL, get_dh2048},
729 {4096, NULL, get_dh4096},
734 for (dh = dh_table; dh < &dh_table[ARRAY_SIZE(dh_table)]; dh++) {
735 if (dh->keylength == keylength) {
737 dh->dh = dh->constructor();
739 fatal(ENOMEM, "out of memory constructing "
740 "Diffie-Hellman parameters");
746 VLOG_ERR("no Diffie-Hellman parameters for key length %d", keylength);
751 vconn_ssl_set_private_key_file(const char *file_name)
756 if (SSL_CTX_use_PrivateKey_file(ctx, file_name, SSL_FILETYPE_PEM) != 1) {
757 VLOG_ERR("SSL_use_PrivateKey_file: %s",
758 ERR_error_string(ERR_get_error(), NULL));
761 has_private_key = true;
765 vconn_ssl_set_certificate_file(const char *file_name)
770 if (SSL_CTX_use_certificate_chain_file(ctx, file_name) != 1) {
771 VLOG_ERR("SSL_use_certificate_file: %s",
772 ERR_error_string(ERR_get_error(), NULL));
775 has_certificate = true;
779 vconn_ssl_set_ca_cert_file(const char *file_name)
781 STACK_OF(X509_NAME) *ca_list;
787 /* Set up list of CAs that the server will accept from the client. */
788 ca_list = SSL_load_client_CA_file(file_name);
789 if (ca_list == NULL) {
790 VLOG_ERR("SSL_load_client_CA_file: %s",
791 ERR_error_string(ERR_get_error(), NULL));
794 SSL_CTX_set_client_CA_list(ctx, ca_list);
796 /* Set up CAs for OpenSSL to trust in verifying the peer's certificate. */
797 if (SSL_CTX_load_verify_locations(ctx, file_name, NULL) != 1) {
798 VLOG_ERR("SSL_CTX_load_verify_locations: %s",
799 ERR_error_string(ERR_get_error(), NULL));