sip_util.c 41.5 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
8
 * This library is free software; you can redistribute it and/or
Pekka Pessi's avatar
Pekka Pessi committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

/**@CFILE sip_util.c
Pekka Pessi's avatar
Pekka Pessi committed
26
 *
Pekka Pessi's avatar
Pekka Pessi committed
27 28 29 30 31 32 33 34 35
 * SIP utility functions.
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>.
 *
 * @date Created: Tue Jun 13 02:57:51 2000 ppessi
 */

#include "config.h"

36 37 38
/* Avoid casting sip_t to msg_pub_t and sip_header_t to msg_header_t */
#define MSG_PUB_T       struct sip_s
#define MSG_HDR_T       union sip_header_u
Pekka Pessi's avatar
Pekka Pessi committed
39

40
#include <sofia-sip/su_alloc.h>
41
#include <sofia-sip/su_strlst.h>
42
#include <sofia-sip/su_string.h>
Pekka Pessi's avatar
Pekka Pessi committed
43

44 45 46 47
#include "sofia-sip/sip_parser.h"
#include <sofia-sip/sip_header.h>
#include <sofia-sip/sip_util.h>
#include <sofia-sip/sip_status.h>
Pekka Pessi's avatar
Pekka Pessi committed
48

49 50
#include <sofia-sip/bnf.h>
#include <sofia-sip/hostdomain.h>
Pekka Pessi's avatar
Pekka Pessi committed
51

52

Youness Alaoui's avatar
Youness Alaoui committed
53
#include <stdio.h>
54 55 56 57 58 59 60
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <float.h>
#include <limits.h>
#include <ctype.h>
Pekka Pessi's avatar
Pekka Pessi committed
61

62
/**Compare two SIP addresses ( @From or @To headers).
Pekka Pessi's avatar
Pekka Pessi committed
63 64 65 66 67 68 69
 *
 * @retval nonzero if matching.
 * @retval zero if not matching.
 */
int sip_addr_match(sip_addr_t const *a, sip_addr_t const *b)
{
  return
Pekka Pessi's avatar
Pekka Pessi committed
70
    (a->a_tag == NULL || b->a_tag == NULL ||
71
     su_casematch(a->a_tag, b->a_tag))
Pekka Pessi's avatar
Pekka Pessi committed
72
    &&
73
    su_casematch(a->a_host, b->a_host)
Pekka Pessi's avatar
Pekka Pessi committed
74
    &&
75
    su_strmatch(a->a_user, b->a_user)
Pekka Pessi's avatar
Pekka Pessi committed
76
    &&
77
    su_strmatch(a->a_url->url_scheme, b->a_url->url_scheme);
Pekka Pessi's avatar
Pekka Pessi committed
78 79 80
}


81 82 83 84
/**@ingroup sip_contact
 *
 * Create a contact header.
 *
85
 * Create a @Contact header object with the given URL and list of parameters.
86 87 88
 *
 * @param home      memory home
 * @param url       URL (string or pointer to url_t)
89
 * @param p,...     NULL-terminated list of @Contact parameters
90 91
 *
 * @return
92 93
 * A pointer to newly created @Contact header object when successful or NULL
 * upon an error.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
 *
 */
sip_contact_t * sip_contact_create(su_home_t *home,
				   url_string_t const *url,
				   char const *p, ...)
{
  su_strlst_t *l;
  su_home_t *lhome;
  sip_contact_t *m;

  if (url == NULL)
    return NULL;

  l = su_strlst_create_with(NULL, "<", NULL), lhome = su_strlst_home(l);
  if (l == NULL)
    return NULL;

  if (url_is_string(url))
    su_strlst_append(l, (char const *)url);
  else
    su_strlst_append(l, url_as_string(lhome, url->us_url));

  su_strlst_append(l, ">");

  if (p) {
    va_list ap;
    va_start(ap, p);

    for (; p; p = va_arg(ap, char const *)) {
      su_strlst_append(l, ";");
      su_strlst_append(l, p);
    }

    va_end(ap);
  }

  m = sip_contact_make(home, su_strlst_join(l, lhome, ""));

  su_strlst_destroy(l);

  return m;
}

137
/** Convert a @Via header to @Contact header.
138
 *
139
 * The @Contact URI will contain the port number if needed. If transport
140 141 142 143
 * protocol name starts with "TLS", "SIPS:" URI schema is used. Transport
 * parameter is included in the URI unless the transport protocol is UDP.
 *
 * @param home      memory home
Pekka Pessi's avatar
Pekka Pessi committed
144
 * @param v         @Via header field structure
145
 *                  (with <sent-protocol> and <sent-by> parameters)
146
 * @param user      username for @Contact URI (may be NULL)
147 148 149 150
 *
 * @retval contact header structure
 * @retval NULL upon an error
 *
Pekka Pessi's avatar
Pekka Pessi committed
151
 * @sa sip_contact_create_from_via_with_transport(),
152 153
 *     sip_contact_string_from_via()
 */
Pekka Pessi's avatar
Pekka Pessi committed
154
sip_contact_t *
155
sip_contact_create_from_via(su_home_t *home,
Pekka Pessi's avatar
Pekka Pessi committed
156 157 158
			    sip_via_t const *v,
			    char const *user)
{
159
  const char *tp;
Pekka Pessi's avatar
Pekka Pessi committed
160 161 162

  if (!v) return NULL;

163
  tp = v->v_protocol;
164

165
  if (tp == sip_transport_udp ||
166
      su_casematch(tp, sip_transport_udp))  /* Default is UDP */
167 168 169 170 171
    tp = NULL;

  return sip_contact_create_from_via_with_transport(home, v, user, tp);
}

