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 close(SSL_get_fd(cookie));
88 HOOK_T ast_tcptls_server_read(struct ast_tcptls_session_instance *tcptls_session, void *buf, size_t count)
90 if (tcptls_session->fd == -1) {
91 ast_log(LOG_ERROR, "server_read called with an fd of -1\n");
97 if (tcptls_session->ssl) {
98 return ssl_read(tcptls_session->ssl, buf, count);
101 return read(tcptls_session->fd, buf, count);
104 HOOK_T ast_tcptls_server_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t count)
106 if (tcptls_session->fd == -1) {
107 ast_log(LOG_ERROR, "server_write called with an fd of -1\n");
113 if (tcptls_session->ssl) {
114 return ssl_write(tcptls_session->ssl, buf, count);
117 return write(tcptls_session->fd, buf, count);
120 static void session_instance_destructor(void *obj)
122 struct ast_tcptls_session_instance *i = obj;
123 ast_mutex_destroy(&i->lock);
127 * creates a FILE * from the fd passed by the accept thread.
128 * This operation is potentially expensive (certificate verification),
129 * so we do it in the child thread context.
131 * \note must decrement ref count before returning NULL on error
133 static void *handle_tcptls_connection(void *data)
135 struct ast_tcptls_session_instance *tcptls_session = data;
137 int (*ssl_setup)(SSL *) = (tcptls_session->client) ? SSL_connect : SSL_accept;
143 * open a FILE * as appropriate.
145 if (!tcptls_session->parent->tls_cfg) {
146 if ((tcptls_session->f = fdopen(tcptls_session->fd, "w+"))) {
147 if(setvbuf(tcptls_session->f, NULL, _IONBF, 0)) {
148 fclose(tcptls_session->f);
149 tcptls_session->f = NULL;
154 else if ( (tcptls_session->ssl = SSL_new(tcptls_session->parent->tls_cfg->ssl_ctx)) ) {
155 SSL_set_fd(tcptls_session->ssl, tcptls_session->fd);
156 if ((ret = ssl_setup(tcptls_session->ssl)) <= 0) {
157 ast_verb(2, "Problem setting up ssl connection: %s\n", ERR_error_string(ERR_get_error(), err));
159 #if defined(HAVE_FUNOPEN) /* the BSD interface */
160 tcptls_session->f = funopen(tcptls_session->ssl, ssl_read, ssl_write, NULL, ssl_close);
162 #elif defined(HAVE_FOPENCOOKIE) /* the glibc/linux interface */
163 static const cookie_io_functions_t cookie_funcs = {
164 ssl_read, ssl_write, NULL, ssl_close
166 tcptls_session->f = fopencookie(tcptls_session->ssl, "w+", cookie_funcs);
168 /* could add other methods here */
169 ast_debug(2, "no tcptls_session->f methods attempted!");
171 if ((tcptls_session->client && !ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_DONT_VERIFY_SERVER))
172 || (!tcptls_session->client && ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_VERIFY_CLIENT))) {
175 peer = SSL_get_peer_certificate(tcptls_session->ssl);
177 ast_log(LOG_WARNING, "No peer SSL certificate\n");
179 res = SSL_get_verify_result(tcptls_session->ssl);
180 if (res != X509_V_OK) {
181 ast_log(LOG_ERROR, "Certificate did not verify: %s\n", X509_verify_cert_error_string(res));
183 if (!ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_IGNORE_COMMON_NAME)) {
186 X509_NAME *name = X509_get_subject_name(peer);
191 /* Walk the certificate to check all available "Common Name" */
192 /* XXX Probably should do a gethostbyname on the hostname and compare that as well */
193 pos = X509_NAME_get_index_by_NID(name, NID_commonName, pos);
197 str = X509_NAME_ENTRY_get_data(X509_NAME_get_entry(name, pos));
198 ASN1_STRING_to_UTF8(&str2, str);
200 if (!strcasecmp(tcptls_session->parent->hostname, (char *) str2)) {
203 ast_debug(3, "SSL Common Name compare s1='%s' s2='%s'\n", tcptls_session->parent->hostname, str2);
211 ast_log(LOG_ERROR, "Certificate common name did not match (%s)\n", tcptls_session->parent->hostname);
215 close(tcptls_session->fd);
216 fclose(tcptls_session->f);
217 ao2_ref(tcptls_session, -1);
226 if (!tcptls_session->f) { /* no success opening descriptor stacking */
227 SSL_free(tcptls_session->ssl);
232 if (!tcptls_session->f) {
233 close(tcptls_session->fd);
234 ast_log(LOG_WARNING, "FILE * open failed!\n");
236 if (tcptls_session->parent->tls_cfg) {
237 ast_log(LOG_WARNING, "Attempted a TLS connection without OpenSSL support. This will not work!\n");
240 ao2_ref(tcptls_session, -1);
244 if (tcptls_session && tcptls_session->parent->worker_fn) {
245 return tcptls_session->parent->worker_fn(tcptls_session);
247 return tcptls_session;
251 void *ast_tcptls_server_root(void *data)
253 struct ast_tcptls_session_args *desc = data;
255 struct ast_sockaddr addr;
256 struct ast_tcptls_session_instance *tcptls_session;
262 if (desc->periodic_fn) {
263 desc->periodic_fn(desc);
265 i = ast_wait_for_input(desc->accept_fd, desc->poll_timeout);
269 fd = ast_accept(desc->accept_fd, &addr);
271 if ((errno != EAGAIN) && (errno != EINTR)) {
272 ast_log(LOG_WARNING, "Accept failed: %s\n", strerror(errno));
276 tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor);
277 if (!tcptls_session) {
278 ast_log(LOG_WARNING, "No memory for new session: %s\n", strerror(errno));
283 ast_mutex_init(&tcptls_session->lock);
285 flags = fcntl(fd, F_GETFL);
286 fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
287 tcptls_session->fd = fd;
288 tcptls_session->parent = desc;
289 ast_sockaddr_copy(&tcptls_session->remote_address, &addr);
291 tcptls_session->client = 0;
293 /* This thread is now the only place that controls the single ref to tcptls_session */
294 if (ast_pthread_create_detached_background(&launched, NULL, handle_tcptls_connection, tcptls_session)) {
295 ast_log(LOG_WARNING, "Unable to launch helper thread: %s\n", strerror(errno));
296 close(tcptls_session->fd);
297 ao2_ref(tcptls_session, -1);
303 static int __ssl_setup(struct ast_tls_config *cfg, int client)
313 SSL_load_error_strings();
314 SSLeay_add_ssl_algorithms();
317 #ifndef OPENSSL_NO_SSL2
318 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV2_CLIENT)) {
319 cfg->ssl_ctx = SSL_CTX_new(SSLv2_client_method());
322 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV3_CLIENT)) {
323 cfg->ssl_ctx = SSL_CTX_new(SSLv3_client_method());
324 } else if (ast_test_flag(&cfg->flags, AST_SSL_TLSV1_CLIENT)) {
325 cfg->ssl_ctx = SSL_CTX_new(TLSv1_client_method());
327 /* SSLv23_client_method() sends SSLv2, this was the original
328 * default for ssl clients before the option was given to
329 * pick what protocol a client should use. In order not
330 * to break expected behavior it remains the default. */
331 cfg->ssl_ctx = SSL_CTX_new(SSLv23_client_method());
334 /* SSLv23_server_method() supports TLSv1, SSLv2, and SSLv3 inbound connections. */
335 cfg->ssl_ctx = SSL_CTX_new(SSLv23_server_method());
339 ast_debug(1, "Sorry, SSL_CTX_new call returned null...\n");
343 if (!ast_strlen_zero(cfg->certfile)) {
344 char *tmpprivate = ast_strlen_zero(cfg->pvtfile) ? cfg->certfile : cfg->pvtfile;
345 if (SSL_CTX_use_certificate_file(cfg->ssl_ctx, cfg->certfile, SSL_FILETYPE_PEM) == 0) {
347 /* Clients don't need a certificate, but if its setup we can use it */
348 ast_verb(0, "SSL error loading cert file. <%s>", cfg->certfile);
354 if ((SSL_CTX_use_PrivateKey_file(cfg->ssl_ctx, tmpprivate, SSL_FILETYPE_PEM) == 0) || (SSL_CTX_check_private_key(cfg->ssl_ctx) == 0 )) {
356 /* Clients don't need a private key, but if its setup we can use it */
357 ast_verb(0, "SSL error loading private key file. <%s>", tmpprivate);
364 if (!ast_strlen_zero(cfg->cipher)) {
365 if (SSL_CTX_set_cipher_list(cfg->ssl_ctx, cfg->cipher) == 0 ) {
367 ast_verb(0, "SSL cipher error <%s>", cfg->cipher);
374 if (!ast_strlen_zero(cfg->cafile) || !ast_strlen_zero(cfg->capath)) {
375 if (SSL_CTX_load_verify_locations(cfg->ssl_ctx, S_OR(cfg->cafile, NULL), S_OR(cfg->capath,NULL)) == 0) {
376 ast_verb(0, "SSL CA file(%s)/path(%s) error\n", cfg->cafile, cfg->capath);
380 ast_verb(0, "SSL certificate ok\n");
385 int ast_ssl_setup(struct ast_tls_config *cfg)
387 return __ssl_setup(cfg, 0);
390 struct ast_tcptls_session_instance *ast_tcptls_client_start(struct ast_tcptls_session_instance *tcptls_session)
392 struct ast_tcptls_session_args *desc;
395 if (!(desc = tcptls_session->parent)) {
396 goto client_start_error;
399 if (ast_connect(desc->accept_fd, &desc->remote_address)) {
400 ast_log(LOG_ERROR, "Unable to connect %s to %s: %s\n",
402 ast_sockaddr_stringify(&desc->remote_address),
404 goto client_start_error;
407 flags = fcntl(desc->accept_fd, F_GETFL);
408 fcntl(desc->accept_fd, F_SETFL, flags & ~O_NONBLOCK);
411 desc->tls_cfg->enabled = 1;
412 __ssl_setup(desc->tls_cfg, 1);
415 return handle_tcptls_connection(tcptls_session);
418 close(desc->accept_fd);
419 desc->accept_fd = -1;
420 if (tcptls_session) {
421 ao2_ref(tcptls_session, -1);
427 struct ast_tcptls_session_instance *ast_tcptls_client_create(struct ast_tcptls_session_args *desc)
430 struct ast_tcptls_session_instance *tcptls_session = NULL;
432 /* Do nothing if nothing has changed */
433 if (!ast_sockaddr_cmp(&desc->old_address, &desc->remote_address)) {
434 ast_debug(1, "Nothing changed in %s\n", desc->name);
438 /* If we return early, there is no connection */
439 ast_sockaddr_setnull(&desc->old_address);
441 if (desc->accept_fd != -1) {
442 close(desc->accept_fd);
445 desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->remote_address) ?
446 AF_INET6 : AF_INET, SOCK_STREAM, IPPROTO_TCP);
447 if (desc->accept_fd < 0) {
448 ast_log(LOG_WARNING, "Unable to allocate socket for %s: %s\n",
449 desc->name, strerror(errno));
453 /* if a local address was specified, bind to it so the connection will
454 originate from the desired address */
455 if (!ast_sockaddr_isnull(&desc->local_address)) {
456 setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
457 if (ast_bind(desc->accept_fd, &desc->local_address)) {
458 ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
460 ast_sockaddr_stringify(&desc->local_address),
466 if (!(tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor))) {
470 ast_mutex_init(&tcptls_session->lock);
471 tcptls_session->client = 1;
472 tcptls_session->fd = desc->accept_fd;
473 tcptls_session->parent = desc;
474 tcptls_session->parent->worker_fn = NULL;
475 ast_sockaddr_copy(&tcptls_session->remote_address,
476 &desc->remote_address);
478 /* Set current info */
479 ast_sockaddr_copy(&desc->old_address, &desc->remote_address);
480 return tcptls_session;
483 close(desc->accept_fd);
484 desc->accept_fd = -1;
485 if (tcptls_session) {
486 ao2_ref(tcptls_session, -1);
491 void ast_tcptls_server_start(struct ast_tcptls_session_args *desc)
496 /* Do nothing if nothing has changed */
497 if (!ast_sockaddr_cmp(&desc->old_address, &desc->local_address)) {
498 ast_debug(1, "Nothing changed in %s\n", desc->name);
502 /* If we return early, there is no one listening */
503 ast_sockaddr_setnull(&desc->old_address);
505 /* Shutdown a running server if there is one */
506 if (desc->master != AST_PTHREADT_NULL) {
507 pthread_cancel(desc->master);
508 pthread_kill(desc->master, SIGURG);
509 pthread_join(desc->master, NULL);
512 if (desc->accept_fd != -1) {
513 close(desc->accept_fd);
516 /* If there's no new server, stop here */
517 if (ast_sockaddr_isnull(&desc->local_address)) {
518 ast_debug(2, "Server disabled: %s\n", desc->name);
522 desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->local_address) ?
523 AF_INET6 : AF_INET, SOCK_STREAM, 0);
524 if (desc->accept_fd < 0) {
525 ast_log(LOG_ERROR, "Unable to allocate socket for %s: %s\n", desc->name, strerror(errno));
529 setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
530 if (ast_bind(desc->accept_fd, &desc->local_address)) {
531 ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
533 ast_sockaddr_stringify(&desc->local_address),
537 if (listen(desc->accept_fd, 10)) {
538 ast_log(LOG_ERROR, "Unable to listen for %s!\n", desc->name);
541 flags = fcntl(desc->accept_fd, F_GETFL);
542 fcntl(desc->accept_fd, F_SETFL, flags | O_NONBLOCK);
543 if (ast_pthread_create_background(&desc->master, NULL, desc->accept_fn, desc)) {
544 ast_log(LOG_ERROR, "Unable to launch thread for %s on %s: %s\n",
546 ast_sockaddr_stringify(&desc->local_address),
551 /* Set current info */
552 ast_sockaddr_copy(&desc->old_address, &desc->local_address);
557 close(desc->accept_fd);
558 desc->accept_fd = -1;
561 void ast_tcptls_server_stop(struct ast_tcptls_session_args *desc)
563 if (desc->master != AST_PTHREADT_NULL) {
564 pthread_cancel(desc->master);
565 pthread_kill(desc->master, SIGURG);
566 pthread_join(desc->master, NULL);
567 desc->master = AST_PTHREADT_NULL;
569 if (desc->accept_fd != -1) {
570 close(desc->accept_fd);
572 desc->accept_fd = -1;
573 ast_debug(2, "Stopped server :: %s\n", desc->name);
576 int ast_tls_read_conf(struct ast_tls_config *tls_cfg, struct ast_tcptls_session_args *tls_desc, const char *varname, const char *value)
578 if (!strcasecmp(varname, "tlsenable") || !strcasecmp(varname, "sslenable")) {
579 tls_cfg->enabled = ast_true(value) ? 1 : 0;
580 } else if (!strcasecmp(varname, "tlscertfile") || !strcasecmp(varname, "sslcert") || !strcasecmp(varname, "tlscert")) {
581 ast_free(tls_cfg->certfile);
582 tls_cfg->certfile = ast_strdup(value);
583 } else if (!strcasecmp(varname, "tlsprivatekey") || !strcasecmp(varname, "sslprivatekey")) {
584 ast_free(tls_cfg->pvtfile);
585 tls_cfg->pvtfile = ast_strdup(value);
586 } else if (!strcasecmp(varname, "tlscipher") || !strcasecmp(varname, "sslcipher")) {
587 ast_free(tls_cfg->cipher);
588 tls_cfg->cipher = ast_strdup(value);
589 } else if (!strcasecmp(varname, "tlscafile")) {
590 ast_free(tls_cfg->cafile);
591 tls_cfg->cafile = ast_strdup(value);
592 } else if (!strcasecmp(varname, "tlscapath") || !strcasecmp(varname, "tlscadir")) {
593 ast_free(tls_cfg->capath);
594 tls_cfg->capath = ast_strdup(value);
595 } else if (!strcasecmp(varname, "tlsverifyclient")) {
596 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_VERIFY_CLIENT);
597 } else if (!strcasecmp(varname, "tlsdontverifyserver")) {
598 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_DONT_VERIFY_SERVER);
599 } else if (!strcasecmp(varname, "tlsbindaddr") || !strcasecmp(varname, "sslbindaddr")) {
600 if (ast_parse_arg(value, PARSE_ADDR, &tls_desc->local_address))
601 ast_log(LOG_WARNING, "Invalid %s '%s'\n", varname, value);
602 } else if (!strcasecmp(varname, "tlsclientmethod") || !strcasecmp(varname, "sslclientmethod")) {
603 if (!strcasecmp(value, "tlsv1")) {
604 ast_set_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
605 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
606 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
607 } else if (!strcasecmp(value, "sslv3")) {
608 ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
609 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
610 ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
611 } else if (!strcasecmp(value, "sslv2")) {
612 ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
613 ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
614 ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);