stun.h 9.74 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
 *
 */

Pekka Pessi's avatar
Pekka Pessi committed
25 26
#ifndef STUN_H
/** Defined when <sofia-sip/stun.h> has been included. */
Pekka Pessi's avatar
Pekka Pessi committed
27
#define STUN_H
28

Pekka Pessi's avatar
Pekka Pessi committed
29
/**@file sofia-sip/stun.h STUN module public interface
Pekka Pessi's avatar
Pekka Pessi committed
30
 *
31
 * @author Martti Mela <Martti.Mela@nokia.com>
32
 * @author Tat Chan <Tat.Chan@nokia.com>
Pekka Pessi's avatar
Pekka Pessi committed
33
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
34
 * @author Kai Vehmanen <kai.vehmanen@nokia.com>
Pekka Pessi's avatar
Pekka Pessi committed
35 36
 */

37 38
#include <sofia-sip/stun_common.h>

39
#ifndef SU_WAIT_H
40
#include <sofia-sip/su_wait.h>
41
#endif
42

43
#ifndef SU_TAG_H
44
#include <sofia-sip/su_tag.h>
45
#endif
Pekka Pessi's avatar
Pekka Pessi committed
46

47
#include <sofia-sip/su_localinfo.h>
48

49

50 51
SOFIA_BEGIN_DECLS

52 53 54 55
typedef struct stun_handle_s     stun_handle_t;
typedef struct stun_request_s    stun_request_t;
typedef struct stun_discovery_s  stun_discovery_t;
typedef struct stun_dns_lookup_s stun_dns_lookup_t;
Pekka Pessi's avatar
Pekka Pessi committed
56

Pekka Pessi's avatar
Pekka Pessi committed
57 58
typedef struct stun_mini_s     stun_mini_t;

59
#ifndef STUN_MAGIC_T
60 61 62 63 64
#define STUN_MAGIC_T            struct stun_magic_t
#endif
/** STUN server context */
typedef STUN_MAGIC_T stun_magic_t;

65
#ifndef STUN_DISCOVERY_MAGIC_T
66 67 68 69 70
#define STUN_DISCOVERY_MAGIC_T            struct stun_discovery_magic_t
#endif
/** STUN discovery_ context */
typedef STUN_DISCOVERY_MAGIC_T stun_discovery_magic_t;

71 72
/** Name and version of STUN software */
SOFIAPUBVAR char const stun_version[];
Pekka Pessi's avatar
Pekka Pessi committed
73

74 75
/**
 * STUN Action types. These define the current discovery process.
76
 * Defined as a bitmap.
77 78
 */
typedef enum stun_action_s {
79 80 81 82
  stun_action_no_action = 1,
  stun_action_tls_query = 2,
  stun_action_binding_request = 4,
  stun_action_keepalive = 8,
83 84
  stun_action_test_nattype = 16,
  stun_action_test_lifetime = 32,
85 86
} stun_action_t;

87 88 89 90 91 92
/**
 * NAT types
 *
 * XXX: should be extended to distinguish between filtering and
 *      mapping allocation behaviour (see IETF BEHAVE documents)
 *
93 94
 * Note: the NAT type detection algorithm can fail in
 *       case where the NAT behaves in a nondeterministic
95 96 97
 *       fashion.
 **/
typedef enum stun_nattype_e {
98 99
  stun_nat_unknown = 0,

100
  /* no NAT between client and STUN server */
101
  stun_open_internet,
102 103

  /* UDP communication blocked by FW */
104
  stun_udp_blocked,
105 106 107

  /* No NAT, but a FW element is performing address and port
   * restricted filtering. */
108
  stun_sym_udp_fw,
109

110
  /* Endpoint independent filtering (endpoint independent mapping)
111
   * RFC3489 full cone NAT. */
112
  stun_nat_full_cone,
113 114 115

  /* Address restricted filtering (endpoint independent mapping),
   * RFC3489 restricted cone NAT. */
116
  stun_nat_res_cone,
117

118
  /* Address and port restricted filtering (endpoint
119
   * independent mapping), RFC3489 port restricted cone */
120
  stun_nat_port_res_cone,
121 122

  /* Endpoint independent filtering, endpoint dependent mapping. */
123
  stun_nat_ei_filt_ad_map,
124 125

  /* Address dependent filtering, endpoint dependent mapping. */
126
  stun_nat_ad_filt_ad_map,
127

128
  /* Address and port dependent filtering, endpoint dependent mapping
129
   * RFC3489 symmetric NAT). */
130
  stun_nat_adp_filt_ad_map,
131

132 133
} stun_nattype_t;

