nua_register.c 46.4 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>
Martti Mela's avatar
Martti Mela committed
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>
Pekka Pessi's avatar
Pekka Pessi committed
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 76 77
#if !defined(random) && defined(_WIN32)
#define random rand
#endif

78 79
/* ======================================================================== */
/* Registrations and contacts */
80

81 82 83 84
int nua_registration_from_via(nua_registration_t **list,
			      su_home_t *home,
			      sip_via_t const *via,
			      int public);
85

86
int nua_registration_add(nua_registration_t **list, nua_registration_t *nr);
87

88
void nua_registration_remove(nua_registration_t *nr);
89

90 91
int nua_registration_set_aor(su_home_t *, nua_registration_t *nr,
			     sip_from_t const *aor);
92

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
int nua_registration_set_contact(su_home_t *,
				 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);
114 115 116
static void nua_register_usage_refresh(nua_handle_t *, nua_dialog_usage_t *,
				       sip_time_t);
static int nua_register_usage_shutdown(nua_handle_t *, nua_dialog_usage_t *);
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

/** 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 */

  /** 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.
   */
135
  unsigned nr_default:1, nr_secure:1, nr_public:1, nr_ip4:1, nr_ip6:1;
136

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

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

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

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

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

153 154 155 156 157 158 159 160
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,
161 162
    nua_register_usage_refresh,
    nua_register_usage_shutdown
163
  }};
164

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

170 171 172 173 174
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);
175

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

179
  ds->ds_has_register = 1;
180

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

183 184
  return 0;
}
185

186

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

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

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

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

  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);
}
218

219 220 221
/* ======================================================================== */
/* REGISTER */

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

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

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

230 231 232 233 234
/* Interface towards outbound_t */
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);
235

236 237
static int nua_stack_outbound_status(nua_handle_t *,
				     outbound_t *ob,
238 239 240
				     int status, char const *phrase,
				     tag_type_t tag, tag_value_t value, ...);

241 242
static int nua_stack_outbound_failed(nua_handle_t *,
				     outbound_t *ob,
243 244 245
				     int status, char const *phrase,
				     tag_type_t tag, tag_value_t value, ...);

246
static int nua_stack_outbound_credentials(nua_handle_t *, auth_client_t **auc);
247

248 249 250 251 252 253 254
outbound_owner_vtable nua_stack_outbound_callbacks = {
    sizeof nua_stack_outbound_callbacks,
    nua_stack_outbound_refresh,
    nua_stack_outbound_status,
    nua_stack_outbound_failed,
    nua_stack_outbound_failed,
    nua_stack_outbound_credentials
255 256
  };

Pekka Pessi's avatar
Pekka Pessi committed
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
/**@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:
273 274
 *     NUTAG_REGISTRAR(), NUTAG_INSTANCE(), NUTAG_OUTBOUND(),
 *     NUTAG_KEEPALIVE(), NUTAG_KEEPALIVE_STREAM(),
Pekka Pessi's avatar
Pekka Pessi committed
275 276 277 278 279 280 281 282
 *
 * @par Events:
 *     #nua_r_register, #nua_i_outbound
 *
 * @par NAT, Firewall and Outbound Support
 *
 * If the application did not include the Contact header in the tags,
 * nua_register() will generate one and start a protocol engine for outbound
283 284 285 286 287 288 289 290 291
 * connections used for NAT and firewall traversal and connectivity checks. 
 *
 * First, nua_register() 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 valid "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 source IP address in the Via header: if that
 * is different from the source IP address seen by the registrar, the
Pekka Pessi's avatar
Pekka Pessi committed
292 293 294 295 296 297 298 299 300
 * 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.
 *
 * The response to the initial REGISTER should also include feature tags
 * indicating whether registrar supports various SIP extensions: @e
301 302 303 304 305 306 307 308 309 310 311 312 313 314
 * 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.
Pekka Pessi's avatar
Pekka Pessi committed
315 316 317 318 319 320 321 322 323
 *
 * 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.
 *
324 325 326 327 328
 * @todo Actually generate public addresses.
 *
 * You can disable this kind of NAT traversal by setting "no-natify" into
 * NUTAG_OUTBOUND() options string.
 * 
Pekka Pessi's avatar
Pekka Pessi committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
 * @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
 * application using nua_i_outbound event, and start unregistration
 * procedure (unless that has been explicitly disabled).
 *
353 354 355
 * You can disable validation by inserting "no-validate" into
 * NUTAG_OUTBOUND() string.
 *
Pekka Pessi's avatar
Pekka Pessi committed
356 357 358 359
 * 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
360 361 362 363 364 365 366 367 368 369 370 371 372
 * 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.
Pekka Pessi's avatar
Pekka Pessi committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 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
 */

