stun.c 83.2 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
#if 0 /* XXX: not used at the moment (2006/03) */
static int stun_change_map[4][4] = {
Martti Mela's avatar
Martti Mela committed
86 87 88 89 90
  {0, 1, 2, 3}, /* no change */
  {2, 3, 0, 1}, /* change ip */
  {1, 0, 3, 2}, /* change port */
  {3, 2, 1, 0}  /* change ip and port, Ca:Cp */
};
91
#endif
Martti Mela's avatar
Martti Mela committed
92 93


94 95 96 97 98 99 100 101 102 103 104 105
/* NAT TYPES */
typedef enum stun_nattype_e {
  stun_nat_unknown,
  stun_open_internet,
  stun_udp_blocked,
  stun_sym_udp_fw,
  stun_nat_full_cone,
  stun_nat_sym,
  stun_nat_res_cone,
  stun_nat_port_res_cone,
} stun_nattype_t;

106 107 108
#define CHG_IP		0x001
#define CHG_PORT	0x004

109 110 111 112 113 114 115 116 117 118
#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)

119
struct stun_discovery_s {
120
  stun_discovery_t   *sd_next, **sd_prev; /**< Linked list */
121

122 123 124
  stun_handle_t          *sd_handle;
  stun_discovery_f        sd_callback;
  stun_discovery_magic_t *sd_magic;
125

126 127 128
  tagi_t          *sd_tags;          /** stored tags for the discovery */


129 130 131 132 133 134 135 136 137 138
  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 */
139 140
  su_sockaddr_t    sd_bind_addr[1]; /**< local address */

141
  su_socket_t      sd_socket2;       /**< Alternative socket */
142

143
  int              sd_index;         /**< root_register index */
144

Martti Mela's avatar
Martti Mela committed
145
  /* Binding discovery */
146
  su_sockaddr_t    sd_addr_seen_outside[1];   /**< local address */
Martti Mela's avatar
Martti Mela committed
147

148
  /* NAT type related */
149
  stun_nattype_t   sd_nattype;       /**< Determined NAT type */
150 151 152 153 154
  unsigned         sd_first:1;       /**< These are the requests  */
  unsigned         sd_second:1;
  unsigned         sd_third:1;
  unsigned         sd_fourth:1;
  unsigned         :0;
155 156 157 158 159

  /* Life time related */
  int              sd_lt_cur;
  int              sd_lt;
  int              sd_lt_max;
Martti Mela's avatar
Martti Mela committed
160 161 162 163

  /* Keepalive timeout */
  unsigned int     sd_timeout;
  su_timer_t      *sd_timer;
164 165
};

166
struct stun_request_s {
167
  su_timer_t       *sr_timer;
168 169 170 171
  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 */

172 173 174
  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
175
  su_sockaddr_t     sr_destination[1];
176

177
  stun_state_t      sr_state;           /**< Progress states */
178 179
  int               sr_retry_count;     /**< current retry number */
  long              sr_timeout;         /**< timeout for next sendto() */
180 181

  int               sr_from_y;
182 183 184
  int               sr_request_mask;    /**< Mask consisting of chg_ip and chg_port */
  stun_discovery_t *sr_discovery;
};
185

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

192
  stun_request_t *sh_requests; /**< outgoing requests list */
193
  stun_discovery_t *sh_discoveries; /**< Actions list */
194

195
  int             sh_max_retries;   /**< max resend for sendto() */
196

197 198
  su_addrinfo_t   sh_pri_info;      /**< server primary info */
  su_sockaddr_t   sh_pri_addr[1];   /**< server primary address */
199

200 201
  su_addrinfo_t   sh_sec_info;      /**< server secondary info */
  su_sockaddr_t   sh_sec_addr[1];   /**< server secondary address */
202

203 204
  su_localinfo_t  sh_localinfo;     /**< local addrinfo */
  su_sockaddr_t   sh_local_addr[1]; /**< local address */
205

206 207
  char           *sh_domain;        /**< domain address for DNS-SRV lookups */

