stun.c 80.8 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3
/*
 * This file is part of the Sofia-SIP package
 *
4
 * Copyright (C) 2005-2006 Nokia Corporation.
Pekka Pessi's avatar
Pekka Pessi committed
5 6 7
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
8
 * This library is free software; you can redistribute it and/or
Pekka Pessi's avatar
Pekka Pessi committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * 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
 *
 */

25
/**@internal
Pekka Pessi's avatar
Pekka Pessi committed
26 27
 * @file stun.c STUN client module
 *
28
 * See RFC 3489/3489bis for further information.
Pekka Pessi's avatar
Pekka Pessi committed
29
 *
30
 * @author Martti Mela <Martti.Mela@nokia.com>
31
 * @author Tat Chan <Tat.Chan@nokia.com>
Pekka Pessi's avatar
Pekka Pessi committed
32 33 34 35 36 37 38 39
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * @author Kai Vehmanen <Kai.Vehmanen@nokia.com>
 * 
 * @date Created: Thu Jul 24 17:21:00 2003 ppessi
 */

#include "config.h" 

40
#include <assert.h>
41
#include <string.h>
42
#include <time.h>
43

44
#define SU_ROOT_MAGIC_T struct stun_magic_t
45

46
#include <sofia-sip/stun.h>
47
#include "stun_internal.h"
48
#include <sofia-sip/stun_tag.h>
Pekka Pessi's avatar
Pekka Pessi committed
49

50 51 52 53 54
#include <sofia-sip/su_alloc.h>
#include <sofia-sip/su_tagarg.h>
#include <sofia-sip/su_log.h>
#include <sofia-sip/su.h>
#include <sofia-sip/su_localinfo.h>
Pekka Pessi's avatar
Pekka Pessi committed
55

56 57 58 59
#if HAVE_NETINET_TCP_H
#include <netinet/tcp.h>
#endif

60
#if HAVE_OPENSSL
Pekka Pessi's avatar
Pekka Pessi committed
61
#include <openssl/opensslv.h>
Martti Mela's avatar
Martti Mela committed
62
#endif
Pekka Pessi's avatar
Pekka Pessi committed
63

Pekka Pessi's avatar
Pekka Pessi committed
64 65 66 67 68
/* Missing socket symbols */
#ifndef SOL_TCP
#define SOL_TCP IPPROTO_TCP
#endif

69 70 71 72 73 74 75
#if HAVE_FUNC
#elif HAVE_FUNCTION
#define __func__ __FUNCTION__
#else
static char const __func__[] = "stun";
#endif

Pekka Pessi's avatar
Pekka Pessi committed
76
/** STUN log. */
77 78 79 80 81 82 83 84 85 86 87 88
su_log_t stun_log[] = { SU_LOG_INIT("stun", "STUN_DEBUG", 3) }; 

/**@var STUN_DEBUG
 *
 * Environment variable determining the debug log level for @b stun module.
 *
 * The STUN_DEBUG environment variable is used to determine the debug logging
 * level for @b stun module. The default level is 3.
 * 
 * @sa <sofia-sip/su_debug.h>, stun_log, SOFIA_DEBUG
 */
extern char const STUN__DEBUG[];
Pekka Pessi's avatar
Pekka Pessi committed
89

90
enum {
91
  STUN_SENDTO_TIMEOUT = 1000,
92
  STUN_TLS_CONNECT_TIMEOUT = 8000,
93 94
};

95 96 97 98 99 100 101 102 103 104 105 106 107
/**
 * States of STUN requests. See stun_state_e for states
 * discovery processes.
 */ 
typedef enum stun_req_state_e {
  stun_req_no_assigned_event,
  stun_req_dispose_me,            /**< request can be disposed */
  stun_req_discovery_init,
  stun_req_discovery_processing,

  stun_req_error,
  stun_req_timeout
} stun_req_state_t;
108

109 110 111
#define CHG_IP		0x001
#define CHG_PORT	0x004

