nua_register.c 52.6 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
int nua_registration_from_via(nua_registration_t **list,
82
			      nua_handle_t *nh, 
83 84
			      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
int nua_registration_set_contact(nua_handle_t *,
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
				 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

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

Pekka Pessi's avatar
Pekka Pessi committed
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()
Pekka Pessi's avatar
Pekka Pessi committed
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().
Pekka Pessi's avatar
Pekka Pessi committed
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
Pekka Pessi's avatar
Pekka Pessi committed
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.
Pekka Pessi's avatar
Pekka Pessi committed
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.
 * 
Pekka Pessi's avatar
Pekka Pessi committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
 * @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).
 *
424 425 426
 * You can disable validation by inserting "no-validate" into
 * NUTAG_OUTBOUND() string.
 *
Pekka Pessi's avatar
Pekka Pessi committed
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.
Pekka Pessi's avatar
Pekka Pessi committed
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
 */

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

512
int
513 514
nua_stack_register(nua_t *nua, nua_handle_t *nh, nua_event_t e,
		   tagi_t const *tags)
515 516
{
  nua_dialog_usage_t *du;
517 518
  nua_registration_t *nr = NULL;
  outbound_t *ob = NULL;
519 520 521
  struct nua_client_request *cr = nh->nh_cr;
  msg_t *msg = NULL;
  sip_t *sip;
522
  int terminating = e != nua_r_register;
523 524

  if (nh->nh_special && nh->nh_special != nua_r_register)
525
    return UA_EVENT2(e, 900, "Invalid handle for REGISTER");
526
  if (cr->cr_orq)
527
    return UA_EVENT2(e, 900, "Request already in progress");
528

529
  nua_stack_init_handle(nua, nh, nh_has_register, "", TAG_NEXT(tags));
530
  nh->nh_special = nua_r_register;
531

532
  du = nua_dialog_usage_add(nh, nh->nh_ds, nua_register_usage, NULL);
533
  if (!du)
534
    return UA_EVENT1(e, NUA_INTERNAL_ERROR);
535 536 537 538
  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");
539

540 541 542 543
  if (cr->cr_msg)
    msg_destroy(cr->cr_msg), cr->cr_msg = NULL;
  /* Use original message as template when unregistering */
  if (terminating)		
544
    cr->cr_msg = msg_ref_create(du->du_msg);
545

546
  msg = nua_creq_msg(nua, nh, cr, cr->cr_msg != NULL,
547
		     SIP_METHOD_REGISTER,
548
		     TAG_IF(!terminating, NUTAG_USE_DIALOG(1)),
549 550
		     TAG_NEXT(tags));
  sip = sip_object(msg);
551 552
  if (!msg || !sip)
    goto error;
553

554 555 556 557
  if (!nr->nr_aor) {
    if (nua_registration_set_aor(nh->nh_home, nr, sip->sip_to) < 0)
      goto error;
  }
558

559
  du->du_terminating = terminating;
560

561 562
  if (du->du_msg == NULL)
    du->du_msg = msg_ref_create(cr->cr_msg); /* Save original message */
563

564 565 566
  if (terminating)
    /* Add Expires: 0 and remove the expire parameters from contacts */
    unregister_expires_contacts(msg, sip);
567

568
  if (nua_registration_set_contact(nh, nr, sip->sip_contact, terminating) < 0)
569 570 571 572 573 574 575 576 577 578 579
    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;
580
  }
581

582 583 584 585 586 587 588 589 590 591
  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);

592
    if (outbound_set_contact(ob, sip->sip_contact, nr->nr_via, terminating) < 0)
593
      goto error;
594 595
  }

596 597 598 599 600 601 602 603 604 605 606 607 608 609
  /* 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;
610

611
  cr->cr_usage = du;
612
  return cr->cr_event = e;
613 614 615 616 617 618

 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);
619 620 621 622 623 624 625
}

static void
restart_register(nua_handle_t *nh, tagi_t *tags)
{
  struct nua_client_request *cr = nh->nh_cr;
  msg_t *msg;
626
  nua_dialog_usage_t *du = cr->cr_usage;
627 628
  nua_registration_t *nr = nua_dialog_usage_private(du);
  int terminating = du && du->du_terminating;
629 630 631 632 633 634 635

  cr->cr_restart = NULL;

  if (!cr->cr_msg)
    return;

  msg = nua_creq_msg(nh->nh_nua, nh, cr, 1,
636 637 638 639
		     SIP_METHOD_UNKNOWN,
		     TAG_NEXT(tags));

  if (!msg)
640
    return;			/* XXX - Uh-oh */
