nua_register.c 58.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>
29
 * @author Martti Mela <Martti.Mela@nokia.com>
30
 * @author Kai Vehmanen <Kai.Vehmanen@nokia.com>
31 32 33 34 35 36
 *
 * @date Created: Wed Mar  8 11:48:49 EET 2006 ppessi
 */

#include "config.h"

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

40 41
#define TP_CLIENT_T          struct register_usage

42
#include <sofia-sip/string0.h>
43
#include <sofia-sip/su_strlst.h>
44 45 46
#include <sofia-sip/su_uniqueid.h>
#include <sofia-sip/su_tagarg.h>

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

51
#define NTA_UPDATE_MAGIC_T   struct nua_s
52

53
#include "nua_stack.h"
54

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

60 61 62 63
#define OUTBOUND_OWNER_T struct nua_handle_s

#include "outbound.h"

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

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

#include <assert.h>

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

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

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

85
void nua_registration_remove(nua_registration_t *nr);
86

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

90
int nua_registration_set_contact(nua_handle_t *,
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
				 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);
111 112 113
static void nua_register_usage_refresh(nua_handle_t *,
				       nua_dialog_state_t *,
				       nua_dialog_usage_t *,
114
				       sip_time_t);
115 116 117
static int nua_register_usage_shutdown(nua_handle_t *,
				       nua_dialog_state_t *,
				       nua_dialog_usage_t *);
118

Pekka Pessi's avatar
Pekka Pessi committed
119
/** @internal @brief REGISTER usage, aka nua_registration_t. */
120 121 122 123
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 */
124
  sip_contact_t nr_dcontact[1];	/**< Contact in dialog */
125
  sip_via_t *nr_via;		/**< Corresponding Via headers */
126

127 128
  unsigned long nr_min_expires;	/**< Value from 423 negotiation */

129 130
  /** Status of registration */
  unsigned nr_ready:1;
131

132 133 134 135 136 137 138 139 140
  /** 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.
   */
141
  unsigned nr_default:1, nr_secure:1, nr_public:1, nr_ip4:1, nr_ip6:1;
142

143
  /** Stack-generated contact */
144 145 146 147 148
  unsigned nr_by_stack:1;

  unsigned:0;
  
  int nr_error_report_id;	/**< ID used to ask for error reports from tport */
149

150 151
  sip_route_t *nr_route;	/**< Outgoing Service-Route */
  sip_path_t *nr_path;		/**< Incoming Path */
152

153 154
  tport_t *nr_tport;		/**< Transport to be used when registered */
  nua_dialog_state_t *nr_dialogs; /**< List of our dialogs */
155

156 157 158
#if HAVE_SIGCOMP
  struct sigcomp_compartment *nr_compartment;
#endif
159

160 161
  outbound_t *nr_ob;	/**< Outbound connection */
};
162

163 164 165 166 167 168 169 170
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,
171 172
    nua_register_usage_refresh,
    nua_register_usage_shutdown
173
  }};
174

175 176 177 178
static char const *nua_register_usage_name(nua_dialog_usage_t const *du)
{
  return "register";
}
179

180 181 182 183 184
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);
185

186 187
  if (ds->ds_has_register)
    return -1;			/* There can be only one usage */
188

189
  ds->ds_has_register = 1;
190

191
  nr->nr_public = 1;		/* */
192

193 194
  return 0;
}
195

196

197 198 199
static void nua_register_usage_remove(nua_handle_t *nh,
				      nua_dialog_state_t *ds,
				      nua_dialog_usage_t *du)
200
{
201
  nua_registration_t *nr = nua_dialog_usage_private(du);
202

203 204 205 206 207
  if (nr->nr_list)
    nua_registration_remove(nr);	/* Remove from list of registrations */

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

209
#if HAVE_SIGCOMP
210 211 212
  if (nr->nr_compartment)
    sigcomp_compartment_unref(nr->nr_compartment);
  nr->nr_compartment = NULL;
213
#endif
214

215 216 217 218 219 220
  if (nr->nr_error_report_id)
    tport_release(nr->nr_tport, nr->nr_error_report_id, NULL, NULL, nr, 0);

  if (nr->nr_tport)
    tport_unref(nr->nr_tport), nr->nr_tport = NULL;

221 222 223 224 225 226 227 228 229 230 231 232 233
  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);
}
234

235 236 237
/* ======================================================================== */
/* REGISTER */

238 239 240 241 242 243
static void nua_register_connection_closed(tp_stack_t *sip_stack,
					   nua_registration_t *nr,
					   tport_t *tport,
					   msg_t *msg,
					   int error);

244
/* Interface towards outbound_t */
245 246
sip_contact_t *nua_handle_contact_by_via(nua_handle_t *nh,
					 su_home_t *home,
247
					 int in_dialog,
248 249 250 251 252
					 sip_via_t const *v,
					 char const *transport,
					 char const *m_param,
					 ...);

253 254
static int nua_stack_outbound_refresh(nua_handle_t *,
				      outbound_t *ob);
