Merge "res_pjsip_sdp_rtp: Fix address family of explicit media_address."
[asterisk/asterisk.git] / res / res_pjsip_sdp_rtp.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  * Kevin Harwell <kharwell@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \author Joshua Colp <jcolp@digium.com>
23  *
24  * \brief SIP SDP media stream handling
25  */
26
27 /*** MODULEINFO
28         <depend>pjproject</depend>
29         <depend>res_pjsip</depend>
30         <depend>res_pjsip_session</depend>
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 #include <pjsip.h>
37 #include <pjsip_ua.h>
38 #include <pjmedia.h>
39 #include <pjlib.h>
40
41 ASTERISK_REGISTER_FILE()
42
43 #include "asterisk/module.h"
44 #include "asterisk/format.h"
45 #include "asterisk/format_cap.h"
46 #include "asterisk/rtp_engine.h"
47 #include "asterisk/netsock2.h"
48 #include "asterisk/channel.h"
49 #include "asterisk/causes.h"
50 #include "asterisk/sched.h"
51 #include "asterisk/acl.h"
52 #include "asterisk/sdp_srtp.h"
53 #include "asterisk/dsp.h"
54 #include "asterisk/linkedlists.h"       /* for AST_LIST_NEXT */
55
56 #include "asterisk/res_pjsip.h"
57 #include "asterisk/res_pjsip_session.h"
58
59 /*! \brief Scheduler for RTCP purposes */
60 static struct ast_sched_context *sched;
61
62 /*! \brief Address for RTP */
63 static struct ast_sockaddr address_rtp;
64
65 static const char STR_AUDIO[] = "audio";
66 static const int FD_AUDIO = 0;
67
68 static const char STR_VIDEO[] = "video";
69 static const int FD_VIDEO = 2;
70
71 /*! \brief Retrieves an ast_format_type based on the given stream_type */
72 static enum ast_media_type stream_to_media_type(const char *stream_type)
73 {
74         if (!strcasecmp(stream_type, STR_AUDIO)) {
75                 return AST_MEDIA_TYPE_AUDIO;
76         } else if (!strcasecmp(stream_type, STR_VIDEO)) {
77                 return AST_MEDIA_TYPE_VIDEO;
78         }
79
80         return 0;
81 }
82
83 /*! \brief Get the starting descriptor for a media type */
84 static int media_type_to_fdno(enum ast_media_type media_type)
85 {
86         switch (media_type) {
87         case AST_MEDIA_TYPE_AUDIO: return FD_AUDIO;
88         case AST_MEDIA_TYPE_VIDEO: return FD_VIDEO;
89         case AST_MEDIA_TYPE_TEXT:
90         case AST_MEDIA_TYPE_UNKNOWN:
91         case AST_MEDIA_TYPE_IMAGE: break;
92         }
93         return -1;
94 }
95
96 /*! \brief Remove all other cap types but the one given */
97 static void format_cap_only_type(struct ast_format_cap *caps, enum ast_media_type media_type)
98 {
99         int i = 0;
100         while (i <= AST_MEDIA_TYPE_TEXT) {
101                 if (i != media_type && i != AST_MEDIA_TYPE_UNKNOWN) {
102                         ast_format_cap_remove_by_type(caps, i);
103                 }
104                 i += 1;
105         }
106 }
107
108 static int send_keepalive(const void *data)
109 {
110         struct ast_sip_session_media *session_media = (struct ast_sip_session_media *) data;
111         struct ast_rtp_instance *rtp = session_media->rtp;
112         int keepalive;
113         time_t interval;
114         int send_keepalive;
115
116         if (!rtp) {
117                 return 0;
118         }
119
120         keepalive = ast_rtp_instance_get_keepalive(rtp);
121
122         if (!ast_sockaddr_isnull(&session_media->direct_media_addr)) {
123                 ast_debug(3, "Not sending RTP keepalive on RTP instance %p since direct media is in use\n", rtp);
124                 return keepalive * 1000;
125         }
126
127         interval = time(NULL) - ast_rtp_instance_get_last_tx(rtp);
128         send_keepalive = interval >= keepalive;
129
130         ast_debug(3, "It has been %d seconds since RTP was last sent on instance %p. %sending keepalive\n",
131                         (int) interval, rtp, send_keepalive ? "S" : "Not s");
132
133         if (send_keepalive) {
134                 ast_rtp_instance_sendcng(rtp, 0);
135                 return keepalive * 1000;
136         }
137
138         return (keepalive - interval) * 1000;
139 }
140
141 /*! \brief Check whether RTP is being received or not */
142 static int rtp_check_timeout(const void *data)
143 {
144         struct ast_sip_session_media *session_media = (struct ast_sip_session_media *)data;
145         struct ast_rtp_instance *rtp = session_media->rtp;
146         int elapsed;
147         struct ast_channel *chan;
148
149         if (!rtp) {
150                 return 0;
151         }
152
153         elapsed = time(NULL) - ast_rtp_instance_get_last_rx(rtp);
154         if (elapsed < ast_rtp_instance_get_timeout(rtp)) {
155                 return (ast_rtp_instance_get_timeout(rtp) - elapsed) * 1000;
156         }
157
158         chan = ast_channel_get_by_name(ast_rtp_instance_get_channel_id(rtp));
159         if (!chan) {
160                 return 0;
161         }
162
163         ast_log(LOG_NOTICE, "Disconnecting channel '%s' for lack of RTP activity in %d seconds\n",
164                 ast_channel_name(chan), elapsed);
165
166         ast_softhangup(chan, AST_SOFTHANGUP_DEV);
167         ast_channel_unref(chan);
168
169         return 0;
170 }
171
172 /*! \brief Internal function which creates an RTP instance */
173 static int create_rtp(struct ast_sip_session *session, struct ast_sip_session_media *session_media)
174 {
175         struct ast_rtp_engine_ice *ice;
176         struct ast_sockaddr temp_media_address;
177         struct ast_sockaddr *media_address =  &address_rtp;
178
179         if (session->endpoint->media.bind_rtp_to_media_address && !ast_strlen_zero(session->endpoint->media.address)) {
180                 ast_sockaddr_parse(&temp_media_address, session->endpoint->media.address, 0);
181                 media_address = &temp_media_address;
182         }
183
184         if (!(session_media->rtp = ast_rtp_instance_new(session->endpoint->media.rtp.engine, sched, media_address, NULL))) {
185                 ast_log(LOG_ERROR, "Unable to create RTP instance using RTP engine '%s'\n", session->endpoint->media.rtp.engine);
186                 return -1;
187         }
188
189         ast_rtp_instance_set_prop(session_media->rtp, AST_RTP_PROPERTY_RTCP, 1);
190         ast_rtp_instance_set_prop(session_media->rtp, AST_RTP_PROPERTY_NAT, session->endpoint->media.rtp.symmetric);
191
192         if (!session->endpoint->media.rtp.ice_support && (ice = ast_rtp_instance_get_ice(session_media->rtp))) {
193                 ice->stop(session_media->rtp);
194         }
195
196         if (session->endpoint->dtmf == AST_SIP_DTMF_RFC_4733 || session->endpoint->dtmf == AST_SIP_DTMF_AUTO) {
197                 ast_rtp_instance_dtmf_mode_set(session_media->rtp, AST_RTP_DTMF_MODE_RFC2833);
198                 ast_rtp_instance_set_prop(session_media->rtp, AST_RTP_PROPERTY_DTMF, 1);
199         } else if (session->endpoint->dtmf == AST_SIP_DTMF_INBAND) {
200                 ast_rtp_instance_dtmf_mode_set(session_media->rtp, AST_RTP_DTMF_MODE_INBAND);
201         }
202
203         if (!strcmp(session_media->stream_type, STR_AUDIO) &&
204                         (session->endpoint->media.tos_audio || session->endpoint->media.cos_video)) {
205                 ast_rtp_instance_set_qos(session_media->rtp, session->endpoint->media.tos_audio,
206                                 session->endpoint->media.cos_audio, "SIP RTP Audio");
207         } else if (!strcmp(session_media->stream_type, STR_VIDEO) &&
208                         (session->endpoint->media.tos_video || session->endpoint->media.cos_video)) {
209                 ast_rtp_instance_set_qos(session_media->rtp, session->endpoint->media.tos_video,
210                                 session->endpoint->media.cos_video, "SIP RTP Video");
211         }
212
213         ast_rtp_instance_set_last_rx(session_media->rtp, time(NULL));
214
215         return 0;
216 }
217
218 static void get_codecs(struct ast_sip_session *session, const struct pjmedia_sdp_media *stream, struct ast_rtp_codecs *codecs,
219        struct ast_sip_session_media *session_media)
220 {
221         pjmedia_sdp_attr *attr;
222         pjmedia_sdp_rtpmap *rtpmap;
223         pjmedia_sdp_fmtp fmtp;
224         struct ast_format *format;
225         int i, num = 0, tel_event = 0;
226         char name[256];
227         char media[20];
228         char fmt_param[256];
229         enum ast_rtp_options options = session->endpoint->media.g726_non_standard ?
230                 AST_RTP_OPT_G726_NONSTANDARD : 0;
231
232         ast_rtp_codecs_payloads_initialize(codecs);
233
234         /* Iterate through provided formats */
235         for (i = 0; i < stream->desc.fmt_count; ++i) {
236                 /* The payload is kept as a string for things like t38 but for video it is always numerical */
237                 ast_rtp_codecs_payloads_set_m_type(codecs, NULL, pj_strtoul(&stream->desc.fmt[i]));
238                 /* Look for the optional rtpmap attribute */
239                 if (!(attr = pjmedia_sdp_media_find_attr2(stream, "rtpmap", &stream->desc.fmt[i]))) {
240                         continue;
241                 }
242
243                 /* Interpret the attribute as an rtpmap */
244                 if ((pjmedia_sdp_attr_to_rtpmap(session->inv_session->pool_prov, attr, &rtpmap)) != PJ_SUCCESS) {
245                         continue;
246                 }
247
248                 ast_copy_pj_str(name, &rtpmap->enc_name, sizeof(name));
249                 if (strcmp(name, "telephone-event") == 0) {
250                         tel_event++;
251                 }
252
253                 ast_copy_pj_str(media, (pj_str_t*)&stream->desc.media, sizeof(media));
254                 ast_rtp_codecs_payloads_set_rtpmap_type_rate(codecs, NULL,
255                         pj_strtoul(&stream->desc.fmt[i]), media, name, options, rtpmap->clock_rate);
256                 /* Look for an optional associated fmtp attribute */
257                 if (!(attr = pjmedia_sdp_media_find_attr2(stream, "fmtp", &rtpmap->pt))) {
258                         continue;
259                 }
260
261                 if ((pjmedia_sdp_attr_get_fmtp(attr, &fmtp)) == PJ_SUCCESS) {
262                         ast_copy_pj_str(fmt_param, &fmtp.fmt, sizeof(fmt_param));
263                         if (sscanf(fmt_param, "%30d", &num) != 1) {
264                                 continue;
265                         }
266
267                         if ((format = ast_rtp_codecs_get_payload_format(codecs, num))) {
268                                 struct ast_format *format_parsed;
269
270                                 ast_copy_pj_str(fmt_param, &fmtp.fmt_param, sizeof(fmt_param));
271
272                                 format_parsed = ast_format_parse_sdp_fmtp(format, fmt_param);
273                                 if (format_parsed) {
274                                         ast_rtp_codecs_payload_replace_format(codecs, num, format_parsed);
275                                         ao2_ref(format_parsed, -1);
276                                 }
277
278                                 ao2_ref(format, -1);
279                         }
280                 }
281         }
282         if (!tel_event && (session->endpoint->dtmf == AST_SIP_DTMF_AUTO)) {
283                 ast_rtp_instance_dtmf_mode_set(session_media->rtp, AST_RTP_DTMF_MODE_INBAND);
284         }
285         /* Get the packetization, if it exists */
286         if ((attr = pjmedia_sdp_media_find_attr2(stream, "ptime", NULL))) {
287                 unsigned long framing = pj_strtoul(pj_strltrim(&attr->value));
288                 if (framing && session->endpoint->media.rtp.use_ptime) {
289                         ast_rtp_codecs_set_framing(codecs, framing);
290                 }
291         }
292 }
293
294 static int set_caps(struct ast_sip_session *session,
295         struct ast_sip_session_media *session_media,
296         const struct pjmedia_sdp_media *stream,
297         int is_offer)
298 {
299         RAII_VAR(struct ast_format_cap *, caps, NULL, ao2_cleanup);
300         RAII_VAR(struct ast_format_cap *, peer, NULL, ao2_cleanup);
301         RAII_VAR(struct ast_format_cap *, joint, NULL, ao2_cleanup);
302         enum ast_media_type media_type = stream_to_media_type(session_media->stream_type);
303         struct ast_rtp_codecs codecs = AST_RTP_CODECS_NULL_INIT;
304         int fmts = 0;
305         int direct_media_enabled = !ast_sockaddr_isnull(&session_media->direct_media_addr) &&
306                 ast_format_cap_count(session->direct_media_cap);
307         int dsp_features = 0;
308
309         if (!(caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT)) ||
310             !(peer = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT)) ||
311             !(joint = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
312                 ast_log(LOG_ERROR, "Failed to allocate %s capabilities\n", session_media->stream_type);
313                 return -1;
314         }
315
316         /* get the endpoint capabilities */
317         if (direct_media_enabled) {
318                 ast_format_cap_get_compatible(session->endpoint->media.codecs, session->direct_media_cap, caps);
319                 format_cap_only_type(caps, media_type);
320         } else {
321                 ast_format_cap_append_from_cap(caps, session->endpoint->media.codecs, media_type);
322         }
323
324         /* get the capabilities on the peer */
325         get_codecs(session, stream, &codecs,  session_media);
326         ast_rtp_codecs_payload_formats(&codecs, peer, &fmts);
327
328         /* get the joint capabilities between peer and endpoint */
329         ast_format_cap_get_compatible(caps, peer, joint);
330         if (!ast_format_cap_count(joint)) {
331                 struct ast_str *usbuf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
332                 struct ast_str *thembuf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
333
334                 ast_rtp_codecs_payloads_destroy(&codecs);
335                 ast_log(LOG_NOTICE, "No joint capabilities for '%s' media stream between our configuration(%s) and incoming SDP(%s)\n",
336                         session_media->stream_type,
337                         ast_format_cap_get_names(caps, &usbuf),
338                         ast_format_cap_get_names(peer, &thembuf));
339                 return -1;
340         }
341
342         if (is_offer) {
343                 /*
344                  * Setup rx payload type mapping to prefer the mapping
345                  * from the peer that the RFC says we SHOULD use.
346                  */
347                 ast_rtp_codecs_payloads_xover(&codecs, &codecs, NULL);
348         }
349         ast_rtp_codecs_payloads_copy(&codecs, ast_rtp_instance_get_codecs(session_media->rtp),
350                 session_media->rtp);
351
352         ast_format_cap_append_from_cap(session->req_caps, joint, AST_MEDIA_TYPE_UNKNOWN);
353
354         if (session->channel) {
355                 ast_channel_lock(session->channel);
356                 ast_format_cap_remove_by_type(caps, AST_MEDIA_TYPE_UNKNOWN);
357                 ast_format_cap_append_from_cap(caps, ast_channel_nativeformats(session->channel),
358                         AST_MEDIA_TYPE_UNKNOWN);
359                 ast_format_cap_remove_by_type(caps, media_type);
360                 if (session->endpoint->preferred_codec_only){
361                         struct ast_format *preferred_fmt = ast_format_cap_get_format(joint, 0);
362                         ast_format_cap_append(caps, preferred_fmt, 0);
363                         ao2_ref(preferred_fmt, -1);
364                 } else {
365                         ast_format_cap_append_from_cap(caps, joint, media_type);
366                 }
367                 /*
368                  * Apply the new formats to the channel, potentially changing
369                  * raw read/write formats and translation path while doing so.
370                  */
371                 ast_channel_nativeformats_set(session->channel, caps);
372                 if (media_type == AST_MEDIA_TYPE_AUDIO) {
373                         ast_set_read_format(session->channel, ast_channel_readformat(session->channel));
374                         ast_set_write_format(session->channel, ast_channel_writeformat(session->channel));
375                 }
376                 if ((session->endpoint->dtmf == AST_SIP_DTMF_AUTO)
377                     && (ast_rtp_instance_dtmf_mode_get(session_media->rtp) == AST_RTP_DTMF_MODE_RFC2833)
378                     && (session->dsp)) {
379                         dsp_features = ast_dsp_get_features(session->dsp);
380                         dsp_features &= ~DSP_FEATURE_DIGIT_DETECT;
381                         if (dsp_features) {
382                                 ast_dsp_set_features(session->dsp, dsp_features);
383                         } else {
384                                 ast_dsp_free(session->dsp);
385                                 session->dsp = NULL;
386                         }
387                 }
388
389                 if (ast_channel_is_bridged(session->channel)) {
390                         ast_channel_set_unbridged_nolock(session->channel, 1);
391                 }
392
393                 ast_channel_unlock(session->channel);
394         }
395
396         ast_rtp_codecs_payloads_destroy(&codecs);
397         return 0;
398 }
399
400 static pjmedia_sdp_attr* generate_rtpmap_attr(struct ast_sip_session *session, pjmedia_sdp_media *media, pj_pool_t *pool,
401                                               int rtp_code, int asterisk_format, struct ast_format *format, int code)
402 {
403         pjmedia_sdp_rtpmap rtpmap;
404         pjmedia_sdp_attr *attr = NULL;
405         char tmp[64];
406         enum ast_rtp_options options = session->endpoint->media.g726_non_standard ?
407                 AST_RTP_OPT_G726_NONSTANDARD : 0;
408
409         snprintf(tmp, sizeof(tmp), "%d", rtp_code);
410         pj_strdup2(pool, &media->desc.fmt[media->desc.fmt_count++], tmp);
411         rtpmap.pt = media->desc.fmt[media->desc.fmt_count - 1];
412         rtpmap.clock_rate = ast_rtp_lookup_sample_rate2(asterisk_format, format, code);
413         pj_strdup2(pool, &rtpmap.enc_name, ast_rtp_lookup_mime_subtype2(asterisk_format, format, code, options));
414         if (!pj_stricmp2(&rtpmap.enc_name, "opus")) {
415                 pj_cstr(&rtpmap.param, "2");
416         } else {
417                 pj_cstr(&rtpmap.param, NULL);
418         }
419
420         pjmedia_sdp_rtpmap_to_attr(pool, &rtpmap, &attr);
421
422         return attr;
423 }
424
425 static pjmedia_sdp_attr* generate_fmtp_attr(pj_pool_t *pool, struct ast_format *format, int rtp_code)
426 {
427         struct ast_str *fmtp0 = ast_str_alloca(256);
428         pj_str_t fmtp1;
429         pjmedia_sdp_attr *attr = NULL;
430         char *tmp;
431
432         ast_format_generate_sdp_fmtp(format, rtp_code, &fmtp0);
433         if (ast_str_strlen(fmtp0)) {
434                 tmp = ast_str_buffer(fmtp0) + ast_str_strlen(fmtp0) - 1;
435                 /* remove any carriage return line feeds */
436                 while (*tmp == '\r' || *tmp == '\n') --tmp;
437                 *++tmp = '\0';
438                 /* ast...generate gives us everything, just need value */
439                 tmp = strchr(ast_str_buffer(fmtp0), ':');
440                 if (tmp && tmp[1] != '\0') {
441                         fmtp1 = pj_str(tmp + 1);
442                 } else {
443                         fmtp1 = pj_str(ast_str_buffer(fmtp0));
444                 }
445                 attr = pjmedia_sdp_attr_create(pool, "fmtp", &fmtp1);
446         }
447         return attr;
448 }
449
450 /*! \brief Function which adds ICE attributes to a media stream */
451 static void add_ice_to_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media, pj_pool_t *pool, pjmedia_sdp_media *media)
452 {
453         struct ast_rtp_engine_ice *ice;
454         struct ao2_container *candidates;
455         const char *username, *password;
456         pj_str_t stmp;
457         pjmedia_sdp_attr *attr;
458         struct ao2_iterator it_candidates;
459         struct ast_rtp_engine_ice_candidate *candidate;
460
461         if (!session->endpoint->media.rtp.ice_support || !(ice = ast_rtp_instance_get_ice(session_media->rtp)) ||
462                 !(candidates = ice->get_local_candidates(session_media->rtp))) {
463                 return;
464         }
465
466         if ((username = ice->get_ufrag(session_media->rtp))) {
467                 attr = pjmedia_sdp_attr_create(pool, "ice-ufrag", pj_cstr(&stmp, username));
468                 media->attr[media->attr_count++] = attr;
469         }
470
471         if ((password = ice->get_password(session_media->rtp))) {
472                 attr = pjmedia_sdp_attr_create(pool, "ice-pwd", pj_cstr(&stmp, password));
473                 media->attr[media->attr_count++] = attr;
474         }
475
476         it_candidates = ao2_iterator_init(candidates, 0);
477         for (; (candidate = ao2_iterator_next(&it_candidates)); ao2_ref(candidate, -1)) {
478                 struct ast_str *attr_candidate = ast_str_create(128);
479
480                 ast_str_set(&attr_candidate, -1, "%s %u %s %d %s ", candidate->foundation, candidate->id, candidate->transport,
481                                         candidate->priority, ast_sockaddr_stringify_addr_remote(&candidate->address));
482                 ast_str_append(&attr_candidate, -1, "%s typ ", ast_sockaddr_stringify_port(&candidate->address));
483
484                 switch (candidate->type) {
485                         case AST_RTP_ICE_CANDIDATE_TYPE_HOST:
486                                 ast_str_append(&attr_candidate, -1, "host");
487                                 break;
488                         case AST_RTP_ICE_CANDIDATE_TYPE_SRFLX:
489                                 ast_str_append(&attr_candidate, -1, "srflx");
490                                 break;
491                         case AST_RTP_ICE_CANDIDATE_TYPE_RELAYED:
492                                 ast_str_append(&attr_candidate, -1, "relay");
493                                 break;
494                 }
495
496                 if (!ast_sockaddr_isnull(&candidate->relay_address)) {
497                         ast_str_append(&attr_candidate, -1, " raddr %s rport", ast_sockaddr_stringify_addr_remote(&candidate->relay_address));
498                         ast_str_append(&attr_candidate, -1, " %s", ast_sockaddr_stringify_port(&candidate->relay_address));
499                 }
500
501                 attr = pjmedia_sdp_attr_create(pool, "candidate", pj_cstr(&stmp, ast_str_buffer(attr_candidate)));
502                 media->attr[media->attr_count++] = attr;
503
504                 ast_free(attr_candidate);
505         }
506
507         ao2_iterator_destroy(&it_candidates);
508         ao2_ref(candidates, -1);
509 }
510
511 /*! \brief Function which processes ICE attributes in an audio stream */
512 static void process_ice_attributes(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
513                                    const struct pjmedia_sdp_session *remote, const struct pjmedia_sdp_media *remote_stream)
514 {
515         struct ast_rtp_engine_ice *ice;
516         const pjmedia_sdp_attr *attr;
517         char attr_value[256];
518         unsigned int attr_i;
519
520         /* If ICE support is not enabled or available exit early */
521         if (!session->endpoint->media.rtp.ice_support || !(ice = ast_rtp_instance_get_ice(session_media->rtp))) {
522                 return;
523         }
524
525         attr = pjmedia_sdp_media_find_attr2(remote_stream, "ice-ufrag", NULL);
526         if (!attr) {
527                 attr = pjmedia_sdp_attr_find2(remote->attr_count, remote->attr, "ice-ufrag", NULL);
528         }
529         if (attr) {
530                 ast_copy_pj_str(attr_value, (pj_str_t*)&attr->value, sizeof(attr_value));
531                 ice->set_authentication(session_media->rtp, attr_value, NULL);
532         } else {
533                 return;
534         }
535
536         attr = pjmedia_sdp_media_find_attr2(remote_stream, "ice-pwd", NULL);
537         if (!attr) {
538                 attr = pjmedia_sdp_attr_find2(remote->attr_count, remote->attr, "ice-pwd", NULL);
539         }
540         if (attr) {
541                 ast_copy_pj_str(attr_value, (pj_str_t*)&attr->value, sizeof(attr_value));
542                 ice->set_authentication(session_media->rtp, NULL, attr_value);
543         } else {
544                 return;
545         }
546
547         if (pjmedia_sdp_media_find_attr2(remote_stream, "ice-lite", NULL)) {
548                 ice->ice_lite(session_media->rtp);
549         }
550
551         /* Find all of the candidates */
552         for (attr_i = 0; attr_i < remote_stream->attr_count; ++attr_i) {
553                 char foundation[32], transport[32], address[PJ_INET6_ADDRSTRLEN + 1], cand_type[6], relay_address[PJ_INET6_ADDRSTRLEN + 1] = "";
554                 unsigned int port, relay_port = 0;
555                 struct ast_rtp_engine_ice_candidate candidate = { 0, };
556
557                 attr = remote_stream->attr[attr_i];
558
559                 /* If this is not a candidate line skip it */
560                 if (pj_strcmp2(&attr->name, "candidate")) {
561                         continue;
562                 }
563
564                 ast_copy_pj_str(attr_value, (pj_str_t*)&attr->value, sizeof(attr_value));
565
566                 if (sscanf(attr_value, "%31s %30u %31s %30u %46s %30u typ %5s %*s %23s %*s %30u", foundation, &candidate.id, transport,
567                         (unsigned *)&candidate.priority, address, &port, cand_type, relay_address, &relay_port) < 7) {
568                         /* Candidate did not parse properly */
569                         continue;
570                 }
571
572                 candidate.foundation = foundation;
573                 candidate.transport = transport;
574
575                 ast_sockaddr_parse(&candidate.address, address, PARSE_PORT_FORBID);
576                 ast_sockaddr_set_port(&candidate.address, port);
577
578                 if (!strcasecmp(cand_type, "host")) {
579                         candidate.type = AST_RTP_ICE_CANDIDATE_TYPE_HOST;
580                 } else if (!strcasecmp(cand_type, "srflx")) {
581                         candidate.type = AST_RTP_ICE_CANDIDATE_TYPE_SRFLX;
582                 } else if (!strcasecmp(cand_type, "relay")) {
583                         candidate.type = AST_RTP_ICE_CANDIDATE_TYPE_RELAYED;
584                 } else {
585                         continue;
586                 }
587
588                 if (!ast_strlen_zero(relay_address)) {
589                         ast_sockaddr_parse(&candidate.relay_address, relay_address, PARSE_PORT_FORBID);
590                 }
591
592                 if (relay_port) {
593                         ast_sockaddr_set_port(&candidate.relay_address, relay_port);
594                 }
595
596                 ice->add_remote_candidate(session_media->rtp, &candidate);
597         }
598
599         ice->set_role(session_media->rtp, pjmedia_sdp_neg_was_answer_remote(session->inv_session->neg) == PJ_TRUE ?
600                 AST_RTP_ICE_ROLE_CONTROLLING : AST_RTP_ICE_ROLE_CONTROLLED);
601         ice->start(session_media->rtp);
602 }
603
604 /*! \brief figure out if media stream has crypto lines for sdes */
605 static int media_stream_has_crypto(const struct pjmedia_sdp_media *stream)
606 {
607         int i;
608
609         for (i = 0; i < stream->attr_count; i++) {
610                 pjmedia_sdp_attr *attr;
611
612                 /* check the stream for the required crypto attribute */
613                 attr = stream->attr[i];
614                 if (pj_strcmp2(&attr->name, "crypto")) {
615                         continue;
616                 }
617
618                 return 1;
619         }
620
621         return 0;
622 }
623
624 /*! \brief figure out media transport encryption type from the media transport string */
625 static enum ast_sip_session_media_encryption get_media_encryption_type(pj_str_t transport,
626         const struct pjmedia_sdp_media *stream, unsigned int *optimistic)
627 {
628         RAII_VAR(char *, transport_str, ast_strndup(transport.ptr, transport.slen), ast_free);
629
630         *optimistic = 0;
631
632         if (!transport_str) {
633                 return AST_SIP_MEDIA_TRANSPORT_INVALID;
634         }
635         if (strstr(transport_str, "UDP/TLS")) {
636                 return AST_SIP_MEDIA_ENCRYPT_DTLS;
637         } else if (strstr(transport_str, "SAVP")) {
638                 return AST_SIP_MEDIA_ENCRYPT_SDES;
639         } else if (media_stream_has_crypto(stream)) {
640                 *optimistic = 1;
641                 return AST_SIP_MEDIA_ENCRYPT_SDES;
642         } else {
643                 return AST_SIP_MEDIA_ENCRYPT_NONE;
644         }
645 }
646
647 /*!
648  * \brief Checks whether the encryption offered in SDP is compatible with the endpoint's configuration
649  * \internal
650  *
651  * \param endpoint_encryption Media encryption configured for the endpoint
652  * \param stream pjmedia_sdp_media stream description
653  *
654  * \retval AST_SIP_MEDIA_TRANSPORT_INVALID on encryption mismatch
655  * \retval The encryption requested in the SDP
656  */
657 static enum ast_sip_session_media_encryption check_endpoint_media_transport(
658         struct ast_sip_endpoint *endpoint,
659         const struct pjmedia_sdp_media *stream)
660 {
661         enum ast_sip_session_media_encryption incoming_encryption;
662         char transport_end = stream->desc.transport.ptr[stream->desc.transport.slen - 1];
663         unsigned int optimistic;
664
665         if ((transport_end == 'F' && !endpoint->media.rtp.use_avpf)
666                 || (transport_end != 'F' && endpoint->media.rtp.use_avpf)) {
667                 return AST_SIP_MEDIA_TRANSPORT_INVALID;
668         }
669
670         incoming_encryption = get_media_encryption_type(stream->desc.transport, stream, &optimistic);
671
672         if (incoming_encryption == endpoint->media.rtp.encryption) {
673                 return incoming_encryption;
674         }
675
676         if (endpoint->media.rtp.force_avp ||
677                 endpoint->media.rtp.encryption_optimistic) {
678                 return incoming_encryption;
679         }
680
681         /* If an optimistic offer has been made but encryption is not enabled consider it as having
682          * no offer of crypto at all instead of invalid so the session proceeds.
683          */
684         if (optimistic) {
685                 return AST_SIP_MEDIA_ENCRYPT_NONE;
686         }
687
688         return AST_SIP_MEDIA_TRANSPORT_INVALID;
689 }
690
691 static int setup_srtp(struct ast_sip_session_media *session_media)
692 {
693         if (!session_media->srtp) {
694                 session_media->srtp = ast_sdp_srtp_alloc();
695                 if (!session_media->srtp) {
696                         return -1;
697                 }
698         }
699
700         if (!session_media->srtp->crypto) {
701                 session_media->srtp->crypto = ast_sdp_crypto_alloc();
702                 if (!session_media->srtp->crypto) {
703                         return -1;
704                 }
705         }
706
707         return 0;
708 }
709
710 static int setup_dtls_srtp(struct ast_sip_session *session,
711         struct ast_sip_session_media *session_media)
712 {
713         struct ast_rtp_engine_dtls *dtls;
714
715         if (!session->endpoint->media.rtp.dtls_cfg.enabled || !session_media->rtp) {
716                 return -1;
717         }
718
719         dtls = ast_rtp_instance_get_dtls(session_media->rtp);
720         if (!dtls) {
721                 return -1;
722         }
723
724         session->endpoint->media.rtp.dtls_cfg.suite = ((session->endpoint->media.rtp.srtp_tag_32) ? AST_AES_CM_128_HMAC_SHA1_32 : AST_AES_CM_128_HMAC_SHA1_80);
725         if (dtls->set_configuration(session_media->rtp, &session->endpoint->media.rtp.dtls_cfg)) {
726                 ast_log(LOG_ERROR, "Attempted to set an invalid DTLS-SRTP configuration on RTP instance '%p'\n",
727                         session_media->rtp);
728                 return -1;
729         }
730
731         if (setup_srtp(session_media)) {
732                 return -1;
733         }
734         return 0;
735 }
736
737 static void apply_dtls_attrib(struct ast_sip_session_media *session_media,
738         pjmedia_sdp_attr *attr)
739 {
740         struct ast_rtp_engine_dtls *dtls = ast_rtp_instance_get_dtls(session_media->rtp);
741         pj_str_t *value;
742
743         if (!attr->value.ptr) {
744                 return;
745         }
746
747         value = pj_strtrim(&attr->value);
748
749         if (!pj_strcmp2(&attr->name, "setup")) {
750                 if (!pj_stricmp2(value, "active")) {
751                         dtls->set_setup(session_media->rtp, AST_RTP_DTLS_SETUP_ACTIVE);
752                 } else if (!pj_stricmp2(value, "passive")) {
753                         dtls->set_setup(session_media->rtp, AST_RTP_DTLS_SETUP_PASSIVE);
754                 } else if (!pj_stricmp2(value, "actpass")) {
755                         dtls->set_setup(session_media->rtp, AST_RTP_DTLS_SETUP_ACTPASS);
756                 } else if (!pj_stricmp2(value, "holdconn")) {
757                         dtls->set_setup(session_media->rtp, AST_RTP_DTLS_SETUP_HOLDCONN);
758                 } else {
759                         ast_log(LOG_WARNING, "Unsupported setup attribute value '%*s'\n", (int)value->slen, value->ptr);
760                 }
761         } else if (!pj_strcmp2(&attr->name, "connection")) {
762                 if (!pj_stricmp2(value, "new")) {
763                         dtls->reset(session_media->rtp);
764                 } else if (!pj_stricmp2(value, "existing")) {
765                         /* Do nothing */
766                 } else {
767                         ast_log(LOG_WARNING, "Unsupported connection attribute value '%*s'\n", (int)value->slen, value->ptr);
768                 }
769         } else if (!pj_strcmp2(&attr->name, "fingerprint")) {
770                 char hash_value[256], hash[32];
771                 char fingerprint_text[value->slen + 1];
772                 ast_copy_pj_str(fingerprint_text, value, sizeof(fingerprint_text));
773                         if (sscanf(fingerprint_text, "%31s %255s", hash, hash_value) == 2) {
774                         if (!strcasecmp(hash, "sha-1")) {
775                                 dtls->set_fingerprint(session_media->rtp, AST_RTP_DTLS_HASH_SHA1, hash_value);
776                         } else if (!strcasecmp(hash, "sha-256")) {
777                                 dtls->set_fingerprint(session_media->rtp, AST_RTP_DTLS_HASH_SHA256, hash_value);
778                         } else {
779                                 ast_log(LOG_WARNING, "Unsupported fingerprint hash type '%s'\n",
780                                 hash);
781                         }
782                 }
783         }
784 }
785
786 static int parse_dtls_attrib(struct ast_sip_session_media *session_media,
787         const struct pjmedia_sdp_session *sdp,
788         const struct pjmedia_sdp_media *stream)
789 {
790         int i;
791
792         for (i = 0; i < sdp->attr_count; i++) {
793                 apply_dtls_attrib(session_media, sdp->attr[i]);
794         }
795
796         for (i = 0; i < stream->attr_count; i++) {
797                 apply_dtls_attrib(session_media, stream->attr[i]);
798         }
799
800         ast_set_flag(session_media->srtp, AST_SRTP_CRYPTO_OFFER_OK);
801
802         return 0;
803 }
804
805 static int setup_sdes_srtp(struct ast_sip_session_media *session_media,
806         const struct pjmedia_sdp_media *stream)
807 {
808         int i;
809
810         for (i = 0; i < stream->attr_count; i++) {
811                 pjmedia_sdp_attr *attr;
812                 RAII_VAR(char *, crypto_str, NULL, ast_free);
813
814                 /* check the stream for the required crypto attribute */
815                 attr = stream->attr[i];
816                 if (pj_strcmp2(&attr->name, "crypto")) {
817                         continue;
818                 }
819
820                 crypto_str = ast_strndup(attr->value.ptr, attr->value.slen);
821                 if (!crypto_str) {
822                         return -1;
823                 }
824
825                 if (setup_srtp(session_media)) {
826                         return -1;
827                 }
828
829                 if (!ast_sdp_crypto_process(session_media->rtp, session_media->srtp, crypto_str)) {
830                         /* found a valid crypto attribute */
831                         return 0;
832                 }
833
834                 ast_debug(1, "Ignoring crypto offer with unsupported parameters: %s\n", crypto_str);
835         }
836
837         /* no usable crypto attributes found */
838         return -1;
839 }
840
841 static int setup_media_encryption(struct ast_sip_session *session,
842         struct ast_sip_session_media *session_media,
843         const struct pjmedia_sdp_session *sdp,
844         const struct pjmedia_sdp_media *stream)
845 {
846         switch (session_media->encryption) {
847         case AST_SIP_MEDIA_ENCRYPT_SDES:
848                 if (setup_sdes_srtp(session_media, stream)) {
849                         return -1;
850                 }
851                 break;
852         case AST_SIP_MEDIA_ENCRYPT_DTLS:
853                 if (setup_dtls_srtp(session, session_media)) {
854                         return -1;
855                 }
856                 if (parse_dtls_attrib(session_media, sdp, stream)) {
857                         return -1;
858                 }
859                 break;
860         case AST_SIP_MEDIA_TRANSPORT_INVALID:
861         case AST_SIP_MEDIA_ENCRYPT_NONE:
862                 break;
863         }
864
865         return 0;
866 }
867
868 /*! \brief Function which negotiates an incoming media stream */
869 static int negotiate_incoming_sdp_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
870                                          const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream)
871 {
872         char host[NI_MAXHOST];
873         RAII_VAR(struct ast_sockaddr *, addrs, NULL, ast_free);
874         enum ast_media_type media_type = stream_to_media_type(session_media->stream_type);
875         enum ast_sip_session_media_encryption encryption = AST_SIP_MEDIA_ENCRYPT_NONE;
876         int res;
877
878         /* If port is 0, ignore this media stream */
879         if (!stream->desc.port) {
880                 ast_debug(3, "Media stream '%s' is already declined\n", session_media->stream_type);
881                 return 0;
882         }
883
884         /* If no type formats have been configured reject this stream */
885         if (!ast_format_cap_has_type(session->endpoint->media.codecs, media_type)) {
886                 ast_debug(3, "Endpoint has no codecs for media type '%s', declining stream\n", session_media->stream_type);
887                 return 0;
888         }
889
890         /* Ensure incoming transport is compatible with the endpoint's configuration */
891         if (!session->endpoint->media.rtp.use_received_transport) {
892                 encryption = check_endpoint_media_transport(session->endpoint, stream);
893
894                 if (encryption == AST_SIP_MEDIA_TRANSPORT_INVALID) {
895                         return -1;
896                 }
897         }
898
899         ast_copy_pj_str(host, stream->conn ? &stream->conn->addr : &sdp->conn->addr, sizeof(host));
900
901         /* Ensure that the address provided is valid */
902         if (ast_sockaddr_resolve(&addrs, host, PARSE_PORT_FORBID, AST_AF_UNSPEC) <= 0) {
903                 /* The provided host was actually invalid so we error out this negotiation */
904                 return -1;
905         }
906
907         /* Using the connection information create an appropriate RTP instance */
908         if (!session_media->rtp && create_rtp(session, session_media)) {
909                 return -1;
910         }
911
912         res = setup_media_encryption(session, session_media, sdp, stream);
913         if (res) {
914                 if (!session->endpoint->media.rtp.encryption_optimistic) {
915                         /* If optimistic encryption is disabled and crypto should have been enabled
916                          * but was not this session must fail.
917                          */
918                         return -1;
919                 }
920                 /* There is no encryption, sad. */
921                 session_media->encryption = AST_SIP_MEDIA_ENCRYPT_NONE;
922         }
923
924         /* If we've been explicitly configured to use the received transport OR if
925          * encryption is on and crypto is present use the received transport.
926          * This is done in case of optimistic because it may come in as RTP/AVP or RTP/SAVP depending
927          * on the configuration of the remote endpoint (optimistic themselves or mandatory).
928          */
929         if ((session->endpoint->media.rtp.use_received_transport) ||
930                 ((encryption == AST_SIP_MEDIA_ENCRYPT_SDES) && !res)) {
931                 pj_strdup(session->inv_session->pool, &session_media->transport, &stream->desc.transport);
932         }
933
934         if (set_caps(session, session_media, stream, 1)) {
935                 return 0;
936         }
937         return 1;
938 }
939
940 static int add_crypto_to_stream(struct ast_sip_session *session,
941         struct ast_sip_session_media *session_media,
942         pj_pool_t *pool, pjmedia_sdp_media *media)
943 {
944         pj_str_t stmp;
945         pjmedia_sdp_attr *attr;
946         enum ast_rtp_dtls_hash hash;
947         const char *crypto_attribute;
948         struct ast_rtp_engine_dtls *dtls;
949         struct ast_sdp_srtp *tmp;
950         static const pj_str_t STR_NEW = { "new", 3 };
951         static const pj_str_t STR_EXISTING = { "existing", 8 };
952         static const pj_str_t STR_ACTIVE = { "active", 6 };
953         static const pj_str_t STR_PASSIVE = { "passive", 7 };
954         static const pj_str_t STR_ACTPASS = { "actpass", 7 };
955         static const pj_str_t STR_HOLDCONN = { "holdconn", 8 };
956
957         switch (session_media->encryption) {
958         case AST_SIP_MEDIA_ENCRYPT_NONE:
959         case AST_SIP_MEDIA_TRANSPORT_INVALID:
960                 break;
961         case AST_SIP_MEDIA_ENCRYPT_SDES:
962                 if (!session_media->srtp) {
963                         session_media->srtp = ast_sdp_srtp_alloc();
964                         if (!session_media->srtp) {
965                                 return -1;
966                         }
967                 }
968
969                 tmp = session_media->srtp;
970
971                 do {
972                         crypto_attribute = ast_sdp_srtp_get_attrib(tmp,
973                                 0 /* DTLS running? No */,
974                                 session->endpoint->media.rtp.srtp_tag_32 /* 32 byte tag length? */);
975                         if (!crypto_attribute) {
976                                 /* No crypto attribute to add, bad news */
977                                 return -1;
978                         }
979
980                         attr = pjmedia_sdp_attr_create(pool, "crypto",
981                                 pj_cstr(&stmp, crypto_attribute));
982                         media->attr[media->attr_count++] = attr;
983                 } while ((tmp = AST_LIST_NEXT(tmp, sdp_srtp_list)));
984
985                 break;
986         case AST_SIP_MEDIA_ENCRYPT_DTLS:
987                 if (setup_dtls_srtp(session, session_media)) {
988                         return -1;
989                 }
990
991                 dtls = ast_rtp_instance_get_dtls(session_media->rtp);
992                 if (!dtls) {
993                         return -1;
994                 }
995
996                 switch (dtls->get_connection(session_media->rtp)) {
997                 case AST_RTP_DTLS_CONNECTION_NEW:
998                         attr = pjmedia_sdp_attr_create(pool, "connection", &STR_NEW);
999                         media->attr[media->attr_count++] = attr;
1000                         break;
1001                 case AST_RTP_DTLS_CONNECTION_EXISTING:
1002                         attr = pjmedia_sdp_attr_create(pool, "connection", &STR_EXISTING);
1003                         media->attr[media->attr_count++] = attr;
1004                         break;
1005                 default:
1006                         break;
1007                 }
1008
1009                 switch (dtls->get_setup(session_media->rtp)) {
1010                 case AST_RTP_DTLS_SETUP_ACTIVE:
1011                         attr = pjmedia_sdp_attr_create(pool, "setup", &STR_ACTIVE);
1012                         media->attr[media->attr_count++] = attr;
1013                         break;
1014                 case AST_RTP_DTLS_SETUP_PASSIVE:
1015                         attr = pjmedia_sdp_attr_create(pool, "setup", &STR_PASSIVE);
1016                         media->attr[media->attr_count++] = attr;
1017                         break;
1018                 case AST_RTP_DTLS_SETUP_ACTPASS:
1019                         attr = pjmedia_sdp_attr_create(pool, "setup", &STR_ACTPASS);
1020                         media->attr[media->attr_count++] = attr;
1021                         break;
1022                 case AST_RTP_DTLS_SETUP_HOLDCONN:
1023                         attr = pjmedia_sdp_attr_create(pool, "setup", &STR_HOLDCONN);
1024                         media->attr[media->attr_count++] = attr;
1025                         break;
1026                 default:
1027                         break;
1028                 }
1029
1030                 hash = dtls->get_fingerprint_hash(session_media->rtp);
1031                 crypto_attribute = dtls->get_fingerprint(session_media->rtp);
1032                 if (crypto_attribute && (hash == AST_RTP_DTLS_HASH_SHA1 || hash == AST_RTP_DTLS_HASH_SHA256)) {
1033                         RAII_VAR(struct ast_str *, fingerprint, ast_str_create(64), ast_free);
1034                         if (!fingerprint) {
1035                                 return -1;
1036                         }
1037
1038                         if (hash == AST_RTP_DTLS_HASH_SHA1) {
1039                                 ast_str_set(&fingerprint, 0, "SHA-1 %s", crypto_attribute);
1040                         } else {
1041                                 ast_str_set(&fingerprint, 0, "SHA-256 %s", crypto_attribute);
1042                         }
1043
1044                         attr = pjmedia_sdp_attr_create(pool, "fingerprint", pj_cstr(&stmp, ast_str_buffer(fingerprint)));
1045                         media->attr[media->attr_count++] = attr;
1046                 }
1047                 break;
1048         }
1049
1050         return 0;
1051 }
1052
1053 /*! \brief Function which creates an outgoing stream */
1054 static int create_outgoing_sdp_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
1055                                       struct pjmedia_sdp_session *sdp)
1056 {
1057         pj_pool_t *pool = session->inv_session->pool_prov;
1058         static const pj_str_t STR_IN = { "IN", 2 };
1059         static const pj_str_t STR_IP4 = { "IP4", 3};
1060         static const pj_str_t STR_IP6 = { "IP6", 3};
1061         static const pj_str_t STR_SENDRECV = { "sendrecv", 8 };
1062         static const pj_str_t STR_SENDONLY = { "sendonly", 8 };
1063         pjmedia_sdp_media *media;
1064         const char *hostip = NULL;
1065         struct ast_sockaddr addr;
1066         char tmp[512];
1067         pj_str_t stmp;
1068         pjmedia_sdp_attr *attr;
1069         int index = 0;
1070         int noncodec = (session->endpoint->dtmf == AST_SIP_DTMF_RFC_4733 || session->endpoint->dtmf == AST_SIP_DTMF_AUTO) ? AST_RTP_DTMF : 0;
1071         int min_packet_size = 0, max_packet_size = 0;
1072         int rtp_code;
1073         RAII_VAR(struct ast_format_cap *, caps, NULL, ao2_cleanup);
1074         enum ast_media_type media_type = stream_to_media_type(session_media->stream_type);
1075         int use_override_prefs = ast_format_cap_count(session->req_caps);
1076
1077         int direct_media_enabled = !ast_sockaddr_isnull(&session_media->direct_media_addr) &&
1078                 ast_format_cap_count(session->direct_media_cap);
1079
1080         if ((use_override_prefs && !ast_format_cap_has_type(session->req_caps, media_type)) ||
1081             (!use_override_prefs && !ast_format_cap_has_type(session->endpoint->media.codecs, media_type))) {
1082                 /* If no type formats are configured don't add a stream */
1083                 return 0;
1084         } else if (!session_media->rtp && create_rtp(session, session_media)) {
1085                 return -1;
1086         }
1087
1088         if (!(media = pj_pool_zalloc(pool, sizeof(struct pjmedia_sdp_media))) ||
1089                 !(media->conn = pj_pool_zalloc(pool, sizeof(struct pjmedia_sdp_conn)))) {
1090                 return -1;
1091         }
1092
1093         if (add_crypto_to_stream(session, session_media, pool, media)) {
1094                 return -1;
1095         }
1096
1097         media->desc.media = pj_str(session_media->stream_type);
1098         if (pj_strlen(&session_media->transport)) {
1099                 /* If a transport has already been specified use it */
1100                 media->desc.transport = session_media->transport;
1101         } else {
1102                 media->desc.transport = pj_str(ast_sdp_get_rtp_profile(
1103                         /* Optimistic encryption places crypto in the normal RTP/AVP profile */
1104                         !session->endpoint->media.rtp.encryption_optimistic &&
1105                                 (session_media->encryption == AST_SIP_MEDIA_ENCRYPT_SDES),
1106                         session_media->rtp, session->endpoint->media.rtp.use_avpf,
1107                         session->endpoint->media.rtp.force_avp));
1108         }
1109
1110         /* Add connection level details */
1111         if (direct_media_enabled) {
1112                 hostip = ast_sockaddr_stringify_fmt(&session_media->direct_media_addr, AST_SOCKADDR_STR_ADDR);
1113         } else if (ast_strlen_zero(session->endpoint->media.address)) {
1114                 hostip = ast_sip_get_host_ip_string(session->endpoint->media.rtp.ipv6 ? pj_AF_INET6() : pj_AF_INET());
1115         } else {
1116                 hostip = session->endpoint->media.address;
1117         }
1118
1119         if (ast_strlen_zero(hostip)) {
1120                 ast_log(LOG_ERROR, "No local host IP available for stream %s\n", session_media->stream_type);
1121                 return -1;
1122         }
1123
1124         media->conn->net_type = STR_IN;
1125         /* Assume that the connection will use IPv4 until proven otherwise */
1126         media->conn->addr_type = STR_IP4;
1127         pj_strdup2(pool, &media->conn->addr, hostip);
1128
1129         if (!ast_strlen_zero(session->endpoint->media.address)) {
1130                 pj_sockaddr ip;
1131
1132                 if ((pj_sockaddr_parse(pj_AF_UNSPEC(), 0, &media->conn->addr, &ip) == PJ_SUCCESS) &&
1133                         (ip.addr.sa_family == pj_AF_INET6())) {
1134                         media->conn->addr_type = STR_IP6;
1135                 }
1136         }
1137
1138         ast_rtp_instance_get_local_address(session_media->rtp, &addr);
1139         media->desc.port = direct_media_enabled ? ast_sockaddr_port(&session_media->direct_media_addr) : (pj_uint16_t) ast_sockaddr_port(&addr);
1140         media->desc.port_count = 1;
1141
1142         /* Add ICE attributes and candidates */
1143         add_ice_to_stream(session, session_media, pool, media);
1144
1145         if (!(caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
1146                 ast_log(LOG_ERROR, "Failed to allocate %s capabilities\n", session_media->stream_type);
1147                 return -1;
1148         }
1149
1150         if (direct_media_enabled) {
1151                 ast_format_cap_get_compatible(session->endpoint->media.codecs, session->direct_media_cap, caps);
1152         } else if (!ast_format_cap_count(session->req_caps) ||
1153                 !ast_format_cap_iscompatible(session->req_caps, session->endpoint->media.codecs)) {
1154                 ast_format_cap_append_from_cap(caps, session->endpoint->media.codecs, media_type);
1155         } else {
1156                 ast_format_cap_append_from_cap(caps, session->req_caps, media_type);
1157         }
1158
1159         for (index = 0; index < ast_format_cap_count(caps); ++index) {
1160                 struct ast_format *format = ast_format_cap_get_format(caps, index);
1161
1162                 if (ast_format_get_type(format) != media_type) {
1163                         ao2_ref(format, -1);
1164                         continue;
1165                 }
1166
1167                 if ((rtp_code = ast_rtp_codecs_payload_code(ast_rtp_instance_get_codecs(session_media->rtp), 1, format, 0)) == -1) {
1168                         ast_log(LOG_WARNING,"Unable to get rtp codec payload code for %s\n", ast_format_get_name(format));
1169                         ao2_ref(format, -1);
1170                         continue;
1171                 }
1172
1173                 if (!(attr = generate_rtpmap_attr(session, media, pool, rtp_code, 1, format, 0))) {
1174                         ao2_ref(format, -1);
1175                         continue;
1176                 }
1177                 media->attr[media->attr_count++] = attr;
1178
1179                 if ((attr = generate_fmtp_attr(pool, format, rtp_code))) {
1180                         media->attr[media->attr_count++] = attr;
1181                 }
1182
1183                 if (ast_format_get_maximum_ms(format) &&
1184                         ((ast_format_get_maximum_ms(format) < max_packet_size) || !max_packet_size)) {
1185                         max_packet_size = ast_format_get_maximum_ms(format);
1186                 }
1187                 ao2_ref(format, -1);
1188         }
1189
1190         /* Add non-codec formats */
1191         if (media_type != AST_MEDIA_TYPE_VIDEO) {
1192                 for (index = 1LL; index <= AST_RTP_MAX; index <<= 1) {
1193                         if (!(noncodec & index)) {
1194                                 continue;
1195                         }
1196                         rtp_code = ast_rtp_codecs_payload_code(
1197                                 ast_rtp_instance_get_codecs(session_media->rtp), 0, NULL, index);
1198                         if (rtp_code == -1) {
1199                                 continue;
1200                         }
1201
1202                         if (!(attr = generate_rtpmap_attr(session, media, pool, rtp_code, 0, NULL, index))) {
1203                                 continue;
1204                         }
1205
1206                         media->attr[media->attr_count++] = attr;
1207
1208                         if (index == AST_RTP_DTMF) {
1209                                 snprintf(tmp, sizeof(tmp), "%d 0-16", rtp_code);
1210                                 attr = pjmedia_sdp_attr_create(pool, "fmtp", pj_cstr(&stmp, tmp));
1211                                 media->attr[media->attr_count++] = attr;
1212                         }
1213                 }
1214         }
1215
1216         /* If no formats were actually added to the media stream don't add it to the SDP */
1217         if (!media->desc.fmt_count) {
1218                 return 1;
1219         }
1220
1221         /* If ptime is set add it as an attribute */
1222         min_packet_size = ast_rtp_codecs_get_framing(ast_rtp_instance_get_codecs(session_media->rtp));
1223         if (!min_packet_size) {
1224                 min_packet_size = ast_format_cap_get_framing(caps);
1225         }
1226         if (min_packet_size) {
1227                 snprintf(tmp, sizeof(tmp), "%d", min_packet_size);
1228                 attr = pjmedia_sdp_attr_create(pool, "ptime", pj_cstr(&stmp, tmp));
1229                 media->attr[media->attr_count++] = attr;
1230         }
1231
1232         if (max_packet_size) {
1233                 snprintf(tmp, sizeof(tmp), "%d", max_packet_size);
1234                 attr = pjmedia_sdp_attr_create(pool, "maxptime", pj_cstr(&stmp, tmp));
1235                 media->attr[media->attr_count++] = attr;
1236         }
1237
1238         /* Add the sendrecv attribute - we purposely don't keep track because pjmedia-sdp will automatically change our offer for us */
1239         attr = PJ_POOL_ZALLOC_T(pool, pjmedia_sdp_attr);
1240         attr->name = !session_media->locally_held ? STR_SENDRECV : STR_SENDONLY;
1241         media->attr[media->attr_count++] = attr;
1242
1243         /* Add the media stream to the SDP */
1244         sdp->media[sdp->media_count++] = media;
1245
1246         return 1;
1247 }
1248
1249 static int apply_negotiated_sdp_stream(struct ast_sip_session *session, struct ast_sip_session_media *session_media,
1250                                        const struct pjmedia_sdp_session *local, const struct pjmedia_sdp_media *local_stream,
1251                                        const struct pjmedia_sdp_session *remote, const struct pjmedia_sdp_media *remote_stream)
1252 {
1253         RAII_VAR(struct ast_sockaddr *, addrs, NULL, ast_free);
1254         enum ast_media_type media_type = stream_to_media_type(session_media->stream_type);
1255         char host[NI_MAXHOST];
1256         int fdno, res;
1257
1258         if (!session->channel) {
1259                 return 1;
1260         }
1261
1262         if (!local_stream->desc.port || !remote_stream->desc.port) {
1263                 return 1;
1264         }
1265
1266         /* Ensure incoming transport is compatible with the endpoint's configuration */
1267         if (!session->endpoint->media.rtp.use_received_transport &&
1268                 check_endpoint_media_transport(session->endpoint, remote_stream) == AST_SIP_MEDIA_TRANSPORT_INVALID) {
1269                 return -1;
1270         }
1271
1272         /* Create an RTP instance if need be */
1273         if (!session_media->rtp && create_rtp(session, session_media)) {
1274                 return -1;
1275         }
1276
1277         res = setup_media_encryption(session, session_media, remote, remote_stream);
1278         if (!session->endpoint->media.rtp.encryption_optimistic && res) {
1279                 /* If optimistic encryption is disabled and crypto should have been enabled but was not
1280                  * this session must fail.
1281                  */
1282                 return -1;
1283         }
1284
1285         if (!remote_stream->conn && !remote->conn) {
1286                 return 1;
1287         }
1288
1289         ast_copy_pj_str(host, remote_stream->conn ? &remote_stream->conn->addr : &remote->conn->addr, sizeof(host));
1290
1291         /* Ensure that the address provided is valid */
1292         if (ast_sockaddr_resolve(&addrs, host, PARSE_PORT_FORBID, AST_AF_UNSPEC) <= 0) {
1293                 /* The provided host was actually invalid so we error out this negotiation */
1294                 return -1;
1295         }
1296
1297         /* Apply connection information to the RTP instance */
1298         ast_sockaddr_set_port(addrs, remote_stream->desc.port);
1299         ast_rtp_instance_set_remote_address(session_media->rtp, addrs);
1300         if (set_caps(session, session_media, remote_stream, 0)) {
1301                 return 1;
1302         }
1303
1304         if ((fdno = media_type_to_fdno(media_type)) < 0) {
1305                 return -1;
1306         }
1307         ast_channel_set_fd(session->channel, fdno, ast_rtp_instance_fd(session_media->rtp, 0));
1308         ast_channel_set_fd(session->channel, fdno + 1, ast_rtp_instance_fd(session_media->rtp, 1));
1309
1310         /* If ICE support is enabled find all the needed attributes */
1311         process_ice_attributes(session, session_media, remote, remote_stream);
1312
1313         /* Ensure the RTP instance is active */
1314         ast_rtp_instance_activate(session_media->rtp);
1315
1316         /* audio stream handles music on hold */
1317         if (media_type != AST_MEDIA_TYPE_AUDIO) {
1318                 if ((pjmedia_sdp_neg_was_answer_remote(session->inv_session->neg) == PJ_FALSE)
1319                         && (session->inv_session->state == PJSIP_INV_STATE_CONFIRMED)) {
1320                         ast_queue_control(session->channel, AST_CONTROL_UPDATE_RTP_PEER);
1321                 }
1322                 return 1;
1323         }
1324
1325         if (ast_sockaddr_isnull(addrs) ||
1326                 ast_sockaddr_is_any(addrs) ||
1327                 pjmedia_sdp_media_find_attr2(remote_stream, "sendonly", NULL) ||
1328                 pjmedia_sdp_media_find_attr2(remote_stream, "inactive", NULL)) {
1329                 if (!session_media->remotely_held) {
1330                         /* The remote side has put us on hold */
1331                         ast_queue_hold(session->channel, session->endpoint->mohsuggest);
1332                         ast_rtp_instance_stop(session_media->rtp);
1333                         ast_queue_frame(session->channel, &ast_null_frame);
1334                         session_media->remotely_held = 1;
1335                 }
1336         } else if (session_media->remotely_held) {
1337                 /* The remote side has taken us off hold */
1338                 ast_queue_unhold(session->channel);
1339                 ast_queue_frame(session->channel, &ast_null_frame);
1340                 session_media->remotely_held = 0;
1341         } else if ((pjmedia_sdp_neg_was_answer_remote(session->inv_session->neg) == PJ_FALSE)
1342                 && (session->inv_session->state == PJSIP_INV_STATE_CONFIRMED)) {
1343                 ast_queue_control(session->channel, AST_CONTROL_UPDATE_RTP_PEER);
1344         }
1345
1346         /* This purposely resets the encryption to the configured in case it gets added later */
1347         session_media->encryption = session->endpoint->media.rtp.encryption;
1348
1349         if (session->endpoint->media.rtp.keepalive > 0 &&
1350                         stream_to_media_type(session_media->stream_type) == AST_MEDIA_TYPE_AUDIO) {
1351                 ast_rtp_instance_set_keepalive(session_media->rtp, session->endpoint->media.rtp.keepalive);
1352                 /* Schedule the initial keepalive early in case this is being used to punch holes through
1353                  * a NAT. This way there won't be an awkward delay before media starts flowing in some
1354                  * scenarios.
1355                  */
1356                 AST_SCHED_DEL(sched, session_media->keepalive_sched_id);
1357                 session_media->keepalive_sched_id = ast_sched_add_variable(sched, 500, send_keepalive,
1358                         session_media, 1);
1359         }
1360
1361         /* As the channel lock is not held during this process the scheduled item won't block if
1362          * it is hanging up the channel at the same point we are applying this negotiated SDP.
1363          */
1364         AST_SCHED_DEL(sched, session_media->timeout_sched_id);
1365
1366         /* Due to the fact that we only ever have one scheduled timeout item for when we are both
1367          * off hold and on hold we don't need to store the two timeouts differently on the RTP
1368          * instance itself.
1369          */
1370         ast_rtp_instance_set_timeout(session_media->rtp, 0);
1371         if (session->endpoint->media.rtp.timeout && !session_media->remotely_held) {
1372                 ast_rtp_instance_set_timeout(session_media->rtp, session->endpoint->media.rtp.timeout);
1373         } else if (session->endpoint->media.rtp.timeout_hold && session_media->remotely_held) {
1374                 ast_rtp_instance_set_timeout(session_media->rtp, session->endpoint->media.rtp.timeout_hold);
1375         }
1376
1377         if (ast_rtp_instance_get_timeout(session_media->rtp)) {
1378                 session_media->timeout_sched_id = ast_sched_add_variable(sched,
1379                         ast_rtp_instance_get_timeout(session_media->rtp) * 1000, rtp_check_timeout,
1380                         session_media, 1);
1381         }
1382
1383         return 1;
1384 }
1385
1386 /*! \brief Function which updates the media stream with external media address, if applicable */
1387 static void change_outgoing_sdp_stream_media_address(pjsip_tx_data *tdata, struct pjmedia_sdp_media *stream, struct ast_sip_transport *transport)
1388 {
1389         RAII_VAR(struct ast_sip_transport_state *, transport_state, ast_sip_get_transport_state(ast_sorcery_object_get_id(transport)), ao2_cleanup);
1390         char host[NI_MAXHOST];
1391         struct ast_sockaddr addr = { { 0, } };
1392
1393         /* If the stream has been rejected there will be no connection line */
1394         if (!stream->conn || !transport_state) {
1395                 return;
1396         }
1397
1398         ast_copy_pj_str(host, &stream->conn->addr, sizeof(host));
1399         ast_sockaddr_parse(&addr, host, PARSE_PORT_FORBID);
1400
1401         /* Is the address within the SDP inside the same network? */
1402         if (ast_apply_ha(transport_state->localnet, &addr) == AST_SENSE_ALLOW) {
1403                 return;
1404         }
1405
1406         pj_strdup2(tdata->pool, &stream->conn->addr, transport->external_media_address);
1407 }
1408
1409 /*! \brief Function which stops the RTP instance */
1410 static void stream_stop(struct ast_sip_session_media *session_media)
1411 {
1412         if (!session_media->rtp) {
1413                 return;
1414         }
1415
1416         AST_SCHED_DEL(sched, session_media->keepalive_sched_id);
1417         AST_SCHED_DEL(sched, session_media->timeout_sched_id);
1418         ast_rtp_instance_stop(session_media->rtp);
1419 }
1420
1421 /*! \brief Function which destroys the RTP instance when session ends */
1422 static void stream_destroy(struct ast_sip_session_media *session_media)
1423 {
1424         if (session_media->rtp) {
1425                 stream_stop(session_media);
1426                 ast_rtp_instance_destroy(session_media->rtp);
1427         }
1428         session_media->rtp = NULL;
1429 }
1430
1431 /*! \brief SDP handler for 'audio' media stream */
1432 static struct ast_sip_session_sdp_handler audio_sdp_handler = {
1433         .id = STR_AUDIO,
1434         .negotiate_incoming_sdp_stream = negotiate_incoming_sdp_stream,
1435         .create_outgoing_sdp_stream = create_outgoing_sdp_stream,
1436         .apply_negotiated_sdp_stream = apply_negotiated_sdp_stream,
1437         .change_outgoing_sdp_stream_media_address = change_outgoing_sdp_stream_media_address,
1438         .stream_stop = stream_stop,
1439         .stream_destroy = stream_destroy,
1440 };
1441
1442 /*! \brief SDP handler for 'video' media stream */
1443 static struct ast_sip_session_sdp_handler video_sdp_handler = {
1444         .id = STR_VIDEO,
1445         .negotiate_incoming_sdp_stream = negotiate_incoming_sdp_stream,
1446         .create_outgoing_sdp_stream = create_outgoing_sdp_stream,
1447         .apply_negotiated_sdp_stream = apply_negotiated_sdp_stream,
1448         .change_outgoing_sdp_stream_media_address = change_outgoing_sdp_stream_media_address,
1449         .stream_stop = stream_stop,
1450         .stream_destroy = stream_destroy,
1451 };
1452
1453 static int video_info_incoming_request(struct ast_sip_session *session, struct pjsip_rx_data *rdata)
1454 {
1455         struct pjsip_transaction *tsx;
1456         pjsip_tx_data *tdata;
1457
1458         if (!session->channel
1459                 || !ast_sip_is_content_type(&rdata->msg_info.msg->body->content_type,
1460                         "application",
1461                         "media_control+xml")) {
1462                 return 0;
1463         }
1464
1465         tsx = pjsip_rdata_get_tsx(rdata);
1466
1467         ast_queue_control(session->channel, AST_CONTROL_VIDUPDATE);
1468
1469         if (pjsip_dlg_create_response(session->inv_session->dlg, rdata, 200, NULL, &tdata) == PJ_SUCCESS) {
1470                 pjsip_dlg_send_response(session->inv_session->dlg, tsx, tdata);
1471         }
1472
1473         return 0;
1474 }
1475
1476 static struct ast_sip_session_supplement video_info_supplement = {
1477         .method = "INFO",
1478         .incoming_request = video_info_incoming_request,
1479 };
1480
1481 /*! \brief Unloads the sdp RTP/AVP module from Asterisk */
1482 static int unload_module(void)
1483 {
1484         ast_sip_session_unregister_supplement(&video_info_supplement);
1485         ast_sip_session_unregister_sdp_handler(&video_sdp_handler, STR_VIDEO);
1486         ast_sip_session_unregister_sdp_handler(&audio_sdp_handler, STR_AUDIO);
1487
1488         if (sched) {
1489                 ast_sched_context_destroy(sched);
1490         }
1491
1492         return 0;
1493 }
1494
1495 /*!
1496  * \brief Load the module
1497  *
1498  * Module loading including tests for configuration or dependencies.
1499  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
1500  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
1501  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the
1502  * configuration file or other non-critical problem return
1503  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
1504  */
1505 static int load_module(void)
1506 {
1507         CHECK_PJSIP_SESSION_MODULE_LOADED();
1508
1509         ast_sockaddr_parse(&address_rtp, "::", 0);
1510
1511         if (!(sched = ast_sched_context_create())) {
1512                 ast_log(LOG_ERROR, "Unable to create scheduler context.\n");
1513                 goto end;
1514         }
1515
1516         if (ast_sched_start_thread(sched)) {
1517                 ast_log(LOG_ERROR, "Unable to create scheduler context thread.\n");
1518                 goto end;
1519         }
1520
1521         if (ast_sip_session_register_sdp_handler(&audio_sdp_handler, STR_AUDIO)) {
1522                 ast_log(LOG_ERROR, "Unable to register SDP handler for %s stream type\n", STR_AUDIO);
1523                 goto end;
1524         }
1525
1526         if (ast_sip_session_register_sdp_handler(&video_sdp_handler, STR_VIDEO)) {
1527                 ast_log(LOG_ERROR, "Unable to register SDP handler for %s stream type\n", STR_VIDEO);
1528                 goto end;
1529         }
1530
1531         ast_sip_session_register_supplement(&video_info_supplement);
1532
1533         return AST_MODULE_LOAD_SUCCESS;
1534 end:
1535         unload_module();
1536
1537         return AST_MODULE_LOAD_FAILURE;
1538 }
1539
1540 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP SDP RTP/AVP stream handler",
1541         .support_level = AST_MODULE_SUPPORT_CORE,
1542         .load = load_module,
1543         .unload = unload_module,
1544         .load_pri = AST_MODPRI_CHANNEL_DRIVER,
1545 );