nua_register.c 53.3 KB
Newer Older
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 26 27 28
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2006 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 nua_register.c
 * @brief REGISTER and registrations
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
29
 * @author Martti Mela <Martti.Mela@nokia.com>
30 31 32 33 34 35
 *
 * @date Created: Wed Mar  8 11:48:49 EET 2006 ppessi
 */

#include "config.h"

36 37 38
/** @internal SU network changed detector argument pointer type */
#define SU_NETWORK_CHANGED_MAGIC_T struct nua_s

39
#include <sofia-sip/string0.h>
40
#include <sofia-sip/su_strlst.h>
41 42 43
#include <sofia-sip/su_uniqueid.h>
#include <sofia-sip/su_tagarg.h>

44
#include <sofia-sip/sip_protos.h>
45
#include <sofia-sip/sip_util.h>
46
#include <sofia-sip/sip_status.h>
47 48 49

#define NTA_LEG_MAGIC_T      struct nua_handle_s
#define NTA_OUTGOING_MAGIC_T struct nua_handle_s
50
#define NTA_UPDATE_MAGIC_T   struct nua_s
51

52
#include "nua_stack.h"
53

54
#include <sofia-sip/hostdomain.h>
55
#include <sofia-sip/nta_tport.h>
56
#include <sofia-sip/tport.h>
57
#include <sofia-sip/tport_tag.h>
58

59 60 61 62
#define OUTBOUND_OWNER_T struct nua_handle_s

#include "outbound.h"

63 64 65 66
#if HAVE_SIGCOMP
#include <sigcomp.h>
#endif

67 68 69 70 71 72 73
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <limits.h>

#include <assert.h>

74 75
/* ======================================================================== */
/* Registrations and contacts */
76

77
int nua_registration_from_via(nua_registration_t **list,
78
			      nua_handle_t *nh, 
79 80
			      sip_via_t const *via,
			      int public);
81

82
int nua_registration_add(nua_registration_t **list, nua_registration_t *nr);
83

84
void nua_registration_remove(nua_registration_t *nr);
85

86 87
int nua_registration_set_aor(su_home_t *, nua_registration_t *nr,
			     sip_from_t const *aor);
88

89
int nua_registration_set_contact(nua_handle_t *,
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
				 nua_registration_t *nr,
				 sip_contact_t const *m,
				 int terminating);

void nua_registration_set_ready(nua_registration_t *nr, int ready);

/* ====================================================================== */
/* REGISTER usage */

static char const *nua_register_usage_name(nua_dialog_usage_t const *du);

static int nua_register_usage_add(nua_handle_t *nh,
				  nua_dialog_state_t *ds,
				  nua_dialog_usage_t *du);
static void nua_register_usage_remove(nua_handle_t *nh,
				      nua_dialog_state_t *ds,
				      nua_dialog_usage_t *du);
static void nua_register_usage_peer_info(nua_dialog_usage_t *du,
					 nua_dialog_state_t const *ds,
					 sip_t const *sip);
110 111 112
static void nua_register_usage_refresh(nua_handle_t *,
				       nua_dialog_state_t *,
				       nua_dialog_usage_t *,
113
				       sip_time_t);
114 115 116
static int nua_register_usage_shutdown(nua_handle_t *,
				       nua_dialog_state_t *,
				       nua_dialog_usage_t *);
117 118 119 120 121 122

/** REGISTER usage, aka nua_registration_t */
struct register_usage {
  nua_registration_t *nr_next, **nr_prev, **nr_list; /* Doubly linked list and its head */
  sip_from_t *nr_aor;		/**< AoR for this registration, NULL if none */
  sip_contact_t *nr_contact;	/**< Our Contact */
123
  sip_via_t *nr_via;		/**< Corresponding Via headers */
124 125 126 127 128 129 130 131 132 133 134 135

  /** Status of registration */
  unsigned nr_ready:1;
  /** Kind of registration.
   *
   * If nr_default is true, this is not a real registration but placeholder
   * for Contact header derived from a transport address.
   *
   * If nr_secure is true, this registration supports SIPS/TLS.
   *
   * If nr_public is true, transport should have public address.
   */
136
  unsigned nr_default:1, nr_secure:1, nr_public:1, nr_ip4:1, nr_ip6:1;
137

138 139
  /** Stack-generated contact */
  unsigned nr_by_stack:1, :0;
140

141 142
  sip_route_t *nr_route;	/**< Outgoing Service-Route */
  sip_path_t *nr_path;		/**< Incoming Path */
143

144 145
  tport_t *nr_tport;		/**< Transport to be used when registered */
  nua_dialog_state_t *nr_dialogs; /**< List of our dialogs */
146

147 148 149
#if HAVE_SIGCOMP
  struct sigcomp_compartment *nr_compartment;
#endif
150

151 152
  outbound_t *nr_ob;	/**< Outbound connection */
};
153

154 155 156 157 158 159 160 161
nua_usage_class const nua_register_usage[1] = {
  {
    sizeof (struct register_usage),
    (sizeof nua_register_usage),
    nua_register_usage_add,
    nua_register_usage_remove,
    nua_register_usage_name,
    nua_register_usage_peer_info,
162 163
    nua_register_usage_refresh,
    nua_register_usage_shutdown
164
  }};
165

166 167 168 169
static char const *nua_register_usage_name(nua_dialog_usage_t const *du)
{
  return "register";
}
170

171 172 173 174 175
static int nua_register_usage_add(nua_handle_t *nh,
				  nua_dialog_state_t *ds,
				  nua_dialog_usage_t *du)
{
  nua_registration_t *nr = nua_dialog_usage_private(du);
176

177 178
  if (ds->ds_has_register)
    return -1;			/* There can be only one usage */
179

180
  ds->ds_has_register = 1;
181

182
  nr->nr_public = 1;		/* */
183

184 185
  return 0;
}
186

187

188 189 190
static void nua_register_usage_remove(nua_handle_t *nh,
				      nua_dialog_state_t *ds,
				      nua_dialog_usage_t *du)
191
{
192
  nua_registration_t *nr = nua_dialog_usage_private(du);
193

194 195 196 197 198
  if (nr->nr_list)
    nua_registration_remove(nr);	/* Remove from list of registrations */

  if (nr->nr_ob)
    outbound_unref(nr->nr_ob);
199

200
#if HAVE_SIGCOMP
201 202 203
  if (nr->nr_compartment)
    sigcomp_compartment_unref(nr->nr_compartment);
  nr->nr_compartment = NULL;
204
#endif
205 206 207 208 209 210 211 212 213 214 215 216 217 218

  ds->ds_has_register = 0;	/* There can be only one */
}