255

256 257
static int nua_stack_outbound_status(nua_handle_t *,
				     outbound_t *ob,
258 259 260
				     int status, char const *phrase,
				     tag_type_t tag, tag_value_t value, ...);

261 262
static int nua_stack_outbound_failed(nua_handle_t *,
				     outbound_t *ob,
263 264 265
				     int status, char const *phrase,
				     tag_type_t tag, tag_value_t value, ...);

266
static int nua_stack_outbound_credentials(nua_handle_t *, auth_client_t **auc);
267

268 269
outbound_owner_vtable nua_stack_outbound_callbacks = {
    sizeof nua_stack_outbound_callbacks,
270 271 272 273 274 275
    /* oo_contact */ nua_handle_contact_by_via,
    /* oo_refresh */ nua_stack_outbound_refresh,
    /* oo_status */  nua_stack_outbound_status,
    /* oo_probe_error */     nua_stack_outbound_failed,
    /* oo_keepalive_error */ nua_stack_outbound_failed,
    /* oo_credentials */     nua_stack_outbound_credentials
276 277
  };

278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
/**@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:
294
 *     NUTAG_REGISTRAR(), NUTAG_INSTANCE(), NUTAG_OUTBOUND(),
295
 *     NUTAG_KEEPALIVE(), NUTAG_KEEPALIVE_STREAM(), NUTAG_M_USERNAME(),
Pekka Pessi's avatar
Pekka Pessi committed
296
 *     NUTAG_M_DISPLAY(), NUTAG_M_PARAMS(), NUTAG_M_FEATURES()
297 298 299
 *
 * @par Events:
 *     #nua_r_register, #nua_i_outbound
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 341 342 343 344 345 346 347 348 349 350 351
 * 
 * @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().
352 353 354
 *
 * @par NAT, Firewall and Outbound Support
 *
355 356 357
 * Normally, @b nua will start start a protocol engine for outbound
 * connections used for NAT and firewall traversal and connectivity checks
 * when registering. 
358
 *
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
 * @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
374 375 376 377 378 379 380
 * 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.
 *
381 382
 * The response to the initial REGISTER should also include option tags
 * indicating whether registrar supports various SIP extension options: @e
383 384 385 386 387 388 389 390 391 392 393 394 395 396
 * 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.
397 398 399 400 401 402 403 404 405
 *
 * 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.
 *
406 407 408 409 410
 * @todo Actually generate public addresses.
 *
 * You can disable this kind of NAT traversal by setting "no-natify" into
 * NUTAG_OUTBOUND() options string.
 * 
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
 * @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
432
 * application using #nua_i_outbound event, and start unregistration
433 434
 * procedure (unless that has been explicitly disabled).
 *
435 436 437
 * You can disable validation by inserting "no-validate" into
 * NUTAG_OUTBOUND() string.
 *
438 439 440 441
 * 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
442 443 444 445 446 447 448 449 450 451 452 453
 * 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.
 *
454 455 456 457 458
 * As alternative to OPTIONS/STUN keepalives, the client can propose
 * a more frequent registration refresh interval with
 * NUTAG_M_FEATURES() (e.g. NUTAG_M_FEATURES("expires=120") given as 
 * parameter to nua_register()).
 * 
459 460 461 462 463 464 465 466 467
 * @sa #nua_r_register, nua_unregister(), #nua_r_unregister, 
 * #nua_i_register,
 * @RFC3261 section 10,
 * @Expires, @Contact, @CallID, @CSeq,
 * @Path, @RFC3327, @ServiceRoute, @RFC3608, @RFC3680,
 *     NUTAG_REGISTRAR(), NUTAG_INSTANCE(), NUTAG_OUTBOUND(),
 *     NUTAG_KEEPALIVE(), NUTAG_KEEPALIVE_STREAM(), 
 *     SIPTAG_CONTACT(), SIPTAG_CONTACT_STR(), NUTAG_M_USERNAME(),
 *     NUTAG_M_DISPLAY(), NUTAG_M_PARAMS(), NUTAG_M_FEATURES(), 
468 469
 */

470
/** @NUA_EVENT nua_r_register
471
 *
472
 * Response to an outgoing REGISTER.
473 474
 *
 * The REGISTER may be sent explicitly by nua_register() or implicitly by
475 476 477 478
 * NUA state machines. 
 * 
 * When REGISTER request has been restarted the @a status may be 100 even
 * while the real response status returned is different.
479
 *
480 481 482 483 484
 * @param status response status code
 *               (if the request is retried, @a status is 100, the @a
 *               sip->sip_status->st_status contain the real status code
 *               from the response message, e.g., 302, 401, or 407)
 * @param phrase a short textual description of @a status code
485
 * @param nh     operation handle associated with the registration
486
 * @param hmagic application context associated with the registration
487
 * @param sip    response message to REGISTER request or NULL upon an error
488 489
 *               (status code is in @a status and 
 *                descriptive message in @a phrase parameters)
490
 * @param tags   empty
491 492 493 494 495 496
 *
 * @sa nua_register(), nua_unregister(), #nua_r_unregister,
 * @Contact, @CallID, @CSeq, @RFC3261 section 10,
 * @Path, @RFC3327, @ServiceRoute, @RFC3608, @RFC3680
 * 
 * @END_NUA_EVENT
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
 */

