stun.c 80.9 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 25 26 27
 * 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
 *
 */

/**
 * @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>
Martti Mela's avatar
Martti Mela committed
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

43
#define SU_ROOT_MAGIC_T struct stun_magic_t
44

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

49 50 51 52 53
#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
54

Martti Mela's avatar
Martti Mela committed
55
#if defined(HAVE_OPENSSL)
Pekka Pessi's avatar
Pekka Pessi committed
56
#include <openssl/opensslv.h>
Martti Mela's avatar
Martti Mela committed
57
#endif
Pekka Pessi's avatar
Pekka Pessi committed
58

59 60 61 62
#if !defined(ETIMEDOUT) && defined(_WIN32)
#define ETIMEDOUT WSAETIMEDOUT
#endif

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

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

Pekka Pessi's avatar
Pekka Pessi committed
75
/** STUN log. */
76
su_log_t stun_log[] = { SU_LOG_INIT("stun", "STUN_DEBUG", SU_DEBUG) }; 
Pekka Pessi's avatar
Pekka Pessi committed
77

78
enum {
79
  STUN_SENDTO_TIMEOUT = 1000,
Martti Mela's avatar
Martti Mela committed
80
  STUN_TLS_CONNECT_TIMEOUT = 8000,
81 82
};

83 84 85 86 87 88 89 90 91 92 93 94 95
/**
 * 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;
96

97 98 99
#define CHG_IP		0x001
#define CHG_PORT	0x004

100 101 102 103 104 105 106 107 108 109
#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)

110
struct stun_discovery_s {
111
  stun_discovery_t   *sd_next, **sd_prev; /**< Linked list */
112

113 114 115
  stun_handle_t          *sd_handle;
  stun_discovery_f        sd_callback;
  stun_discovery_magic_t *sd_magic;
116

117 118 119
  tagi_t          *sd_tags;          /** stored tags for the discovery */


120 121 122 123 124 125 126 127 128 129
  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 */
130 131
  su_sockaddr_t    sd_bind_addr[1]; /**< local address */

132
  su_socket_t      sd_socket2;       /**< Alternative socket */
133

134
  int              sd_index;         /**< root_register index */
135

Martti Mela's avatar
Martti Mela committed
136
  /* Binding discovery */
137
  su_sockaddr_t    sd_addr_seen_outside[1];   /**< local address */
Martti Mela's avatar
Martti Mela committed
138

139
  /* NAT type related */
140
  stun_nattype_t   sd_nattype;       /**< Determined NAT type */
141 142
  int              sd_mapped_addr_match; /** Mapped addresses match? */
  int              sd_first;         /**< These are the requests  */
143 144 145
  int              sd_second;
  int              sd_third;
  int              sd_fourth;
146 147 148 149 150

  /* Life time related */
  int              sd_lt_cur;
  int              sd_lt;
  int              sd_lt_max;
Martti Mela's avatar
Martti Mela committed
151 152 153 154

  /* Keepalive timeout */
  unsigned int     sd_timeout;
  su_timer_t      *sd_timer;
155 156
};

157
struct stun_request_s {
158
  su_timer_t       *sr_timer;
159 160 161 162
  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 */

163 164 165
  su_socket_t       sr_socket;          /**< Alternative socket */
  su_localinfo_t    sr_localinfo;       /**< local addrinfo */
  su_sockaddr_t     sr_local_addr[1];   /**< local address */
Martti Mela's avatar
Martti Mela committed
166
  su_sockaddr_t     sr_destination[1];
167

168
  stun_state_t      sr_state;           /**< Progress states */
169 170
  int               sr_retry_count;     /**< current retry number */
  long              sr_timeout;         /**< timeout for next sendto() */
171 172

  int               sr_from_y;
173 174 175
  int               sr_request_mask;    /**< Mask consisting of chg_ip and chg_port */
  stun_discovery_t *sr_discovery;
};
176