172
/** Convert a @Via header to @Contact header.
173
 *
174
 * The @Contact URI will contain the port number and transport parameters if
175 176 177 178
 * needed. If transport protocol name starts with "TLS", "SIPS:" URI schema
 * is used.
 *
 * @param home      memory home
179
 * @param v         @Via header field structure
180
 *                  (with <sent-by> parameter containing host and port)
181 182
 * @param user      username for @Contact URI (may be NULL)
 * @param transport transport name for @Contact URI (may be NULL)
183 184 185 186 187 188
 *
 * @retval contact header structure
 * @retval NULL upon an error
 *
 * @sa sip_contact_create_from_via(), sip_contact_string_from_via()
 */
189
sip_contact_t *
190
sip_contact_create_from_via_with_transport(su_home_t *home,
191 192 193
					   sip_via_t const *v,
					   char const *user,
					   char const *transport)
194 195 196 197 198 199 200
{
  char *s = sip_contact_string_from_via(NULL, v, user, transport);
  sip_contact_t *m = sip_contact_make(home, s);
  su_free(NULL, s);
  return m;
}

201
/** Convert a @Via header to @Contact URL string.
202
 *
203
 * The @Contact URI will contain the port number and transport parameters if
204 205 206 207 208 209 210
 * needed. If transport protocol name starts with "TLS", "SIPS:" URI schema
 * is used.
 *
 * The contact URI string returned will always have angle brackets ("<" and
 * ">") around it.
 *
 * @param home      memory home
211
 * @param v         @Via header field structure
212
 *                  (with <sent-by> parameter containing host and port)
213 214
 * @param user      username for @Contact URI (may be NULL)
 * @param transport transport name for @Contact URI (may be NULL)
215 216 217 218
 *
 * @retval string containing Contact URI with angle brackets
 * @retval NULL upon an error
 */
219 220 221 222 223
char *
sip_contact_string_from_via(su_home_t *home,
			    sip_via_t const *v,
			    char const *user,
			    char const *transport)
224 225
{
  const char *host, *port, *maddr, *comp;
226 227 228
  char const *scheme = "sip:";
  int one = 1;
  char _transport[16];
229 230 231

  if (!v) return NULL;

Pekka Pessi's avatar
Pekka Pessi committed
232
  host = v->v_host;
233 234 235
  if (v->v_received)
    host = v->v_received;
  port = sip_via_port(v, &one);
Pekka Pessi's avatar
Pekka Pessi committed
236
  maddr = v->v_maddr;
237
  comp = v->v_comp;
Pekka Pessi's avatar
Pekka Pessi committed
238

239
  if (host == NULL)
Pekka Pessi's avatar
Pekka Pessi committed
240 241
    return NULL;

242 243
  if (sip_transport_has_tls(v->v_protocol) ||
      sip_transport_has_tls(transport)) {
244
    scheme = "sips:";
245
    if (port && strcmp(port, SIPS_DEFAULT_SERV) == 0)
Pekka Pessi's avatar
Pekka Pessi committed
246
      port = NULL;
247 248 249
    if (port || host_is_ip_address(host))
      transport = NULL;
  }
250 251
  else if (port && strcmp(port, SIP_DEFAULT_SERV) == 0 &&
	   (host_is_ip_address(host) || host_has_domain_invalid(host))) {
252
    port = NULL;
Pekka Pessi's avatar
Pekka Pessi committed
253 254
  }

255
  if (su_casenmatch(transport, "SIP/2.0/", 8))
256 257 258 259 260
    transport += 8;

  /* Make transport parameter lowercase */
  if (transport && strlen(transport) < (sizeof _transport)) {
    char *s = strcpy(_transport, transport);
261
    short c;
Pekka Pessi's avatar
Pekka Pessi committed
262

263
    for (; (c = *s) && c != ';'; s++)
264 265
      if (isupper(c))
	*s = tolower(c);
266 267

    transport = _transport;
268 269
  }

270 271 272 273 274 275 276 277 278 279 280
  return su_strcat_all(home,
		       "<",
		       scheme,
		       user ? user : "", user ? "@" : "",
		       host,
		       SIP_STRLOG(":", port),
		       SIP_STRLOG(";transport=", transport),
		       SIP_STRLOG(";maddr=", maddr),
		       SIP_STRLOG(";comp=", comp),
		       ">",
		       NULL);
Pekka Pessi's avatar
Pekka Pessi committed
281 282
}

283 284 285 286 287 288 289 290 291
/** Check if tranport name refers to TLS */
int sip_transport_has_tls(char const *transport_name)
{
  if (!transport_name)
    return 0;

  if (transport_name == sip_transport_tls)
    return 1;

292 293
  /* transport name starts with TLS or SIP/2.0/TLS */
  return
294 295
    su_casenmatch(transport_name, "TLS", 3) ||
    su_casenmatch(transport_name, sip_transport_tls, 11);
296
}
297

Pekka Pessi's avatar
Pekka Pessi committed
298
/**Perform sanity check on a SIP message
Pekka Pessi's avatar
Pekka Pessi committed
299 300
 *
 * Check that the SIP message has all the mandatory fields.
Pekka Pessi's avatar
Pekka Pessi committed
301 302 303
 *
 * @param sip SIP message to be checked
 *
Pekka Pessi's avatar
Pekka Pessi committed
304
 * @return
305 306
 * When the SIP message fulfills the minimum requirements, return zero,
 * otherwise a negative status code.
Pekka Pessi's avatar
Pekka Pessi committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
 */