/**@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
518
 *     Header tags defined in <sofia-sip/sip_tag.h> except SIPTAG_EXPIRES() or SIPTAG_EXPIRES_STR()
519 520 521
 *
 * @par Events:
 *     #nua_r_unregister
522 523 524 525 526 527 528 529 530
 *
 * @sa nua_register(), #nua_r_register, nua_handle_destroy(), nua_shutdown(),
 * #nua_i_register,
 * @Expires, @Contact, @CallID, @CSeq, @RFC3261 section 10,
 * @Path, @RFC3327, @ServiceRoute, @RFC3608, @RFC3680,
 *     NUTAG_REGISTRAR(), NUTAG_INSTANCE(), NUTAG_OUTBOUND(),
 *     NUTAG_KEEPALIVE(), NUTAG_KEEPALIVE_STREAM(), 
 *     SIPTAG_CONTACT(), SIPTAG_CONTACT_STR(), NUTAG_M_USERNAME(),
 *     NUTAG_M_DISPLAY(), NUTAG_M_PARAMS(), NUTAG_M_FEATURES(), 
531 532
 */

533
/** @NUA_EVENT nua_r_unregister
534 535 536
 *
 * Answer to outgoing un-REGISTER.
 *
537 538 539 540 541
 * @param status response status code
 *               (if the request is retried, @a status is 100, the @a
 *               sip->sip_status->st_status contain the real status code
 *               from the response message, e.g., 302, 401, or 407)
 * @param phrase a short textual description of @a status code
542
 * @param nh     operation handle associated with the registration
543
 * @param hmagic application context associated with the registration
544
 * @param sip    response message to REGISTER request or NULL upon an error
545 546
 *               (status code is in @a status and 
 *                descriptive message in @a phrase parameters)
547
 * @param tags   empty
548 549 550 551 552 553
 *
 * @sa nua_unregister(), nua_register(), #nua_r_register,
 * @Contact, @CallID, @CSeq, @RFC3261 section 10,
 * @Path, @RFC3327, @ServiceRoute, @RFC3608, @RFC3680
 * 
 * @END_NUA_EVENT
554 555
 */

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
static int nua_register_client_template(nua_client_request_t *cr,
					msg_t **return_msg,
					tagi_t const *tags);
static int nua_register_client_init(nua_client_request_t *cr,
				    msg_t *, sip_t *,
				    tagi_t const *tags);
static int nua_register_client_request(nua_client_request_t *cr,
				       msg_t *, sip_t *,
				       tagi_t const *tags);
static int nua_register_client_check_restart(nua_client_request_t *cr,
					     int status, char const *phrase,
					     sip_t const *sip);
static int nua_register_client_response(nua_client_request_t *cr,
					int status, char const *phrase,
					sip_t const *sip);

572
static nua_client_methods_t const nua_register_client_methods = {
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
  SIP_METHOD_REGISTER,
  0,
  {
    /* create_dialog */ 1,
    /* in_dialog */ 0,
    /* target refresh */ 0
  },
  nua_register_client_template,
  nua_register_client_init,
  nua_register_client_request,
  nua_register_client_check_restart,
  nua_register_client_response
};

/**@internal Send REGISTER. */
int nua_stack_register(nua_t *nua,
		       nua_handle_t *nh,
		       nua_event_t e,
		       tagi_t const *tags)
{
  return nua_client_create(nh, e, &nua_register_client_methods, tags);
}

static int nua_register_client_template(nua_client_request_t *cr,
					msg_t **return_msg,
					tagi_t const *tags)
599 600 601
{
  nua_dialog_usage_t *du;

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
  if (cr->cr_event == nua_r_register)
    return 0;

  /* Use a copy of REGISTER message as the template for un-REGISTER */
  du = nua_dialog_usage_get(cr->cr_owner->nh_ds, nua_register_usage, NULL);
  if (du && du->du_cr) {
    if (nua_client_set_target(cr, du->du_cr->cr_target) < 0)
      return -1;
    *return_msg = msg_copy(du->du_cr->cr_msg);
    return 1;
  }

  return 0;
}