134 135
/**
 * States of the STUN client->server query process.
136 137 138 139 140
 *
 * @see stun_bind()
 * @see stun_obtain_shared_secret()
 * @see stun_test_nattype()
 * @see stun_test_lifetime()
141
 */
142
typedef enum stun_state_e {
143

144
  stun_no_assigned_event,
145

146 147 148 149 150 151 152
  /* TLS events; see stun_obtain_shared_request() */
  stun_tls_connecting,          /**< Connecting to TLS port */
  stun_tls_ssl_connecting,      /**< Started the TLS/SSL handshake */
  stun_tls_writing,             /**< Next step: send request */
  stun_tls_closing,             /**< Closing TLS connection */
  stun_tls_reading,             /**< Request send, waiting for response */
  stun_tls_done,                /**< Shared-secret acquired */
153

154
  /* STUN discovery events */
155
  stun_discovery_done,          /**< Discovery process done */
156

157
  /* STUN errors */
158
  /* Do not change the order! Errors need to be after stun_error */
159

160 161 162 163
  stun_error,                   /**< Generic error in discovery process */
  stun_tls_connection_timeout,  /**< No response to connect attempt */
  stun_tls_connection_failed,   /**< No response from TLS/SSL server  */
  stun_tls_ssl_connect_failed,  /**< TLS/SSL handshake failed */
164

165 166
  stun_discovery_error,         /**< Error in discovery process */
  stun_discovery_timeout,       /**< No response to discovery request */
167 168

} stun_state_t;
169

170 171 172
/* -------------------------------------------------------------------
 * Calback function prototypes (signals emitted by the stack) */

173 174 175 176 177 178 179
/* Per discovery */
typedef void (*stun_discovery_f)(stun_discovery_magic_t *magic,
				 stun_handle_t *sh,
				 stun_discovery_t *sd,
				 stun_action_t action,
				 stun_state_t event);

180 181
/** Callback invoked by stun handle when it has a message to send. */
typedef int (*stun_send_callback)(stun_magic_t *magic,
182
				  stun_handle_t *sh,
183 184 185 186 187
				  int socket,
				  void *data,
				  unsigned len,
				  int only_a_keepalive);

188 189 190 191
/** Callback for delivering DNS lookup results */
typedef void (*stun_dns_lookup_f)(stun_dns_lookup_t *self,
				  stun_magic_t *magic);

192 193
/* -------------------------------------------------------------------
 * Functions for managing STUN handles. */
Pekka Pessi's avatar
Pekka Pessi committed
194

195 196
SOFIAPUBFUN stun_handle_t *stun_handle_init(su_root_t *root,
					    tag_type_t, tag_value_t, ...);
197

198
SOFIAPUBFUN void stun_handle_destroy(stun_handle_t *sh);
199

200 201 202 203
SOFIAPUBFUN su_root_t *stun_root(stun_handle_t *sh);
SOFIAPUBFUN int stun_is_requested(tag_type_t tag, tag_value_t value, ...);
SOFIAPUBFUN char const *stun_str_state(stun_state_t state);
SOFIAPUBFUN su_addrinfo_t const *stun_server_address(stun_handle_t *sh);
204

205
SOFIAPUBFUN
206 207
int stun_process_message(stun_handle_t *sh, su_socket_t s,
			 su_sockaddr_t *sa, socklen_t salen,
208
			 void *data, isize_t len);
209
SOFIAPUBFUN
210 211
int stun_process_request(su_socket_t s, stun_msg_t *req,
			 int sid, su_sockaddr_t *from_addr,
212
			 socklen_t from_len);
213

214
/* -------------------------------------------------------------------
215 216
 * Functions for 'Binding Discovery' usage (RFC3489/3489bis) */

217
SOFIAPUBFUN
218 219 220 221
int stun_obtain_shared_secret(stun_handle_t *sh, stun_discovery_f,
			      stun_discovery_magic_t *magic,
			      tag_type_t tag, tag_value_t value, ...);

222 223
SOFIAPUBFUN
int stun_bind(stun_handle_t *sh,
224 225
	      stun_discovery_f, stun_discovery_magic_t *magic,
	      tag_type_t tag, tag_value_t value, ...);
Kai Vehmanen's avatar
Kai Vehmanen committed
226