/** @var nua_event_e::nua_r_register
 *
 * Answer to outgoing REGISTER.
 *
 * 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.
 *
 * @param nh     operation handle associated with the call
 * @param hmagic operation magic associated with the call
 * @param status registration status
 * @param sip    response to REGISTER request or NULL upon an error
 *               (error code and message are in status an phrase parameters)
 * @param tags   empty
 */

/** @var nua_event_e::nua_i_outbound
 *
 * Answer to outgoing REGISTER.
 *
 * The REGISTER may be sent explicitly by nua_register() or
 * implicitly by NUA state machine.
 *
 * @param nh     operation handle associated with the call
 * @param hmagic operation magic associated with the call
 * @param sip    response to REGISTER request or NULL upon an error
 *               (error code and message are in status an phrase parameters)
 * @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.
 *
 * @param nh     operation handle associated with the call
 * @param hmagic operation magic associated with the call
 * @param sip    response to REGISTER request or NULL upon an error
 *               (error code and message are in status and phrase parameters)
 * @param tags   empty
 */


442
int
443 444
nua_stack_register(nua_t *nua, nua_handle_t *nh, nua_event_t e,
		   tagi_t const *tags)
445 446
{
  nua_dialog_usage_t *du;
447 448
  nua_registration_t *nr = NULL;
  outbound_t *ob = NULL;
449 450 451
  struct nua_client_request *cr = nh->nh_cr;
  msg_t *msg = NULL;
  sip_t *sip;
452
  int terminating = e != nua_r_register;
453 454

  if (nh->nh_special && nh->nh_special != nua_r_register)
455
    return UA_EVENT2(e, 900, "Invalid handle for REGISTER");
456
  if (cr->cr_orq)
457
    return UA_EVENT2(e, 900, "Request already in progress");
458

459
  nua_stack_init_handle(nua, nh, nh_has_register, "", TAG_NEXT(tags));
460
  nh->nh_special = nua_r_register;
461

462
  du = nua_dialog_usage_add(nh, nh->nh_ds, nua_register_usage, NULL);
463
  if (!du)
464
    return UA_EVENT1(e, NUA_INTERNAL_ERROR);
465 466 467 468
  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");
469

470 471 472 473
  if (cr->cr_msg)
    msg_destroy(cr->cr_msg), cr->cr_msg = NULL;
  /* Use original message as template when unregistering */
  if (terminating)		
474
    cr->cr_msg = msg_ref_create(du->du_msg);
475

476
  msg = nua_creq_msg(nua, nh, cr, cr->cr_msg != NULL,
477
		     SIP_METHOD_REGISTER,
478
		     TAG_IF(!terminating, NUTAG_USE_DIALOG(1)),
479 480
		     TAG_NEXT(tags));
  sip = sip_object(msg);
481 482
  if (!msg || !sip)
    goto error;
483

484 485 486 487
  if (!nr->nr_aor) {
    if (nua_registration_set_aor(nh->nh_home, nr, sip->sip_to) < 0)
      goto error;
  }
488

489
  du->du_terminating = terminating;
490

491 492
  if (du->du_msg == NULL)
    du->du_msg = msg_ref_create(cr->cr_msg); /* Save original message */
493

494 495 496
  if (terminating)
    /* Add Expires: 0 and remove the expire parameters from contacts */
    unregister_expires_contacts(msg, sip);
497

498 499 500 501 502 503 504 505 506 507 508 509
  if (nua_registration_set_contact(nh->nh_home, nr, sip->sip_contact, terminating) < 0)
    goto error;
  
  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;
510
  }