/** @internal Store information about registrar. */
static void nua_register_usage_peer_info(nua_dialog_usage_t *du,
					 nua_dialog_state_t const *ds,
					 sip_t const *sip)
{
  nua_registration_t *nr = nua_dialog_usage_private(du);
  if (nr->nr_ob)
    outbound_peer_info(nr->nr_ob, sip);
}
219

220 221 222
/* ======================================================================== */
/* REGISTER */

223
static void restart_register(nua_handle_t *nh, tagi_t *tags);
224 225 226 227 228

static int process_response_to_register(nua_handle_t *nh,
					nta_outgoing_t *orq,
					sip_t const *sip);

229 230
static void unregister_expires_contacts(msg_t *msg, sip_t *sip);

231
/* Interface towards outbound_t */
232 233 234 235 236 237 238 239
sip_contact_t *nua_handle_contact_by_via(nua_handle_t *nh,
					 su_home_t *home,
					 char const *extra_username,
					 sip_via_t const *v,
					 char const *transport,
					 char const *m_param,
					 ...);

240 241 242 243
static int nua_stack_outbound_features(nua_handle_t *nh, outbound_t *ob);

static int nua_stack_outbound_refresh(nua_handle_t *,
				      outbound_t *ob);
244

245 246
static int nua_stack_outbound_status(nua_handle_t *,
				     outbound_t *ob,
247 248 249
				     int status, char const *phrase,
				     tag_type_t tag, tag_value_t value, ...);

250 251
static int nua_stack_outbound_failed(nua_handle_t *,
				     outbound_t *ob,
252 253 254
				     int status, char const *phrase,
				     tag_type_t tag, tag_value_t value, ...);

255
static int nua_stack_outbound_credentials(nua_handle_t *, auth_client_t **auc);
256

257 258
outbound_owner_vtable nua_stack_outbound_callbacks = {
    sizeof nua_stack_outbound_callbacks,
259
    nua_handle_contact_by_via,
260 261 262 263 264
    nua_stack_outbound_refresh,
    nua_stack_outbound_status,
    nua_stack_outbound_failed,
    nua_stack_outbound_failed,
    nua_stack_outbound_credentials
265 266
  };

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
/**@fn void nua_register(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...);
 * 
 * Send SIP REGISTER request to the registrar. 
 *
 * Request status will be delivered to the application using #nua_r_register
 * event. When successful the registration will be updated periodically.
 *
 * The handle used for registration cannot be used for any other purposes.
 *
 * @param nh              Pointer to operation handle
 * @param tag, value, ... List of tagged parameters
 *
 * @return
 *     nothing
 *
 * @par Related tags:
283
 *     NUTAG_REGISTRAR(), NUTAG_INSTANCE(), NUTAG_OUTBOUND(),
284 285
 *     NUTAG_KEEPALIVE(), NUTAG_KEEPALIVE_STREAM(), NUTAG_M_USERNAME(),
 *     NUTAG_M_PARAMS(), NUTAG_M_FEATURES()
286 287 288
 *
 * @par Events:
 *     #nua_r_register, #nua_i_outbound
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 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 333 334 335 336 337 338 339 340
 * 
 * @par Generating Contact Header
 *
 * If the application did not specify the Contact header in the tags,
 * nua_register() will generate one. It will obtain the schema, IP address
 * for the host and port number for the Contact URI from the transport
 * socket. The diplay name is taken from NUTAG_M_DISPLAY(), URL username
 * part is taken from NUTAG_M_USERNAME(), URI parameters from
 * NUTAG_M_PARAMS(), and Contact header parameters from NUTAG_M_FEATURES(). 
 * If NUTAG_CALLEE_CAPS(1) is specified, additional Contact header
 * parameters are generated based on SDP capabilities and SIP @Allow header.
 * 
 * Note that @b nua may append a identifier of its own to the @Contact URI
 * username. Such nua-generated identifier trailer always starts with "="
 * (equal sign), rest of the nua-generated identifier may contain any
 * url-unreserved characters except "=".
 *
 * Likewise, nua may add transport parameters (such as "transport=tcp" or
 * "maddr") to the @Contact URI. It can add addtional header parameters, like
 * "+sip.instance" or "reg-id", too.
 *
 * For instance, if application uses tags like
 * @code
 *   nua_register(nh,
 *                NUTAG_M_DISPLAY("1"),
 *                NUTAG_M_USERNAME("line-1"),
 *                NUTAG_M_PARAMS("user=phone"),
 *                NUTAG_M_FEATURES("audio"),
 *                NUTAG_CALLEE_CAPS(0),
 *                TAG_END())
 * @endcode
 * @b nua can generate a Contact header like
 * @code
 * Contact: 1 <sip:line-1=SSQAIbjv@192.168.1.200;transport=tcp;user=phone>
 *   ;audio;reg-id=1
 *   ;+sip.instance=urn:uuid:97701ad9-39df-1229-1083-dbc0a85f029c
 * @endcode
 *
 * The incoming request from the proxy should contain the registered contact
 * URI as the request URI. The application can use the username prefix set
 * by NUTAG_M_USERNAME() and the non-transport parameters of the request URI
 * set by NUTAG_M_PARAMS() when determining to which registration the
 * incoming request belongs.
 * 
 * For example, a request line correspoding to the @Contact in above example
 * may look like:
 * @code
 * INVITE sip:line-1=SSQAIbjv@192.168.1.200;user=phone SIP/2.0
 * @endcode
 *
 * @sa NUTAG_M_DISPLAY(), NUTAG_M_USERNAME(), NUTAG_M_PARAMS(),
 * NUTAG_M_FEATURES(), NUTAG_CALLEE_CAPS().
341 342 343
 *
 * @par NAT, Firewall and Outbound Support
 *
344 345 346
 * Normally, @b nua will start start a protocol engine for outbound
 * connections used for NAT and firewall traversal and connectivity checks
 * when registering. 
347
 *
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
 * @note If the application provides @b nua with a
 * @Contact header of its own (or includes a SIPTAG_CONTACT(NULL) tag in
 * nua_register() tags), the outbound protocol engine is not started. It is
 * assumed that the application knows better what it is doing when it sets
 * the @Contact, or it is using experimental CPL upload as specified in 
 * <a href="http://www.ietf.org/internet-drafts/draft-lennox-sip-reg-payload-01.txt">
 * draft-lennox-sip-reg-payload-01.txt</a>.
 *
 * First, outbound engine will probe for NATs in between UA and registrar. 
 * It will send a REGISTER request as usual. Upon receiving the response it
 * checks for the presence of "received" and "rport" parameters in the Via
 * header returned by registrar. The presence of NAT is determined from the
 * "received" parameter in a Via header. When a REGISTER request was sent,
 * the stack inserted the actual source IP address in the Via header: if
 * that is different from the source IP address seen by the registrar, the
363 364 365 366 367 368 369
 * registrar inserts the source IP address it sees into the "received"
 * parameter.
 *
 * Please note that an ALG (application-level gateway) modifying the Via
 * headers in outbound requests and again in incoming responses will make
 * the above-described NAT check to fail.
 *
370 371
 * The response to the initial REGISTER should also include option tags
 * indicating whether registrar supports various SIP extension options: @e
372 373 374 375 376 377 378 379 380 381 382 383 384 385
 * outbound, @e pref, @e path, @e gruu.
 *
 * Basically, @e outbound means that instead of registering its contact URI
 * with a particular address-of-record URI, the user-agent registers a
 * transport-level connection. Such a connection is identified on the
 * Contact header field with an instance identifier, application-provided
 * @ref NUTAG_INSTANCE() "unique string" identifying the user-agent instance
 * and a stack-generated numeric index identifying the transport-level
 * connection.
 *
 * If the @e outbound extension is supported, NUTAG_OUTBOUND() contains
 * option string "outbound" and the application has provided an instance
 * identifer to the stack with NUTAG_INSTANCE(), the nua_register() will try
 * to use outbound.
386 387 388 389 390 391 392 393 394
 *
 * If @e outbound is not supported, nua_register() has to generate a URI
 * that can be used to reach it from outside. It will check for public
 * transport addresses detected by underlying stack with, e.g., STUN, UPnP
 * or SOCKS. If there are public addresses, nua_register() will use them. If
 * there is no public address, it will try to generate a Contact URI from
 * the "received" and "rport" parameters found in the Via header of the
 * response message.
 *
395 396 397 398 399
 * @todo Actually generate public addresses.
 *
 * You can disable this kind of NAT traversal by setting "no-natify" into
 * NUTAG_OUTBOUND() options string.
 * 
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
 * @par GRUU and Service-Route
 *
 * After a successful response to the REGISTER request has been received,
 * nua_register() will update the information about the registration based
 * on it. If there is a "gruu" parameter included in the response,
 * nua_register() will save it and use the gruu URI in the Contact header
 * fields of dialog-establishing messages, such as INVITE or SUBSCRIBE. 
 * Also, if the registrar has included a Service-Route header in the
 * response, and the service route feature has not been disabled using
 * NUTAG_SERVICE_ROUTE_ENABLE(), the route URIs from the Service-Route
 * header will be used for initial non-REGISTER requests.
 *
 * The #nua_r_register message will include the contact header and route
 * used in with the registration.
 *
 * @par Registration Keep-Alive
 *
 * After the registration has successfully completed the nua_register() will
 * validate the registration and initiate the keepalive mechanism, too. The
 * user-agent validates the registration by sending a OPTIONS requests to
 * itself. If there is an error, nua_register() will indicate that to the
421
 * application using #nua_i_outbound event, and start unregistration
422 423
 * procedure (unless that has been explicitly disabled).
 *
424 425 426
 * You can disable validation by inserting "no-validate" into
 * NUTAG_OUTBOUND() string.
 *
427 428 429 430
 * The keepalive mechanism depends on the network features detected earlier. 
 * If @a outbound extension is used, the STUN keepalives will be used. 
 * Otherwise, NUA stack will repeatedly send OPTIONS requests to itself. In
 * order to save bandwidth, it will include Max-Forwards: 0 in the
431 432 433 434 435 436 437 438 439 440 441 442 443
 * keep-alive requests, however. The keepalive interval is determined by
 * NUTAG_KEEPALIVE() parameter. If the interval is 0, no keepalive messages
 * is sent.
 *
 * You can disable keepalive OPTIONS by inserting "no-options-keepalive"
 * into NUTAG_OUTBOUND() string. Currently there are no other keepalive
 * mechanisms available.
 *
 * The value of NUTAG_KEEPALIVE_STREAM(), if specified, is used to indicate
 * the desired transport-layer keepalive interval for stream-based
 * transports like TLS and TCP.
 *
 * @sa NUTAG_OUTBOUND() and tags.
444 445 446 447
 */

