src/include/gnunet_nat_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2007, 2008, 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file include/gnunet_nat_lib.h
  23  * @brief Library handling UPnP and NAT-PMP port forwarding and
  24  *     external IP address retrieval
  25  *
  26  * @author Milan Bouchet-Valat
  27  */
  28
  29 #ifndef GNUNET_NAT_LIB_H
  30 #define GNUNET_NAT_LIB_H
  31
  32 #include "gnunet_util_lib.h"
  33
  34 /**
  35  * Signature of the callback passed to GNUNET_NAT_register for
  36  * a function to call whenever our set of 'valid' addresses changes.
  37  *
  38  * @param cls closure
  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
  43  */
  44 typedef void (*GNUNET_NAT_AddressCallback) (void *cls, int add_remove,
  45                                             const struct sockaddr * addr,
  46                                             socklen_t addrlen);
  47
  48
  49 /**
  50  * Signature of the callback passed to GNUNET_NAT_register
  51  * for a function to call whenever someone asks us to do connection
  52  * reversal.
  53  *
  54  * @param cls closure
  55  * @param addr public IP address of the other peer
  56  * @param addrlen actual lenght of the address
  57  */
  58 typedef void (*GNUNET_NAT_ReversalCallback) (void *cls,
  59                                              const struct sockaddr * addr,
  60                                              socklen_t addrlen);
  61
  62
  63 /**
  64  * Handle for active NAT registrations.
  65  */
  66 struct GNUNET_NAT_Handle;
  67
  68
  69 /**
  70  * Attempt to enable port redirection and detect public IP address contacting
  71  * UPnP or NAT-PMP routers on the local network. Use addr to specify to which
  72  * of the local host's addresses should the external port be mapped. The port
  73  * is taken from the corresponding sockaddr_in[6] field.  The NAT module
  74  * should call the given callback for any 'plausible' external address.
  75  *
  76  * @param cfg configuration to use
  77  * @param is_tcp GNUNET_YES for TCP, GNUNET_NO for UDP
  78  * @param adv_port advertised port (port we are either bound to or that our OS
  79  *                 locally performs redirection from to our bound port).
  80  * @param num_addrs number of addresses in 'addrs'
  81  * @param addrs list of local addresses packets should be redirected to
  82  * @param addrlens actual lengths of the addresses
  83  * @param address_callback function to call everytime the public IP address changes
  84  * @param reversal_callback function to call if someone wants connection reversal from us,
  85  *        NULL if connection reversal is not supported
  86  * @param callback_cls closure for callback
  87  * @return NULL on error, otherwise handle that can be used to unregister
  88  */
  89 struct GNUNET_NAT_Handle *GNUNET_NAT_register (const struct
  90                                                GNUNET_CONFIGURATION_Handle *cfg,
  91                                                int is_tcp, uint16_t adv_port,
  92                                                unsigned int num_addrs,
  93                                                const struct sockaddr **addrs,
  94                                                const socklen_t * addrlens,
  95                                                GNUNET_NAT_AddressCallback
  96                                                address_callback,
  97                                                GNUNET_NAT_ReversalCallback
  98                                                reversal_callback,
  99                                                void *callback_cls);
 100
 101
 102 /**
 103  * Test if the given address is (currently) a plausible IP address for this peer.
 104  *
 105  * @param h the handle returned by register
 106  * @param addr IP address to test (IPv4 or IPv6)
 107  * @param addrlen number of bytes in addr
 108  * @return GNUNET_YES if the address is plausible,
 109  *         GNUNET_NO if the address is not plausible,
 110  *         GNUNET_SYSERR if the address is malformed
 111  */
 112 int GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h, const void *addr,
 113                              socklen_t addrlen);
 114
 115
 116 /**
 117  * We learned about a peer (possibly behind NAT) so run the
 118  * gnunet-nat-client to send dummy ICMP responses to cause
 119  * that peer to connect to us (connection reversal).
 120  *
 121  * @param h handle (used for configuration)
 122  * @param sa the address of the peer (IPv4-only)
 123  */
 124 void GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
 125                             const struct sockaddr_in *sa);
 126
 127
 128
 129 /**
 130  * Stop port redirection and public IP address detection for the given handle.
 131  * This frees the handle, after having sent the needed commands to close open ports.
 132  *
 133  * @param h the handle to stop
 134  */
 135 void GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
 136
 137
 138 /**
 139  * Handle to a NAT test.
 140  */
 141 struct GNUNET_NAT_Test;
 142
 143 /**
 144  * Function called to report success or failure for
 145  * NAT configuration test.
 146  *
 147  * @param cls closure
 148  * @param success GNUNET_OK on success, GNUNET_NO on failure,
 149  *                GNUNET_SYSERR if the test could not be
 150  *                properly started (internal failure)
 151  */
 152 typedef void (*GNUNET_NAT_TestCallback) (void *cls, int success);
 153
 154 /**
 155  * Start testing if NAT traversal works using the
 156  * given configuration (IPv4-only).
 157  *
 158  * @param cfg configuration for the NAT traversal
 159  * @param is_tcp GNUNET_YES to test TCP, GNUNET_NO to test UDP
 160  * @param bnd_port port to bind to, 0 for connection reversal
 161  * @param adv_port externally advertised port to use
 162  * @param report function to call with the result of the test
 163  * @param report_cls closure for report
 164  * @return handle to cancel NAT test
 165  */
 166 struct GNUNET_NAT_Test *GNUNET_NAT_test_start (const struct
 167                                                GNUNET_CONFIGURATION_Handle *cfg,
 168                                                int is_tcp, uint16_t bnd_port,
 169                                                uint16_t adv_port,
 170                                                GNUNET_NAT_TestCallback report,
 171                                                void *report_cls);
 172
 173
 174 /**
 175  * Stop an active NAT test.
 176  *
 177  * @param tst test to stop.
 178  */
 179 void GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst);
 180
 181
 182 /**
 183  * Signature of a callback that is given an IP address.
 184  *
 185  * @param cls closure
 186  * @param addr the address, NULL on errors
 187  */
 188 typedef void (*GNUNET_NAT_IPCallback) (void *cls, const struct in_addr * addr);
 189
 190
 191
 192 /**
 193  * Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation.
 194  */
 195 struct GNUNET_NAT_ExternalHandle;
 196
 197
 198 /**
 199  * Try to get the external IPv4 address of this peer.
 200  *
 201  * @param timeout when to fail
 202  * @param cb function to call with result
 203  * @param cb_cls closure for 'cb'
 204  * @return handle for cancellation (can only be used until 'cb' is called), NULL on error
 205  */
 206 struct GNUNET_NAT_ExternalHandle *GNUNET_NAT_mini_get_external_ipv4 (struct
 207                                                                      GNUNET_TIME_Relative
 208                                                                      timeout,
 209                                                                      GNUNET_NAT_IPCallback
 210                                                                      cb,
 211                                                                      void
 212                                                                      *cb_cls);
 213
 214
 215 /**
 216  * Cancel operation.
 217  *
 218  * @param eh operation to cancel
 219  */
 220 void GNUNET_NAT_mini_get_external_ipv4_cancel (struct GNUNET_NAT_ExternalHandle
 221                                                *eh);
 222
 223
 224 /**
 225  * Handle to a mapping created with upnpc.
 226  */
 227 struct GNUNET_NAT_MiniHandle;
 228
 229
 230 /**
 231  * Start mapping the given port using (mini)upnpc.  This function
 232  * should typically not be used directly (it is used within the
 233  * general-purpose 'GNUNET_NAT_register' code).  However, it can be
 234  * used if specifically UPnP-based NAT traversal is to be used or
 235  * tested.
 236  *
 237  * @param port port to map
 238  * @param is_tcp GNUNET_YES to map TCP, GNUNET_NO for UDP
 239  * @param ac function to call with mapping result
 240  * @param ac_cls closure for 'ac'
 241  * @return NULL on error
 242  */
 243 struct GNUNET_NAT_MiniHandle *GNUNET_NAT_mini_map_start (uint16_t port,
 244                                                          int is_tcp,
 245                                                          GNUNET_NAT_AddressCallback
 246                                                          ac, void *ac_cls);
 247
 248
 249 /**
 250  * Remove a mapping created with (mini)upnpc.  Calling
 251  * this function will give 'upnpc' 1s to remove tha mapping,
 252  * so while this function is non-blocking, a task will be
 253  * left with the scheduler for up to 1s past this call.
 254  *
 255  * @param mini the handle
 256  */
 257 void GNUNET_NAT_mini_map_stop (struct GNUNET_NAT_MiniHandle *mini);
 258
 259
 260 #endif
 261
 262 /* end of gnunet_nat_lib.h */