static int nua_register_client_init(nua_client_request_t *cr,
				    msg_t *msg, sip_t *sip,
				    tagi_t const *tags)
{
  nua_handle_t *nh = cr->cr_owner;
  nua_dialog_usage_t *du;
  nua_registration_t *nr;
  sip_to_t const *aor = sip->sip_to;

  int unreg;
627

628 629 630 631 632 633 634 635 636
  /* Explicit empty (NULL) contact - used for CPL store/remove? */
  if (!sip->sip_contact && cr->cr_has_contact)
    /* Do not create any usage */
    return 0;

  unreg = cr->cr_event != nua_r_register ||
    (sip->sip_expires && sip->sip_expires->ex_delta == 0);
  if (unreg)
    nua_client_terminating(cr);
637

638
  du = nua_dialog_usage_add(nh, nh->nh_ds, nua_register_usage, NULL);
639 640 641 642 643 644
  if (du == NULL)
    return -1;
  nr = nua_dialog_usage_private(du);

  if (nua_client_bind(cr, du) < 0)
    return -1;
645

646 647
  if (!nr->nr_list) {
    nua_registration_add(&nh->nh_nua->nua_registrations, nr);
648

649 650 651 652 653 654 655 656
    if (aor == NULL)
      aor = sip->sip_from;
    if (aor == NULL)
      aor = nh->nh_nua->nua_from;

    if (nua_registration_set_aor(nh->nh_home, nr, aor) < 0)
      return -1;
  }
657

658 659
  if (nua_registration_set_contact(nh, nr, sip->sip_contact, unreg) < 0)
    return -1;
660

661 662 663 664 665 666 667
  if (!nr->nr_ob && (NH_PGET(nh, outbound) || NH_PGET(nh, instance))) {
    nr->nr_ob = outbound_new(nh, &nua_stack_outbound_callbacks,
			     nh->nh_nua->nua_root,
			     nh->nh_nua->nua_nta,
			     NH_PGET(nh, instance));
    if (!nr->nr_ob)
      return nua_client_return(cr, 900, "Cannot create outbound", msg);
668
  }
669

670 671 672 673 674 675 676 677 678 679 680 681 682
  if (nr->nr_ob) {
    outbound_t *ob = nr->nr_ob;
    sip_contact_t *m;

    if (!unreg && sip->sip_contact) {
      for (m = sip->sip_contact; m; m = m->m_next)
	if (!m->m_expires || strtoul(m->m_expires, NULL, 10) != 0)
	  break;
      
      if (m == NULL)
	unreg = 1;	/* All contacts have expires=0 */
    }

683 684 685 686 687 688 689
    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));

690 691
    if (outbound_set_contact(ob, sip->sip_contact, nr->nr_via, unreg) < 0)
      return nua_client_return(cr, 900, "Cannot set outbound contact", msg);
692 693
  }

694
  return 0;
695 696
}

697 698 699 700
static
int nua_register_client_request(nua_client_request_t *cr,
				msg_t *msg, sip_t *sip,
				tagi_t const *tags)
701
{
702
  nua_handle_t *nh = cr->cr_owner;
703
  nua_dialog_usage_t *du = cr->cr_usage;
704
  nua_registration_t *nr;
705 706
  sip_contact_t *m, *contacts = sip->sip_contact;
  char const *min_expires = NULL;
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
  int unreg;

  (void)nh;

  /* Explicit empty (NULL) contact - used for CPL store/remove? */
  if (!contacts && cr->cr_has_contact)
    return nua_base_client_request(cr, msg, sip, tags);

  if ((du && du->du_shutdown) ||
      (sip->sip_expires && sip->sip_expires->ex_delta == 0))
    nua_client_terminating(cr);

  if (contacts) {
    if (!cr->cr_terminating) {
      for (m = contacts; m; m = m->m_next)
	if (!m->m_expires || strtoul(m->m_expires, NULL, 10) != 0)
	  break;
      /* All contacts have expires=0 */
      if (m == NULL)
	nua_client_terminating(cr);
    }
  }
729

730
  unreg = cr->cr_terminating;
731

732
  nr = nua_dialog_usage_private(du);
733

734
  if (nr) {
735 736 737 738
    if (nr->nr_ob) {
      outbound_stop_keepalive(nr->nr_ob);
      outbound_start_registering(nr->nr_ob);
    }
739

740
    if (nr->nr_by_stack) {
741 742
      sip_contact_t *m = nr->nr_contact, *previous = NULL;

743
      outbound_get_contacts(nr->nr_ob, &m, &previous);
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775

      sip_add_dup(msg, sip, (sip_header_t *)m);
      /* previous is an outdated contact generated by stack 
       * and it is now unregistered */
      if (previous)
	sip_add_dup(msg, sip, (sip_header_t *)previous);
    }
  }

  for (m = sip->sip_contact; m; m = m->m_next) {
    if (m->m_url->url_type == url_any) {
      /* If there is a '*' in contact list, remove everything else */
      while (m != sip->sip_contact)
	sip_header_remove(msg, sip, (sip_header_t *)sip->sip_contact);
      while (m->m_next)
	sip_header_remove(msg, sip, (sip_header_t *)m->m_next);
      contacts = m;
      break;
    }

    if (!m->m_expires)
      continue;
    if (unreg) {
      /* Remove the expire parameters from contacts */
      msg_header_remove_param(m->m_common, "expires");
    }
    else if (nr && nr->nr_min_expires && 
	     strtoul(m->m_expires, 0, 10) < nr->nr_min_expires) {
      if (min_expires == NULL) 
	min_expires = su_sprintf(msg_home(msg), "expires=%lu", 
				 nr->nr_min_expires);
      msg_header_replace_param(msg_home(msg), m->m_common, min_expires);
776 777
    }
  }
778

779 780 781 782 783 784
  return nua_base_client_trequest(cr, msg, sip,
				  TAG_IF(unreg, SIPTAG_EXPIRES_STR("0")),
#if 0
				  TAG_IF(unreg, NTATAG_SIGCOMP_CLOSE(1)),
				  TAG_IF(!unreg, NTATAG_COMP("sigcomp")),
#endif
785
				  NTATAG_TPORT(nr->nr_tport),
786
				  TAG_NEXT(tags));
787
}
788

