tcptls: Avoid compiler warning on non-dev-mode.
[asterisk/asterisk.git] / main / tcptls.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007 - 2008, Digium, Inc.
5  *
6  * Luigi Rizzo (TCP and TLS server code)
7  * Brett Bryant <brettbryant@gmail.com> (updated for client support)
8  *
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.
14  *
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.
18  */
19
20 /*!
21  * \file
22  * \brief Code to support TCP and TLS server/client
23  *
24  * \author Luigi Rizzo
25  * \author Brett Bryant <brettbryant@gmail.com>
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #ifdef HAVE_FCNTL_H
37 #include <fcntl.h>
38 #endif
39
40 #include <signal.h>
41 #include <sys/signal.h>
42
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"
52
53 /*! ao2 object used for the FILE stream fopencookie()/funopen() cookie. */
54 struct ast_tcptls_stream {
55         /*! SSL state if not NULL */
56         SSL *ssl;
57         /*!
58          * \brief Start time from when an I/O sequence must complete
59          * by struct ast_tcptls_stream.timeout.
60          *
61          * \note If struct ast_tcptls_stream.start.tv_sec is zero then
62          * start time is the current I/O request.
63          */
64         struct timeval start;
65         /*!
66          * \brief The socket returned by accept().
67          *
68          * \note Set to -1 if the stream is closed.
69          */
70         int fd;
71         /*!
72          * \brief Timeout in ms relative to struct ast_tcptls_stream.start
73          * to wait for an event on struct ast_tcptls_stream.fd.
74          *
75          * \note Set to -1 to disable timeout.
76          * \note The socket needs to be set to non-blocking for the timeout
77          * feature to work correctly.
78          */
79         int timeout;
80         /*! TRUE if stream can exclusively wait for fd input. */
81         int exclusive_input;
82 };
83
84 void ast_tcptls_stream_set_timeout_disable(struct ast_tcptls_stream *stream)
85 {
86         ast_assert(stream != NULL);
87
88         stream->timeout = -1;
89 }
90
91 void ast_tcptls_stream_set_timeout_inactivity(struct ast_tcptls_stream *stream, int timeout)
92 {
93         ast_assert(stream != NULL);
94
95         stream->start.tv_sec = 0;
96         stream->timeout = timeout;
97 }
98
99 void ast_tcptls_stream_set_timeout_sequence(struct ast_tcptls_stream *stream, struct timeval start, int timeout)
100 {
101         ast_assert(stream != NULL);
102
103         stream->start = start;
104         stream->timeout = timeout;
105 }
106
107 void ast_tcptls_stream_set_exclusive_input(struct ast_tcptls_stream *stream, int exclusive_input)
108 {
109         ast_assert(stream != NULL);
110
111         stream->exclusive_input = exclusive_input;
112 }
113
114 /*!
115  * \internal
116  * \brief fopencookie()/funopen() stream read function.
117  *
118  * \param cookie Stream control data.
119  * \param buf Where to put read data.
120  * \param size Size of the buffer.
121  *
122  * \retval number of bytes put into buf.
123  * \retval 0 on end of file.
124  * \retval -1 on error.
125  */
126 static HOOK_T tcptls_stream_read(void *cookie, char *buf, LEN_T size)
127 {
128         struct ast_tcptls_stream *stream = cookie;
129         struct timeval start;
130         int ms;
131         int res;
132
133         if (!size) {
134                 /* You asked for no data you got no data. */
135                 return 0;
136         }
137
138         if (!stream || stream->fd == -1) {
139                 errno = EBADF;
140                 return -1;
141         }
142
143         if (stream->start.tv_sec) {
144                 start = stream->start;
145         } else {
146                 start = ast_tvnow();
147         }
148
149 #if defined(DO_SSL)
150         if (stream->ssl) {
151                 for (;;) {
152                         res = SSL_read(stream->ssl, buf, size);
153                         if (0 < res) {
154                                 /* We read some payload data. */
155                                 return res;
156                         }
157                         switch (SSL_get_error(stream->ssl, res)) {
158                         case SSL_ERROR_ZERO_RETURN:
159                                 /* Report EOF for a shutdown */
160                                 ast_debug(1, "TLS clean shutdown alert reading data\n");
161                                 return 0;
162                         case SSL_ERROR_WANT_READ:
163                                 if (!stream->exclusive_input) {
164                                         /* We cannot wait for data now. */
165                                         errno = EAGAIN;
166                                         return -1;
167                                 }
168                                 while ((ms = ast_remaining_ms(start, stream->timeout))) {
169                                         res = ast_wait_for_input(stream->fd, ms);
170                                         if (0 < res) {
171                                                 /* Socket is ready to be read. */
172                                                 break;
173                                         }
174                                         if (res < 0) {
175                                                 if (errno == EINTR || errno == EAGAIN) {
176                                                         /* Try again. */
177                                                         continue;
178                                                 }
179                                                 ast_debug(1, "TLS socket error waiting for read data: %s\n",
180                                                         strerror(errno));
181                                                 return -1;
182                                         }
183                                 }
184                                 break;
185                         case SSL_ERROR_WANT_WRITE:
186                                 while ((ms = ast_remaining_ms(start, stream->timeout))) {
187                                         res = ast_wait_for_output(stream->fd, ms);
188                                         if (0 < res) {
189                                                 /* Socket is ready to be written. */
190                                                 break;
191                                         }
192                                         if (res < 0) {
193                                                 if (errno == EINTR || errno == EAGAIN) {
194                                                         /* Try again. */
195                                                         continue;
196                                                 }
197                                                 ast_debug(1, "TLS socket error waiting for write space: %s\n",
198                                                         strerror(errno));
199                                                 return -1;
200                                         }
201                                 }
202                                 break;
203                         default:
204                                 /* Report EOF for an undecoded SSL or transport error. */
205                                 ast_debug(1, "TLS transport or SSL error reading data\n");
206                                 return 0;
207                         }
208                         if (!ms) {
209                                 /* Report EOF for a timeout */
210                                 ast_debug(1, "TLS timeout reading data\n");
211                                 return 0;
212                         }
213                 }
214         }
215 #endif  /* defined(DO_SSL) */
216
217         for (;;) {
218                 res = read(stream->fd, buf, size);
219                 if (0 <= res || !stream->exclusive_input) {
220                         /* Got data or we cannot wait for it. */
221                         return res;
222                 }
223                 if (errno != EINTR && errno != EAGAIN) {
224                         /* Not a retryable error. */
225                         ast_debug(1, "TCP socket error reading data: %s\n",
226                                 strerror(errno));
227                         return -1;
228                 }
229                 ms = ast_remaining_ms(start, stream->timeout);
230                 if (!ms) {
231                         /* Report EOF for a timeout */
232                         ast_debug(1, "TCP timeout reading data\n");
233                         return 0;
234                 }
235                 ast_wait_for_input(stream->fd, ms);
236         }
237 }
238
239 /*!
240  * \internal
241  * \brief fopencookie()/funopen() stream write function.
242  *
243  * \param cookie Stream control data.
244  * \param buf Where to get data to write.
245  * \param size Size of the buffer.
246  *
247  * \retval number of bytes written from buf.
248  * \retval -1 on error.
249  */
250 static HOOK_T tcptls_stream_write(void *cookie, const char *buf, LEN_T size)
251 {
252         struct ast_tcptls_stream *stream = cookie;
253         struct timeval start;
254         int ms;
255         int res;
256         int written;
257         int remaining;
258
259         if (!size) {
260                 /* You asked to write no data you wrote no data. */
261                 return 0;
262         }
263
264         if (!stream || stream->fd == -1) {
265                 errno = EBADF;
266                 return -1;
267         }
268
269         if (stream->start.tv_sec) {
270                 start = stream->start;
271         } else {
272                 start = ast_tvnow();
273         }
274
275 #if defined(DO_SSL)
276         if (stream->ssl) {
277                 written = 0;
278                 remaining = size;
279                 for (;;) {
280                         res = SSL_write(stream->ssl, buf + written, remaining);
281                         if (res == remaining) {
282                                 /* Everything was written. */
283                                 return size;
284                         }
285                         if (0 < res) {
286                                 /* Successfully wrote part of the buffer.  Try to write the rest. */
287                                 written += res;
288                                 remaining -= res;
289                                 continue;
290                         }
291                         switch (SSL_get_error(stream->ssl, res)) {
292                         case SSL_ERROR_ZERO_RETURN:
293                                 ast_debug(1, "TLS clean shutdown alert writing data\n");
294                                 if (written) {
295                                         /* Report partial write. */
296                                         return written;
297                                 }
298                                 errno = EBADF;
299                                 return -1;
300                         case SSL_ERROR_WANT_READ:
301                                 ms = ast_remaining_ms(start, stream->timeout);
302                                 if (!ms) {
303                                         /* Report partial write. */
304                                         ast_debug(1, "TLS timeout writing data (want read)\n");
305                                         return written;
306                                 }
307                                 ast_wait_for_input(stream->fd, ms);
308                                 break;
309                         case SSL_ERROR_WANT_WRITE:
310                                 ms = ast_remaining_ms(start, stream->timeout);
311                                 if (!ms) {
312                                         /* Report partial write. */
313                                         ast_debug(1, "TLS timeout writing data (want write)\n");
314                                         return written;
315                                 }
316                                 ast_wait_for_output(stream->fd, ms);
317                                 break;
318                         default:
319                                 /* Undecoded SSL or transport error. */
320                                 ast_debug(1, "TLS transport or SSL error writing data\n");
321                                 if (written) {
322                                         /* Report partial write. */
323                                         return written;
324                                 }
325                                 errno = EBADF;
326                                 return -1;
327                         }
328                 }
329         }
330 #endif  /* defined(DO_SSL) */
331
332         written = 0;
333         remaining = size;
334         for (;;) {
335                 res = write(stream->fd, buf + written, remaining);
336                 if (res == remaining) {
337                         /* Yay everything was written. */
338                         return size;
339                 }
340                 if (0 < res) {
341                         /* Successfully wrote part of the buffer.  Try to write the rest. */
342                         written += res;
343                         remaining -= res;
344                         continue;
345                 }
346                 if (errno != EINTR && errno != EAGAIN) {
347                         /* Not a retryable error. */
348                         ast_debug(1, "TCP socket error writing: %s\n", strerror(errno));
349                         if (written) {
350                                 return written;
351                         }
352                         return -1;
353                 }
354                 ms = ast_remaining_ms(start, stream->timeout);
355                 if (!ms) {
356                         /* Report partial write. */
357                         ast_debug(1, "TCP timeout writing data\n");
358                         return written;
359                 }
360                 ast_wait_for_output(stream->fd, ms);
361         }
362 }
363
364 /*!
365  * \internal
366  * \brief fopencookie()/funopen() stream close function.
367  *
368  * \param cookie Stream control data.
369  *
370  * \retval 0 on success.
371  * \retval -1 on error.
372  */
373 static int tcptls_stream_close(void *cookie)
374 {
375         struct ast_tcptls_stream *stream = cookie;
376
377         if (!stream) {
378                 errno = EBADF;
379                 return -1;
380         }
381
382         if (stream->fd != -1) {
383 #if defined(DO_SSL)
384                 if (stream->ssl) {
385                         int res;
386
387                         /*
388                          * According to the TLS standard, it is acceptable for an
389                          * application to only send its shutdown alert and then
390                          * close the underlying connection without waiting for
391                          * the peer's response (this way resources can be saved,
392                          * as the process can already terminate or serve another
393                          * connection).
394                          */
395                         res = SSL_shutdown(stream->ssl);
396                         if (res < 0) {
397                                 ast_log(LOG_ERROR, "SSL_shutdown() failed: %d\n",
398                                         SSL_get_error(stream->ssl, res));
399                         }
400
401                         if (!stream->ssl->server) {
402                                 /* For client threads, ensure that the error stack is cleared */
403                                 ERR_remove_state(0);
404                         }
405
406                         SSL_free(stream->ssl);
407                         stream->ssl = NULL;
408                 }
409 #endif  /* defined(DO_SSL) */
410
411                 /*
412                  * Issuing shutdown() is necessary here to avoid a race
413                  * condition where the last data written may not appear
414                  * in the TCP stream.  See ASTERISK-23548
415                  */
416                 shutdown(stream->fd, SHUT_RDWR);
417                 if (close(stream->fd)) {
418                         ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
419                 }
420                 stream->fd = -1;
421         }
422         ao2_t_ref(stream, -1, "Closed tcptls stream cookie");
423
424         return 0;
425 }
426
427 /*!
428  * \internal
429  * \brief fopencookie()/funopen() stream destructor function.
430  *
431  * \param cookie Stream control data.
432  *
433  * \return Nothing
434  */
435 static void tcptls_stream_dtor(void *cookie)
436 {
437 #ifdef AST_DEVMODE
438         /* Since the ast_assert below is the only one using stream,
439          * and ast_assert is only available with AST_DEVMODE, we
440          * put this in a conditional to avoid compiler warnings. */
441         struct ast_tcptls_stream *stream = cookie;
442 #endif
443
444         ast_assert(stream->fd == -1);
445 }
446
447 /*!
448  * \internal
449  * \brief fopencookie()/funopen() stream allocation function.
450  *
451  * \retval stream_cookie on success.
452  * \retval NULL on error.
453  */
454 static struct ast_tcptls_stream *tcptls_stream_alloc(void)
455 {
456         struct ast_tcptls_stream *stream;
457
458         stream = ao2_alloc_options(sizeof(*stream), tcptls_stream_dtor,
459                 AO2_ALLOC_OPT_LOCK_NOLOCK);
460         if (stream) {
461                 stream->fd = -1;
462                 stream->timeout = -1;
463         }
464         return stream;
465 }
466
467 /*!
468  * \internal
469  * \brief Open a custom FILE stream for tcptls.
470  *
471  * \param stream Stream cookie control data.
472  * \param ssl SSL state if not NULL.
473  * \param fd Socket file descriptor.
474  * \param timeout ms to wait for an event on fd. -1 if timeout disabled.
475  *
476  * \retval fp on success.
477  * \retval NULL on error.
478  */
479 static FILE *tcptls_stream_fopen(struct ast_tcptls_stream *stream, SSL *ssl, int fd, int timeout)
480 {
481         FILE *fp;
482
483 #if defined(HAVE_FOPENCOOKIE)   /* the glibc/linux interface */
484         static const cookie_io_functions_t cookie_funcs = {
485                 tcptls_stream_read,
486                 tcptls_stream_write,
487                 NULL,
488                 tcptls_stream_close
489         };
490 #endif  /* defined(HAVE_FOPENCOOKIE) */
491
492         if (fd == -1) {
493                 /* Socket not open. */
494                 return NULL;
495         }
496
497         stream->ssl = ssl;
498         stream->fd = fd;
499         stream->timeout = timeout;
500         ao2_t_ref(stream, +1, "Opening tcptls stream cookie");
501
502 #if defined(HAVE_FUNOPEN)       /* the BSD interface */
503         fp = funopen(stream, tcptls_stream_read, tcptls_stream_write, NULL,
504                 tcptls_stream_close);
505 #elif defined(HAVE_FOPENCOOKIE) /* the glibc/linux interface */
506         fp = fopencookie(stream, "w+", cookie_funcs);
507 #else
508         /* could add other methods here */
509         ast_debug(2, "No stream FILE methods attempted!\n");
510         fp = NULL;
511 #endif
512
513         if (!fp) {
514                 stream->fd = -1;
515                 ao2_t_ref(stream, -1, "Failed to open tcptls stream cookie");
516         }
517         return fp;
518 }
519
520 HOOK_T ast_tcptls_server_read(struct ast_tcptls_session_instance *tcptls_session, void *buf, size_t count)
521 {
522         if (!tcptls_session->stream_cookie || tcptls_session->stream_cookie->fd == -1) {
523                 ast_log(LOG_ERROR, "TCP/TLS read called on invalid stream.\n");
524                 errno = EIO;
525                 return -1;
526         }
527
528         return tcptls_stream_read(tcptls_session->stream_cookie, buf, count);
529 }
530
531 HOOK_T ast_tcptls_server_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t count)
532 {
533         if (!tcptls_session->stream_cookie || tcptls_session->stream_cookie->fd == -1) {
534                 ast_log(LOG_ERROR, "TCP/TLS write called on invalid stream.\n");
535                 errno = EIO;
536                 return -1;
537         }
538
539         return tcptls_stream_write(tcptls_session->stream_cookie, buf, count);
540 }
541
542 static void session_instance_destructor(void *obj)
543 {
544         struct ast_tcptls_session_instance *i = obj;
545
546         if (i->stream_cookie) {
547                 ao2_t_ref(i->stream_cookie, -1, "Destroying tcptls session instance");
548                 i->stream_cookie = NULL;
549         }
550         ast_free(i->overflow_buf);
551         ao2_cleanup(i->private_data);
552 }
553
554 /*! \brief
555 * creates a FILE * from the fd passed by the accept thread.
556 * This operation is potentially expensive (certificate verification),
557 * so we do it in the child thread context.
558 *
559 * \note must decrement ref count before returning NULL on error
560 */
561 static void *handle_tcptls_connection(void *data)
562 {
563         struct ast_tcptls_session_instance *tcptls_session = data;
564 #ifdef DO_SSL
565         int (*ssl_setup)(SSL *) = (tcptls_session->client) ? SSL_connect : SSL_accept;
566         int ret;
567         char err[256];
568 #endif
569
570         /* TCP/TLS connections are associated with external protocols, and
571          * should not be allowed to execute 'dangerous' functions. This may
572          * need to be pushed down into the individual protocol handlers, but
573          * this seems like a good general policy.
574          */
575         if (ast_thread_inhibit_escalations()) {
576                 ast_log(LOG_ERROR, "Failed to inhibit privilege escalations; killing connection\n");
577                 ast_tcptls_close_session_file(tcptls_session);
578                 ao2_ref(tcptls_session, -1);
579                 return NULL;
580         }
581
582         tcptls_session->stream_cookie = tcptls_stream_alloc();
583         if (!tcptls_session->stream_cookie) {
584                 ast_tcptls_close_session_file(tcptls_session);
585                 ao2_ref(tcptls_session, -1);
586                 return NULL;
587         }
588
589         /*
590         * open a FILE * as appropriate.
591         */
592         if (!tcptls_session->parent->tls_cfg) {
593                 tcptls_session->f = tcptls_stream_fopen(tcptls_session->stream_cookie, NULL,
594                         tcptls_session->fd, -1);
595                 if (tcptls_session->f) {
596                         if (setvbuf(tcptls_session->f, NULL, _IONBF, 0)) {
597                                 ast_tcptls_close_session_file(tcptls_session);
598                         }
599                 }
600         }
601 #ifdef DO_SSL
602         else if ( (tcptls_session->ssl = SSL_new(tcptls_session->parent->tls_cfg->ssl_ctx)) ) {
603                 SSL_set_fd(tcptls_session->ssl, tcptls_session->fd);
604                 if ((ret = ssl_setup(tcptls_session->ssl)) <= 0) {
605                         ast_log(LOG_ERROR, "Problem setting up ssl connection: %s\n", ERR_error_string(ERR_get_error(), err));
606                 } else if ((tcptls_session->f = tcptls_stream_fopen(tcptls_session->stream_cookie,
607                         tcptls_session->ssl, tcptls_session->fd, -1))) {
608                         if ((tcptls_session->client && !ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_DONT_VERIFY_SERVER))
609                                 || (!tcptls_session->client && ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_VERIFY_CLIENT))) {
610                                 X509 *peer;
611                                 long res;
612                                 peer = SSL_get_peer_certificate(tcptls_session->ssl);
613                                 if (!peer) {
614                                         ast_log(LOG_ERROR, "No peer SSL certificate to verify\n");
615                                         ast_tcptls_close_session_file(tcptls_session);
616                                         ao2_ref(tcptls_session, -1);
617                                         return NULL;
618                                 }
619
620                                 res = SSL_get_verify_result(tcptls_session->ssl);
621                                 if (res != X509_V_OK) {
622                                         ast_log(LOG_ERROR, "Certificate did not verify: %s\n", X509_verify_cert_error_string(res));
623                                         X509_free(peer);
624                                         ast_tcptls_close_session_file(tcptls_session);
625                                         ao2_ref(tcptls_session, -1);
626                                         return NULL;
627                                 }
628                                 if (!ast_test_flag(&tcptls_session->parent->tls_cfg->flags, AST_SSL_IGNORE_COMMON_NAME)) {
629                                         ASN1_STRING *str;
630                                         unsigned char *str2;
631                                         X509_NAME *name = X509_get_subject_name(peer);
632                                         int pos = -1;
633                                         int found = 0;
634
635                                         for (;;) {
636                                                 /* Walk the certificate to check all available "Common Name" */
637                                                 /* XXX Probably should do a gethostbyname on the hostname and compare that as well */
638                                                 pos = X509_NAME_get_index_by_NID(name, NID_commonName, pos);
639                                                 if (pos < 0) {
640                                                         break;
641                                                 }
642                                                 str = X509_NAME_ENTRY_get_data(X509_NAME_get_entry(name, pos));
643                                                 ASN1_STRING_to_UTF8(&str2, str);
644                                                 if (str2) {
645                                                         if (!strcasecmp(tcptls_session->parent->hostname, (char *) str2)) {
646                                                                 found = 1;
647                                                         }
648                                                         ast_debug(3, "SSL Common Name compare s1='%s' s2='%s'\n", tcptls_session->parent->hostname, str2);
649                                                         OPENSSL_free(str2);
650                                                 }
651                                                 if (found) {
652                                                         break;
653                                                 }
654                                         }
655                                         if (!found) {
656                                                 ast_log(LOG_ERROR, "Certificate common name did not match (%s)\n", tcptls_session->parent->hostname);
657                                                 X509_free(peer);
658                                                 ast_tcptls_close_session_file(tcptls_session);
659                                                 ao2_ref(tcptls_session, -1);
660                                                 return NULL;
661                                         }
662                                 }
663                                 X509_free(peer);
664                         }
665                 }
666                 if (!tcptls_session->f) {       /* no success opening descriptor stacking */
667                         SSL_free(tcptls_session->ssl);
668                 }
669         }
670 #endif /* DO_SSL */
671
672         if (!tcptls_session->f) {
673                 ast_tcptls_close_session_file(tcptls_session);
674                 ast_log(LOG_WARNING, "FILE * open failed!\n");
675 #ifndef DO_SSL
676                 if (tcptls_session->parent->tls_cfg) {
677                         ast_log(LOG_ERROR, "Attempted a TLS connection without OpenSSL support. This will not work!\n");
678                 }
679 #endif
680                 ao2_ref(tcptls_session, -1);
681                 return NULL;
682         }
683
684         if (tcptls_session->parent->worker_fn) {
685                 return tcptls_session->parent->worker_fn(tcptls_session);
686         } else {
687                 return tcptls_session;
688         }
689 }
690
691 void *ast_tcptls_server_root(void *data)
692 {
693         struct ast_tcptls_session_args *desc = data;
694         int fd;
695         struct ast_sockaddr addr;
696         struct ast_tcptls_session_instance *tcptls_session;
697         pthread_t launched;
698
699         for (;;) {
700                 int i, flags;
701
702                 if (desc->periodic_fn) {
703                         desc->periodic_fn(desc);
704                 }
705                 i = ast_wait_for_input(desc->accept_fd, desc->poll_timeout);
706                 if (i <= 0) {
707                         continue;
708                 }
709                 fd = ast_accept(desc->accept_fd, &addr);
710                 if (fd < 0) {
711                         if ((errno != EAGAIN) && (errno != EINTR)) {
712                                 ast_log(LOG_ERROR, "Accept failed: %s\n", strerror(errno));
713                         }
714                         continue;
715                 }
716                 tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor);
717                 if (!tcptls_session) {
718                         ast_log(LOG_WARNING, "No memory for new session: %s\n", strerror(errno));
719                         if (close(fd)) {
720                                 ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
721                         }
722                         continue;
723                 }
724
725                 tcptls_session->overflow_buf = ast_str_create(128);
726                 flags = fcntl(fd, F_GETFL);
727                 fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
728                 tcptls_session->fd = fd;
729                 tcptls_session->parent = desc;
730                 ast_sockaddr_copy(&tcptls_session->remote_address, &addr);
731
732                 tcptls_session->client = 0;
733
734                 /* This thread is now the only place that controls the single ref to tcptls_session */
735                 if (ast_pthread_create_detached_background(&launched, NULL, handle_tcptls_connection, tcptls_session)) {
736                         ast_log(LOG_ERROR, "Unable to launch helper thread: %s\n", strerror(errno));
737                         ast_tcptls_close_session_file(tcptls_session);
738                         ao2_ref(tcptls_session, -1);
739                 }
740         }
741         return NULL;
742 }
743
744 static int __ssl_setup(struct ast_tls_config *cfg, int client)
745 {
746 #ifndef DO_SSL
747         cfg->enabled = 0;
748         return 0;
749 #else
750         if (!cfg->enabled) {
751                 return 0;
752         }
753
754         /* Get rid of an old SSL_CTX since we're about to
755          * allocate a new one
756          */
757         if (cfg->ssl_ctx) {
758                 SSL_CTX_free(cfg->ssl_ctx);
759                 cfg->ssl_ctx = NULL;
760         }
761
762         if (client) {
763 #ifndef OPENSSL_NO_SSL2
764                 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV2_CLIENT)) {
765                         cfg->ssl_ctx = SSL_CTX_new(SSLv2_client_method());
766                 } else
767 #endif
768                 if (ast_test_flag(&cfg->flags, AST_SSL_SSLV3_CLIENT)) {
769                         cfg->ssl_ctx = SSL_CTX_new(SSLv3_client_method());
770                 } else if (ast_test_flag(&cfg->flags, AST_SSL_TLSV1_CLIENT)) {
771                         cfg->ssl_ctx = SSL_CTX_new(TLSv1_client_method());
772                 } else {
773                         /* SSLv23_client_method() sends SSLv2, this was the original
774                          * default for ssl clients before the option was given to
775                          * pick what protocol a client should use.  In order not
776                          * to break expected behavior it remains the default. */
777                         cfg->ssl_ctx = SSL_CTX_new(SSLv23_client_method());
778                 }
779         } else {
780                 /* SSLv23_server_method() supports TLSv1, SSLv2, and SSLv3 inbound connections. */
781                 cfg->ssl_ctx = SSL_CTX_new(SSLv23_server_method());
782         }
783
784         if (!cfg->ssl_ctx) {
785                 ast_debug(1, "Sorry, SSL_CTX_new call returned null...\n");
786                 cfg->enabled = 0;
787                 return 0;
788         }
789
790         SSL_CTX_set_verify(cfg->ssl_ctx,
791                 ast_test_flag(&cfg->flags, AST_SSL_VERIFY_CLIENT) ? SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT : SSL_VERIFY_NONE,
792                 NULL);
793
794         if (!ast_strlen_zero(cfg->certfile)) {
795                 char *tmpprivate = ast_strlen_zero(cfg->pvtfile) ? cfg->certfile : cfg->pvtfile;
796                 if (SSL_CTX_use_certificate_chain_file(cfg->ssl_ctx, cfg->certfile) == 0) {
797                         if (!client) {
798                                 /* Clients don't need a certificate, but if its setup we can use it */
799                                 ast_log(LOG_ERROR, "TLS/SSL error loading cert file. <%s>\n", cfg->certfile);
800                                 cfg->enabled = 0;
801                                 SSL_CTX_free(cfg->ssl_ctx);
802                                 cfg->ssl_ctx = NULL;
803                                 return 0;
804                         }
805                 }
806                 if ((SSL_CTX_use_PrivateKey_file(cfg->ssl_ctx, tmpprivate, SSL_FILETYPE_PEM) == 0) || (SSL_CTX_check_private_key(cfg->ssl_ctx) == 0 )) {
807                         if (!client) {
808                                 /* Clients don't need a private key, but if its setup we can use it */
809                                 ast_log(LOG_ERROR, "TLS/SSL error loading private key file. <%s>\n", tmpprivate);
810                                 cfg->enabled = 0;
811                                 SSL_CTX_free(cfg->ssl_ctx);
812                                 cfg->ssl_ctx = NULL;
813                                 return 0;
814                         }
815                 }
816         }
817         if (!ast_strlen_zero(cfg->cipher)) {
818                 if (SSL_CTX_set_cipher_list(cfg->ssl_ctx, cfg->cipher) == 0 ) {
819                         if (!client) {
820                                 ast_log(LOG_ERROR, "TLS/SSL cipher error <%s>\n", cfg->cipher);
821                                 cfg->enabled = 0;
822                                 SSL_CTX_free(cfg->ssl_ctx);
823                                 cfg->ssl_ctx = NULL;
824                                 return 0;
825                         }
826                 }
827         }
828         if (!ast_strlen_zero(cfg->cafile) || !ast_strlen_zero(cfg->capath)) {
829                 if (SSL_CTX_load_verify_locations(cfg->ssl_ctx, S_OR(cfg->cafile, NULL), S_OR(cfg->capath,NULL)) == 0) {
830                         ast_log(LOG_ERROR, "TLS/SSL CA file(%s)/path(%s) error\n", cfg->cafile, cfg->capath);
831                 }
832         }
833
834 #ifdef HAVE_OPENSSL_EC
835
836         if (!ast_strlen_zero(cfg->pvtfile)) {
837                 BIO *bio = BIO_new_file(cfg->pvtfile, "r");
838                 if (bio != NULL) {
839                         DH *dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
840                         if (dh != NULL) {
841                                 if (SSL_CTX_set_tmp_dh(cfg->ssl_ctx, dh)) {
842                                         long options = SSL_OP_CIPHER_SERVER_PREFERENCE | SSL_OP_SINGLE_DH_USE | SSL_OP_SINGLE_ECDH_USE;
843                                         options = SSL_CTX_set_options(cfg->ssl_ctx, options);
844                                         ast_verb(2, "TLS/SSL DH initialized, PFS cipher-suites enabled\n");
845                                 }
846                                 DH_free(dh);
847                         }
848                         BIO_free(bio);
849                 }
850         }
851         #ifndef SSL_CTRL_SET_ECDH_AUTO
852                 #define SSL_CTRL_SET_ECDH_AUTO 94
853         #endif
854         /* SSL_CTX_set_ecdh_auto(cfg->ssl_ctx, on); requires OpenSSL 1.0.2 which wraps: */
855         if (SSL_CTX_ctrl(cfg->ssl_ctx, SSL_CTRL_SET_ECDH_AUTO, 1, NULL)) {
856                 ast_verb(2, "TLS/SSL ECDH initialized (automatic), faster PFS ciphers enabled\n");
857         } else {
858                 /* enables AES-128 ciphers, to get AES-256 use NID_secp384r1 */
859                 EC_KEY *ecdh = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
860                 if (ecdh != NULL) {
861                         if (SSL_CTX_set_tmp_ecdh(cfg->ssl_ctx, ecdh)) {
862                                 ast_verb(2, "TLS/SSL ECDH initialized (secp256r1), faster PFS cipher-suites enabled\n");
863                         }
864                         EC_KEY_free(ecdh);
865                 }
866         }
867
868 #endif /* #ifdef HAVE_OPENSSL_EC */
869
870         ast_verb(2, "TLS/SSL certificate ok\n");        /* We should log which one that is ok. This message doesn't really make sense in production use */
871         return 1;
872 #endif
873 }
874
875 int ast_ssl_setup(struct ast_tls_config *cfg)
876 {
877         return __ssl_setup(cfg, 0);
878 }
879
880 void ast_ssl_teardown(struct ast_tls_config *cfg)
881 {
882 #ifdef DO_SSL
883         if (cfg->ssl_ctx) {
884                 SSL_CTX_free(cfg->ssl_ctx);
885                 cfg->ssl_ctx = NULL;
886         }
887 #endif
888 }
889
890 struct ast_tcptls_session_instance *ast_tcptls_client_start(struct ast_tcptls_session_instance *tcptls_session)
891 {
892         struct ast_tcptls_session_args *desc;
893         int flags;
894
895         if (!(desc = tcptls_session->parent)) {
896                 goto client_start_error;
897         }
898
899         if (ast_connect(desc->accept_fd, &desc->remote_address)) {
900                 ast_log(LOG_ERROR, "Unable to connect %s to %s: %s\n",
901                         desc->name,
902                         ast_sockaddr_stringify(&desc->remote_address),
903                         strerror(errno));
904                 goto client_start_error;
905         }
906
907         flags = fcntl(desc->accept_fd, F_GETFL);
908         fcntl(desc->accept_fd, F_SETFL, flags & ~O_NONBLOCK);
909
910         if (desc->tls_cfg) {
911                 desc->tls_cfg->enabled = 1;
912                 __ssl_setup(desc->tls_cfg, 1);
913         }
914
915         return handle_tcptls_connection(tcptls_session);
916
917 client_start_error:
918         if (desc) {
919                 close(desc->accept_fd);
920                 desc->accept_fd = -1;
921         }
922         ao2_ref(tcptls_session, -1);
923         return NULL;
924
925 }
926
927 struct ast_tcptls_session_instance *ast_tcptls_client_create(struct ast_tcptls_session_args *desc)
928 {
929         int x = 1;
930         struct ast_tcptls_session_instance *tcptls_session = NULL;
931
932         /* Do nothing if nothing has changed */
933         if (!ast_sockaddr_cmp(&desc->old_address, &desc->remote_address)) {
934                 ast_debug(1, "Nothing changed in %s\n", desc->name);
935                 return NULL;
936         }
937
938         /* If we return early, there is no connection */
939         ast_sockaddr_setnull(&desc->old_address);
940
941         if (desc->accept_fd != -1) {
942                 close(desc->accept_fd);
943         }
944
945         desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->remote_address) ?
946                                  AF_INET6 : AF_INET, SOCK_STREAM, IPPROTO_TCP);
947         if (desc->accept_fd < 0) {
948                 ast_log(LOG_ERROR, "Unable to allocate socket for %s: %s\n",
949                         desc->name, strerror(errno));
950                 return NULL;
951         }
952
953         /* if a local address was specified, bind to it so the connection will
954            originate from the desired address */
955         if (!ast_sockaddr_isnull(&desc->local_address)) {
956                 setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
957                 if (ast_bind(desc->accept_fd, &desc->local_address)) {
958                         ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
959                                 desc->name,
960                                 ast_sockaddr_stringify(&desc->local_address),
961                                 strerror(errno));
962                         goto error;
963                 }
964         }
965
966         if (!(tcptls_session = ao2_alloc(sizeof(*tcptls_session), session_instance_destructor))) {
967                 goto error;
968         }
969
970         tcptls_session->overflow_buf = ast_str_create(128);
971         tcptls_session->client = 1;
972         tcptls_session->fd = desc->accept_fd;
973         tcptls_session->parent = desc;
974         tcptls_session->parent->worker_fn = NULL;
975         ast_sockaddr_copy(&tcptls_session->remote_address,
976                           &desc->remote_address);
977
978         /* Set current info */
979         ast_sockaddr_copy(&desc->old_address, &desc->remote_address);
980         return tcptls_session;
981
982 error:
983         close(desc->accept_fd);
984         desc->accept_fd = -1;
985         if (tcptls_session) {
986                 ao2_ref(tcptls_session, -1);
987         }
988         return NULL;
989 }
990
991 void ast_tcptls_server_start(struct ast_tcptls_session_args *desc)
992 {
993         int flags;
994         int x = 1;
995
996         /* Do nothing if nothing has changed */
997         if (!ast_sockaddr_cmp(&desc->old_address, &desc->local_address)) {
998                 ast_debug(1, "Nothing changed in %s\n", desc->name);
999                 return;
1000         }
1001
1002         /* If we return early, there is no one listening */
1003         ast_sockaddr_setnull(&desc->old_address);
1004
1005         /* Shutdown a running server if there is one */
1006         if (desc->master != AST_PTHREADT_NULL) {
1007                 pthread_cancel(desc->master);
1008                 pthread_kill(desc->master, SIGURG);
1009                 pthread_join(desc->master, NULL);
1010         }
1011
1012         if (desc->accept_fd != -1) {
1013                 close(desc->accept_fd);
1014         }
1015
1016         /* If there's no new server, stop here */
1017         if (ast_sockaddr_isnull(&desc->local_address)) {
1018                 ast_debug(2, "Server disabled:  %s\n", desc->name);
1019                 return;
1020         }
1021
1022         desc->accept_fd = socket(ast_sockaddr_is_ipv6(&desc->local_address) ?
1023                                  AF_INET6 : AF_INET, SOCK_STREAM, 0);
1024         if (desc->accept_fd < 0) {
1025                 ast_log(LOG_ERROR, "Unable to allocate socket for %s: %s\n", desc->name, strerror(errno));
1026                 return;
1027         }
1028
1029         setsockopt(desc->accept_fd, SOL_SOCKET, SO_REUSEADDR, &x, sizeof(x));
1030         if (ast_bind(desc->accept_fd, &desc->local_address)) {
1031                 ast_log(LOG_ERROR, "Unable to bind %s to %s: %s\n",
1032                         desc->name,
1033                         ast_sockaddr_stringify(&desc->local_address),
1034                         strerror(errno));
1035                 goto error;
1036         }
1037         if (listen(desc->accept_fd, 10)) {
1038                 ast_log(LOG_ERROR, "Unable to listen for %s!\n", desc->name);
1039                 goto error;
1040         }
1041         flags = fcntl(desc->accept_fd, F_GETFL);
1042         fcntl(desc->accept_fd, F_SETFL, flags | O_NONBLOCK);
1043         if (ast_pthread_create_background(&desc->master, NULL, desc->accept_fn, desc)) {
1044                 ast_log(LOG_ERROR, "Unable to launch thread for %s on %s: %s\n",
1045                         desc->name,
1046                         ast_sockaddr_stringify(&desc->local_address),
1047                         strerror(errno));
1048                 goto error;
1049         }
1050
1051         /* Set current info */
1052         ast_sockaddr_copy(&desc->old_address, &desc->local_address);
1053
1054         return;
1055
1056 error:
1057         close(desc->accept_fd);
1058         desc->accept_fd = -1;
1059 }
1060
1061 void ast_tcptls_close_session_file(struct ast_tcptls_session_instance *tcptls_session)
1062 {
1063         if (tcptls_session->f) {
1064                 fflush(tcptls_session->f);
1065                 if (fclose(tcptls_session->f)) {
1066                         ast_log(LOG_ERROR, "fclose() failed: %s\n", strerror(errno));
1067                 }
1068                 tcptls_session->f = NULL;
1069                 tcptls_session->fd = -1;
1070         } else if (tcptls_session->fd != -1) {
1071                 /*
1072                  * Issuing shutdown() is necessary here to avoid a race
1073                  * condition where the last data written may not appear
1074                  * in the TCP stream.  See ASTERISK-23548
1075                  */
1076                 shutdown(tcptls_session->fd, SHUT_RDWR);
1077                 if (close(tcptls_session->fd)) {
1078                         ast_log(LOG_ERROR, "close() failed: %s\n", strerror(errno));
1079                 }
1080                 tcptls_session->fd = -1;
1081         } else {
1082                 ast_log(LOG_ERROR, "ast_tcptls_close_session_file invoked on session instance without file or file descriptor\n");
1083         }
1084 }
1085
1086 void ast_tcptls_server_stop(struct ast_tcptls_session_args *desc)
1087 {
1088         if (desc->master != AST_PTHREADT_NULL) {
1089                 pthread_cancel(desc->master);
1090                 pthread_kill(desc->master, SIGURG);
1091                 pthread_join(desc->master, NULL);
1092                 desc->master = AST_PTHREADT_NULL;
1093         }
1094         if (desc->accept_fd != -1) {
1095                 close(desc->accept_fd);
1096         }
1097         desc->accept_fd = -1;
1098         ast_debug(2, "Stopped server :: %s\n", desc->name);
1099 }
1100
1101 int ast_tls_read_conf(struct ast_tls_config *tls_cfg, struct ast_tcptls_session_args *tls_desc, const char *varname, const char *value)
1102 {
1103         if (!strcasecmp(varname, "tlsenable") || !strcasecmp(varname, "sslenable")) {
1104                 tls_cfg->enabled = ast_true(value) ? 1 : 0;
1105         } else if (!strcasecmp(varname, "tlscertfile") || !strcasecmp(varname, "sslcert") || !strcasecmp(varname, "tlscert")) {
1106                 ast_free(tls_cfg->certfile);
1107                 tls_cfg->certfile = ast_strdup(value);
1108         } else if (!strcasecmp(varname, "tlsprivatekey") || !strcasecmp(varname, "sslprivatekey")) {
1109                 ast_free(tls_cfg->pvtfile);
1110                 tls_cfg->pvtfile = ast_strdup(value);
1111         } else if (!strcasecmp(varname, "tlscipher") || !strcasecmp(varname, "sslcipher")) {
1112                 ast_free(tls_cfg->cipher);
1113                 tls_cfg->cipher = ast_strdup(value);
1114         } else if (!strcasecmp(varname, "tlscafile")) {
1115                 ast_free(tls_cfg->cafile);
1116                 tls_cfg->cafile = ast_strdup(value);
1117         } else if (!strcasecmp(varname, "tlscapath") || !strcasecmp(varname, "tlscadir")) {
1118                 ast_free(tls_cfg->capath);
1119                 tls_cfg->capath = ast_strdup(value);
1120         } else if (!strcasecmp(varname, "tlsverifyclient")) {
1121                 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_VERIFY_CLIENT);
1122         } else if (!strcasecmp(varname, "tlsdontverifyserver")) {
1123                 ast_set2_flag(&tls_cfg->flags, ast_true(value), AST_SSL_DONT_VERIFY_SERVER);
1124         } else if (!strcasecmp(varname, "tlsbindaddr") || !strcasecmp(varname, "sslbindaddr")) {
1125                 if (ast_parse_arg(value, PARSE_ADDR, &tls_desc->local_address))
1126                         ast_log(LOG_ERROR, "Invalid %s '%s'\n", varname, value);
1127         } else if (!strcasecmp(varname, "tlsclientmethod") || !strcasecmp(varname, "sslclientmethod")) {
1128                 if (!strcasecmp(value, "tlsv1")) {
1129                         ast_set_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
1130                         ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
1131                         ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
1132                 } else if (!strcasecmp(value, "sslv3")) {
1133                         ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
1134                         ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
1135                         ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
1136                 } else if (!strcasecmp(value, "sslv2")) {
1137                         ast_set_flag(&tls_cfg->flags, AST_SSL_SSLV2_CLIENT);
1138                         ast_clear_flag(&tls_cfg->flags, AST_SSL_TLSV1_CLIENT);
1139                         ast_clear_flag(&tls_cfg->flags, AST_SSL_SSLV3_CLIENT);
1140                 }
1141         } else {
1142                 return -1;
1143         }
1144
1145         return 0;
1146 }