int
sip_sanity_check(sip_t const *sip)
{
  if (!sip ||
      !((sip->sip_request != NULL) ^ (sip->sip_status != NULL)) ||
      !sip->sip_to ||
      !sip->sip_from ||
      !sip->sip_call_id ||
      !sip->sip_cseq ||
      !sip->sip_via ||
      (sip->sip_flags & MSG_FLG_TRUNC))
    return -1;  /* Bad request */

  if (sip->sip_request) {
    url_t const *ruri = sip->sip_request->rq_url;

    switch (ruri->url_type) {
    case url_invalid:
      return -1;

    case url_sip: case url_sips: case url_im: case url_pres:
      if (!ruri->url_host || strlen(ruri->url_host) == 0)
	return -1;
      break;

Pekka Pessi's avatar
Pekka Pessi committed
333
    case url_tel:
Pekka Pessi's avatar
Pekka Pessi committed
334 335 336 337 338 339 340
      if (!ruri->url_user || strlen(ruri->url_user) == 0)
	return -1;
      break;
    }

    if (sip->sip_request->rq_method != sip->sip_cseq->cs_method)
      return -1;
341

Pekka Pessi's avatar
Pekka Pessi committed
342
    if (sip->sip_request->rq_method == sip_method_unknown &&
343 344
	!su_strmatch(sip->sip_request->rq_method_name,
		     sip->sip_cseq->cs_method_name))
Pekka Pessi's avatar
Pekka Pessi committed
345 346 347 348 349 350
      return -1;
  }

  return 0;
}

351 352 353 354 355 356
/** Decode a string containg header field.
 *
 * The header object is initialized with the contents of the string. The
 * string is modified when parsing. The home is used to allocate extra
 * memory required when parsing, e.g., for parameter list or when there
 * string contains multiple header fields.
Pekka Pessi's avatar
Pekka Pessi committed
357
 *
358 359 360 361 362 363 364
 * @deprecated
 * Use msg_header_make() or header-specific make functions, e.g.,
 * sip_via_make().
 *
 * @retval 0 when successful
 * @retval -1 upon an error.
 */
365
issize_t sip_header_field_d(su_home_t *home, sip_header_t *h, char *s, isize_t slen)
Pekka Pessi's avatar
Pekka Pessi committed
366 367
{
  if (h && s && s[slen] == '\0') {
368
    size_t n = span_lws(s);
Pekka Pessi's avatar
Pekka Pessi committed
369
    s += n; slen -= n;
370

371
    for (n = slen; n >= 1 && IS_LWS(s[n - 1]); n--)
Pekka Pessi's avatar
Pekka Pessi committed
372
      ;
Pekka Pessi's avatar
Pekka Pessi committed
373

374
    s[n] = '\0';
Pekka Pessi's avatar
Pekka Pessi committed
375

376 377
    assert(SIP_HDR_TEST(h));

Pekka Pessi's avatar
Pekka Pessi committed
378 379 380 381 382 383
    return h->sh_class->hc_parse(home, h, s, slen);
  }
  else
    return -1;
}

384 385 386 387
/** Encode a SIP header contents.
 *
 * @deprecated Use msg_header_field_e() instead.
 */
388
issize_t sip_header_field_e(char *b, isize_t bsiz, sip_header_t const *h, int flags)
Pekka Pessi's avatar
Pekka Pessi committed
389
{
390
  return msg_header_field_e(b, bsiz, h, flags);
Pekka Pessi's avatar
Pekka Pessi committed
391 392 393
}

/** Convert the header @a h to a string allocated from @a home. */
394
char *sip_header_as_string(su_home_t *home, sip_header_t const *h)
Pekka Pessi's avatar
Pekka Pessi committed
395
{
396
  ssize_t len;
Pekka Pessi's avatar
Pekka Pessi committed
397 398 399 400 401 402 403
  char *rv, s[128];

  if (h == NULL)
    return NULL;

  len = sip_header_field_e(s, sizeof(s), h, 0);

404
  if (len >= 0 && (size_t)len < sizeof(s))
Pekka Pessi's avatar
Pekka Pessi committed
405 406 407 408 409 410 411 412 413 414
    return su_strdup(home, s);

  if (len == -1)
    len = 2 * sizeof(s);
  else
    len += 1;

  for (rv = su_alloc(home, len);
       rv;
       rv = su_realloc(home, rv, len)) {
415
    ssize_t n = sip_header_field_e(rv, len, h, 0);
Pekka Pessi's avatar
Pekka Pessi committed
416 417 418
    if (n > -1 && n + 1 <= len)
      break;
    if (n > -1)			/* glibc >2.1 */
Pekka Pessi's avatar
Pekka Pessi committed
419
      len = n + 1;
Pekka Pessi's avatar
Pekka Pessi committed
420
    else			/* glibc 2.0 */
Pekka Pessi's avatar
Pekka Pessi committed
421
      len *= 2;
Pekka Pessi's avatar
Pekka Pessi committed
422 423 424 425 426 427
  }

  return rv;
}

/** Calculate size of a SIP header. */
428
isize_t sip_header_size(sip_header_t const *h)
Pekka Pessi's avatar
Pekka Pessi committed
429 430 431 432 433 434 435 436
{
  assert(h == NULL || h == SIP_NONE || h->sh_class);
  if (h == NULL || h == SIP_NONE)
    return 0;
  else
    return h->sh_class->hc_dxtra(h, h->sh_class->hc_size);
}

Pekka Pessi's avatar
Pekka Pessi committed
437
/** Duplicate a url or make a url out of string.
Pekka Pessi's avatar
Pekka Pessi committed
438 439 440 441 442 443 444 445
 * @deprecated Use url_hdup() instead.
 */
url_t *sip_url_dup(su_home_t *home, url_t const *o)
{
  return url_hdup(home, o);
}