789 790 791
static int nua_register_client_check_restart(nua_client_request_t *cr,
					     int status, char const *phrase,
					     sip_t const *sip)
792
{
793 794 795 796 797 798 799
  nua_registration_t *nr = nua_dialog_usage_private(cr->cr_usage);
  unsigned short retry_count = cr->cr_retry_count;
  int restart = 0, retry;

  if (nr && nr->nr_ob) {
    msg_t *_reqmsg = nta_outgoing_getrequest(cr->cr_orq);
    sip_t *req = sip_object(_reqmsg); msg_destroy(_reqmsg);
800

801 802
    retry = outbound_register_response(nr->nr_ob, cr->cr_terminating,
				       req, sip);
803

804 805 806 807 808 809 810
    restart = retry >= ob_reregister_now;
    
    if (retry == ob_reregister)
      /* outbound restarts REGISTER later */;

    if (retry < 0)
      /* XXX - report an error? */;
811
  }
812

813 814 815 816 817
  if (nr && status == 423) {
    if (sip->sip_min_expires)
      nr->nr_min_expires = sip->sip_min_expires->me_delta;
  }

818 819 820
  /* Check for status-specific reasons to retry */
  if (nua_base_client_check_restart(cr, status, phrase, sip))
    return 1;
821

822 823
  /* Restart only if nua_base_client_check_restart() did not try to restart */
  if (restart && retry_count == cr->cr_retry_count)
824
    return nua_client_restart(cr, 100, "Outbound NAT Detected");
825 826
  
  return 0;
827 828
}

829 830 831
static int nua_register_client_response(nua_client_request_t *cr,
					int status, char const *phrase,
					sip_t const *sip)
832
{
833 834
  nua_handle_t *nh = cr->cr_owner;
  nua_dialog_usage_t *du = cr->cr_usage;
835
  nua_registration_t *nr = nua_dialog_usage_private(du);
836
  int ready;
837

838
  ready = du && !cr->cr_terminated && status < 300;
839

840 841 842
  if (ready) {
    sip_time_t mindelta = 0;
    sip_time_t now = sip_now(), delta, reqdelta, mdelta;
843

844
    sip_contact_t const *m, *sent;
845

846 847 848
    msg_t *_reqmsg = nta_outgoing_getrequest(cr->cr_orq);
    sip_t *req = sip_object(_reqmsg);

849 850
    tport_t *tport;

851 852
    msg_destroy(_reqmsg);

853
    assert(nr); assert(sip); assert(req);
854

855 856 857 858 859 860 861 862
#if HAVE_SIGCOMP
    {
      struct sigcomp_compartment *cc;
      cc = nta_outgoing_compartment(cr->cr_orq);
      sigcomp_compartment_unref(nr->nr_compartment);
      nr->nr_compartment = cc;
    }
#endif
863

864 865 866 867 868
    /* XXX - if store/remove, remove 
       Content-Disposition
       Content-Type
       body
    */
869

870 871
    /** Search for lowest delta of SIP contacts we tried to register */
    mindelta = SIP_TIME_MAX;
872

873
    reqdelta = req->sip_expires ? req->sip_expires->ex_delta : 0;
874

875 876 877 878
    for (m = sip->sip_contact; m; m = m->m_next) {
      if (m->m_url->url_type != url_sip && 
	  m->m_url->url_type != url_sips)
	continue;
879

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
      for (sent = req->sip_contact; sent; sent = sent->m_next) {
	if (url_cmp(m->m_url, sent->m_url))
	  continue;

	if (sent->m_expires)
	  mdelta = strtoul(sent->m_expires, NULL, 10);
	else
	  mdelta = reqdelta;

	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;
899
      }
900
    }
901

902 903 904
    if (mindelta == SIP_TIME_MAX)
      mindelta = 3600;

905
    nua_dialog_usage_set_refresh(du, mindelta);
906

907
  /*  RFC 3608 Section 6.1 Procedures at the UA
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922

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

924
  */
925 926
    su_free(nh->nh_home, nr->nr_route);
    nr->nr_route = sip_route_dup(nh->nh_home, sip->sip_service_route);
927

928 929 930 931
    {
      /* RFC 3327 */
      /* Store last URI in Path header */
      sip_path_t *path = sip->sip_path;
932

933 934
      while (path && path->r_next)
	path = path->r_next;
935

936 937 938 939 940
      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);
      }
941 942
    }