/** @var nua_event_e::nua_r_register
 *
448
 * Response to an outgoing REGISTER.
449 450 451 452 453
 *
 * The REGISTER may be sent explicitly by nua_register() or implicitly by
 * NUA state machines. The @a status may be 100 even if the real response
 * status returned is different if the REGISTER request has been restarted.
 *
454 455 456 457 458 459 460
 * @param nh     operation handle associated with the registration
 * @param hmagic operation magic associated with the registration
 * @param status status code
 *               (from the response message or internally generated)
 * @param phrase response phrase
 * @param sip    response message to REGISTER request or NULL upon an error
 *               (error code and message are in status and phrase parameters)
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
 * @param tags   empty
 */

/**@fn void nua_unregister(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...);
 * Unregister. 
 *
 * Send a REGISTER request with expiration time 0. This removes the 
 * registration from the registrar. If the handle was earlier used 
 * with nua_register() the periodic updates will be terminated. 
 *
 * If a SIPTAG_CONTACT_STR() with argument "*" is used, all the
 * registrations will be removed from the registrar otherwise only the
 * contact address belonging to the NUA stack is removed.
 *
 * @param nh              Pointer to operation handle
 * @param tag, value, ... List of tagged parameters
 *
 * @return
 *     nothing
 *
 * @par Related tags:
 *     NUTAG_REGISTRAR() \n
 *     Tags in <sip_tag.h> except SIPTAG_EXPIRES() or SIPTAG_EXPIRES_STR()
 *
 * @par Events:
 *     #nua_r_unregister
 */

/** @var nua_event_e::nua_r_unregister
 *
 * Answer to outgoing un-REGISTER.
 *
493 494 495 496 497 498
 * @param nh     operation handle associated with the registration
 * @param hmagic operation magic associated with the registration
 * @param status status code
 *               (from the response message or internally generated)
 * @param phrase response phrase
 * @param sip    response message to REGISTER request or NULL upon an error
499 500 501 502
 *               (error code and message are in status and phrase parameters)
 * @param tags   empty
 */

503
int
504 505
nua_stack_register(nua_t *nua, nua_handle_t *nh, nua_event_t e,
		   tagi_t const *tags)