208 209
  stun_dns_lookup_t  *sh_dns_lookup;
  stun_action_t       sh_dns_pend_action; 
210 211 212
  stun_discovery_f    sh_dns_pend_cb;
  stun_discovery_magic_t *sh_dns_pend_ctx;
  tagi_t             *sh_dns_pend_tags;
213

Martti Mela's avatar
Martti Mela committed
214
#if defined(HAVE_OPENSSL)
215 216
  SSL_CTX        *sh_ctx;           /**< SSL context for TLS */
  SSL            *sh_ssl;           /**< SSL handle for TLS */
Martti Mela's avatar
Martti Mela committed
217 218 219 220 221
#else
  void           *sh_ctx;           /**< SSL context for TLS */
  void           *sh_ssl;           /**< SSL handle for TLS */
#endif

222 223
  stun_msg_t      sh_tls_request;
  stun_msg_t      sh_tls_response;
224
  int             sh_nattype;       /**< NAT-type, see stun_common.h */
Martti Mela's avatar
Martti Mela committed
225

226
#if 0
227 228
  stun_event_f    sh_callback;      /**< callback for calling application */ 
  stun_magic_t   *sh_context;       /**< application context */
229
#endif
230

231 232
  stun_buffer_t   sh_username;
  stun_buffer_t   sh_passwd;
233

234 235
  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
236 237
};

Martti Mela's avatar
Martti Mela committed
238

239 240
#define STUN_STATE_STR(x) case x: return #x

241
char const *stun_str_state(stun_state_t state)
242 243 244
{
  switch (state) {
  STUN_STATE_STR(stun_no_assigned_event);
245
  STUN_STATE_STR(stun_dispose_me);
246 247 248 249 250
  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);
251 252 253
  STUN_STATE_STR(stun_discovery_init);
  STUN_STATE_STR(stun_discovery_processing);
  STUN_STATE_STR(stun_discovery_done);
254
#if 0
255 256 257
  STUN_STATE_STR(stun_bind_init);
  STUN_STATE_STR(stun_bind_processing);
  STUN_STATE_STR(stun_bind_done);
258 259 260 261
  STUN_STATE_STR(stun_bind_error);
  STUN_STATE_STR(stun_bind_timeout);
  STUN_STATE_STR(stun_request_not_found);
#endif
262 263 264
  STUN_STATE_STR(stun_tls_connection_timeout);
  STUN_STATE_STR(stun_tls_connection_failed);
  STUN_STATE_STR(stun_tls_ssl_connect_failed);
265
  STUN_STATE_STR(stun_discovery_timeout);
266
  STUN_STATE_STR(stun_request_timeout);
267 268 269 270 271 272
  
  case stun_error:
  default: return "stun_error";
  }
}

273 274 275
/** 
 * Returns the NAT type attached to STUN discovery handle.
 */
276
char const *stun_nattype(stun_discovery_t *sd)
277
{
Martti Mela's avatar
Martti Mela committed
278 279 280 281 282 283 284 285 286 287 288
  char const *stun_nattype_str[] = {
    "NAT type undetermined",
    "Open Internet",
    "UDP traffic is blocked or server unreachable",
    "Symmetric UDP Firewall",
    "Full-Cone NAT",
    "Symmetric NAT",
    "Restricted Cone NAT",
    "Port Restricted Cone NAT",
  };

Pekka Pessi's avatar
Pekka Pessi committed
289 290 291 292
  if (sd)
    return stun_nattype_str[sd->sd_nattype];
  else
    return stun_nattype_str[stun_nat_unknown];
293 294
}

295 296 297 298
su_addrinfo_t const *stun_server_address(stun_handle_t *sh)
{
  return &sh->sh_pri_info;
}
299

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


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

314 315 316 317 318 319 320 321 322 323
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);
324
static int process_test_lifetime(stun_request_t *req, stun_msg_t *binding_response);
325 326 327