/**Calculate Q value.
Pekka Pessi's avatar
Pekka Pessi committed
446
 *
447
 * Convert q-value string @a q to numeric value
Pekka Pessi's avatar
Pekka Pessi committed
448 449 450
 * in range (0..1000).  Q values are used, for instance, to describe
 * relative priorities of registered contacts.
 *
451
 * @param q q-value string <code>("1" | "." 1,3DIGIT)</code>
Pekka Pessi's avatar
Pekka Pessi committed
452
 *
453
 * @return An integer in range 0 .. 1000.
Pekka Pessi's avatar
Pekka Pessi committed
454
 */
455
unsigned sip_q_value(char const *q)
Pekka Pessi's avatar
Pekka Pessi committed
456
{
Pekka Pessi's avatar
Pekka Pessi committed
457
  unsigned value = 0;
Pekka Pessi's avatar
Pekka Pessi committed
458 459 460 461 462 463 464 465 466 467 468

  if (!q)
    return 1000;
  if (q[0] != '0' && q[0] != '.' && q[0] != '1')
    return 500; /* Garbage... */
  while (q[0] == '0')
    q++;
  if (q[0] >= '1' && q[0] <= '9')
    return 1000;
  if (q[0] == '\0')
    return 0;
Pekka Pessi's avatar
Pekka Pessi committed
469
  if (q[0] != '.')
Pekka Pessi's avatar
Pekka Pessi committed
470 471 472 473 474 475 476 477 478 479 480
    return 500;    /* Garbage... */

  if (q[1] >= '0' && q[1] <= '9') {
    value = (q[1] - '0') * 100;
    if (q[2] >= '0' && q[2] <= '9') {
      value += (q[2] - '0') * 10;
      if (q[3] >= '0' && q[3] <= '9') {
	value += (q[3] - '0');
	if (q[4] > '5' && q[4] <= '9')
	  /* Round upwards */
	  value += 1;
Pekka Pessi's avatar
Pekka Pessi committed
481
	else if (q[4] == '5')
Pekka Pessi's avatar
Pekka Pessi committed
482 483 484 485 486 487 488 489 490 491 492
	  value += value & 1; /* Round to even */
      }
    }
  }

  return value;
}


/**@ingroup sip_route
 *
Pekka Pessi's avatar
Pekka Pessi committed
493
 * Get first route header and remove it from its fragment chain.
Pekka Pessi's avatar
Pekka Pessi committed
494 495 496 497 498 499 500
 *
 */
sip_route_t *sip_route_remove(msg_t *msg, sip_t *sip)
{
  sip_route_t *r;

  if ((r = sip->sip_route))
Pekka Pessi's avatar
Pekka Pessi committed
501
    msg_header_remove(msg, (msg_pub_t *)sip, (msg_header_t *)r);
Pekka Pessi's avatar
Pekka Pessi committed
502 503 504 505 506 507

  return r;
}

/**@ingroup sip_route
 *
Pekka Pessi's avatar
Pekka Pessi committed
508
 * Get last route header and remove it from its fragment chain.
Pekka Pessi's avatar
Pekka Pessi committed
509 510 511 512 513 514
 *
 */
sip_route_t *sip_route_pop(msg_t *msg, sip_t *sip)
{
  sip_route_t *r;

Pekka Pessi's avatar
Pekka Pessi committed
515
  for (r = sip->sip_route; r; r = r->r_next)
Pekka Pessi's avatar
Pekka Pessi committed
516
    if (r->r_next == NULL) {
Pekka Pessi's avatar
Pekka Pessi committed
517
      msg_header_remove(msg, (msg_pub_t *)sip, (msg_header_t *)r);
Pekka Pessi's avatar
Pekka Pessi committed
518 519 520 521 522 523 524 525 526
      return r;
    }

  return NULL;
}


/**@ingroup sip_route
 *
Pekka Pessi's avatar
Pekka Pessi committed
527
 * Get first route header and rewrite the RequestURI.
Pekka Pessi's avatar
Pekka Pessi committed
528 529 530 531
 */
sip_route_t *sip_route_follow(msg_t *msg, sip_t *sip)
{
  if (sip->sip_route) {
Pekka Pessi's avatar
Pekka Pessi committed
532 533
    /* XXX - in case of outbound proxy, route may contain our address */

Pekka Pessi's avatar
Pekka Pessi committed
534 535 536 537 538 539 540
    sip_route_t *r = sip_route_remove(msg, sip);
    sip_request_t *rq = sip->sip_request;

    rq = sip_request_create(msg_home(msg), rq->rq_method, rq->rq_method_name,
			    (url_string_t const *)r->r_url, rq->rq_version);
    url_strip_transport(rq->rq_url);

Pekka Pessi's avatar
Pekka Pessi committed
541
    msg_header_insert(msg, (msg_pub_t *)sip, (msg_header_t *)rq);
Pekka Pessi's avatar
Pekka Pessi committed
542 543 544 545 546 547

    return r;
  }
  return NULL;
}

Pekka Pessi's avatar
Pekka Pessi committed
548
/**@ingroup sip_route
Pekka Pessi's avatar
Pekka Pessi committed
549
 *
Pekka Pessi's avatar
Pekka Pessi committed
550 551 552 553
 * Check if route header has lr param.
 *
 * "lr" param can be either URL or header parameter.
 */
Pekka Pessi's avatar
Pekka Pessi committed
554
int
Pekka Pessi's avatar
Pekka Pessi committed
555 556 557 558 559 560 561 562 563 564 565 566
sip_route_is_loose(sip_route_t const *r)
{
  if (!r)
    return 0;
  if (r->r_url->url_params)
    return url_has_param(r->r_url, "lr");
  else
    return r->r_params && msg_params_find(r->r_params, "lr") != NULL;
}

