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