511

512 513 514 515 516 517 518 519 520 521 522 523
  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);

    if (outbound_set_contact(ob, sip->sip_contact, nr->nr_contact, terminating) < 0)
      goto error;
524 525
  }

526 527 528 529 530 531 532 533 534 535 536 537 538 539
  /* 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;
540

541
  cr->cr_usage = du;
542
  return cr->cr_event = e;
543 544 545 546 547 548

 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);
549 550 551 552 553 554 555
}

static void
restart_register(nua_handle_t *nh, tagi_t *tags)
{
  struct nua_client_request *cr = nh->nh_cr;
  msg_t *msg;
556
  nua_dialog_usage_t *du = cr->cr_usage;
557 558
  nua_registration_t *nr = nua_dialog_usage_private(du);
  int terminating = du && du->du_terminating;
559 560 561 562 563 564 565

  cr->cr_restart = NULL;

  if (!cr->cr_msg)
    return;

  msg = nua_creq_msg(nh->nh_nua, nh, cr, 1,
566 567 568 569
		     SIP_METHOD_UNKNOWN,
		     TAG_NEXT(tags));

  if (!msg)
570
    return;			/* XXX - Uh-oh */
571

572
  if (terminating)
573
    unregister_expires_contacts(msg, sip_object(msg));
574

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
  /* 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);
}
590

591 592 593 594 595
/** Refresh registration */
static
void nua_register_usage_refresh(nua_handle_t *nh,
				nua_dialog_usage_t *du,
				sip_time_t now)
596 597 598 599 600 601
{
  nua_t *nua = nh->nh_nua;
  nua_client_request_t *cr = nh->nh_cr;
  nua_registration_t *nr = nua_dialog_usage_private(du);
  msg_t *msg;
  sip_t *sip;
602 603 604

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

606
  if (cr->cr_msg) {
607
    /* Busy, delay of 5 .. 15 seconds */
608 609
    nua_dialog_usage_set_refresh(du, 5 + (unsigned)random() % 11U);
    return;
610
  }
611

612
  outbound_stop_keepalive(nr->nr_ob);
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 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
  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
int nua_register_usage_shutdown(nua_handle_t *nh, nua_dialog_usage_t *du)
{
  nua_t *nua = nh->nh_nua;
  nua_client_request_t *cr = nh->nh_cr;
  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;
666 667 668

  outbound_stop_keepalive(nr->nr_ob);

669
  cr->cr_msg = msg_copy(du->du_msg);
670 671 672 673 674 675 676 677
  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;

678
  unregister_expires_contacts(msg, sip);
679 680

  cr->cr_orq =
681
    outbound_register_request(nr->nr_ob, 1,
682 683 684 685 686
			      nr->nr_by_stack ? nr->nr_contact : NULL,
			      nh->nh_nua->nua_nta,
			      process_response_to_register, nh, NULL,
			      msg,
			      SIPTAG_END(), 
687
			      NTATAG_SIGCOMP_CLOSE(1),
688 689 690 691 692
			      TAG_END());
  if (!cr->cr_orq)
    goto error;

  cr->cr_usage = du;
693 694
  cr->cr_event = nua_r_destroy;
  return 200;
695 696

 error:
697
  nua_dialog_usage_remove(nh, nh->nh_ds, du);
698 699
  msg_destroy(msg);
  msg_destroy(cr->cr_msg);
700
  return 500;
701 702
}

703

704 705 706 707 708 709 710
static
int process_response_to_register(nua_handle_t *nh,
				 nta_outgoing_t *orq,
				 sip_t const *sip)
{
  struct nua_client_request *cr = nh->nh_cr;
  nua_dialog_usage_t *du = cr->cr_usage;
711 712
  nua_registration_t *nr = nua_dialog_usage_private(du);
  int status, ready, reregister, terminating;
713
  char const *phrase;
714 715
  msg_t *_reqmsg = nta_outgoing_getrequest(orq);
  sip_t *req = sip_object(_reqmsg); msg_destroy(_reqmsg);
716 717

  assert(sip);
718
  assert(du && du->du_class == nua_register_usage);
719 720 721 722 723 724
  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());

725 726
  terminating = du->du_terminating;
  if (!terminating)
727
    nua_dialog_store_peer_info(nh, nh->nh_ds, sip);
728

729 730 731 732 733 734
  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);
