nta.c 278 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * 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 nta.c
Pekka Pessi's avatar
Pekka Pessi committed
26
 * @brief Sofia SIP Transaction API implementation
Pekka Pessi's avatar
Pekka Pessi committed
27 28 29 30 31
 * 
 * This source file has been divided into sections as follows:
 * 1) agent
 * 2) tport handling
 * 3) dispatching messages received from network
Pekka Pessi's avatar
Pekka Pessi committed
32
 * 4) message creation and message utility functions
Pekka Pessi's avatar
Pekka Pessi committed
33 34 35 36 37 38
 * 5) stateless operation
 * 6) dialogs (legs)
 * 7) server transactions (incoming)
 * 8) client transactions (outgoing)
 * 9) resolving URLs for client transactions
 * 10) 100rel reliable responses (reliable)
Pekka Pessi's avatar
Pekka Pessi committed
39
 * 11) SigComp handling and public transport interface
Pekka Pessi's avatar
Pekka Pessi committed
40 41 42 43 44 45 46 47
 * 
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * 
 * @date Created: Tue Jun 13 02:57:51 2000 ppessi
 */

#include "config.h"

48
#include <sofia-sip/string0.h>
Pekka Pessi's avatar
Pekka Pessi committed
49 50 51 52 53 54

/** @internal SU message argument structure type */
#define SU_MSG_ARG_T   union sm_arg_u
/** @internal SU timer argument pointer type */
#define SU_TIMER_ARG_T struct nta_agent_s

55 56 57
#include <sofia-sip/su_alloc.h>
#include <sofia-sip/su.h>
#include <sofia-sip/su_time.h>
58
#include <sofia-sip/su_wait.h>
59
#include <sofia-sip/su_tagarg.h>
Pekka Pessi's avatar
Pekka Pessi committed
60

61 62
#include <sofia-sip/base64.h>
#include <sofia-sip/su_uniqueid.h>
Pekka Pessi's avatar
Pekka Pessi committed
63

64 65 66 67
#include <sofia-sip/sip.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
68

69 70
#include <sofia-sip/hostdomain.h>

71
#include <sofia-sip/msg_addr.h>
Pekka Pessi's avatar
Pekka Pessi committed
72
#include <sofia-sip/msg_parser.h>
Pekka Pessi's avatar
Pekka Pessi committed
73 74

#include "nta_internal.h"
75 76
#include "sofia-sip/nta_stateless.h"
#include "sofia-sip/url_tag.h"
Pekka Pessi's avatar
Pekka Pessi committed
77

Pekka Pessi's avatar
Pekka Pessi committed
78 79 80 81 82 83 84 85
#include <stddef.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <assert.h>
#include <limits.h>
#include <errno.h>

Pekka Pessi's avatar
Pekka Pessi committed
86 87 88
/* From AM_INIT/AC_INIT in our "config.h" */
char const nta_version[] = PACKAGE_VERSION;

Pekka Pessi's avatar
Pekka Pessi committed
89 90 91 92 93 94 95 96 97 98 99
#if HAVE_FUNC
#elif HAVE_FUNCTION
#define __func__ __FUNCTION__
#else
static char const __func__[] = "nta";
#endif

#define NONE ((void *)-1)

/* Internal tags */

100
/* Delay sending of request */
Pekka Pessi's avatar
Pekka Pessi committed
101 102 103 104 105 106 107
#define NTATAG_DELAY_SENDING(x) ntatag_delay_sending, tag_bool_v((x))
#define NTATAG_DELAY_SENDING_REF(x) \
ntatag_delay_sending_ref, tag_bool_vr(&(x))

extern tag_typedef_t ntatag_delay_sending;
extern tag_typedef_t ntatag_delay_sending_ref;

108
/* Allow sending incomplete responses */
Pekka Pessi's avatar
Pekka Pessi committed
109 110 111 112 113 114 115
#define NTATAG_INCOMPLETE(x) ntatag_incomplete, tag_bool_v((x))
#define NTATAG_INCOMPLETE_REF(x) \
ntatag_incomplete_ref, tag_bool_vr(&(x))

extern tag_typedef_t ntatag_incomplete;
extern tag_typedef_t ntatag_incomplete_ref;

116 117
nta_compressor_vtable_t *nta_compressor_vtable = NULL;

Pekka Pessi's avatar
Pekka Pessi committed
118 119 120 121 122 123 124
/* Agent */
static int agent_tag_init(nta_agent_t *self);
static int agent_timer_init(nta_agent_t *agent);
static void agent_timer(su_root_magic_t *rm, su_timer_t *, nta_agent_t *);
static int agent_launch_terminator(nta_agent_t *agent);
static void agent_kill_terminator(nta_agent_t *agent);
static int agent_set_params(nta_agent_t *agent, tagi_t *tags);
125
static void agent_set_udp_params(nta_agent_t *self, usize_t udp_mtu);
Pekka Pessi's avatar
Pekka Pessi committed
126 127 128 129
static int agent_get_params(nta_agent_t *agent, tagi_t *tags);

/* Transport interface */
static sip_via_t const *agent_tport_via(tport_t *tport);
Pekka Pessi's avatar
Pekka Pessi committed
130
static int outgoing_insert_via(nta_outgoing_t *orq, sip_via_t const *);
Pekka Pessi's avatar
Pekka Pessi committed
131 132 133
static int nta_tpn_by_via(tp_name_t *tpn, sip_via_t const *v, int *using_rport);

static msg_t *nta_msg_create_for_transport(nta_agent_t *agent, int flags,
Pekka Pessi's avatar
Pekka Pessi committed
134 135 136
					   char const data[], usize_t dlen,
					   tport_t const *tport,
					   tp_client_t *via);
Pekka Pessi's avatar
Pekka Pessi committed
137

138 139
static int complete_response(msg_t *response, 
			     int status, char const *phrase, 
Pekka Pessi's avatar
Pekka Pessi committed
140
			     msg_t *request);
141

142 143
#define IF_SIGCOMP_TPTAG_COMPARTMENT(cc)     TAG_IF(cc, TPTAG_COMPARTMENT(cc)),
#define IF_SIGCOMP_TPTAG_COMPARTMENT_REF(cc) TPTAG_COMPARTMENT_REF(cc),
Pekka Pessi's avatar
Pekka Pessi committed
144

145
struct sigcomp_compartment;
146

Pekka Pessi's avatar
Pekka Pessi committed
147
struct sigcomp_compartment *
148
nta_compartment_ref(struct sigcomp_compartment *cc);
Pekka Pessi's avatar
Pekka Pessi committed
149 150 151

static
struct sigcomp_compartment *
152 153
agent_compression_compartment(nta_agent_t *sa, tport_t *tp, tp_name_t const *tpn,
			      int new_if_needed);
Pekka Pessi's avatar
Pekka Pessi committed
154 155

static
156 157
int agent_accept_compressed(nta_agent_t *sa, msg_t *msg,
			    struct sigcomp_compartment *cc);
Pekka Pessi's avatar
Pekka Pessi committed
158

159 160 161 162 163
static int agent_close_compressor(nta_agent_t *sa,
				  struct sigcomp_compartment *cc);

static int agent_zap_compressor(nta_agent_t *sa,
				struct sigcomp_compartment *cc);
Pekka Pessi's avatar
Pekka Pessi committed
164 165


Pekka Pessi's avatar
Pekka Pessi committed
166 167
static char const * stateful_branch(su_home_t *home, nta_agent_t *);
static char const * stateless_branch(nta_agent_t *, msg_t *, sip_t const *,
Pekka Pessi's avatar
Pekka Pessi committed
168 169 170 171 172
				    tp_name_t const *tp);

#define NTA_BRANCH_PRIME SU_U64_C(0xB9591D1C361C6521)
#define NTA_TAG_PRIME    SU_U64_C(0xB9591D1C361C6521)

Pekka Pessi's avatar
Pekka Pessi committed
173
HTABLE_PROTOS_WITH(leg_htable, lht, nta_leg_t, size_t, hash_value_t);
Pekka Pessi's avatar
Pekka Pessi committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
static nta_leg_t *leg_find(nta_agent_t const *sa,
			   char const *method_name,
			   url_t const *request_uri,
			   sip_call_id_t const *i,
			   char const *from_tag,
			   url_t const *from_uri,
			   char const *to_tag,
			   url_t const *to_uri);
static nta_leg_t *dst_find(nta_agent_t const *sa, url_t const *u0,
			   char const *method);
static void leg_recv(nta_leg_t *, msg_t *, sip_t *, tport_t *);
static void leg_free(nta_agent_t *sa, nta_leg_t *leg);

