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