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