#define NTA_HASH(i, cs) ((i)->i_hash + 26839U * (uint32_t)(cs))

Pekka Pessi's avatar
Pekka Pessi committed
189
HTABLE_PROTOS_WITH(incoming_htable, iht, nta_incoming_t, size_t, hash_value_t);
Pekka Pessi's avatar
Pekka Pessi committed
190 191 192 193 194 195 196
static nta_incoming_t *incoming_create(nta_agent_t *agent,
				       msg_t *request,
				       sip_t *sip,
				       tport_t *tport,
				       char const *tag);
static int incoming_callback(nta_leg_t *leg, nta_incoming_t *irq, sip_t *sip);
static void incoming_free(nta_incoming_t *irq);
197 198
su_inline void incoming_cut_off(nta_incoming_t *irq);
su_inline void incoming_reclaim(nta_incoming_t *irq);
Pekka Pessi's avatar
Pekka Pessi committed
199 200 201 202 203 204
static void incoming_queue_init(incoming_queue_t *, 
				unsigned timeout);
static void incoming_queue_adjust(nta_agent_t *sa, 
				  incoming_queue_t *queue, 
				  unsigned timeout);

205
su_inline
Pekka Pessi's avatar
Pekka Pessi committed
206 207 208 209 210
nta_incoming_t *incoming_find(nta_agent_t const *agent, sip_t const *sip,
			      sip_via_t const *v,
			      nta_incoming_t **merge,
			      nta_incoming_t **ack);
static int incoming_reply(nta_incoming_t *irq, msg_t *msg, sip_t *sip);
211
su_inline int incoming_recv(nta_incoming_t *irq, msg_t *msg, sip_t *sip,
Pekka Pessi's avatar
Pekka Pessi committed
212
				tport_t *tport);
213
su_inline int incoming_ack(nta_incoming_t *irq, msg_t *msg, sip_t *sip,
Pekka Pessi's avatar
Pekka Pessi committed
214
			       tport_t *tport);
215
su_inline int incoming_cancel(nta_incoming_t *irq, msg_t *msg, sip_t *sip,
Pekka Pessi's avatar
Pekka Pessi committed
216
				  tport_t *tport);
217
su_inline int incoming_merge(nta_incoming_t *irq, msg_t *msg, sip_t *sip,
Pekka Pessi's avatar
Pekka Pessi committed
218
				 tport_t *tport);
219 220
su_inline int incoming_timestamp(nta_incoming_t *, msg_t *, sip_t *);
su_inline su_duration_t incoming_timer(nta_agent_t *, su_duration_t);
Pekka Pessi's avatar
Pekka Pessi committed
221 222 223 224 225 226 227 228 229 230 231

static nta_reliable_t *reliable_mreply(nta_incoming_t *,
				       nta_prack_f *, nta_reliable_magic_t *,
				       msg_t *, sip_t *);
static int reliable_send(nta_incoming_t *, nta_reliable_t *, msg_t *, sip_t *);
static int reliable_final(nta_incoming_t *irq, msg_t *msg, sip_t *sip);
static msg_t *reliable_response(nta_incoming_t *irq);
static int reliable_recv(nta_incoming_t *, msg_t *, sip_t *, tport_t *);
static void reliable_flush(nta_incoming_t *irq);
static void reliable_timeout(nta_incoming_t *irq, int timeout);

Pekka Pessi's avatar
Pekka Pessi committed
232
HTABLE_PROTOS_WITH(outgoing_htable, oht, nta_outgoing_t, size_t, hash_value_t);
Pekka Pessi's avatar
Pekka Pessi committed
233 234 235 236 237 238 239 240 241 242 243 244 245
static nta_outgoing_t *outgoing_create(nta_agent_t *agent,
				       nta_response_f *callback,
				       nta_outgoing_magic_t *magic,
				       url_string_t const *route_url,
				       tp_name_t const *tpn,
				       msg_t *msg,
				       tag_type_t tag, tag_value_t value, ...);
static void outgoing_queue_init(outgoing_queue_t *, 
				unsigned timeout);
static void outgoing_queue_adjust(nta_agent_t *sa, 
				  outgoing_queue_t *queue, 
				  unsigned timeout);
static void outgoing_free(nta_outgoing_t *orq);
246 247
su_inline void outgoing_cut_off(nta_outgoing_t *orq);
su_inline void outgoing_reclaim(nta_outgoing_t *orq);
Pekka Pessi's avatar
Pekka Pessi committed
248 249 250 251 252
static nta_outgoing_t *outgoing_find(nta_agent_t const *sa,
				     msg_t const *msg,
				     sip_t const *sip,
				     sip_via_t const *v);
static int outgoing_recv(nta_outgoing_t *orq, int status, msg_t *, sip_t *);
253
static void outgoing_default_recv(nta_outgoing_t *, int, msg_t *, sip_t *);
254
su_inline su_duration_t outgoing_timer(nta_agent_t *, su_duration_t);
Pekka Pessi's avatar
Pekka Pessi committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
static int outgoing_recv_reliable(nta_outgoing_t *orq, msg_t *msg, sip_t *sip);

/* Internal message passing */
union sm_arg_u {
  struct leg_recv_s {
    nta_leg_t    *leg;
    msg_t        *msg;
    tport_t      *tport;
  } a_leg_recv[1];

  struct outgoing_recv_s {
    nta_outgoing_t *orq;
    msg_t          *msg;
    sip_t          *sip;
    int             status;
  } a_outgoing_recv[1];

  incoming_queue_t a_incoming_queue[1];
  outgoing_queue_t a_outgoing_queue[1];
};

/* Global module data */

278
/**@var char const NTA_DEBUG[];
Pekka Pessi's avatar
Pekka Pessi committed
279 280 281 282 283 284
 *
 * Environment variable determining the default debug log level.
 *
 * The NTA_DEBUG environment variable is used to determine the default
 * debug logging level. The normal level is 3.
 * 
285
 * @sa <su_debug.h>, #su_log_global, #SOFIA_DEBUG
Pekka Pessi's avatar
Pekka Pessi committed
286 287 288 289 290 291 292 293 294 295
 */
extern char const NTA_DEBUG[];

#ifndef SU_DEBUG
#define SU_DEBUG 3
#endif

/**Debug log for @b nta module. 
 * 
 * The nta_log is the log object used by @b nta module. The level of
296
 * nta_log is set using #NTA_DEBUG environment variable.
Pekka Pessi's avatar
Pekka Pessi committed
297 298 299 300 301 302 303 304 305
 */
su_log_t nta_log[] = { SU_LOG_INIT("nta", "NTA_DEBUG", SU_DEBUG) };

/* ====================================================================== */
/* 1) Agent */

/**
 * Create an NTA agent object.
 *
Pekka Pessi's avatar
Pekka Pessi committed
306
 * Create an NTA agent object.  The agent
Pekka Pessi's avatar
Pekka Pessi committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
 * object creates and binds a server socket with address specified in @e url.
 * If the @e host portion of the @e url is @c "*", the agent listens to all
 * addresses available on the host.
 *
 * When a message is received, the agent object parses it.  If the result is
 * a valid SIP message, the agent object passes the message to the
 * application by invoking the nta_message_f @e callback function.
 *
 * @note
 * The @e url can be either parsed url (of type url_t ()), or a valid
 * SIP URL as a string.
 *
 * @note
 * If @e url is @c NULL, the default @e url @c "sip:*" is used.
 * @par
Pekka Pessi's avatar
Pekka Pessi committed
322 323
 * If @e url is @c NONE (iow, (void*)-1), no server sockets are bound.
 * @par
Pekka Pessi's avatar
Pekka Pessi committed
324 325 326 327 328
 * If @p transport parameters are specified in @a url, agent uses only
 * specified transport type.
 *
 * @par
 * If an @p maddr parameter is specified in @e url, agent binds to the
329 330 331
 * specified address, but uses @e host part of @e url when it generates
 * @Contact and @Via headers. The @p maddr parameter is also included,
 * unless it equals to @c INADDR_ANY (@p 0.0.0.0 or @p [::]).
Pekka Pessi's avatar
Pekka Pessi committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
 *
 * @param root          pointer to a su_root_t used for synchronization
 * @param contact_url   URL that agent uses to bind the server sockets
 * @param callback      pointer to callback function
 * @param magic         pointer to user data
 * @param tag,value,... other arguments
 *
 * @note It is possible to provide -1 as @a contact_url.
 * 
 * @retval handle to the agent when successful,
 * @retval NULL upon an error.
 *
 */