/**@ingroup sip_route
 *
567
 * Reverse a route header (@Route, @RecordRoute, @Path, @ServiceRoute).
Pekka Pessi's avatar
Pekka Pessi committed
568
 */
Pekka Pessi's avatar
Pekka Pessi committed
569
sip_route_t *sip_route_reverse_as(su_home_t *home,
570
				  msg_hclass_t *hc,
571
				  sip_route_t const *route)
Pekka Pessi's avatar
Pekka Pessi committed
572 573 574 575 576
{
  sip_route_t *reverse = NULL;
  sip_route_t r[1], *tmp;
  sip_route_init(r);

577 578
  r->r_common->h_class = hc;

Pekka Pessi's avatar
Pekka Pessi committed
579 580 581 582
  for (reverse = NULL; route; route = route->r_next) {
    *r->r_url = *route->r_url;
    /* Fix broken (Record-)Routes without <> */
    if (r->r_url->url_params == NULL
Pekka Pessi's avatar
Pekka Pessi committed
583 584
	&& r->r_params
	&& r->r_params[0]
Pekka Pessi's avatar
Pekka Pessi committed
585 586 587 588 589 590 591
	&& (r->r_params[0][0] == 'l' || r->r_params[0][0] == 'L')
	&& (r->r_params[0][1] == 'r' || r->r_params[0][1] == 'R')
	&& (r->r_params[0][2] == '=' || r->r_params[0][2] == 0))
      r->r_url->url_params = route->r_params[0],
	r->r_params = route->r_params + 1;
    else
      r->r_params = route->r_params;
592
    tmp = (sip_route_t *)msg_header_dup_as(home, hc, (msg_header_t *)r);
Pekka Pessi's avatar
Pekka Pessi committed
593
    if (!tmp)
Pekka Pessi's avatar
Pekka Pessi committed
594 595 596 597 598 599 600 601
      goto error;
    tmp->r_next = reverse;
    reverse = tmp;
  }

  return reverse;

 error:
602
  msg_header_free_all(home, (msg_header_t *)reverse);
Pekka Pessi's avatar
Pekka Pessi committed
603 604 605 606 607 608
  return NULL;
}


/**@ingroup sip_route
 *
Pekka Pessi's avatar
Pekka Pessi committed
609
 * Reverse a @Route header.
610
 *
611
 * Reverse A route header like @RecordRoute or @Path.
612 613 614 615 616 617 618 619
 */
sip_route_t *sip_route_reverse(su_home_t *home, sip_route_t const *route)
{
  return sip_route_reverse_as(home, sip_route_class, route);
}


/**@ingroup sip_route
Pekka Pessi's avatar
Pekka Pessi committed
620
 *
621
 * Fix and duplicate a route header (@Route, @RecordRoute, @Path, @ServiceRoute).
Pekka Pessi's avatar
Pekka Pessi committed
622 623
 *
 */
624
sip_route_t *sip_route_fixdup_as(su_home_t *home,
625
				 msg_hclass_t *hc,
626
				 sip_route_t const *route)
Pekka Pessi's avatar
Pekka Pessi committed
627 628 629 630 631 632 633 634 635 636
{
  sip_route_t *copy = NULL;
  sip_route_t r[1], **rr;
  sip_route_init(r);

  /* Copy the record route as route */
  for (rr = &copy; route; route = route->r_next) {
    *r->r_url = *route->r_url;
    /* Fix broken (Record-)Routes without <> */
    if (r->r_url->url_params == NULL
Pekka Pessi's avatar
Pekka Pessi committed
637 638
	&& r->r_params
	&& r->r_params[0]
Pekka Pessi's avatar
Pekka Pessi committed
639 640 641 642 643 644 645
	&& (r->r_params[0][0] == 'l' || r->r_params[0][0] == 'L')
	&& (r->r_params[0][1] == 'r' || r->r_params[0][1] == 'R')
	&& (r->r_params[0][2] == '=' || r->r_params[0][2] == 0))
      r->r_url->url_params = route->r_params[0],
	r->r_params = route->r_params + 1;
    else
      r->r_params = route->r_params;
646
    *rr = (sip_route_t *)msg_header_dup_as(home, hc, (msg_header_t *)r);
Pekka Pessi's avatar
Pekka Pessi committed
647 648 649 650 651 652 653
    if (!*rr) goto error;
    rr = &(*rr)->r_next;
  }

  return copy;

 error:
654
  msg_header_free_all(home, (msg_header_t *)copy);
Pekka Pessi's avatar
Pekka Pessi committed
655 656 657
  return NULL;
}

658 659 660

/**@ingroup sip_route
 *
Pekka Pessi's avatar
Pekka Pessi committed
661
 * Fix and duplicate a @Route header.
662
 *
663
 * Copy a route header like @RecordRoute or @Path as @Route.
664 665 666 667 668 669 670
 *
 */
sip_route_t *sip_route_fixdup(su_home_t *home, sip_route_t const *route)
{
  return sip_route_fixdup_as(home, sip_route_class, route);
}

Pekka Pessi's avatar
Pekka Pessi committed
671 672
/**@ingroup sip_route
 *
673
 * Fix @Route header.
Pekka Pessi's avatar
Pekka Pessi committed
674 675 676
 *
 * If URI has no parameters and the header contains a single @c ;lr header
 * parameter, the "lr" is moved as URI parameter.
Pekka Pessi's avatar
Pekka Pessi committed
677 678 679 680 681
 */