506 507
{
  nua_dialog_usage_t *du;
508 509
  nua_registration_t *nr = NULL;
  outbound_t *ob = NULL;
510
  nua_client_request_t *cr = nh->nh_ds->ds_cr;
511 512
  msg_t *msg = NULL;
  sip_t *sip;
513
  int terminating = e != nua_r_register;
514

515
  if (nua_stack_set_handle_special(nh, nh_has_register, nua_r_register) < 0)
516
    return UA_EVENT2(e, 900, "Invalid handle for REGISTER");
517
  if (cr->cr_orq)
518
    return UA_EVENT2(e, 900, "Request already in progress");
519

520
  nua_stack_init_handle(nua, nh, TAG_NEXT(tags));
521

522
  du = nua_dialog_usage_add(nh, nh->nh_ds, nua_register_usage, NULL);
523
  if (!du)
524
    return UA_EVENT1(e, NUA_INTERNAL_ERROR);
525 526 527 528
  nr = nua_dialog_usage_private(du); assert(nr);
  nua_registration_add(&nh->nh_nua->nua_registrations, nr);
  if (!terminating && du->du_terminating)
    return UA_EVENT2(e, 900, "Unregister in progress");
529

530 531 532 533
  if (cr->cr_msg)
    msg_destroy(cr->cr_msg), cr->cr_msg = NULL;
  /* Use original message as template when unregistering */
  if (terminating)		
534
    cr->cr_msg = msg_ref_create(du->du_msg);
535

536
  msg = nua_creq_msg(nua, nh, cr, cr->cr_msg != NULL,
537
		     SIP_METHOD_REGISTER,
538
		     TAG_IF(!terminating, NUTAG_USE_DIALOG(1)),
539 540
		     TAG_NEXT(tags));
  sip = sip_object(msg);
541 542
  if (!msg || !sip)
    goto error;
543

544 545 546 547
  if (!nr->nr_aor) {
    if (nua_registration_set_aor(nh->nh_home, nr, sip->sip_to) < 0)
      goto error;
  }
548

549 550
  if (du->du_msg == NULL)
    du->du_msg = msg_ref_create(cr->cr_msg); /* Save original message */
551

552 553 554
  if (terminating)
    /* Add Expires: 0 and remove the expire parameters from contacts */
    unregister_expires_contacts(msg, sip);
555

556 557 558 559 560 561 562
  if (nua_tagis_have_contact_tag(tags) ||
      nua_tagis_have_contact_tag(nh->nh_tags)) {
    if (!sip->sip_contact)
      terminating = 1;
  }
  else if (nua_registration_set_contact(nh, nr, sip->sip_contact, terminating)
	   < 0)
563
    goto error;
564 565 566

  du->du_terminating = terminating;

567 568 569 570 571 572 573 574 575
  ob = nr->nr_ob;
  
  if (!ob && (NH_PGET(nh, outbound) || NH_PGET(nh, instance))) {
    nr->nr_ob = ob = outbound_new(nh, &nua_stack_outbound_callbacks,
				  nh->nh_nua->nua_root,
				  nh->nh_nua->nua_nta,
				  NH_PGET(nh, instance));
    if (!ob)
      goto error;
576
  }
577

578 579 580 581 582 583 584 585 586 587
  if (ob) {
    outbound_set_options(ob,
			 NH_PGET(nh, outbound),
			 NH_PGET(nh, keepalive),
			 NH_PISSET(nh, keepalive_stream)
			 ? NH_PGET(nh, keepalive_stream)
			 : NH_PGET(nh, keepalive));
    nua_stack_outbound_features(nh, ob);
    outbound_stop_keepalive(ob);

588
    if (outbound_set_contact(ob, sip->sip_contact, nr->nr_via, terminating) < 0)
589
      goto error;
590 591
  }

592 593 594 595 596 597 598 599 600 601 602 603 604 605
  /* This calls nta_outgoing_mcreate() but adds a few tags */
  cr->cr_orq =
    outbound_register_request(ob, terminating,
			      nr->nr_by_stack ? nr->nr_contact : NULL,
			      nua->nua_nta,
			      process_response_to_register, nh, NULL,
			      msg,
			      SIPTAG_END(), 
			      TAG_IF(terminating, NTATAG_SIGCOMP_CLOSE(1)),
			      TAG_IF(!terminating, NTATAG_COMP("sigcomp")),
			      TAG_NEXT(tags));

  if (!cr->cr_orq)
    goto error;
606

607
  cr->cr_usage = du;
608
  return cr->cr_event = e;
609 610 611 612 613 614

 error:
  msg_destroy(msg);
  msg_destroy(cr->cr_msg), cr->cr_msg = NULL;
  nua_dialog_usage_remove(nh, nh->nh_ds, du);    
  return UA_EVENT1(e, NUA_INTERNAL_ERROR);
615 616 617 618 619
}

static void
restart_register(nua_handle_t *nh, tagi_t *tags)
{
620
  nua_client_request_t *cr = nh->nh_ds->ds_cr;
621
  msg_t *msg;
622
  nua_dialog_usage_t *du = cr->cr_usage;
623 624
  nua_registration_t *nr = nua_dialog_usage_private(du);
  int terminating = du && du->du_terminating;
625 626 627 628 629 630 631

  cr->cr_restart = NULL;

  if (!cr->cr_msg)
    return;

  msg = nua_creq_msg(nh->nh_nua, nh, cr, 1,
632 633 634 635
		     SIP_METHOD_UNKNOWN,
		     TAG_NEXT(tags));

  if (!msg)
636
    return;			/* XXX - Uh-oh */
637

638
  if (terminating)
639
    unregister_expires_contacts(msg, sip_object(msg));
640

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
  /* This calls nta_outgoing_mcreate() but adds a few tags */
  cr->cr_orq =
    outbound_register_request(nr->nr_ob, terminating,
			      nr->nr_by_stack ? nr->nr_contact : NULL,
			      nh->nh_nua->nua_nta,
			      process_response_to_register, nh, NULL,
			      msg,
			      SIPTAG_END(), 
			      TAG_IF(terminating, NTATAG_SIGCOMP_CLOSE(1)),
			      TAG_IF(!terminating, NTATAG_COMP("sigcomp")),
			      TAG_NEXT(tags));

  if (!cr->cr_orq)
    msg_destroy(msg);
}
656

657 658 659
/** Refresh registration */
static
void nua_register_usage_refresh(nua_handle_t *nh,
660
				nua_dialog_state_t *ds,
661 662
				nua_dialog_usage_t *du,
				sip_time_t now)