nta_agent_t *nta_agent_create(su_root_t *root,
			      url_string_t const *contact_url,
			      nta_message_f *callback,
			      nta_agent_magic_t *magic,
			      tag_type_t tag, tag_value_t value, ...)
{
  nta_agent_t *agent;
  ta_list ta;

  if (root == NULL)
    return su_seterrno(EINVAL), NULL;

  ta_start(ta, tag, value);

359
  if ((agent = su_home_new(sizeof(*agent)))) {
Pekka Pessi's avatar
Pekka Pessi committed
360 361 362 363 364
    agent->sa_root = root;
    agent->sa_callback = callback;
    agent->sa_magic = magic;
    agent->sa_flags = MSG_DO_CANONIC;

Pekka Pessi's avatar
Pekka Pessi committed
365
    agent->sa_maxsize         = 2 * 1024 * 1024; /* 2 MB */
366 367 368 369
    agent->sa_bad_req_mask    = 
      (unsigned) ~(sip_mask_response | sip_mask_proxy);
    agent->sa_bad_resp_mask   = 
      (unsigned) ~(sip_mask_request | sip_mask_proxy);
Pekka Pessi's avatar
Pekka Pessi committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    agent->sa_t1 	      = NTA_SIP_T1;
    agent->sa_t2 	      = NTA_SIP_T2;
    agent->sa_t4              = NTA_SIP_T4;
    agent->sa_t1x64 	      = 64 * NTA_SIP_T1;
    agent->sa_drop_prob       = 0;
    agent->sa_is_a_uas        = 0;
    agent->sa_progress        = 60 * 1000;
    agent->sa_user_via        = 0;
    agent->sa_extra_100       = 0;
    agent->sa_pass_100        = 0;
    agent->sa_timeout_408     = 1;
    agent->sa_pass_408        = 0;
    agent->sa_merge_482       = 0;
    agent->sa_cancel_2543     = 0;
    agent->sa_cancel_487      = 1;
    agent->sa_invite_100rel   = 0;
    agent->sa_timestamp       = 0;
    agent->sa_use_naptr       = 1;
    agent->sa_use_srv         = 1;
    agent->sa_auto_comp       = 0;
    agent->sa_server_rport    = 1;

    /* RFC 3261 section 8.1.1.6 */
393
    sip_max_forwards_init(agent->sa_max_forwards);
Pekka Pessi's avatar
Pekka Pessi committed
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549

    if (getenv("SIPCOMPACT"))
      agent->sa_flags |= MSG_DO_COMPACT;

    agent_set_params(agent, ta_args(ta));

    if (agent->sa_mclass == NULL)
      agent->sa_mclass = sip_default_mclass();

    agent->sa_in.re_t1 = &agent->sa_in.re_list;
    
    incoming_queue_init(agent->sa_in.proceeding, 0);
    incoming_queue_init(agent->sa_in.preliminary, agent->sa_t1x64); /* P1 */
    incoming_queue_init(agent->sa_in.inv_completed, agent->sa_t1x64); /* H */
    incoming_queue_init(agent->sa_in.inv_confirmed, agent->sa_t4); /* I */
    incoming_queue_init(agent->sa_in.completed, agent->sa_t1x64); /* J */
    incoming_queue_init(agent->sa_in.terminated, 0);
    incoming_queue_init(agent->sa_in.final_failed, 0); 

    agent->sa_out.re_t1 = &agent->sa_out.re_list;

    outgoing_queue_init(agent->sa_out.delayed, 0);
    outgoing_queue_init(agent->sa_out.resolving, 0);
    outgoing_queue_init(agent->sa_out.trying, agent->sa_t1x64); /* F */
    outgoing_queue_init(agent->sa_out.completed, agent->sa_t4); /* K */
    outgoing_queue_init(agent->sa_out.terminated, 0); 
    /* Special queues (states) for outgoing INVITE transactions */
    outgoing_queue_init(agent->sa_out.inv_calling, agent->sa_t1x64); /* B */
    outgoing_queue_init(agent->sa_out.inv_proceeding, 0); 
    outgoing_queue_init(agent->sa_out.inv_completed, 32000); /* Timer D */

    if (leg_htable_resize(agent->sa_home, agent->sa_dialogs, 0) < 0 ||
	leg_htable_resize(agent->sa_home, agent->sa_defaults, 0) < 0 ||
	outgoing_htable_resize(agent->sa_home, agent->sa_outgoing, 0) < 0 ||
	incoming_htable_resize(agent->sa_home, agent->sa_incoming, 0) < 0) {
      SU_DEBUG_0(("nta_agent_create: failure with %s\n", "hash tables"));
      goto deinit;
    }
    SU_DEBUG_9(("nta_agent_create: initialized %s\n", "hash tables"));

    if (contact_url != (url_string_t *)-1 &&
	nta_agent_add_tport(agent, contact_url, ta_tags(ta)) < 0) {
      SU_DEBUG_7(("nta_agent_create: failure with %s\n", "transport"));
      goto deinit;
    }
    SU_DEBUG_9(("nta_agent_create: initialized %s\n", "transports"));

    if (agent_tag_init(agent) < 0) {
      SU_DEBUG_3(("nta_agent_create: failure with %s\n", "random identifiers"));
      goto deinit;
    }
    SU_DEBUG_9(("nta_agent_create: initialized %s\n", "random identifiers"));

    if (agent_timer_init(agent) < 0) {
      SU_DEBUG_0(("nta_agent_create: failure with %s\n", "timer"));
      goto deinit;
    }
    SU_DEBUG_9(("nta_agent_create: initialized %s\n", "timer"));

    if (agent_launch_terminator(agent) == 0)
      SU_DEBUG_9(("nta_agent_create: initialized %s\n", "threads"));

#if HAVE_SOFIA_SRESOLV
    agent->sa_resolver = sres_resolver_create(root, NULL, ta_tags(ta));
    if (!agent->sa_resolver) {
      SU_DEBUG_0(("nta_agent_create: failure with %s\n", "resolver"));
    }
    SU_DEBUG_9(("nta_agent_create: initialized %s\n", "resolver"));
#endif

    ta_end(ta);

    return agent;

  deinit:
    nta_agent_destroy(agent);
  }

  ta_end(ta);

  return NULL;
}

/**
 * Destroy an NTA agent object.
 *
 * @param agent the NTA agent object to be destroyed.
 *
 */
void nta_agent_destroy(nta_agent_t *agent)
{
  if (agent) {
    size_t i;
    outgoing_htable_t *oht = agent->sa_outgoing;
    incoming_htable_t *iht = agent->sa_incoming;
    /* Currently, this is pretty pointless, as legs don't keep any resources */
    leg_htable_t *lht;
    nta_leg_t *leg;

    for (i = 0, lht = agent->sa_dialogs; i < lht->lht_size; i++) {
      if ((leg = lht->lht_table[i])) {
	SU_DEBUG_3(("nta_agent_destroy: destroying dialog with <"
		    URL_PRINT_FORMAT ">\n",
		    URL_PRINT_ARGS(leg->leg_remote->a_url)));
	leg_free(agent, leg);
      }
    }

    for (i = 0, lht = agent->sa_defaults; i < lht->lht_size; i++) {
      if ((leg = lht->lht_table[i])) {
	SU_DEBUG_3(("%s: destroying leg for <" 
		    URL_PRINT_FORMAT ">\n",
		    __func__, URL_PRINT_ARGS(leg->leg_url)));
	leg_free(agent, leg);
      }
    }

    if (agent->sa_default_leg)
      leg_free(agent, agent->sa_default_leg);

    for (i = iht->iht_size; i-- > 0; )
      while (iht->iht_table[i]) {
	nta_incoming_t *irq = iht->iht_table[i];

	if (!irq->irq_destroyed)
	  SU_DEBUG_3(("%s: destroying %s server transaction from <"
		      URL_PRINT_FORMAT ">\n",
		      __func__, irq->irq_rq->rq_method_name,
		      URL_PRINT_ARGS(irq->irq_from->a_url)));

	incoming_free(irq);
      }

    for (i = oht->oht_size; i-- > 0;)
      while (oht->oht_table[i]) {
	nta_outgoing_t *orq = oht->oht_table[i];

	if (!orq->orq_destroyed)
	  SU_DEBUG_3(("%s: destroying %s client transaction to <"
		      URL_PRINT_FORMAT ">\n",
		      __func__, orq->orq_method_name,
		      URL_PRINT_ARGS(orq->orq_to->a_url)));

	outgoing_free(orq);
      }

    su_timer_destroy(agent->sa_timer), agent->sa_timer = NULL;

#   if HAVE_SOFIA_SRESOLV
    sres_resolver_destroy(agent->sa_resolver), agent->sa_resolver = NULL;
#   endif

    tport_destroy(agent->sa_tports), agent->sa_tports = NULL;

    agent_kill_terminator(agent);

550
    su_home_unref(agent->sa_home);
Pekka Pessi's avatar
Pekka Pessi committed
551 552 553 554 555 556 557 558 559
  }
}