sip_route_t *sip_route_fix(sip_route_t *route)
{
  sip_route_t *r;
  sip_header_t *h = NULL;
682
  size_t i;
Pekka Pessi's avatar
Pekka Pessi committed
683 684 685

  for (r = route; r; r = r->r_next) {
    /* Keep track of first header structure on this header line */
Pekka Pessi's avatar
Pekka Pessi committed
686
    if (!h
687
	|| (char *)h->sh_data + h->sh_len != r->r_common->h_data
Pekka Pessi's avatar
Pekka Pessi committed
688 689 690 691
	|| r->r_common->h_len)
      h = (sip_header_t *)r;

    if (r->r_url->url_params == NULL
Pekka Pessi's avatar
Pekka Pessi committed
692 693
	&& r->r_params
	&& r->r_params[0]
Pekka Pessi's avatar
Pekka Pessi committed
694 695 696 697 698 699 700 701
	&& (r->r_params[0][0] == 'l' || r->r_params[0][0] == 'L')
	&& (r->r_params[0][1] == 'r' || r->r_params[0][1] == 'R')
	&& (r->r_params[0][2] == '=' || r->r_params[0][2] == 0)) {
      r->r_url->url_params = r->r_params[0];

      for (i = 0; r->r_params[i]; i++)
	((char const **)r->r_params)[i] = r->r_params[i + 1];

702
      msg_fragment_clear_chain((msg_header_t *)h);
Pekka Pessi's avatar
Pekka Pessi committed
703 704 705 706 707 708 709 710
    }
  }

  return route;
}

/**@ingroup sip_via
 *
Pekka Pessi's avatar
Pekka Pessi committed
711
 * Get first via header and remove it from its fragment chain.
Pekka Pessi's avatar
Pekka Pessi committed
712 713 714 715
 */
sip_via_t *sip_via_remove(msg_t *msg, sip_t *sip)
{
  sip_via_t *v;
Pekka Pessi's avatar
Pekka Pessi committed
716 717 718

  if (sip == NULL)
    return NULL;
Pekka Pessi's avatar
Pekka Pessi committed
719

720
  v = sip->sip_via;
Pekka Pessi's avatar
Pekka Pessi committed
721

722
  if (v)
Pekka Pessi's avatar
Pekka Pessi committed
723
    msg_header_remove(msg, (msg_pub_t *)sip, (msg_header_t *)v);
Pekka Pessi's avatar
Pekka Pessi committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

  return v;
}

/** Serialize payload.
 *
 * The sip_payload_serialize() adds missing headers to MIME multiparty payload,
 * encodes them and orders them in header chain.  It also calculates the total
 * length of the payload.
 */
unsigned long sip_payload_serialize(msg_t *msg, sip_payload_t *pl)
{
  unsigned long total;

  for (total = 0; pl; pl = (sip_payload_t *)pl->pl_next) {
    total += (unsigned)pl->pl_common->h_len;
  }

  return total;
}

Pekka Pessi's avatar
Pekka Pessi committed
745
/**
746 747
 * Remove extra parameters from an AOR URL.
 *
748
 * The extra parameters listed in the @RFC3261 table 1 include port number,
749
 * method, maddr, ttl, transport, lr and headers.
Pekka Pessi's avatar
Pekka Pessi committed
750
 *
751 752 753 754
 * @note The funtion modifies the @a url and the strings attached to it.
 *
 * @retval 0 when successful
 * @retval -1 upon an error
Pekka Pessi's avatar
Pekka Pessi committed
755 756 757 758 759 760 761 762 763
 */
int sip_aor_strip(url_t *url)
{
  if (url == NULL)
    return -1;

  url->url_port = NULL;
  url->url_headers = NULL;

764 765
  if (url->url_params)
    url_strip_transport(url);
Pekka Pessi's avatar
Pekka Pessi committed
766

767
  if (url->url_params)
Pekka Pessi's avatar
Pekka Pessi committed
768
    url->url_params =
769
      url_strip_param_string((char *)url->url_params, "lr");
Pekka Pessi's avatar
Pekka Pessi committed
770 771 772 773

  return 0;
}

774
/** Compare @SecurityVerify header with @SecurityServer header. */
Pekka Pessi's avatar
Pekka Pessi committed
775 776
int sip_security_verify_compare(sip_security_server_t const *s,
				sip_security_verify_t const *v,
Pekka Pessi's avatar
Pekka Pessi committed
777
				msg_param_t *return_d_ver)
Pekka Pessi's avatar
Pekka Pessi committed
778
{
779 780
  size_t i, j;
  int retval, digest;
Pekka Pessi's avatar
Pekka Pessi committed
781
  msg_param_t const *s_params, *v_params, empty[] = { NULL };
Pekka Pessi's avatar
Pekka Pessi committed
782 783 784 785 786 787 788 789 790 791

  if (return_d_ver)
    *return_d_ver = NULL;

  if (s == NULL)
    return 0;

  for (;;s = s->sa_next, v = v->sa_next) {
    if (s == NULL || v == NULL)
      return (s == NULL) - (v == NULL);
Pekka Pessi's avatar
Pekka Pessi committed
792

793
    if ((retval = su_strcmp(s->sa_mec, v->sa_mec)))
Pekka Pessi's avatar
Pekka Pessi committed
794 795
      return retval;

796
    digest = su_casematch(s->sa_mec, "Digest");
Pekka Pessi's avatar
Pekka Pessi committed
797 798 799 800 801 802

    s_params = s->sa_params, v_params = v->sa_params;

    if (digest && s_params == NULL && v_params != NULL)
      s_params = empty;

803
    if (s_params == NULL || v_params == NULL) {
Pekka Pessi's avatar
Pekka Pessi committed
804 805
      if ((retval = (s_params == NULL) - (v_params == NULL)))
	return retval;
806 807
      continue;
    }
Pekka Pessi's avatar
Pekka Pessi committed
808 809

    for (i = 0, j = 0;; i++, j++) {
Pekka Pessi's avatar
Pekka Pessi committed
810
      if (digest && v_params[j] &&
811
	  su_casenmatch(v_params[j], "d-ver=", 6)) {
Pekka Pessi's avatar
Pekka Pessi committed
812 813 814 815 816
	if (return_d_ver)
	  *return_d_ver = v_params[j] + strlen("d-ver=");
	j++;
      }

817
      retval = su_strcmp(s_params[i], v_params[j]);
Pekka Pessi's avatar
Pekka Pessi committed
818 819

      if (retval || s_params[i] == NULL || v_params[j] == NULL)
Pekka Pessi's avatar
Pekka Pessi committed
820 821 822 823 824 825 826 827
	break;
    }

    if (retval)
      return retval;
  }
}

Pekka Pessi's avatar
Pekka Pessi committed
828
/** Select best mechanism from @SecurityClient header.
Pekka Pessi's avatar
Pekka Pessi committed
829
 *
830
 * @note We assume that @SecurityServer header in @a s is sorted by
Pekka Pessi's avatar
Pekka Pessi committed
831 832 833
 * preference.
 */
sip_security_client_t const *
834 835
sip_security_client_select(sip_security_client_t const *client,
			   sip_security_server_t const *server)
Pekka Pessi's avatar
Pekka Pessi committed
836
{
837
  sip_security_server_t const *c, *s;
Pekka Pessi's avatar
Pekka Pessi committed
838

839 840
  if (server == NULL || client == NULL)
    return NULL;
Pekka Pessi's avatar
Pekka Pessi committed
841

842 843
  for (s = server; s; s = s->sa_next) {
    for (c = client; c; c = c->sa_next) {
844
      if (su_strmatch(s->sa_mec, c->sa_mec))
845
	return c;
Pekka Pessi's avatar
Pekka Pessi committed
846 847
    }
  }
848 849

  return NULL;
Pekka Pessi's avatar
Pekka Pessi committed
850 851 852 853
}

/**Checks if the response with given response code terminates dialog or
 * dialog usage.
Pekka Pessi's avatar
Pekka Pessi committed
854
 *
Pekka Pessi's avatar
Pekka Pessi committed
855 856 857
 * @return -1 if the response with given code terminates whole dialog.
 * @return 1 if the response terminates the dialog usage.
 * @return 0 if the response does not terminate dialog or dialog usage.
Pekka Pessi's avatar
Pekka Pessi committed
858
 *
859 860 861 862 863 864
 * @return
 * The @a *return_graceful_terminate_usage is set to 1, if application
 * should gracefully terminate its dialog usage. It is set to 0, if no
 * graceful terminate is required. If it is up to application policy to
 * decide whether to gracefully terminate or not, the
 * @a *return_graceful_terminate_usage is left unmodified.
Pekka Pessi's avatar
Pekka Pessi committed
865
 *
Pekka Pessi's avatar
Pekka Pessi committed
866
 * @RFC5057
Pekka Pessi's avatar
Pekka Pessi committed
867 868 869 870 871 872 873 874
 */