Martti Mela's avatar
Martti Mela committed
177
struct stun_handle_s
Pekka Pessi's avatar
Pekka Pessi committed
178
{
179 180 181
  su_home_t       sh_home[1];
  su_root_t      *sh_root;          /**< event loop */
  int             sh_root_index;    /**< object index of su_root_register() */
182

183
  stun_request_t *sh_requests; /**< outgoing requests list */
184
  stun_discovery_t *sh_discoveries; /**< Actions list */
185

186
  int             sh_max_retries;   /**< max resend for sendto() */
187

188 189
  su_addrinfo_t   sh_pri_info;      /**< server primary info */
  su_sockaddr_t   sh_pri_addr[1];   /**< server primary address */
190

191 192
  su_addrinfo_t   sh_sec_info;      /**< server secondary info */
  su_sockaddr_t   sh_sec_addr[1];   /**< server secondary address */
193

194 195
  su_localinfo_t  sh_localinfo;     /**< local addrinfo */
  su_sockaddr_t   sh_local_addr[1]; /**< local address */
196

197 198
  char           *sh_domain;        /**< domain address for DNS-SRV lookups */

199 200
  stun_dns_lookup_t  *sh_dns_lookup;
  stun_action_t       sh_dns_pend_action; 
201 202 203
  stun_discovery_f    sh_dns_pend_cb;
  stun_discovery_magic_t *sh_dns_pend_ctx;
  tagi_t             *sh_dns_pend_tags;
204

Martti Mela's avatar
Martti Mela committed
205
#if defined(HAVE_OPENSSL)
206 207
  SSL_CTX        *sh_ctx;           /**< SSL context for TLS */
  SSL            *sh_ssl;           /**< SSL handle for TLS */
Martti Mela's avatar
Martti Mela committed
208 209 210 211 212
#else
  void           *sh_ctx;           /**< SSL context for TLS */
  void           *sh_ssl;           /**< SSL handle for TLS */
#endif

213 214
  stun_msg_t      sh_tls_request;
  stun_msg_t      sh_tls_response;
215
  int             sh_nattype;       /**< NAT-type, see stun_common.h */
Martti Mela's avatar
Martti Mela committed
216

217 218
  stun_buffer_t   sh_username;
  stun_buffer_t   sh_passwd;
219

220 221
  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
222 223
};

Martti Mela's avatar
Martti Mela committed
224

225 226
#define STUN_STATE_STR(x) case x: return #x

227
char const *stun_str_state(stun_state_t state)
228 229 230
{
  switch (state) {
  STUN_STATE_STR(stun_no_assigned_event);
231
  /* STUN_STATE_STR(stun_req_dispose_me); */
232 233 234 235 236
  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);
237 238
  /* STUN_STATE_STR(stun_req_discovery_init); */
  /* STUN_STATE_STR(stun_req_discovery_processing); */
239
  STUN_STATE_STR(stun_discovery_done);
240 241 242
  STUN_STATE_STR(stun_tls_connection_timeout);
  STUN_STATE_STR(stun_tls_connection_failed);
  STUN_STATE_STR(stun_tls_ssl_connect_failed);
243
  STUN_STATE_STR(stun_discovery_timeout);
244
  /* STUN_STATE_STR(stun_req_timeout); */
245 246 247 248 249 250
  
  case stun_error:
  default: return "stun_error";
  }
}

251 252
/** 
 * Returns the NAT type attached to STUN discovery handle.
253 254 255
 *
 * @see stun_nattype_str().
 * @see stun_test_nattype().
256
 */
257
char const *stun_nattype_str(stun_discovery_t *sd)
258
{
Martti Mela's avatar
Martti Mela committed
259 260 261 262 263
  char const *stun_nattype_str[] = {
    "NAT type undetermined",
    "Open Internet",
    "UDP traffic is blocked or server unreachable",
    "Symmetric UDP Firewall",
264 265 266 267 268 269
    "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)",
Martti Mela's avatar
Martti Mela committed
270 271
  };

Pekka Pessi's avatar
Pekka Pessi committed
272 273 274 275
  if (sd)
    return stun_nattype_str[sd->sd_nattype];
  else
    return stun_nattype_str[stun_nat_unknown];
276 277
}