/** Return agent context. */
nta_agent_magic_t *nta_agent_magic(nta_agent_t const *agent)
{
  return agent ? agent->sa_magic : NULL;
}

560
/** Return @Contact header.
Pekka Pessi's avatar
Pekka Pessi committed
561
 *
Pekka Pessi's avatar
Pekka Pessi committed
562
 * Get a @Contact header, which can be used to reach @a agent.
Pekka Pessi's avatar
Pekka Pessi committed
563 564 565
 *
 * @param agent NTA agent object
 *
566
 * User agents can insert the @Contact header in the outgoing REGISTER,
Pekka Pessi's avatar
Pekka Pessi committed
567 568 569
 * INVITE, and ACK requests and replies to incoming INVITE and OPTIONS
 * transactions.
 *
570
 * Proxies can use the @Contact header to create appropriate @RecordRoute
Pekka Pessi's avatar
Pekka Pessi committed
571 572 573 574 575 576
 * headers:
 * @code
 * r_r = sip_record_route_create(msg_home(msg),
 *	 			 sip->sip_request->rq_url,
 *				 contact->m_url);
 * @endcode
Pekka Pessi's avatar
Pekka Pessi committed
577 578
 *
 * @return A sip_contact_t object corresponding to the @a agent.
Pekka Pessi's avatar
Pekka Pessi committed
579 580 581 582 583 584
 */
sip_contact_t *nta_agent_contact(nta_agent_t const *agent)
{
  return agent ? agent->sa_contact : NULL;
}

585
/** Return a list of @Via headers.
Pekka Pessi's avatar
Pekka Pessi committed
586
 *
Pekka Pessi's avatar
Pekka Pessi committed
587
 * Get @Via headers for all activated transport.
Pekka Pessi's avatar
Pekka Pessi committed
588 589 590
 *
 * @param agent NTA agent object
 *
Pekka Pessi's avatar
Pekka Pessi committed
591
 * @return A list of #sip_via_t objects used by the @a agent.
Pekka Pessi's avatar
Pekka Pessi committed
592 593 594 595 596 597
 */
sip_via_t *nta_agent_via(nta_agent_t const *agent)
{
  return agent ? agent->sa_vias : NULL;
}

598
/** Return a list of public (UPnP, STUN) @Via headers.
Pekka Pessi's avatar
Pekka Pessi committed
599
 *
Pekka Pessi's avatar
Pekka Pessi committed
600
 * Get public @Via headers for all activated transports.
Pekka Pessi's avatar
Pekka Pessi committed
601 602
 *
 * @param agent NTA agent object
603
 *
Pekka Pessi's avatar
Pekka Pessi committed
604
 * @return A list of #sip_via_t objects used by the @a agent.
Pekka Pessi's avatar
Pekka Pessi committed
605 606 607 608 609 610
 */
sip_via_t *nta_agent_public_via(nta_agent_t const *agent)
{
  return agent ? agent->sa_public_vias : NULL;
}

611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
/** Match a @Via header @a v with @Via headers in @a agent.
 *
 */
static
sip_via_t *agent_has_via(nta_agent_t const *agent, sip_via_t const *via)
{
  sip_via_t const *v;

  for (v = agent->sa_public_vias; v; v = v->v_next) {
    if (strcasecmp(via->v_host, v->v_host))
      continue;
    if (str0cmp(via->v_port, v->v_port))
      continue;
    if (strcasecmp(via->v_protocol, v->v_protocol))
      continue;
    return (sip_via_t *)v;
  }

  for (v = agent->sa_vias; v; v = v->v_next) {
    if (strcasecmp(via->v_host, v->v_host))
      continue;
    if (str0cmp(via->v_port, v->v_port))
      continue;
    if (strcasecmp(via->v_protocol, v->v_protocol))
      continue;
    return (sip_via_t *)v;
  }

  return NULL;
}

642
/** Return @UserAgent header.
Pekka Pessi's avatar
Pekka Pessi committed
643
 *
Pekka Pessi's avatar
Pekka Pessi committed
644
 * Get @UserAgent information with NTA version.
Pekka Pessi's avatar
Pekka Pessi committed
645
 *
Pekka Pessi's avatar
Pekka Pessi committed
646
 * @param agent NTA agent object (may be NULL)
Pekka Pessi's avatar
Pekka Pessi committed
647
 *
Pekka Pessi's avatar
Pekka Pessi committed
648
 * @return A string containing the @a agent version.
Pekka Pessi's avatar
Pekka Pessi committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
 */
char const *nta_agent_version(nta_agent_t const *agent)
{
  return "nta" "/" VERSION;
}

/** Initialize default tag */
static int agent_tag_init(nta_agent_t *self)
{
  sip_contact_t *m = self->sa_contact;
  uint32_t hash = 1;

  if (m) {

    if (m->m_url->url_user)
      hash = 914715421U * hash + msg_hash_string(m->m_url->url_user);
    if (m->m_url->url_host)
      hash = 914715421U * hash + msg_hash_string(m->m_url->url_host);
    if (m->m_url->url_port)
      hash = 914715421U * hash + msg_hash_string(m->m_url->url_port);
    if (m->m_url->url_params)
      hash = 914715421U * hash + msg_hash_string(m->m_url->url_params);
  }

  if (hash == 0)
    hash = 914715421U;

  self->sa_branch = NTA_BRANCH_PRIME * su_ntp_now();
  self->sa_branch *= hash;

  self->sa_tags = NTA_TAG_PRIME * self->sa_branch;

  return 0;
}

/** Initialize agent timer. */
static
int agent_timer_init(nta_agent_t *agent)
{
688 689 690 691
  agent->sa_timer = su_timer_create(su_root_task(agent->sa_root),
				    NTA_SIP_T1 / 8);
#if 0
  return su_timer_set(agent->sa_timer,
Pekka Pessi's avatar
Pekka Pessi committed
692 693
		      agent_timer,
		      agent);
694 695
#endif
  return -(agent->sa_timer == NULL);
Pekka Pessi's avatar
Pekka Pessi committed
696 697
}

698 699 700
#define NEXT_TIMEOUT(next, p, f, now) \
  (p && p->f - (next) < 0 ? (p->f - (now) > 0 ? p->f : (now)) : (next))

Pekka Pessi's avatar
Pekka Pessi committed
701 702 703 704 705 706
/**
 * Agent timer routine.
 */
static
void agent_timer(su_root_magic_t *rm, su_timer_t *timer, nta_agent_t *agent)
{
707 708
  su_time_t stamp = su_now();
  su_duration_t now = su_time_ms(stamp), next;
Pekka Pessi's avatar
Pekka Pessi committed
709 710 711

  now += now == 0;

712
  agent->sa_now = stamp;
Pekka Pessi's avatar
Pekka Pessi committed
713
  agent->sa_millisec = now;
714 715
  agent->sa_next = 0;
  agent->sa_in_timer = 1;
Pekka Pessi's avatar
Pekka Pessi committed
716

717 718 719
  next = now + SU_DURATION_MAX;
  next = outgoing_timer(agent, next);
  next = incoming_timer(agent, next);
Pekka Pessi's avatar
Pekka Pessi committed
720 721

  agent->sa_millisec = 0;
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
  agent->sa_in_timer = 0;

  if (agent->sa_next)
    next = NEXT_TIMEOUT(next, agent, sa_next, now);

  if (next == now + SU_DURATION_MAX) {
    /* Do not set timer */
    SU_DEBUG_9(("nta: timer not set\n"));
    assert(!agent->sa_out.completed->q_head);
    assert(!agent->sa_out.trying->q_head);
    assert(!agent->sa_out.inv_calling->q_head);
    assert(!agent->sa_out.re_list);
    assert(!agent->sa_in.inv_confirmed->q_head);
    assert(!agent->sa_in.preliminary->q_head);
    assert(!agent->sa_in.completed->q_head);
    assert(!agent->sa_in.inv_completed->q_head);
    assert(!agent->sa_in.re_list);
    return;
  }
Pekka Pessi's avatar
Pekka Pessi committed
741

742 743 744 745 746 747 748
  if (next == now) if (++next == 0) ++next;

  SU_DEBUG_9(("nta: timer %s to %ld ms\n", "set next", (long)(next - now)));

  agent->sa_next = next;

  su_timer_set_at(timer, agent_timer, agent, su_time_add(stamp, next - now));
Pekka Pessi's avatar
Pekka Pessi committed
749 750
}