static stun_request_t *stun_request_create(stun_discovery_t *sd);
static int stun_send_binding_request(stun_request_t *req,
328
			      su_sockaddr_t *srvr_addr);
329
static int stun_bind_callback(stun_magic_t *m, su_wait_t *w, su_wakeup_arg_t *arg);
330 331

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

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


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

Martti Mela's avatar
Martti Mela committed
384
  enter;
Martti Mela's avatar
Martti Mela committed
385

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

  return stun_server != NULL;
}

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 466 467 468

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

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


500
#if 0
501
/** 
502
 * Creates a STUN handle.
503
 *
504 505 506 507 508 509
 * The created handles can be used for STUN binding discovery, 
 * keepalives, and other STUN usages.
 *
 * @param context self pointer for callback 'cb'
 * @param root eventloop to used by the stun state machine
 * @param cb callback to signal state machine events
510 511
 * @param tag,value,... tag-value list 
 *
Pekka Pessi's avatar
Pekka Pessi committed
512
 * @TAGS
513
 * @TAG STUNTAG_DOMAIN() domain to use in DNS-SRV based STUN server
514
 * @TAG STUNTAG_SERVER() stun server hostname or dotted IPv4 address
515 516
 * @TAG STUNTAG_REQUIRE_INTEGRITY() true if msg integrity should be
 * used enforced
517 518
 *
 */
Pekka Pessi's avatar
Pekka Pessi committed
519 520 521 522
stun_handle_t *stun_handle_create(stun_magic_t *context,
				  su_root_t *root,
				  stun_event_f cb,
				  tag_type_t tag, tag_value_t value, ...)
Pekka Pessi's avatar
Pekka Pessi committed
523
{
Martti Mela's avatar
Martti Mela committed
524
  stun_handle_t *stun = NULL;
525
  char const *server = NULL, *domain = NULL;
526
  int req_msg_integrity = 1;
527
  int err;
528
  ta_list ta;
529
  
Martti Mela's avatar
Martti Mela committed
530
  enter;
Martti Mela's avatar
Martti Mela committed
531

532 533 534 535
  ta_start(ta, tag, value);

  tl_gets(ta_args(ta),
	  STUNTAG_SERVER_REF(server),
536
	  STUNTAG_DOMAIN_REF(domain),
537
	  STUNTAG_REQUIRE_INTEGRITY_REF(req_msg_integrity),
538 539
	  TAG_END());

540 541 542 543 544 545 546
  stun = su_home_clone(NULL, sizeof(*stun));

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

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

553
  SU_DEBUG_5(("%s(\"%s\"): called\n", 
Martti Mela's avatar
Martti Mela committed
554
	      "stun_handle_tcreate", server));
555

556 557
  /* fail, if no server or a domain for a DNS-SRV lookup is specified */
  if (!server && !domain)
558
    return NULL;
559
  
560 561
  stun->sh_pri_info.ai_addrlen = 16;
  stun->sh_pri_info.ai_addr = &stun->sh_pri_addr->su_sa;
Pekka Pessi's avatar
Pekka Pessi committed
562

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

566 567
  stun->sh_localinfo.li_addrlen = 16;
  stun->sh_localinfo.li_addr = stun->sh_local_addr;
568

569 570 571 572
  stun->sh_domain = su_strdup(stun->sh_home, domain);
  stun->sh_dns_lookup = NULL;
  
  if (server) {
573
    err = stun_atoaddr(stun->sh_home, AF_INET, &stun->sh_pri_info, server);
574

575 576 577
    if (err < 0)
      return NULL;
  }
578

579
  stun->sh_nattype = stun_nat_unknown;
580

581 582 583
  stun->sh_root     = root;
  stun->sh_context  = context;
  stun->sh_callback = cb;
584
  /* always try TLS: */
Kai Vehmanen's avatar
Kai Vehmanen committed
585
  stun->sh_use_msgint = 1;
586 587
  /* whether use of shared-secret msgint is required */
  stun->sh_req_msgint = req_msg_integrity;
Pekka Pessi's avatar
Pekka Pessi committed
588

589
  stun->sh_max_retries = STUN_MAX_RETRX;
Martti Mela's avatar
Martti Mela committed
590

591
  /* initialize username and password */
592 593
  stun_init_buffer(&stun->sh_username);
  stun_init_buffer(&stun->sh_passwd);
594
  
595
  stun->sh_nattype = stun_nat_unknown;
596 597 598 599
  
  /* initialize random number generator */
  srand(time(NULL));
  
600 601
  ta_end(ta);

Pekka Pessi's avatar
Pekka Pessi committed
602 603
  return stun;
}
604
#endif
Pekka Pessi's avatar
Pekka Pessi committed
605