735

736 737 738 739
    if (nua_creq_check_restart(nh, cr, orq, sip, restart_register)) {
      msg_destroy(msg);
      return 0;
    }
740

741 742
    assert(cr->cr_msg == NULL);
    cr->cr_msg = msg;
743

744 745 746 747 748 749 750 751 752 753
    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);
754
    }
755
    return 0;
756
  }
757

758
  if (status >= 300)
759 760
    if (nua_creq_check_restart(nh, cr, orq, sip, restart_register))
      return 0;
761

762 763
  ready = !terminating && status < 300;
  du->du_ready = ready;
764

765 766 767 768 769 770
  if (status < 300) {
    sip_time_t mindelta = 0;

    if (!du->du_terminating) {
      sip_time_t now = sip_now(), delta, reqdelta;
      sip_contact_t const *m, *sent;
771

772
      /** Search for lowest delta of SIP contacts we tried to register */
773
      mindelta = SIP_TIME_MAX;
774

775
      reqdelta = req->sip_expires ? req->sip_expires->ex_delta : 0;
776

777
      for (m = sip->sip_contact; m; m = m->m_next) {
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
        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;
          }
797 798
      }

799
      if (mindelta == SIP_TIME_MAX)
800 801
        mindelta = 3600;
    }
802

803 804
    nua_dialog_usage_set_refresh(du, mindelta);
  }
805 806

#if HAVE_SIGCOMP
807 808 809 810 811
  if (ready) {
    struct sigcomp_compartment *cc;
    cc = nta_outgoing_compartment(orq);
    sigcomp_compartment_unref(nr->nr_compartment);
    nr->nr_compartment = cc;
812
  }
813
#endif
814

815
  /*  RFC 3608 Section 6.1 Procedures at the UA
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830

   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.
831

832
  */
833 834 835
  if (ready) {
    su_free(nh->nh_home, nr->nr_route);
    nr->nr_route = sip_route_dup(nh->nh_home, sip->sip_service_route);
836 837
  }
  else {
838 839
    su_free(nh->nh_home, nr->nr_route);
    nr->nr_route = NULL;
840
  }
841

842 843 844
  if (ready) {
    /* RFC 3327 */
    /* Store last URI in Path header */
845 846
    sip_path_t *path = sip->sip_path;

847
    while (path && path->r_next)
848 849
      path = path->r_next;

850 851 852 853
    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);
854 855 856
    }
  }

857
  if (ready)
858
    if (sip->sip_to->a_url->url_type == url_sips)
859
      nr->nr_secure = 1;
860

861 862 863 864
  if (nr->nr_ob) {
    if (ready) {
      outbound_gruuize(nr->nr_ob, sip);
      outbound_start_keepalive(nr->nr_ob, orq);
865
    }
866 867
    else
      outbound_stop_keepalive(nr->nr_ob);
868 869
  }

870
  nua_registration_set_ready(nr, ready);
871

872
  return nua_stack_process_response(nh, cr, orq, sip, TAG_END());
873
}
874

875
/* ---------------------------------------------------------------------- */
876
/* nua_registration_t interface */
877

878 879 880 881
#if HAVE_SOFIA_STUN
#include <sofia-sip/stun.h>
#endif