751 752 753 754 755 756 757 758 759
/** Calculate nonzero value for timeout.
 *
 * Sets or adjusts agent timer when needed.
 *
 * @retval 0 if offset is 0
 * @retval timeout (millisecond counter) otherwise
 */
static
su_duration_t set_timeout(nta_agent_t *agent, su_duration_t offset)
Pekka Pessi's avatar
Pekka Pessi committed
760
{
761 762
  su_time_t now;
  su_duration_t next, ms;
Pekka Pessi's avatar
Pekka Pessi committed
763

764 765 766 767 768
  if (offset == 0)
    return 0;

  if (agent->sa_millisec) /* Avoid expensive call to su_timer_ms() */
    now = agent->sa_now, ms = agent->sa_millisec;
Pekka Pessi's avatar
Pekka Pessi committed
769
  else
770 771 772
    now = su_now(), ms = (su_duration_t)su_time_ms(now);
  
  next = ms + offset; if (next == 0) next = 1;
Pekka Pessi's avatar
Pekka Pessi committed
773

774 775 776 777 778 779 780 781 782 783 784
  if (agent->sa_in_timer)
    return next;

  if (agent->sa_next == 0 || agent->sa_next - next - 5L > 0) {
    /* Set timer */
    if (agent->sa_next)
      SU_DEBUG_9(("nta: timer %s to %ld ms\n", "shortened", (long)offset));
    else
      SU_DEBUG_9(("nta: timer %s to %ld ms\n", "set", (long)offset));
      
    su_timer_set_at(agent->sa_timer, agent_timer, agent, 
Pekka Pessi's avatar
Pekka Pessi committed
785
		    su_time_add(now, offset));
786 787
    agent->sa_next = next;
  }
Pekka Pessi's avatar
Pekka Pessi committed
788

789
  return next;
Pekka Pessi's avatar
Pekka Pessi committed
790 791 792 793
}


/** Return current timeval. */
794
static
Pekka Pessi's avatar
Pekka Pessi committed
795 796
su_time_t agent_now(nta_agent_t const *agent)
{
Pekka Pessi's avatar
Pekka Pessi committed
797 798 799 800
  if (agent && agent->sa_millisec != 0)
    return agent->sa_now;
  else 
    return su_now();
Pekka Pessi's avatar
Pekka Pessi committed
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
}


/** Launch transaction terminator task */
static
int agent_launch_terminator(nta_agent_t *agent)
{
#ifdef TPTAG_THRPSIZE
  if (agent->sa_tport_threadpool) {
    su_home_threadsafe(agent->sa_home);
    return su_clone_start(agent->sa_root, 
			  agent->sa_terminator,
			  NULL,
			  NULL,
			  NULL);
  }
#endif
  return -1;
}

/** Kill transaction terminator task */
static
void agent_kill_terminator(nta_agent_t *agent)
{
  su_clone_wait(agent->sa_root, agent->sa_terminator);
}


/**Set NTA Parameters.
 *
 * The nta_agent_set_params() function sets the stack parameters. The
 * parameters determine the way NTA handles the retransmissions, how long
 * NTA keeps transactions alive, does NTA apply proxy or user-agent logic to
834
 * INVITE transactions, or how the @Via headers are generated.
Pekka Pessi's avatar
Pekka Pessi committed
835 836 837 838 839 840 841 842 843 844
 *
 * @note 
 * Setting the parameters NTATAG_MAXSIZE(), NTATAG_UDP_MTU(),
 * NTATAG_SIP_T1X64(), NTATAG_SIP_T1(), NTATAG_SIP_T2(), NTATAG_SIP_T4() to
 * 0 selects the default value.
 *
 * @TAGS
 * NTATAG_ALIASES(), NTATAG_BAD_REQ_MASK(), NTATAG_BAD_RESP_MASK(),
 * NTATAG_CANCEL_2543(), NTATAG_CANCEL_487(), NTATAG_DEBUG_DROP_PROB(),
 * NTATAG_DEFAULT_PROXY(), NTATAG_EXTRA_100(), NTATAG_MAXSIZE(),
845
 * NTATAG_MAX_FORWARDS(),
Pekka Pessi's avatar
Pekka Pessi committed
846
 * NTATAG_UDP_MTU(), NTATAG_MERGE_482(), NTATAG_PASS_100(),
Pekka Pessi's avatar
Pekka Pessi committed
847 848
 * NTATAG_PRELOAD(), NTATAG_REL100(), NTATAG_RPORT(), NTATAG_SERVER_RPORT(),
 * NTATAG_TCP_RPORT(),
Pekka Pessi's avatar
Pekka Pessi committed
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
 * NTATAG_SIPFLAGS(), NTATAG_SIP_T1X64(), NTATAG_SIP_T1(), NTATAG_SIP_T2(),
 * NTATAG_SIP_T4(), NTATAG_SMIME(), NTATAG_STATELESS(), NTATAG_TAG_3261(),
 * NTATAG_TIMEOUT_408(), NTATAG_PASS_408(), NTATAG_UA(), NTATAG_USER_VIA(),
 * and NTATAG_USE_TIMESTAMP().
 */
int nta_agent_set_params(nta_agent_t *agent,
			 tag_type_t tag, tag_value_t value, ...)
{
  int retval;

  if (agent) {
    ta_list ta;
    ta_start(ta, tag, value);
    retval = agent_set_params(agent, ta_args(ta));
    ta_end(ta);
  } else {
    su_seterrno(EINVAL);
    retval = -1;
  }

  return retval;
}