606

607 608 609 610 611
/** 
 * Performs shared secret request/response processing.
 * Result will be trigged in STUN handle callback (state
 * one of stun_tls_*).
 **/
612 613 614 615
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
616
{
617
#if defined(HAVE_OPENSSL)
Martti Mela's avatar
Martti Mela committed
618 619 620 621 622 623
  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;
624
  stun_discovery_t *sd;
Martti Mela's avatar
Martti Mela committed
625
  /* stun_request_t *req; */
Martti Mela's avatar
Martti Mela committed
626

627 628
  ta_list ta;

Martti Mela's avatar
Martti Mela committed
629
  assert(sh);
Martti Mela's avatar
Martti Mela committed
630

Martti Mela's avatar
Martti Mela committed
631
  enter;
Martti Mela's avatar
Martti Mela committed
632

633 634
  if (!sh->sh_pri_addr[0].su_port) {
    /* no STUN server address, perform a DNS-SRV lookup */
635 636 637
   
    ta_list ta;
    ta_start(ta, tag, value);
638
    SU_DEBUG_5(("Delaying STUN shared-secret req. for DNS-SRV query.\n"));
639 640 641 642
    err = priv_dns_queue_action(sh, stun_action_tls_query, sdf, magic, ta_tags(ta));
    ta_end(ta);
       
    return err;
643 644
  }

Martti Mela's avatar
Martti Mela committed
645 646 647
  ai = &sh->sh_pri_info;

  if (sh->sh_use_msgint == 1) {
Martti Mela's avatar
Martti Mela committed
648
    SU_DEBUG_3(("%s: Obtaining shared secret.\n", __func__));
Martti Mela's avatar
Martti Mela committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
  }
  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;
  }
668

Martti Mela's avatar
Martti Mela committed
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
  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)));
  
689
  sd = stun_discovery_create(sh, stun_action_tls_query, sdf, magic);
Martti Mela's avatar
Martti Mela committed
690
  sd->sd_socket = s;
Martti Mela's avatar
Martti Mela committed
691
  /* req = stun_request_create(sd); */
Martti Mela's avatar
Martti Mela committed
692

Martti Mela's avatar
Martti Mela committed
693
  events = SU_WAIT_CONNECT | SU_WAIT_ERR;
Martti Mela's avatar
Martti Mela committed
694 695 696
  if (su_wait_create(wait, s, events) == -1)
    STUN_ERROR(errno, su_wait_create);

Martti Mela's avatar
Martti Mela committed
697
  /* su_root_eventmask(sh->sh_root, sh->sh_root_index, s, events); */
698 699

  if ((sd->sd_index =
Martti Mela's avatar
Martti Mela committed
700
       su_root_register(sh->sh_root, wait, stun_tls_callback, (su_wakeup_arg_t *) sd, 0)) == -1) {
Martti Mela's avatar
Martti Mela committed
701 702 703 704
    STUN_ERROR(errno, su_root_register);
    return -1;
  }

705 706 707 708
  ta_start(ta, tag, value);
  sd->sd_tags = tl_adup(sh->sh_home, ta_args(ta));
  ta_end(ta);

709
  sd->sd_state = stun_tls_connecting;
Martti Mela's avatar
Martti Mela committed
710 711 712 713

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