663 664
{
  nua_t *nua = nh->nh_nua;
665
  nua_client_request_t *cr = nh->nh_ds->ds_cr;
666 667 668
  nua_registration_t *nr = nua_dialog_usage_private(du);
  msg_t *msg;
  sip_t *sip;
669 670 671

  if (du->du_terminating || du->du_shutdown)
    return;
672

673
  if (cr->cr_msg) {
674 675
    /* Dialog is busy, delay of 5 .. 15 seconds */
    nua_dialog_usage_refresh_range(du, 5, 15);
676
    return;
677
  }
678

679
  outbound_stop_keepalive(nr->nr_ob);
680

681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
  cr->cr_msg = msg_copy(du->du_msg);
  msg = nua_creq_msg(nua, nh, cr, 1,
		     SIP_METHOD_REGISTER,
		     NUTAG_USE_DIALOG(1),
		     TAG_END());
  sip = sip_object(msg);
  if (!msg || !sip)
    goto error;

  cr->cr_orq =
    outbound_register_request(nr->nr_ob, 0,
			      nr->nr_by_stack ? nr->nr_contact : NULL,
			      nh->nh_nua->nua_nta,
			      process_response_to_register, nh, NULL,
			      msg,
			      SIPTAG_END(), 
			      NTATAG_COMP("sigcomp"),
			      TAG_END());
  if (!cr->cr_orq)
    goto error;

  cr->cr_usage = du;
  cr->cr_event = nua_r_register;
  return;

 error:
  msg_destroy(msg);
  msg_destroy(cr->cr_msg);
  UA_EVENT2(nua_r_register, NUA_INTERNAL_ERROR, TAG_END());
  return;
}

/** Shutdown register usage. 
 *
 * Called when stack is shut down or handle is destroyed. Unregister.
 */
static
718 719 720
int nua_register_usage_shutdown(nua_handle_t *nh, 
				nua_dialog_state_t *ds,
				nua_dialog_usage_t *du)
721 722
{
  nua_t *nua = nh->nh_nua;
723
  nua_client_request_t *cr = nh->nh_ds->ds_cr;
724 725 726 727 728 729 730 731 732 733 734
  nua_registration_t *nr = nua_dialog_usage_private(du);
  msg_t *msg;
  sip_t *sip;

  if (du->du_terminating)	/* Already terminating? */
    return 100;

  du->du_terminating = 1;

  if (cr->cr_msg)    /* Busy */
    return 100;
735 736 737

  outbound_stop_keepalive(nr->nr_ob);

738
  cr->cr_msg = msg_copy(du->du_msg);
739 740 741 742 743 744 745 746
  msg = nua_creq_msg(nua, nh, cr, 1,
		     SIP_METHOD_REGISTER,
		     NUTAG_USE_DIALOG(1),
		     TAG_END());
  sip = sip_object(msg);
  if (!msg || !sip)
    goto error;

747
  unregister_expires_contacts(msg, sip);
748 749

  cr->cr_orq =
750
    outbound_register_request(nr->nr_ob, 1,
751 752 753 754 755
			      nr->nr_by_stack ? nr->nr_contact : NULL,
			      nh->nh_nua->nua_nta,
			      process_response_to_register, nh, NULL,
			      msg,
			      SIPTAG_END(), 
756
			      NTATAG_SIGCOMP_CLOSE(1),
757 758 759 760 761
			      TAG_END());
  if (!cr->cr_orq)
    goto error;

  cr->cr_usage = du;
762 763
  cr->cr_event = nua_r_destroy;
  return 200;
764 765

 error:
766
  nua_dialog_usage_remove(nh, nh->nh_ds, du);
767 768
  msg_destroy(msg);
  msg_destroy(cr->cr_msg);
769
  return 500;
770 771
}

772

773 774 775 776 777
static
int process_response_to_register(nua_handle_t *nh,
				 nta_outgoing_t *orq,
				 sip_t const *sip)
{
778
  nua_client_request_t *cr = nh->nh_ds->ds_cr;
779
  nua_dialog_usage_t *du = cr->cr_usage;
780 781
  nua_registration_t *nr = nua_dialog_usage_private(du);
  int status, ready, reregister, terminating;
782
  char const *phrase;
783 784
  msg_t *_reqmsg = nta_outgoing_getrequest(orq);
  sip_t *req = sip_object(_reqmsg); msg_destroy(_reqmsg);
785 786

  assert(sip);
787
  assert(du && du->du_class == nua_register_usage);
788 789 790 791 792 793
  status = sip->sip_status->st_status;
  phrase = sip->sip_status->st_phrase;

  if (status < 200 || !du)
    return nua_stack_process_response(nh, cr, orq, sip, TAG_END());

794 795
  terminating = du->du_terminating;
  if (!terminating)
796
    nua_dialog_store_peer_info(nh, nh->nh_ds, sip);
797

798 799 800 801 802 803
  reregister = outbound_register_response(nr->nr_ob, terminating, req, sip);
  if (reregister < 0)
    SET_STATUS1(NUA_INTERNAL_ERROR);
  else if (reregister >= ob_reregister) {
    /* Save msg otherwise nua_creq_check_restart() will zap it */
    msg_t *msg = msg_ref_create(cr->cr_msg);
804

805 806 807 808
    if (nua_creq_check_restart(nh, cr, orq, sip, restart_register)) {
      msg_destroy(msg);
      return 0;
    }
809

810 811
    assert(cr->cr_msg == NULL);
    cr->cr_msg = msg;
812

813 814 815 816 817 818 819 820 821 822
    if (reregister >= ob_reregister_now) {
      /* We can try to reregister immediately */
      nua_creq_restart_with(nh, cr, orq, 100, "Updated Contact",
			    restart_register,
			    TAG_END());
    }
    else {
      /* Outbound will invoke refresh_register() later */
      nua_creq_save_restart(nh, cr, orq, 100, "Updated Contact",
			    restart_register);
823
    }
824
    return 0;
825
  }
826

827
  if (status >= 300)
828 829
    if (nua_creq_check_restart(nh, cr, orq, sip, restart_register))
      return 0;
830

831 832
  ready = !terminating && status < 300;
  du->du_ready = ready;
833

834 835
  if (status < 300) {
    if (!du->du_terminating) {
836
      sip_time_t mindelta = 0;
837 838
      sip_time_t now = sip_now(), delta, reqdelta;
      sip_contact_t const *m, *sent;
839

840
      /** Search for lowest delta of SIP contacts we tried to register */
841
      mindelta = SIP_TIME_MAX;
842

843
      reqdelta = req->sip_expires ? req->sip_expires->ex_delta : 0;
844

845
      for (m = sip->sip_contact; m; m = m->m_next) {
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
        if (m->m_url->url_type != url_sip && 
            m->m_url->url_type != url_sips)
          continue;
        for (sent = req->sip_contact; sent; sent = sent->m_next)
          if (url_cmp(m->m_url, sent->m_url) == 0) {
            sip_time_t mdelta = reqdelta;

            if (sent->m_expires)
              mdelta = strtoul(sent->m_expires, NULL, 10);
            if (mdelta == 0)
              mdelta = 3600;

            delta = sip_contact_expires(m, sip->sip_expires, sip->sip_date,
       				 mdelta, now);
            if (delta > 0 && delta < mindelta)
              mindelta = delta;
            if (url_cmp_all(m->m_url, sent->m_url) == 0)
              break;
          }
865 866
      }

867
      if (mindelta == SIP_TIME_MAX)
868
        mindelta = 3600;
869
      nua_dialog_usage_set_expires(du, mindelta);
870
    }
871 872
    else
      nua_dialog_usage_set_expires(du, 0);
873
  }
874 875

#if HAVE_SIGCOMP
876 877 878 879 880
  if (ready) {
    struct sigcomp_compartment *cc;
    cc = nta_outgoing_compartment(orq);
    sigcomp_compartment_unref(nr->nr_compartment);
    nr->nr_compartment = cc;
881
  }
882
#endif
883

884
  /*  RFC 3608 Section 6.1 Procedures at the UA
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899

   The UA performs a registration as usual.  The REGISTER response may
   contain a Service-Route header field.  If so, the UA MAY store the
   value of the Service-Route header field in an association with the
   address-of-record for which the REGISTER transaction had registered a
   contact.  If the UA supports multiple addresses-of-record, it may be
   able to store multiple service routes, one per address-of-record.  If
   the UA refreshes the registration, the stored value of the Service-
   Route is updated according to the Service-Route header field of the
   latest 200 class response.  If there is no Service-Route header field
   in the response, the UA clears any service route for that address-
   of-record previously stored by the UA.  If the re-registration
   request is refused or if an existing registration expires and the UA
   chooses not to re-register, the UA SHOULD discard any stored service
   route for that address-of-record.
900

901
  */
902 903 904
  if (ready) {
    su_free(nh->nh_home, nr->nr_route);
    nr->nr_route = sip_route_dup(nh->nh_home, sip->sip_service_route);
905 906
  }
  else {
907 908
    su_free(nh->nh_home, nr->nr_route);
    nr->nr_route = NULL;
909
  }
910

911 912 913
  if (ready) {
    /* RFC 3327 */
    /* Store last URI in Path header */
914 915
    sip_path_t *path = sip->sip_path;

916
    while (path && path->r_next)
917 918
      path = path->r_next;

919 920 921 922
    if (!nr->nr_path || !path ||
        url_cmp_all(nr->nr_path->r_url, path->r_url)) {
      su_free(nh->nh_home, nr->nr_path);
      nr->nr_path = sip_path_dup(nh->nh_home, path);
923 924 925
    }
  }

926
  if (ready)
927
    if (sip->sip_to->a_url->url_type == url_sips)
928
      nr->nr_secure = 1;
929

930 931 932 933
  if (nr->nr_ob) {
    if (ready) {
      outbound_gruuize(nr->nr_ob, sip);
      outbound_start_keepalive(nr->nr_ob, orq);
934
    }
935 936
    else
      outbound_stop_keepalive(nr->nr_ob);
937 938
  }

939
  nua_registration_set_ready(nr, ready);
940

941
  return nua_stack_process_response(nh, cr, orq, sip, TAG_END());
942
}
943