/** Internal function for setting tags */
static
int agent_set_params(nta_agent_t *agent, tagi_t *tags)
{
  int n, m;
  unsigned bad_req_mask = agent->sa_bad_req_mask;
  unsigned bad_resp_mask = agent->sa_bad_resp_mask;
Pekka Pessi's avatar
Pekka Pessi committed
879
  usize_t  maxsize    = agent->sa_maxsize;
880
  unsigned max_forwards = agent->sa_max_forwards->mf_count;
Pekka Pessi's avatar
Pekka Pessi committed
881
  usize_t  udp_mtu    = agent->sa_udp_mtu;
Pekka Pessi's avatar
Pekka Pessi committed
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
  unsigned sip_t1     = agent->sa_t1;
  unsigned sip_t2     = agent->sa_t2;
  unsigned sip_t4     = agent->sa_t4;
  unsigned sip_t1x64  = agent->sa_t1x64;
  unsigned blacklist  = agent->sa_blacklist;
  int ua              = agent->sa_is_a_uas;
  unsigned progress   = agent->sa_progress;
  int stateless       = agent->sa_is_stateless;
  unsigned drop_prob  = agent->sa_drop_prob;
  int user_via        = agent->sa_user_via;
  int extra_100       = agent->sa_extra_100;
  int pass_100        = agent->sa_pass_100;
  int timeout_408     = agent->sa_timeout_408;
  int pass_408        = agent->sa_pass_408;
  int merge_482       = agent->sa_merge_482;
  int cancel_2543     = agent->sa_cancel_2543;
  int cancel_487      = agent->sa_cancel_487;
  int invite_100rel   = agent->sa_invite_100rel;
  int use_timestamp   = agent->sa_timestamp;
  int use_naptr       = agent->sa_use_naptr;
  int use_srv         = agent->sa_use_srv;
  void *smime         = agent->sa_smime;
  uint32_t flags      = agent->sa_flags;
  int rport           = agent->sa_rport;
  int server_rport    = agent->sa_server_rport;
Pekka Pessi's avatar
Pekka Pessi committed
907
  int tcp_rport       = agent->sa_tcp_rport;
Pekka Pessi's avatar
Pekka Pessi committed
908 909 910 911
  unsigned preload         = agent->sa_preload;
  unsigned threadpool      = agent->sa_tport_threadpool;
  char const *sigcomp = agent->sa_sigcomp_options;
  char const *algorithm = NONE;
912
  msg_mclass_t const *mclass = NONE;
Pekka Pessi's avatar
Pekka Pessi committed
913 914 915 916 917 918 919 920 921 922 923 924 925 926
  sip_contact_t const *aliases = NONE;
  url_string_t const *proxy = NONE;
  tport_t *tport;

  su_home_t *home = agent->sa_home;

  n = tl_gets(tags,
	      NTATAG_MCLASS_REF(mclass),
	      NTATAG_BAD_REQ_MASK_REF(bad_req_mask),
	      NTATAG_BAD_RESP_MASK_REF(bad_resp_mask),
	      NTATAG_ALIASES_REF(aliases),
	      NTATAG_UA_REF(ua),
	      NTATAG_STATELESS_REF(stateless),
	      NTATAG_MAXSIZE_REF(maxsize),
927
	      NTATAG_MAX_FORWARDS_REF(max_forwards),
Pekka Pessi's avatar
Pekka Pessi committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954
	      NTATAG_UDP_MTU_REF(udp_mtu),
	      NTATAG_SIP_T1_REF(sip_t1),
	      NTATAG_SIP_T2_REF(sip_t2),
	      NTATAG_SIP_T4_REF(sip_t4),
	      NTATAG_SIP_T1X64_REF(sip_t1x64),
	      NTATAG_PROGRESS_REF(progress),
	      NTATAG_BLACKLIST_REF(blacklist),
	      NTATAG_DEBUG_DROP_PROB_REF(drop_prob),
	      NTATAG_USER_VIA_REF(user_via),
	      NTATAG_EXTRA_100_REF(extra_100),
	      NTATAG_PASS_100_REF(pass_100),
	      NTATAG_TIMEOUT_408_REF(timeout_408),
	      NTATAG_PASS_408_REF(pass_408),
	      NTATAG_MERGE_482_REF(merge_482),
	      NTATAG_DEFAULT_PROXY_REF(proxy),
	      NTATAG_CANCEL_2543_REF(cancel_2543),
	      NTATAG_CANCEL_487_REF(cancel_487),
	      NTATAG_REL100_REF(invite_100rel),
	      NTATAG_USE_TIMESTAMP_REF(use_timestamp),
	      NTATAG_USE_NAPTR_REF(use_naptr),
	      NTATAG_USE_SRV_REF(use_srv),
#if HAVE_SOFIA_SMIME
	      NTATAG_SMIME_REF(smime),
#endif
	      NTATAG_SIPFLAGS_REF(flags),
	      NTATAG_RPORT_REF(rport),
	      NTATAG_SERVER_RPORT_REF(server_rport),
Pekka Pessi's avatar
Pekka Pessi committed
955
	      NTATAG_TCP_RPORT_REF(tcp_rport),
Pekka Pessi's avatar
Pekka Pessi committed
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
	      NTATAG_PRELOAD_REF(preload),
#ifdef TPTAG_THRPSIZE
	      /* If threadpool is enabled, start a separate "reaper thread" */
	      TPTAG_THRPSIZE_REF(threadpool),
#endif
	      NTATAG_SIGCOMP_OPTIONS_REF(sigcomp),
	      NTATAG_SIGCOMP_ALGORITHM_REF(algorithm),
	      TAG_END());

  if (mclass != NONE)
    agent->sa_mclass = mclass ? mclass : sip_default_mclass();

  m = 0;
  for (tport = agent->sa_tports; tport; tport = tport_next(tport)) {
    m = tport_set_params(tport, TAG_NEXT(tags));
  }

Pekka Pessi's avatar
Pekka Pessi committed
973
  if (n == 0 || m == -1)
Pekka Pessi's avatar
Pekka Pessi committed
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
    return m;

  n += m;

  if (aliases != NONE) {
    sip_contact_t const *m, *m_next;

    m = agent->sa_aliases;
    agent->sa_aliases = sip_contact_dup(home, aliases);

    for (; m; m = m_next) {	/* Free old aliases */
      m_next = m->m_next;
      su_free(home, (void *)m);
    }
  }

  if (proxy != NONE) {
    url_t *dp = url_hdup(home, proxy->us_url);

    url_sanitize(dp);

    if (dp == NULL || dp->url_type == url_sip || dp->url_type == url_sips) {
      if (agent->sa_default_proxy)
	su_free(home, agent->sa_default_proxy);
      agent->sa_default_proxy = dp;
    }
    else
Pekka Pessi's avatar
Pekka Pessi committed
1001
      n = -1;
Pekka Pessi's avatar
Pekka Pessi committed
1002 1003 1004
  }

  if (algorithm != NONE)
Pekka Pessi's avatar
Pekka Pessi committed
1005
    agent->sa_algorithm = su_strdup(home, algorithm);
Pekka Pessi's avatar
Pekka Pessi committed
1006 1007

  if (str0cmp(sigcomp, agent->sa_sigcomp_options)) {
Pekka Pessi's avatar
Pekka Pessi committed
1008
    msg_param_t const *l = NULL;
Pekka Pessi's avatar
Pekka Pessi committed
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    char *s = su_strdup(home, sigcomp);
    char *s1 = su_strdup(home, s), *s2 = s1;

    if (s && s2 && msg_avlist_d(home, &s2, &l) == 0 && *s2 == '\0') {
      su_free(home, (void *)agent->sa_sigcomp_options);
      su_free(home, (void *)agent->sa_sigcomp_option_list);
      agent->sa_sigcomp_options = s;
      agent->sa_sigcomp_option_free = s1;
      agent->sa_sigcomp_option_list = l;
    } else {
      su_free(home, s);
      su_free(home, s1);
      su_free(home, (void *)l);
      n = -1;
    }
  }

  if (maxsize == 0) maxsize = 2 * 1024 * 1024;
  if (maxsize > NTA_TIME_MAX) maxsize = NTA_TIME_MAX;
  agent->sa_maxsize = maxsize;

1030 1031 1032
  if (max_forwards == 0) max_forwards = 70; /* Default value */
  agent->sa_max_forwards->mf_count = max_forwards;

Pekka Pessi's avatar
Pekka Pessi committed
1033 1034
  if (udp_mtu == 0) udp_mtu = 1300;
  if (udp_mtu > 65535) udp_mtu = 65535;
Pekka Pessi's avatar
Pekka Pessi committed
1035 1036
  if (agent->sa_udp_mtu != udp_mtu) {
    agent->sa_udp_mtu = udp_mtu;
Pekka Pessi's avatar
Pekka Pessi committed
1037
    agent_set_udp_params(agent, udp_mtu);
Pekka Pessi's avatar
Pekka Pessi committed
1038
  }
Pekka Pessi's avatar
Pekka Pessi committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092

  if (sip_t1 == 0) sip_t1 = NTA_SIP_T1;
  if (sip_t1 > NTA_TIME_MAX) sip_t1 = NTA_TIME_MAX;
  agent->sa_t1 = sip_t1;

  if (sip_t2 == 0) sip_t2 = NTA_SIP_T2;
  if (sip_t2 > NTA_TIME_MAX) sip_t2 = NTA_TIME_MAX;
  agent->sa_t2 = sip_t2;

  if (sip_t4 == 0) sip_t4 = NTA_SIP_T4;
  if (sip_t4 > NTA_TIME_MAX) sip_t4 = NTA_TIME_MAX;
  if (agent->sa_t4 != sip_t4) {
    incoming_queue_adjust(agent, agent->sa_in.inv_confirmed, sip_t4);
    outgoing_queue_adjust(agent, agent->sa_out.completed, sip_t4);
  }
  agent->sa_t4 = sip_t4;

  if (sip_t1x64 == 0) sip_t1x64 = NTA_SIP_T1 * 64;
  if (sip_t1x64 > NTA_TIME_MAX) sip_t1x64 = NTA_TIME_MAX;
  if (agent->sa_t1x64 != sip_t1x64) {
    incoming_queue_adjust(agent, agent->sa_in.preliminary, sip_t1x64);
    incoming_queue_adjust(agent, agent->sa_in.completed, sip_t1x64);
    incoming_queue_adjust(agent, agent->sa_in.inv_completed, sip_t1x64);
    outgoing_queue_adjust(agent, agent->sa_out.trying, sip_t1x64);
    outgoing_queue_adjust(agent, agent->sa_out.inv_calling, sip_t1x64);
  }
  agent->sa_t1x64 = sip_t1x64;
  agent->sa_blacklist = blacklist;

  if (progress == 0)
    progress = 60 * 1000;
  agent->sa_progress = progress;

  agent->sa_bad_req_mask = bad_req_mask;
  agent->sa_bad_resp_mask = bad_resp_mask;

  agent->sa_is_a_uas = ua != 0;
  agent->sa_is_stateless = stateless != 0;
  agent->sa_drop_prob = drop_prob < 1000 ? drop_prob : 1000;
  agent->sa_user_via = user_via != 0;
  agent->sa_extra_100 = extra_100 != 0;
  agent->sa_pass_100 = pass_100 != 0;
  agent->sa_timeout_408 = timeout_408 != 0;
  agent->sa_pass_408 = pass_408 != 0;
  agent->sa_merge_482 = merge_482 != 0;
  agent->sa_cancel_2543 = cancel_2543 != 0;
  agent->sa_cancel_487 = cancel_487 != 0;
  agent->sa_invite_100rel = invite_100rel != 0;
  agent->sa_timestamp = use_timestamp != 0;
  agent->sa_use_naptr = use_naptr != 0;
  agent->sa_use_srv = use_srv != 0;
  agent->sa_smime = smime;
  agent->sa_flags = flags & MSG_FLG_USERMASK;
  agent->sa_rport = rport != 0;
1093
  agent->sa_server_rport = server_rport != 0;
Pekka Pessi's avatar
Pekka Pessi committed
1094
  agent->sa_tcp_rport = tcp_rport != 0;
Pekka Pessi's avatar
Pekka Pessi committed
1095 1096 1097 1098 1099 1100 1101
  agent->sa_preload = preload;
  agent->sa_tport_threadpool = threadpool;

  return n;
}