112 113 114 115 116 117 118 119 120 121
#define x_insert(l, n, x) \
 ((l) ? (l)->x##_prev = &(n)->x##_next : 0, \
  (n)->x##_next = (l), (n)->x##_prev = &(l), (l) = (n))

#define x_remove(n, x) \
  ((*(n)->x##_prev = (n)->x##_next) ? \
   (n)->x##_next->x##_prev = (n)->x##_prev : 0)

#define x_is_inserted(n, x) ((n)->x##_prev != NULL)

122
struct stun_discovery_s {
123
  stun_discovery_t   *sd_next, **sd_prev; /**< Linked list */
124

125 126 127
  stun_handle_t          *sd_handle;
  stun_discovery_f        sd_callback;
  stun_discovery_magic_t *sd_magic;
128

129 130 131
  tagi_t          *sd_tags;          /** stored tags for the discovery */


132 133 134 135 136 137 138 139 140 141
  su_addrinfo_t    sd_pri_info;      /**< server primary info */
  su_sockaddr_t    sd_pri_addr[1];   /**< server primary address */

  su_addrinfo_t    sd_sec_info;      /**< server secondary info */
  su_sockaddr_t    sd_sec_addr[1];   /**< server secondary address */

  stun_action_t    sd_action;        /**< My action */
  stun_state_t     sd_state;         /**< Progress states */

  su_socket_t      sd_socket;        /**< target socket */
142 143
  su_sockaddr_t    sd_bind_addr[1]; /**< local address */

144
  su_socket_t      sd_socket2;       /**< Alternative socket */
145

146
  int              sd_index;         /**< root_register index */
147

Martti Mela's avatar
Martti Mela committed
148
  /* Binding discovery */
149
  su_sockaddr_t    sd_addr_seen_outside[1];   /**< local address */
Martti Mela's avatar
Martti Mela committed
150

151
  /* NAT type related */
152
  stun_nattype_t   sd_nattype;       /**< Determined NAT type */
153 154
  int              sd_mapped_addr_match; /** Mapped addresses match? */
  int              sd_first;         /**< These are the requests  */
155 156 157
  int              sd_second;
  int              sd_third;
  int              sd_fourth;
158 159 160 161 162

  /* Life time related */
  int              sd_lt_cur;
  int              sd_lt;
  int              sd_lt_max;
163 164 165 166

  /* Keepalive timeout */
  unsigned int     sd_timeout;
  su_timer_t      *sd_timer;
167 168
};

169
struct stun_request_s {
170
  su_timer_t       *sr_timer;
171 172 173 174
  stun_request_t   *sr_next, **sr_prev; /**< Linked list */
  stun_msg_t       *sr_msg;             /**< STUN message pointer */
  stun_handle_t    *sr_handle;          /**< backpointer, STUN object */

175
  su_socket_t       sr_socket;          /**< Alternative socket */
176 177
  su_localinfo_t    sr_localinfo;       /**< local addrinfo */
  su_sockaddr_t     sr_local_addr[1];   /**< local address */
178
  su_sockaddr_t     sr_destination[1];
179

180
  stun_req_state_t  sr_state;           /**< Progress states */
181 182
  int               sr_retry_count;     /**< current retry number */
  long              sr_timeout;         /**< timeout for next sendto() */
183 184

  int               sr_from_y;
185 186 187
  int               sr_request_mask;    /**< Mask consisting of chg_ip and chg_port */
  stun_discovery_t *sr_discovery;
};
188

Martti Mela's avatar
Martti Mela committed
189
struct stun_handle_s
Pekka Pessi's avatar
Pekka Pessi committed
190
{
191 192 193
  su_home_t       sh_home[1];
  su_root_t      *sh_root;          /**< event loop */
  int             sh_root_index;    /**< object index of su_root_register() */
194

195
  stun_request_t *sh_requests; /**< outgoing requests list */
196
  stun_discovery_t *sh_discoveries; /**< Actions list */
197

198
  int             sh_max_retries;   /**< max resend for sendto() */
199

200 201
  su_addrinfo_t   sh_pri_info;      /**< server primary info */
  su_sockaddr_t   sh_pri_addr[1];   /**< server primary address */
202

203 204
  su_addrinfo_t   sh_sec_info;      /**< server secondary info */
  su_sockaddr_t   sh_sec_addr[1];   /**< server secondary address */
205

206 207
  su_localinfo_t  sh_localinfo;     /**< local addrinfo */
  su_sockaddr_t   sh_local_addr[1]; /**< local address */
208

209 210
  char           *sh_domain;        /**< domain address for DNS-SRV lookups */

211 212
  stun_dns_lookup_t  *sh_dns_lookup;
  stun_action_t       sh_dns_pend_action; 
213 214 215
  stun_discovery_f    sh_dns_pend_cb;
  stun_discovery_magic_t *sh_dns_pend_ctx;
  tagi_t             *sh_dns_pend_tags;
216

217
#if HAVE_OPENSSL
218 219
  SSL_CTX        *sh_ctx;           /**< SSL context for TLS */
  SSL            *sh_ssl;           /**< SSL handle for TLS */
Martti Mela's avatar
Martti Mela committed
220 221 222 223 224
#else
  void           *sh_ctx;           /**< SSL context for TLS */
  void           *sh_ssl;           /**< SSL handle for TLS */
#endif

225 226
  stun_msg_t      sh_tls_request;
  stun_msg_t      sh_tls_response;
227
  int             sh_nattype;       /**< NAT-type, see stun_common.h */
228

229 230
  stun_buffer_t   sh_username;
  stun_buffer_t   sh_passwd;
231

232 233
  int             sh_use_msgint;    /**< try message integrity (TLS) */
  int             sh_req_msgint;    /**< require use of msg-int (TLS) */
Pekka Pessi's avatar
Pekka Pessi committed
234 235
};

236

237 238
#define STUN_STATE_STR(x) case x: return #x

239
char const *stun_str_state(stun_state_t state)
240 241 242
{
  switch (state) {
  STUN_STATE_STR(stun_no_assigned_event);
243
  /* STUN_STATE_STR(stun_req_dispose_me); */
244 245 246 247 248
  STUN_STATE_STR(stun_tls_connecting);
  STUN_STATE_STR(stun_tls_writing);
  STUN_STATE_STR(stun_tls_closing);
  STUN_STATE_STR(stun_tls_reading);
  STUN_STATE_STR(stun_tls_done);
249 250
  /* STUN_STATE_STR(stun_req_discovery_init); */
  /* STUN_STATE_STR(stun_req_discovery_processing); */
251
  STUN_STATE_STR(stun_discovery_done);
252 253 254
  STUN_STATE_STR(stun_tls_connection_timeout);
  STUN_STATE_STR(stun_tls_connection_failed);
  STUN_STATE_STR(stun_tls_ssl_connect_failed);
255
  STUN_STATE_STR(stun_discovery_timeout);
256
  /* STUN_STATE_STR(stun_req_timeout); */
257 258 259 260 261 262
  
  case stun_error:
  default: return "stun_error";
  }
}

263 264
/** 
 * Returns the NAT type attached to STUN discovery handle.
265 266 267
 *
 * @see stun_nattype_str().
 * @see stun_test_nattype().
268
 */
269
char const *stun_nattype_str(stun_discovery_t *sd)
270
{
271 272 273 274 275
  char const *stun_nattype_str[] = {
    "NAT type undetermined",
    "Open Internet",
    "UDP traffic is blocked or server unreachable",
    "Symmetric UDP Firewall",
276 277 278 279 280 281
    "Full-Cone NAT (endpoint independent filtering and mapping)",
    "Restricted Cone NAT (endpoint independent mapping)",
    "Port Restricted Cone NAT (endpoint independent mapping)",
    "Endpoint independent filtering, endpoint dependent mapping",
    "Address dependent filtering, endpoint dependent mapping",
    "Symmetric NAT (address and port dependent filtering, endpoint dependent mapping)",
282 283
  };

284 285 286 287
  if (sd)
    return stun_nattype_str[sd->sd_nattype];
  else
    return stun_nattype_str[stun_nat_unknown];
288 289
}

290 291 292 293 294 295 296 297 298 299 300 301 302 303
/**
 * Returns the detected NAT type.
 * 
 * @see stun_nattype_str().
 * @see stun_test_nattype().
 */
stun_nattype_t stun_nattype(stun_discovery_t *sd)
{
  if (!sd)
    return stun_nat_unknown;

  return sd->sd_nattype;
}

304 305 306 307
su_addrinfo_t const *stun_server_address(stun_handle_t *sh)
{
  return &sh->sh_pri_info;
}
308

309 310
int stun_lifetime(stun_discovery_t *sd)
{
311
  return sd ? sd->sd_lt_cur : -1;
312 313 314
}


315
#if HAVE_OPENSSL
Pekka Pessi's avatar
Pekka Pessi committed
316
char const stun_version[] = 
Pekka Pessi's avatar
Pekka Pessi committed
317
 "sofia-sip-stun using " OPENSSL_VERSION_TEXT;
Martti Mela's avatar
Martti Mela committed
318 319 320 321
#else
char const stun_version[] = 
 "sofia-sip-stun";
#endif
Pekka Pessi's avatar
Pekka Pessi committed
322

323
static int do_action(stun_handle_t *sh, stun_msg_t *binding_response);
324
#if HAVE_OPENSSL
325
static int stun_tls_callback(su_root_magic_t *m, su_wait_t *w, su_wakeup_arg_t *arg);
326
#endif
327 328 329 330 331 332 333 334
static int process_binding_request(stun_request_t *req, stun_msg_t *binding_response);
static stun_discovery_t *stun_discovery_create(stun_handle_t *sh,
					       stun_action_t action,
					       stun_discovery_f sdf,
					       stun_discovery_magic_t *magic);
static int stun_discovery_destroy(stun_discovery_t *sd);
static int action_bind(stun_request_t *req, stun_msg_t *binding_response);
static int action_determine_nattype(stun_request_t *req, stun_msg_t *binding_response);
335
static int process_test_lifetime(stun_request_t *req, stun_msg_t *binding_response);
336 337 338

static stun_request_t *stun_request_create(stun_discovery_t *sd);
static int stun_send_binding_request(stun_request_t *req,
339
			      su_sockaddr_t *srvr_addr);
340
static int stun_bind_callback(stun_magic_t *m, su_wait_t *w, su_wakeup_arg_t *arg);
341

342
#if defined (__CYGWIN__)
343
static int get_localinfo(int family, su_sockaddr_t *su, socklen_t *return_len);
344
#endif
345

346
/* timers */
347 348 349
static void stun_sendto_timer_cb(su_root_magic_t *magic, 
				 su_timer_t *t,
				 su_timer_arg_t *arg);
350
#if HAVE_OPENSSL
351 352 353
static void stun_tls_connect_timer_cb(su_root_magic_t *magic, 
				      su_timer_t *t,
				      su_timer_arg_t *arg);
354
#endif
355 356 357
static void stun_test_lifetime_timer_cb(su_root_magic_t *magic, 
					su_timer_t *t,
					su_timer_arg_t *arg);
358 359 360 361 362 363
static void stun_keepalive_timer_cb(su_root_magic_t *magic, 
				    su_timer_t *t,
				    su_timer_arg_t *arg);


static int priv_stun_bind_send(stun_handle_t *sh, stun_request_t *req, stun_discovery_t *sd);
364 365 366 367 368
static int priv_dns_queue_action(stun_handle_t *sh,
				 stun_action_t action,
				 stun_discovery_f sdf,
				 stun_discovery_magic_t *magic,
				 tag_type_t tag, tag_value_t value, ...);
Martti Mela's avatar
Martti Mela committed
369 370 371

/**
 * Return su_root_t assigned to stun_handle_t.
372
 *
Martti Mela's avatar
Martti Mela committed
373
 * @param self stun_handle_t object
374 375
 * @return su_root_t object, NULL if self not given.
 */
376
su_root_t *stun_root(stun_handle_t *self)
377
{
378
  return self ? self->sh_root : NULL;
379 380 381
}


Pekka Pessi's avatar
Pekka Pessi committed
382
/**
Martti Mela's avatar
Martti Mela committed
383
 * Check if a STUN handle should be created.
Pekka Pessi's avatar
Pekka Pessi committed
384
 *
385 386 387 388 389 390 391
 * Return true if STUNTAG_SERVER() or STUNTAG_DOMAIN() tags have 
 * been specified, or otherwise if STUN_SERVER environment variable 
 * is set.
 *
 * @TAGS
 * @TAG STUNTAG_DOMAIN() domain to use in DNS-SRV based STUN server
 * @TAG STUNTAG_SERVER() stun server hostname or dotted IPv4 address
Pekka Pessi's avatar
Pekka Pessi committed
392 393 394 395 396 397
 *
 * @param tag,value,... tag-value list
 */
int stun_is_requested(tag_type_t tag, tag_value_t value, ...)
{
  ta_list ta;
398
  tagi_t const *t, *t2;
Pekka Pessi's avatar
Pekka Pessi committed
399 400
  char const *stun_server;

Martti Mela's avatar
Martti Mela committed
401
  enter;
Martti Mela's avatar
Martti Mela committed
402

Pekka Pessi's avatar
Pekka Pessi committed
403 404
  ta_start(ta, tag, value);
  t = tl_find(ta_args(ta), stuntag_server);
405 406 407 408
  t2 = tl_find(ta_args(ta), stuntag_domain);
  if (t && t->t_value) 
    stun_server = (char *)t->t_value;
  else if (t2 && t2->t_value)
409
    stun_server = (char *)t2->t_value;
410 411
  else
    stun_server = getenv("STUN_SERVER");
Pekka Pessi's avatar
Pekka Pessi committed
412 413 414 415 416
  ta_end(ta);

  return stun_server != NULL;
}

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452

/** 
 * Creates a STUN handle.
 *
 * The created handles can be used for STUN binding discovery, 
 * keepalives, and other STUN usages.
 *
 * @param root eventloop to used by the stun state machine
 * @param tag,value,... tag-value list 
 *
 * @TAGS
 * @TAG STUNTAG_DOMAIN() domain to use in DNS-SRV based STUN server
 * @TAG STUNTAG_SERVER() stun server hostname or dotted IPv4 address
 * @TAG STUNTAG_REQUIRE_INTEGRITY() true if msg integrity should be
 * used enforced
 *
 */
stun_handle_t *stun_handle_init(su_root_t *root,
				tag_type_t tag, tag_value_t value, ...)
{
  stun_handle_t *stun = NULL;
  char const *server = NULL, *domain = NULL;
  int req_msg_integrity = 1;
  int err;
  ta_list ta;
  
  enter;

  ta_start(ta, tag, value);

  tl_gets(ta_args(ta),
	  STUNTAG_SERVER_REF(server),
	  STUNTAG_DOMAIN_REF(domain),
	  STUNTAG_REQUIRE_INTEGRITY_REF(req_msg_integrity),
	  TAG_END());

453 454
  ta_end(ta);

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
  stun = su_home_clone(NULL, sizeof(*stun));

  if (!stun) {
    SU_DEBUG_3(("%s: %s failed\n", __func__, "su_home_clone()"));
    return NULL;
  }

  /* Enviroment overrides */
  if (getenv("STUN_SERVER")) {
    server = getenv("STUN_SERVER");
    SU_DEBUG_5(("%s: using STUN_SERVER=%s\n", __func__, server));
  }

  SU_DEBUG_5(("%s(\"%s\"): called\n", 
	      __func__, server));

  /* fail, if no server or a domain for a DNS-SRV lookup is specified */
472 473
  if (!server && !domain) {
    errno = ENOENT;
474
    return NULL;
475
  }
476 477 478 479 480 481 482 483 484 485 486 487 488 489
  
  stun->sh_pri_info.ai_addrlen = 16;
  stun->sh_pri_info.ai_addr = &stun->sh_pri_addr->su_sa;

  stun->sh_sec_info.ai_addrlen = 16;
  stun->sh_sec_info.ai_addr = &stun->sh_sec_addr->su_sa;

  stun->sh_localinfo.li_addrlen = 16;
  stun->sh_localinfo.li_addr = stun->sh_local_addr;

  stun->sh_domain = su_strdup(stun->sh_home, domain);
  stun->sh_dns_lookup = NULL;
  
  if (server) {
490
    err = stun_atoaddr(stun->sh_home, AF_INET, &stun->sh_pri_info, server);
491 492
    if (err < 0) {
      errno = ENOENT;
493
      return NULL;
494
    }
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
  }

  stun->sh_nattype = stun_nat_unknown;

  stun->sh_root     = root;
  /* always try TLS: */
  stun->sh_use_msgint = 1;
  /* whether use of shared-secret msgint is required */
  stun->sh_req_msgint = req_msg_integrity;

  stun->sh_max_retries = STUN_MAX_RETRX;

  /* initialize username and password */
  stun_init_buffer(&stun->sh_username);
  stun_init_buffer(&stun->sh_passwd);
  
  stun->sh_nattype = stun_nat_unknown;
  
  /* initialize random number generator */
  srand(time(NULL));
515
 
516 517 518
  return stun;
}

519 520 521 522 523
/** 
 * Performs shared secret request/response processing.
 * Result will be trigged in STUN handle callback (state
 * one of stun_tls_*).
 **/
524 525 526 527
int stun_obtain_shared_secret(stun_handle_t *sh,
			      stun_discovery_f sdf,
			      stun_discovery_magic_t *magic,
			      tag_type_t tag, tag_value_t value, ...)
Martti Mela's avatar
Martti Mela committed
528
{
529
#if HAVE_OPENSSL
Martti Mela's avatar
Martti Mela committed
530 531 532
  int events = -1;
  int one, err = -1;
  su_wait_t wait[1] = { SU_WAIT_INIT };
533
  su_socket_t s = INVALID_SOCKET;
Martti Mela's avatar
Martti Mela committed
534 535
  int family;
  su_addrinfo_t *ai = NULL;
536
  stun_discovery_t *sd;
Martti Mela's avatar
Martti Mela committed
537
  /* stun_request_t *req; */
Martti Mela's avatar
Martti Mela committed
538

539 540
  ta_list ta;

Martti Mela's avatar
Martti Mela committed
541
  assert(sh);
Martti Mela's avatar
Martti Mela committed
542

Martti Mela's avatar
Martti Mela committed
543
  enter;
Martti Mela's avatar
Martti Mela committed
544

545 546
  if (!sh->sh_pri_addr[0].su_port) {
    /* no STUN server address, perform a DNS-SRV lookup */
547 548 549
   
    ta_list ta;
    ta_start(ta, tag, value);
550
    SU_DEBUG_5(("Delaying STUN shared-secret req. for DNS-SRV query.\n"));
551 552 553 554
    err = priv_dns_queue_action(sh, stun_action_tls_query, sdf, magic, ta_tags(ta));
    ta_end(ta);
       
    return err;
555 556
  }

Martti Mela's avatar
Martti Mela committed
557 558 559
  ai = &sh->sh_pri_info;

  if (sh->sh_use_msgint == 1) {
560
    SU_DEBUG_3(("%s: Obtaining shared secret.\n", __func__));
Martti Mela's avatar
Martti Mela committed
561 562 563 564 565 566 567 568 569
  }
  else {
    SU_DEBUG_3(("No message integrity enabled.\n"));
    return errno = EFAULT, -1;
  }

  /* open tcp connection to server */
  s = su_socket(family = AF_INET, SOCK_STREAM, 0);

570
  if (s == INVALID_SOCKET) {
571
    return STUN_ERROR(errno, socket);
Martti Mela's avatar
Martti Mela committed
572 573 574 575
  }

  /* asynchronous connect() */
  if (su_setblocking(s, 0) < 0) {
576
    return STUN_ERROR(errno, su_setblocking);
Martti Mela's avatar
Martti Mela committed
577
  }
578

Martti Mela's avatar
Martti Mela committed
579 580
  if (setsockopt(s, SOL_TCP, TCP_NODELAY,
		 (void *)&one, sizeof one) == -1) {
581
    return STUN_ERROR(errno, setsockopt);
Martti Mela's avatar
Martti Mela committed
582 583 584 585 586 587 588 589
  }

  /* Do an asynchronous connect(). Three error codes are ok,
   * others cause return -1. */
  if (connect(s, (struct sockaddr *) &sh->sh_pri_addr, 
	      ai->ai_addrlen) == SOCKET_ERROR) {
    err = su_errno();
    if (err != EINPROGRESS && err != EAGAIN && err != EWOULDBLOCK) {
590
      return STUN_ERROR(err, connect);
Martti Mela's avatar
Martti Mela committed
591 592 593 594 595 596
    }
  }

  SU_DEBUG_9(("%s: %s: %s\n", __func__, "connect",
	      su_strerror(err)));
  
597
  sd = stun_discovery_create(sh, stun_action_tls_query, sdf, magic);
Martti Mela's avatar
Martti Mela committed
598
  sd->sd_socket = s;
Martti Mela's avatar
Martti Mela committed
599
  /* req = stun_request_create(sd); */
Martti Mela's avatar
Martti Mela committed
600

Martti Mela's avatar
Martti Mela committed
601
  events = SU_WAIT_CONNECT | SU_WAIT_ERR;
Martti Mela's avatar
Martti Mela committed
602
  if (su_wait_create(wait, s, events) == -1)
603
    return STUN_ERROR(errno, su_wait_create);
Martti Mela's avatar
Martti Mela committed
604

Martti Mela's avatar
Martti Mela committed
605
  /* su_root_eventmask(sh->sh_root, sh->sh_root_index, s, events); */
606 607

  if ((sd->sd_index =
Martti Mela's avatar
Martti Mela committed
608
       su_root_register(sh->sh_root, wait, stun_tls_callback, (su_wakeup_arg_t *) sd, 0)) == -1) {
609
    return STUN_ERROR(errno, su_root_register);
Martti Mela's avatar
Martti Mela committed
610 611
  }

612 613 614 615
  ta_start(ta, tag, value);
  sd->sd_tags = tl_adup(sh->sh_home, ta_args(ta));
  ta_end(ta);

616
  sd->sd_state = stun_tls_connecting;
Martti Mela's avatar
Martti Mela committed
617 618 619 620

  /* Create and start timer for connect() timeout */
  SU_DEBUG_3(("%s: creating timeout timer for connect()\n", __func__));

621 622
  sd->sd_timer = su_timer_create(su_root_task(sh->sh_root),
				 STUN_TLS_CONNECT_TIMEOUT);
Martti Mela's avatar
Martti Mela committed
623

624
  su_timer_set(sd->sd_timer, stun_tls_connect_timer_cb, (su_wakeup_arg_t *) sd);
Martti Mela's avatar
Martti Mela committed
625 626

  return 0;
627 628 629
#else /* !HAVE_OPENSSL */
  return -1;
#endif
Martti Mela's avatar
Martti Mela committed
630 631
}

632
static stun_request_t *stun_request_create(stun_discovery_t *sd)
633
{
634
  stun_handle_t *sh = sd->sd_handle;
635 636
  stun_request_t *req = NULL;

Martti Mela's avatar
Martti Mela committed
637
  enter;
Martti Mela's avatar
Martti Mela committed
638

639
  req = calloc(sizeof(stun_request_t), 1);
640 641
  if (!req)
    return NULL;
642

643
  req->sr_handle = sh;
644
  req->sr_discovery = sd;
645 646

  /* This is the default */
647
  req->sr_socket = sd->sd_socket;
648 649 650 651 652 653 654
  
  req->sr_localinfo.li_addrlen = sizeof(su_sockaddr_t);
  req->sr_localinfo.li_addr = req->sr_local_addr;
  
  /* default timeout for next sendto() */
  req->sr_timeout = STUN_SENDTO_TIMEOUT;
  req->sr_retry_count = 0;
655
  /* req->sr_action = action; */
656 657 658
  req->sr_request_mask = 0;
  
  req->sr_msg = calloc(sizeof(stun_msg_t), 1);
659

660
  req->sr_state = stun_req_discovery_init;
661
  memcpy(req->sr_local_addr, sd->sd_bind_addr, sizeof(su_sockaddr_t));
662

663
  /* Insert this request to the request queue */
664
  x_insert(sh->sh_requests, req, sr);
665

666 667 668
  return req;
}

669
void stun_request_destroy(stun_request_t *req)
670
{
671
  stun_handle_t *sh;
672 673
  assert(req);

Martti Mela's avatar
Martti Mela committed
674
  enter;
Martti Mela's avatar
Martti Mela committed
675

676 677
  sh = req->sr_handle;

678 679 680
  if (x_is_inserted(req, sr))
    x_remove(req, sr);

681
  req->sr_handle = NULL;
682
  req->sr_discovery = NULL;
683
  /* memset(req->sr_destination, 0, sizeof(su_sockaddr_t)); */
684

685 686 687 688 689 690 691 692 693 694
  if (req->sr_timer) {
    su_timer_destroy(req->sr_timer);
    req->sr_timer = NULL;
    SU_DEBUG_7(("%s: timer destroyed.\n", __func__));
  }

  if (req->sr_msg) {
    free(req->sr_msg);
    req->sr_msg = NULL;
  }
695

696
  free(req);
697 698 699

  SU_DEBUG_9(("%s: request destroyed.\n", __func__));

700 701 702
  return;
}

703

Pekka Pessi's avatar
Pekka Pessi committed
704
/** Destroy a STUN client */ 
Martti Mela's avatar
Martti Mela committed
705
void stun_handle_destroy(stun_handle_t *sh)
Pekka Pessi's avatar
Pekka Pessi committed
706
{ 
707
  stun_discovery_t *sd = NULL, *kill = NULL;
708
  stun_request_t *a, *b;
Pekka Pessi's avatar
Pekka Pessi committed
709

Martti Mela's avatar
Martti Mela committed
710
  enter;
Martti Mela's avatar
Martti Mela committed
711

712 713
  if (sh->sh_dns_lookup)
    stun_dns_lookup_destroy(sh->sh_dns_lookup);
714

715 716 717
  if (sh->sh_dns_pend_tags)
    su_free(sh->sh_home, sh->sh_dns_pend_tags);

718 719 720 721 722 723 724
  for (a = sh->sh_requests; a; ) {
    b = a->sr_next;
    stun_request_destroy(a);
    a = b;
  }


Martti Mela's avatar
Martti Mela committed
725 726
  /* There can be several discoveries using the same socket. It is
     still enough to deregister the socket in first of them */
727 728 729
  for (sd = sh->sh_discoveries; sd; ) {
    kill = sd;
    sd = sd->sd_next;
730

731 732 733
    /* Index has same value as sockfd, right? ... or not? */
    if (kill->sd_index != -1)
      su_root_deregister(sh->sh_root, kill->sd_index);
734 735
    if (kill->sd_action == stun_action_tls_query)
      su_close(kill->sd_socket);
736 737

    stun_discovery_destroy(kill);
Martti Mela's avatar
Martti Mela committed
738
  }
Martti Mela's avatar
Martti Mela committed
739

740 741 742 743 744
  stun_free_message(&sh->sh_tls_request);
  stun_free_message(&sh->sh_tls_response);
  stun_free_buffer(&sh->sh_username);
  stun_free_buffer(&sh->sh_passwd);

Martti Mela's avatar
Martti Mela committed
745
  su_home_zap(sh->sh_home);
Martti Mela's avatar
Martti Mela committed
746 747
}

Pekka Pessi's avatar
Pekka Pessi committed
748

749
/** Create wait object and register it to the handle callback */
750 751
static
int assign_socket(stun_discovery_t *sd, su_socket_t s, int register_socket) 
752
{
753
  stun_handle_t *sh = sd->sd_handle;
754
  int events;
Martti Mela's avatar
Martti Mela committed
755
  stun_discovery_t *tmp;
756
  /* su_localinfo_t clientinfo[1]; */
757 758
  su_sockaddr_t su[1];
  socklen_t sulen;
759
  char addr[SU_ADDRSIZE];
760
  int err;
761
  
762 763
  su_wait_t wait[1] = { SU_WAIT_INIT };

Martti Mela's avatar
Martti Mela committed
764 765
  enter;

766
  if (s == INVALID_SOCKET) {
767
    SU_DEBUG_3(("%s: invalid socket\n", __func__));
768 769 770
    return errno = EINVAL, -1;
  }

Martti Mela's avatar
Martti Mela committed
771
  for (tmp = sh->sh_discoveries; tmp; tmp = tmp->sd_next) {
772 773 774 775 776 777
    if (tmp->sd_socket == s) {
      sd->sd_socket = s;
      sd->sd_index = tmp->sd_index;
      memcpy(sd->sd_bind_addr, tmp->sd_bind_addr, sizeof(su_sockaddr_t));
      return 0;
    }
Martti Mela's avatar
Martti Mela committed
778
  }
779
  sd->sd_socket = s;
Martti Mela's avatar
Martti Mela committed
780

781
  if (!register_socket)
782 783
    return 0;

784 785
  /* set socket asynchronous */
  if (su_setblocking(s, 0) < 0) {
786
    return STUN_ERROR(errno, su_setblocking);
787 788
  }

789
  /* xxx -- check if socket is already assigned to this root */
790

791
  memset(su, 0, sulen = sizeof su);
792

793 794
  /* Try to bind it if not already bound */
  if (getsockname(s, &su->su_sa, &sulen) == -1 || su->su_port == 0) {
Martti Mela's avatar
Martti Mela committed
795

796 797
    sulen = su->su_len = sizeof su->su_sin;
    su->su_family = AF_INET;
798 799

#if defined (__CYGWIN__)
800
    get_localinfo(AF_INET, su, &sulen);
801 802
#endif

803 804
    if ((err = bind(s, &su->su_sa, sulen)) < 0) {
      SU_DEBUG_3(("%s: bind(%s:%u): %s\n",  __func__, 
805
		  inet_ntop(su->su_family, SU_ADDR(su), addr, sizeof(addr)),
806 807
		  (unsigned) ntohs(su->su_port),
		  su_strerror(su_errno())));
808 809 810
      return -1;
    }

811 812 813
    if (getsockname(s, &su->su_sa, &sulen) == -1) {
      return STUN_ERROR(errno, getsockname);
    }
814 815
  }

816
  memcpy(&sd->sd_bind_addr, su, sulen);
817 818

  SU_DEBUG_3(("%s: local socket is bound to %s:%u\n", __func__,
819
	      inet_ntop(su->su_family, SU_ADDR(su), addr, sizeof(addr)),
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
	      (unsigned) ntohs(su->su_port)));

  events = SU_WAIT_IN | SU_WAIT_ERR;

  if (su_wait_create(wait, s, events) == -1) {
    return STUN_ERROR(su_errno(), su_wait_create);
  }

  /* Register receiving function with events specified above */
  if ((sd->sd_index = su_root_register(sh->sh_root,
				       wait, stun_bind_callback,
				       (su_wakeup_arg_t *) sd, 0)) < 0) {
    return STUN_ERROR(errno, su_root_register);
  }

  SU_DEBUG_7(("%s: socket registered.\n", __func__));
836 837

  return 0;
838 839
}

840

841 842 843 844
/**
 * Helper function needed by Cygwin builds.
 */
#if defined (__CYGWIN__)
845
static int get_localinfo(int family, su_sockaddr_t *su, socklen_t *return_len)
846
{
847 848
  su_localinfo_t hints[1] = {{ LI_CANONNAME | LI_NUMERIC }}, *li, *res = NULL;
  int i, error;
849
  char addr[SU_ADDRSIZE];
850

851
  hints->li_family = family;
852

853
  if ((error = su_getlocalinfo(hints, &res)) == 0) {
854 855
    /* try to bind to the first available address */
    for (i = 0, li = res; li; li = li->li_next) {
856
      if (li->li_family != family)
857
	continue;
858 859 860 861 862 863 864 865 866
      if (li->li_scope == LI_SCOPE_HOST)
	continue;

      assert(*return_len >= li->li_addrlen);

      memcpy(su, li->li_addr, *return_len = li->li_addrlen);

      SU_DEBUG_3(("%s: using local address %s\n", __func__, 
		  inet_ntop(family, SU_ADDR(su), addr, sizeof(addr))));
867 868
      break;
    }
869 870

    su_freelocalinfo(res);
871
    
872 873
    if (!li) {			/* Not found */
      return STUN_ERROR(error, su_getlocalinfo);
874
    }
875 876

    return 0;
877 878
  }
  else {
879
    return STUN_ERROR(error, su_getlocalinfo);
880 881
  }
}
882
#endif
883

884 885 886 887 888 889 890 891
static void priv_lookup_cb(stun_dns_lookup_t *self,
			   stun_magic_t *magic)
{
  const char *udp_target = NULL;
  uint16_t udp_port = 0;
  int res;
  stun_handle_t *sh = (stun_handle_t *)magic;

892
  res = stun_dns_lookup_udp_addr(self, &udp_target, &udp_port);
893
  if (res == 0 && udp_target) {
894
    /* XXX: assumption that same host and port used for UDP/TLS */
895 896 897 898 899 900
    stun_atoaddr(sh->sh_home, AF_INET, &sh->sh_pri_info, udp_target);
    
    if (udp_port) 
      sh->sh_pri_addr[0].su_port = htons(udp_port);
    else
      sh->sh_pri_addr[0].su_port = htons(STUN_DEFAULT_PORT);
901

902 903
    /* step: now that server address is known, continue 
     *       the pending action */
904

905 906
    SU_DEBUG_5(("STUN server address found, running queue actions (%d).\n",
		sh->sh_dns_pend_action));
907

908 909 910 911
    switch(sh->sh_dns_pend_action) {
    case stun_action_tls_query:
      stun_obtain_shared_secret(sh, sh->sh_dns_pend_cb, sh->sh_dns_pend_ctx, TAG_NEXT(sh->sh_dns_pend_tags));
      break;
912

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
    case stun_action_binding_request:
      stun_bind(sh, sh->sh_dns_pend_cb, sh->sh_dns_pend_ctx, TAG_NEXT(sh->sh_dns_pend_tags));
      break;
      
    case stun_action_test_lifetime:
      stun_test_lifetime(sh, sh->sh_dns_pend_cb, sh->sh_dns_pend_ctx, TAG_NEXT(sh->sh_dns_pend_tags));
      break;
      
    case stun_action_test_nattype:
      stun_test_nattype(sh, sh->sh_dns_pend_cb, sh->sh_dns_pend_ctx, TAG_NEXT(sh->sh_dns_pend_tags));
      break;
      
    default:
      SU_DEBUG_5(("Warning: unknown pending STUN DNS-SRV action.\n"));
    }
928
      }
929 930 931 932 933 934
  else {
    /* DNS lookup failed */
    SU_DEBUG_5(("Warning: STUN DNS-SRV lookup failed.\n"));
    if (sh->sh_dns_pend_cb) {
      sh->sh_dns_pend_cb(sh->sh_dns_pend_ctx, sh, NULL,
			 sh->sh_dns_pend_action, stun_error);
935 936
    }
  }
937 938 939 940 941

  su_free(sh->sh_home, sh->sh_dns_pend_tags), sh->sh_dns_pend_tags = NULL;
  sh->sh_dns_pend_action = 0;
  sh->sh_dns_pend_cb = NULL;
  sh->sh_dns_pend_ctx = NULL;
942 943 944
}

/**
945 946
 * Queus a discovery process for later execution when DNS-SRV lookup
 * has been completed.
947
 */
948 949 950 951 952
static int priv_dns_queue_action(stun_handle_t *sh,
				 stun_action_t action,
				 stun_discovery_f sdf,
				 stun_discovery_magic_t *magic,
				 tag_type_t tag, tag_value_t value, ...)
953
{
954
  ta_list ta;
955

956 957 958
  if (!sh->sh_dns_pend_action) {
    if (!sh->sh_dns_lookup) {
      sh->sh_dns_lookup = stun_dns_lookup((stun_magic_t*)sh, sh->sh_root, priv_lookup_cb, sh->sh_domain);
959
      ta_start(ta, tag, value);
960
      assert(sh->sh_dns_pend_tags == NULL);
961 962 963 964 965
      sh->sh_dns_pend_tags = tl_tlist(sh->sh_home, 
				      ta_tags(ta));
      ta_end(ta);
      sh->sh_dns_pend_cb = sdf;
      sh->sh_dns_pend_ctx = magic;
966 967

    }
968
    sh->sh_dns_pend_action |= action;
969 970

    return 0;
971
  }
972 973
  
  return -1;
974 975 976 977 978 979 980 981 982
}

static int priv_stun_bind_send(stun_handle_t *sh, stun_request_t *req, stun_discovery_t *sd)
{
  int res = stun_send_binding_request(req, sh->sh_pri_addr);
  if (res < 0) {
    stun_free_message(req->sr_msg);
    stun_discovery_destroy(sd);
  }
983
  return res;
984 985
}

986 987 988 989 990
/** 
 * Performs a STUN Binding Discovery (see RFC3489/3489bis) process
 *
 * To integrity protect the discovery process, first call 
 * stun_request_shared_secret() on the handle 'sh'.
Pekka Pessi's avatar
Pekka Pessi committed
991
 *
992 993 994 995
 * If STUNTAG_REGISTER_SOCKET() is omitted, or set to false, the
 * client is responsible for socket i/o. Other stun module will
 * perform the whole discovery process and return the results
 * via callback 'sdf'.
Pekka Pessi's avatar
Pekka Pessi committed
996
 * 
997 998 999
 * @param sh       pointer to valid stun handle
 * @param sdf      callback to signal process progress
 * @param magic    context pointer attached to 'sdf'
1000
 * @param tag, value, ... list of tagged parameters.
Pekka Pessi's avatar
Pekka Pessi committed
1001
 *
1002
 * @TAGS
1003 1004 1005
 * @TAG STUNTAG_SOCKET() Bind socket handle to STUN (socket handle).
 * @TAG STUNTAG_REGISTER_SOCKET() Register socket for eventloop owned by STUN (boolean)
 *
Pekka Pessi's avatar
Pekka Pessi committed
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
 * @return
 * On success, zero is returned.  Upon error, -1 is returned, and @e errno is
 * set appropriately.
 * 
 * @ERRORS
 * @ERROR EFAULT          An invalid address is given as argument
 * @ERROR EPROTONOSUPPORT Not a UDP socket.
 * @ERROR EINVAL          The socket is already bound to an address.
 * @ERROR EACCESS   	  The address is protected, and the user is not 
 *                  	  the super-user.
 * @ERROR ENOTSOCK  	  Argument is a descriptor for a file, not a socket.
 * @ERROR EAGAIN          Operation in progress. Application should call 
 *                        stun_bind() again when there is data available on 
 *                        the socket.
 */
1021 1022 1023 1024 1025
int stun_bind(stun_handle_t *sh,
	      stun_discovery_f sdf,
	      stun_discovery_magic_t *magic,
	      tag_type_t tag, tag_value_t value,
	      ...)
Pekka Pessi's avatar
Pekka Pessi committed
1026
{
1027
  su_socket_t s = INVALID_SOCKET;
1028
  stun_request_t *req = NULL;
1029
  stun_discovery_t *sd = NULL;
1030
  ta_list ta;
1031
  int s_reg = 0;
1032
  
Martti Mela's avatar
Martti Mela committed
1033
  enter;
1034 1035 1036

  if (sh == NULL)
    return errno = EFAULT, -1;
1037

1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
  if (!sh->sh_pri_addr[0].su_port) {
    /* no STUN server address, perform a DNS-SRV lookup */
    int err;
    ta_list ta;
    ta_start(ta, tag, value);
    SU_DEBUG_5(("Delaying STUN bind for DNS-SRV query.\n"));
    err = priv_dns_queue_action(sh, stun_action_binding_request, sdf, magic, ta_tags(ta));
    ta_end(ta);
    return err;
  }

1049
  ta_start(ta, tag, value);
Pekka Pessi's avatar
Pekka Pessi committed
1050

1051 1052
  tl_gets(ta_args(ta),
	  STUNTAG_SOCKET_REF(s),
1053
	  STUNTAG_REGISTER_EVENTS_REF(s_reg),
1054 1055
	  TAG_END());

1056 1057
  ta_end(ta);

1058
  sd = stun_discovery_create(sh, stun_action_binding_request, sdf, magic);
1059
  if (assign_socket(sd, s, s_reg) < 0)
1060
    return -1;
1061

1062 1063
  req = stun_request_create(sd);

1064
  if (stun_make_binding_req(sh, req, req->sr_msg, 0, 0) < 0) {
1065
    stun_discovery_destroy(sd);
1066
    stun_free_message(req->sr_msg);
1067
    return -1;
1068
  }
Pekka Pessi's avatar
Pekka Pessi committed
1069

1070 1071
  /* note: we always report success if bind() succeeds */
  return priv_stun_bind_send(sh, req, sd);
Pekka Pessi's avatar
Pekka Pessi committed
1072 1073
}

Martti Mela's avatar
Martti Mela committed
1074

1075 1076 1077 1078 1079 1080
/** 
 * Returns the address of the public binding allocated by the NAT.
 *
 * In case of multiple on path NATs, the binding allocated by
 * the outermost NAT is returned.
 *
Martti Mela's avatar
Martti Mela committed
1081 1082 1083
 * This function returns the local address seen from outside.
 * Note that the address is not valid until the event stun_clien_done is launched.
 */
1084 1085 1086
int stun_discovery_get_address(stun_discovery_t *sd,
			       void *addr,
			       socklen_t *return_addrlen)
Martti Mela's avatar
Martti Mela committed
1087
{
1088
  socklen_t siz;
1089
  
Martti Mela's avatar
Martti Mela committed
1090
  enter;
Martti Mela's avatar
Martti Mela committed
1091

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
  assert(sd && addr);

  siz = SU_SOCKADDR_SIZE(sd->sd_addr_seen_outside);

  /* Check if enough memory provided */
  if (siz > *return_addrlen)
    return errno = EFAULT, -1;
  else
    *return_addrlen = siz;

  memcpy(addr, sd->sd_addr_seen_outside, siz);
  
  return 0;
Martti Mela's avatar
Martti Mela committed
1105 1106
}

1107 1108 1109 1110
static stun_discovery_t *stun_discovery_create(stun_handle_t *sh,
					       stun_action_t action,
					       stun_discovery_f sdf,
					       stun_discovery_magic_t *magic)
Martti Mela's avatar
Martti Mela committed
1111
{
1112
  stun_discovery_t *sd = NULL;
Martti Mela's avatar
Martti Mela committed
1113

Martti Mela's avatar
Martti Mela committed
1114
  enter;
Martti Mela's avatar
Martti Mela committed
1115

1116
  sd = calloc(1, sizeof(stun_discovery_t));
Martti Mela's avatar
Martti Mela committed
1117

1118 1119
  sd->sd_action = action;
  sd->sd_handle = sh;
1120 1121
  sd->sd_callback = sdf;
  sd->sd_magic = magic;
1122

1123 1124 1125 1126
  sd->sd_lt_cur = 0;
  sd->sd_lt = STUN_LIFETIME_EST;
  sd->sd_lt_max = STUN_LIFETIME_MAX;

1127
  sd->sd_pri_info.ai_addrlen = sizeof sd->sd_pri_addr->su_sin;
1128 1129 1130
  sd->sd_pri_info.ai_addr = &sd->sd_pri_addr->su_sa;

  /* Insert this action to the discovery queue */
1131
  x_insert(sh->sh_discoveries, sd, sd);
1132

1133
  return sd;
1134
}
Martti Mela's avatar
Martti Mela committed
1135

1136
static int stun_discovery_destroy(stun_discovery_t *sd)
1137
{
Martti Mela's avatar
Martti Mela committed
1138 1139
  stun_handle_t *sh;

Martti Mela's avatar
Martti Mela committed
1140
  enter;
Martti Mela's avatar
Martti Mela committed
1141

Martti Mela's avatar
Martti Mela committed
1142 1143 1144 1145 1146
  if (!sd)
    return errno = EFAULT, -1;

  sh = sd->sd_handle;

1147 1148 1149
  if (sd->sd_timer) 
    su_timer_destroy(sd->sd_timer), sd->sd_timer = NULL;

Martti Mela's avatar
Martti Mela committed
1150 1151 1152 1153
  /* if we are in the queue*/
  if (x_is_inserted(sd, sd))
    x_remove(sd, sd);

1154 1155
  sd->sd_next = NULL;

1156 1157 1158
  free(sd);
  return 0;
}
Martti Mela's avatar
Martti Mela committed
1159

1160
/**
1161 1162 1163 1164 1165 1166
 * Initiates STUN discovery process to find out NAT 
 * characteristics. 
 *
 * Process partly follows the algorithm defined in RFC3489 section 
 * 10.1. Due the known limitations of RFC3489, some of the tests
 * are done. 
1167
 *
1168
 * Note: does not support STUNTAG_DOMAIN() even if specified to
1169
 * stun_handle_init().
1170
 *
1171 1172 1173 1174 1175
 * @TAGS
 * @TAG STUNTAG_SOCKET Bind socket for STUN
 * @TAG STUNTAG_REGISTER_SOCKET Register socket for eventloop owned by STUN
 * @TAG STUNTAG_SERVER() stun server hostname or dotted IPv4 address
 *
1176
 * @return 0 on success, non-zero on error
1177
 */
1178 1179 1180 1181 1182
int stun_test_nattype(stun_handle_t *sh,
		       stun_discovery_f sdf,
		       stun_discovery_magic_t *magic,
		       tag_type_t tag, tag_value_t value,
		       ...)
Pekka Pessi's avatar
Pekka Pessi committed
1183
{
1184
  int err = 0, index = 0, s_reg = 0;
1185
  ta_list ta;
1186
  char const *server = NULL;
1187 1188
  stun_request_t *req = NULL;
  stun_discovery_t *sd = NULL;
1189
  su_socket_t s = INVALID_SOCKET;
1190 1191
  su_sockaddr_t *destination = NULL;

Martti Mela's avatar
Martti Mela committed
1192
  enter;
Martti Mela's avatar
Martti Mela committed
1193

1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
  if (!sh->sh_pri_addr[0].su_port) {
    /* no STUN server address, perform a DNS-SRV lookup */
   
    ta_list ta;
    ta_start(ta, tag, value);
    SU_DEBUG_5(("Delaying STUN get-nat-type req. for DNS-SRV query.\n"));
    err = priv_dns_queue_action(sh, stun_action_test_nattype, sdf, magic, ta_tags(ta));
    ta_end(ta);
       
    return err;
  }

  ta_start(ta, tag, value);
1207 1208
  tl_gets(ta_args(ta),
	  STUNTAG_SOCKET_REF(s),
1209
	  STUNTAG_REGISTER_EVENTS_REF(s_reg),
1210
	  STUNTAG_SERVER_REF(server),
1211 1212
	  TAG_END());

1213 1214
  ta_end(ta);

1215 1216
  if (s < 0)
    return errno = EFAULT, -1;
1217

1218
  sd = stun_discovery_create(sh, stun_action_test_nattype, sdf, magic);
1219 1220
  sd->sd_mapped_addr_match = -1;

1221
  if ((index = assign_socket(sd, s, s_reg)) < 0)
1222
    return errno = EFAULT, -1;
1223

1224
  /* If no server given, use default address from stun_handle_init() */
1225
  if (!server) {
1226 1227
    /* memcpy(&sd->sd_pri_info, &sh->sh_pri_info, sizeof(su_addrinfo_t)); */
    memcpy(sd->sd_pri_addr, sh->sh_pri_addr, sizeof(su_sockaddr_t));
1228 1229
  }
  else {
1230
    err = stun_atoaddr(sh->sh_home, AF_INET, &sd->sd_pri_info, server);
1231
    memcpy(sd->sd_pri_addr, &sd->sd_pri_info.ai_addr, sizeof(su_sockaddr_t));
1232
  }
1233
  destination = (su_sockaddr_t *) sd->sd_pri_addr;
1234