278 279 280 281 282 283 284 285 286 287 288 289 290 291
/**
 * 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;
}

292 293 294 295
su_addrinfo_t const *stun_server_address(stun_handle_t *sh)
{
  return &sh->sh_pri_info;
}
296

297 298
int stun_lifetime(stun_discovery_t *sd)
{
Pekka Pessi's avatar
Pekka Pessi committed
299
  return sd ? sd->sd_lt_cur : -1;
300 301 302
}


Martti Mela's avatar
Martti Mela committed
303
#if defined(HAVE_OPENSSL)
Pekka Pessi's avatar
Pekka Pessi committed
304
char const stun_version[] = 
Pekka Pessi's avatar
Pekka Pessi committed
305
 "sofia-sip-stun using " OPENSSL_VERSION_TEXT;
Martti Mela's avatar
Martti Mela committed
306 307 308 309
#else
char const stun_version[] = 
 "sofia-sip-stun";
#endif
Pekka Pessi's avatar
Pekka Pessi committed
310

311 312 313 314 315 316 317 318 319 320
static int do_action(stun_handle_t *sh, stun_msg_t *binding_response);
static int stun_tls_callback(su_root_magic_t *m, su_wait_t *w, su_wakeup_arg_t *arg);
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);
321
static int process_test_lifetime(stun_request_t *req, stun_msg_t *binding_response);
322 323 324

static stun_request_t *stun_request_create(stun_discovery_t *sd);
static int stun_send_binding_request(stun_request_t *req,
325
			      su_sockaddr_t *srvr_addr);
326
static int stun_bind_callback(stun_magic_t *m, su_wait_t *w, su_wakeup_arg_t *arg);
327 328

/* timers */
329 330 331 332 333 334
static void stun_sendto_timer_cb(su_root_magic_t *magic, 
				 su_timer_t *t,
				 su_timer_arg_t *arg);
static void stun_tls_connect_timer_cb(su_root_magic_t *magic, 
				      su_timer_t *t,
				      su_timer_arg_t *arg);
335 336 337
static void stun_test_lifetime_timer_cb(su_root_magic_t *magic, 
					su_timer_t *t,
					su_timer_arg_t *arg);
338 339 340 341 342 343
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);
344 345 346 347 348
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
349 350 351

/**
 * Return su_root_t assigned to stun_handle_t.
352
 *
Martti Mela's avatar
Martti Mela committed
353
 * @param self stun_handle_t object
354 355
 * @return su_root_t object, NULL if self not given.
 */
356
su_root_t *stun_root(stun_handle_t *self)
357
{
358
  return self ? self->sh_root : NULL;
359 360 361
}


Pekka Pessi's avatar
Pekka Pessi committed
362
/**
Martti Mela's avatar
Martti Mela committed
363
 * Check if a STUN handle should be created.
Pekka Pessi's avatar
Pekka Pessi committed
364
 *
365 366 367 368 369 370 371
 * 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
372 373 374 375 376 377
 *
 * @param tag,value,... tag-value list
 */
int stun_is_requested(tag_type_t tag, tag_value_t value, ...)
{
  ta_list ta;
378
  tagi_t const *t, *t2;
Pekka Pessi's avatar
Pekka Pessi committed
379 380
  char const *stun_server;

Martti Mela's avatar
Martti Mela committed
381
  enter;
Martti Mela's avatar
Martti Mela committed
382

Pekka Pessi's avatar
Pekka Pessi committed
383 384
  ta_start(ta, tag, value);
  t = tl_find(ta_args(ta), stuntag_server);
385 386 387 388
  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)
389
    stun_server = (char *)t2->t_value;
390 391
  else
    stun_server = getenv("STUN_SERVER");
Pekka Pessi's avatar
Pekka Pessi committed
392 393 394 395 396
  ta_end(ta);

  return stun_server != NULL;
}

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465

/** 
 * 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());

  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 */
  if (!server && !domain)
    return NULL;
  
  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) {
466
    err = stun_atoaddr(stun->sh_home, AF_INET, &stun->sh_pri_info, server);
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495

    if (err < 0)
      return NULL;
  }

  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));
  
  ta_end(ta);

  return stun;
}

496 497 498 499 500
/** 
 * Performs shared secret request/response processing.
 * Result will be trigged in STUN handle callback (state
 * one of stun_tls_*).
 **/
