2 This file is part of GNUnet.
3 (C) 2007, 2008, 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_nat_lib.h
23 * @brief Library handling UPnP and NAT-PMP port forwarding and
24 * external IP address retrieval
26 * @author Milan Bouchet-Valat
29 #ifndef GNUNET_NAT_LIB_H
30 #define GNUNET_NAT_LIB_H
32 #include "gnunet_util_lib.h"
35 * Signature of the callback passed to GNUNET_NAT_register for
36 * a function to call whenever our set of 'valid' addresses changes.
39 * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
40 * the previous (now invalid) one
41 * @param addr either the previous or the new public IP address
42 * @param addrlen actual lenght of the address
44 typedef void (*GNUNET_NAT_AddressCallback) (void *cls,
46 const struct sockaddr * addr,
51 * Signature of the callback passed to GNUNET_NAT_register
52 * for a function to call whenever someone asks us to do connection
56 * @param addr public IP address of the other peer
57 * @param addrlen actual lenght of the address
59 typedef void (*GNUNET_NAT_ReversalCallback) (void *cls,
60 const struct sockaddr * addr,
65 * Handle for active NAT registrations.
67 struct GNUNET_NAT_Handle;
71 * Attempt to enable port redirection and detect public IP address contacting
72 * UPnP or NAT-PMP routers on the local network. Use addr to specify to which
73 * of the local host's addresses should the external port be mapped. The port
74 * is taken from the corresponding sockaddr_in[6] field. The NAT module
75 * should call the given callback for any 'plausible' external address.
77 * @param cfg configuration to use
78 * @param is_tcp GNUNET_YES for TCP, GNUNET_NO for UDP
79 * @param adv_port advertised port (port we are either bound to or that our OS
80 * locally performs redirection from to our bound port).
81 * @param num_addrs number of addresses in 'addrs'
82 * @param addrs list of local addresses packets should be redirected to
83 * @param addrlens actual lengths of the addresses
84 * @param address_callback function to call everytime the public IP address changes
85 * @param reversal_callback function to call if someone wants connection reversal from us,
86 * NULL if connection reversal is not supported
87 * @param callback_cls closure for callback
88 * @return NULL on error, otherwise handle that can be used to unregister
90 struct GNUNET_NAT_Handle *GNUNET_NAT_register (const struct
91 GNUNET_CONFIGURATION_Handle *cfg,
92 int is_tcp, uint16_t adv_port,
93 unsigned int num_addrs,
94 const struct sockaddr **addrs,
95 const socklen_t * addrlens,
96 GNUNET_NAT_AddressCallback
98 GNUNET_NAT_ReversalCallback
104 * Test if the given address is (currently) a plausible IP address for this peer.
106 * @param h the handle returned by register
107 * @param addr IP address to test (IPv4 or IPv6)
108 * @param addrlen number of bytes in addr
109 * @return GNUNET_YES if the address is plausible,
110 * GNUNET_NO if the address is not plausible,
111 * GNUNET_SYSERR if the address is malformed
114 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
115 const void *addr, socklen_t addrlen);
119 * We learned about a peer (possibly behind NAT) so run the
120 * gnunet-nat-client to send dummy ICMP responses to cause
121 * that peer to connect to us (connection reversal).
123 * @param h handle (used for configuration)
124 * @param sa the address of the peer (IPv4-only)
127 GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
128 const struct sockaddr_in *sa);
133 * Stop port redirection and public IP address detection for the given handle.
134 * This frees the handle, after having sent the needed commands to close open ports.
136 * @param h the handle to stop
138 void GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
142 * Handle to a NAT test.
144 struct GNUNET_NAT_Test;
147 * Function called to report success or failure for
148 * NAT configuration test.
151 * @param success GNUNET_OK on success, GNUNET_NO on failure,
152 * GNUNET_SYSERR if the test could not be
153 * properly started (internal failure)
155 typedef void (*GNUNET_NAT_TestCallback) (void *cls, int success);
158 * Start testing if NAT traversal works using the
159 * given configuration (IPv4-only).
161 * @param cfg configuration for the NAT traversal
162 * @param is_tcp GNUNET_YES to test TCP, GNUNET_NO to test UDP
163 * @param bnd_port port to bind to, 0 for connection reversal
164 * @param adv_port externally advertised port to use
165 * @param report function to call with the result of the test
166 * @param report_cls closure for report
167 * @return handle to cancel NAT test
169 struct GNUNET_NAT_Test *GNUNET_NAT_test_start (const struct
170 GNUNET_CONFIGURATION_Handle *cfg,
171 int is_tcp, uint16_t bnd_port,
173 GNUNET_NAT_TestCallback report,
178 * Stop an active NAT test.
180 * @param tst test to stop.
182 void GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst);
186 * Signature of a callback that is given an IP address.
189 * @param addr the address, NULL on errors
191 typedef void (*GNUNET_NAT_IPCallback) (void *cls, const struct in_addr * addr);
196 * Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation.
198 struct GNUNET_NAT_ExternalHandle;
202 * Try to get the external IPv4 address of this peer.
204 * @param timeout when to fail
205 * @param cb function to call with result
206 * @param cb_cls closure for 'cb'
207 * @return handle for cancellation (can only be used until 'cb' is called), NULL on error
209 struct GNUNET_NAT_ExternalHandle *GNUNET_NAT_mini_get_external_ipv4 (struct
212 GNUNET_NAT_IPCallback
221 * @param eh operation to cancel
224 GNUNET_NAT_mini_get_external_ipv4_cancel (struct GNUNET_NAT_ExternalHandle *eh);
228 * Handle to a mapping created with upnpc.
230 struct GNUNET_NAT_MiniHandle;
234 * Start mapping the given port using (mini)upnpc. This function
235 * should typically not be used directly (it is used within the
236 * general-purpose 'GNUNET_NAT_register' code). However, it can be
237 * used if specifically UPnP-based NAT traversal is to be used or
240 * @param port port to map
241 * @param is_tcp GNUNET_YES to map TCP, GNUNET_NO for UDP
242 * @param ac function to call with mapping result
243 * @param ac_cls closure for 'ac'
244 * @return NULL on error
246 struct GNUNET_NAT_MiniHandle *GNUNET_NAT_mini_map_start (uint16_t port,
248 GNUNET_NAT_AddressCallback
253 * Remove a mapping created with (mini)upnpc. Calling
254 * this function will give 'upnpc' 1s to remove tha mapping,
255 * so while this function is non-blocking, a task will be
256 * left with the scheduler for up to 1s past this call.
258 * @param mini the handle
260 void GNUNET_NAT_mini_map_stop (struct GNUNET_NAT_MiniHandle *mini);
265 /* end of gnunet_nat_lib.h */