943
    if (sip->sip_to->a_url->url_type == url_sips)
944
      nr->nr_secure = 1;
945

946
    if (nr->nr_ob) {
947
      outbound_gruuize(nr->nr_ob, sip);
948
      outbound_start_keepalive(nr->nr_ob, cr->cr_orq);
949
    }
950

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
    tport = nta_outgoing_transport (cr->cr_orq);

    /* cache persistant connection for registration */
    if (tport && tport != nr->nr_tport) {
      if (nr->nr_error_report_id) {
	if (tport_release(nr->nr_tport, nr->nr_error_report_id, NULL, NULL, nr, 0) < 0)
	  SU_DEBUG_1(("nua_register: tport_release() failed\n"));
	nr->nr_error_report_id = 0;
      }
      tport_unref(nr->nr_tport);
      nr->nr_tport = tport;

      if (tport_is_secondary(tport)) {
	tport_set_params(tport, TPTAG_SDWN_ERROR(1), TAG_END());
	nr->nr_error_report_id = 
	  tport_pend(tport, NULL, nua_register_connection_closed, nr);
      }
    }
    else
      tport_unref(tport);    /* note: nta_outgoing_transport() makes a ref */
971

972 973 974
    nua_registration_set_ready(nr, 1);
  }
  else if (du) {
975
    nua_dialog_usage_reset_refresh(du);
976 977 978 979 980 981

    su_free(nh->nh_home, nr->nr_route);
    nr->nr_route = NULL;

    outbound_stop_keepalive(nr->nr_ob);

982
    /* release the persistant transport for registration */
983 984 985 986 987 988
    if (nr->nr_tport) {
      if (nr->nr_error_report_id) {
	if (tport_release(nr->nr_tport, nr->nr_error_report_id, NULL, NULL, nr, 0) < 0)
	  SU_DEBUG_1(("nua_register: tport_release() failed\n"));
	nr->nr_error_report_id = 0;
      }
989

990 991
      tport_unref(nr->nr_tport), nr->nr_tport = NULL;
    }
992
    nua_registration_set_ready(nr, 0);
993 994 995
  }


996 997 998
  return nua_base_client_response(cr, status, phrase, sip, NULL);
}

999 1000 1001 1002 1003 1004 1005
static
void nua_register_connection_closed(tp_stack_t *sip_stack,
				    nua_registration_t *nr,
				    tport_t *tport,
				    msg_t *msg,
				    int error)
{
Pekka Pessi's avatar
Pekka Pessi committed
1006
  nua_dialog_usage_t *du = nua_dialog_usage_public(nr);
1007 1008 1009 1010
  tp_name_t const *tpn;
  int pending = nr->nr_error_report_id;

  assert(tport == nr->nr_tport);
1011

1012 1013 1014 1015 1016
  if (!nr->nr_tport)
    return;

  if (tport_release(nr->nr_tport, pending, NULL, NULL, nr, 0) < 0)
    SU_DEBUG_1(("nua_register: tport_release() failed\n"));
1017
  nr->nr_error_report_id = 0;
1018 1019 1020 1021

  tpn = tport_name(nr->nr_tport);

  SU_DEBUG_5(("nua_register(%p): tport to %s/%s:%s%s%s closed %s\n", 
Pekka Pessi's avatar
Pekka Pessi committed
1022
	      du->du_dialog->ds_owner,
1023 1024 1025 1026 1027
	      tpn->tpn_proto, tpn->tpn_host, tpn->tpn_port,
	      tpn->tpn_comp ? ";comp=" : "",
	      tpn->tpn_comp ? tpn->tpn_comp : "",
	      error != 0 ? su_strerror(error) : ""));

1028 1029 1030
  tport_unref(nr->nr_tport), nr->nr_tport = NULL;

  /* Schedule re-REGISTER immediately */
Pekka Pessi's avatar
Pekka Pessi committed
1031
  nua_dialog_usage_set_refresh_range(du, 0, 0);
1032 1033 1034
}


1035 1036 1037 1038 1039
static void nua_register_usage_refresh(nua_handle_t *nh,
				       nua_dialog_state_t *ds,
				       nua_dialog_usage_t *du,
				       sip_time_t now)
{
1040
  nua_t *nua = nh->nh_nua;
1041 1042 1043
  nua_client_request_t *cr = du->du_cr;

  if (cr) {
1044
    if (nua_client_resend_request(cr, 0) >= 0)
1045 1046 1047 1048
      return;
  }

  /* Report that we have de-registered */
1049
  nua_stack_event(nua, nh, NULL, nua_r_register, NUA_ERROR_AT(__FILE__, __LINE__), NULL);
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
  nua_dialog_usage_remove(nh, ds, du);
}

/** @interal Shut down REGISTER usage.
 *
 * @retval >0  shutdown done
 * @retval 0   shutdown in progress
 * @retval <0  try again later
 */