714 715
  sd->sd_timer = su_timer_create(su_root_task(sh->sh_root),
				 STUN_TLS_CONNECT_TIMEOUT);
Martti Mela's avatar
Martti Mela committed
716

717
  su_timer_set(sd->sd_timer, stun_tls_connect_timer_cb, (su_wakeup_arg_t *) sd);
Martti Mela's avatar
Martti Mela committed
718 719

  return 0;
720 721 722
#else /* !HAVE_OPENSSL */
  return -1;
#endif
Martti Mela's avatar
Martti Mela committed
723 724
}

725
static stun_request_t *stun_request_create(stun_discovery_t *sd)
726
{
727
  stun_handle_t *sh = sd->sd_handle;
728 729
  stun_request_t *req = NULL;

Martti Mela's avatar
Martti Mela committed
730
  enter;
Martti Mela's avatar
Martti Mela committed
731

732
  req = calloc(sizeof(stun_request_t), 1);
733 734
  if (!req)
    return NULL;
735

736
  req->sr_handle = sh;
737
  req->sr_discovery = sd;
738 739

  /* This is the default */
740
  req->sr_socket = sd->sd_socket;
741 742 743 744 745 746 747
  
  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;
748
  /* req->sr_action = action; */
749 750 751
  req->sr_request_mask = 0;
  
  req->sr_msg = calloc(sizeof(stun_msg_t), 1);
752

753
  req->sr_state = stun_discovery_init;
754
  memcpy(req->sr_local_addr, sd->sd_bind_addr, sizeof(su_sockaddr_t));
755

756 757 758 759 760 761
  /* Insert this request to the request queue */
  if (sh->sh_requests)
    x_insert(sh->sh_requests, req, sr);
  else
    sh->sh_requests = req;

762 763 764
  return req;
}

765
void stun_request_destroy(stun_request_t *req)
766
{
767
  stun_handle_t *sh;
768 769
  assert(req);

Martti Mela's avatar
Martti Mela committed
770
  enter;
Martti Mela's avatar
Martti Mela committed
771

772 773
  sh = req->sr_handle;

774 775 776
  if (x_is_inserted(req, sr))
    x_remove(req, sr);

777 778 779
  if (!x_is_inserted(req, sr) && !req->sr_next)
    sh->sh_requests = NULL;

780
  req->sr_handle = NULL;
781
  req->sr_discovery = NULL;
Martti Mela's avatar
Martti Mela committed
782
  /* memset(req->sr_destination, 0, sizeof(su_sockaddr_t)); */
783

784 785 786 787 788 789 790 791 792 793
  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;
  }
794

795
  free(req);
796 797 798

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

799 800 801
  return;
}

802