static 
Pekka Pessi's avatar
Pekka Pessi committed
1102
void agent_set_udp_params(nta_agent_t *self, usize_t udp_mtu)
Pekka Pessi's avatar
Pekka Pessi committed
1103 1104 1105 1106 1107
{
  tport_t *tp;

  /* Set via fields for the tports */
  for (tp = tport_primaries(self->sa_tports); tp; tp = tport_next(tp)) {
Pekka Pessi's avatar
Pekka Pessi committed
1108
    if (tport_is_udp(tp))
Pekka Pessi's avatar
Pekka Pessi committed
1109 1110
      tport_set_params(tp,
		       TPTAG_TIMEOUT(2 * self->sa_t1x64),
Pekka Pessi's avatar
Pekka Pessi committed
1111
		       TPTAG_MTU(udp_mtu),
Pekka Pessi's avatar
Pekka Pessi committed
1112 1113 1114 1115 1116 1117 1118 1119 1120
		       TAG_END());
  }
}

/**Get NTA Parameters.
 *
 * The nta_agent_get_params() function retrieves the stack parameters. The
 * parameters determine the way NTA handles the retransmissions, how long
 * NTA keeps transactions alive, does NTA apply proxy or user-agent logic to
1121
 * INVITE transactions, or how the @Via headers are generated.
Pekka Pessi's avatar
Pekka Pessi committed
1122 1123 1124 1125 1126
 *
 * @TAGS
 * NTATAG_ALIASES_REF(), NTATAG_CANCEL_2543_REF(), NTATAG_CANCEL_487_REF(),
 * NTATAG_CONTACT_REF(), NTATAG_DEBUG_DROP_PROB_REF(),
 * NTATAG_DEFAULT_PROXY_REF(), NTATAG_EXTRA_100_REF(), NTATAG_MAXSIZE_REF(),
1127
 * NTATAG_MAX_FORWARDS_REF(),
Pekka Pessi's avatar
Pekka Pessi committed
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
 * NTATAG_MERGE_482_REF(), NTATAG_PASS_100_REF(), NTATAG_PRELOAD_REF(),
 * NTATAG_REL100_REF(), NTATAG_RPORT_REF(), NTATAG_SIPFLAGS_REF(),
 * NTATAG_SIP_T1X64_REF(), NTATAG_SIP_T1_REF(), NTATAG_SIP_T2_REF(),
 * NTATAG_SIP_T4_REF(), NTATAG_SMIME_REF(), NTATAG_STATELESS_REF(),
 * NTATAG_TAG_3261_REF(), NTATAG_TIMEOUT_408_REF(), NTATAG_PASS_408_REF(),
 * NTATAG_UA_REF(), NTATAG_USER_VIA_REF(), and NTATAG_USE_TIMESTAMP_REF().
 *
 */
int nta_agent_get_params(nta_agent_t *agent,
			 tag_type_t tag, tag_value_t value, ...)
{
  int n;
  ta_list ta;

  if (agent) {
    ta_start(ta, tag, value);
    n = agent_get_params(agent, ta_args(ta));
    ta_end(ta);
  } else {
    su_seterrno(EINVAL);
    n = -1;
  }

  return n;
}

/** Get NTA parameters */
static
int agent_get_params(nta_agent_t *agent, tagi_t *tags)
{
  return
    tl_tgets(tags,
	     NTATAG_MCLASS(agent->sa_mclass),
	     NTATAG_CONTACT(agent->sa_contact),
	     NTATAG_ALIASES(agent->sa_aliases),
	     NTATAG_UA(agent->sa_is_a_uas),
	     NTATAG_STATELESS(agent->sa_is_stateless),
	     NTATAG_MAXSIZE(agent->sa_maxsize),
1166
	     NTATAG_MAX_FORWARDS(agent->sa_max_forwards->mf_count),
Pekka Pessi's avatar
Pekka Pessi committed
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
	     NTATAG_UDP_MTU(agent->sa_udp_mtu),
	     NTATAG_SIP_T1(agent->sa_t1),
	     NTATAG_SIP_T2(agent->sa_t2),
	     NTATAG_SIP_T4(agent->sa_t4),
	     NTATAG_SIP_T1X64(agent->sa_t1x64),
	     NTATAG_BLACKLIST(agent->sa_blacklist),
	     NTATAG_DEBUG_DROP_PROB(agent->sa_drop_prob),
	     NTATAG_USER_VIA(agent->sa_user_via),
	     NTATAG_EXTRA_100(agent->sa_extra_100),
	     NTATAG_PASS_100(agent->sa_pass_100),
	     NTATAG_TIMEOUT_408(agent->sa_timeout_408),
	     NTATAG_PASS_408(agent->sa_pass_408),
	     NTATAG_MERGE_482(agent->sa_merge_482),
	     NTATAG_DEFAULT_PROXY(agent->sa_default_proxy),
	     NTATAG_CANCEL_2543(agent->sa_cancel_2543),
	     NTATAG_CANCEL_487(agent->sa_cancel_487),
1183
	     NTATAG_TAG_3261(1),
Pekka Pessi's avatar
Pekka Pessi committed
1184 1185 1186 1187 1188 1189
	     NTATAG_REL100(agent->sa_invite_100rel),
	     NTATAG_USE_TIMESTAMP(agent->sa_timestamp),
	     NTATAG_USE_NAPTR(agent->sa_use_naptr),
	     NTATAG_USE_SRV(agent->sa_use_srv),
#if HAVE_SOFIA_SMIME
	     NTATAG_SMIME(agent->sa_smime),
1190 1191
#else
	     NTATAG_SMIME(NULL),
Pekka Pessi's avatar
Pekka Pessi committed
1192 1193 1194 1195
#endif
	     NTATAG_SIPFLAGS(agent->sa_flags),
	     NTATAG_RPORT(agent->sa_rport),
	     NTATAG_PRELOAD(agent->sa_preload),
1196
	     NTATAG_SIGCOMP_ALGORITHM(agent->sa_algorithm),
Pekka Pessi's avatar
Pekka Pessi committed
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
	     NTATAG_SIGCOMP_OPTIONS(agent->sa_sigcomp_options ?
				    agent->sa_sigcomp_options :
				    "sip"),
	     TAG_END());
}

/**Get NTA statistics.
 *
 * The nta_agent_get_stats() function retrieves the stack statistics.
 *
 * @TAGS
 * @TAG NTATAG_S_*
 *
 */