227
SOFIAPUBFUN
228 229 230
int stun_discovery_get_address(stun_discovery_t *sd,
			       void *addr,
			       socklen_t *return_addrlen);
231 232
SOFIAPUBFUN su_socket_t stun_discovery_get_socket(stun_discovery_t *sd);
SOFIAPUBFUN int stun_discovery_release_socket(stun_discovery_t *sd);
233

234
SOFIAPUBFUN
235 236 237
int stun_test_nattype(stun_handle_t *sh,
		       stun_discovery_f, stun_discovery_magic_t *magic,
		       tag_type_t tag, tag_value_t value, ...);
238 239
SOFIAPUBFUN char const *stun_nattype_str(stun_discovery_t *sd);
SOFIAPUBFUN stun_nattype_t stun_nattype(stun_discovery_t *sd);
240

241
SOFIAPUBFUN
242
int stun_test_lifetime(stun_handle_t *sh,
243 244
		       stun_discovery_f, stun_discovery_magic_t *magic,
		       tag_type_t tag, tag_value_t value, ...);
245
SOFIAPUBFUN int stun_lifetime(stun_discovery_t *sd);
246

247
/* -------------------------------------------------------------------
248
 * Functions for 'Connectivity Check' and 'NAT Keepalives' usages (RFC3489bis) */
249

250
SOFIAPUBFUN
251 252
int stun_set_uname_pwd(stun_handle_t *sh,
		       const char *uname,
253
		       isize_t len_uname,
254
		       const char *pwd,
255
		       isize_t len_pwd);
Pekka Pessi's avatar
Pekka Pessi committed
256

257
SOFIAPUBFUN int stun_msg_is_keepalive(uint16_t data);
258
SOFIAPUBFUN int stun_message_length(void *data, isize_t len, int end_of_message);
259 260 261

/* Create a keepalive dispatcher for bound SIP sockets */

262
SOFIAPUBFUN
263
int stun_keepalive(stun_handle_t *sh,
264
		   su_sockaddr_t *sa,
265 266
		   tag_type_t tag, tag_value_t value,
		   ...);
267
SOFIAPUBFUN int stun_keepalive_destroy(stun_handle_t *sh, su_socket_t s);
268

269 270 271
/* -------------------------------------------------------------------
 * Functions for 'Short-Term password' usage (RFC3489bis) */

Kai Vehmanen's avatar
Kai Vehmanen committed
272
/* (not implemented, see stun_request_shared_secret()) */
273

274 275 276
/* -------------------------------------------------------------------
 * Functions for STUN server discovery using DNS (RFC3489/3489bis) */

277 278
SOFIAPUBFUN
stun_dns_lookup_t *stun_dns_lookup(stun_magic_t *magic,
279
				   su_root_t *root,
280
				   stun_dns_lookup_f func,
281
				   const char *domain);
282
SOFIAPUBFUN void stun_dns_lookup_destroy(stun_dns_lookup_t *self);
283

284 285 286 287 288 289
SOFIAPUBFUN int stun_dns_lookup_udp_addr(stun_dns_lookup_t *,
					 const char **target, uint16_t *port);
SOFIAPUBFUN int stun_dns_lookup_tcp_addr(stun_dns_lookup_t *self,
					 const char **target, uint16_t *port);
SOFIAPUBFUN int stun_dns_lookup_stp_addr(stun_dns_lookup_t *self,
					 const char **target, uint16_t *port);
290

Pekka Pessi's avatar
Pekka Pessi committed
291 292 293
/* -------------------------------------------------------------------
 * Functions for minimal STUN server */

294 295
SOFIAPUBFUN stun_mini_t *stun_mini_create(void);
SOFIAPUBFUN void stun_mini_destroy(stun_mini_t *);
Pekka Pessi's avatar
Pekka Pessi committed
296

297 298 299 300
SOFIAPUBFUN int stun_mini_add_socket(stun_mini_t *server,
				     su_socket_t socket);
SOFIAPUBFUN int stun_mini_remove_socket(stun_mini_t *server,
					su_socket_t socket);
Pekka Pessi's avatar
Pekka Pessi committed
301

302
SOFIAPUBFUN void stun_mini_request(stun_mini_t *server, su_socket_t socket,
303 304
				   void *msg, ssize_t msglen,
				   void *addr, socklen_t addrlen);
Pekka Pessi's avatar
Pekka Pessi committed
305

306 307
SOFIA_END_DECLS

Pekka Pessi's avatar
Pekka Pessi committed
308
#endif /* !defined(STUN_H) */