501 502 503 504
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
505
{
506
#if defined(HAVE_OPENSSL)
Martti Mela's avatar
Martti Mela committed
507 508 509 510 511 512
  int events = -1;
  int one, err = -1;
  su_wait_t wait[1] = { SU_WAIT_INIT };
  su_socket_t s = SOCKET_ERROR;
  int family;
  su_addrinfo_t *ai = NULL;
513
  stun_discovery_t *sd;
Martti Mela's avatar
Martti Mela committed
514
  /* stun_request_t *req; */
Martti Mela's avatar
Martti Mela committed
515

516 517
  ta_list ta;

Martti Mela's avatar
Martti Mela committed
518
  assert(sh);
Martti Mela's avatar
Martti Mela committed
519

Martti Mela's avatar
Martti Mela committed
520
  enter;
Martti Mela's avatar
Martti Mela committed
521

522 523
  if (!sh->sh_pri_addr[0].su_port) {
    /* no STUN server address, perform a DNS-SRV lookup */
524 525 526
   
    ta_list ta;
    ta_start(ta, tag, value);
527
    SU_DEBUG_5(("Delaying STUN shared-secret req. for DNS-SRV query.\n"));
528 529 530 531
    err = priv_dns_queue_action(sh, stun_action_tls_query, sdf, magic, ta_tags(ta));
    ta_end(ta);
       
    return err;
532 533
  }

Martti Mela's avatar
Martti Mela committed
534 535 536
  ai = &sh->sh_pri_info;

  if (sh->sh_use_msgint == 1) {
Martti Mela's avatar
Martti Mela committed
537
    SU_DEBUG_3(("%s: Obtaining shared secret.\n", __func__));
Martti Mela's avatar
Martti Mela committed
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
  }
  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);

  if (s == -1) {
    STUN_ERROR(errno, socket);
    return -1;
  }

  /* asynchronous connect() */
  if (su_setblocking(s, 0) < 0) {
    STUN_ERROR(errno, su_setblocking);
    return -1;
  }
557

Martti Mela's avatar
Martti Mela committed
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
  if (setsockopt(s, SOL_TCP, TCP_NODELAY,
		 (void *)&one, sizeof one) == -1) {
    STUN_ERROR(errno, setsockopt);
    return -1;
  }

  /* 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) {
      STUN_ERROR(err, connect);
      return -1;
    }
  }

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

Martti Mela's avatar
Martti Mela committed
582
  events = SU_WAIT_CONNECT | SU_WAIT_ERR;
Martti Mela's avatar
Martti Mela committed
583 584 585
  if (su_wait_create(wait, s, events) == -1)
    STUN_ERROR(errno, su_wait_create);

Martti Mela's avatar
Martti Mela committed
586
  /* su_root_eventmask(sh->sh_root, sh->sh_root_index, s, events); */
587 588

  if ((sd->sd_index =
Martti Mela's avatar
Martti Mela committed
589
       su_root_register(sh->sh_root, wait, stun_tls_callback, (su_wakeup_arg_t *) sd, 0)) == -1) {
Martti Mela's avatar
Martti Mela committed
590 591 592 593
    STUN_ERROR(errno, su_root_register);
    return -1;
  }

594 595 596 597
  ta_start(ta, tag, value);
  sd->sd_tags = tl_adup(sh->sh_home, ta_args(ta));
  ta_end(ta);

598
  sd->sd_state = stun_tls_connecting;
Martti Mela's avatar
Martti Mela committed
599 600 601 602

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

603 604
  sd->sd_timer = su_timer_create(su_root_task(sh->sh_root),
				 STUN_TLS_CONNECT_TIMEOUT);
Martti Mela's avatar
Martti Mela committed
605

606
  su_timer_set(sd->sd_timer, stun_tls_connect_timer_cb, (su_wakeup_arg_t *) sd);
Martti Mela's avatar
Martti Mela committed
607 608

  return 0;
609 610 611
#else /* !HAVE_OPENSSL */
  return -1;
#endif
Martti Mela's avatar
Martti Mela committed
612 613
}

