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>
29 <support_level>core</support_level>
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
41 #include <sys/signal.h>
43 #include "asterisk/compat.h"
44 #include "asterisk/tcptls.h"
45 #include "asterisk/http.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/strings.h"
48 #include "asterisk/options.h"
49 #include "asterisk/manager.h"
50 #include "asterisk/astobj2.h"
51 #include "asterisk/pbx.h"
54 * replacement read/write functions for SSL support.
55 * We use wrappers rather than SSL_read/SSL_write directly so
56 * we can put in some debugging.
60 static HOOK_T ssl_read(void *cookie, char *buf, LEN_T len)
62 int i = SSL_read(cookie, buf, len-1);
67 ast_verb(0, "ssl read size %d returns %d <%s>\n", (int)len, i, buf);
72 static HOOK_T ssl_write(void *cookie, const char *buf, LEN_T len)
75 char *s = ast_alloca(len+1);
79 ast_verb(0, "ssl write size %d <%s>\n", (int)len, s);
81 return SSL_write(cookie, buf, len);
84 static int ssl_close(void *cookie)
86 int cookie_fd = SSL_get_fd(cookie);
91 * According to the TLS standard, it is acceptable for an application to only send its shutdown
92 * alert and then close the underlying connection without waiting for the peer's response (this
93 * way resources can be saved, as the process can already terminate or serve another connection).
95 if ((ret = SSL_shutdown(cookie)) < 0) {
96 ast_log(LOG_ERROR, "SSL_shutdown() failed: %d\n", SSL_get_error(cookie, ret));
99 if (!((SSL*)cookie)->server) {
100 /* For client threads, ensure that the error stack is cleared */
105 /* adding shutdown(2) here has no added benefit */
106 if (close(cookie_fd)) {
107 ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
114 HOOK_T ast_tcptls_server_read(struct ast_tcptls_session_instance *tcptls_session, void *buf, size_t count)
116 if (tcptls_session->fd == -1) {
117 ast_log(LOG_ERROR, "server_read called with an fd of -1\n");
123 if (tcptls_session->ssl) {
124 return ssl_read(tcptls_session->ssl, buf, count);
127 return read(tcptls_session->fd, buf, count);
130 HOOK_T ast_tcptls_server_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t count)
132 if (tcptls_session->fd == -1) {
133 ast_log(LOG_ERROR, "server_write called with an fd of -1\n");
139 if (tcptls_session->ssl) {
140 return ssl_write(tcptls_session->ssl, buf, count);
143 return write(tcptls_session->fd, buf, count);
146 static void session_instance_destructor(void *obj)
148 struct ast_tcptls_session_instance *i = obj;
149 ast_free(i->overflow_buf);
153 * creates a FILE * from the fd passed by the accept thread.
154 * This operation is potentially expensive (certificate verification),
155 * so we do it in the child thread context.
157 * \note must decrement ref count before returning NULL on error
159 static void *handle_tcptls_connection(void *data)
161 struct ast_tcptls_session_instance *tcptls_session = data;
163 int (*ssl_setup)(SSL *) = (tcptls_session->client) ? SSL_connect : SSL_accept;
168 /* TCP/TLS connections are associated with external protocols, and
169 * should not be allowed to execute 'dangerous' functions. This may
170 * need to be pushed down into the individual protocol handlers, but
171 * this seems like a good general policy.
173 if (ast_thread_inhibit_escalations()) {
174 ast_log(LOG_ERROR, "Failed to inhibit privilege escalations; killing connection\n");
175 ast_tcptls_close_session_file(tcptls_session);
176 ao2_ref(tcptls_session, -1);
181 * open a FILE * as appropriate.
183 if (!tcptls_session->parent->tls_cfg) {
184 if ((tcptls_session->f = fdopen(tcptls_session->fd, "w+"))) {
185 if(setvbuf(tcptls_session->f, NULL, _IONBF, 0)) {
186 ast_tcptls_close_session_file(tcptls_session);
191 else if ( (tcptls_session->ssl = SSL_new(tcptls_session->parent->tls_cfg->ssl_ctx)) ) {
192 SSL_set_fd(tcptls_session->ssl, tcptls_session->fd);
193 if ((ret = ssl_setup(tcptls_session->ssl)) <= 0) {
194 ast_verb(2, "Problem setting up ssl connection: %s\n", ERR_error_string(ERR_get_error(), err));
196 #if defined(HAVE_FUNOPEN) /* the BSD interface */
197 tcptls_session->f = funopen(tcptls_session->ssl, ssl_read, ssl_write, NULL, ssl_close);
199 #elif defined(HAVE_FOPENCOOKIE) /* the glibc/linux interface */
200 static const cookie_io_functions_t cookie_funcs = {
201 ssl_read, ssl_write, NULL, ssl_close
203 tcptls_session->f = fopencookie(tcptls_session->ssl, "w+", cookie_funcs);
205 /* could add other methods here */
206 ast_debug(2, "no tcptls_session->f methods attempted!\n");
208 if ((tcptls_session->client && !ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_DONT_VERIFY_SERVER))
209 || (!tcptls_session->client && ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_VERIFY_CLIENT))) {
212 peer = SSL_get_peer_certificate(tcptls_session->ssl);
214 ast_log(LOG_ERROR, "No peer SSL certificate to verify\n");
215 ast_tcptls_close_session_file(tcptls_session);
216 ao2_ref(tcptls_session, -1);
220 res = SSL_get_verify_result(tcptls_session->ssl);
221 if (res != X509_V_OK) {
222 ast_log(LOG_ERROR, "Certificate did not verify: %s\n", X509_verify_cert_error_string(res));
224 ast_tcptls_close_session_file(tcptls_session);
225 ao2_ref(tcptls_session, -1);
228 if (!ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_IGNORE_COMMON_NAME)) {
231 X509_NAME *name = X509_get_subject_name(peer);
236 /* Walk the certificate to check all available "Common Name" */
237 /* XXX Probably should do a gethostbyname on the hostname and compare that as well */
238 pos = X509_NAME_get_index_by_NID(name, NID_commonName, pos);
242 str = X509_NAME_ENTRY_get_data(X509_NAME_get_entry(name, pos));
243 ASN1_STRING_to_UTF8(&str2, str);
245 if (!strcasecmp(tcptls_session->parent->hostname, (char *) str2)) {
248 ast_debug(3, "SSL Common Name compare s1='%s' s2='%s'\n", tcptls_session->parent->hostname, str2);
256 ast_log(LOG_ERROR, "Certificate common name did not match (%s)\n", tcptls_session->parent->hostname);
258 ast_tcptls_close_session_file(tcptls_session);
259 ao2_ref(tcptls_session, -1);
266 if (!tcptls_session->f) { /* no success opening descriptor stacking */
267 SSL_free(tcptls_session->ssl);
272 if (!tcptls_session->f) {
273 ast_tcptls_close_session_file(tcptls_session);
274 ast_log(LOG_WARNING, "FILE * open failed!\n");
276 if (tcptls_session->parent->tls_cfg) {
277 ast_log(LOG_WARNING, "Attempted a TLS connection without OpenSSL support. This will not work!\n");
280 ao2_ref(tcptls_session, -1);
284 if (tcptls_session->parent->worker_fn) {
285 return tcptls_session->parent->worker_fn(tcptls_session);
287 return tcptls_session;
291 void *ast_tcptls_server_root(void *data)
293 struct ast_tcptls_session_args *desc = data;
295 struct ast_sockaddr addr;
296 struct ast_tcptls_session_instance *tcptls_session;
302 if (desc->periodic_fn) {
303 desc->periodic_fn(desc);
305 i = ast_wait_for_input(desc->accept_fd, desc->poll_timeout);
309 fd = ast_accept(desc->accept_fd, &addr);
311 if ((errno != EAGAIN) && (errno != EINTR)) {
312 ast_log(LOG_WARNING, "Accept failed: %s\n", strerror(errno));
316 tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor);
317 if (!tcptls_session) {
318 ast_log(LOG_WARNING, "No memory for new session: %s\n", strerror(errno));
320 ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
325 tcptls_session->overflow_buf = ast_str_create(128);
326 flags = fcntl(fd, F_GETFL);
327 fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
328 tcptls_session->fd = fd;
329 tcptls_session->parent = desc;
330 ast_sockaddr_copy(&tcptls_session->remote_address, &addr);
332 tcptls_session->client = 0;
334 /* This thread is now the only place that controls the single ref to tcptls_session */
335 if (ast_pthread_create_detached_background(&launched, NULL, handle_tcptls_connection, tcptls_session)) {
336 ast_log(LOG_WARNING, "Unable to launch helper thread: %s\n", strerror(errno));
337 ast_tcptls_close_session_file(tcptls_session);
338 ao2_ref(tcptls_session, -1);
344 static int __ssl_setup(struct ast_tls_config *cfg, int client)
354 /* Get rid of an old SSL_CTX since we're about to
358 SSL_CTX_free(cfg->ssl_ctx);
363 #ifndef OPENSSL_NO_SSL2
364 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV2_CLIENT)) {
365 cfg->ssl_ctx = SSL_CTX_new(SSLv2_client_method());
368 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV3_CLIENT)) {
369 cfg->ssl_ctx = SSL_CTX_new(SSLv3_client_method());
370 } else if (ast_test_flag(&cfg->flags, AST_SSL_TLSV1_CLIENT)) {
371 cfg->ssl_ctx = SSL_CTX_new(TLSv1_client_method());
373 /* SSLv23_client_method() sends SSLv2, this was the original
374 * default for ssl clients before the option was given to
375 * pick what protocol a client should use. In order not
376 * to break expected behavior it remains the default. */
377 cfg->ssl_ctx = SSL_CTX_new(SSLv23_client_method());
380 /* SSLv23_server_method() supports TLSv1, SSLv2, and SSLv3 inbound connections. */
381 cfg->ssl_ctx = SSL_CTX_new(SSLv23_server_method());
385 ast_debug(1, "Sorry, SSL_CTX_new call returned null...\n");
390 SSL_CTX_set_verify(cfg->ssl_ctx,
391 ast_test_flag(&cfg->flags, AST_SSL_VERIFY_CLIENT) ? SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT : SSL_VERIFY_NONE,
394 if (!ast_strlen_zero(cfg->certfile)) {
395 char *tmpprivate = ast_strlen_zero(cfg->pvtfile) ? cfg->certfile : cfg->pvtfile;
396 if (SSL_CTX_use_certificate_chain_file(cfg->ssl_ctx, cfg->certfile) == 0) {
398 /* Clients don't need a certificate, but if its setup we can use it */
399 ast_verb(0, "SSL error loading cert file. <%s>\n", cfg->certfile);
401 SSL_CTX_free(cfg->ssl_ctx);
406 if ((SSL_CTX_use_PrivateKey_file(cfg->ssl_ctx, tmpprivate, SSL_FILETYPE_PEM) == 0) || (SSL_CTX_check_private_key(cfg->ssl_ctx) == 0 )) {
408 /* Clients don't need a private key, but if its setup we can use it */
409 ast_verb(0, "SSL error loading private key file. <%s>\n", tmpprivate);
411 SSL_CTX_free(cfg->ssl_ctx);
417 if (!ast_strlen_zero(cfg->cipher)) {
418 if (SSL_CTX_set_cipher_list(cfg->ssl_ctx, cfg->cipher) == 0 ) {
420 ast_verb(0, "SSL cipher error <%s>\n", cfg->cipher);
422 SSL_CTX_free(cfg->ssl_ctx);
428 if (!ast_strlen_zero(cfg->cafile) || !ast_strlen_zero(cfg->capath)) {
429 if (SSL_CTX_load_verify_locations(cfg->ssl_ctx, S_OR(cfg->cafile, NULL), S_OR(cfg->capath,NULL)) == 0) {
430 ast_verb(0, "SSL CA file(%s)/path(%s) error\n", cfg->cafile, cfg->capath);
434 ast_verb(0, "SSL certificate ok\n");
439 int ast_ssl_setup(struct ast_tls_config *cfg)
441 return __ssl_setup(cfg, 0);
444 void ast_ssl_teardown(struct ast_tls_config *cfg)
448 SSL_CTX_free(cfg->ssl_ctx);
454 struct ast_tcptls_session_instance *ast_tcptls_client_start(struct ast_tcptls_session_instance *tcptls_session)
456 struct ast_tcptls_session_args *desc;
459 if (!(desc = tcptls_session->parent)) {
460 goto client_start_error;
463 if (ast_connect(desc->accept_fd, &desc->remote_address)) {
464 ast_log(LOG_ERROR, "Unable to connect %s to %s: %s\n",
466 ast_sockaddr_stringify(&desc->remote_address),
468 goto client_start_error;
471 flags = fcntl(desc->accept_fd, F_GETFL);
472 fcntl(desc->accept_fd, F_SETFL, flags & ~O_NONBLOCK);
475 desc->tls_cfg->enabled = 1;
476 __ssl_setup(desc->tls_cfg, 1);
479 return handle_tcptls_connection(tcptls_session);
483 close(desc->accept_fd);
484 desc->accept_fd = -1;
486 ao2_ref(tcptls_session, -1);
491 struct ast_tcptls_session_instance *ast_tcptls_client_create(struct ast_tcptls_session_args *desc)
494 struct ast_tcptls_session_instance *tcptls_session = NULL;
496 /* Do nothing if nothing has changed */
497 if (!ast_sockaddr_cmp(&desc->old_address, &desc->remote_address)) {
498 ast_debug(1, "Nothing changed in %s\n", desc->name);
502 /* If we return early, there is no connection */
503 ast_sockaddr_setnull(&desc->old_address);
505 if (desc->accept_fd != -1) {
506 close(desc->accept_fd);
509 desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->remote_address) ?
510 AF_INET6 : AF_INET, SOCK_STREAM, IPPROTO_TCP);
511 if (desc->accept_fd < 0) {
512 ast_log(LOG_WARNING, "Unable to allocate socket for %s: %s\n",
513 desc->name, strerror(errno));
517 /* if a local address was specified, bind to it so the connection will
518 originate from the desired address */
519 if (!ast_sockaddr_isnull(&desc->local_address)) {
520 setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
521 if (ast_bind(desc->accept_fd, &desc->local_address)) {
522 ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
524 ast_sockaddr_stringify(&desc->local_address),
530 if (!(tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor))) {
534 tcptls_session->overflow_buf = ast_str_create(128);
535 tcptls_session->client = 1;
536 tcptls_session->fd = desc->accept_fd;
537 tcptls_session->parent = desc;
538 tcptls_session->parent->worker_fn = NULL;
539 ast_sockaddr_copy(&tcptls_session->remote_address,
540 &desc->remote_address);
542 /* Set current info */
543 ast_sockaddr_copy(&desc->old_address, &desc->remote_address);
544 return tcptls_session;
547 close(desc->accept_fd);
548 desc->accept_fd = -1;
549 if (tcptls_session) {
550 ao2_ref(tcptls_session, -1);
555 void ast_tcptls_server_start(struct ast_tcptls_session_args *desc)
560 /* Do nothing if nothing has changed */
561 if (!ast_sockaddr_cmp(&desc->old_address, &desc->local_address)) {
562 ast_debug(1, "Nothing changed in %s\n", desc->name);
566 /* If we return early, there is no one listening */
567 ast_sockaddr_setnull(&desc->old_address);
569 /* Shutdown a running server if there is one */
570 if (desc->master != AST_PTHREADT_NULL) {
571 pthread_cancel(desc->master);
572 pthread_kill(desc->master, SIGURG);
573 pthread_join(desc->master, NULL);
576 if (desc->accept_fd != -1) {
577 close(desc->accept_fd);
580 /* If there's no new server, stop here */
581 if (ast_sockaddr_isnull(&desc->local_address)) {
582 ast_debug(2, "Server disabled: %s\n", desc->name);
586 desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->local_address) ?
587 AF_INET6 : AF_INET, SOCK_STREAM, 0);
588 if (desc->accept_fd < 0) {
589 ast_log(LOG_ERROR, "Unable to allocate socket for %s: %s\n", desc->name, strerror(errno));
593 setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
594 if (ast_bind(desc->accept_fd, &desc->local_address)) {
595 ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
597 ast_sockaddr_stringify(&desc->local_address),
601 if (listen(desc->accept_fd, 10)) {
602 ast_log(LOG_ERROR, "Unable to listen for %s!\n", desc->name);
605 flags = fcntl(desc->accept_fd, F_GETFL);
606 fcntl(desc->accept_fd, F_SETFL, flags | O_NONBLOCK);
607 if (ast_pthread_create_background(&desc->master, NULL, desc->accept_fn, desc)) {
608 ast_log(LOG_ERROR, "Unable to launch thread for %s on %s: %s\n",
610 ast_sockaddr_stringify(&desc->local_address),
615 /* Set current info */
616 ast_sockaddr_copy(&desc->old_address, &desc->local_address);
621 close(desc->accept_fd);
622 desc->accept_fd = -1;
625 void ast_tcptls_close_session_file(struct ast_tcptls_session_instance *tcptls_session)
627 if (tcptls_session->f) {
629 * Issuing shutdown() is necessary here to avoid a race
630 * condition where the last data written may not appear
631 * in the TCP stream. See ASTERISK-23548
633 fflush(tcptls_session->f);
634 if (tcptls_session->fd != -1) {
635 shutdown(tcptls_session->fd, SHUT_RDWR);
637 if (fclose(tcptls_session->f)) {
638 ast_log(LOG_ERROR, "fclose() failed: %s\n", strerror(errno));
640 tcptls_session->f = NULL;
641 tcptls_session->fd = -1;
642 } else if (tcptls_session->fd != -1) {
643 shutdown(tcptls_session->fd, SHUT_RDWR);
644 if (close(tcptls_session->fd)) {
645 ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
647 tcptls_session->fd = -1;
649 ast_log(LOG_ERROR, "ast_tcptls_close_session_file invoked on session instance without file or file descriptor\n");
653 void ast_tcptls_server_stop(struct ast_tcptls_session_args *desc)
655 if (desc->master != AST_PTHREADT_NULL) {
656 pthread_cancel(desc->master);
657 pthread_kill(desc->master, SIGURG);
658 pthread_join(desc->master, NULL);
659 desc->master = AST_PTHREADT_NULL;
661 if (desc->accept_fd != -1) {
662 close(desc->accept_fd);
664 desc->accept_fd = -1;
665 ast_debug(2, "Stopped server :: %s\n", desc->name);
668 int ast_tls_read_conf(struct ast_tls_config *tls_cfg, struct ast_tcptls_session_args *tls_desc, const char *varname, const char *value)
670 if (!strcasecmp(varname, "tlsenable") || !strcasecmp(varname, "sslenable")) {
671 tls_cfg->enabled = ast_true(value) ? 1 : 0;
672 } else if (!strcasecmp(varname, "tlscertfile") || !strcasecmp(varname, "sslcert") || !strcasecmp(varname, "tlscert")) {
673 ast_free(tls_cfg->certfile);
674 tls_cfg->certfile = ast_strdup(value);
675 } else if (!strcasecmp(varname, "tlsprivatekey") || !strcasecmp(varname, "sslprivatekey")) {
676 ast_free(tls_cfg->pvtfile);
677 tls_cfg->pvtfile = ast_strdup(value);
678 } else if (!strcasecmp(varname, "tlscipher") || !strcasecmp(varname, "sslcipher")) {
679 ast_free(tls_cfg->cipher);
680 tls_cfg->cipher = ast_strdup(value);
681 } else if (!strcasecmp(varname, "tlscafile")) {
682 ast_free(tls_cfg->cafile);
683 tls_cfg->cafile = ast_strdup(value);
684 } else if (!strcasecmp(varname, "tlscapath") || !strcasecmp(varname, "tlscadir")) {
685 ast_free(tls_cfg->capath);
686 tls_cfg->capath = ast_strdup(value);
687 } else if (!strcasecmp(varname, "tlsverifyclient")) {
688 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_VERIFY_CLIENT);
689 } else if (!strcasecmp(varname, "tlsdontverifyserver")) {
690 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_DONT_VERIFY_SERVER);
691 } else if (!strcasecmp(varname, "tlsbindaddr") || !strcasecmp(varname, "sslbindaddr")) {
692 if (ast_parse_arg(value, PARSE_ADDR, &tls_desc->local_address))
693 ast_log(LOG_WARNING, "Invalid %s '%s'\n", varname, value);
694 } else if (!strcasecmp(varname, "tlsclientmethod") || !strcasecmp(varname, "sslclientmethod")) {
695 if (!strcasecmp(value, "tlsv1")) {
696 ast_set_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
697 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
698 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
699 } else if (!strcasecmp(value, "sslv3")) {
700 ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
701 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
702 ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
703 } else if (!strcasecmp(value, "sslv2")) {
704 ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
705 ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
706 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);