static int nua_register_usage_shutdown(nua_handle_t *nh,
1060 1061
				       nua_dialog_state_t *ds,
				       nua_dialog_usage_t *du)
1062 1063
{
  nua_client_request_t *cr = du->du_cr;
1064
  nua_registration_t *nr = nua_dialog_usage_private(du);
1065 1066 1067 1068 1069

  if (cr) {
    if (nua_client_is_queued(cr)) /* Already registering. */
      return -1;
    cr->cr_event = nua_r_unregister;
1070
    if (nua_client_resend_request(cr, 1) >= 0)
1071 1072 1073
      return 0;
  }

1074 1075 1076 1077
  /* release the persistant transport for registration */
  if (nr->nr_tport)
    tport_decref(&nr->nr_tport), nr->nr_tport = NULL;

1078 1079
  nua_dialog_usage_remove(nh, ds, du);
  return 200;
1080
}
1081

1082
/* ---------------------------------------------------------------------- */
1083
/* nua_registration_t interface */
1084

1085 1086 1087 1088
#if HAVE_SOFIA_STUN
#include <sofia-sip/stun.h>
#endif

1089
static void nua_stack_tport_update(nua_t *nua, nta_agent_t *nta);
1090 1091
static int nua_registration_add_contact_and_route(nua_handle_t *nh,
						  nua_registration_t *nr,
1092 1093 1094 1095
						  msg_t *msg,
						  sip_t *sip,
						  int add_contact,
						  int add_service_route);
1096

1097
int
1098 1099 1100 1101 1102 1103 1104
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,
1105 1106 1107 1108
          NUTAG_URL_REF(contact1),
          NUTAG_SIPS_URL_REF(contact2),
          NUTAG_CERTIFICATE_DIR_REF(certificate_dir),
          TAG_END());
1109

1110 1111 1112
  if (!contact1 && contact2)
    contact1 = contact2, contact2 = NULL;

1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
  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";

1125
  if (!contact1 /* && !contact2 */) {
1126
    if (nta_agent_add_tport(nua->nua_nta, NULL,
1127 1128 1129
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0 &&
1130
        nta_agent_add_tport(nua->nua_nta, URL_STRING_MAKE("sip:*:*"),
1131 1132 1133
			    TPTAG_IDENT("sip"),
			    TPTAG_CERTIFICATE(certificate_dir),
			    TAG_NEXT(nua->nua_args)) < 0)
1134
      return -1;
1135
#if HAVE_SOFIA_STUN
1136 1137 1138 1139 1140 1141 1142 1143
    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"));
    }
1144
#endif
1145
  }
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
  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;
1159 1160
  }

1161

1162 1163 1164 1165 1166 1167
  if (nua_stack_init_registrations(nua) < 0)
    return -1;

  return 0;
}

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
#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:
1188
    nua_stack_event(nua, NULL, NULL, nua_i_network_changed, SIP_200_OK, NULL);
1189 1190 1191 1192 1193 1194 1195
    break;
    
  case NUA_NW_DETECT_TRY_FULL:

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

1196
    /* 2) Create new tports */
1197 1198 1199
    if (nua_stack_init_transport(nua, nua->nua_args) < 0)
      /* We are hosed */
      nua_stack_event(nua, NULL, NULL, nua_i_network_changed,
1200
		      900, "Internal Error", NULL);
1201 1202
    else
      nua_stack_event(nua, NULL, NULL, nua_i_network_changed,
1203
		      SIP_200_OK, NULL);
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231

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