641

642
  if (terminating)
643
    unregister_expires_contacts(msg, sip_object(msg));
644

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
  /* 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);
}
660

661 662 663 664 665
/** Refresh registration */
static
void nua_register_usage_refresh(nua_handle_t *nh,
				nua_dialog_usage_t *du,
				sip_time_t now)
666 667 668 669 670 671
{
  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;
672 673 674

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

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

682
  outbound_stop_keepalive(nr->nr_ob);
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 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
  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;
736 737 738

  outbound_stop_keepalive(nr->nr_ob);

739
  cr->cr_msg = msg_copy(du->du_msg);
740 741 742 743 744 745 746 747
  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;

748
  unregister_expires_contacts(msg, sip);
749 750

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

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

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

773

774 775 776 777 778 779 780
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;
781 782
  nua_registration_t *nr = nua_dialog_usage_private(du);
  int status, ready, reregister, terminating;
783
  char const *phrase;
784 785
  msg_t *_reqmsg = nta_outgoing_getrequest(orq);
  sip_t *req = sip_object(_reqmsg); msg_destroy(_reqmsg);
786 787

  assert(sip);
788
  assert(du && du->du_class == nua_register_usage);
789 790 791 792 793 794
  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());

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

799 800 801 802 803 804
  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);
805

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

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

814 815 816 817 818 819 820 821 822 823
    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);
824
    }
825
    return 0;
826
  }
827

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

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

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

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

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

846
      for (m = sip->sip_contact; m; m = m->m_next) {
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
        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;
          }
866 867
      }

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

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

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

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

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

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

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

920 921 922 923
    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);
924 925 926
    }
  }

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

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

940
  nua_registration_set_ready(nr, ready);
941

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

945
/* ---------------------------------------------------------------------- */
946
/* nua_registration_t interface */
947

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

952
static void nua_stack_tport_update(nua_t *nua, nta_agent_t *nta);
953 954 955 956 957
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);
958

959
int
Pekka Pessi's avatar
Pekka Pessi committed
960 961 962 963 964 965 966
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,
967 968 969 970
          NUTAG_URL_REF(contact1),
          NUTAG_SIPS_URL_REF(contact2),
          NUTAG_CERTIFICATE_DIR_REF(certificate_dir),
          TAG_END());
Pekka Pessi's avatar
Pekka Pessi committed
971

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

Pekka Pessi's avatar
Pekka Pessi committed
975 976 977 978 979 980 981 982 983 984 985 986
  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";

987
  if (!contact1 /* && !contact2 */) {
Pekka Pessi's avatar
Pekka Pessi committed
988
    if (nta_agent_add_tport(nua->nua_nta, NULL,
989 990 991
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0 &&
992
        nta_agent_add_tport(nua->nua_nta, URL_STRING_MAKE("sip:*:*"),
993 994 995
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0)
Pekka Pessi's avatar
Pekka Pessi committed
996
      return -1;
997
#if HAVE_SOFIA_STUN
998 999 1000 1001 1002 1003 1004 1005
    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"));
    }
1006
#endif
Pekka Pessi's avatar
Pekka Pessi committed
1007
  }
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
  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
1021 1022
  }

1023

Pekka Pessi's avatar
Pekka Pessi committed
1024 1025 1026 1027 1028 1029
  if (nua_stack_init_registrations(nua) < 0)
    return -1;

  return 0;
}

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 1059
#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
1060
    /* 2) Create new tports */
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 1093
    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
1094 1095
int
nua_stack_init_registrations(nua_t *nua)
1096 1097
{
  /* Create initial identities: peer-to-peer, public, sips */
Martti Mela's avatar
Martti Mela committed
1098 1099
  nua_registration_t **nr_list = &nua->nua_registrations, **nr_next;
  nua_handle_t **nh_list;
1100
  nua_handle_t *dnh = nua->nua_dhandle;
1101
  sip_via_t const *v;
1102

Martti Mela's avatar
Martti Mela committed
1103 1104 1105 1106 1107 1108