614
static stun_request_t *stun_request_create(stun_discovery_t *sd)
615
{
616
  stun_handle_t *sh = sd->sd_handle;
617 618
  stun_request_t *req = NULL;

Martti Mela's avatar
Martti Mela committed
619
  enter;
Martti Mela's avatar
Martti Mela committed
620

621
  req = calloc(sizeof(stun_request_t), 1);
622 623
  if (!req)
    return NULL;
624

625
  req->sr_handle = sh;
626
  req->sr_discovery = sd;
627 628

  /* This is the default */
629
  req->sr_socket = sd->sd_socket;
630 631 632 633 634 635 636
  
  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;
637
  /* req->sr_action = action; */
638 639 640
  req->sr_request_mask = 0;
  
  req->sr_msg = calloc(sizeof(stun_msg_t), 1);
641

642
  req->sr_state = stun_req_discovery_init;
643
  memcpy(req->sr_local_addr, sd->sd_bind_addr, sizeof(su_sockaddr_t));
644

645 646 647 648 649 650
  /* Insert this request to the request queue */
  if (sh->sh_requests)
    x_insert(sh->sh_requests, req, sr);
  else
    sh->sh_requests = req;

651 652 653
  return req;
}

654
void stun_request_destroy(stun_request_t *req)
655
{
656
  stun_handle_t *sh;
657 658
  assert(req);

Martti Mela's avatar
Martti Mela committed
659
  enter;
Martti Mela's avatar
Martti Mela committed
660

661 662
  sh = req->sr_handle;

663 664 665
  if (x_is_inserted(req, sr))
    x_remove(req, sr);

666 667 668
  if (!x_is_inserted(req, sr) && !req->sr_next)
    sh->sh_requests = NULL;

669
  req->sr_handle = NULL;
670
  req->sr_discovery = NULL;
Martti Mela's avatar
Martti Mela committed
671
  /* memset(req->sr_destination, 0, sizeof(su_sockaddr_t)); */
672

673 674 675 676 677 678 679 680 681 682
  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;
  }
683

684
  free(req);
685 686 687

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

688 689 690
  return;
}

691

Pekka Pessi's avatar
Pekka Pessi committed
692
/** Destroy a STUN client */ 
Martti Mela's avatar
Martti Mela committed
693
void stun_handle_destroy(stun_handle_t *sh)
Pekka Pessi's avatar
Pekka Pessi committed
694
{ 
Martti Mela's avatar
Martti Mela committed
695
  stun_discovery_t *sd = NULL, *kill = NULL;
696
  stun_request_t *a, *b;
Pekka Pessi's avatar
Pekka Pessi committed
697

Martti Mela's avatar
Martti Mela committed
698
  enter;
Martti Mela's avatar
Martti Mela committed
699

700 701
  if (sh->sh_dns_lookup)
    stun_dns_lookup_destroy(sh->sh_dns_lookup);
702

703 704 705
  if (sh->sh_dns_pend_tags)
    su_free(sh->sh_home, sh->sh_dns_pend_tags);

706 707 708 709 710 711 712
  for (a = sh->sh_requests; a; ) {
    b = a->sr_next;
    stun_request_destroy(a);
    a = b;
  }


Martti Mela's avatar
Martti Mela committed
713 714
  /* There can be several discoveries using the same socket. It is
     still enough to deregister the socket in first of them */
Martti Mela's avatar
Martti Mela committed
715 716 717
  for (sd = sh->sh_discoveries; sd; ) {
    kill = sd;
    sd = sd->sd_next;
Martti Mela's avatar
Martti Mela committed
718

719 720 721
    /* Index has same value as sockfd, right? ... or not? */
    if (kill->sd_index != -1)
      su_root_deregister(sh->sh_root, kill->sd_index);
Martti Mela's avatar
Martti Mela committed
722 723
    if (kill->sd_action == stun_action_tls_query)
      su_close(kill->sd_socket);
724 725

    stun_discovery_destroy(kill);
Martti Mela's avatar
Martti Mela committed
726
  }
Martti Mela's avatar
Martti Mela committed
727

Martti Mela's avatar
Martti Mela committed
728
  su_home_zap(sh->sh_home);
Martti Mela's avatar
Martti Mela committed
729 730
}

Pekka Pessi's avatar
Pekka Pessi committed
731

