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 *
  90 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg, int is_tcp,
  91                      uint16_t adv_port, unsigned int num_addrs,
  92                      const struct sockaddr **addrs, const socklen_t * addrlens,
  93                      GNUNET_NAT_AddressCallback address_callback,
  94                      GNUNET_NAT_ReversalCallback reversal_callback,
  95                      void *callback_cls);
  96
  97
  98 /**
  99  * Test if the given address is (currently) a plausible IP address for this peer.
 100  *
 101  * @param h the handle returned by register
 102  * @param addr IP address to test (IPv4 or IPv6)
 103  * @param addrlen number of bytes in addr
 104  * @return GNUNET_YES if the address is plausible,
 105  *         GNUNET_NO if the address is not plausible,
 106  *         GNUNET_SYSERR if the address is malformed
 107  */
 108 int
 109 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h, const void *addr,
 110                          socklen_t addrlen);
 111
 112
 113 /**
 114  * We learned about a peer (possibly behind NAT) so run the
 115  * gnunet-nat-client to send dummy ICMP responses to cause
 116  * that peer to connect to us (connection reversal).
 117  *
 118  * @param h handle (used for configuration)
 119  * @param sa the address of the peer (IPv4-only)
 120  */
 121 void
 122 GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
 123                        const struct sockaddr_in *sa);
 124
 125
 126
 127 /**
 128  * Stop port redirection and public IP address detection for the given handle.
 129  * This frees the handle, after having sent the needed commands to close open ports.
 130  *
 131  * @param h the handle to stop
 132  */
 133 void
 134 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
 135
 136
 137 /**
 138  * Handle to a NAT test.
 139  */
 140 struct GNUNET_NAT_Test;
 141
 142 /**
 143  * Function called to report success or failure for
 144  * NAT configuration test.
 145  *
 146  * @param cls closure
 147  * @param success GNUNET_OK on success, GNUNET_NO on failure,
 148  *                GNUNET_SYSERR if the test could not be
 149  *                properly started (internal failure)
 150  */
 151 typedef void (*GNUNET_NAT_TestCallback) (void *cls, int success);
 152
 153 /**
 154  * Start testing if NAT traversal works using the
 155  * given configuration (IPv4-only).
 156  *
 157  * @param cfg configuration for the NAT traversal
 158  * @param is_tcp GNUNET_YES to test TCP, GNUNET_NO to test UDP
 159  * @param bnd_port port to bind to, 0 for connection reversal
 160  * @param adv_port externally advertised port to use
 161  * @param report function to call with the result of the test
 162  * @param report_cls closure for report
 163  * @return handle to cancel NAT test
 164  */
 165 struct GNUNET_NAT_Test *
 166 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 167                        int is_tcp, uint16_t bnd_port, uint16_t adv_port,
 168                        GNUNET_NAT_TestCallback report, void *report_cls);
 169
 170
 171 /**
 172  * Stop an active NAT test.
 173  *
 174  * @param tst test to stop.
 175  */
 176 void
 177 GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst);
 178
 179
 180 /**
 181  * Signature of a callback that is given an IP address.
 182  *
 183  * @param cls closure
 184  * @param addr the address, NULL on errors
 185  */
 186 typedef void (*GNUNET_NAT_IPCallback) (void *cls, const struct in_addr * addr);
 187
 188
 189
 190 /**
 191  * Opaque handle to cancel "GNUNET_NAT_mini_get_external_ipv4" operation.
 192  */
 193 struct GNUNET_NAT_ExternalHandle;
 194
 195
 196 /**
 197  * Try to get the external IPv4 address of this peer.
 198  *
 199  * @param timeout when to fail
 200  * @param cb function to call with result
 201  * @param cb_cls closure for 'cb'
 202  * @return handle for cancellation (can only be used until 'cb' is called), NULL on error
 203  */
 204 struct GNUNET_NAT_ExternalHandle *
 205 GNUNET_NAT_mini_get_external_ipv4 (struct GNUNET_TIME_Relative timeout,
 206                                    GNUNET_NAT_IPCallback cb, void *cb_cls);
 207
 208
 209 /**
 210  * Cancel operation.
 211  *
 212  * @param eh operation to cancel
 213  */
 214 void
 215 GNUNET_NAT_mini_get_external_ipv4_cancel (struct GNUNET_NAT_ExternalHandle *eh);
 216
 217
 218 /**
 219  * Handle to a mapping created with upnpc.
 220  */
 221 struct GNUNET_NAT_MiniHandle;
 222
 223
 224 /**
 225  * Start mapping the given port using (mini)upnpc.  This function
 226  * should typically not be used directly (it is used within the
 227  * general-purpose 'GNUNET_NAT_register' code).  However, it can be
 228  * used if specifically UPnP-based NAT traversal is to be used or
 229  * tested.
 230  *
 231  * @param port port to map
 232  * @param is_tcp GNUNET_YES to map TCP, GNUNET_NO for UDP
 233  * @param ac function to call with mapping result
 234  * @param ac_cls closure for 'ac'
 235  * @return NULL on error
 236  */
 237 struct GNUNET_NAT_MiniHandle *
 238 GNUNET_NAT_mini_map_start (uint16_t port, int is_tcp,
 239                            GNUNET_NAT_AddressCallback ac, void *ac_cls);
 240
 241
 242 /**
 243  * Remove a mapping created with (mini)upnpc.  Calling
 244  * this function will give 'upnpc' 1s to remove tha mapping,
 245  * so while this function is non-blocking, a task will be
 246  * left with the scheduler for up to 1s past this call.
 247  *
 248  * @param mini the handle
 249  */
 250 void
 251 GNUNET_NAT_mini_map_stop (struct GNUNET_NAT_MiniHandle *mini);
 252
 253
 254 #endif
 255
 256 /* end of gnunet_nat_lib.h */