2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 2007 - 2008, Digium, Inc.
6 * Luigi Rizzo (TCP and TLS server code)
7 * Brett Bryant <brettbryant@gmail.com> (updated for client support)
9 * See http://www.asterisk.org for more information about
10 * the Asterisk project. Please do not directly contact
11 * any of the maintainers of this project for assistance;
12 * the project provides a web site, mailing lists and IRC
13 * channels for your use.
15 * This program is free software, distributed under the terms of
16 * the GNU General Public License Version 2. See the LICENSE file
17 * at the top of the source tree.
22 * \brief Code to support TCP and TLS server/client
25 * \author Brett Bryant <brettbryant@gmail.com>
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37 #include <sys/signal.h>
39 #include "asterisk/compat.h"
40 #include "asterisk/tcptls.h"
41 #include "asterisk/http.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/strings.h"
44 #include "asterisk/options.h"
45 #include "asterisk/manager.h"
46 #include "asterisk/astobj2.h"
49 * replacement read/write functions for SSL support.
50 * We use wrappers rather than SSL_read/SSL_write directly so
51 * we can put in some debugging.
55 static HOOK_T ssl_read(void *cookie, char *buf, LEN_T len)
57 int i = SSL_read(cookie, buf, len-1);
62 ast_verb(0, "ssl read size %d returns %d <%s>\n", (int)len, i, buf);
67 static HOOK_T ssl_write(void *cookie, const char *buf, LEN_T len)
70 char *s = alloca(len+1);
74 ast_verb(0, "ssl write size %d <%s>\n", (int)len, s);
76 return SSL_write(cookie, buf, len);
79 static int ssl_close(void *cookie)
81 int cookie_fd = SSL_get_fd(cookie);
85 * According to the TLS standard, it is acceptable for an application to only send its shutdown
86 * alert and then close the underlying connection without waiting for the peer's response (this
87 * way resources can be saved, as the process can already terminate or serve another connection).
89 if ((ret = SSL_shutdown(cookie)) < 0) {
90 ast_log(LOG_ERROR, "SSL_shutdown() failed: %d\n", SSL_get_error(cookie, ret));
93 /* adding shutdown(2) here has no added benefit */
94 if (close(cookie_fd)) {
95 ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
102 HOOK_T ast_tcptls_server_read(struct ast_tcptls_session_instance *tcptls_session, void *buf, size_t count)
104 if (tcptls_session->fd == -1) {
105 ast_log(LOG_ERROR, "server_read called with an fd of -1\n");
111 if (tcptls_session->ssl) {
112 return ssl_read(tcptls_session->ssl, buf, count);
115 return read(tcptls_session->fd, buf, count);
118 HOOK_T ast_tcptls_server_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t count)
120 if (tcptls_session->fd == -1) {
121 ast_log(LOG_ERROR, "server_write called with an fd of -1\n");
127 if (tcptls_session->ssl) {
128 return ssl_write(tcptls_session->ssl, buf, count);
131 return write(tcptls_session->fd, buf, count);
134 static void session_instance_destructor(void *obj)
136 struct ast_tcptls_session_instance *i = obj;
137 if (i->parent && i->parent->tls_cfg) {
138 ast_ssl_teardown(i->parent->tls_cfg);
143 * creates a FILE * from the fd passed by the accept thread.
144 * This operation is potentially expensive (certificate verification),
145 * so we do it in the child thread context.
147 * \note must decrement ref count before returning NULL on error
149 static void *handle_tcptls_connection(void *data)
151 struct ast_tcptls_session_instance *tcptls_session = data;
153 int (*ssl_setup)(SSL *) = (tcptls_session->client) ? SSL_connect : SSL_accept;
159 * open a FILE * as appropriate.
161 if (!tcptls_session->parent->tls_cfg) {
162 if ((tcptls_session->f = fdopen(tcptls_session->fd, "w+"))) {
163 if(setvbuf(tcptls_session->f, NULL, _IONBF, 0)) {
164 ast_tcptls_close_session_file(tcptls_session);
169 else if ( (tcptls_session->ssl = SSL_new(tcptls_session->parent->tls_cfg->ssl_ctx)) ) {
170 SSL_set_fd(tcptls_session->ssl, tcptls_session->fd);
171 if ((ret = ssl_setup(tcptls_session->ssl)) <= 0) {
172 ast_verb(2, "Problem setting up ssl connection: %s\n", ERR_error_string(ERR_get_error(), err));
174 #if defined(HAVE_FUNOPEN) /* the BSD interface */
175 tcptls_session->f = funopen(tcptls_session->ssl, ssl_read, ssl_write, NULL, ssl_close);
177 #elif defined(HAVE_FOPENCOOKIE) /* the glibc/linux interface */
178 static const cookie_io_functions_t cookie_funcs = {
179 ssl_read, ssl_write, NULL, ssl_close
181 tcptls_session->f = fopencookie(tcptls_session->ssl, "w+", cookie_funcs);
183 /* could add other methods here */
184 ast_debug(2, "no tcptls_session->f methods attempted!\n");
186 if ((tcptls_session->client && !ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_DONT_VERIFY_SERVER))
187 || (!tcptls_session->client && ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_VERIFY_CLIENT))) {
190 peer = SSL_get_peer_certificate(tcptls_session->ssl);
192 ast_log(LOG_WARNING, "No peer SSL certificate\n");
194 res = SSL_get_verify_result(tcptls_session->ssl);
195 if (res != X509_V_OK) {
196 ast_log(LOG_ERROR, "Certificate did not verify: %s\n", X509_verify_cert_error_string(res));
198 if (!ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_IGNORE_COMMON_NAME)) {
201 X509_NAME *name = X509_get_subject_name(peer);
206 /* Walk the certificate to check all available "Common Name" */
207 /* XXX Probably should do a gethostbyname on the hostname and compare that as well */
208 pos = X509_NAME_get_index_by_NID(name, NID_commonName, pos);
212 str = X509_NAME_ENTRY_get_data(X509_NAME_get_entry(name, pos));
213 ASN1_STRING_to_UTF8(&str2, str);
215 if (!strcasecmp(tcptls_session->parent->hostname, (char *) str2)) {
218 ast_debug(3, "SSL Common Name compare s1='%s' s2='%s'\n", tcptls_session->parent->hostname, str2);
226 ast_log(LOG_ERROR, "Certificate common name did not match (%s)\n", tcptls_session->parent->hostname);
230 ast_tcptls_close_session_file(tcptls_session);
231 ao2_ref(tcptls_session, -1);
240 if (!tcptls_session->f) { /* no success opening descriptor stacking */
241 SSL_free(tcptls_session->ssl);
246 if (!tcptls_session->f) {
247 ast_tcptls_close_session_file(tcptls_session);
248 ast_log(LOG_WARNING, "FILE * open failed!\n");
250 if (tcptls_session->parent->tls_cfg) {
251 ast_log(LOG_WARNING, "Attempted a TLS connection without OpenSSL support. This will not work!\n");
254 ao2_ref(tcptls_session, -1);
258 if (tcptls_session && tcptls_session->parent->worker_fn) {
259 return tcptls_session->parent->worker_fn(tcptls_session);
261 return tcptls_session;
265 void *ast_tcptls_server_root(void *data)
267 struct ast_tcptls_session_args *desc = data;
269 struct ast_sockaddr addr;
270 struct ast_tcptls_session_instance *tcptls_session;
276 if (desc->periodic_fn) {
277 desc->periodic_fn(desc);
279 i = ast_wait_for_input(desc->accept_fd, desc->poll_timeout);
283 fd = ast_accept(desc->accept_fd, &addr);
285 if ((errno != EAGAIN) && (errno != EINTR)) {
286 ast_log(LOG_WARNING, "Accept failed: %s\n", strerror(errno));
290 tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor);
291 if (!tcptls_session) {
292 ast_log(LOG_WARNING, "No memory for new session: %s\n", strerror(errno));
294 ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
299 flags = fcntl(fd, F_GETFL);
300 fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
301 tcptls_session->fd = fd;
302 tcptls_session->parent = desc;
303 ast_sockaddr_copy(&tcptls_session->remote_address, &addr);
305 tcptls_session->client = 0;
307 /* This thread is now the only place that controls the single ref to tcptls_session */
308 if (ast_pthread_create_detached_background(&launched, NULL, handle_tcptls_connection, tcptls_session)) {
309 ast_log(LOG_WARNING, "Unable to launch helper thread: %s\n", strerror(errno));
310 ast_tcptls_close_session_file(tcptls_session);
311 ao2_ref(tcptls_session, -1);
317 static int __ssl_setup(struct ast_tls_config *cfg, int client)
327 SSL_load_error_strings();
328 SSLeay_add_ssl_algorithms();
330 /* Get rid of an old SSL_CTX since we're about to
334 SSL_CTX_free(cfg->ssl_ctx);
339 #ifndef OPENSSL_NO_SSL2
340 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV2_CLIENT)) {
341 cfg->ssl_ctx = SSL_CTX_new(SSLv2_client_method());
344 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV3_CLIENT)) {
345 cfg->ssl_ctx = SSL_CTX_new(SSLv3_client_method());
346 } else if (ast_test_flag(&cfg->flags, AST_SSL_TLSV1_CLIENT)) {
347 cfg->ssl_ctx = SSL_CTX_new(TLSv1_client_method());
349 /* SSLv23_client_method() sends SSLv2, this was the original
350 * default for ssl clients before the option was given to
351 * pick what protocol a client should use. In order not
352 * to break expected behavior it remains the default. */
353 cfg->ssl_ctx = SSL_CTX_new(SSLv23_client_method());
356 /* SSLv23_server_method() supports TLSv1, SSLv2, and SSLv3 inbound connections. */
357 cfg->ssl_ctx = SSL_CTX_new(SSLv23_server_method());
361 ast_debug(1, "Sorry, SSL_CTX_new call returned null...\n");
365 if (!ast_strlen_zero(cfg->certfile)) {
366 char *tmpprivate = ast_strlen_zero(cfg->pvtfile) ? cfg->certfile : cfg->pvtfile;
367 if (SSL_CTX_use_certificate_file(cfg->ssl_ctx, cfg->certfile, SSL_FILETYPE_PEM) == 0) {
369 /* Clients don't need a certificate, but if its setup we can use it */
370 ast_verb(0, "SSL error loading cert file. <%s>\n", cfg->certfile);
373 SSL_CTX_free(cfg->ssl_ctx);
378 if ((SSL_CTX_use_PrivateKey_file(cfg->ssl_ctx, tmpprivate, SSL_FILETYPE_PEM) == 0) || (SSL_CTX_check_private_key(cfg->ssl_ctx) == 0 )) {
380 /* Clients don't need a private key, but if its setup we can use it */
381 ast_verb(0, "SSL error loading private key file. <%s>\n", tmpprivate);
384 SSL_CTX_free(cfg->ssl_ctx);
390 if (!ast_strlen_zero(cfg->cipher)) {
391 if (SSL_CTX_set_cipher_list(cfg->ssl_ctx, cfg->cipher) == 0 ) {
393 ast_verb(0, "SSL cipher error <%s>\n", cfg->cipher);
396 SSL_CTX_free(cfg->ssl_ctx);
402 if (!ast_strlen_zero(cfg->cafile) || !ast_strlen_zero(cfg->capath)) {
403 if (SSL_CTX_load_verify_locations(cfg->ssl_ctx, S_OR(cfg->cafile, NULL), S_OR(cfg->capath,NULL)) == 0) {
404 ast_verb(0, "SSL CA file(%s)/path(%s) error\n", cfg->cafile, cfg->capath);
408 ast_verb(0, "SSL certificate ok\n");
413 int ast_ssl_setup(struct ast_tls_config *cfg)
415 return __ssl_setup(cfg, 0);
418 void ast_ssl_teardown(struct ast_tls_config *cfg)
422 SSL_CTX_free(cfg->ssl_ctx);
428 struct ast_tcptls_session_instance *ast_tcptls_client_start(struct ast_tcptls_session_instance *tcptls_session)
430 struct ast_tcptls_session_args *desc;
433 if (!(desc = tcptls_session->parent)) {
434 goto client_start_error;
437 if (ast_connect(desc->accept_fd, &desc->remote_address)) {
438 ast_log(LOG_ERROR, "Unable to connect %s to %s: %s\n",
440 ast_sockaddr_stringify(&desc->remote_address),
442 goto client_start_error;
445 flags = fcntl(desc->accept_fd, F_GETFL);
446 fcntl(desc->accept_fd, F_SETFL, flags & ~O_NONBLOCK);
449 desc->tls_cfg->enabled = 1;
450 __ssl_setup(desc->tls_cfg, 1);
453 return handle_tcptls_connection(tcptls_session);
457 close(desc->accept_fd);
458 desc->accept_fd = -1;
460 if (tcptls_session) {
461 ao2_ref(tcptls_session, -1);
467 struct ast_tcptls_session_instance *ast_tcptls_client_create(struct ast_tcptls_session_args *desc)
470 struct ast_tcptls_session_instance *tcptls_session = NULL;
472 /* Do nothing if nothing has changed */
473 if (!ast_sockaddr_cmp(&desc->old_address, &desc->remote_address)) {
474 ast_debug(1, "Nothing changed in %s\n", desc->name);
478 /* If we return early, there is no connection */
479 ast_sockaddr_setnull(&desc->old_address);
481 if (desc->accept_fd != -1) {
482 close(desc->accept_fd);
485 desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->remote_address) ?
486 AF_INET6 : AF_INET, SOCK_STREAM, IPPROTO_TCP);
487 if (desc->accept_fd < 0) {
488 ast_log(LOG_WARNING, "Unable to allocate socket for %s: %s\n",
489 desc->name, strerror(errno));
493 /* if a local address was specified, bind to it so the connection will
494 originate from the desired address */
495 if (!ast_sockaddr_isnull(&desc->local_address)) {
496 setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
497 if (ast_bind(desc->accept_fd, &desc->local_address)) {
498 ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
500 ast_sockaddr_stringify(&desc->local_address),
506 if (!(tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor))) {
510 tcptls_session->client = 1;
511 tcptls_session->fd = desc->accept_fd;
512 tcptls_session->parent = desc;
513 tcptls_session->parent->worker_fn = NULL;
514 ast_sockaddr_copy(&tcptls_session->remote_address,
515 &desc->remote_address);
517 /* Set current info */
518 ast_sockaddr_copy(&desc->old_address, &desc->remote_address);
519 return tcptls_session;
522 close(desc->accept_fd);
523 desc->accept_fd = -1;
524 if (tcptls_session) {
525 ao2_ref(tcptls_session, -1);
530 void ast_tcptls_server_start(struct ast_tcptls_session_args *desc)
535 /* Do nothing if nothing has changed */
536 if (!ast_sockaddr_cmp(&desc->old_address, &desc->local_address)) {
537 ast_debug(1, "Nothing changed in %s\n", desc->name);
541 /* If we return early, there is no one listening */
542 ast_sockaddr_setnull(&desc->old_address);
544 /* Shutdown a running server if there is one */
545 if (desc->master != AST_PTHREADT_NULL) {
546 pthread_cancel(desc->master);
547 pthread_kill(desc->master, SIGURG);
548 pthread_join(desc->master, NULL);
551 if (desc->accept_fd != -1) {
552 close(desc->accept_fd);
555 /* If there's no new server, stop here */
556 if (ast_sockaddr_isnull(&desc->local_address)) {
557 ast_debug(2, "Server disabled: %s\n", desc->name);
561 desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->local_address) ?
562 AF_INET6 : AF_INET, SOCK_STREAM, 0);
563 if (desc->accept_fd < 0) {
564 ast_log(LOG_ERROR, "Unable to allocate socket for %s: %s\n", desc->name, strerror(errno));
568 setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
569 if (ast_bind(desc->accept_fd, &desc->local_address)) {
570 ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
572 ast_sockaddr_stringify(&desc->local_address),
576 if (listen(desc->accept_fd, 10)) {
577 ast_log(LOG_ERROR, "Unable to listen for %s!\n", desc->name);
580 flags = fcntl(desc->accept_fd, F_GETFL);
581 fcntl(desc->accept_fd, F_SETFL, flags | O_NONBLOCK);
582 if (ast_pthread_create_background(&desc->master, NULL, desc->accept_fn, desc)) {
583 ast_log(LOG_ERROR, "Unable to launch thread for %s on %s: %s\n",
585 ast_sockaddr_stringify(&desc->local_address),
590 /* Set current info */
591 ast_sockaddr_copy(&desc->old_address, &desc->local_address);
596 close(desc->accept_fd);
597 desc->accept_fd = -1;
600 void ast_tcptls_close_session_file(struct ast_tcptls_session_instance *tcptls_session)
602 if (tcptls_session->f) {
603 if (fclose(tcptls_session->f)) {
604 ast_log(LOG_ERROR, "fclose() failed: %s\n", strerror(errno));
606 tcptls_session->f = NULL;
607 tcptls_session->fd = -1;
608 } else if (tcptls_session->fd != -1) {
609 if (close(tcptls_session->fd)) {
610 ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
612 tcptls_session->fd = -1;
614 ast_log(LOG_ERROR, "ast_tcptls_close_session_file invoked on session instance without file or file descriptor\n");
618 void ast_tcptls_server_stop(struct ast_tcptls_session_args *desc)
620 if (desc->master != AST_PTHREADT_NULL) {
621 pthread_cancel(desc->master);
622 pthread_kill(desc->master, SIGURG);
623 pthread_join(desc->master, NULL);
624 desc->master = AST_PTHREADT_NULL;
626 if (desc->accept_fd != -1) {
627 close(desc->accept_fd);
629 desc->accept_fd = -1;
630 ast_debug(2, "Stopped server :: %s\n", desc->name);
633 int ast_tls_read_conf(struct ast_tls_config *tls_cfg, struct ast_tcptls_session_args *tls_desc, const char *varname, const char *value)
635 if (!strcasecmp(varname, "tlsenable") || !strcasecmp(varname, "sslenable")) {
636 tls_cfg->enabled = ast_true(value) ? 1 : 0;
637 } else if (!strcasecmp(varname, "tlscertfile") || !strcasecmp(varname, "sslcert") || !strcasecmp(varname, "tlscert")) {
638 ast_free(tls_cfg->certfile);
639 tls_cfg->certfile = ast_strdup(value);
640 } else if (!strcasecmp(varname, "tlsprivatekey") || !strcasecmp(varname, "sslprivatekey")) {
641 ast_free(tls_cfg->pvtfile);
642 tls_cfg->pvtfile = ast_strdup(value);
643 } else if (!strcasecmp(varname, "tlscipher") || !strcasecmp(varname, "sslcipher")) {
644 ast_free(tls_cfg->cipher);
645 tls_cfg->cipher = ast_strdup(value);
646 } else if (!strcasecmp(varname, "tlscafile")) {
647 ast_free(tls_cfg->cafile);
648 tls_cfg->cafile = ast_strdup(value);
649 } else if (!strcasecmp(varname, "tlscapath") || !strcasecmp(varname, "tlscadir")) {
650 ast_free(tls_cfg->capath);
651 tls_cfg->capath = ast_strdup(value);
652 } else if (!strcasecmp(varname, "tlsverifyclient")) {
653 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_VERIFY_CLIENT);
654 } else if (!strcasecmp(varname, "tlsdontverifyserver")) {
655 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_DONT_VERIFY_SERVER);
656 } else if (!strcasecmp(varname, "tlsbindaddr") || !strcasecmp(varname, "sslbindaddr")) {
657 if (ast_parse_arg(value, PARSE_ADDR, &tls_desc->local_address))
658 ast_log(LOG_WARNING, "Invalid %s '%s'\n", varname, value);
659 } else if (!strcasecmp(varname, "tlsclientmethod") || !strcasecmp(varname, "sslclientmethod")) {
660 if (!strcasecmp(value, "tlsv1")) {
661 ast_set_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
662 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
663 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
664 } else if (!strcasecmp(value, "sslv3")) {
665 ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
666 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
667 ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
668 } else if (!strcasecmp(value, "sslv2")) {
669 ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
670 ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
671 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);