882
static void nua_stack_tport_update(nua_t *nua, nta_agent_t *nta);
883 884 885 886 887
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);
888

889
int
Pekka Pessi's avatar
Pekka Pessi committed
890 891 892 893 894 895 896
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,
897 898 899 900
          NUTAG_URL_REF(contact1),
          NUTAG_SIPS_URL_REF(contact2),
          NUTAG_CERTIFICATE_DIR_REF(certificate_dir),
          TAG_END());
Pekka Pessi's avatar
Pekka Pessi committed
901

902 903 904
  if (!contact1 && contact2)
    contact1 = contact2, contact2 = NULL;

Pekka Pessi's avatar
Pekka Pessi committed
905 906 907 908 909 910 911 912 913 914 915 916
  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";

917
  if (!contact1 /* && !contact2 */) {
Pekka Pessi's avatar
Pekka Pessi committed
918
    if (nta_agent_add_tport(nua->nua_nta, NULL,
919 920 921
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0 &&
922
        nta_agent_add_tport(nua->nua_nta, URL_STRING_MAKE("sip:*:*"),
923 924 925
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0)
Pekka Pessi's avatar
Pekka Pessi committed
926
      return -1;
927
#if HAVE_SOFIA_STUN
928 929 930 931 932 933 934 935
    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"));
    }
936
#endif
Pekka Pessi's avatar
Pekka Pessi committed
937
  }
938 939 940 941 942 943 944 945 946 947 948 949 950
  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;
Pekka Pessi's avatar
Pekka Pessi committed
951 952
  }

953

Pekka Pessi's avatar
Pekka Pessi committed
954 955 956 957 958 959
  if (nua_stack_init_registrations(nua) < 0)
    return -1;

  return 0;
}

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
#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);

Martti Mela's avatar
Martti Mela committed
990
    /* 2) Create new tports */
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
    if (nua_stack_init_transport(nua, nua->nua_args) < 0);


    nua_stack_event(nua, NULL, NULL, nua_i_network_changed,
		    SIP_200_OK, TAG_END());

    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;
}


Pekka Pessi's avatar
Pekka Pessi committed
1024 1025
int
nua_stack_init_registrations(nua_t *nua)
1026 1027
{
  /* Create initial identities: peer-to-peer, public, sips */
Martti Mela's avatar
Martti Mela committed
1028 1029
  nua_registration_t **nr_list = &nua->nua_registrations, **nr_next;
  nua_handle_t **nh_list;
1030
  su_home_t *home = nua->nua_dhandle->nh_home;
1031
  sip_via_t const *v;
1032

Martti Mela's avatar
Martti Mela committed
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
  /* 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;

1046 1047
  v = nta_agent_public_via(nua->nua_nta);
  if (v) {
Martti Mela's avatar
Martti Mela committed
1048
    nua_registration_from_via(nr_list, home, v, 1);
1049
  }
1050

1051 1052
  v = nta_agent_via(nua->nua_nta);
  if (v) {
Martti Mela's avatar
Martti Mela committed
1053
    nua_registration_from_via(nr_list, home, v, 0);
1054
  }
1055 1056
  else {
    sip_via_t v[2];
1057

1058 1059 1060 1061 1062 1063
    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.";
1064

Martti Mela's avatar
Martti Mela committed
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
    nua_registration_from_via(nr_list, home, v, 0);
  }

  /* 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) {
      du->du_refresh = sip_now();
      nua_dialog_usage_refresh(*nh_list, du, 1);
    }
1082 1083
  }

1084
  nta_agent_bind_tport_update(nua->nua_nta, nua, nua_stack_tport_update);
1085

1086 1087 1088
  return 0;
}

1089 1090 1091 1092
int nua_registration_from_via(nua_registration_t **list,
			      su_home_t *home,
			      sip_via_t const *via,
			      int public)
1093
{
1094 1095 1096
  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)];
1097
  int nr_items = 0;
1098

1099
  vias = sip_via_copy(su_home_auto(auto