res_rtp_asterisk: Fix mapping of pjsip's ICE roles to ours
[asterisk/asterisk.git] / res / res_rtp_asterisk.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  *
22  * \brief Supports RTP and RTCP with Symmetric RTP support for NAT traversal.
23  *
24  * \author Mark Spencer <markster@digium.com>
25  *
26  * \note RTP is defined in RFC 3550.
27  *
28  * \ingroup rtp_engines
29  */
30
31 /*** MODULEINFO
32         <use type="external">pjproject</use>
33         <support_level>core</support_level>
34  ***/
35
36 #include "asterisk.h"
37
38 #include <sys/time.h>
39 #include <signal.h>
40 #include <fcntl.h>
41
42 #ifdef HAVE_OPENSSL_SRTP
43 #include <openssl/ssl.h>
44 #include <openssl/err.h>
45 #include <openssl/bio.h>
46 #endif
47
48 #ifdef HAVE_PJPROJECT
49 #include <pjlib.h>
50 #include <pjlib-util.h>
51 #include <pjnath.h>
52 #include <ifaddrs.h>
53 #endif
54
55 #include "asterisk/options.h"
56 #include "asterisk/stun.h"
57 #include "asterisk/pbx.h"
58 #include "asterisk/frame.h"
59 #include "asterisk/format_cache.h"
60 #include "asterisk/channel.h"
61 #include "asterisk/acl.h"
62 #include "asterisk/config.h"
63 #include "asterisk/lock.h"
64 #include "asterisk/utils.h"
65 #include "asterisk/cli.h"
66 #include "asterisk/manager.h"
67 #include "asterisk/unaligned.h"
68 #include "asterisk/module.h"
69 #include "asterisk/rtp_engine.h"
70 #include "asterisk/smoother.h"
71 #include "asterisk/uuid.h"
72 #include "asterisk/test.h"
73
74 #define MAX_TIMESTAMP_SKEW      640
75
76 #define RTP_SEQ_MOD     (1<<16) /*!< A sequence number can't be more than 16 bits */
77 #define RTCP_DEFAULT_INTERVALMS   5000  /*!< Default milli-seconds between RTCP reports we send */
78 #define RTCP_MIN_INTERVALMS       500   /*!< Min milli-seconds between RTCP reports we send */
79 #define RTCP_MAX_INTERVALMS       60000 /*!< Max milli-seconds between RTCP reports we send */
80
81 #define DEFAULT_RTP_START 5000 /*!< Default port number to start allocating RTP ports from */
82 #define DEFAULT_RTP_END 31000  /*!< Default maximum port number to end allocating RTP ports at */
83
84 #define MINIMUM_RTP_PORT 1024 /*!< Minimum port number to accept */
85 #define MAXIMUM_RTP_PORT 65535 /*!< Maximum port number to accept */
86
87 #define DEFAULT_TURN_PORT 3478
88
89 #define TURN_STATE_WAIT_TIME 2000
90
91 #define RTCP_PT_FUR     192
92 #define RTCP_PT_SR      AST_RTP_RTCP_SR
93 #define RTCP_PT_RR      AST_RTP_RTCP_RR
94 #define RTCP_PT_SDES    202
95 #define RTCP_PT_BYE     203
96 #define RTCP_PT_APP     204
97 /* VP8: RTCP Feedback */
98 #define RTCP_PT_PSFB    206
99
100 #define RTP_MTU         1200
101 #define DTMF_SAMPLE_RATE_MS    8 /*!< DTMF samples per millisecond */
102
103 #define DEFAULT_DTMF_TIMEOUT (150 * (8000 / 1000))      /*!< samples */
104
105 #define ZFONE_PROFILE_ID 0x505a
106
107 #define DEFAULT_LEARNING_MIN_SEQUENTIAL 4
108
109 #define SRTP_MASTER_KEY_LEN 16
110 #define SRTP_MASTER_SALT_LEN 14
111 #define SRTP_MASTER_LEN (SRTP_MASTER_KEY_LEN + SRTP_MASTER_SALT_LEN)
112
113 #define RTP_DTLS_ESTABLISHED -37
114
115 enum strict_rtp_state {
116         STRICT_RTP_OPEN = 0, /*! No RTP packets should be dropped, all sources accepted */
117         STRICT_RTP_LEARN,    /*! Accept next packet as source */
118         STRICT_RTP_CLOSED,   /*! Drop all RTP packets not coming from source that was learned */
119 };
120
121 #define DEFAULT_STRICT_RTP STRICT_RTP_CLOSED
122 #define DEFAULT_ICESUPPORT 1
123
124 extern struct ast_srtp_res *res_srtp;
125 extern struct ast_srtp_policy_res *res_srtp_policy;
126
127 static int dtmftimeout = DEFAULT_DTMF_TIMEOUT;
128
129 static int rtpstart = DEFAULT_RTP_START;                        /*!< First port for RTP sessions (set in rtp.conf) */
130 static int rtpend = DEFAULT_RTP_END;                    /*!< Last port for RTP sessions (set in rtp.conf) */
131 static int rtpdebug;                    /*!< Are we debugging? */
132 static int rtcpdebug;                   /*!< Are we debugging RTCP? */
133 static int rtcpstats;                   /*!< Are we debugging RTCP? */
134 static int rtcpinterval = RTCP_DEFAULT_INTERVALMS; /*!< Time between rtcp reports in millisecs */
135 static struct ast_sockaddr rtpdebugaddr;        /*!< Debug packets to/from this host */
136 static struct ast_sockaddr rtcpdebugaddr;       /*!< Debug RTCP packets to/from this host */
137 static int rtpdebugport;                /*!< Debug only RTP packets from IP or IP+Port if port is > 0 */
138 static int rtcpdebugport;               /*!< Debug only RTCP packets from IP or IP+Port if port is > 0 */
139 #ifdef SO_NO_CHECK
140 static int nochecksums;
141 #endif
142 static int strictrtp = DEFAULT_STRICT_RTP; /*!< Only accept RTP frames from a defined source. If we receive an indication of a changing source, enter learning mode. */
143 static int learning_min_sequential = DEFAULT_LEARNING_MIN_SEQUENTIAL; /*!< Number of sequential RTP frames needed from a single source during learning mode to accept new source. */
144 #ifdef HAVE_PJPROJECT
145 static int icesupport = DEFAULT_ICESUPPORT;
146 static struct sockaddr_in stunaddr;
147 static pj_str_t turnaddr;
148 static int turnport = DEFAULT_TURN_PORT;
149 static pj_str_t turnusername;
150 static pj_str_t turnpassword;
151
152 static struct ast_ha *ice_blacklist = NULL;    /*!< Blacklisted ICE networks */
153 static ast_rwlock_t ice_blacklist_lock = AST_RWLOCK_INIT_VALUE;
154
155 /*! Blacklisted networks for STUN requests */
156 static struct ast_ha *stun_blacklist = NULL;
157 static ast_rwlock_t stun_blacklist_lock = AST_RWLOCK_INIT_VALUE;
158
159
160 /*! \brief Pool factory used by pjlib to allocate memory. */
161 static pj_caching_pool cachingpool;
162
163 /*! \brief Global memory pool for configuration and timers */
164 static pj_pool_t *pool;
165
166 /*! \brief Global timer heap */
167 static pj_timer_heap_t *timer_heap;
168
169 /*! \brief Thread executing the timer heap */
170 static pj_thread_t *timer_thread;
171
172 /*! \brief Used to tell the timer thread to terminate */
173 static int timer_terminate;
174
175 /*! \brief Structure which contains ioqueue thread information */
176 struct ast_rtp_ioqueue_thread {
177         /*! \brief Pool used by the thread */
178         pj_pool_t *pool;
179         /*! \brief The thread handling the queue and timer heap */
180         pj_thread_t *thread;
181         /*! \brief Ioqueue which polls on sockets */
182         pj_ioqueue_t *ioqueue;
183         /*! \brief Timer heap for scheduled items */
184         pj_timer_heap_t *timerheap;
185         /*! \brief Termination request */
186         int terminate;
187         /*! \brief Current number of descriptors being waited on */
188         unsigned int count;
189         /*! \brief Linked list information */
190         AST_LIST_ENTRY(ast_rtp_ioqueue_thread) next;
191 };
192
193 /*! \brief List of ioqueue threads */
194 static AST_LIST_HEAD_STATIC(ioqueues, ast_rtp_ioqueue_thread);
195
196 /*! \brief Structure which contains ICE host candidate mapping information */
197 struct ast_ice_host_candidate {
198         pj_sockaddr local;
199         pj_sockaddr advertised;
200         AST_RWLIST_ENTRY(ast_ice_host_candidate) next;
201 };
202
203 /*! \brief List of ICE host candidate mappings */
204 static AST_RWLIST_HEAD_STATIC(host_candidates, ast_ice_host_candidate);
205
206 #endif
207
208 #define FLAG_3389_WARNING               (1 << 0)
209 #define FLAG_NAT_ACTIVE                 (3 << 1)
210 #define FLAG_NAT_INACTIVE               (0 << 1)
211 #define FLAG_NAT_INACTIVE_NOWARN        (1 << 1)
212 #define FLAG_NEED_MARKER_BIT            (1 << 3)
213 #define FLAG_DTMF_COMPENSATE            (1 << 4)
214
215 #define TRANSPORT_SOCKET_RTP 0
216 #define TRANSPORT_SOCKET_RTCP 1
217 #define TRANSPORT_TURN_RTP 2
218 #define TRANSPORT_TURN_RTCP 3
219
220 /*! \brief RTP learning mode tracking information */
221 struct rtp_learning_info {
222         int max_seq;    /*!< The highest sequence number received */
223         int packets;    /*!< The number of remaining packets before the source is accepted */
224 };
225
226 #ifdef HAVE_OPENSSL_SRTP
227 struct dtls_details {
228         SSL *ssl;         /*!< SSL session */
229         BIO *read_bio;    /*!< Memory buffer for reading */
230         BIO *write_bio;   /*!< Memory buffer for writing */
231         enum ast_rtp_dtls_setup dtls_setup; /*!< Current setup state */
232         enum ast_rtp_dtls_connection connection; /*!< Whether this is a new or existing connection */
233         int timeout_timer; /*!< Scheduler id for timeout timer */
234 };
235 #endif
236
237 #ifdef HAVE_PJPROJECT
238 /*! An ao2 wrapper protecting the PJPROJECT ice structure with ref counting. */
239 struct ice_wrap {
240         pj_ice_sess *real_ice;           /*!< ICE session */
241 };
242 #endif
243
244 /*! \brief Structure used for mapping an incoming SSRC to an RTP instance */
245 struct rtp_ssrc_mapping {
246         /*! \brief The received SSRC */
247         unsigned int ssrc;
248         /*! \brief The RTP instance this SSRC belongs to*/
249         struct ast_rtp_instance *instance;
250 };
251
252 /*! \brief RTP session description */
253 struct ast_rtp {
254         int s;
255         /*! \note The f.subclass.format holds a ref. */
256         struct ast_frame f;
257         unsigned char rawdata[8192 + AST_FRIENDLY_OFFSET];
258         unsigned int ssrc;              /*!< Synchronization source, RFC 3550, page 10. */
259         char cname[AST_UUID_STR_LEN]; /*!< Our local CNAME */
260         unsigned int themssrc;          /*!< Their SSRC */
261         unsigned int rxssrc;
262         unsigned int lastts;
263         unsigned int lastrxts;
264         unsigned int lastividtimestamp;
265         unsigned int lastovidtimestamp;
266         unsigned int lastitexttimestamp;
267         unsigned int lastotexttimestamp;
268         unsigned int lasteventseqn;
269         int lastrxseqno;                /*!< Last received sequence number, from the network */
270         int expectedseqno;              /*!< Next expected sequence number, from the core */
271         unsigned short seedrxseqno;     /*!< What sequence number did they start with?*/
272         unsigned int seedrxts;          /*!< What RTP timestamp did they start with? */
273         unsigned int rxcount;           /*!< How many packets have we received? */
274         unsigned int rxoctetcount;      /*!< How many octets have we received? should be rxcount *160*/
275         unsigned int txcount;           /*!< How many packets have we sent? */
276         unsigned int txoctetcount;      /*!< How many octets have we sent? (txcount*160)*/
277         unsigned int cycles;            /*!< Shifted count of sequence number cycles */
278         double rxjitter;                /*!< Interarrival jitter at the moment in seconds */
279         double rxtransit;               /*!< Relative transit time for previous packet */
280         struct ast_format *lasttxformat;
281         struct ast_format *lastrxformat;
282
283         int rtptimeout;                 /*!< RTP timeout time (negative or zero means disabled, negative value means temporarily disabled) */
284         int rtpholdtimeout;             /*!< RTP timeout when on hold (negative or zero means disabled, negative value means temporarily disabled). */
285         int rtpkeepalive;               /*!< Send RTP comfort noice packets for keepalive */
286
287         /* DTMF Reception Variables */
288         char resp;                        /*!< The current digit being processed */
289         unsigned int last_seqno;          /*!< The last known sequence number for any DTMF packet */
290         unsigned int last_end_timestamp;  /*!< The last known timestamp received from an END packet */
291         unsigned int dtmf_duration;       /*!< Total duration in samples since the digit start event */
292         unsigned int dtmf_timeout;        /*!< When this timestamp is reached we consider END frame lost and forcibly abort digit */
293         unsigned int dtmfsamples;
294         enum ast_rtp_dtmf_mode dtmfmode;  /*!< The current DTMF mode of the RTP stream */
295         /* DTMF Transmission Variables */
296         unsigned int lastdigitts;
297         char sending_digit;     /*!< boolean - are we sending digits */
298         char send_digit;        /*!< digit we are sending */
299         int send_payload;
300         int send_duration;
301         unsigned int flags;
302         struct timeval rxcore;
303         struct timeval txcore;
304         double drxcore;                 /*!< The double representation of the first received packet */
305         struct timeval lastrx;          /*!< timeval when we last received a packet */
306         struct timeval dtmfmute;
307         struct ast_smoother *smoother;
308         int *ioid;
309         unsigned short seqno;           /*!< Sequence number, RFC 3550, page 13. */
310         unsigned short rxseqno;
311         struct ast_sched_context *sched;
312         struct io_context *io;
313         void *data;
314         struct ast_rtcp *rtcp;
315         struct ast_rtp *bridged;        /*!< Who we are Packet bridged to */
316
317         struct ast_rtp_instance *bundled; /*!< The RTP instance we are bundled to */
318         int stream_num; /*!< Stream num for this RTP instance */
319         AST_VECTOR(, struct rtp_ssrc_mapping) ssrc_mapping; /*!< Mappings of SSRC to RTP instances */
320         struct ast_sockaddr bind_address; /*!< Requested bind address for the sockets */
321
322         enum strict_rtp_state strict_rtp_state; /*!< Current state that strict RTP protection is in */
323         struct ast_sockaddr strict_rtp_address;  /*!< Remote address information for strict RTP purposes */
324
325         /*
326          * Learning mode values based on pjmedia's probation mode.  Many of these values are redundant to the above,
327          * but these are in place to keep learning mode sequence values sealed from their normal counterparts.
328          */
329         struct rtp_learning_info rtp_source_learn;      /* Learning mode track for the expected RTP source */
330         struct rtp_learning_info alt_source_learn;      /* Learning mode tracking for a new RTP source after one has been chosen */
331
332         struct rtp_red *red;
333
334 #ifdef HAVE_PJPROJECT
335         ast_cond_t cond;            /*!< ICE/TURN condition for signaling */
336
337         struct ice_wrap *ice;       /*!< ao2 wrapped ICE session */
338         enum ast_rtp_ice_role role; /*!< Our role in ICE negotiation */
339         pj_turn_sock *turn_rtp;     /*!< RTP TURN relay */
340         pj_turn_sock *turn_rtcp;    /*!< RTCP TURN relay */
341         pj_turn_state_t turn_state; /*!< Current state of the TURN relay session */
342         unsigned int passthrough:1; /*!< Bit to indicate that the received packet should be passed through */
343         unsigned int rtp_passthrough:1; /*!< Bit to indicate that TURN RTP should be passed through */
344         unsigned int rtcp_passthrough:1; /*!< Bit to indicate that TURN RTCP should be passed through */
345         unsigned int ice_port;      /*!< Port that ICE was started with if it was previously started */
346         struct ast_sockaddr rtp_loop; /*!< Loopback address for forwarding RTP from TURN */
347         struct ast_sockaddr rtcp_loop; /*!< Loopback address for forwarding RTCP from TURN */
348
349         struct ast_rtp_ioqueue_thread *ioqueue; /*!< The ioqueue thread handling us */
350
351         char remote_ufrag[256];  /*!< The remote ICE username */
352         char remote_passwd[256]; /*!< The remote ICE password */
353
354         char local_ufrag[256];  /*!< The local ICE username */
355         char local_passwd[256]; /*!< The local ICE password */
356
357         struct ao2_container *ice_local_candidates;           /*!< The local ICE candidates */
358         struct ao2_container *ice_active_remote_candidates;   /*!< The remote ICE candidates */
359         struct ao2_container *ice_proposed_remote_candidates; /*!< Incoming remote ICE candidates for new session */
360         struct ast_sockaddr ice_original_rtp_addr;            /*!< rtp address that ICE started on first session */
361         unsigned int ice_num_components; /*!< The number of ICE components */
362 #endif
363
364 #ifdef HAVE_OPENSSL_SRTP
365         SSL_CTX *ssl_ctx; /*!< SSL context */
366         enum ast_rtp_dtls_verify dtls_verify; /*!< What to verify */
367         enum ast_srtp_suite suite;   /*!< SRTP crypto suite */
368         enum ast_rtp_dtls_hash local_hash; /*!< Local hash used for the fingerprint */
369         char local_fingerprint[160]; /*!< Fingerprint of our certificate */
370         enum ast_rtp_dtls_hash remote_hash; /*!< Remote hash used for the fingerprint */
371         unsigned char remote_fingerprint[EVP_MAX_MD_SIZE]; /*!< Fingerprint of the peer certificate */
372         unsigned int rekey; /*!< Interval at which to renegotiate and rekey */
373         int rekeyid; /*!< Scheduled item id for rekeying */
374         struct dtls_details dtls; /*!< DTLS state information */
375 #endif
376 };
377
378 /*!
379  * \brief Structure defining an RTCP session.
380  *
381  * The concept "RTCP session" is not defined in RFC 3550, but since
382  * this structure is analogous to ast_rtp, which tracks a RTP session,
383  * it is logical to think of this as a RTCP session.
384  *
385  * RTCP packet is defined on page 9 of RFC 3550.
386  *
387  */
388 struct ast_rtcp {
389         int rtcp_info;
390         int s;                          /*!< Socket */
391         struct ast_sockaddr us;         /*!< Socket representation of the local endpoint. */
392         struct ast_sockaddr them;       /*!< Socket representation of the remote endpoint. */
393         unsigned int soc;               /*!< What they told us */
394         unsigned int spc;               /*!< What they told us */
395         unsigned int themrxlsr;         /*!< The middle 32 bits of the NTP timestamp in the last received SR*/
396         struct timeval rxlsr;           /*!< Time when we got their last SR */
397         struct timeval txlsr;           /*!< Time when we sent or last SR*/
398         unsigned int expected_prior;    /*!< no. packets in previous interval */
399         unsigned int received_prior;    /*!< no. packets received in previous interval */
400         int schedid;                    /*!< Schedid returned from ast_sched_add() to schedule RTCP-transmissions*/
401         unsigned int rr_count;          /*!< number of RRs we've sent, not including report blocks in SR's */
402         unsigned int sr_count;          /*!< number of SRs we've sent */
403         unsigned int lastsrtxcount;     /*!< Transmit packet count when last SR sent */
404         double accumulated_transit;     /*!< accumulated a-dlsr-lsr */
405         double rtt;                     /*!< Last reported rtt */
406         unsigned int reported_jitter;   /*!< The contents of their last jitter entry in the RR */
407         unsigned int reported_lost;     /*!< Reported lost packets in their RR */
408
409         double reported_maxjitter;
410         double reported_minjitter;
411         double reported_normdev_jitter;
412         double reported_stdev_jitter;
413         unsigned int reported_jitter_count;
414
415         double reported_maxlost;
416         double reported_minlost;
417         double reported_normdev_lost;
418         double reported_stdev_lost;
419
420         double rxlost;
421         double maxrxlost;
422         double minrxlost;
423         double normdev_rxlost;
424         double stdev_rxlost;
425         unsigned int rxlost_count;
426
427         double maxrxjitter;
428         double minrxjitter;
429         double normdev_rxjitter;
430         double stdev_rxjitter;
431         unsigned int rxjitter_count;
432         double maxrtt;
433         double minrtt;
434         double normdevrtt;
435         double stdevrtt;
436         unsigned int rtt_count;
437
438         /* VP8: sequence number for the RTCP FIR FCI */
439         int firseq;
440
441 #ifdef HAVE_OPENSSL_SRTP
442         struct dtls_details dtls; /*!< DTLS state information */
443 #endif
444
445         /* Cached local address string allows us to generate
446          * RTCP stasis messages without having to look up our
447          * own address every time
448          */
449         char *local_addr_str;
450         enum ast_rtp_instance_rtcp type;
451         /* Buffer for frames created during RTCP interpretation */
452         unsigned char frame_buf[512 + AST_FRIENDLY_OFFSET];
453 };
454
455 struct rtp_red {
456         struct ast_frame t140;  /*!< Primary data  */
457         struct ast_frame t140red;   /*!< Redundant t140*/
458         unsigned char pt[AST_RED_MAX_GENERATION];  /*!< Payload types for redundancy data */
459         unsigned char ts[AST_RED_MAX_GENERATION]; /*!< Time stamps */
460         unsigned char len[AST_RED_MAX_GENERATION]; /*!< length of each generation */
461         int num_gen; /*!< Number of generations */
462         int schedid; /*!< Timer id */
463         int ti; /*!< How long to buffer data before send */
464         unsigned char t140red_data[64000];
465         unsigned char buf_data[64000]; /*!< buffered primary data */
466         int hdrlen;
467         long int prev_ts;
468 };
469
470 AST_LIST_HEAD_NOLOCK(frame_list, ast_frame);
471
472 /* Forward Declarations */
473 static int ast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data);
474 static int ast_rtp_destroy(struct ast_rtp_instance *instance);
475 static int ast_rtp_dtmf_begin(struct ast_rtp_instance *instance, char digit);
476 static int ast_rtp_dtmf_end(struct ast_rtp_instance *instance, char digit);
477 static int ast_rtp_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration);
478 static int ast_rtp_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode);
479 static enum ast_rtp_dtmf_mode ast_rtp_dtmf_mode_get(struct ast_rtp_instance *instance);
480 static void ast_rtp_update_source(struct ast_rtp_instance *instance);
481 static void ast_rtp_change_source(struct ast_rtp_instance *instance);
482 static int ast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
483 static struct ast_frame *ast_rtp_read(struct ast_rtp_instance *instance, int rtcp);
484 static void ast_rtp_prop_set(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value);
485 static int ast_rtp_fd(struct ast_rtp_instance *instance, int rtcp);
486 static void ast_rtp_remote_address_set(struct ast_rtp_instance *instance, struct ast_sockaddr *addr);
487 static int rtp_red_init(struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations);
488 static int rtp_red_buffer(struct ast_rtp_instance *instance, struct ast_frame *frame);
489 static int ast_rtp_local_bridge(struct ast_rtp_instance *instance0, struct ast_rtp_instance *instance1);
490 static int ast_rtp_get_stat(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat);
491 static int ast_rtp_dtmf_compatible(struct ast_channel *chan0, struct ast_rtp_instance *instance0, struct ast_channel *chan1, struct ast_rtp_instance *instance1);
492 static void ast_rtp_stun_request(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username);
493 static void ast_rtp_stop(struct ast_rtp_instance *instance);
494 static int ast_rtp_qos_set(struct ast_rtp_instance *instance, int tos, int cos, const char* desc);
495 static int ast_rtp_sendcng(struct ast_rtp_instance *instance, int level);
496 static unsigned int ast_rtp_get_ssrc(struct ast_rtp_instance *instance);
497 static const char *ast_rtp_get_cname(struct ast_rtp_instance *instance);
498 static void ast_rtp_set_remote_ssrc(struct ast_rtp_instance *instance, unsigned int ssrc);
499 static void ast_rtp_set_stream_num(struct ast_rtp_instance *instance, int stream_num);
500 static int ast_rtp_bundle(struct ast_rtp_instance *child, struct ast_rtp_instance *parent);
501
502 #ifdef HAVE_OPENSSL_SRTP
503 static int ast_rtp_activate(struct ast_rtp_instance *instance);
504 static void dtls_srtp_check_pending(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp);
505 static void dtls_srtp_start_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp);
506 static void dtls_srtp_stop_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp);
507 #endif
508
509 static int __rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp, int *via_ice, int use_srtp);
510
511 #ifdef HAVE_PJPROJECT
512 /*! \brief Helper function which clears the ICE host candidate mapping */
513 static void host_candidate_overrides_clear(void)
514 {
515         struct ast_ice_host_candidate *candidate;
516
517         AST_RWLIST_WRLOCK(&host_candidates);
518         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&host_candidates, candidate, next) {
519                 AST_RWLIST_REMOVE_CURRENT(next);
520                 ast_free(candidate);
521         }
522         AST_RWLIST_TRAVERSE_SAFE_END;
523         AST_RWLIST_UNLOCK(&host_candidates);
524 }
525
526 /*! \brief Applies the ICE host candidate mapping */
527 static void host_candidate_overrides_apply(unsigned int count, pj_sockaddr addrs[])
528 {
529         int pos;
530         struct ast_ice_host_candidate *candidate;
531
532         AST_RWLIST_RDLOCK(&host_candidates);
533         for (pos = 0; pos < count; pos++) {
534                 AST_LIST_TRAVERSE(&host_candidates, candidate, next) {
535                         if (!pj_sockaddr_cmp(&candidate->local, &addrs[pos])) {
536                                 pj_sockaddr_copy_addr(&addrs[pos], &candidate->advertised);
537                                 break;
538                         }
539                 }
540         }
541         AST_RWLIST_UNLOCK(&host_candidates);
542 }
543
544 /*! \brief Helper function which updates an ast_sockaddr with the candidate used for the component */
545 static void update_address_with_ice_candidate(pj_ice_sess *ice, enum ast_rtp_ice_component_type component,
546         struct ast_sockaddr *cand_address)
547 {
548         char address[PJ_INET6_ADDRSTRLEN];
549
550         if (component < 1 || !ice->comp[component - 1].valid_check) {
551                 return;
552         }
553
554         ast_sockaddr_parse(cand_address,
555                 pj_sockaddr_print(&ice->comp[component - 1].valid_check->rcand->addr, address,
556                         sizeof(address), 0), 0);
557         ast_sockaddr_set_port(cand_address,
558                 pj_sockaddr_get_port(&ice->comp[component - 1].valid_check->rcand->addr));
559 }
560
561 /*! \brief Destructor for locally created ICE candidates */
562 static void ast_rtp_ice_candidate_destroy(void *obj)
563 {
564         struct ast_rtp_engine_ice_candidate *candidate = obj;
565
566         if (candidate->foundation) {
567                 ast_free(candidate->foundation);
568         }
569
570         if (candidate->transport) {
571                 ast_free(candidate->transport);
572         }
573 }
574
575 /*! \pre instance is locked */
576 static void ast_rtp_ice_set_authentication(struct ast_rtp_instance *instance, const char *ufrag, const char *password)
577 {
578         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
579
580         if (!ast_strlen_zero(ufrag)) {
581                 ast_copy_string(rtp->remote_ufrag, ufrag, sizeof(rtp->remote_ufrag));
582         }
583
584         if (!ast_strlen_zero(password)) {
585                 ast_copy_string(rtp->remote_passwd, password, sizeof(rtp->remote_passwd));
586         }
587 }
588
589 static int ice_candidate_cmp(void *obj, void *arg, int flags)
590 {
591         struct ast_rtp_engine_ice_candidate *candidate1 = obj, *candidate2 = arg;
592
593         if (strcmp(candidate1->foundation, candidate2->foundation) ||
594                         candidate1->id != candidate2->id ||
595                         candidate1->type != candidate2->type ||
596                         ast_sockaddr_cmp(&candidate1->address, &candidate2->address)) {
597                 return 0;
598         }
599
600         return CMP_MATCH | CMP_STOP;
601 }
602
603 /*! \pre instance is locked */
604 static void ast_rtp_ice_add_remote_candidate(struct ast_rtp_instance *instance, const struct ast_rtp_engine_ice_candidate *candidate)
605 {
606         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
607         struct ast_rtp_engine_ice_candidate *remote_candidate;
608
609         /* ICE sessions only support UDP candidates */
610         if (strcasecmp(candidate->transport, "udp")) {
611                 return;
612         }
613
614         if (!rtp->ice_proposed_remote_candidates &&
615                         !(rtp->ice_proposed_remote_candidates = ao2_container_alloc(1, NULL, ice_candidate_cmp))) {
616                 return;
617         }
618
619         /* If this is going to exceed the maximum number of ICE candidates don't even add it */
620         if (ao2_container_count(rtp->ice_proposed_remote_candidates) == PJ_ICE_MAX_CAND) {
621                 return;
622         }
623
624         if (!(remote_candidate = ao2_alloc(sizeof(*remote_candidate), ast_rtp_ice_candidate_destroy))) {
625                 return;
626         }
627
628         remote_candidate->foundation = ast_strdup(candidate->foundation);
629         remote_candidate->id = candidate->id;
630         remote_candidate->transport = ast_strdup(candidate->transport);
631         remote_candidate->priority = candidate->priority;
632         ast_sockaddr_copy(&remote_candidate->address, &candidate->address);
633         ast_sockaddr_copy(&remote_candidate->relay_address, &candidate->relay_address);
634         remote_candidate->type = candidate->type;
635
636         ao2_link(rtp->ice_proposed_remote_candidates, remote_candidate);
637         ao2_ref(remote_candidate, -1);
638 }
639
640 AST_THREADSTORAGE(pj_thread_storage);
641
642 /*! \brief Function used to check if the calling thread is registered with pjlib. If it is not it will be registered. */
643 static void pj_thread_register_check(void)
644 {
645         pj_thread_desc *desc;
646         pj_thread_t *thread;
647
648         if (pj_thread_is_registered() == PJ_TRUE) {
649                 return;
650         }
651
652         desc = ast_threadstorage_get(&pj_thread_storage, sizeof(pj_thread_desc));
653         if (!desc) {
654                 ast_log(LOG_ERROR, "Could not get thread desc from thread-local storage. Expect awful things to occur\n");
655                 return;
656         }
657         pj_bzero(*desc, sizeof(*desc));
658
659         if (pj_thread_register("Asterisk Thread", *desc, &thread) != PJ_SUCCESS) {
660                 ast_log(LOG_ERROR, "Coudln't register thread with PJLIB.\n");
661         }
662         return;
663 }
664
665 static int ice_create(struct ast_rtp_instance *instance, struct ast_sockaddr *addr,
666         int port, int replace);
667
668 /*! \pre instance is locked */
669 static void ast_rtp_ice_stop(struct ast_rtp_instance *instance)
670 {
671         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
672         struct ice_wrap *ice;
673
674         ice = rtp->ice;
675         rtp->ice = NULL;
676         if (ice) {
677                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
678                 ao2_unlock(instance);
679                 ao2_ref(ice, -1);
680                 ao2_lock(instance);
681         }
682 }
683
684 /*!
685  * \brief ao2 ICE wrapper object destructor.
686  *
687  * \param vdoomed Object being destroyed.
688  *
689  * \note The associated struct ast_rtp_instance object must not
690  * be locked when unreffing the object.  Otherwise we could
691  * deadlock trying to destroy the PJPROJECT ICE structure.
692  */
693 static void ice_wrap_dtor(void *vdoomed)
694 {
695         struct ice_wrap *ice = vdoomed;
696
697         if (ice->real_ice) {
698                 pj_thread_register_check();
699
700                 pj_ice_sess_destroy(ice->real_ice);
701         }
702 }
703
704 static void ast2pj_rtp_ice_role(enum ast_rtp_ice_role ast_role, enum pj_ice_sess_role *pj_role)
705 {
706         switch (ast_role) {
707         case AST_RTP_ICE_ROLE_CONTROLLED:
708                 *pj_role = PJ_ICE_SESS_ROLE_CONTROLLED;
709                 break;
710         case AST_RTP_ICE_ROLE_CONTROLLING:
711                 *pj_role = PJ_ICE_SESS_ROLE_CONTROLLING;
712                 break;
713         }
714 }
715
716 static void pj2ast_rtp_ice_role(enum pj_ice_sess_role pj_role, enum ast_rtp_ice_role *ast_role)
717 {
718         switch (pj_role) {
719         case PJ_ICE_SESS_ROLE_CONTROLLED:
720                 *ast_role = AST_RTP_ICE_ROLE_CONTROLLED;
721                 return;
722         case PJ_ICE_SESS_ROLE_CONTROLLING:
723                 *ast_role = AST_RTP_ICE_ROLE_CONTROLLING;
724                 return;
725         case PJ_ICE_SESS_ROLE_UNKNOWN:
726                 /* Don't change anything */
727                 return;
728         default:
729                 /* If we aren't explicitly handling something, it's a bug */
730                 ast_assert(0);
731                 return;
732         }
733 }
734
735 /*! \pre instance is locked */
736 static int ice_reset_session(struct ast_rtp_instance *instance)
737 {
738         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
739         int res;
740
741         ast_debug(3, "Resetting ICE for RTP instance '%p'\n", instance);
742         if (!rtp->ice->real_ice->is_nominating && !rtp->ice->real_ice->is_complete) {
743                 ast_debug(3, "Nevermind. ICE isn't ready for a reset\n");
744                 return 0;
745         }
746
747         ast_debug(3, "Recreating ICE session %s (%d) for RTP instance '%p'\n", ast_sockaddr_stringify(&rtp->ice_original_rtp_addr), rtp->ice_port, instance);
748         res = ice_create(instance, &rtp->ice_original_rtp_addr, rtp->ice_port, 1);
749         if (!res) {
750                 /* Use the current expected role for the ICE session */
751                 enum pj_ice_sess_role role = PJ_ICE_SESS_ROLE_UNKNOWN;
752                 ast2pj_rtp_ice_role(rtp->role, &role);
753                 pj_ice_sess_change_role(rtp->ice->real_ice, role);
754         }
755
756         /* If we only have one component now, and we previously set up TURN for RTCP,
757          * we need to destroy that TURN socket.
758          */
759         if (rtp->ice_num_components == 1 && rtp->turn_rtcp) {
760                 struct timeval wait = ast_tvadd(ast_tvnow(), ast_samp2tv(TURN_STATE_WAIT_TIME, 1000));
761                 struct timespec ts = { .tv_sec = wait.tv_sec, .tv_nsec = wait.tv_usec * 1000, };
762
763                 rtp->turn_state = PJ_TURN_STATE_NULL;
764
765                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
766                 ao2_unlock(instance);
767                 pj_turn_sock_destroy(rtp->turn_rtcp);
768                 ao2_lock(instance);
769                 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
770                         ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
771                 }
772         }
773
774         return res;
775 }
776
777 static int ice_candidates_compare(struct ao2_container *left, struct ao2_container *right)
778 {
779         struct ao2_iterator i;
780         struct ast_rtp_engine_ice_candidate *right_candidate;
781
782         if (ao2_container_count(left) != ao2_container_count(right)) {
783                 return -1;
784         }
785
786         i = ao2_iterator_init(right, 0);
787         while ((right_candidate = ao2_iterator_next(&i))) {
788                 struct ast_rtp_engine_ice_candidate *left_candidate = ao2_find(left, right_candidate, OBJ_POINTER);
789
790                 if (!left_candidate) {
791                         ao2_ref(right_candidate, -1);
792                         ao2_iterator_destroy(&i);
793                         return -1;
794                 }
795
796                 ao2_ref(left_candidate, -1);
797                 ao2_ref(right_candidate, -1);
798         }
799         ao2_iterator_destroy(&i);
800
801         return 0;
802 }
803
804 /*! \pre instance is locked */
805 static void ast_rtp_ice_start(struct ast_rtp_instance *instance)
806 {
807         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
808         pj_str_t ufrag = pj_str(rtp->remote_ufrag), passwd = pj_str(rtp->remote_passwd);
809         pj_ice_sess_cand candidates[PJ_ICE_MAX_CAND];
810         struct ao2_iterator i;
811         struct ast_rtp_engine_ice_candidate *candidate;
812         int cand_cnt = 0, has_rtp = 0, has_rtcp = 0;
813
814         if (!rtp->ice || !rtp->ice_proposed_remote_candidates) {
815                 return;
816         }
817
818         /* Check for equivalence in the lists */
819         if (rtp->ice_active_remote_candidates &&
820                         !ice_candidates_compare(rtp->ice_proposed_remote_candidates, rtp->ice_active_remote_candidates)) {
821                 ast_debug(3, "Proposed == active candidates for RTP instance '%p'\n", instance);
822                 ao2_cleanup(rtp->ice_proposed_remote_candidates);
823                 rtp->ice_proposed_remote_candidates = NULL;
824                 /* If this ICE session is being preserved then go back to the role it currently is */
825                 pj2ast_rtp_ice_role(rtp->ice->real_ice->role, &rtp->role);
826                 return;
827         }
828
829         /* Out with the old, in with the new */
830         ao2_cleanup(rtp->ice_active_remote_candidates);
831         rtp->ice_active_remote_candidates = rtp->ice_proposed_remote_candidates;
832         rtp->ice_proposed_remote_candidates = NULL;
833
834         /* Reset the ICE session. Is this going to work? */
835         if (ice_reset_session(instance)) {
836                 ast_log(LOG_NOTICE, "Failed to create replacement ICE session\n");
837                 return;
838         }
839
840         pj_thread_register_check();
841
842         i = ao2_iterator_init(rtp->ice_active_remote_candidates, 0);
843
844         while ((candidate = ao2_iterator_next(&i)) && (cand_cnt < PJ_ICE_MAX_CAND)) {
845                 pj_str_t address;
846
847                 /* there needs to be at least one rtp and rtcp candidate in the list */
848                 has_rtp |= candidate->id == AST_RTP_ICE_COMPONENT_RTP;
849                 has_rtcp |= candidate->id == AST_RTP_ICE_COMPONENT_RTCP;
850
851                 pj_strdup2(rtp->ice->real_ice->pool, &candidates[cand_cnt].foundation,
852                         candidate->foundation);
853                 candidates[cand_cnt].comp_id = candidate->id;
854                 candidates[cand_cnt].prio = candidate->priority;
855
856                 pj_sockaddr_parse(pj_AF_UNSPEC(), 0, pj_cstr(&address, ast_sockaddr_stringify(&candidate->address)), &candidates[cand_cnt].addr);
857
858                 if (!ast_sockaddr_isnull(&candidate->relay_address)) {
859                         pj_sockaddr_parse(pj_AF_UNSPEC(), 0, pj_cstr(&address, ast_sockaddr_stringify(&candidate->relay_address)), &candidates[cand_cnt].rel_addr);
860                 }
861
862                 if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_HOST) {
863                         candidates[cand_cnt].type = PJ_ICE_CAND_TYPE_HOST;
864                 } else if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_SRFLX) {
865                         candidates[cand_cnt].type = PJ_ICE_CAND_TYPE_SRFLX;
866                 } else if (candidate->type == AST_RTP_ICE_CANDIDATE_TYPE_RELAYED) {
867                         candidates[cand_cnt].type = PJ_ICE_CAND_TYPE_RELAYED;
868                 }
869
870                 if (candidate->id == AST_RTP_ICE_COMPONENT_RTP && rtp->turn_rtp) {
871                         ast_debug(3, "RTP candidate %s (%p)\n", ast_sockaddr_stringify(&candidate->address), instance);
872                         /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
873                         ao2_unlock(instance);
874                         pj_turn_sock_set_perm(rtp->turn_rtp, 1, &candidates[cand_cnt].addr, 1);
875                         ao2_lock(instance);
876                 } else if (candidate->id == AST_RTP_ICE_COMPONENT_RTCP && rtp->turn_rtcp) {
877                         ast_debug(3, "RTCP candidate %s (%p)\n", ast_sockaddr_stringify(&candidate->address), instance);
878                         /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
879                         ao2_unlock(instance);
880                         pj_turn_sock_set_perm(rtp->turn_rtcp, 1, &candidates[cand_cnt].addr, 1);
881                         ao2_lock(instance);
882                 }
883
884                 cand_cnt++;
885                 ao2_ref(candidate, -1);
886         }
887
888         ao2_iterator_destroy(&i);
889
890         if (cand_cnt < ao2_container_count(rtp->ice_active_remote_candidates)) {
891                 ast_log(LOG_WARNING, "Lost %d ICE candidates. Consider increasing PJ_ICE_MAX_CAND in PJSIP (%p)\n",
892                         ao2_container_count(rtp->ice_active_remote_candidates) - cand_cnt, instance);
893         }
894
895         if (!has_rtp) {
896                 ast_log(LOG_WARNING, "No RTP candidates; skipping ICE checklist (%p)\n", instance);
897         }
898
899         /* If we're only dealing with one ICE component, then we don't care about the lack of RTCP candidates */
900         if (!has_rtcp && rtp->ice_num_components > 1) {
901                 ast_log(LOG_WARNING, "No RTCP candidates; skipping ICE checklist (%p)\n", instance);
902         }
903
904         if (rtp->ice && has_rtp && (has_rtcp || rtp->ice_num_components == 1)) {
905                 pj_status_t res;
906                 char reason[80];
907                 struct ice_wrap *ice;
908
909                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
910                 ice = rtp->ice;
911                 ao2_ref(ice, +1);
912                 ao2_unlock(instance);
913                 res = pj_ice_sess_create_check_list(ice->real_ice, &ufrag, &passwd, cand_cnt, &candidates[0]);
914                 if (res == PJ_SUCCESS) {
915                         ast_debug(3, "Successfully created ICE checklist (%p)\n", instance);
916                         ast_test_suite_event_notify("ICECHECKLISTCREATE", "Result: SUCCESS");
917                         pj_ice_sess_start_check(ice->real_ice);
918                         pj_timer_heap_poll(timer_heap, NULL);
919                         ao2_ref(ice, -1);
920                         ao2_lock(instance);
921                         rtp->strict_rtp_state = STRICT_RTP_OPEN;
922                         return;
923                 }
924                 ao2_ref(ice, -1);
925                 ao2_lock(instance);
926
927                 pj_strerror(res, reason, sizeof(reason));
928                 ast_log(LOG_WARNING, "Failed to create ICE session check list: %s (%p)\n", reason, instance);
929         }
930
931         ast_test_suite_event_notify("ICECHECKLISTCREATE", "Result: FAILURE");
932
933         /* even though create check list failed don't stop ice as
934            it might still work */
935         /* however we do need to reset remote candidates since
936            this function may be re-entered */
937         ao2_ref(rtp->ice_active_remote_candidates, -1);
938         rtp->ice_active_remote_candidates = NULL;
939         if (rtp->ice) {
940                 rtp->ice->real_ice->rcand_cnt = rtp->ice->real_ice->clist.count = 0;
941         }
942 }
943
944 /*! \pre instance is locked */
945 static const char *ast_rtp_ice_get_ufrag(struct ast_rtp_instance *instance)
946 {
947         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
948
949         return rtp->local_ufrag;
950 }
951
952 /*! \pre instance is locked */
953 static const char *ast_rtp_ice_get_password(struct ast_rtp_instance *instance)
954 {
955         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
956
957         return rtp->local_passwd;
958 }
959
960 /*! \pre instance is locked */
961 static struct ao2_container *ast_rtp_ice_get_local_candidates(struct ast_rtp_instance *instance)
962 {
963         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
964
965         if (rtp->ice_local_candidates) {
966                 ao2_ref(rtp->ice_local_candidates, +1);
967         }
968
969         return rtp->ice_local_candidates;
970 }
971
972 /*! \pre instance is locked */
973 static void ast_rtp_ice_lite(struct ast_rtp_instance *instance)
974 {
975         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
976
977         if (!rtp->ice) {
978                 return;
979         }
980
981         pj_thread_register_check();
982
983         pj_ice_sess_change_role(rtp->ice->real_ice, PJ_ICE_SESS_ROLE_CONTROLLING);
984 }
985
986 /*! \pre instance is locked */
987 static void ast_rtp_ice_set_role(struct ast_rtp_instance *instance, enum ast_rtp_ice_role role)
988 {
989         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
990
991         ast_debug(3, "Set role to %s (%p)\n",
992                 role == AST_RTP_ICE_ROLE_CONTROLLED ? "CONTROLLED" : "CONTROLLING", instance);
993
994         if (!rtp->ice) {
995                 ast_debug(3, "Set role failed; no ice instance (%p)\n", instance);
996                 return;
997         }
998
999         rtp->role = role;
1000 }
1001
1002 /*! \pre instance is locked */
1003 static void ast_rtp_ice_add_cand(struct ast_rtp_instance *instance, struct ast_rtp *rtp,
1004         unsigned comp_id, unsigned transport_id, pj_ice_cand_type type, pj_uint16_t local_pref,
1005         const pj_sockaddr_t *addr, const pj_sockaddr_t *base_addr, const pj_sockaddr_t *rel_addr,
1006         int addr_len)
1007 {
1008         pj_str_t foundation;
1009         struct ast_rtp_engine_ice_candidate *candidate, *existing;
1010         struct ice_wrap *ice;
1011         char address[PJ_INET6_ADDRSTRLEN];
1012         pj_status_t status;
1013
1014         if (!rtp->ice) {
1015                 return;
1016         }
1017
1018         pj_thread_register_check();
1019
1020         pj_ice_calc_foundation(rtp->ice->real_ice->pool, &foundation, type, addr);
1021
1022         if (!rtp->ice_local_candidates && !(rtp->ice_local_candidates = ao2_container_alloc(1, NULL, ice_candidate_cmp))) {
1023                 return;
1024         }
1025
1026         if (!(candidate = ao2_alloc(sizeof(*candidate), ast_rtp_ice_candidate_destroy))) {
1027                 return;
1028         }
1029
1030         candidate->foundation = ast_strndup(pj_strbuf(&foundation), pj_strlen(&foundation));
1031         candidate->id = comp_id;
1032         candidate->transport = ast_strdup("UDP");
1033
1034         ast_sockaddr_parse(&candidate->address, pj_sockaddr_print(addr, address, sizeof(address), 0), 0);
1035         ast_sockaddr_set_port(&candidate->address, pj_sockaddr_get_port(addr));
1036
1037         if (rel_addr) {
1038                 ast_sockaddr_parse(&candidate->relay_address, pj_sockaddr_print(rel_addr, address, sizeof(address), 0), 0);
1039                 ast_sockaddr_set_port(&candidate->relay_address, pj_sockaddr_get_port(rel_addr));
1040         }
1041
1042         if (type == PJ_ICE_CAND_TYPE_HOST) {
1043                 candidate->type = AST_RTP_ICE_CANDIDATE_TYPE_HOST;
1044         } else if (type == PJ_ICE_CAND_TYPE_SRFLX) {
1045                 candidate->type = AST_RTP_ICE_CANDIDATE_TYPE_SRFLX;
1046         } else if (type == PJ_ICE_CAND_TYPE_RELAYED) {
1047                 candidate->type = AST_RTP_ICE_CANDIDATE_TYPE_RELAYED;
1048         }
1049
1050         if ((existing = ao2_find(rtp->ice_local_candidates, candidate, OBJ_POINTER))) {
1051                 ao2_ref(existing, -1);
1052                 ao2_ref(candidate, -1);
1053                 return;
1054         }
1055
1056         /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1057         ice = rtp->ice;
1058         ao2_ref(ice, +1);
1059         ao2_unlock(instance);
1060         status = pj_ice_sess_add_cand(ice->real_ice, comp_id, transport_id, type, local_pref,
1061                 &foundation, addr, base_addr, rel_addr, addr_len, NULL);
1062         ao2_ref(ice, -1);
1063         ao2_lock(instance);
1064         if (!rtp->ice || status != PJ_SUCCESS) {
1065                 ao2_ref(candidate, -1);
1066                 return;
1067         }
1068
1069         /* By placing the candidate into the ICE session it will have produced the priority, so update the local candidate with it */
1070         candidate->priority = rtp->ice->real_ice->lcand[rtp->ice->real_ice->lcand_cnt - 1].prio;
1071
1072         ao2_link(rtp->ice_local_candidates, candidate);
1073         ao2_ref(candidate, -1);
1074 }
1075
1076 /* PJPROJECT TURN callback */
1077 static void ast_rtp_on_turn_rx_rtp_data(pj_turn_sock *turn_sock, void *pkt, unsigned pkt_len, const pj_sockaddr_t *peer_addr, unsigned addr_len)
1078 {
1079         struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1080         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1081         struct ice_wrap *ice;
1082         pj_status_t status;
1083
1084         ao2_lock(instance);
1085         ice = ao2_bump(rtp->ice);
1086         ao2_unlock(instance);
1087
1088         if (ice) {
1089                 status = pj_ice_sess_on_rx_pkt(ice->real_ice, AST_RTP_ICE_COMPONENT_RTP,
1090                         TRANSPORT_TURN_RTP, pkt, pkt_len, peer_addr, addr_len);
1091                 ao2_ref(ice, -1);
1092                 if (status != PJ_SUCCESS) {
1093                         char buf[100];
1094
1095                         pj_strerror(status, buf, sizeof(buf));
1096                         ast_log(LOG_WARNING, "PJ ICE Rx error status code: %d '%s'.\n",
1097                                 (int)status, buf);
1098                         return;
1099                 }
1100                 if (!rtp->rtp_passthrough) {
1101                         return;
1102                 }
1103                 rtp->rtp_passthrough = 0;
1104         }
1105
1106         ast_sendto(rtp->s, pkt, pkt_len, 0, &rtp->rtp_loop);
1107 }
1108
1109 /* PJPROJECT TURN callback */
1110 static void ast_rtp_on_turn_rtp_state(pj_turn_sock *turn_sock, pj_turn_state_t old_state, pj_turn_state_t new_state)
1111 {
1112         struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1113         struct ast_rtp *rtp;
1114
1115         /* If this is a leftover from an already notified RTP instance just ignore the state change */
1116         if (!instance) {
1117                 return;
1118         }
1119
1120         rtp = ast_rtp_instance_get_data(instance);
1121
1122         ao2_lock(instance);
1123
1124         /* We store the new state so the other thread can actually handle it */
1125         rtp->turn_state = new_state;
1126         ast_cond_signal(&rtp->cond);
1127
1128         if (new_state == PJ_TURN_STATE_DESTROYING) {
1129                 pj_turn_sock_set_user_data(rtp->turn_rtp, NULL);
1130                 rtp->turn_rtp = NULL;
1131         }
1132
1133         ao2_unlock(instance);
1134 }
1135
1136 /* RTP TURN Socket interface declaration */
1137 static pj_turn_sock_cb ast_rtp_turn_rtp_sock_cb = {
1138         .on_rx_data = ast_rtp_on_turn_rx_rtp_data,
1139         .on_state = ast_rtp_on_turn_rtp_state,
1140 };
1141
1142 /* PJPROJECT TURN callback */
1143 static void ast_rtp_on_turn_rx_rtcp_data(pj_turn_sock *turn_sock, void *pkt, unsigned pkt_len, const pj_sockaddr_t *peer_addr, unsigned addr_len)
1144 {
1145         struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1146         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1147         struct ice_wrap *ice;
1148         pj_status_t status;
1149
1150         ao2_lock(instance);
1151         ice = ao2_bump(rtp->ice);
1152         ao2_unlock(instance);
1153
1154         if (ice) {
1155                 status = pj_ice_sess_on_rx_pkt(ice->real_ice, AST_RTP_ICE_COMPONENT_RTCP,
1156                         TRANSPORT_TURN_RTCP, pkt, pkt_len, peer_addr, addr_len);
1157                 ao2_ref(ice, -1);
1158                 if (status != PJ_SUCCESS) {
1159                         char buf[100];
1160
1161                         pj_strerror(status, buf, sizeof(buf));
1162                         ast_log(LOG_WARNING, "PJ ICE Rx error status code: %d '%s'.\n",
1163                                 (int)status, buf);
1164                         return;
1165                 }
1166                 if (!rtp->rtcp_passthrough) {
1167                         return;
1168                 }
1169                 rtp->rtcp_passthrough = 0;
1170         }
1171
1172         ast_sendto(rtp->rtcp->s, pkt, pkt_len, 0, &rtp->rtcp_loop);
1173 }
1174
1175 /* PJPROJECT TURN callback */
1176 static void ast_rtp_on_turn_rtcp_state(pj_turn_sock *turn_sock, pj_turn_state_t old_state, pj_turn_state_t new_state)
1177 {
1178         struct ast_rtp_instance *instance = pj_turn_sock_get_user_data(turn_sock);
1179         struct ast_rtp *rtp;
1180
1181         /* If this is a leftover from an already destroyed RTP instance just ignore the state change */
1182         if (!instance) {
1183                 return;
1184         }
1185
1186         rtp = ast_rtp_instance_get_data(instance);
1187
1188         ao2_lock(instance);
1189
1190         /* We store the new state so the other thread can actually handle it */
1191         rtp->turn_state = new_state;
1192         ast_cond_signal(&rtp->cond);
1193
1194         if (new_state == PJ_TURN_STATE_DESTROYING) {
1195                 pj_turn_sock_set_user_data(rtp->turn_rtcp, NULL);
1196                 rtp->turn_rtcp = NULL;
1197         }
1198
1199         ao2_unlock(instance);
1200 }
1201
1202 /* RTCP TURN Socket interface declaration */
1203 static pj_turn_sock_cb ast_rtp_turn_rtcp_sock_cb = {
1204         .on_rx_data = ast_rtp_on_turn_rx_rtcp_data,
1205         .on_state = ast_rtp_on_turn_rtcp_state,
1206 };
1207
1208 /*! \brief Worker thread for ioqueue and timerheap */
1209 static int ioqueue_worker_thread(void *data)
1210 {
1211         struct ast_rtp_ioqueue_thread *ioqueue = data;
1212
1213         while (!ioqueue->terminate) {
1214                 const pj_time_val delay = {0, 10};
1215
1216                 pj_ioqueue_poll(ioqueue->ioqueue, &delay);
1217
1218                 pj_timer_heap_poll(ioqueue->timerheap, NULL);
1219         }
1220
1221         return 0;
1222 }
1223
1224 /*! \brief Destroyer for ioqueue thread */
1225 static void rtp_ioqueue_thread_destroy(struct ast_rtp_ioqueue_thread *ioqueue)
1226 {
1227         if (ioqueue->thread) {
1228                 ioqueue->terminate = 1;
1229                 pj_thread_join(ioqueue->thread);
1230                 pj_thread_destroy(ioqueue->thread);
1231         }
1232
1233         if (ioqueue->pool) {
1234                 /* This mimics the behavior of pj_pool_safe_release
1235                  * which was introduced in pjproject 2.6.
1236                  */
1237                 pj_pool_t *temp_pool = ioqueue->pool;
1238
1239                 ioqueue->pool = NULL;
1240                 pj_pool_release(temp_pool);
1241         }
1242
1243         ast_free(ioqueue);
1244 }
1245
1246 /*! \brief Removal function for ioqueue thread, determines if it should be terminated and destroyed */
1247 static void rtp_ioqueue_thread_remove(struct ast_rtp_ioqueue_thread *ioqueue)
1248 {
1249         int destroy = 0;
1250
1251         /* If nothing is using this ioqueue thread destroy it */
1252         AST_LIST_LOCK(&ioqueues);
1253         if ((ioqueue->count - 2) == 0) {
1254                 destroy = 1;
1255                 AST_LIST_REMOVE(&ioqueues, ioqueue, next);
1256         }
1257         AST_LIST_UNLOCK(&ioqueues);
1258
1259         if (!destroy) {
1260                 return;
1261         }
1262
1263         rtp_ioqueue_thread_destroy(ioqueue);
1264 }
1265
1266 /*! \brief Finder and allocator for an ioqueue thread */
1267 static struct ast_rtp_ioqueue_thread *rtp_ioqueue_thread_get_or_create(void)
1268 {
1269         struct ast_rtp_ioqueue_thread *ioqueue;
1270         pj_lock_t *lock;
1271
1272         AST_LIST_LOCK(&ioqueues);
1273
1274         /* See if an ioqueue thread exists that can handle more */
1275         AST_LIST_TRAVERSE(&ioqueues, ioqueue, next) {
1276                 if ((ioqueue->count + 2) < PJ_IOQUEUE_MAX_HANDLES) {
1277                         break;
1278                 }
1279         }
1280
1281         /* If we found one bump it up and return it */
1282         if (ioqueue) {
1283                 ioqueue->count += 2;
1284                 goto end;
1285         }
1286
1287         ioqueue = ast_calloc(1, sizeof(*ioqueue));
1288         if (!ioqueue) {
1289                 goto end;
1290         }
1291
1292         ioqueue->pool = pj_pool_create(&cachingpool.factory, "rtp", 512, 512, NULL);
1293
1294         /* We use a timer on the ioqueue thread for TURN so that two threads aren't operating
1295          * on a session at the same time
1296          */
1297         if (pj_timer_heap_create(ioqueue->pool, 4, &ioqueue->timerheap) != PJ_SUCCESS) {
1298                 goto fatal;
1299         }
1300
1301         if (pj_lock_create_recursive_mutex(ioqueue->pool, "rtp%p", &lock) != PJ_SUCCESS) {
1302                 goto fatal;
1303         }
1304
1305         pj_timer_heap_set_lock(ioqueue->timerheap, lock, PJ_TRUE);
1306
1307         if (pj_ioqueue_create(ioqueue->pool, PJ_IOQUEUE_MAX_HANDLES, &ioqueue->ioqueue) != PJ_SUCCESS) {
1308                 goto fatal;
1309         }
1310
1311         if (pj_thread_create(ioqueue->pool, "ice", &ioqueue_worker_thread, ioqueue, 0, 0, &ioqueue->thread) != PJ_SUCCESS) {
1312                 goto fatal;
1313         }
1314
1315         AST_LIST_INSERT_HEAD(&ioqueues, ioqueue, next);
1316
1317         /* Since this is being returned to an active session the count always starts at 2 */
1318         ioqueue->count = 2;
1319
1320         goto end;
1321
1322 fatal:
1323         rtp_ioqueue_thread_destroy(ioqueue);
1324         ioqueue = NULL;
1325
1326 end:
1327         AST_LIST_UNLOCK(&ioqueues);
1328         return ioqueue;
1329 }
1330
1331 /*! \pre instance is locked */
1332 static void ast_rtp_ice_turn_request(struct ast_rtp_instance *instance, enum ast_rtp_ice_component_type component,
1333                 enum ast_transport transport, const char *server, unsigned int port, const char *username, const char *password)
1334 {
1335         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1336         pj_turn_sock **turn_sock;
1337         const pj_turn_sock_cb *turn_cb;
1338         pj_turn_tp_type conn_type;
1339         int conn_transport;
1340         pj_stun_auth_cred cred = { 0, };
1341         pj_str_t turn_addr;
1342         struct ast_sockaddr addr = { { 0, } };
1343         pj_stun_config stun_config;
1344         struct timeval wait = ast_tvadd(ast_tvnow(), ast_samp2tv(TURN_STATE_WAIT_TIME, 1000));
1345         struct timespec ts = { .tv_sec = wait.tv_sec, .tv_nsec = wait.tv_usec * 1000, };
1346         pj_turn_session_info info;
1347         struct ast_sockaddr local, loop;
1348         pj_status_t status;
1349         pj_turn_sock_cfg turn_sock_cfg;
1350         struct ice_wrap *ice;
1351
1352         ast_rtp_instance_get_local_address(instance, &local);
1353         if (ast_sockaddr_is_ipv4(&local)) {
1354                 ast_sockaddr_parse(&loop, "127.0.0.1", PARSE_PORT_FORBID);
1355         } else {
1356                 ast_sockaddr_parse(&loop, "::1", PARSE_PORT_FORBID);
1357         }
1358
1359         /* Determine what component we are requesting a TURN session for */
1360         if (component == AST_RTP_ICE_COMPONENT_RTP) {
1361                 turn_sock = &rtp->turn_rtp;
1362                 turn_cb = &ast_rtp_turn_rtp_sock_cb;
1363                 conn_transport = TRANSPORT_TURN_RTP;
1364                 ast_sockaddr_set_port(&loop, ast_sockaddr_port(&local));
1365         } else if (component == AST_RTP_ICE_COMPONENT_RTCP) {
1366                 turn_sock = &rtp->turn_rtcp;
1367                 turn_cb = &ast_rtp_turn_rtcp_sock_cb;
1368                 conn_transport = TRANSPORT_TURN_RTCP;
1369                 ast_sockaddr_set_port(&loop, ast_sockaddr_port(&rtp->rtcp->us));
1370         } else {
1371                 return;
1372         }
1373
1374         if (transport == AST_TRANSPORT_UDP) {
1375                 conn_type = PJ_TURN_TP_UDP;
1376         } else if (transport == AST_TRANSPORT_TCP) {
1377                 conn_type = PJ_TURN_TP_TCP;
1378         } else {
1379                 ast_assert(0);
1380                 return;
1381         }
1382
1383         ast_sockaddr_parse(&addr, server, PARSE_PORT_FORBID);
1384
1385         if (*turn_sock) {
1386                 rtp->turn_state = PJ_TURN_STATE_NULL;
1387
1388                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1389                 ao2_unlock(instance);
1390                 pj_turn_sock_destroy(*turn_sock);
1391                 ao2_lock(instance);
1392                 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
1393                         ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
1394                 }
1395         }
1396
1397         if (component == AST_RTP_ICE_COMPONENT_RTP && !rtp->ioqueue) {
1398                 /*
1399                  * We cannot hold the instance lock because we could wait
1400                  * for the ioqueue thread to die and we might deadlock as
1401                  * a result.
1402                  */
1403                 ao2_unlock(instance);
1404                 rtp->ioqueue = rtp_ioqueue_thread_get_or_create();
1405                 ao2_lock(instance);
1406                 if (!rtp->ioqueue) {
1407                         return;
1408                 }
1409         }
1410
1411         pj_stun_config_init(&stun_config, &cachingpool.factory, 0, rtp->ioqueue->ioqueue, rtp->ioqueue->timerheap);
1412
1413         /* Use ICE session group lock for TURN session to avoid deadlock */
1414         pj_turn_sock_cfg_default(&turn_sock_cfg);
1415         ice = rtp->ice;
1416         if (ice) {
1417                 turn_sock_cfg.grp_lock = ice->real_ice->grp_lock;
1418                 ao2_ref(ice, +1);
1419         }
1420
1421         /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
1422         ao2_unlock(instance);
1423         status = pj_turn_sock_create(&stun_config,
1424                 ast_sockaddr_is_ipv4(&addr) ? pj_AF_INET() : pj_AF_INET6(), conn_type,
1425                 turn_cb, &turn_sock_cfg, instance, turn_sock);
1426         ao2_cleanup(ice);
1427         if (status != PJ_SUCCESS) {
1428                 ast_log(LOG_WARNING, "Could not create a TURN client socket\n");
1429                 ao2_lock(instance);
1430                 return;
1431         }
1432
1433         cred.type = PJ_STUN_AUTH_CRED_STATIC;
1434         pj_strset2(&cred.data.static_cred.username, (char*)username);
1435         cred.data.static_cred.data_type = PJ_STUN_PASSWD_PLAIN;
1436         pj_strset2(&cred.data.static_cred.data, (char*)password);
1437
1438         pj_turn_sock_alloc(*turn_sock, pj_cstr(&turn_addr, server), port, NULL, &cred, NULL);
1439         ao2_lock(instance);
1440
1441         /*
1442          * Because the TURN socket is asynchronous and we are synchronous we need to
1443          * wait until it is done
1444          */
1445         while (rtp->turn_state < PJ_TURN_STATE_READY) {
1446                 ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
1447         }
1448
1449         /* If a TURN session was allocated add it as a candidate */
1450         if (rtp->turn_state != PJ_TURN_STATE_READY) {
1451                 return;
1452         }
1453
1454         pj_turn_sock_get_info(*turn_sock, &info);
1455
1456         ast_rtp_ice_add_cand(instance, rtp, component, conn_transport,
1457                 PJ_ICE_CAND_TYPE_RELAYED, 65535, &info.relay_addr, &info.relay_addr,
1458                 &info.mapped_addr, pj_sockaddr_get_len(&info.relay_addr));
1459
1460         if (component == AST_RTP_ICE_COMPONENT_RTP) {
1461                 ast_sockaddr_copy(&rtp->rtp_loop, &loop);
1462         } else if (component == AST_RTP_ICE_COMPONENT_RTCP) {
1463                 ast_sockaddr_copy(&rtp->rtcp_loop, &loop);
1464         }
1465 }
1466
1467 static char *generate_random_string(char *buf, size_t size)
1468 {
1469         long val[4];
1470         int x;
1471
1472         for (x=0; x<4; x++) {
1473                 val[x] = ast_random();
1474         }
1475         snprintf(buf, size, "%08lx%08lx%08lx%08lx", (long unsigned)val[0], (long unsigned)val[1], (long unsigned)val[2], (long unsigned)val[3]);
1476
1477         return buf;
1478 }
1479
1480 /*! \pre instance is locked */
1481 static void ast_rtp_ice_change_components(struct ast_rtp_instance *instance, int num_components)
1482 {
1483         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1484
1485         /* Don't do anything if ICE is unsupported or if we're not changing the
1486          * number of components
1487          */
1488         if (!icesupport || !rtp->ice || rtp->ice_num_components == num_components) {
1489                 return;
1490         }
1491
1492         rtp->ice_num_components = num_components;
1493         ice_reset_session(instance);
1494 }
1495
1496 /* ICE RTP Engine interface declaration */
1497 static struct ast_rtp_engine_ice ast_rtp_ice = {
1498         .set_authentication = ast_rtp_ice_set_authentication,
1499         .add_remote_candidate = ast_rtp_ice_add_remote_candidate,
1500         .start = ast_rtp_ice_start,
1501         .stop = ast_rtp_ice_stop,
1502         .get_ufrag = ast_rtp_ice_get_ufrag,
1503         .get_password = ast_rtp_ice_get_password,
1504         .get_local_candidates = ast_rtp_ice_get_local_candidates,
1505         .ice_lite = ast_rtp_ice_lite,
1506         .set_role = ast_rtp_ice_set_role,
1507         .turn_request = ast_rtp_ice_turn_request,
1508         .change_components = ast_rtp_ice_change_components,
1509 };
1510 #endif
1511
1512 #ifdef HAVE_OPENSSL_SRTP
1513 static int dtls_verify_callback(int preverify_ok, X509_STORE_CTX *ctx)
1514 {
1515         /* We don't want to actually verify the certificate so just accept what they have provided */
1516         return 1;
1517 }
1518
1519 static int dtls_details_initialize(struct dtls_details *dtls, SSL_CTX *ssl_ctx,
1520         enum ast_rtp_dtls_setup setup)
1521 {
1522         dtls->dtls_setup = setup;
1523
1524         if (!(dtls->ssl = SSL_new(ssl_ctx))) {
1525                 ast_log(LOG_ERROR, "Failed to allocate memory for SSL\n");
1526                 goto error;
1527         }
1528
1529         if (!(dtls->read_bio = BIO_new(BIO_s_mem()))) {
1530                 ast_log(LOG_ERROR, "Failed to allocate memory for inbound SSL traffic\n");
1531                 goto error;
1532         }
1533         BIO_set_mem_eof_return(dtls->read_bio, -1);
1534
1535         if (!(dtls->write_bio = BIO_new(BIO_s_mem()))) {
1536                 ast_log(LOG_ERROR, "Failed to allocate memory for outbound SSL traffic\n");
1537                 goto error;
1538         }
1539         BIO_set_mem_eof_return(dtls->write_bio, -1);
1540
1541         SSL_set_bio(dtls->ssl, dtls->read_bio, dtls->write_bio);
1542
1543         if (dtls->dtls_setup == AST_RTP_DTLS_SETUP_PASSIVE) {
1544                 SSL_set_accept_state(dtls->ssl);
1545         } else {
1546                 SSL_set_connect_state(dtls->ssl);
1547         }
1548         dtls->connection = AST_RTP_DTLS_CONNECTION_NEW;
1549
1550         return 0;
1551
1552 error:
1553         if (dtls->read_bio) {
1554                 BIO_free(dtls->read_bio);
1555                 dtls->read_bio = NULL;
1556         }
1557
1558         if (dtls->write_bio) {
1559                 BIO_free(dtls->write_bio);
1560                 dtls->write_bio = NULL;
1561         }
1562
1563         if (dtls->ssl) {
1564                 SSL_free(dtls->ssl);
1565                 dtls->ssl = NULL;
1566         }
1567         return -1;
1568 }
1569
1570 static int dtls_setup_rtcp(struct ast_rtp_instance *instance)
1571 {
1572         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1573
1574         if (!rtp->ssl_ctx || !rtp->rtcp) {
1575                 return 0;
1576         }
1577
1578         return dtls_details_initialize(&rtp->rtcp->dtls, rtp->ssl_ctx, rtp->dtls.dtls_setup);
1579 }
1580
1581 /*! \pre instance is locked */
1582 static int ast_rtp_dtls_set_configuration(struct ast_rtp_instance *instance, const struct ast_rtp_dtls_cfg *dtls_cfg)
1583 {
1584         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1585         int res;
1586 #ifdef HAVE_OPENSSL_EC
1587         EC_KEY *ecdh;
1588 #endif
1589
1590         if (!dtls_cfg->enabled) {
1591                 return 0;
1592         }
1593
1594         if (!ast_rtp_engine_srtp_is_registered()) {
1595                 ast_log(LOG_ERROR, "SRTP support module is not loaded or available. Try loading res_srtp.so.\n");
1596                 return -1;
1597         }
1598
1599         if (rtp->ssl_ctx) {
1600                 return 0;
1601         }
1602
1603 #if OPENSSL_VERSION_NUMBER < 0x10002000L || defined(LIBRESSL_VERSION_NUMBER)
1604         rtp->ssl_ctx = SSL_CTX_new(DTLSv1_method());
1605 #else
1606         rtp->ssl_ctx = SSL_CTX_new(DTLS_method());
1607 #endif
1608         if (!rtp->ssl_ctx) {
1609                 return -1;
1610         }
1611
1612         SSL_CTX_set_read_ahead(rtp->ssl_ctx, 1);
1613
1614 #ifdef HAVE_OPENSSL_EC
1615
1616         if (!ast_strlen_zero(dtls_cfg->pvtfile)) {
1617                 BIO *bio = BIO_new_file(dtls_cfg->pvtfile, "r");
1618                 if (bio != NULL) {
1619                         DH *dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
1620                         if (dh != NULL) {
1621                                 if (SSL_CTX_set_tmp_dh(rtp->ssl_ctx, dh)) {
1622                                         long options = SSL_OP_CIPHER_SERVER_PREFERENCE |
1623                                                 SSL_OP_SINGLE_DH_USE | SSL_OP_SINGLE_ECDH_USE;
1624                                         options = SSL_CTX_set_options(rtp->ssl_ctx, options);
1625                                         ast_verb(2, "DTLS DH initialized, PFS enabled\n");
1626                                 }
1627                                 DH_free(dh);
1628                         }
1629                         BIO_free(bio);
1630                 }
1631         }
1632         /* enables AES-128 ciphers, to get AES-256 use NID_secp384r1 */
1633         ecdh = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
1634         if (ecdh != NULL) {
1635                 if (SSL_CTX_set_tmp_ecdh(rtp->ssl_ctx, ecdh)) {
1636                         #ifndef SSL_CTRL_SET_ECDH_AUTO
1637                                 #define SSL_CTRL_SET_ECDH_AUTO 94
1638                         #endif
1639                         /* SSL_CTX_set_ecdh_auto(rtp->ssl_ctx, on); requires OpenSSL 1.0.2 which wraps: */
1640                         if (SSL_CTX_ctrl(rtp->ssl_ctx, SSL_CTRL_SET_ECDH_AUTO, 1, NULL)) {
1641                                 ast_verb(2, "DTLS ECDH initialized (automatic), faster PFS enabled\n");
1642                         } else {
1643                                 ast_verb(2, "DTLS ECDH initialized (secp256r1), faster PFS enabled\n");
1644                         }
1645                 }
1646                 EC_KEY_free(ecdh);
1647         }
1648
1649 #endif /* #ifdef HAVE_OPENSSL_EC */
1650
1651         rtp->dtls_verify = dtls_cfg->verify;
1652
1653         SSL_CTX_set_verify(rtp->ssl_ctx, (rtp->dtls_verify & AST_RTP_DTLS_VERIFY_FINGERPRINT) || (rtp->dtls_verify & AST_RTP_DTLS_VERIFY_CERTIFICATE) ?
1654                 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT : SSL_VERIFY_NONE, !(rtp->dtls_verify & AST_RTP_DTLS_VERIFY_CERTIFICATE) ?
1655                 dtls_verify_callback : NULL);
1656
1657         if (dtls_cfg->suite == AST_AES_CM_128_HMAC_SHA1_80) {
1658                 SSL_CTX_set_tlsext_use_srtp(rtp->ssl_ctx, "SRTP_AES128_CM_SHA1_80");
1659         } else if (dtls_cfg->suite == AST_AES_CM_128_HMAC_SHA1_32) {
1660                 SSL_CTX_set_tlsext_use_srtp(rtp->ssl_ctx, "SRTP_AES128_CM_SHA1_32");
1661         } else {
1662                 ast_log(LOG_ERROR, "Unsupported suite specified for DTLS-SRTP on RTP instance '%p'\n", instance);
1663                 return -1;
1664         }
1665
1666         rtp->local_hash = dtls_cfg->hash;
1667
1668         if (!ast_strlen_zero(dtls_cfg->certfile)) {
1669                 char *private = ast_strlen_zero(dtls_cfg->pvtfile) ? dtls_cfg->certfile : dtls_cfg->pvtfile;
1670                 BIO *certbio;
1671                 X509 *cert = NULL;
1672                 const EVP_MD *type;
1673                 unsigned int size, i;
1674                 unsigned char fingerprint[EVP_MAX_MD_SIZE];
1675                 char *local_fingerprint = rtp->local_fingerprint;
1676
1677                 if (!SSL_CTX_use_certificate_file(rtp->ssl_ctx, dtls_cfg->certfile, SSL_FILETYPE_PEM)) {
1678                         ast_log(LOG_ERROR, "Specified certificate file '%s' for RTP instance '%p' could not be used\n",
1679                                 dtls_cfg->certfile, instance);
1680                         return -1;
1681                 }
1682
1683                 if (!SSL_CTX_use_PrivateKey_file(rtp->ssl_ctx, private, SSL_FILETYPE_PEM) ||
1684                     !SSL_CTX_check_private_key(rtp->ssl_ctx)) {
1685                         ast_log(LOG_ERROR, "Specified private key file '%s' for RTP instance '%p' could not be used\n",
1686                                 private, instance);
1687                         return -1;
1688                 }
1689
1690                 if (rtp->local_hash == AST_RTP_DTLS_HASH_SHA1) {
1691                         type = EVP_sha1();
1692                 } else if (rtp->local_hash == AST_RTP_DTLS_HASH_SHA256) {
1693                         type = EVP_sha256();
1694                 } else {
1695                         ast_log(LOG_ERROR, "Unsupported fingerprint hash type on RTP instance '%p'\n",
1696                                 instance);
1697                         return -1;
1698                 }
1699
1700                 if (!(certbio = BIO_new(BIO_s_file()))) {
1701                         ast_log(LOG_ERROR, "Failed to allocate memory for certificate fingerprinting on RTP instance '%p'\n",
1702                                 instance);
1703                         return -1;
1704                 }
1705
1706                 if (!BIO_read_filename(certbio, dtls_cfg->certfile) ||
1707                     !(cert = PEM_read_bio_X509(certbio, NULL, 0, NULL)) ||
1708                     !X509_digest(cert, type, fingerprint, &size) ||
1709                     !size) {
1710                         ast_log(LOG_ERROR, "Could not produce fingerprint from certificate '%s' for RTP instance '%p'\n",
1711                                 dtls_cfg->certfile, instance);
1712                         BIO_free_all(certbio);
1713                         if (cert) {
1714                                 X509_free(cert);
1715                         }
1716                         return -1;
1717                 }
1718
1719                 for (i = 0; i < size; i++) {
1720                         sprintf(local_fingerprint, "%02hhX:", fingerprint[i]);
1721                         local_fingerprint += 3;
1722                 }
1723
1724                 *(local_fingerprint-1) = 0;
1725
1726                 BIO_free_all(certbio);
1727                 X509_free(cert);
1728         }
1729
1730         if (!ast_strlen_zero(dtls_cfg->cipher)) {
1731                 if (!SSL_CTX_set_cipher_list(rtp->ssl_ctx, dtls_cfg->cipher)) {
1732                         ast_log(LOG_ERROR, "Invalid cipher specified in cipher list '%s' for RTP instance '%p'\n",
1733                                 dtls_cfg->cipher, instance);
1734                         return -1;
1735                 }
1736         }
1737
1738         if (!ast_strlen_zero(dtls_cfg->cafile) || !ast_strlen_zero(dtls_cfg->capath)) {
1739                 if (!SSL_CTX_load_verify_locations(rtp->ssl_ctx, S_OR(dtls_cfg->cafile, NULL), S_OR(dtls_cfg->capath, NULL))) {
1740                         ast_log(LOG_ERROR, "Invalid certificate authority file '%s' or path '%s' specified for RTP instance '%p'\n",
1741                                 S_OR(dtls_cfg->cafile, ""), S_OR(dtls_cfg->capath, ""), instance);
1742                         return -1;
1743                 }
1744         }
1745
1746         rtp->rekey = dtls_cfg->rekey;
1747         rtp->suite = dtls_cfg->suite;
1748
1749         res = dtls_details_initialize(&rtp->dtls, rtp->ssl_ctx, dtls_cfg->default_setup);
1750         if (!res) {
1751                 dtls_setup_rtcp(instance);
1752         }
1753
1754         return res;
1755 }
1756
1757 /*! \pre instance is locked */
1758 static int ast_rtp_dtls_active(struct ast_rtp_instance *instance)
1759 {
1760         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1761
1762         return !rtp->ssl_ctx ? 0 : 1;
1763 }
1764
1765 /*! \pre instance is locked */
1766 static void ast_rtp_dtls_stop(struct ast_rtp_instance *instance)
1767 {
1768         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1769         SSL *ssl = rtp->dtls.ssl;
1770
1771         ao2_unlock(instance);
1772         dtls_srtp_stop_timeout_timer(instance, rtp, 0);
1773         ao2_lock(instance);
1774
1775         if (rtp->ssl_ctx) {
1776                 SSL_CTX_free(rtp->ssl_ctx);
1777                 rtp->ssl_ctx = NULL;
1778         }
1779
1780         if (rtp->dtls.ssl) {
1781                 SSL_free(rtp->dtls.ssl);
1782                 rtp->dtls.ssl = NULL;
1783         }
1784
1785         if (rtp->rtcp) {
1786                 ao2_unlock(instance);
1787                 dtls_srtp_stop_timeout_timer(instance, rtp, 1);
1788                 ao2_lock(instance);
1789
1790                 if (rtp->rtcp->dtls.ssl) {
1791                         if (rtp->rtcp->dtls.ssl != ssl) {
1792                                 SSL_free(rtp->rtcp->dtls.ssl);
1793                         }
1794                         rtp->rtcp->dtls.ssl = NULL;
1795                 }
1796         }
1797 }
1798
1799 /*! \pre instance is locked */
1800 static void ast_rtp_dtls_reset(struct ast_rtp_instance *instance)
1801 {
1802         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1803
1804         if (SSL_is_init_finished(rtp->dtls.ssl)) {
1805                 SSL_shutdown(rtp->dtls.ssl);
1806                 rtp->dtls.connection = AST_RTP_DTLS_CONNECTION_NEW;
1807         }
1808
1809         if (rtp->rtcp && SSL_is_init_finished(rtp->rtcp->dtls.ssl)) {
1810                 SSL_shutdown(rtp->rtcp->dtls.ssl);
1811                 rtp->rtcp->dtls.connection = AST_RTP_DTLS_CONNECTION_NEW;
1812         }
1813 }
1814
1815 /*! \pre instance is locked */
1816 static enum ast_rtp_dtls_connection ast_rtp_dtls_get_connection(struct ast_rtp_instance *instance)
1817 {
1818         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1819
1820         return rtp->dtls.connection;
1821 }
1822
1823 /*! \pre instance is locked */
1824 static enum ast_rtp_dtls_setup ast_rtp_dtls_get_setup(struct ast_rtp_instance *instance)
1825 {
1826         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1827
1828         return rtp->dtls.dtls_setup;
1829 }
1830
1831 static void dtls_set_setup(enum ast_rtp_dtls_setup *dtls_setup, enum ast_rtp_dtls_setup setup, SSL *ssl)
1832 {
1833         enum ast_rtp_dtls_setup old = *dtls_setup;
1834
1835         switch (setup) {
1836         case AST_RTP_DTLS_SETUP_ACTIVE:
1837                 *dtls_setup = AST_RTP_DTLS_SETUP_PASSIVE;
1838                 break;
1839         case AST_RTP_DTLS_SETUP_PASSIVE:
1840                 *dtls_setup = AST_RTP_DTLS_SETUP_ACTIVE;
1841                 break;
1842         case AST_RTP_DTLS_SETUP_ACTPASS:
1843                 /* We can't respond to an actpass setup with actpass ourselves... so respond with active, as we can initiate connections */
1844                 if (*dtls_setup == AST_RTP_DTLS_SETUP_ACTPASS) {
1845                         *dtls_setup = AST_RTP_DTLS_SETUP_ACTIVE;
1846                 }
1847                 break;
1848         case AST_RTP_DTLS_SETUP_HOLDCONN:
1849                 *dtls_setup = AST_RTP_DTLS_SETUP_HOLDCONN;
1850                 break;
1851         default:
1852                 /* This should never occur... if it does exit early as we don't know what state things are in */
1853                 return;
1854         }
1855
1856         /* If the setup state did not change we go on as if nothing happened */
1857         if (old == *dtls_setup) {
1858                 return;
1859         }
1860
1861         /* If they don't want us to establish a connection wait until later */
1862         if (*dtls_setup == AST_RTP_DTLS_SETUP_HOLDCONN) {
1863                 return;
1864         }
1865
1866         if (*dtls_setup == AST_RTP_DTLS_SETUP_ACTIVE) {
1867                 SSL_set_connect_state(ssl);
1868         } else if (*dtls_setup == AST_RTP_DTLS_SETUP_PASSIVE) {
1869                 SSL_set_accept_state(ssl);
1870         } else {
1871                 return;
1872         }
1873 }
1874
1875 /*! \pre instance is locked */
1876 static void ast_rtp_dtls_set_setup(struct ast_rtp_instance *instance, enum ast_rtp_dtls_setup setup)
1877 {
1878         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1879
1880         if (rtp->dtls.ssl) {
1881                 dtls_set_setup(&rtp->dtls.dtls_setup, setup, rtp->dtls.ssl);
1882         }
1883
1884         if (rtp->rtcp && rtp->rtcp->dtls.ssl) {
1885                 dtls_set_setup(&rtp->rtcp->dtls.dtls_setup, setup, rtp->rtcp->dtls.ssl);
1886         }
1887 }
1888
1889 /*! \pre instance is locked */
1890 static void ast_rtp_dtls_set_fingerprint(struct ast_rtp_instance *instance, enum ast_rtp_dtls_hash hash, const char *fingerprint)
1891 {
1892         char *tmp = ast_strdupa(fingerprint), *value;
1893         int pos = 0;
1894         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1895
1896         if (hash != AST_RTP_DTLS_HASH_SHA1 && hash != AST_RTP_DTLS_HASH_SHA256) {
1897                 return;
1898         }
1899
1900         rtp->remote_hash = hash;
1901
1902         while ((value = strsep(&tmp, ":")) && (pos != (EVP_MAX_MD_SIZE - 1))) {
1903                 sscanf(value, "%02hhx", &rtp->remote_fingerprint[pos++]);
1904         }
1905 }
1906
1907 /*! \pre instance is locked */
1908 static enum ast_rtp_dtls_hash ast_rtp_dtls_get_fingerprint_hash(struct ast_rtp_instance *instance)
1909 {
1910         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1911
1912         return rtp->local_hash;
1913 }
1914
1915 /*! \pre instance is locked */
1916 static const char *ast_rtp_dtls_get_fingerprint(struct ast_rtp_instance *instance)
1917 {
1918         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1919
1920         return rtp->local_fingerprint;
1921 }
1922
1923 /* DTLS RTP Engine interface declaration */
1924 static struct ast_rtp_engine_dtls ast_rtp_dtls = {
1925         .set_configuration = ast_rtp_dtls_set_configuration,
1926         .active = ast_rtp_dtls_active,
1927         .stop = ast_rtp_dtls_stop,
1928         .reset = ast_rtp_dtls_reset,
1929         .get_connection = ast_rtp_dtls_get_connection,
1930         .get_setup = ast_rtp_dtls_get_setup,
1931         .set_setup = ast_rtp_dtls_set_setup,
1932         .set_fingerprint = ast_rtp_dtls_set_fingerprint,
1933         .get_fingerprint_hash = ast_rtp_dtls_get_fingerprint_hash,
1934         .get_fingerprint = ast_rtp_dtls_get_fingerprint,
1935 };
1936
1937 #endif
1938
1939 /* RTP Engine Declaration */
1940 static struct ast_rtp_engine asterisk_rtp_engine = {
1941         .name = "asterisk",
1942         .new = ast_rtp_new,
1943         .destroy = ast_rtp_destroy,
1944         .dtmf_begin = ast_rtp_dtmf_begin,
1945         .dtmf_end = ast_rtp_dtmf_end,
1946         .dtmf_end_with_duration = ast_rtp_dtmf_end_with_duration,
1947         .dtmf_mode_set = ast_rtp_dtmf_mode_set,
1948         .dtmf_mode_get = ast_rtp_dtmf_mode_get,
1949         .update_source = ast_rtp_update_source,
1950         .change_source = ast_rtp_change_source,
1951         .write = ast_rtp_write,
1952         .read = ast_rtp_read,
1953         .prop_set = ast_rtp_prop_set,
1954         .fd = ast_rtp_fd,
1955         .remote_address_set = ast_rtp_remote_address_set,
1956         .red_init = rtp_red_init,
1957         .red_buffer = rtp_red_buffer,
1958         .local_bridge = ast_rtp_local_bridge,
1959         .get_stat = ast_rtp_get_stat,
1960         .dtmf_compatible = ast_rtp_dtmf_compatible,
1961         .stun_request = ast_rtp_stun_request,
1962         .stop = ast_rtp_stop,
1963         .qos = ast_rtp_qos_set,
1964         .sendcng = ast_rtp_sendcng,
1965 #ifdef HAVE_PJPROJECT
1966         .ice = &ast_rtp_ice,
1967 #endif
1968 #ifdef HAVE_OPENSSL_SRTP
1969         .dtls = &ast_rtp_dtls,
1970         .activate = ast_rtp_activate,
1971 #endif
1972         .ssrc_get = ast_rtp_get_ssrc,
1973         .cname_get = ast_rtp_get_cname,
1974         .set_remote_ssrc = ast_rtp_set_remote_ssrc,
1975         .set_stream_num = ast_rtp_set_stream_num,
1976         .bundle = ast_rtp_bundle,
1977 };
1978
1979 #ifdef HAVE_OPENSSL_SRTP
1980 /*! \pre instance is locked */
1981 static void dtls_perform_handshake(struct ast_rtp_instance *instance, struct dtls_details *dtls, int rtcp)
1982 {
1983         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
1984
1985         /* If we are not acting as a client connecting to the remote side then
1986          * don't start the handshake as it will accomplish nothing and would conflict
1987          * with the handshake we receive from the remote side.
1988          */
1989         if (!dtls->ssl || (dtls->dtls_setup != AST_RTP_DTLS_SETUP_ACTIVE)) {
1990                 return;
1991         }
1992
1993         SSL_do_handshake(dtls->ssl);
1994
1995         /*
1996          * A race condition is prevented between this function and __rtp_recvfrom()
1997          * because both functions have to get the instance lock before they can do
1998          * anything.  Without holding the instance lock, this function could start
1999          * the SSL handshake above in one thread and the __rtp_recvfrom() function
2000          * called by the channel thread could read the response and stop the timeout
2001          * timer before we have a chance to even start it.
2002          */
2003         dtls_srtp_start_timeout_timer(instance, rtp, rtcp);
2004
2005         /*
2006          * We must call dtls_srtp_check_pending() after starting the timer.
2007          * Otherwise we won't prevent the race condition.
2008          */
2009         dtls_srtp_check_pending(instance, rtp, rtcp);
2010 }
2011 #endif
2012
2013 #ifdef HAVE_OPENSSL_SRTP
2014 static void dtls_perform_setup(struct dtls_details *dtls)
2015 {
2016         if (!dtls->ssl || !SSL_is_init_finished(dtls->ssl)) {
2017                 return;
2018         }
2019
2020         SSL_clear(dtls->ssl);
2021         if (dtls->dtls_setup == AST_RTP_DTLS_SETUP_PASSIVE) {
2022                 SSL_set_accept_state(dtls->ssl);
2023         } else {
2024                 SSL_set_connect_state(dtls->ssl);
2025         }
2026         dtls->connection = AST_RTP_DTLS_CONNECTION_NEW;
2027 }
2028 #endif
2029
2030 #ifdef HAVE_PJPROJECT
2031 static void rtp_learning_seq_init(struct rtp_learning_info *info, uint16_t seq);
2032
2033 /* PJPROJECT ICE callback */
2034 static void ast_rtp_on_ice_complete(pj_ice_sess *ice, pj_status_t status)
2035 {
2036         struct ast_rtp_instance *instance = ice->user_data;
2037         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2038
2039         ao2_lock(instance);
2040         if (status == PJ_SUCCESS) {
2041                 struct ast_sockaddr remote_address;
2042
2043                 ast_sockaddr_setnull(&remote_address);
2044                 update_address_with_ice_candidate(ice, AST_RTP_ICE_COMPONENT_RTP, &remote_address);
2045                 if (!ast_sockaddr_isnull(&remote_address)) {
2046                         /* Symmetric RTP must be disabled for the remote address to not get overwritten */
2047                         ast_rtp_instance_set_prop(instance, AST_RTP_PROPERTY_NAT, 0);
2048
2049                         ast_rtp_instance_set_remote_address(instance, &remote_address);
2050                 }
2051
2052                 if (rtp->rtcp) {
2053                         update_address_with_ice_candidate(ice, AST_RTP_ICE_COMPONENT_RTCP, &rtp->rtcp->them);
2054                 }
2055         }
2056
2057 #ifdef HAVE_OPENSSL_SRTP
2058
2059         dtls_perform_setup(&rtp->dtls);
2060         dtls_perform_handshake(instance, &rtp->dtls, 0);
2061
2062         if (rtp->rtcp && rtp->rtcp->type == AST_RTP_INSTANCE_RTCP_STANDARD) {
2063                 dtls_perform_setup(&rtp->rtcp->dtls);
2064                 dtls_perform_handshake(instance, &rtp->rtcp->dtls, 1);
2065         }
2066 #endif
2067
2068         if (!strictrtp) {
2069                 ao2_unlock(instance);
2070                 return;
2071         }
2072
2073         rtp->strict_rtp_state = STRICT_RTP_LEARN;
2074         rtp_learning_seq_init(&rtp->rtp_source_learn, (uint16_t)rtp->seqno);
2075         ao2_unlock(instance);
2076 }
2077
2078 /* PJPROJECT ICE callback */
2079 static void ast_rtp_on_ice_rx_data(pj_ice_sess *ice, unsigned comp_id, unsigned transport_id, void *pkt, pj_size_t size, const pj_sockaddr_t *src_addr, unsigned src_addr_len)
2080 {
2081         struct ast_rtp_instance *instance = ice->user_data;
2082         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2083
2084         /* Instead of handling the packet here (which really doesn't work with our architecture) we set a bit to indicate that it should be handled after pj_ice_sess_on_rx_pkt
2085          * returns */
2086         if (transport_id == TRANSPORT_SOCKET_RTP || transport_id == TRANSPORT_SOCKET_RTCP) {
2087                 rtp->passthrough = 1;
2088         } else if (transport_id == TRANSPORT_TURN_RTP) {
2089                 rtp->rtp_passthrough = 1;
2090         } else if (transport_id == TRANSPORT_TURN_RTCP) {
2091                 rtp->rtcp_passthrough = 1;
2092         }
2093 }
2094
2095 /* PJPROJECT ICE callback */
2096 static pj_status_t ast_rtp_on_ice_tx_pkt(pj_ice_sess *ice, unsigned comp_id, unsigned transport_id, const void *pkt, pj_size_t size, const pj_sockaddr_t *dst_addr, unsigned dst_addr_len)
2097 {
2098         struct ast_rtp_instance *instance = ice->user_data;
2099         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2100         pj_status_t status = PJ_EINVALIDOP;
2101         pj_ssize_t _size = (pj_ssize_t)size;
2102
2103         if (transport_id == TRANSPORT_SOCKET_RTP) {
2104                 /* Traffic is destined to go right out the RTP socket we already have */
2105                 status = pj_sock_sendto(rtp->s, pkt, &_size, 0, dst_addr, dst_addr_len);
2106                 /* sendto on a connectionless socket should send all the data, or none at all */
2107                 ast_assert(_size == size || status != PJ_SUCCESS);
2108         } else if (transport_id == TRANSPORT_SOCKET_RTCP) {
2109                 /* Traffic is destined to go right out the RTCP socket we already have */
2110                 if (rtp->rtcp) {
2111                         status = pj_sock_sendto(rtp->rtcp->s, pkt, &_size, 0, dst_addr, dst_addr_len);
2112                         /* sendto on a connectionless socket should send all the data, or none at all */
2113                         ast_assert(_size == size || status != PJ_SUCCESS);
2114                 } else {
2115                         status = PJ_SUCCESS;
2116                 }
2117         } else if (transport_id == TRANSPORT_TURN_RTP) {
2118                 /* Traffic is going through the RTP TURN relay */
2119                 if (rtp->turn_rtp) {
2120                         status = pj_turn_sock_sendto(rtp->turn_rtp, pkt, size, dst_addr, dst_addr_len);
2121                 }
2122         } else if (transport_id == TRANSPORT_TURN_RTCP) {
2123                 /* Traffic is going through the RTCP TURN relay */
2124                 if (rtp->turn_rtcp) {
2125                         status = pj_turn_sock_sendto(rtp->turn_rtcp, pkt, size, dst_addr, dst_addr_len);
2126                 }
2127         }
2128
2129         return status;
2130 }
2131
2132 /* ICE Session interface declaration */
2133 static pj_ice_sess_cb ast_rtp_ice_sess_cb = {
2134         .on_ice_complete = ast_rtp_on_ice_complete,
2135         .on_rx_data = ast_rtp_on_ice_rx_data,
2136         .on_tx_pkt = ast_rtp_on_ice_tx_pkt,
2137 };
2138
2139 /*! \brief Worker thread for timerheap */
2140 static int timer_worker_thread(void *data)
2141 {
2142         pj_ioqueue_t *ioqueue;
2143
2144         if (pj_ioqueue_create(pool, 1, &ioqueue) != PJ_SUCCESS) {
2145                 return -1;
2146         }
2147
2148         while (!timer_terminate) {
2149                 const pj_time_val delay = {0, 10};
2150
2151                 pj_timer_heap_poll(timer_heap, NULL);
2152                 pj_ioqueue_poll(ioqueue, &delay);
2153         }
2154
2155         return 0;
2156 }
2157 #endif
2158
2159 static inline int rtp_debug_test_addr(struct ast_sockaddr *addr)
2160 {
2161         if (!rtpdebug) {
2162                 return 0;
2163         }
2164         if (!ast_sockaddr_isnull(&rtpdebugaddr)) {
2165                 if (rtpdebugport) {
2166                         return (ast_sockaddr_cmp(&rtpdebugaddr, addr) == 0); /* look for RTP packets from IP+Port */
2167                 } else {
2168                         return (ast_sockaddr_cmp_addr(&rtpdebugaddr, addr) == 0); /* only look for RTP packets from IP */
2169                 }
2170         }
2171
2172         return 1;
2173 }
2174
2175 static inline int rtcp_debug_test_addr(struct ast_sockaddr *addr)
2176 {
2177         if (!rtcpdebug) {
2178                 return 0;
2179         }
2180         if (!ast_sockaddr_isnull(&rtcpdebugaddr)) {
2181                 if (rtcpdebugport) {
2182                         return (ast_sockaddr_cmp(&rtcpdebugaddr, addr) == 0); /* look for RTCP packets from IP+Port */
2183                 } else {
2184                         return (ast_sockaddr_cmp_addr(&rtcpdebugaddr, addr) == 0); /* only look for RTCP packets from IP */
2185                 }
2186         }
2187
2188         return 1;
2189 }
2190
2191 #ifdef HAVE_OPENSSL_SRTP
2192 /*! \pre instance is locked */
2193 static int dtls_srtp_handle_timeout(struct ast_rtp_instance *instance, int rtcp)
2194 {
2195         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2196         struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2197         struct timeval dtls_timeout;
2198
2199         DTLSv1_handle_timeout(dtls->ssl);
2200         dtls_srtp_check_pending(instance, rtp, rtcp);
2201
2202         /* If a timeout can't be retrieved then this recurring scheduled item must stop */
2203         if (!DTLSv1_get_timeout(dtls->ssl, &dtls_timeout)) {
2204                 dtls->timeout_timer = -1;
2205                 return 0;
2206         }
2207
2208         return dtls_timeout.tv_sec * 1000 + dtls_timeout.tv_usec / 1000;
2209 }
2210
2211 /* Scheduler callback */
2212 static int dtls_srtp_handle_rtp_timeout(const void *data)
2213 {
2214         struct ast_rtp_instance *instance = (struct ast_rtp_instance *)data;
2215         int reschedule;
2216
2217         ao2_lock(instance);
2218         reschedule = dtls_srtp_handle_timeout(instance, 0);
2219         ao2_unlock(instance);
2220         if (!reschedule) {
2221                 ao2_ref(instance, -1);
2222         }
2223
2224         return reschedule;
2225 }
2226
2227 /* Scheduler callback */
2228 static int dtls_srtp_handle_rtcp_timeout(const void *data)
2229 {
2230         struct ast_rtp_instance *instance = (struct ast_rtp_instance *)data;
2231         int reschedule;
2232
2233         ao2_lock(instance);
2234         reschedule = dtls_srtp_handle_timeout(instance, 1);
2235         ao2_unlock(instance);
2236         if (!reschedule) {
2237                 ao2_ref(instance, -1);
2238         }
2239
2240         return reschedule;
2241 }
2242
2243 static void dtls_srtp_start_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp)
2244 {
2245         struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2246         struct timeval dtls_timeout;
2247
2248         if (DTLSv1_get_timeout(dtls->ssl, &dtls_timeout)) {
2249                 int timeout = dtls_timeout.tv_sec * 1000 + dtls_timeout.tv_usec / 1000;
2250
2251                 ast_assert(dtls->timeout_timer == -1);
2252
2253                 ao2_ref(instance, +1);
2254                 if ((dtls->timeout_timer = ast_sched_add(rtp->sched, timeout,
2255                         !rtcp ? dtls_srtp_handle_rtp_timeout : dtls_srtp_handle_rtcp_timeout, instance)) < 0) {
2256                         ao2_ref(instance, -1);
2257                         ast_log(LOG_WARNING, "Scheduling '%s' DTLS retransmission for RTP instance [%p] failed.\n",
2258                                 !rtcp ? "RTP" : "RTCP", instance);
2259                 }
2260         }
2261 }
2262
2263 /*! \pre Must not be called with the instance locked. */
2264 static void dtls_srtp_stop_timeout_timer(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp)
2265 {
2266         struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2267
2268         AST_SCHED_DEL_UNREF(rtp->sched, dtls->timeout_timer, ao2_ref(instance, -1));
2269 }
2270
2271 /*! \pre instance is locked */
2272 static void dtls_srtp_check_pending(struct ast_rtp_instance *instance, struct ast_rtp *rtp, int rtcp)
2273 {
2274         struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2275         size_t pending;
2276
2277         if (!dtls->ssl || !dtls->write_bio) {
2278                 return;
2279         }
2280
2281         pending = BIO_ctrl_pending(dtls->write_bio);
2282
2283         if (pending > 0) {
2284                 char outgoing[pending];
2285                 size_t out;
2286                 struct ast_sockaddr remote_address = { {0, } };
2287                 int ice;
2288
2289                 if (!rtcp) {
2290                         ast_rtp_instance_get_remote_address(instance, &remote_address);
2291                 } else {
2292                         ast_sockaddr_copy(&remote_address, &rtp->rtcp->them);
2293                 }
2294
2295                 /* If we do not yet know an address to send this to defer it until we do */
2296                 if (ast_sockaddr_isnull(&remote_address)) {
2297                         return;
2298                 }
2299
2300                 out = BIO_read(dtls->write_bio, outgoing, sizeof(outgoing));
2301                 __rtp_sendto(instance, outgoing, out, 0, &remote_address, rtcp, &ice, 0);
2302         }
2303 }
2304
2305 /* Scheduler callback */
2306 static int dtls_srtp_renegotiate(const void *data)
2307 {
2308         struct ast_rtp_instance *instance = (struct ast_rtp_instance *)data;
2309         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2310
2311         ao2_lock(instance);
2312
2313         SSL_renegotiate(rtp->dtls.ssl);
2314         SSL_do_handshake(rtp->dtls.ssl);
2315         dtls_srtp_check_pending(instance, rtp, 0);
2316
2317         if (rtp->rtcp && rtp->rtcp->dtls.ssl && rtp->rtcp->dtls.ssl != rtp->dtls.ssl) {
2318                 SSL_renegotiate(rtp->rtcp->dtls.ssl);
2319                 SSL_do_handshake(rtp->rtcp->dtls.ssl);
2320                 dtls_srtp_check_pending(instance, rtp, 1);
2321         }
2322
2323         rtp->rekeyid = -1;
2324
2325         ao2_unlock(instance);
2326         ao2_ref(instance, -1);
2327
2328         return 0;
2329 }
2330
2331 static int dtls_srtp_add_local_ssrc(struct ast_rtp *rtp, struct ast_srtp *srtp, struct ast_rtp_instance *instance, int rtcp, unsigned int ssrc, int set_remote_policy)
2332 {
2333         unsigned char material[SRTP_MASTER_LEN * 2];
2334         unsigned char *local_key, *local_salt, *remote_key, *remote_salt;
2335         struct ast_srtp_policy *local_policy, *remote_policy = NULL;
2336         int res = -1;
2337         struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2338
2339         /* Produce key information and set up SRTP */
2340         if (!SSL_export_keying_material(dtls->ssl, material, SRTP_MASTER_LEN * 2, "EXTRACTOR-dtls_srtp", 19, NULL, 0, 0)) {
2341                 ast_log(LOG_WARNING, "Unable to extract SRTP keying material from DTLS-SRTP negotiation on RTP instance '%p'\n",
2342                         instance);
2343                 return -1;
2344         }
2345
2346         /* Whether we are acting as a server or client determines where the keys/salts are */
2347         if (rtp->dtls.dtls_setup == AST_RTP_DTLS_SETUP_ACTIVE) {
2348                 local_key = material;
2349                 remote_key = local_key + SRTP_MASTER_KEY_LEN;
2350                 local_salt = remote_key + SRTP_MASTER_KEY_LEN;
2351                 remote_salt = local_salt + SRTP_MASTER_SALT_LEN;
2352         } else {
2353                 remote_key = material;
2354                 local_key = remote_key + SRTP_MASTER_KEY_LEN;
2355                 remote_salt = local_key + SRTP_MASTER_KEY_LEN;
2356                 local_salt = remote_salt + SRTP_MASTER_SALT_LEN;
2357         }
2358
2359         if (!(local_policy = res_srtp_policy->alloc())) {
2360                 return -1;
2361         }
2362
2363         if (res_srtp_policy->set_master_key(local_policy, local_key, SRTP_MASTER_KEY_LEN, local_salt, SRTP_MASTER_SALT_LEN) < 0) {
2364                 ast_log(LOG_WARNING, "Could not set key/salt information on local policy of '%p' when setting up DTLS-SRTP\n", rtp);
2365                 goto error;
2366         }
2367
2368         if (res_srtp_policy->set_suite(local_policy, rtp->suite)) {
2369                 ast_log(LOG_WARNING, "Could not set suite to '%u' on local policy of '%p' when setting up DTLS-SRTP\n", rtp->suite, rtp);
2370                 goto error;
2371         }
2372
2373         res_srtp_policy->set_ssrc(local_policy, ssrc, 0);
2374
2375         if (set_remote_policy) {
2376                 if (!(remote_policy = res_srtp_policy->alloc())) {
2377                         goto error;
2378                 }
2379
2380                 if (res_srtp_policy->set_master_key(remote_policy, remote_key, SRTP_MASTER_KEY_LEN, remote_salt, SRTP_MASTER_SALT_LEN) < 0) {
2381                         ast_log(LOG_WARNING, "Could not set key/salt information on remote policy of '%p' when setting up DTLS-SRTP\n", rtp);
2382                         goto error;
2383                 }
2384
2385                 if (res_srtp_policy->set_suite(remote_policy, rtp->suite)) {
2386                         ast_log(LOG_WARNING, "Could not set suite to '%u' on remote policy of '%p' when setting up DTLS-SRTP\n", rtp->suite, rtp);
2387                         goto error;
2388                 }
2389
2390                 res_srtp_policy->set_ssrc(remote_policy, 0, 1);
2391         }
2392
2393         if (ast_rtp_instance_add_srtp_policy(instance, remote_policy, local_policy, rtcp)) {
2394                 ast_log(LOG_WARNING, "Could not set policies when setting up DTLS-SRTP on '%p'\n", rtp);
2395                 goto error;
2396         }
2397
2398         res = 0;
2399
2400 error:
2401         /* policy->destroy() called even on success to release local reference to these resources */
2402         res_srtp_policy->destroy(local_policy);
2403
2404         if (remote_policy) {
2405                 res_srtp_policy->destroy(remote_policy);
2406         }
2407
2408         return res;
2409 }
2410
2411 static int dtls_srtp_setup(struct ast_rtp *rtp, struct ast_srtp *srtp, struct ast_rtp_instance *instance, int rtcp)
2412 {
2413         struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2414         int index;
2415
2416         /* If a fingerprint is present in the SDP make sure that the peer certificate matches it */
2417         if (rtp->dtls_verify & AST_RTP_DTLS_VERIFY_FINGERPRINT) {
2418                 X509 *certificate;
2419
2420                 if (!(certificate = SSL_get_peer_certificate(dtls->ssl))) {
2421                         ast_log(LOG_WARNING, "No certificate was provided by the peer on RTP instance '%p'\n", instance);
2422                         return -1;
2423                 }
2424
2425                 /* If a fingerprint is present in the SDP make sure that the peer certificate matches it */
2426                 if (rtp->remote_fingerprint[0]) {
2427                         const EVP_MD *type;
2428                         unsigned char fingerprint[EVP_MAX_MD_SIZE];
2429                         unsigned int size;
2430
2431                         if (rtp->remote_hash == AST_RTP_DTLS_HASH_SHA1) {
2432                                 type = EVP_sha1();
2433                         } else if (rtp->remote_hash == AST_RTP_DTLS_HASH_SHA256) {
2434                                 type = EVP_sha256();
2435                         } else {
2436                                 ast_log(LOG_WARNING, "Unsupported fingerprint hash type on RTP instance '%p'\n", instance);
2437                                 return -1;
2438                         }
2439
2440                         if (!X509_digest(certificate, type, fingerprint, &size) ||
2441                             !size ||
2442                             memcmp(fingerprint, rtp->remote_fingerprint, size)) {
2443                                 X509_free(certificate);
2444                                 ast_log(LOG_WARNING, "Fingerprint provided by remote party does not match that of peer certificate on RTP instance '%p'\n",
2445                                         instance);
2446                                 return -1;
2447                         }
2448                 }
2449
2450                 X509_free(certificate);
2451         }
2452
2453         if (dtls_srtp_add_local_ssrc(rtp, srtp, instance, rtcp, ast_rtp_instance_get_ssrc(instance), 1)) {
2454                 return -1;
2455         }
2456
2457         for (index = 0; index < AST_VECTOR_SIZE(&rtp->ssrc_mapping); ++index) {
2458                 struct rtp_ssrc_mapping *mapping = AST_VECTOR_GET_ADDR(&rtp->ssrc_mapping, index);
2459
2460                 if (dtls_srtp_add_local_ssrc(rtp, srtp, instance, rtcp, ast_rtp_instance_get_ssrc(mapping->instance), 0)) {
2461                         return -1;
2462                 }
2463         }
2464
2465         if (rtp->rekey) {
2466                 ao2_ref(instance, +1);
2467                 if ((rtp->rekeyid = ast_sched_add(rtp->sched, rtp->rekey * 1000, dtls_srtp_renegotiate, instance)) < 0) {
2468                         ao2_ref(instance, -1);
2469                         return -1;
2470                 }
2471         }
2472
2473         return 0;
2474 }
2475 #endif
2476
2477 static int rtcp_mux(struct ast_rtp *rtp, const unsigned char *packet)
2478 {
2479         uint8_t version;
2480         uint8_t pt;
2481         uint8_t m;
2482
2483         if (!rtp->rtcp || rtp->rtcp->type != AST_RTP_INSTANCE_RTCP_MUX) {
2484                 return 0;
2485         }
2486
2487         version = (packet[0] & 0XC0) >> 6;
2488         if (version == 0) {
2489                 /* version 0 indicates this is a STUN packet and shouldn't
2490                  * be interpreted as a possible RTCP packet
2491                  */
2492                 return 0;
2493         }
2494
2495         /* The second octet of a packet will be one of the following:
2496          * For RTP: The marker bit (1 bit) and the RTP payload type (7 bits)
2497          * For RTCP: The payload type (8)
2498          *
2499          * RTP has a forbidden range of payload types (64-95) since these
2500          * will conflict with RTCP payload numbers if the marker bit is set.
2501          */
2502         m = packet[1] & 0x80;
2503         pt = packet[1] & 0x7F;
2504         if (m && pt >= 64 && pt <= 95) {
2505                 return 1;
2506         }
2507         return 0;
2508 }
2509
2510 /*! \pre instance is locked */
2511 static int __rtp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp)
2512 {
2513         int len;
2514         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2515         struct ast_srtp *srtp = ast_rtp_instance_get_srtp(instance, rtcp);
2516         char *in = buf;
2517 #ifdef HAVE_PJPROJECT
2518         struct ast_sockaddr *loop = rtcp ? &rtp->rtcp_loop : &rtp->rtp_loop;
2519 #endif
2520
2521         if ((len = ast_recvfrom(rtcp ? rtp->rtcp->s : rtp->s, buf, size, flags, sa)) < 0) {
2522            return len;
2523         }
2524
2525 #ifdef HAVE_OPENSSL_SRTP
2526         /* If this is an SSL packet pass it to OpenSSL for processing. RFC section for first byte value:
2527          * https://tools.ietf.org/html/rfc5764#section-5.1.2 */
2528         if ((*in >= 20) && (*in <= 63)) {
2529                 struct dtls_details *dtls = !rtcp ? &rtp->dtls : &rtp->rtcp->dtls;
2530                 int res = 0;
2531
2532                 /* If no SSL session actually exists terminate things */
2533                 if (!dtls->ssl) {
2534                         ast_log(LOG_ERROR, "Received SSL traffic on RTP instance '%p' without an SSL session\n",
2535                                 instance);
2536                         return -1;
2537                 }
2538
2539                 /*
2540                  * A race condition is prevented between dtls_perform_handshake()
2541                  * and this function because both functions have to get the
2542                  * instance lock before they can do anything.  The
2543                  * dtls_perform_handshake() function needs to start the timer
2544                  * before we stop it below.
2545                  */
2546
2547                 /* Before we feed data into OpenSSL ensure that the timeout timer is either stopped or completed */
2548                 ao2_unlock(instance);
2549                 dtls_srtp_stop_timeout_timer(instance, rtp, rtcp);
2550                 ao2_lock(instance);
2551
2552                 /* If we don't yet know if we are active or passive and we receive a packet... we are obviously passive */
2553                 if (dtls->dtls_setup == AST_RTP_DTLS_SETUP_ACTPASS) {
2554                         dtls->dtls_setup = AST_RTP_DTLS_SETUP_PASSIVE;
2555                         SSL_set_accept_state(dtls->ssl);
2556                 }
2557
2558                 dtls_srtp_check_pending(instance, rtp, rtcp);
2559
2560                 BIO_write(dtls->read_bio, buf, len);
2561
2562                 len = SSL_read(dtls->ssl, buf, len);
2563
2564                 if ((len < 0) && (SSL_get_error(dtls->ssl, len) == SSL_ERROR_SSL)) {
2565                         unsigned long error = ERR_get_error();
2566                         ast_log(LOG_ERROR, "DTLS failure occurred on RTP instance '%p' due to reason '%s', terminating\n",
2567                                 instance, ERR_reason_error_string(error));
2568                         return -1;
2569                 }
2570
2571                 dtls_srtp_check_pending(instance, rtp, rtcp);
2572
2573                 if (SSL_is_init_finished(dtls->ssl)) {
2574                         /* Any further connections will be existing since this is now established */
2575                         dtls->connection = AST_RTP_DTLS_CONNECTION_EXISTING;
2576                         /* Use the keying material to set up key/salt information */
2577                         if ((res = dtls_srtp_setup(rtp, srtp, instance, rtcp))) {
2578                                 return res;
2579                         }
2580                         /* Notify that dtls has been established */
2581                         res = RTP_DTLS_ESTABLISHED;
2582                 } else {
2583                         /* Since we've sent additional traffic start the timeout timer for retransmission */
2584                         dtls_srtp_start_timeout_timer(instance, rtp, rtcp);
2585                 }
2586
2587                 return res;
2588         }
2589 #endif
2590
2591 #ifdef HAVE_PJPROJECT
2592         if (!ast_sockaddr_isnull(loop) && !ast_sockaddr_cmp(loop, sa)) {
2593                 /* ICE traffic will have been handled in the TURN callback, so skip it but update the address
2594                  * so it reflects the actual source and not the loopback
2595                  */
2596                 if (rtcp) {
2597                         ast_sockaddr_copy(sa, &rtp->rtcp->them);
2598                 } else {
2599                         ast_rtp_instance_get_remote_address(instance, sa);
2600                 }
2601         } else if (rtp->ice) {
2602                 pj_str_t combined = pj_str(ast_sockaddr_stringify(sa));
2603                 pj_sockaddr address;
2604                 pj_status_t status;
2605                 struct ice_wrap *ice;
2606
2607                 pj_thread_register_check();
2608
2609                 pj_sockaddr_parse(pj_AF_UNSPEC(), 0, &combined, &address);
2610
2611                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
2612                 ice = rtp->ice;
2613                 ao2_ref(ice, +1);
2614                 ao2_unlock(instance);
2615                 status = pj_ice_sess_on_rx_pkt(ice->real_ice,
2616                         rtcp ? AST_RTP_ICE_COMPONENT_RTCP : AST_RTP_ICE_COMPONENT_RTP,
2617                         rtcp ? TRANSPORT_SOCKET_RTCP : TRANSPORT_SOCKET_RTP, buf, len, &address,
2618                         pj_sockaddr_get_len(&address));
2619                 ao2_ref(ice, -1);
2620                 ao2_lock(instance);
2621                 if (status != PJ_SUCCESS) {
2622                         char buf[100];
2623
2624                         pj_strerror(status, buf, sizeof(buf));
2625                         ast_log(LOG_WARNING, "PJ ICE Rx error status code: %d '%s'.\n",
2626                                 (int)status, buf);
2627                         return -1;
2628                 }
2629                 if (!rtp->passthrough) {
2630                         /* If a unidirectional ICE negotiation occurs then lock on to the source of the
2631                          * ICE traffic and use it as the target. This will occur if the remote side only
2632                          * wants to receive media but never send to us.
2633                          */
2634                         if (!rtp->ice_active_remote_candidates && !rtp->ice_proposed_remote_candidates) {
2635                                 if (rtcp) {
2636                                         ast_sockaddr_copy(&rtp->rtcp->them, sa);
2637                                 } else {
2638                                         ast_rtp_instance_set_remote_address(instance, sa);
2639                                 }
2640                         }
2641                         return 0;
2642                 }
2643                 rtp->passthrough = 0;
2644         }
2645 #endif
2646
2647         if ((*in & 0xC0) && res_srtp && srtp && res_srtp->unprotect(
2648                     srtp, buf, &len, rtcp || rtcp_mux(rtp, buf)) < 0) {
2649            return -1;
2650         }
2651
2652         return len;
2653 }
2654
2655 /*! \pre instance is locked */
2656 static int rtcp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa)
2657 {
2658         return __rtp_recvfrom(instance, buf, size, flags, sa, 1);
2659 }
2660
2661 /*! \pre instance is locked */
2662 static int rtp_recvfrom(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa)
2663 {
2664         return __rtp_recvfrom(instance, buf, size, flags, sa, 0);
2665 }
2666
2667 /*! \pre instance is locked */
2668 static int __rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int rtcp, int *via_ice, int use_srtp)
2669 {
2670         int len = size;
2671         void *temp = buf;
2672         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2673         struct ast_rtp_instance *transport = rtp->bundled ? rtp->bundled : instance;
2674         struct ast_rtp *transport_rtp = ast_rtp_instance_get_data(transport);
2675         struct ast_srtp *srtp = ast_rtp_instance_get_srtp(transport, rtcp);
2676         int res;
2677
2678         *via_ice = 0;
2679
2680         if (use_srtp && res_srtp && srtp && res_srtp->protect(srtp, &temp, &len, rtcp) < 0) {
2681                 return -1;
2682         }
2683
2684 #ifdef HAVE_PJPROJECT
2685         if (transport_rtp->ice) {
2686                 enum ast_rtp_ice_component_type component = rtcp ? AST_RTP_ICE_COMPONENT_RTCP : AST_RTP_ICE_COMPONENT_RTP;
2687                 pj_status_t status;
2688                 struct ice_wrap *ice;
2689
2690                 /* If RTCP is sharing the same socket then use the same component */
2691                 if (rtcp && rtp->rtcp->s == rtp->s) {
2692                         component = AST_RTP_ICE_COMPONENT_RTP;
2693                 }
2694
2695                 pj_thread_register_check();
2696
2697                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
2698                 ice = transport_rtp->ice;
2699                 ao2_ref(ice, +1);
2700                 if (instance == transport) {
2701                         ao2_unlock(instance);
2702                 }
2703                 status = pj_ice_sess_send_data(ice->real_ice, component, temp, len);
2704                 ao2_ref(ice, -1);
2705                 if (instance == transport) {
2706                         ao2_lock(instance);
2707                 }
2708                 if (status == PJ_SUCCESS) {
2709                         *via_ice = 1;
2710                         return len;
2711                 }
2712         }
2713 #endif
2714
2715         res = ast_sendto(rtcp ? transport_rtp->rtcp->s : transport_rtp->s, temp, len, flags, sa);
2716         if (res > 0) {
2717                 ast_rtp_instance_set_last_tx(instance, time(NULL));
2718         }
2719
2720         return res;
2721 }
2722
2723 /*! \pre instance is locked */
2724 static int rtcp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int *ice)
2725 {
2726         return __rtp_sendto(instance, buf, size, flags, sa, 1, ice, 1);
2727 }
2728
2729 /*! \pre instance is locked */
2730 static int rtp_sendto(struct ast_rtp_instance *instance, void *buf, size_t size, int flags, struct ast_sockaddr *sa, int *ice)
2731 {
2732         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
2733         int hdrlen = 12;
2734         int res;
2735
2736         if ((res = __rtp_sendto(instance, buf, size, flags, sa, 0, ice, 1)) > 0) {
2737                 rtp->txcount++;
2738                 rtp->txoctetcount += (res - hdrlen);
2739         }
2740
2741         return res;
2742 }
2743
2744 static int rtp_get_rate(struct ast_format *format)
2745 {
2746         /* For those wondering: due to a fluke in RFC publication, G.722 is advertised
2747          * as having a sample rate of 8kHz, while implementations must know that its
2748          * real rate is 16kHz. Seriously.
2749          */
2750         return (ast_format_cmp(format, ast_format_g722) == AST_FORMAT_CMP_EQUAL) ? 8000 : (int)ast_format_get_sample_rate(format);
2751 }
2752
2753 static unsigned int ast_rtcp_calc_interval(struct ast_rtp *rtp)
2754 {
2755         unsigned int interval;
2756         /*! \todo XXX Do a more reasonable calculation on this one
2757          * Look in RFC 3550 Section A.7 for an example*/
2758         interval = rtcpinterval;
2759         return interval;
2760 }
2761
2762 /*! \brief Calculate normal deviation */
2763 static double normdev_compute(double normdev, double sample, unsigned int sample_count)
2764 {
2765         normdev = normdev * sample_count + sample;
2766         sample_count++;
2767
2768         return normdev / sample_count;
2769 }
2770
2771 static double stddev_compute(double stddev, double sample, double normdev, double normdev_curent, unsigned int sample_count)
2772 {
2773 /*
2774                 for the formula check http://www.cs.umd.edu/~austinjp/constSD.pdf
2775                 return sqrt( (sample_count*pow(stddev,2) + sample_count*pow((sample-normdev)/(sample_count+1),2) + pow(sample-normdev_curent,2)) / (sample_count+1));
2776                 we can compute the sigma^2 and that way we would have to do the sqrt only 1 time at the end and would save another pow 2 compute
2777                 optimized formula
2778 */
2779 #define SQUARE(x) ((x) * (x))
2780
2781         stddev = sample_count * stddev;
2782         sample_count++;
2783
2784         return stddev +
2785                 ( sample_count * SQUARE( (sample - normdev) / sample_count ) ) +
2786                 ( SQUARE(sample - normdev_curent) / sample_count );
2787
2788 #undef SQUARE
2789 }
2790
2791 static int create_new_socket(const char *type, int af)
2792 {
2793         int sock = socket(af, SOCK_DGRAM, 0);
2794
2795         if (sock < 0) {
2796                 if (!type) {
2797                         type = "RTP/RTCP";
2798                 }
2799                 ast_log(LOG_WARNING, "Unable to allocate %s socket: %s\n", type, strerror(errno));
2800         } else {
2801                 long flags = fcntl(sock, F_GETFL);
2802                 fcntl(sock, F_SETFL, flags | O_NONBLOCK);
2803 #ifdef SO_NO_CHECK
2804                 if (nochecksums) {
2805                         setsockopt(sock, SOL_SOCKET, SO_NO_CHECK, &nochecksums, sizeof(nochecksums));
2806                 }
2807 #endif
2808         }
2809
2810         return sock;
2811 }
2812
2813 /*!
2814  * \internal
2815  * \brief Initializes sequence values and probation for learning mode.
2816  * \note This is an adaptation of pjmedia's pjmedia_rtp_seq_init function.
2817  *
2818  * \param info The learning information to track
2819  * \param seq sequence number read from the rtp header to initialize the information with
2820  */
2821 static void rtp_learning_seq_init(struct rtp_learning_info *info, uint16_t seq)
2822 {
2823         info->max_seq = seq - 1;
2824         info->packets = learning_min_sequential;
2825 }
2826
2827 /*!
2828  * \internal
2829  * \brief Updates sequence information for learning mode and determines if probation/learning mode should remain in effect.
2830  * \note This function was adapted from pjmedia's pjmedia_rtp_seq_update function.
2831  *
2832  * \param info Structure tracking the learning progress of some address
2833  * \param seq sequence number read from the rtp header
2834  * \retval 0 if probation mode should exit for this address
2835  * \retval non-zero if probation mode should continue
2836  */
2837 static int rtp_learning_rtp_seq_update(struct rtp_learning_info *info, uint16_t seq)
2838 {
2839         if (seq == info->max_seq + 1) {
2840                 /* packet is in sequence */
2841                 info->packets--;
2842         } else {
2843                 /* Sequence discontinuity; reset */
2844                 info->packets = learning_min_sequential - 1;
2845         }
2846         info->max_seq = seq;
2847
2848         return (info->packets == 0);
2849 }
2850
2851 #ifdef HAVE_PJPROJECT
2852 /*!
2853  * \internal
2854  * \brief Checks an address against the ICE blacklist
2855  * \note If there is no ice_blacklist list, always returns 0
2856  *
2857  * \param address The address to consider
2858  * \retval 0 if address is not ICE blacklisted
2859  * \retval 1 if address is ICE blacklisted
2860  */
2861 static int rtp_address_is_ice_blacklisted(const pj_sockaddr_t *address)
2862 {
2863         char buf[PJ_INET6_ADDRSTRLEN];
2864         struct ast_sockaddr saddr;
2865         int result = 1;
2866
2867         ast_sockaddr_parse(&saddr, pj_sockaddr_print(address, buf, sizeof(buf), 0), 0);
2868
2869         ast_rwlock_rdlock(&ice_blacklist_lock);
2870         if (!ice_blacklist || (ast_apply_ha(ice_blacklist, &saddr) == AST_SENSE_ALLOW)) {
2871                 result = 0;
2872         }
2873         ast_rwlock_unlock(&ice_blacklist_lock);
2874
2875         return result;
2876 }
2877
2878 /*!
2879  * \internal
2880  * \brief Checks an address against the STUN blacklist
2881  * \since 13.16.0
2882  *
2883  * \note If there is no stun_blacklist list, always returns 0
2884  *
2885  * \param addr The address to consider
2886  *
2887  * \retval 0 if address is not STUN blacklisted
2888  * \retval 1 if address is STUN blacklisted
2889  */
2890 static int stun_address_is_blacklisted(const struct ast_sockaddr *addr)
2891 {
2892         int result = 1;
2893
2894         ast_rwlock_rdlock(&stun_blacklist_lock);
2895         if (!stun_blacklist
2896                 || ast_apply_ha(stun_blacklist, addr) == AST_SENSE_ALLOW) {
2897                 result = 0;
2898         }
2899         ast_rwlock_unlock(&stun_blacklist_lock);
2900
2901         return result;
2902 }
2903
2904 /*! \pre instance is locked */
2905 static void rtp_add_candidates_to_ice(struct ast_rtp_instance *instance, struct ast_rtp *rtp, struct ast_sockaddr *addr, int port, int component,
2906                                       int transport)
2907 {
2908         pj_sockaddr address[PJ_ICE_MAX_CAND];
2909         unsigned int count = PJ_ARRAY_SIZE(address), pos = 0;
2910         int basepos = -1;
2911
2912         /* Add all the local interface IP addresses */
2913         if (ast_sockaddr_is_ipv4(addr)) {
2914                 pj_enum_ip_interface(pj_AF_INET(), &count, address);
2915         } else if (ast_sockaddr_is_any(addr)) {
2916                 pj_enum_ip_interface(pj_AF_UNSPEC(), &count, address);
2917         } else {
2918                 pj_enum_ip_interface(pj_AF_INET6(), &count, address);
2919         }
2920
2921         host_candidate_overrides_apply(count, address);
2922
2923         for (pos = 0; pos < count; pos++) {
2924                 if (!rtp_address_is_ice_blacklisted(&address[pos])) {
2925                         if (basepos == -1) {
2926                                 basepos = pos;
2927                         }
2928                         pj_sockaddr_set_port(&address[pos], port);
2929                         ast_rtp_ice_add_cand(instance, rtp, component, transport,
2930                                 PJ_ICE_CAND_TYPE_HOST, 65535, &address[pos], &address[pos], NULL,
2931                                 pj_sockaddr_get_len(&address[pos]));
2932                 }
2933         }
2934         if (basepos == -1) {
2935                 /* start with first address unless excluded above */
2936                 basepos = 0;
2937         }
2938
2939         /* If configured to use a STUN server to get our external mapped address do so */
2940         if (stunaddr.sin_addr.s_addr && count && ast_sockaddr_is_ipv4(addr)
2941                 && !stun_address_is_blacklisted(addr)) {
2942                 struct sockaddr_in answer;
2943                 int rsp;
2944
2945                 /*
2946                  * The instance should not be locked because we can block
2947                  * waiting for a STUN respone.
2948                  */
2949                 ao2_unlock(instance);
2950                 rsp = ast_stun_request(component == AST_RTP_ICE_COMPONENT_RTCP
2951                         ? rtp->rtcp->s : rtp->s, &stunaddr, NULL, &answer);
2952                 ao2_lock(instance);
2953                 if (!rsp) {
2954                         pj_sockaddr base;
2955                         pj_sockaddr ext;
2956                         pj_str_t mapped = pj_str(ast_strdupa(ast_inet_ntoa(answer.sin_addr)));
2957                         int srflx = 1;
2958
2959                         /* Use the first local host candidate as the base */
2960                         pj_sockaddr_cp(&base, &address[basepos]);
2961
2962                         pj_sockaddr_init(pj_AF_INET(), &ext, &mapped, ntohs(answer.sin_port));
2963
2964                         /* If the returned address is the same as one of our host candidates, don't send the srflx */
2965                         for (pos = 0; pos < count; pos++) {
2966                                 if ((pj_sockaddr_cmp(&address[pos], &ext) == 0) && !rtp_address_is_ice_blacklisted(&address[pos])) {
2967                                         srflx = 0;
2968                                         break;
2969                                 }
2970                         }
2971
2972                         if (srflx) {
2973                                 ast_rtp_ice_add_cand(instance, rtp, component, transport,
2974                                         PJ_ICE_CAND_TYPE_SRFLX, 65535, &ext, &base, &base,
2975                                         pj_sockaddr_get_len(&ext));
2976                         }
2977                 }
2978         }
2979
2980         /* If configured to use a TURN relay create a session and allocate */
2981         if (pj_strlen(&turnaddr)) {
2982                 ast_rtp_ice_turn_request(instance, component, AST_TRANSPORT_TCP, pj_strbuf(&turnaddr), turnport,
2983                         pj_strbuf(&turnusername), pj_strbuf(&turnpassword));
2984         }
2985 }
2986 #endif
2987
2988 /*!
2989  * \internal
2990  * \brief Calculates the elapsed time from issue of the first tx packet in an
2991  *        rtp session and a specified time
2992  *
2993  * \param rtp pointer to the rtp struct with the transmitted rtp packet
2994  * \param delivery time of delivery - if NULL or zero value, will be ast_tvnow()
2995  *
2996  * \return time elapsed in milliseconds
2997  */
2998 static unsigned int calc_txstamp(struct ast_rtp *rtp, struct timeval *delivery)
2999 {
3000         struct timeval t;
3001         long ms;
3002
3003         if (ast_tvzero(rtp->txcore)) {
3004                 rtp->txcore = ast_tvnow();
3005                 rtp->txcore.tv_usec -= rtp->txcore.tv_usec % 20000;
3006         }
3007
3008         t = (delivery && !ast_tvzero(*delivery)) ? *delivery : ast_tvnow();
3009         if ((ms = ast_tvdiff_ms(t, rtp->txcore)) < 0) {
3010                 ms = 0;
3011         }
3012         rtp->txcore = t;
3013
3014         return (unsigned int) ms;
3015 }
3016
3017 #ifdef HAVE_PJPROJECT
3018 /*!
3019  * \internal
3020  * \brief Creates an ICE session. Can be used to replace a destroyed ICE session.
3021  *
3022  * \param instance RTP instance for which the ICE session is being replaced
3023  * \param addr ast_sockaddr to use for adding RTP candidates to the ICE session
3024  * \param port port to use for adding RTP candidates to the ICE session
3025  * \param replace 0 when creating a new session, 1 when replacing a destroyed session
3026  *
3027  * \pre instance is locked
3028  *
3029  * \retval 0 on success
3030  * \retval -1 on failure
3031  */
3032 static int ice_create(struct ast_rtp_instance *instance, struct ast_sockaddr *addr,
3033         int port, int replace)
3034 {
3035         pj_stun_config stun_config;
3036         pj_str_t ufrag, passwd;
3037         pj_status_t status;
3038         struct ice_wrap *ice_old;
3039         struct ice_wrap *ice;
3040         pj_ice_sess *real_ice = NULL;
3041         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3042
3043         ao2_cleanup(rtp->ice_local_candidates);
3044         rtp->ice_local_candidates = NULL;
3045
3046         ice = ao2_alloc_options(sizeof(*ice), ice_wrap_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK);
3047         if (!ice) {
3048                 ast_rtp_ice_stop(instance);
3049                 return -1;
3050         }
3051
3052         pj_thread_register_check();
3053
3054         pj_stun_config_init(&stun_config, &cachingpool.factory, 0, NULL, timer_heap);
3055
3056         ufrag = pj_str(rtp->local_ufrag);
3057         passwd = pj_str(rtp->local_passwd);
3058
3059         /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
3060         ao2_unlock(instance);
3061         /* Create an ICE session for ICE negotiation */
3062         status = pj_ice_sess_create(&stun_config, NULL, PJ_ICE_SESS_ROLE_UNKNOWN,
3063                 rtp->ice_num_components, &ast_rtp_ice_sess_cb, &ufrag, &passwd, NULL, &real_ice);
3064         ao2_lock(instance);
3065         if (status == PJ_SUCCESS) {
3066                 /* Safely complete linking the ICE session into the instance */
3067                 real_ice->user_data = instance;
3068                 ice->real_ice = real_ice;
3069                 ice_old = rtp->ice;
3070                 rtp->ice = ice;
3071                 if (ice_old) {
3072                         ao2_unlock(instance);
3073                         ao2_ref(ice_old, -1);
3074                         ao2_lock(instance);
3075                 }
3076
3077                 /* Add all of the available candidates to the ICE session */
3078                 rtp_add_candidates_to_ice(instance, rtp, addr, port, AST_RTP_ICE_COMPONENT_RTP,
3079                         TRANSPORT_SOCKET_RTP);
3080
3081                 /* Only add the RTCP candidates to ICE when replacing the session and if
3082                  * the ICE session contains more than just an RTP component. New sessions
3083                  * handle this in a separate part of the setup phase */
3084                 if (replace && rtp->rtcp && rtp->ice_num_components > 1) {
3085                         rtp_add_candidates_to_ice(instance, rtp, &rtp->rtcp->us,
3086                                 ast_sockaddr_port(&rtp->rtcp->us), AST_RTP_ICE_COMPONENT_RTCP,
3087                                 TRANSPORT_SOCKET_RTCP);
3088                 }
3089
3090                 return 0;
3091         }
3092
3093         /*
3094          * It is safe to unref this while instance is locked here.
3095          * It was not initialized with a real_ice pointer.
3096          */
3097         ao2_ref(ice, -1);
3098
3099         ast_rtp_ice_stop(instance);
3100         return -1;
3101
3102 }
3103 #endif
3104
3105 static int rtp_allocate_transport(struct ast_rtp_instance *instance, struct ast_rtp *rtp)
3106 {
3107         int x, startplace;
3108
3109         rtp->strict_rtp_state = (strictrtp ? STRICT_RTP_LEARN : STRICT_RTP_OPEN);
3110         if (strictrtp) {
3111                 rtp_learning_seq_init(&rtp->rtp_source_learn, (uint16_t)rtp->seqno);
3112                 rtp_learning_seq_init(&rtp->alt_source_learn, (uint16_t)rtp->seqno);
3113         }
3114
3115         /* Create a new socket for us to listen on and use */
3116         if ((rtp->s =
3117              create_new_socket("RTP",
3118                                ast_sockaddr_is_ipv4(&rtp->bind_address) ? AF_INET  :
3119                                ast_sockaddr_is_ipv6(&rtp->bind_address) ? AF_INET6 : -1)) < 0) {
3120                 ast_log(LOG_WARNING, "Failed to create a new socket for RTP instance '%p'\n", instance);
3121                 return -1;
3122         }
3123
3124         /* Now actually find a free RTP port to use */
3125         x = (rtpend == rtpstart) ? rtpstart : (ast_random() % (rtpend - rtpstart)) + rtpstart;
3126         x = x & ~1;
3127         startplace = x;
3128
3129         for (;;) {
3130                 ast_sockaddr_set_port(&rtp->bind_address, x);
3131                 /* Try to bind, this will tell us whether the port is available or not */
3132                 if (!ast_bind(rtp->s, &rtp->bind_address)) {
3133                         ast_debug(1, "Allocated port %d for RTP instance '%p'\n", x, instance);
3134                         ast_rtp_instance_set_local_address(instance, &rtp->bind_address);
3135                         break;
3136                 }
3137
3138                 x += 2;
3139                 if (x > rtpend) {
3140                         x = (rtpstart + 1) & ~1;
3141                 }
3142
3143                 /* See if we ran out of ports or if the bind actually failed because of something other than the address being in use */
3144                 if (x == startplace || (errno != EADDRINUSE && errno != EACCES)) {
3145                         ast_log(LOG_ERROR, "Oh dear... we couldn't allocate a port for RTP instance '%p'\n", instance);
3146                         close(rtp->s);
3147                         return -1;
3148                 }
3149         }
3150
3151 #ifdef HAVE_PJPROJECT
3152         /* Initialize synchronization aspects */
3153         ast_cond_init(&rtp->cond, NULL);
3154
3155         generate_random_string(rtp->local_ufrag, sizeof(rtp->local_ufrag));
3156         generate_random_string(rtp->local_passwd, sizeof(rtp->local_passwd));
3157
3158         /* Create an ICE session for ICE negotiation */
3159         if (icesupport) {
3160                 rtp->ice_num_components = 2;
3161                 ast_debug(3, "Creating ICE session %s (%d) for RTP instance '%p'\n", ast_sockaddr_stringify(&rtp->bind_address), x, instance);
3162                 if (ice_create(instance, &rtp->bind_address, x, 0)) {
3163                         ast_log(LOG_NOTICE, "Failed to create ICE session\n");
3164                 } else {
3165                         rtp->ice_port = x;
3166                         ast_sockaddr_copy(&rtp->ice_original_rtp_addr, &rtp->bind_address);
3167                 }
3168         }
3169 #endif
3170
3171 #ifdef HAVE_OPENSSL_SRTP
3172         rtp->rekeyid = -1;
3173         rtp->dtls.timeout_timer = -1;
3174 #endif
3175
3176         return 0;
3177 }
3178
3179 static void rtp_deallocate_transport(struct ast_rtp_instance *instance, struct ast_rtp *rtp)
3180 {
3181 #ifdef HAVE_PJPROJECT
3182         struct timeval wait = ast_tvadd(ast_tvnow(), ast_samp2tv(TURN_STATE_WAIT_TIME, 1000));
3183         struct timespec ts = { .tv_sec = wait.tv_sec, .tv_nsec = wait.tv_usec * 1000, };
3184 #endif
3185
3186 #ifdef HAVE_OPENSSL_SRTP
3187         ast_rtp_dtls_stop(instance);
3188 #endif
3189
3190         /* Close our own socket so we no longer get packets */
3191         if (rtp->s > -1) {
3192                 close(rtp->s);
3193                 rtp->s = -1;
3194         }
3195
3196         /* Destroy RTCP if it was being used */
3197         if (rtp->rtcp && rtp->rtcp->s > -1) {
3198                 close(rtp->rtcp->s);
3199                 rtp->rtcp->s = -1;
3200         }
3201
3202 #ifdef HAVE_PJPROJECT
3203         pj_thread_register_check();
3204
3205         /*
3206          * The instance lock is already held.
3207          *
3208          * Destroy the RTP TURN relay if being used
3209          */
3210         if (rtp->turn_rtp) {
3211                 rtp->turn_state = PJ_TURN_STATE_NULL;
3212
3213                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
3214                 ao2_unlock(instance);
3215                 pj_turn_sock_destroy(rtp->turn_rtp);
3216                 ao2_lock(instance);
3217                 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
3218                         ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
3219                 }
3220                 rtp->turn_rtp = NULL;
3221         }
3222
3223         /* Destroy the RTCP TURN relay if being used */
3224         if (rtp->turn_rtcp) {
3225                 rtp->turn_state = PJ_TURN_STATE_NULL;
3226
3227                 /* Release the instance lock to avoid deadlock with PJPROJECT group lock */
3228                 ao2_unlock(instance);
3229                 pj_turn_sock_destroy(rtp->turn_rtcp);
3230                 ao2_lock(instance);
3231                 while (rtp->turn_state != PJ_TURN_STATE_DESTROYING) {
3232                         ast_cond_timedwait(&rtp->cond, ao2_object_get_lockaddr(instance), &ts);
3233                 }
3234                 rtp->turn_rtcp = NULL;
3235         }
3236
3237         /* Destroy any ICE session */
3238         ast_rtp_ice_stop(instance);
3239
3240         /* Destroy any candidates */
3241         if (rtp->ice_local_candidates) {
3242                 ao2_ref(rtp->ice_local_candidates, -1);
3243                 rtp->ice_local_candidates = NULL;
3244         }
3245
3246         if (rtp->ice_active_remote_candidates) {
3247                 ao2_ref(rtp->ice_active_remote_candidates, -1);
3248                 rtp->ice_active_remote_candidates = NULL;
3249         }
3250
3251         if (rtp->ioqueue) {
3252                 /*
3253                  * We cannot hold the instance lock because we could wait
3254                  * for the ioqueue thread to die and we might deadlock as
3255                  * a result.
3256                  */
3257                 ao2_unlock(instance);
3258                 rtp_ioqueue_thread_remove(rtp->ioqueue);
3259                 ao2_lock(instance);
3260                 rtp->ioqueue = NULL;
3261         }
3262 #endif
3263 }
3264
3265 /*! \pre instance is locked */
3266 static int ast_rtp_new(struct ast_rtp_instance *instance,
3267                        struct ast_sched_context *sched, struct ast_sockaddr *addr,
3268                        void *data)
3269 {
3270         struct ast_rtp *rtp = NULL;
3271
3272         /* Create a new RTP structure to hold all of our data */
3273         if (!(rtp = ast_calloc(1, sizeof(*rtp)))) {
3274                 return -1;
3275         }
3276
3277         /* Set default parameters on the newly created RTP structure */
3278         rtp->ssrc = ast_random();
3279         ast_uuid_generate_str(rtp->cname, sizeof(rtp->cname));
3280         rtp->seqno = ast_random() & 0x7fff;
3281         rtp->expectedseqno = -1;
3282         rtp->sched = sched;
3283         ast_sockaddr_copy(&rtp->bind_address, addr);
3284
3285         /* Transport creation operations can grab the RTP data from the instance, so set it */
3286         ast_rtp_instance_set_data(instance, rtp);
3287
3288         if (rtp_allocate_transport(instance, rtp)) {
3289                 ast_free(rtp);
3290                 return -1;
3291         }
3292
3293         rtp->f.subclass.format = ao2_bump(ast_format_none);
3294         rtp->lastrxformat = ao2_bump(ast_format_none);
3295         rtp->lasttxformat = ao2_bump(ast_format_none);
3296         rtp->stream_num = -1;
3297         AST_VECTOR_INIT(&rtp->ssrc_mapping, 1);
3298
3299         return 0;
3300 }
3301
3302 /*!
3303  * \brief SSRC mapping comparator for AST_VECTOR_REMOVE_CMP_UNORDERED()
3304  *
3305  * \param elem Element to compare against
3306  * \param value Value to compare with the vector element.
3307  *
3308  * \return 0 if element does not match.
3309  * \return Non-zero if element matches.
3310  */
3311 #define SSRC_MAPPING_ELEM_CMP(elem, value) (elem.instance == value)
3312
3313 /*! \pre instance is locked */
3314 static int ast_rtp_destroy(struct ast_rtp_instance *instance)
3315 {
3316         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3317
3318         if (rtp->bundled) {
3319                 struct ast_rtp *bundled_rtp;
3320
3321                 /* We can't hold our instance lock while removing ourselves from the parent */
3322                 ao2_unlock(instance);
3323
3324                 ao2_lock(rtp->bundled);
3325                 bundled_rtp = ast_rtp_instance_get_data(rtp->bundled);
3326                 AST_VECTOR_REMOVE_CMP_UNORDERED(&bundled_rtp->ssrc_mapping, instance, SSRC_MAPPING_ELEM_CMP, AST_VECTOR_ELEM_CLEANUP_NOOP);
3327                 ao2_unlock(rtp->bundled);
3328
3329                 ao2_lock(instance);
3330                 ao2_ref(rtp->bundled, -1);
3331         }
3332
3333         rtp_deallocate_transport(instance, rtp);
3334
3335         /* Destroy the smoother that was smoothing out audio if present */
3336         if (rtp->smoother) {
3337                 ast_smoother_free(rtp->smoother);
3338         }
3339
3340         /* Destroy RTCP if it was being used */
3341         if (rtp->rtcp) {
3342                 /*
3343                  * It is not possible for there to be an active RTCP scheduler
3344                  * entry at this point since it holds a reference to the
3345                  * RTP instance while it's active.
3346                  */
3347                 ast_free(rtp->rtcp->local_addr_str);
3348                 ast_free(rtp->rtcp);
3349         }
3350
3351         /* Destroy RED if it was being used */
3352         if (rtp->red) {
3353                 ao2_unlock(instance);
3354                 AST_SCHED_DEL(rtp->sched, rtp->red->schedid);
3355                 ao2_lock(instance);
3356                 ast_free(rtp->red);
3357                 rtp->red = NULL;
3358         }
3359
3360         ao2_cleanup(rtp->lasttxformat);
3361         ao2_cleanup(rtp->lastrxformat);
3362         ao2_cleanup(rtp->f.subclass.format);
3363         AST_VECTOR_FREE(&rtp->ssrc_mapping);
3364
3365         /* Finally destroy ourselves */
3366         ast_free(rtp);
3367
3368         return 0;
3369 }
3370
3371 /*! \pre instance is locked */
3372 static int ast_rtp_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode)
3373 {
3374         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3375         rtp->dtmfmode = dtmf_mode;
3376         return 0;
3377 }
3378
3379 /*! \pre instance is locked */
3380 static enum ast_rtp_dtmf_mode ast_rtp_dtmf_mode_get(struct ast_rtp_instance *instance)
3381 {
3382         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3383         return rtp->dtmfmode;
3384 }
3385
3386 /*! \pre instance is locked */
3387 static int ast_rtp_dtmf_begin(struct ast_rtp_instance *instance, char digit)
3388 {
3389         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3390         struct ast_sockaddr remote_address = { {0,} };
3391         int hdrlen = 12, res = 0, i = 0, payload = 101;
3392         char data[256];
3393         unsigned int *rtpheader = (unsigned int*)data;
3394
3395         ast_rtp_instance_get_remote_address(instance, &remote_address);
3396
3397         /* If we have no remote address information bail out now */
3398         if (ast_sockaddr_isnull(&remote_address)) {
3399                 return -1;
3400         }
3401
3402         /* Convert given digit into what we want to transmit */
3403         if ((digit <= '9') && (digit >= '0')) {
3404                 digit -= '0';
3405         } else if (digit == '*') {
3406                 digit = 10;
3407         } else if (digit == '#') {
3408                 digit = 11;
3409         } else if ((digit >= 'A') && (digit <= 'D')) {
3410                 digit = digit - 'A' + 12;
3411         } else if ((digit >= 'a') && (digit <= 'd')) {
3412                 digit = digit - 'a' + 12;
3413         } else {
3414                 ast_log(LOG_WARNING, "Don't know how to represent '%c'\n", digit);
3415                 return -1;
3416         }
3417
3418         /* Grab the payload that they expect the RFC2833 packet to be received in */
3419         payload = ast_rtp_codecs_payload_code_tx(ast_rtp_instance_get_codecs(instance), 0, NULL, AST_RTP_DTMF);
3420
3421         rtp->dtmfmute = ast_tvadd(ast_tvnow(), ast_tv(0, 500000));
3422         rtp->send_duration = 160;
3423         rtp->lastts += calc_txstamp(rtp, NULL) * DTMF_SAMPLE_RATE_MS;
3424         rtp->lastdigitts = rtp->lastts + rtp->send_duration;
3425
3426         /* Create the actual packet that we will be sending */
3427         rtpheader[0] = htonl((2 << 30) | (1 << 23) | (payload << 16) | (rtp->seqno));
3428         rtpheader[1] = htonl(rtp->lastdigitts);
3429         rtpheader[2] = htonl(rtp->ssrc);
3430
3431         /* Actually send the packet */
3432         for (i = 0; i < 2; i++) {
3433                 int ice;
3434
3435                 rtpheader[3] = htonl((digit << 24) | (0xa << 16) | (rtp->send_duration));
3436                 res = rtp_sendto(instance, (void *) rtpheader, hdrlen + 4, 0, &remote_address, &ice);
3437                 if (res < 0) {
3438                         ast_log(LOG_ERROR, "RTP Transmission error to %s: %s\n",
3439                                 ast_sockaddr_stringify(&remote_address),
3440                                 strerror(errno));
3441                 }
3442                 if (rtp_debug_test_addr(&remote_address)) {
3443                         ast_verbose("Sent RTP DTMF packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
3444                                     ast_sockaddr_stringify(&remote_address),
3445                                     ice ? " (via ICE)" : "",
3446                                     payload, rtp->seqno, rtp->lastdigitts, res - hdrlen);
3447                 }
3448                 rtp->seqno++;
3449                 rtp->send_duration += 160;
3450                 rtpheader[0] = htonl((2 << 30) | (payload << 16) | (rtp->seqno));
3451         }
3452
3453         /* Record that we are in the process of sending a digit and information needed to continue doing so */
3454         rtp->sending_digit = 1;
3455         rtp->send_digit = digit;
3456         rtp->send_payload = payload;
3457
3458         return 0;
3459 }
3460
3461 /*! \pre instance is locked */
3462 static int ast_rtp_dtmf_continuation(struct ast_rtp_instance *instance)
3463 {
3464         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3465         struct ast_sockaddr remote_address = { {0,} };
3466         int hdrlen = 12, res = 0;
3467         char data[256];
3468         unsigned int *rtpheader = (unsigned int*)data;
3469         int ice;
3470
3471         ast_rtp_instance_get_remote_address(instance, &remote_address);
3472
3473         /* Make sure we know where the other side is so we can send them the packet */
3474         if (ast_sockaddr_isnull(&remote_address)) {
3475                 return -1;
3476         }
3477
3478         /* Actually create the packet we will be sending */
3479         rtpheader[0] = htonl((2 << 30) | (rtp->send_payload << 16) | (rtp->seqno));
3480         rtpheader[1] = htonl(rtp->lastdigitts);
3481         rtpheader[2] = htonl(rtp->ssrc);
3482         rtpheader[3] = htonl((rtp->send_digit << 24) | (0xa << 16) | (rtp->send_duration));
3483
3484         /* Boom, send it on out */
3485         res = rtp_sendto(instance, (void *) rtpheader, hdrlen + 4, 0, &remote_address, &ice);
3486         if (res < 0) {
3487                 ast_log(LOG_ERROR, "RTP Transmission error to %s: %s\n",
3488                         ast_sockaddr_stringify(&remote_address),
3489                         strerror(errno));
3490         }
3491
3492         if (rtp_debug_test_addr(&remote_address)) {
3493                 ast_verbose("Sent RTP DTMF packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
3494                             ast_sockaddr_stringify(&remote_address),
3495                             ice ? " (via ICE)" : "",
3496                             rtp->send_payload, rtp->seqno, rtp->lastdigitts, res - hdrlen);
3497         }
3498
3499         /* And now we increment some values for the next time we swing by */
3500         rtp->seqno++;
3501         rtp->send_duration += 160;
3502         rtp->lastts += calc_txstamp(rtp, NULL) * DTMF_SAMPLE_RATE_MS;
3503
3504         return 0;
3505 }
3506
3507 /*! \pre instance is locked */
3508 static int ast_rtp_dtmf_end_with_duration(struct ast_rtp_instance *instance, char digit, unsigned int duration)
3509 {
3510         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3511         struct ast_sockaddr remote_address = { {0,} };
3512         int hdrlen = 12, res = -1, i = 0;
3513         char data[256];
3514         unsigned int *rtpheader = (unsigned int*)data;
3515         unsigned int measured_samples;
3516
3517         ast_rtp_instance_get_remote_address(instance, &remote_address);
3518
3519         /* Make sure we know where the remote side is so we can send them the packet we construct */
3520         if (ast_sockaddr_isnull(&remote_address)) {
3521                 goto cleanup;
3522         }
3523
3524         /* Convert the given digit to the one we are going to send */
3525         if ((digit <= '9') && (digit >= '0')) {
3526                 digit -= '0';
3527         } else if (digit == '*') {
3528                 digit = 10;
3529         } else if (digit == '#') {
3530                 digit = 11;
3531         } else if ((digit >= 'A') && (digit <= 'D')) {
3532                 digit = digit - 'A' + 12;
3533         } else if ((digit >= 'a') && (digit <= 'd')) {
3534                 digit = digit - 'a' + 12;
3535         } else {
3536                 ast_log(LOG_WARNING, "Don't know how to represent '%c'\n", digit);
3537                 goto cleanup;
3538         }
3539
3540         rtp->dtmfmute = ast_tvadd(ast_tvnow(), ast_tv(0, 500000));
3541
3542         if (duration > 0 && (measured_samples = duration * rtp_get_rate(rtp->f.subclass.format) / 1000) > rtp->send_duration) {
3543                 ast_debug(2, "Adjusting final end duration from %d to %u\n", rtp->send_duration, measured_samples);
3544                 rtp->send_duration = measured_samples;
3545         }
3546
3547         /* Construct the packet we are going to send */
3548         rtpheader[1] = htonl(rtp->lastdigitts);
3549         rtpheader[2] = htonl(rtp->ssrc);
3550         rtpheader[3] = htonl((digit << 24) | (0xa << 16) | (rtp->send_duration));
3551         rtpheader[3] |= htonl((1 << 23));
3552
3553         /* Send it 3 times, that's the magical number */
3554         for (i = 0; i < 3; i++) {
3555                 int ice;
3556
3557                 rtpheader[0] = htonl((2 << 30) | (rtp->send_payload << 16) | (rtp->seqno));
3558
3559                 res = rtp_sendto(instance, (void *) rtpheader, hdrlen + 4, 0, &remote_address, &ice);
3560
3561                 if (res < 0) {
3562                         ast_log(LOG_ERROR, "RTP Transmission error to %s: %s\n",
3563                                 ast_sockaddr_stringify(&remote_address),
3564                                 strerror(errno));
3565                 }
3566
3567                 if (rtp_debug_test_addr(&remote_address)) {
3568                         ast_verbose("Sent RTP DTMF packet to %s%s (type %-2.2d, seq %-6.6d, ts %-6.6u, len %-6.6d)\n",
3569                                     ast_sockaddr_stringify(&remote_address),
3570                                     ice ? " (via ICE)" : "",
3571                                     rtp->send_payload, rtp->seqno, rtp->lastdigitts, res - hdrlen);
3572                 }
3573
3574                 rtp->seqno++;
3575         }
3576         res = 0;
3577
3578         /* Oh and we can't forget to turn off the stuff that says we are sending DTMF */
3579         rtp->lastts += calc_txstamp(rtp, NULL) * DTMF_SAMPLE_RATE_MS;
3580 cleanup:
3581         rtp->sending_digit = 0;
3582         rtp->send_digit = 0;
3583
3584         return res;
3585 }
3586
3587 /*! \pre instance is locked */
3588 static int ast_rtp_dtmf_end(struct ast_rtp_instance *instance, char digit)
3589 {
3590         return ast_rtp_dtmf_end_with_duration(instance, digit, 0);
3591 }
3592
3593 /*! \pre instance is locked */
3594 static void ast_rtp_update_source(struct ast_rtp_instance *instance)
3595 {
3596         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3597
3598         /* We simply set this bit so that the next packet sent will have the marker bit turned on */
3599         ast_set_flag(rtp, FLAG_NEED_MARKER_BIT);
3600         ast_debug(3, "Setting the marker bit due to a source update\n");
3601
3602         return;
3603 }
3604
3605 /*! \pre instance is locked */
3606 static void ast_rtp_change_source(struct ast_rtp_instance *instance)
3607 {
3608         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3609         struct ast_srtp *srtp = ast_rtp_instance_get_srtp(instance, 0);
3610         struct ast_srtp *rtcp_srtp = ast_rtp_instance_get_srtp(instance, 1);
3611         unsigned int ssrc = ast_random();
3612
3613         if (rtp->lastts) {
3614                 /* We simply set this bit so that the next packet sent will have the marker bit turned on */
3615                 ast_set_flag(rtp, FLAG_NEED_MARKER_BIT);
3616
3617                 ast_debug(3, "Changing ssrc from %u to %u due to a source change\n", rtp->ssrc, ssrc);
3618
3619                 if (srtp) {
3620                         ast_debug(3, "Changing ssrc for SRTP from %u to %u\n", rtp->ssrc, ssrc);
3621                         res_srtp->change_source(srtp, rtp->ssrc, ssrc);
3622                         if (rtcp_srtp != srtp) {
3623                                 res_srtp->change_source(rtcp_srtp, rtp->ssrc, ssrc);
3624                         }
3625                 }
3626         }
3627
3628         rtp->ssrc = ssrc;
3629
3630         return;
3631 }
3632
3633 static void timeval2ntp(struct timeval tv, unsigned int *msw, unsigned int *lsw)
3634 {
3635         unsigned int sec, usec, frac;
3636         sec = tv.tv_sec + 2208988800u; /* Sec between 1900 and 1970 */
3637         usec = tv.tv_usec;
3638         /*
3639          * Convert usec to 0.32 bit fixed point without overflow.
3640          *
3641          * = usec * 2^32 / 10^6
3642          * = usec * 2^32 / (2^6 * 5^6)
3643          * = usec * 2^26 / 5^6
3644          *
3645          * The usec value needs 20 bits to represent 999999 usec.  So
3646          * splitting the 2^26 to get the most precision using 32 bit
3647          * values gives:
3648          *
3649          * = ((usec * 2^12) / 5^6) * 2^14
3650          *
3651          * Splitting the division into two stages preserves all the
3652          * available significant bits of usec over doing the division
3653          * all at once.
3654          *
3655          * = ((((usec * 2^12) / 5^3) * 2^7) / 5^3) * 2^7
3656          */
3657         frac = ((((usec << 12) / 125) << 7) / 125) << 7;
3658         *msw = sec;
3659         *lsw = frac;
3660 }
3661
3662 static void ntp2timeval(unsigned int msw, unsigned int lsw, struct timeval *tv)
3663 {
3664         tv->tv_sec = msw - 2208988800u;
3665         /* Reverse the sequence in timeval2ntp() */
3666         tv->tv_usec = ((((lsw >> 7) * 125) >> 7) * 125) >> 12;
3667 }
3668
3669 static void calculate_lost_packet_statistics(struct ast_rtp *rtp,
3670                 unsigned int *lost_packets,
3671                 int *fraction_lost)
3672 {
3673         unsigned int extended_seq_no;
3674         unsigned int expected_packets;
3675         unsigned int expected_interval;
3676         unsigned int received_interval;
3677         double rxlost_current;
3678         int lost_interval;
3679
3680         /* Compute statistics */
3681         extended_seq_no = rtp->cycles + rtp->lastrxseqno;
3682         expected_packets = extended_seq_no - rtp->seedrxseqno + 1;
3683         if (rtp->rxcount > expected_packets) {
3684                 expected_packets += rtp->rxcount - expected_packets;
3685         }
3686         *lost_packets = expected_packets - rtp->rxcount;
3687         expected_interval = expected_packets - rtp->rtcp->expected_prior;
3688         received_interval = rtp->rxcount - rtp->rtcp->received_prior;
3689         lost_interval = expected_interval - received_interval;
3690         if (expected_interval == 0 || lost_interval <= 0) {
3691                 *fraction_lost = 0;
3692         } else {
3693                 *fraction_lost = (lost_interval << 8) / expected_interval;
3694         }
3695
3696         /* Update RTCP statistics */
3697         rtp->rtcp->received_prior = rtp->rxcount;
3698         rtp->rtcp->expected_prior = expected_packets;
3699         if (lost_interval <= 0) {
3700                 rtp->rtcp->rxlost = 0;
3701         } else {
3702                 rtp->rtcp->rxlost = lost_interval;
3703         }
3704         if (rtp->rtcp->rxlost_count == 0) {
3705                 rtp->rtcp->minrxlost = rtp->rtcp->rxlost;
3706         }
3707         if (lost_interval < rtp->rtcp->minrxlost) {
3708                 rtp->rtcp->minrxlost = rtp->rtcp->rxlost;
3709         }
3710         if (lost_interval > rtp->rtcp->maxrxlost) {
3711                 rtp->rtcp->maxrxlost = rtp->rtcp->rxlost;
3712         }
3713         rxlost_current = normdev_compute(rtp->rtcp->normdev_rxlost,
3714                         rtp->rtcp->rxlost,
3715                         rtp->rtcp->rxlost_count);
3716         rtp->rtcp->stdev_rxlost = stddev_compute(rtp->rtcp->stdev_rxlost,
3717                         rtp->rtcp->rxlost,
3718                         rtp->rtcp->normdev_rxlost,
3719                         rxlost_current,
3720                         rtp->rtcp->rxlost_count);
3721         rtp->rtcp->normdev_rxlost = rxlost_current;
3722         rtp->rtcp->rxlost_count++;
3723 }
3724
3725 /*!
3726  * \brief Send RTCP SR or RR report
3727  *
3728  * \pre instance is locked
3729  */
3730 static int ast_rtcp_write_report(struct ast_rtp_instance *instance, int sr)
3731 {
3732         struct ast_rtp *rtp = ast_rtp_instance_get_data(instance);
3733         RAII_VAR(struct ast_json *, message_blob, NULL, ast_json_unref);
3734         int res;
3735         int len = 0;
3736         struct timeval now;
3737         unsigned int now_lsw;
3738         unsigned int now_msw;
3739         unsigned char *rtcpheader;
3740         unsigned int lost_packets;
3741         int fraction_lost;
3742         struct timeval dlsr = { 0, };
3743         unsigned char bdata[512] = "";
3744         int rate = rtp_get_rate(rtp->f.subclass.format);
3745         int ice;