Pekka Pessi's avatar
Pekka Pessi committed
803
/** Destroy a STUN client */ 
Martti Mela's avatar
Martti Mela committed
804
void stun_handle_destroy(stun_handle_t *sh)
Pekka Pessi's avatar
Pekka Pessi committed
805
{ 
Martti Mela's avatar
Martti Mela committed
806
  stun_discovery_t *sd = NULL, *kill = NULL;
807
  stun_request_t *a, *b;
Pekka Pessi's avatar
Pekka Pessi committed
808

Martti Mela's avatar
Martti Mela committed
809
  enter;
Martti Mela's avatar
Martti Mela committed
810

811 812
  if (sh->sh_dns_lookup)
    stun_dns_lookup_destroy(sh->sh_dns_lookup);
813

814 815 816
  if (sh->sh_dns_pend_tags)
    su_free(sh->sh_home, sh->sh_dns_pend_tags);

817 818 819 820 821 822 823
  for (a = sh->sh_requests; a; ) {
    b = a->sr_next;
    stun_request_destroy(a);
    a = b;
  }


Martti Mela's avatar
Martti Mela committed
824 825
  /* 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
826 827 828
  for (sd = sh->sh_discoveries; sd; ) {
    kill = sd;
    sd = sd->sd_next;
Martti Mela's avatar
Martti Mela committed
829

830 831 832
    /* 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
833 834
    if (kill->sd_action == stun_action_tls_query)
      su_close(kill->sd_socket);
835 836

    stun_discovery_destroy(kill);
Martti Mela's avatar
Martti Mela committed
837
  }
Martti Mela's avatar
Martti Mela committed
838

Martti Mela's avatar
Martti Mela committed
839
  su_home_zap(sh->sh_home);
Martti Mela's avatar
Martti Mela committed
840 841
}

Pekka Pessi's avatar
Pekka Pessi committed
842

Pekka Pessi's avatar
Pekka Pessi committed
843
/** Create wait object and register it to the handle callback */
844
int assign_socket(stun_discovery_t *sd, su_socket_t s, int reg_socket) 
845
{
846
  stun_handle_t *sh = sd->sd_handle;
847
  int events;
Martti Mela's avatar
Martti Mela committed
848
  stun_discovery_t *tmp;
849 850 851 852 853 854
  /* 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;
855
  
856 857
  su_wait_t wait[1] = { SU_WAIT_INIT };

Martti Mela's avatar
Martti Mela committed
858 859
  enter;

860 861 862 863 864
  if (s == -1) {
    SU_DEBUG_3(("%s: invalid socket.\n", __func__));
    return errno = EINVAL, -1;
  }

Martti Mela's avatar
Martti Mela committed
865
  for (tmp = sh->sh_discoveries; tmp; tmp = tmp->sd_next) {
866 867 868 869 870 871
    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
872
  }
873
  sd->sd_socket = s;
Martti Mela's avatar
Martti Mela committed
874

875 876 877
  if (reg_socket != 1)
    return 0;

878 879 880 881 882 883 884 885
  /* set socket asynchronous */
  if (su_setblocking(s, 0) < 0) {
    STUN_ERROR(errno, su_setblocking);

    su_close(s);
    return -1;
  }

886
  /* xxx -- check if socket is already assigned to this root */
887 888 889 890 891 892 893 894
  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 */
895 896
  if ((sd->sd_index = su_root_register(sh->sh_root,
				       wait, stun_bind_callback,
Martti Mela's avatar
Martti Mela committed
897
				       (su_wakeup_arg_t *) sd, 0)) < 0) {
898 899 900 901
    STUN_ERROR(errno, su_root_register);
    return -1;
  }

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

904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
  bind_len = sizeof bind_addr;

  sa = (void *) &bind_addr;
  bind_len = sizeof bind_addr;
  memset(sa, 0, sizeof(bind_addr));
  /* 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

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

952

953 954 955 956
/**
 * Helper function needed by Cygwin builds.
 */
#if defined (__CYGWIN__)
957 958 959
static int get_localinfo(su_localinfo_t *clientinfo)
{
  su_localinfo_t  hints[1] = {{ LI_CANONNAME | LI_NUMERIC }}, *li, *res = NULL;
960
  su_sockaddr_t *sa;
961 962 963
  int i, error, found = 0;
  char ipaddr[SU_ADDRSIZE + 2] = { 0 };

964

Martti Mela's avatar
Martti Mela committed
965
  hints->li_family = AF_INET;
966
  if ((error = su_getlocalinfo(hints, &res)) == 0) {
967 968 969 970 971 972 973
    
    /* 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
974
      clientinfo->li_addrlen = li->li_addrlen;
975
      
976
      sa = clientinfo->li_addr;
Martti Mela's avatar
Martti Mela committed
977
      memcpy(sa, li->li_addr, sizeof(su_sockaddr_t));
978 979 980 981
      SU_DEBUG_3(("%s: local address found to be %s.\n",
		  __func__, 
		  inet_ntop(clientinfo->li_family, SU_ADDR(sa),
			    ipaddr, sizeof(ipaddr))));
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
      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
1000
#endif
Martti Mela's avatar
Martti Mela committed
1001

1002 1003 1004 1005 1006 1007 1008 1009
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;

1010
  res = stun_dns_lookup_udp_addr(self, &udp_target, &udp_port);