media: sort candidates in sipe-media.c
[siplcs.git] / src / core / sdpmsg.c
blob95477a2b9f93075befe97339eaba7b23ec5849d3
1 /**
2 * @file sdpmsg.c
4 * pidgin-sipe
6 * Copyright (C) 2013 SIPE Project <http://sipe.sourceforge.net/>
7 * Copyright (C) 2010 Jakub Adam <jakub.adam@ktknet.cz>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
28 #include <glib.h>
30 #include "sipe-backend.h"
31 #include "sdpmsg.h"
32 #include "sipe-utils.h"
34 static gboolean
35 append_attribute(struct sdpmedia *media, gchar *attr)
37 gchar **parts = g_strsplit(attr + 2, ":", 2);
39 if(!parts[0]) {
40 g_strfreev(parts);
41 return FALSE;
44 media->attributes = sipe_utils_nameval_add(media->attributes,
45 parts[0],
46 parts[1] ? parts[1] : "");
47 g_strfreev(parts);
48 return TRUE;
51 static gboolean
52 parse_attributes(struct sdpmsg *smsg, gchar *msg) {
53 gchar **lines = g_strsplit(msg, "\r\n", 0);
54 gchar **ptr = lines;
56 while (*ptr != NULL) {
57 if (g_str_has_prefix(*ptr, "o=")) {
58 gchar **parts = g_strsplit(*ptr + 2, " ", 6);
59 smsg->ip = g_strdup(parts[5]);
60 g_strfreev(parts);
61 } else if (g_str_has_prefix(*ptr, "m=")) {
62 gchar **parts = g_strsplit(*ptr + 2, " ", 3);
63 struct sdpmedia *media = g_new0(struct sdpmedia, 1);
65 smsg->media = g_slist_append(smsg->media, media);
67 media->name = g_strdup(parts[0]);
68 media->port = atoi(parts[1]);
70 g_strfreev(parts);
72 while (*(++ptr) && !g_str_has_prefix(*ptr, "m=")) {
74 if (g_str_has_prefix(*ptr, "a=")) {
75 if (!append_attribute(media, *ptr)) {
76 g_strfreev(lines);
77 return FALSE;
81 continue;
84 ++ptr;
87 g_strfreev(lines);
89 return TRUE;
92 static struct sdpcandidate * sdpcandidate_copy(struct sdpcandidate *candidate);
93 static void sdpcandidate_free(struct sdpcandidate *candidate);
95 static SipeComponentType
96 parse_component(const gchar *str)
98 switch (atoi(str)) {
99 case 1: return SIPE_COMPONENT_RTP;
100 case 2: return SIPE_COMPONENT_RTCP;
101 default: return SIPE_COMPONENT_NONE;
105 static gchar *
106 base64_pad(const gchar* str)
108 size_t str_len = strlen(str);
109 int mod = str_len % 4;
111 if (mod > 0) {
112 gchar *result = NULL;
113 int pad = 4 - mod;
114 gchar *ptr = result = g_malloc(str_len + pad + 1);
116 memcpy(ptr, str, str_len);
117 ptr += str_len;
118 memset(ptr, '=', pad);
119 ptr += pad;
120 *ptr = '\0';
122 return result;
123 } else
124 return g_strdup(str);
127 static GSList *
128 parse_append_candidate_draft_6(gchar **tokens, GSList *candidates)
130 struct sdpcandidate *candidate = g_new0(struct sdpcandidate, 1);
132 candidate->username = base64_pad(tokens[0]);
133 candidate->component = parse_component(tokens[1]);
134 candidate->password = base64_pad(tokens[2]);
136 if (sipe_strequal(tokens[3], "UDP"))
137 candidate->protocol = SIPE_NETWORK_PROTOCOL_UDP;
138 else if (sipe_strequal(tokens[3], "TCP"))
139 candidate->protocol = SIPE_NETWORK_PROTOCOL_TCP_ACTIVE;
140 else {
141 sdpcandidate_free(candidate);
142 return candidates;
145 candidate->priority = atoi(tokens[4] + 2);
146 candidate->ip = g_strdup(tokens[5]);
147 candidate->port = atoi(tokens[6]);
149 candidates = g_slist_append(candidates, candidate);
151 // draft 6 candidates are both active and passive
152 if (candidate->protocol == SIPE_NETWORK_PROTOCOL_TCP_ACTIVE) {
153 candidate = sdpcandidate_copy(candidate);
154 candidate->protocol = SIPE_NETWORK_PROTOCOL_TCP_PASSIVE;
155 candidates = g_slist_append(candidates, candidate);
158 return candidates;
161 static GSList *
162 parse_append_candidate_rfc_5245(gchar **tokens, GSList *candidates)
164 struct sdpcandidate *candidate = g_new0(struct sdpcandidate, 1);
166 candidate->foundation = g_strdup(tokens[0]);
167 candidate->component = parse_component(tokens[1]);
169 if (sipe_strequal(tokens[2], "UDP"))
170 candidate->protocol = SIPE_NETWORK_PROTOCOL_UDP;
171 else if (sipe_strequal(tokens[2], "TCP-ACT"))
172 candidate->protocol = SIPE_NETWORK_PROTOCOL_TCP_ACTIVE;
173 else if (sipe_strequal(tokens[2], "TCP-PASS"))
174 candidate->protocol = SIPE_NETWORK_PROTOCOL_TCP_PASSIVE;
175 else {
176 sdpcandidate_free(candidate);
177 return candidates;
180 candidate->priority = atoi(tokens[3]);
181 candidate->ip = g_strdup(tokens[4]);
182 candidate->port = atoi(tokens[5]);
184 if (sipe_strequal(tokens[7], "host"))
185 candidate->type = SIPE_CANDIDATE_TYPE_HOST;
186 else if (sipe_strequal(tokens[7], "relay"))
187 candidate->type = SIPE_CANDIDATE_TYPE_RELAY;
188 else if (sipe_strequal(tokens[7], "srflx"))
189 candidate->type = SIPE_CANDIDATE_TYPE_SRFLX;
190 else if (sipe_strequal(tokens[7], "prflx"))
191 candidate->type = SIPE_CANDIDATE_TYPE_PRFLX;
192 else {
193 sdpcandidate_free(candidate);
194 return candidates;
197 return g_slist_append(candidates, candidate);
200 static GSList *
201 parse_candidates(GSList *attrs, SipeIceVersion *ice_version)
203 GSList *candidates = NULL;
204 const gchar *attr;
205 int i = 0;
207 while ((attr = sipe_utils_nameval_find_instance(attrs, "candidate", i++))) {
208 gchar **tokens = g_strsplit_set(attr, " ", 0);
210 if (sipe_strequal(tokens[6], "typ")) {
211 candidates = parse_append_candidate_rfc_5245(tokens, candidates);
212 if (candidates)
213 *ice_version = SIPE_ICE_RFC_5245;
214 } else {
215 candidates = parse_append_candidate_draft_6(tokens, candidates);
216 if (candidates)
217 *ice_version = SIPE_ICE_DRAFT_6;
220 g_strfreev(tokens);
223 if (!candidates)
224 *ice_version = SIPE_ICE_NO_ICE;
226 if (*ice_version == SIPE_ICE_RFC_5245) {
227 const gchar *username = sipe_utils_nameval_find(attrs, "ice-ufrag");
228 const gchar *password = sipe_utils_nameval_find(attrs, "ice-pwd");
230 if (username && password) {
231 GSList *i;
232 for (i = candidates; i; i = i->next) {
233 struct sdpcandidate *c = i->data;
234 c->username = g_strdup(username);
235 c->password = g_strdup(password);
240 return candidates;
243 static GSList *
244 create_legacy_candidates(gchar *ip, guint16 port)
246 struct sdpcandidate *candidate;
247 GSList *candidates = NULL;
249 candidate = g_new0(struct sdpcandidate, 1);
250 candidate->foundation = g_strdup("1");
251 candidate->component = SIPE_COMPONENT_RTP;
252 candidate->type = SIPE_CANDIDATE_TYPE_HOST;
253 candidate->protocol = SIPE_NETWORK_PROTOCOL_UDP;
254 candidate->ip = g_strdup(ip);
255 candidate->port = port;
257 candidates = g_slist_append(candidates, candidate);
259 candidate = g_new0(struct sdpcandidate, 1);
260 candidate->foundation = g_strdup("1");
261 candidate->component = SIPE_COMPONENT_RTCP;
262 candidate->type = SIPE_CANDIDATE_TYPE_HOST;
263 candidate->protocol = SIPE_NETWORK_PROTOCOL_UDP;
264 candidate->ip = g_strdup(ip);
265 candidate->port = port + 1;
267 candidates = g_slist_append(candidates, candidate);
269 return candidates;
272 static GSList *
273 parse_codecs(GSList *attrs, SipeMediaType type)
275 int i = 0;
276 const gchar *attr;
277 GSList *codecs = NULL;
279 while ((attr = sipe_utils_nameval_find_instance(attrs, "rtpmap", i++))) {
280 struct sdpcodec *codec = g_new0(struct sdpcodec, 1);
281 gchar **tokens = g_strsplit_set(attr, " /", 3);
283 int j = 0;
284 const gchar* params;
286 codec->id = atoi(tokens[0]);
287 codec->name = g_strdup(tokens[1]);
288 codec->clock_rate = atoi(tokens[2]);
289 codec->type = type;
291 // TODO: more secure and effective implementation
292 while((params = sipe_utils_nameval_find_instance(attrs, "fmtp", j++))) {
293 gchar **tokens = g_strsplit_set(params, " ", 0);
294 gchar **next = tokens + 1;
296 if (atoi(tokens[0]) == codec->id) {
297 while (*next) {
298 gchar name[50];
299 gchar value[50];
301 if (sscanf(*next, "%[a-zA-Z0-9]=%s", name, value) == 2)
302 codec->parameters = sipe_utils_nameval_add(codec->parameters, name, value);
304 ++next;
308 g_strfreev(tokens);
311 codecs = g_slist_append(codecs, codec);
312 g_strfreev(tokens);
315 return codecs;
318 struct sdpmsg *
319 sdpmsg_parse_msg(gchar *msg)
321 struct sdpmsg *smsg = g_new0(struct sdpmsg, 1);
322 GSList *i;
324 if (!parse_attributes(smsg, msg)) {
325 sdpmsg_free(smsg);
326 return NULL;
329 for (i = smsg->media; i; i = i->next) {
330 struct sdpmedia *media = i->data;
331 SipeMediaType type;
333 media->candidates = parse_candidates(media->attributes,
334 &smsg->ice_version);
336 if (!media->candidates && media->port != 0) {
337 // No a=candidate in SDP message, this seems to be MSOC 2005
338 media->candidates = create_legacy_candidates(smsg->ip, media->port);
341 if (sipe_strequal(media->name, "audio"))
342 type = SIPE_MEDIA_AUDIO;
343 else if (sipe_strequal(media->name, "video"))
344 type = SIPE_MEDIA_VIDEO;
345 else {
346 // Unknown media type
347 sdpmsg_free(smsg);
348 return NULL;
351 media->codecs = parse_codecs(media->attributes, type);
354 return smsg;
357 static gchar *
358 codecs_to_string(GSList *codecs)
360 GString *result = g_string_new(NULL);
362 for (; codecs; codecs = codecs->next) {
363 struct sdpcodec *c = codecs->data;
364 GSList *params = c->parameters;
366 g_string_append_printf(result,
367 "a=rtpmap:%d %s/%d\r\n",
368 c->id,
369 c->name,
370 c->clock_rate);
372 if (params) {
373 g_string_append_printf(result, "a=fmtp:%d", c->id);
375 for (; params; params = params->next) {
376 struct sipnameval* par = params->data;
377 g_string_append_printf(result, " %s=%s",
378 par->name, par->value);
381 g_string_append(result, "\r\n");
385 return g_string_free(result, FALSE);
388 static gchar *
389 codec_ids_to_string(GSList *codecs)
391 GString *result = g_string_new(NULL);
393 for (; codecs; codecs = codecs->next) {
394 struct sdpcodec *c = codecs->data;
395 g_string_append_printf(result, " %d", c->id);
398 return g_string_free(result, FALSE);
401 static gchar *
402 base64_unpad(const gchar *str)
404 gchar *result = g_strdup(str);
405 gchar *ptr;
407 for (ptr = result + strlen(result); ptr != result; --ptr) {
408 if (*(ptr - 1) != '=') {
409 *ptr = '\0';
410 break;
414 return result;
417 static gchar *
418 candidates_to_string(GSList *candidates, SipeIceVersion ice_version)
420 GString *result = g_string_new("");
421 GSList *i;
422 GSList *processed_tcp_candidates = NULL;
424 for (i = candidates; i; i = i->next) {
425 struct sdpcandidate *c = i->data;
426 const gchar *protocol;
427 const gchar *type;
428 gchar *related = NULL;
430 if (ice_version == SIPE_ICE_RFC_5245) {
432 switch (c->protocol) {
433 case SIPE_NETWORK_PROTOCOL_TCP_ACTIVE:
434 protocol = "TCP-ACT";
435 break;
436 case SIPE_NETWORK_PROTOCOL_TCP_PASSIVE:
437 protocol = "TCP-PASS";
438 break;
439 case SIPE_NETWORK_PROTOCOL_UDP:
440 protocol = "UDP";
441 break;
442 default:
443 /* error unknown/unsupported type */
444 protocol = "UNKNOWN";
445 break;
448 switch (c->type) {
449 case SIPE_CANDIDATE_TYPE_HOST:
450 type = "host";
451 break;
452 case SIPE_CANDIDATE_TYPE_RELAY:
453 type = "relay";
454 related = g_strdup_printf("raddr %s rport %d ",
455 c->ip,
456 c->port);
457 break;
458 case SIPE_CANDIDATE_TYPE_SRFLX:
459 type = "srflx";
460 related = g_strdup_printf("raddr %s rport %d",
461 c->base_ip,
462 c->base_port);
463 break;
464 case SIPE_CANDIDATE_TYPE_PRFLX:
465 type = "prflx";
466 break;
467 default:
468 /* error unknown/unsupported type */
469 type = "unknown";
470 break;
473 g_string_append_printf(result,
474 "a=candidate:%s %u %s %u %s %d typ %s %s\r\n",
475 c->foundation,
476 c->component,
477 protocol,
478 c->priority,
479 c->ip,
480 c->port,
481 type,
482 related ? related : "");
483 g_free(related);
485 } else if (ice_version == SIPE_ICE_DRAFT_6) {
486 gchar *username;
487 gchar *password;
489 switch (c->protocol) {
490 case SIPE_NETWORK_PROTOCOL_TCP_ACTIVE:
491 case SIPE_NETWORK_PROTOCOL_TCP_PASSIVE: {
492 GSList *prev_cand = processed_tcp_candidates;
493 for (; prev_cand; prev_cand = prev_cand->next) {
494 struct sdpcandidate *c2 = (struct sdpcandidate *)prev_cand->data;
496 if (sipe_strequal(c->ip, c2->ip) &&
497 c->component == c2->component) {
498 break;
502 if (prev_cand) {
503 protocol = NULL;
504 } else {
505 protocol = "TCP";
506 processed_tcp_candidates =
507 g_slist_append(processed_tcp_candidates, c);
509 break;
511 case SIPE_NETWORK_PROTOCOL_UDP:
512 protocol = "UDP";
513 break;
514 default:
515 /* unknown/unsupported type, ignore */
516 protocol = NULL;
517 break;
520 if (!protocol) {
521 continue;
524 username = base64_unpad(c->username);
525 password = base64_unpad(c->password);
527 g_string_append_printf(result,
528 "a=candidate:%s %u %s %s 0.%u %s %d\r\n",
529 username,
530 c->component,
531 password,
532 protocol,
533 c->priority,
534 c->ip,
535 c->port);
537 g_free(username);
538 g_free(password);
542 g_slist_free(processed_tcp_candidates);
544 return g_string_free(result, FALSE);
547 static gchar *
548 remote_candidates_to_string(GSList *candidates, SipeIceVersion ice_version)
550 GString *result = g_string_new("");
552 if (candidates) {
553 if (ice_version == SIPE_ICE_RFC_5245) {
554 GSList *i;
555 g_string_append(result, "a=remote-candidates:");
557 for (i = candidates; i; i = i->next) {
558 struct sdpcandidate *c = i->data;
559 g_string_append_printf(result, "%u %s %u ",
560 c->component, c->ip, c->port);
563 g_string_append(result, "\r\n");
564 } else if (ice_version == SIPE_ICE_DRAFT_6) {
565 struct sdpcandidate *c = candidates->data;
566 g_string_append_printf(result, "a=remote-candidate:%s\r\n",
567 c->username);
571 return g_string_free(result, FALSE);
574 static gchar *
575 attributes_to_string(GSList *attributes)
577 GString *result = g_string_new("");
579 for (; attributes; attributes = attributes->next) {
580 struct sipnameval *a = attributes->data;
581 g_string_append_printf(result, "a=%s", a->name);
582 if (!sipe_strequal(a->value, ""))
583 g_string_append_printf(result, ":%s", a->value);
584 g_string_append(result, "\r\n");
587 return g_string_free(result, FALSE);
590 static gchar *
591 media_to_string(const struct sdpmsg *msg, const struct sdpmedia *media)
593 gchar *media_str;
595 gchar *media_conninfo = NULL;
597 gchar *codecs_str = NULL;
598 gchar *codec_ids_str = codec_ids_to_string(media->codecs);
600 gchar *candidates_str = NULL;
601 gchar *remote_candidates_str = NULL;
603 gchar *tcp_setup_str = NULL;
604 gchar *attributes_str = NULL;
605 gchar *credentials = NULL;
607 gboolean uses_tcp_transport = FALSE;
609 if (media->port != 0) {
610 if (!sipe_strequal(msg->ip, media->ip)) {
611 media_conninfo = g_strdup_printf("c=IN IP4 %s\r\n", media->ip);
614 codecs_str = codecs_to_string(media->codecs);
615 candidates_str = candidates_to_string(media->candidates, msg->ice_version);
616 remote_candidates_str = remote_candidates_to_string(media->remote_candidates,
617 msg->ice_version);
619 if (media->remote_candidates) {
620 struct sdpcandidate *c = media->remote_candidates->data;
621 uses_tcp_transport =
622 c->protocol == SIPE_NETWORK_PROTOCOL_TCP_ACTIVE ||
623 c->protocol == SIPE_NETWORK_PROTOCOL_TCP_PASSIVE;
624 if (uses_tcp_transport) {
625 tcp_setup_str = g_strdup_printf(
626 "a=connection:existing\r\n"
627 "a=setup:%s\r\n",
628 (c->protocol == SIPE_NETWORK_PROTOCOL_TCP_ACTIVE) ? "passive" : "active");
632 attributes_str = attributes_to_string(media->attributes);
634 if (msg->ice_version == SIPE_ICE_RFC_5245 && media->candidates) {
635 struct sdpcandidate *c = media->candidates->data;
637 credentials = g_strdup_printf("a=ice-ufrag:%s\r\n"
638 "a=ice-pwd:%s\r\n",
639 c->username,
640 c->password);
644 media_str = g_strdup_printf("m=%s %d %sRTP/AVP%s\r\n"
645 "%s"
646 "%s"
647 "%s"
648 "%s"
649 "%s"
650 "%s"
651 "%s",
652 media->name, media->port, uses_tcp_transport ? "TCP/" : "", codec_ids_str,
653 media_conninfo ? media_conninfo : "",
654 candidates_str ? candidates_str : "",
655 remote_candidates_str ? remote_candidates_str : "",
656 tcp_setup_str ? tcp_setup_str : "",
657 codecs_str ? codecs_str : "",
658 attributes_str ? attributes_str : "",
659 credentials ? credentials : "");
661 g_free(media_conninfo);
662 g_free(codecs_str);
663 g_free(codec_ids_str);
664 g_free(candidates_str);
665 g_free(remote_candidates_str);
666 g_free(tcp_setup_str);
667 g_free(attributes_str);
668 g_free(credentials);
670 return media_str;
673 gchar *
674 sdpmsg_to_string(const struct sdpmsg *msg)
676 GString *body = g_string_new(NULL);
677 GSList *i;
679 g_string_append_printf(
680 body,
681 "v=0\r\n"
682 "o=- 0 0 IN IP4 %s\r\n"
683 "s=session\r\n"
684 "c=IN IP4 %s\r\n"
685 "b=CT:99980\r\n"
686 "t=0 0\r\n",
687 msg->ip, msg->ip);
690 for (i = msg->media; i; i = i->next) {
691 gchar *media_str = media_to_string(msg, i->data);
692 g_string_append(body, media_str);
693 g_free(media_str);
696 return g_string_free(body, FALSE);
699 static struct sdpcandidate *
700 sdpcandidate_copy(struct sdpcandidate *candidate)
702 if (candidate) {
703 struct sdpcandidate *copy = g_new0(struct sdpcandidate, 1);
705 copy->foundation = g_strdup(candidate->foundation);
706 copy->component = candidate->component;
707 copy->type = candidate->type;
708 copy->protocol = candidate->protocol;
709 copy->priority = candidate->priority;
710 copy->ip = g_strdup(candidate->ip);
711 copy->port = candidate->port;
712 copy->base_ip = g_strdup(candidate->base_ip);
713 copy->base_port = candidate->base_port;
714 copy->username = g_strdup(candidate->username);
715 copy->password = g_strdup(candidate->password);
717 return copy;
718 } else
719 return NULL;
722 static void
723 sdpcandidate_free(struct sdpcandidate *candidate)
725 if (candidate) {
726 g_free(candidate->foundation);
727 g_free(candidate->ip);
728 g_free(candidate->base_ip);
729 g_free(candidate->username);
730 g_free(candidate->password);
731 g_free(candidate);
735 static void
736 sdpcodec_free(struct sdpcodec *codec)
738 if (codec) {
739 g_free(codec->name);
740 sipe_utils_nameval_free(codec->parameters);
741 g_free(codec);
745 void
746 sdpmedia_free(struct sdpmedia *media)
748 if (media) {
749 g_free(media->name);
750 g_free(media->ip);
752 sipe_utils_nameval_free(media->attributes);
754 sipe_utils_slist_free_full(media->candidates,
755 (GDestroyNotify) sdpcandidate_free);
756 sipe_utils_slist_free_full(media->codecs,
757 (GDestroyNotify) sdpcodec_free);
758 sipe_utils_slist_free_full(media->remote_candidates,
759 (GDestroyNotify) sdpcandidate_free);
761 g_free(media);
765 void
766 sdpmsg_free(struct sdpmsg *msg)
768 if (msg) {
769 g_free(msg->ip);
770 sipe_utils_slist_free_full(msg->media,
771 (GDestroyNotify) sdpmedia_free);
772 g_free(msg);
777 Local Variables:
778 mode: c
779 c-file-style: "bsd"
780 indent-tabs-mode: t
781 tab-width: 8
782 End: