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