Pekka Pessi's avatar
Pekka Pessi committed
732
/** Create wait object and register it to the handle callback */
733
int assign_socket(stun_discovery_t *sd, su_socket_t s, int reg_socket) 
734
{
735
  stun_handle_t *sh = sd->sd_handle;
736
  int events;
Martti Mela's avatar
Martti Mela committed
737
  stun_discovery_t *tmp;
738 739 740 741 742 743
  /* su_localinfo_t clientinfo[1]; */
  su_sockaddr_t bind_addr;
  socklen_t bind_len;
  char ipaddr[SU_ADDRSIZE + 2] = { 0 };
  su_sockaddr_t *sa;
  int err;
744
  
745 746
  su_wait_t wait[1] = { SU_WAIT_INIT };

Martti Mela's avatar
Martti Mela committed
747 748
  enter;

749 750 751 752 753
  if (s == -1) {
    SU_DEBUG_3(("%s: invalid socket.\n", __func__));
    return errno = EINVAL, -1;
  }

Martti Mela's avatar
Martti Mela committed
754
  for (tmp = sh->sh_discoveries; tmp; tmp = tmp->sd_next) {
755 756 757 758 759 760
    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
761
  }
762
  sd->sd_socket = s;
Martti Mela's avatar
Martti Mela committed
763

764 765 766
  if (reg_socket != 1)
    return 0;

767 768 769 770 771 772 773 774
  /* set socket asynchronous */
  if (su_setblocking(s, 0) < 0) {
    STUN_ERROR(errno, su_setblocking);

    su_close(s);
    return -1;
  }

775
  /* xxx -- check if socket is already assigned to this root */
776 777 778 779 780 781 782 783
  events = SU_WAIT_IN | SU_WAIT_ERR;

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

  /* Register receiving function with events specified above */
784 785
  if ((sd->sd_index = su_root_register(sh->sh_root,
				       wait, stun_bind_callback,
Martti Mela's avatar
Martti Mela committed
786
				       (su_wakeup_arg_t *) sd, 0)) < 0) {
787 788 789 790
    STUN_ERROR(errno, su_root_register);
    return -1;
  }

Martti Mela's avatar
Martti Mela committed
791 792
  SU_DEBUG_7(("%s: socket registered.\n", __func__));

793
  sa = (void *) &bind_addr;
794 795
  bind_len = SU_SOCKADDR_SIZE(sa);
  memset(sa, 0, bind_len);
796 797 798 799 800 801 802 803 804 805 806 807 808
  /* if bound check the error */
  err = getsockname(s, (struct sockaddr *) sa, &bind_len);
  if (err < 0 && errno == SOCKET_ERROR) {
    STUN_ERROR(errno, getsockname);
    return -1;
  }

  /* Not bound - bind it */
  if (sa->su_port == 0) {
#if defined (__CYGWIN__)
    get_localinfo(clientinfo);
#endif

809 810
    sa->su_family = AF_INET;

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
    if ((err = bind(s, (struct sockaddr *) sa, bind_len)) < 0) {
      STUN_ERROR(errno, bind);
      SU_DEBUG_3(("%s: Error binding to %s:%u\n", __func__, 
		  inet_ntop(sa->su_family, SU_ADDR(sa), 
			    ipaddr, sizeof(ipaddr)),
		  (unsigned) ntohs(sa->su_port)));
      return -1;
    }

    /* bind_len = clientinfo->li_addrlen; */
    /* clientinfo->li_addrlen = bind_len; */
    sa->su_len = bind_len; /* ? */
  }

  memcpy(&sd->sd_bind_addr, &bind_addr, sizeof bind_addr);

  if (getsockname(s, (struct sockaddr *) &bind_addr, &bind_len) != 0) {
    STUN_ERROR(errno, getsockname);
    return -1;
  }

  SU_DEBUG_3(("%s: local socket is bound to %s:%u\n", __func__,
	      inet_ntop(bind_addr.su_family, SU_ADDR(&bind_addr), 
			ipaddr, sizeof(ipaddr)),
	      (unsigned) ntohs(bind_addr.su_port)));

  return 0;
838 839
}

840

841 842 843 844
/**
 * Helper function needed by Cygwin builds.
 */
