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