944
/* ---------------------------------------------------------------------- */
945
/* nua_registration_t interface */
946

947 948 949 950
#if HAVE_SOFIA_STUN
#include <sofia-sip/stun.h>
#endif

951
static void nua_stack_tport_update(nua_t *nua, nta_agent_t *nta);
952 953 954 955 956
static int nua_registration_add_contact_and_route(nua_registration_t *nr,
						  msg_t *msg,
						  sip_t *sip,
						  int add_contact,
						  int add_service_route);
957

958
int
959 960 961 962 963 964 965
nua_stack_init_transport(nua_t *nua, tagi_t const *tags)
{
  url_string_t const *contact1 = NULL, *contact2 = NULL;
  char const *name1 = "sip", *name2 = "sip";
  char const *certificate_dir = NULL;

  tl_gets(tags,
966 967 968 969
          NUTAG_URL_REF(contact1),
          NUTAG_SIPS_URL_REF(contact2),
          NUTAG_CERTIFICATE_DIR_REF(certificate_dir),
          TAG_END());
970

971 972 973
  if (!contact1 && contact2)
    contact1 = contact2, contact2 = NULL;

974 975 976 977 978 979 980 981 982 983 984 985
  if (contact1 &&
      (url_is_string(contact1) 
       ? strncasecmp(contact1->us_str, "sips:", 5) == 0
       : contact1->us_url->url_type == url_sips))
    name1 = "sips";

  if (contact2 && 
      (url_is_string(contact2) 
       ? strncasecmp(contact2->us_str, "sips:", 5) == 0
       : contact2->us_url->url_type == url_sips))
    name2 = "sips";

986
  if (!contact1 /* && !contact2 */) {
987
    if (nta_agent_add_tport(nua->nua_nta, NULL,
988 989 990
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0 &&
991
        nta_agent_add_tport(nua->nua_nta, URL_STRING_MAKE("sip:*:*"),
992 993 994
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0)
995
      return -1;
996
#if HAVE_SOFIA_STUN
997 998 999 1000 1001 1002 1003 1004
    if (stun_is_requested(TAG_NEXT(nua->nua_args)) &&
	nta_agent_add_tport(nua->nua_nta, URL_STRING_MAKE("sip:0.0.0.0:*"),
			    TPTAG_IDENT("stun"),
			    TPTAG_PUBLIC(tport_type_stun), /* use stun */
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0) {
      SU_DEBUG_0(("nua: error initializing STUN transport\n"));
    }
1005
#endif
1006
  }
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
  else {
    if (nta_agent_add_tport(nua->nua_nta, contact1,
			    TPTAG_IDENT(name1),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0)
      return -1;

    if (contact2 &&
	nta_agent_add_tport(nua->nua_nta, contact2,
			    TPTAG_IDENT(name2),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0) 
      return -1;
1020 1021
  }

1022

1023 1024 1025 1026 1027 1028
  if (nua_stack_init_registrations(nua) < 0)
    return -1;

  return 0;
}

1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
#if 0
  /* Store network detector param value */
  if (agent->sa_nw_updates == 0)
    agent->sa_nw_updates = nw_updates;
 	      NTATAG_DETECT_NETWORK_UPDATES_REF(nw_updates),
  unsigned nw_updates = 0;
  unsigned nw_updates = 0;

  su_network_changed_t *sa_nw_changed;

#endif

static
void nua_network_changed_cb(nua_t *nua, su_root_t *root)
{

  uint32_t nw_updates = NUA_NW_DETECT_TRY_FULL;

  switch (nw_updates) {
  case NUA_NW_DETECT_ONLY_INFO:
    nua_stack_event(nua, NULL, NULL, nua_i_network_changed,
		    SIP_200_OK, TAG_END());

    break;
    
  case NUA_NW_DETECT_TRY_FULL:

    /* 1) Shutdown all tports */
    nta_agent_close_tports(nua->nua_nta);

1059
    /* 2) Create new tports */
1060 1061 1062 1063 1064 1065 1066
    if (nua_stack_init_transport(nua, nua->nua_args) < 0)
      /* We are hosed */
      nua_stack_event(nua, NULL, NULL, nua_i_network_changed,
		      900, "Internal Error", TAG_END());
    else
      nua_stack_event(nua, NULL, NULL, nua_i_network_changed,
		      SIP_200_OK, TAG_END());
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 1093 1094

    break;
    
  default:
    break;
  }

  return;
}

int nua_stack_launch_network_change_detector(nua_t *nua)
{
  su_network_changed_t *snc = NULL;

  snc = su_root_add_network_changed(nua->nua_home,
				    nua->nua_api_root,
				    nua_network_changed_cb,
				    nua);
  
  if (!snc)
    return -1;

  nua->nua_nw_changed = snc;

  return 0;
}


1095 1096
int
nua_stack_init_registrations(nua_t *nua)
1097 1098
{
  /* Create initial identities: peer-to-peer, public, sips */
1099 1100
  nua_registration_t **nr_list = &nua->nua_registrations, **nr_next;
  nua_handle_t **nh_list;
1101
  nua_handle_t *dnh = nua->nua_dhandle;
1102
  sip_via_t const *v;
1103

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
  /* Remove existing, local address based registrations and count the
     rest */
  while (nr_list && *nr_list) {
    nr_next = &(*nr_list)->nr_next;
    if ((*nr_list)->nr_default == 1) {
      nua_registration_remove(*nr_list);
      /* memset(*nr_list, 170, sizeof(**nr_list)); */
      /* XXX - free, too */
    }
    nr_list = nr_next;
  }
  nr_list = &nua->nua_registrations;

1117 1118
  v = nta_agent_public_via(nua->nua_nta);
  if (v) {
1119
    nua_registration_from_via(nr_list, dnh, v, 1);
1120
  }
1121

1122 1123
  v = nta_agent_via(nua->nua_nta);
  if (v) {
1124
    nua_registration_from_via(nr_list, dnh, v, 0);
1125
  }
1126 1127
  else {
    sip_via_t v[2];
1128

1129 1130 1131 1132 1133 1134
    sip_via_init(v)->v_next = v + 1;
    v[0].v_protocol = sip_transport_udp;
    v[0].v_host = "addr.is.invalid.";
    sip_via_init(v + 1);
    v[1].v_protocol = sip_transport_tcp;
    v[1].v_host = "addr.is.invalid.";
1135

1136
    nua_registration_from_via(nr_list, dnh, v, 0);
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
  }

  /* Go through all the registrations and set to refresh almost
     immediately */
  nh_list = &nua->nua_handles;
  for (; *nh_list; nh_list = &(*nh_list)->nh_next) {
    nua_dialog_state_t *ds;
    nua_dialog_usage_t *du;

    ds = (*nh_list)->nh_ds;
    du = ds->ds_usage;

    if (ds->ds_has_register == 1 && du->du_class->usage_refresh) {
1150
      nua_dialog_usage_refresh(*nh_list, ds, du, 1);
1151
    }
1152 1153
  }

1154
  nta_agent_bind_tport_update(nua->nua_nta, nua, nua_stack_tport_update);
1155

1156 1157 1158
  return 0;
}

1159
int nua_registration_from_via(nua_registration_t **list,
1160
			      nua_handle_t *nh,
1161 1162
			      sip_via_t const *via,
			      int public)
1163
{
1164
  su_home_t *home = nh->nh_home;
1165 1166 1167
  sip_via_t *v, *pair, /* v2[2], */ *vias, **vv, **prev;
  nua_registration_t *nr = NULL, **next;
  su_home_t autohome[SU_HOME_AUTO_SIZE(1024)];
1168
  int nr_items = 0;
1169

1170
  vias = sip_via_copy(su_home_auto(autohome, sizeof autohome), via);
1171

1172
  for (; *list; list = &(*list)->nr_next)
1173
    ++nr_items;
1174

1175
  next = list;
1176

1177 1178 1179
  for (vv = &vias; (v = *vv);) {
    char const *protocol;
    sip_contact_t *contact;
1180
    sip_via_t v2[2];
1181

1182
    *vv = v->v_next, v->v_next = NULL, pair = NULL;
1183

1184 1185 1186 1187 1188 1189
    if (v->v_protocol == sip_transport_tcp)
      protocol = sip_transport_udp;
    else if (v->v_protocol == sip_transport_udp)
      protocol = sip_transport_tcp;
    else
      protocol = NULL;
1190

1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
    if (protocol) {
      /* Try to pair vias if we have both udp and tcp */
      for (prev = vv; *prev; prev = &(*prev)->v_next) {
        if (strcasecmp(protocol, (*prev)->v_protocol))
          continue;
        if (strcasecmp(v->v_host, (*prev)->v_host))
          continue;
        if (str0cmp(v->v_port, (*prev)->v_port))
          continue;
        break;
      }
1202

1203 1204 1205 1206
      if (*prev) {
        pair = *prev; *prev = pair->v_next; pair->v_next = NULL;
      }
    }
1207

1208 1209 1210
    /* if more than one candidate, ignore local entries */
    if (v && (*vv || nr_items > 0) && 
	host_is_local(v->v_host)) {
1211 1212
      SU_DEBUG_9(("nua_register: ignoring contact candidate %s:%s.\n", 
		  v->v_host, v->v_port ? v->v_port : ""));
1213 1214 1215
      continue;
    }
     
1216 1217 1218
    nr = su_zalloc(home, sizeof *nr);
    if (!nr)
      break;
1219

1220
    v2[0] = *v;
1221

1222 1223
    if (pair)
      /* Don't use protocol if we have both udp and tcp */
1224
      protocol = NULL, v2[0].v_next = &v2[1], v2[1] = *pair;
1225
    else
1226
      protocol = via->v_protocol, v2[0].v_next = NULL;
1227

1228
    v2[1].v_next = NULL;
1229

1230 1231 1232 1233 1234 1235 1236 1237
#if 1
    contact = nua_handle_contact_by_via(nh, home, NULL, v2, protocol, NULL);
#else
    contact = sip_contact_create_from_via_with_transport(home, v2, NULL, protocol);
#endif
    v = sip_via_dup(home, v2);

    if (!contact || !v) {
1238 1239 1240
      su_free(home, nr);
      break;
    }
1241

1242 1243 1244
    nr->nr_ready = 1, nr->nr_default = 1, nr->nr_public = public;
    nr->nr_secure = contact->m_url->url_type == url_sips;
    nr->nr_contact = contact;
1245
    nr->nr_via = v;
1246 1247
    nr->nr_ip4 = host_is_ip4_address(contact->m_url->url_host);
    nr->nr_ip6 = !nr->nr_ip4 && host_is_ip6_reference(contact->m_url->url_host);
1248

1249 1250 1251
    SU_DEBUG_9(("nua_register: Adding contact URL '%s' to list.\n", contact->m_url->url_host));

    ++nr_items;
1252 1253
    nr->nr_next = *next, nr->nr_prev = next; *next = nr, next = &nr->nr_next;
    nr->nr_list = list;
1254 1255
  }

1256 1257
  su_home_deinit(autohome);

1258 1259 1260
  return 0;
}

1261
static
1262
void nua_stack_tport_update(nua_t *nua, nta_agent_t *nta)
1263
{
1264 1265 1266 1267
#if 0
  nua_registration_t *default_oc;
  nua_registration_t const *defaults = nua->nua_registrations;
  sip_via_t *via = nta_agent_via(nta);
1268

1269
  default_oc = outbound_by_aor(defaults, NULL, 1);
1270

1271 1272
  if (default_oc) {
    assert(default_oc->nr_via);
1273

1274 1275 1276
    outbound_contacts_from_via(default_oc,
				       via,
				       via->v_next);
1277

1278 1279 1280 1281 1282
    /* refresh_register(nua_handle_t *nh, nua_dialog_usage_t *du, sip_time_t now); */
  }
#endif
  return;
}
1283

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
nua_registration_t *nua_registration_by_aor(nua_registration_t const *list,
					    sip_from_t const *aor,
					    url_t const *remote_uri,
					    int only_default)
{
  sip_from_t *alt_aor = NULL, _alt_aor[1];
  int sips_aor = aor && aor->a_url->url_type == url_sips;
  int sips_uri = remote_uri && remote_uri->url_type == url_sips;

  nua_registration_t const *nr, *public = NULL, *any = NULL;
  nua_registration_t const *namewise = NULL, *sipswise = NULL;

1296 1297 1298
  int ip4 = remote_uri && host_is_ip4_address(remote_uri->url_host);
  int ip6 = remote_uri && host_is_ip6_reference(remote_uri->url_host);

1299 1300 1301 1302 1303 1304 1305
  if (only_default || aor == NULL) {
    /* Ignore AoR, select only by remote_uri */
    for (nr = list; nr; nr = nr->nr_next) {
      if (!nr->nr_ready)
	continue;
      if (only_default && !nr->nr_default)
	continue;
1306 1307 1308 1309
      if (nr->nr_ip4 && ip6)
	continue;
      if (nr->nr_ip6 && ip4)
	continue;
1310 1311 1312 1313 1314 1315
      if (sips_uri ? nr->nr_secure : !nr->nr_secure) 
	return (nua_registration_t *)nr;
      if (!public && nr->nr_public)
	public = nr;
      if (!any)
	any = nr;
1316
    }
1317 1318 1319 1320 1321
    if (public)
      return (nua_registration_t *)public;
    if (any)
      return (nua_registration_t *)any;
    return NULL;
1322 1323
  }

1324 1325
  if (!sips_aor && aor)
    alt_aor = memcpy(_alt_aor, aor, sizeof _alt_aor);
1326

1327 1328 1329 1330 1331 1332 1333 1334 1335
  for (nr = list; nr; nr = nr->nr_next) {
    if (!nr->nr_ready)
      continue;
    if (nr->nr_aor) {
      if (aor && url_cmp(nr->nr_aor->a_url, aor->a_url) == 0)
	return (nua_registration_t *)nr;
      if (!namewise && alt_aor && url_cmp(nr->nr_aor->a_url, aor->a_url) == 0)
	namewise = nr;
    }
1336
    if (!sipswise && ((sips_aor || sips_uri) ? nr->nr_secure : !nr->nr_secure))
1337 1338 1339 1340 1341
      sipswise = nr;
    if (!public && nr->nr_public)
      public = nr;
    if (!any)
      any = nr;
1342 1343
  }

1344 1345 1346 1347
  if (namewise)
    return (nua_registration_t *)namewise;
  if (sipswise)
    return (nua_registration_t *)sipswise;
1348

1349 1350 1351 1352 1353 1354 1355 1356
  /* XXX - 
     should we do some policing whether sips_aor or sips_uri can be used
     with sip contact?
  */
  if (public)
    return (nua_registration_t *)public;
  if (any)
    return (nua_registration_t *)any;
1357

1358
  return NULL;
1359 1360
}

1361

1362
nua_registration_t *
1363
nua_registration_for_request(nua_registration_t const *list, sip_t const *sip)
1364
{
1365 1366
  sip_from_t const *aor;
  url_t *uri;
1367

1368 1369
  aor = sip->sip_from;
  uri = sip->sip_request->rq_url;
1370

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
  return nua_registration_by_aor(list, aor, uri, 0);
}

nua_registration_t *
nua_registration_for_response(nua_registration_t const *list, 
			      sip_t const *sip,
			      sip_record_route_t const *record_route,
			      sip_contact_t const *remote_contact)
{
  sip_to_t const *aor = NULL;
  url_t const *uri = NULL;

  if (sip)
1384
    aor = sip->sip_to;
1385 1386 1387 1388 1389 1390 1391 1392 1393
  
  if (record_route)
    uri = record_route->r_url;
  else if (sip && sip->sip_record_route)
    uri = sip->sip_record_route->r_url;
  else if (remote_contact)
    uri = remote_contact->m_url;
  else if (sip && sip->sip_from)
    uri = sip->sip_from->a_url;
1394

1395
  return nua_registration_by_aor(list, aor, uri, 0);
1396
}
1397

1398

1399 1400
/** Return Contact usable in dialogs */
sip_contact_t const *nua_registration_contact(nua_registration_t const *nr)
1401
{
1402 1403 1404 1405
  if (nr->nr_by_stack && nr->nr_ob) {
    sip_contact_t const *m = outbound_dialog_contact(nr->nr_ob);
    if (m)
      return m;
1406 1407
  }

1408
  return nr->nr_contact;
1409 1410
}

1411 1412
/** Return initial route. */
sip_route_t const *nua_registration_route(nua_registration_t const *nr)
1413
{
1414
  return nr ? nr->nr_route : NULL;
1415 1416
}

1417
sip_contact_t const *nua_stack_get_contact(nua_registration_t const *nr)
1418
{
1419 1420
  nr = nua_registration_by_aor(nr, NULL, NULL, 1);
  return nr ? nr->nr_contact : NULL;
1421 1422
}

1423 1424 1425 1426 1427 1428
/** Add a Contact (and Route) header to request */
int nua_registration_add_contact_to_request(nua_handle_t *nh,
					    msg_t *msg,
					    sip_t *sip,
					    int add_contact,
					    int add_service_route)
1429
{
1430
  nua_registration_t *nr = NULL;
1431

1432
  if (!add_contact && !add_service_route)
1433 1434
    return 0;

1435