int nta_agent_get_stats(nta_agent_t *agent,
			tag_type_t tag, tag_value_t value, ...)
{
  int n;
  ta_list ta;

  if (!agent)
    return su_seterrno(EINVAL), -1;

  ta_start(ta, tag, value);

  n = tl_tgets(ta_args(ta),
	       NTATAG_S_IRQ_HASH(agent->sa_incoming->iht_size),
	       NTATAG_S_ORQ_HASH(agent->sa_outgoing->oht_size),
	       NTATAG_S_LEG_HASH(agent->sa_dialogs->lht_size),
	       NTATAG_S_IRQ_HASH_USED(agent->sa_incoming->iht_used),
	       NTATAG_S_ORQ_HASH_USED(agent->sa_outgoing->oht_used),
	       NTATAG_S_LEG_HASH_USED(agent->sa_dialogs->lht_used),
	       NTATAG_S_RECV_MSG(agent->sa_stats->as_recv_msg),
	       NTATAG_S_RECV_REQUEST(agent->sa_stats->as_recv_request),
	       NTATAG_S_RECV_RESPONSE(agent->sa_stats->as_recv_response),
	       NTATAG_S_BAD_MESSAGE(agent->sa_stats->as_bad_message),
	       NTATAG_S_BAD_REQUEST(agent->sa_stats->as_bad_request),
	       NTATAG_S_BAD_RESPONSE(agent->sa_stats->as_bad_response),
	       NTATAG_S_DROP_REQUEST(agent->sa_stats->as_drop_request),
	       NTATAG_S_DROP_RESPONSE(agent->sa_stats->as_drop_response),
	       NTATAG_S_CLIENT_TR(agent->sa_stats->as_client_tr),
	       NTATAG_S_SERVER_TR(agent->sa_stats->as_server_tr),
	       NTATAG_S_DIALOG_TR(agent->sa_stats->as_dialog_tr),
	       NTATAG_S_ACKED_TR(agent->sa_stats->as_acked_tr),
	       NTATAG_S_CANCELED_TR(agent->sa_stats->as_canceled_tr),
	       NTATAG_S_TRLESS_REQUEST(agent->sa_stats->as_trless_request),
	       NTATAG_S_TRLESS_TO_TR(agent->sa_stats->as_trless_to_tr),
	       NTATAG_S_TRLESS_RESPONSE(agent->sa_stats->as_trless_response),
	       NTATAG_S_TRLESS_200(agent->sa_stats->as_trless_200),
	       NTATAG_S_MERGED_REQUEST(agent->sa_stats->as_merged_request),
	       NTATAG_S_SENT_MSG(agent->sa_stats->as_sent_msg),
	       NTATAG_S_SENT_REQUEST(agent->sa_stats->as_sent_request),
	       NTATAG_S_SENT_RESPONSE(agent->sa_stats->as_sent_response),
	       NTATAG_S_RETRY_REQUEST(agent->sa_stats->as_retry_request),
	       NTATAG_S_RETRY_RESPONSE(agent->sa_stats->as_retry_response),
	       NTATAG_S_RECV_RETRY(agent->sa_stats->as_recv_retry),
	       NTATAG_S_TOUT_REQUEST(agent->sa_stats->as_tout_request),
	       NTATAG_S_TOUT_RESPONSE(agent->sa_stats->as_tout_response),
	       TAG_END());

  ta_end(ta);

  return n;
}

/**Calculate a new unique tag.
 *
1264
 * This function generates a series of 2**64 unique tags for @From or @To
Pekka Pessi's avatar
Pekka Pessi committed
1265 1266 1267 1268
 * headers. The start of the tag series is derived from the NTP time the NTA
 * agent was initialized.
 *
 */
Pekka Pessi's avatar
Pekka Pessi committed
1269
char const *nta_agent_newtag(su_home_t *home, char const *fmt, nta_agent_t *sa)
Pekka Pessi's avatar
Pekka Pessi committed
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
{
  char tag[(8 * 8 + 4)/ 5 + 1];

  if (sa == NULL)
    return su_seterrno(EINVAL), NULL;

  /* XXX - use a cryptographically safe func here? */
  sa->sa_tags += NTA_TAG_PRIME;

  msg_random_token(tag, sizeof(tag) - 1, &sa->sa_tags, sizeof(sa->sa_tags));

  if (fmt && fmt[0])
    return su_sprintf(home, fmt, tag);
  else
    return su_strdup(home, tag);
}

/**
 * Calculate branch value.
 */
Pekka Pessi's avatar
Pekka Pessi committed
1290
static char const *stateful_branch(su_home_t *home, nta_agent_t *sa)
Pekka Pessi's avatar
Pekka Pessi committed
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
{
  char branch[(8 * 8 + 4)/ 5 + 1];

  /* XXX - use a cryptographically safe func here? */
  sa->sa_branch += NTA_BRANCH_PRIME;

  msg_random_token(branch, sizeof(branch) - 1, 
		   &sa->sa_branch, sizeof(sa->sa_branch));

  return su_sprintf(home, "branch=z9hG4bK%s", branch);
}

1303
#include <sofia-sip/su_md5.h>
Pekka Pessi's avatar
Pekka Pessi committed
1304 1305 1306 1307

/**
 * Calculate branch value for stateless operation.
 * 
1308
 * XXX - should include HMAC of previous @Via line.
Pekka Pessi's avatar
Pekka Pessi committed
1309 1310
 */
static
Pekka Pessi's avatar
Pekka Pessi committed
1311
char const *stateless_branch(nta_agent_t *sa, 
Pekka Pessi's avatar
Pekka Pessi committed
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340
			     msg_t *msg,
			     sip_t const *sip, 
			     tp_name_t const *tpn)
{
  su_md5_t md5[1];
  uint8_t digest[SU_MD5_DIGEST_SIZE];
  char branch[(SU_MD5_DIGEST_SIZE * 8 + 4)/ 5 + 1];
  sip_route_t const *r;

  assert(sip->sip_request);

  if (!sip->sip_via)
    return stateful_branch(msg_home(msg), sa);

  su_md5_init(md5);

  su_md5_str0update(md5, tpn->tpn_host);
  su_md5_str0update(md5, tpn->tpn_port);

  url_update(md5, sip->sip_request->rq_url);
  if (sip->sip_call_id) {
    su_md5_str0update(md5, sip->sip_call_id->i_id);
  }
  if (sip->sip_from) {
    url_update(md5, sip->sip_from->a_url);
    su_md5_stri0update(md5, sip->sip_from->a_tag);
  }
  if (sip->sip_to) {
    url_update(md5, sip->sip_to->a_url);
Pekka Pessi's avatar
Pekka Pessi committed
1341 1342
    /* XXX - some broken implementations include To tag in CANCEL */
    /* su_md5_str0update(md5, sip->sip_to->a_tag); */
Pekka Pessi's avatar
Pekka Pessi committed
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
  }
  if (sip->sip_cseq) {
    uint32_t cseq = htonl(sip->sip_cseq->cs_seq);
    su_md5_update(md5, &cseq, sizeof(cseq));
  }

  for (r = sip->sip_route; r; r = r->r_next)
    url_update(md5, r->r_url);

  su_md5_digest(md5, digest);

  msg_random_token(branch, sizeof(branch) - 1, digest, sizeof(digest));

  return su_sprintf(msg_home(msg), "branch=z9hG4bK.%s", branch);
}

/* ====================================================================== */
/* 2) Transport interface */

/* Local prototypes */
Pekka Pessi's avatar
Pekka Pessi committed
1363
static int agent_create_master_transport(nta_agent_t *self, tagi_t *tags);
1364
static int agent_init_via(nta_agent_t *self, tport_t *primaries, int use_maddr);
Pekka Pessi's avatar
Pekka Pessi committed
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
static int agent_init_contact(nta_agent_t *self);
static void agent_recv_message(nta_agent_t *agent,
			       tport_t *tport,
			       msg_t *msg,
			       sip_via_t *tport_via,
			       su_time_t now);
static void agent_tp_error(nta_agent_t *agent,
			   tport_t *tport,
			   int errcode,
			   char const *remote);
Pekka Pessi's avatar
Pekka Pessi committed
1375
static void agent_update_tport(nta_agent_t *agent, tport_t *);
Pekka Pessi's avatar
Pekka Pessi committed
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390

/**For each transport, we have name used by tport module, SRV prefixes used
 * for resolving, and NAPTR service/conversion.
 */
static 
struct sipdns_tport {
  char name[6];			/**< Named used by tport module */
  char port[6];			/**< Default port number */
  char prefix[14];		/**< Prefix for SRV domains */
  char service[10];		/**< NAPTR service */
}
#define SIPDNS_TRANSPORTS (4)
const sipdns_tports[SIPDNS_TRANSPORTS] = {
  { "udp",  "5060", "_sip._udp.",  "SIP+D2U"  },
  { "tcp",  "5060", "_sip._tcp.",  "SIP+D2T"  },
1391 1392
  { "sctp", "5060", "_sip._sctp.", "SIP+D2S" },
  { "tls",  "5061", "_sips._tcp.", "SIPS+D2T"  },
Pekka Pessi's avatar
Pekka Pessi committed
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
};

static char const * const tports_sip[] =
  {
    "udp", "tcp", "sctp", NULL
  };

static char const * const tports_sips[] =
  {
    "tls", NULL
  };

1405
static tport_stack_class_t nta_agent_class[1] =
Pekka Pessi's avatar
Pekka Pessi committed
1406 1407 1408 1409
  {{
    sizeof(nta_agent_class),
    agent_recv_message,
    agent_tp_error,
Pekka Pessi's avatar
Pekka Pessi committed
1410
    nta_msg_create_for_transport,
Pekka Pessi's avatar
Pekka Pessi committed
1411
    agent_update_tport,
Pekka Pessi's avatar
Pekka Pessi committed
1412 1413 1414 1415 1416
  }};


/** Add a transport to the agent.
 *
Pekka Pessi's avatar
Pekka Pessi committed
1417
 * Creates a new transport and binds it
Pekka Pessi's avatar
Pekka Pessi committed