1232 1233
int
nua_stack_init_registrations(nua_t *nua)
1234 1235
{
  /* Create initial identities: peer-to-peer, public, sips */
1236 1237
  nua_registration_t **nr_list = &nua->nua_registrations, **nr_next;
  nua_handle_t **nh_list;
1238
  nua_handle_t *dnh = nua->nua_dhandle;
1239
  sip_via_t const *v;
1240

1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
  /* 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;

1254 1255
  v = nta_agent_public_via(nua->nua_nta);
  if (v) {
1256
    nua_registration_from_via(nr_list, dnh, v, 1);
1257
  }
1258

1259 1260
  v = nta_agent_via(nua->nua_nta);
  if (v) {
1261
    nua_registration_from_via(nr_list, dnh, v, 0);
1262
  }
1263 1264
  else {
    sip_via_t v[2];
1265

1266 1267 1268 1269 1270 1271
    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.";
1272

1273
    nua_registration_from_via(nr_list, dnh, v, 0);
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
  }

  /* 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) {
1287
      nua_dialog_usage_refresh(*nh_list, ds, du, 1);
1288
    }
1289 1290
  }

1291
  nta_agent_bind_tport_update(nua->nua_nta, nua, nua_stack_tport_update);
1292

1293 1294 1295
  return 0;
}

1296
int nua_registration_from_via(nua_registration_t **list,
1297
			      nua_handle_t *nh,
1298 1299
			      sip_via_t const *via,
			      int public)
1300
{
1301
  su_home_t *home = nh->nh_home;
1302 1303 1304
  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)];
1305
  int nr_items = 0;
1306

1307
  vias = sip_via_copy(su_home_auto(autohome, sizeof autohome), via);
1308

1309
  for (; *list; list = &(*list)->nr_next)
1310
    ++nr_items;
1311

1312
  next = list;
1313

1314 1315 1316
  for (vv = &vias; (v = *vv);) {
    char const *protocol;
    sip_contact_t *contact;
1317
    sip_via_t v2[2];
1318

1319
    *vv = v->v_next, v->v_next = NULL, pair = NULL;
1320

1321 1322 1323 1324 1325 1326
    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;
1327

1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
    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;
      }
1339

1340 1341 1342 1343
      if (*prev) {
        pair = *prev; *prev = pair->v_next; pair->v_next = NULL;
      }
    }
1344

1345 1346 1347
    /* if more than one candidate, ignore local entries */
    if (v && (*vv || nr_items > 0) && 
	host_is_local(v->v_host)) {
1348 1349
      SU_DEBUG_9(("nua_register: ignoring contact candidate %s:%s.\n", 
		  v->v_host, v->v_port ? v->v_port : ""));
1350 1351 1352
      continue;
    }
     
1353 1354 1355
    nr = su_zalloc(home, sizeof *nr);
    if (!nr)
      break;
1356

1357
    v2[0] = *v;
1358

1359 1360
    if (pair)
      /* Don't use protocol if we have both udp and tcp */
1361
      protocol = NULL, v2[0].v_next = &v2[1], v2[1] = *pair;
1362
    else
1363
      protocol = via->v_protocol, v2[0].v_next = NULL;
1364

1365
    v2[1].v_next = NULL;
1366

1367
    contact = nua_handle_contact_by_via(nh, home, 0, v2, protocol, NULL);
1368

1369 1370 1371
    v = sip_via_dup(home, v2);

    if (!contact || !v) {
1372 1373 1374
      su_free(home, nr);
      break;
    }
1375

1376 1377 1378
    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;
1379
    *nr->nr_dcontact = *contact, nr->nr_dcontact->m_params = NULL;
1380
    nr->nr_via = v;
1381 1382
    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);
1383

1384 1385 1386
    SU_DEBUG_9(("nua_register: Adding contact URL '%s' to list.\n", contact->m_url->url_host));

    ++nr_items;
1387 1388
    nr->nr_next = *next, nr->nr_prev = next; *next = nr, next = &nr->nr_next;
    nr->nr_list = list;
1389 1390
  }

1391 1392
  su_home_deinit(autohome);

1393 1394 1395
  return 0;
}

1396
static
1397
void nua_stack_tport_update(nua_t *nua, nta_agent_t *nta)
1398
{
1399 1400 1401 1402
#if 0
  nua_registration_t *default_oc;
  nua_registration_t const *defaults = nua->nua_registrations;
  sip_via_t *via = nta_agent_via(nta);
1403

1404
  default_oc = outbound_by_aor(defaults, NULL, 1);
1405

1406 1407
  if (default_oc) {
    assert(default_oc->nr_via);
1408

1409 1410 1411
    outbound_contacts_from_via(default_oc,
				       via,
				       via->v_next);
1412

1413 1414 1415 1416 1417
    /* refresh_register(nua_handle_t *nh, nua_dialog_usage_t *du, sip_time_t now); */
  }
#endif
  return;
}
1418

1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
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;
1429
  nua_registration_t const *registered = NULL;
1430 1431
  nua_registration_t const *namewise = NULL, *sipswise = NULL;

1432 1433 1434
  int ip4 = remote_uri && host_is_ip4_address(remote_uri->url_host);
  int ip6 = remote_uri && host_is_ip6_reference(remote_uri->url_host);

1435 1436 1437 1438 1439 1440 1441
  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;
1442 1443 1444 1445
      if (nr->nr_ip4 && ip6)
	continue;
      if (nr->nr_ip6 && ip4)
	continue;
1446 1447
      if (sips_uri ? nr->nr_secure : !nr->nr_secure) 
	return (nua_registration_t *)nr;
1448 1449
      if (!registered && nr->nr_aor)
	registered = nr;
1450 1451 1452 1453
      if (!public && nr->nr_public)
	public = nr;
      if (!any)
	any = nr;
1454
    }
1455 1456
    if (registered)
      return (nua_registration_t *)registered;
1457 1458 1459 1460 1461
    if (public)
      return (nua_registration_t *)public;
    if (any)
      return (nua_registration_t *)any;
    return NULL;
1462 1463
  }

1464
  if (!sips_aor && aor) {
1465
    alt_aor = memcpy(_alt_aor, aor, sizeof _alt_aor);
1466 1467 1468
    alt_aor->a_url->url_type = url_sips;
    alt_aor->a_url->url_scheme = "sips";
  }
1469

1470
  for (nr = list; nr; nr = nr->nr_next) {
Pekka Pessi's avatar