int sip_response_terminates_dialog(int response_code,
				   sip_method_t method,
				   int *return_graceful_terminate_usage)
{
  enum { no_effect, terminate_usage = 1, terminate_dialog = -1 };
  int dummy;

Pekka Pessi's avatar
Pekka Pessi committed
875
  if (!return_graceful_terminate_usage)
Pekka Pessi's avatar
Pekka Pessi committed
876 877 878 879 880
    return_graceful_terminate_usage = &dummy;

  if (response_code < 300)
    return *return_graceful_terminate_usage = 0;

Pekka Pessi's avatar
Pekka Pessi committed
881
  /*
Pekka Pessi's avatar
Pekka Pessi committed
882 883 884 885 886 887
      3xx responses: Redirection mid-dialog is not well understood in SIP,
      but whatever effect it has impacts the entire dialog and all of
      its usages equally.  In our example scenario, both the
      subscription and the invite usage would be redirected by this
      single response.
  */
Pekka Pessi's avatar
Pekka Pessi committed
888
  if (response_code < 400)
Pekka Pessi's avatar
Pekka Pessi committed
889 890 891 892
    return *return_graceful_terminate_usage = 0;

  if (response_code < 500) switch (response_code) {
  default:
Pekka Pessi's avatar
Pekka Pessi committed
893
  case 400: /** @par 400 and unrecognized 4xx responses
894

Pekka Pessi's avatar
Pekka Pessi committed
895 896 897 898 899 900 901 902 903
      These responses affect only the NOTIFY transaction, not the
      subscription, the dialog it resides in (beyond affecting the local
      CSeq), or any other usage of that dialog. In general, the response
      is a complaint about this transaction, not the usage or dialog the
      transaction occurs in.
    */
    *return_graceful_terminate_usage = 0;
    return 0;

Pekka Pessi's avatar
Pekka Pessi committed
904
  case 401:
905 906 907 908
  case 407: /** @par 401 Unauthorized and 407 Proxy Authentication Required

      This request, not the subscription or dialog, is being challenged. The
      usages and dialog are not terminated.
Pekka Pessi's avatar
Pekka Pessi committed
909
    */
Pekka Pessi's avatar
Pekka Pessi committed
910 911 912
    *return_graceful_terminate_usage = 0;
    return 0;

Pekka Pessi's avatar
Pekka Pessi committed
913
  case 402: /** @par 402 Payment Required
914

Pekka Pessi's avatar
Pekka Pessi committed
915 916 917 918 919 920
      This is a reserved response code. If encountered, it should be
      treated as an unrecognized 4xx.
    */
    *return_graceful_terminate_usage = 0;
    return 0;

Pekka Pessi's avatar
Pekka Pessi committed
921
  case 403: /** @par 403 Forbidden
922

Pekka Pessi's avatar
Pekka Pessi committed
923 924 925 926 927 928
      This response terminates the subscription, but has no effect on
      any other usages of the dialog. In our example scenario, the
      invite usage continues to exist. Similarly, if the 403 came in
      response to a re-INVITE, the invite usage would be terminated, but
      not the subscription.
    */
929 930
    *return_graceful_terminate_usage = 0;
    return 0;
Pekka Pessi's avatar
Pekka Pessi committed
931 932

  case 404: /** @par 404 Not Found
933

Pekka Pessi's avatar
Pekka Pessi committed
934 935
      This response destroys the dialog and all usages sharing it. The
      Request-URI that is being 404ed is the remote target set by the
936
      @Contact provided by the peer. Getting this response means
Pekka Pessi's avatar
Pekka Pessi committed
937 938 939 940
      something has gone fundamentally wrong with the dialog state.
    */
    return terminate_dialog;

Pekka Pessi's avatar
Pekka Pessi committed
941
  case 405: /** @par 405 Method Not Allowed
942

Pekka Pessi's avatar
Pekka Pessi committed
943 944 945 946 947 948 949
      In our example scenario, this response destroys the subscription,
      but not the invite usage or the dialog. It's an aberrant case for
      NOTIFYs to receive a 405 since they only come as a result to
      something that creates subscription. In general, a 405 within a
      given usage affects only that usage, but does not affect other
      usages of the dialog.
    */
950 951 952 953 954
    switch (method) {
    case sip_method_notify:
    case sip_method_subscribe:
    case sip_method_invite:
      return terminate_usage;
955 956 957
    default:
      *return_graceful_terminate_usage = 0;
      return 0;
958
    }
Pekka Pessi's avatar
Pekka Pessi committed
959

Pekka Pessi's avatar
Pekka Pessi committed
960
  case 406: /** @par 406 Not Acceptable
961

Pekka Pessi's avatar
Pekka Pessi committed
962
      These responses concern details of the message in the transaction.
Pekka Pessi's avatar
Pekka Pessi committed
963 964 965 966 967 968 969
      Subsequent requests in this same usage may succeed. Neither the
      usage nor dialog is terminated, other usages sharing this dialog
      are unaffected.
      */
    *return_graceful_terminate_usage = 0;
    return 0;

Pekka Pessi's avatar
Pekka Pessi committed
970
  case 408: /** @par 408 Request Timeout
971

Pekka Pessi's avatar
Pekka Pessi committed
972 973 974 975 976 977
      Receiving a 408 will have the same effect on
      usages and dialogs as a real transaction timeout as described in
      Section 3.2.
    */
    return terminate_usage;

Pekka Pessi's avatar
Pekka Pessi committed
978
  case 410: /** @par 410 Gone
979

Pekka Pessi's avatar
Pekka Pessi committed
980 981
      This response destroys the dialog and all usages sharing
      it.  The Request-URI that is being rejected is the remote target
982
      set by the @Contact provided by the peer.  Similar to 404, getting
Pekka Pessi's avatar
Pekka Pessi committed
983 984 985 986 987 988 989
      this response means something has gone fundamentally wrong with
      the dialog state, its slightly less aberrant in that the other
      endpoint recognizes that this was once a valid URI that it isn't
      willing to respond to anymore.
    */
    return terminate_dialog;

Pekka Pessi's avatar
Pekka Pessi committed
990
  case 412: /* Conditional Request Failed: */
Pekka Pessi's avatar
Pekka Pessi committed
991 992 993
  case 413: /* Request Entity Too Large: */
  case 414: /* Request-URI Too Long: */
  case 415: /* Unsupported Media Type: */
Pekka Pessi's avatar
Pekka Pessi committed
994
    /** @par 412, 413, 414 and 415
995

Pekka Pessi's avatar
Pekka Pessi committed
996
      These responses concern details of the message in the transaction.
Pekka Pessi's avatar
Pekka Pessi committed
997 998 999 1000 1001 1002 1003
      Subsequent requests in this same usage may succeed. Neither the usage
      nor dialog is terminated, other usages sharing this dialog are
      unaffected.
    */
    *return_graceful_terminate_usage = 0;
    return 0;

Pekka Pessi's avatar
Pekka Pessi committed
1004
  case 416: /** @par 416 Unsupported URI Scheme
1005

Pekka Pessi's avatar
Pekka Pessi committed
1006 1007
      Similar to 404 and 410, this response
      came to a request whose Request-URI was provided by the peer in a
1008
      @Contact header field.  Something has gone fundamentally wrong, and
Pekka Pessi's avatar
Pekka Pessi committed
1009 1010 1011 1012
      the dialog and all of its usages are destroyed.
    */
    return terminate_dialog;

1013 1014 1015 1016 1017
  case 417:
    /** @par 417 Uknown Resource-Priority
      The effect of this response on usages
      and dialogs is analgous to that for 420 and 488.  The usage is not
      affected.  The dialog is only affected by a change in its local
1018
      @CSeq.  No other usages of the dialog are affected.
1019 1020
    */

Pekka Pessi's avatar
Pekka Pessi committed
1021
  case 420: /* Bad Extension */
1022 1023 1024 1025
  case 421: /* Extension Required */

    /** @par 420 Bad Extension and 421 Extension Required

Pekka Pessi's avatar
Pekka Pessi committed
1026 1027
      These responses are objecting to the request, not the usage. The
      usage is not affected. The dialog is only affected by a change in
1028
      its local @CSeq. No other usages of the dialog are affected.
Pekka Pessi's avatar
Pekka Pessi committed
1029
    */