#if defined (__CYGWIN__)
845 846 847
static int get_localinfo(su_localinfo_t *clientinfo)
{
  su_localinfo_t  hints[1] = {{ LI_CANONNAME | LI_NUMERIC }}, *li, *res = NULL;
848
  su_sockaddr_t *sa;
849 850 851
  int i, error, found = 0;
  char ipaddr[SU_ADDRSIZE + 2] = { 0 };

852

Martti Mela's avatar
Martti Mela committed
853
  hints->li_family = AF_INET;
854
  if ((error = su_getlocalinfo(hints, &res)) == 0) {
855 856 857 858 859 860 861
    
    /* try to bind to the first available address */
    for (i = 0, li = res; li; li = li->li_next) {
      if (li->li_family != AF_INET)
	continue;
      
      clientinfo->li_family = li->li_family;
Martti Mela's avatar
Martti Mela committed
862
      clientinfo->li_addrlen = li->li_addrlen;
863
      
864
      sa = clientinfo->li_addr;
Martti Mela's avatar
Martti Mela committed
865
      memcpy(sa, li->li_addr, sizeof(su_sockaddr_t));
866 867 868 869
      SU_DEBUG_3(("%s: local address found to be %s.\n",
		  __func__, 
		  inet_ntop(clientinfo->li_family, SU_ADDR(sa),
			    ipaddr, sizeof(ipaddr))));
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
      found = 1;
      break;
    }
    
    if (!found) {
      STUN_ERROR(error, su_getlocalinfo);
      return -1;
    }
  }
  else {
    STUN_ERROR(error, su_getlocalinfo);
    return -1;
  }
  if (res)
    su_freelocalinfo(res);

  return 0;
}
Pekka Pessi's avatar
Pekka Pessi committed
888
#endif
Martti Mela's avatar
Martti Mela committed
889

890 891 892 893 894 895 896 897
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;

898
  res = stun_dns_lookup_udp_addr(self, &udp_target, &udp_port);
899
  if (res == 0 && udp_target) {
900
    /* XXX: assumption that same host and port used for UDP/TLS */
901 902 903 904 905 906
    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);
907

908 909
    /* step: now that server address is known, continue 
     *       the pending action */
910

911 912
    SU_DEBUG_5(("STUN server address found, running queue actions (%d).\n",
		sh->sh_dns_pend_action));
913

914 915 916 917
    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;
918

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
    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"));
    }
934
      }
935 936 937 938 939 940
  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);
941 942
    }
  }
943 944 945 946 947

  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;
948 949 950
}

/**
951 952
 * Queus a discovery process for later execution when DNS-SRV lookup
 * has been completed.
953
 */
954 955 956 957 958
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, ...)
959
{
960
  ta_list ta;
961

962 963 964
  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);
965
      ta_start(ta, tag, value);
966
      assert(sh->sh_dns_pend_tags == NULL);
967 968 969 970 971
      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;
972 973

    }
974
    sh->sh_dns_pend_action |= action;
975 976

    return 0;
977
  }
978 979
  
  return -1;
980 981 982 983 984 985 986 987 988
}

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);
  }
989
  return res;
990 991
}

992 993 994 995 996
/** 
 * 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
997
 *
998 999 1000 1001
 * 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
1002
 * 
1003 1004 1005
 * @param sh       pointer to valid stun handle
 * @param sdf      callback to signal process progress
 * @param magic    context pointer attached to 'sdf'
Pekka Pessi's avatar
Pekka Pessi committed
1006
 *
1007
 * @TAGS
1008 1009
 * @TAG STUNTAG_SOCKET Bind socket for STUN (socket handle).
 * @TAG STUNTAG_REGISTER_SOCKET Register socket for eventloop owned by STUN (boolean)
1010

Pekka Pessi's avatar
Pekka Pessi committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
 * @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.
 */
1026 1027 1028 1029 1030
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
1031
{
1032
  su_socket_t s = -1;
1033
  stun_request_t *req = NULL;
1034
  stun_discovery_t *sd = NULL;
1035
  ta_list ta;
1036
  int index, s_reg = 0;
1037
  
Martti Mela's avatar