src/include/gnunet_nat_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2007, 2008, 2009, 2010 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,
  45                                             int add_remove,
  46                                             const struct sockaddr *addr,
  47                                             socklen_t addrlen);
  48
  49
  50 /**
  51  * Signature of the callback passed to GNUNET_NAT_register
  52  * for a function to call whenever someone asks us to do connection
  53  * reversal.
  54  *
  55  * @param cls closure
  56  * @param addr public IP address of the other peer
  57  * @param addrlen actual lenght of the address
  58  */
  59 typedef void (*GNUNET_NAT_ReversalCallback) (void *cls,
  60                                              const struct sockaddr *addr,
  61                                              socklen_t addrlen);
  62
  63
  64 /**
  65  * Handle for active NAT registrations.
  66  */
  67 struct GNUNET_NAT_Handle;
  68
  69
  70 /**
  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.
  76  *
  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
  89  */
  90 struct GNUNET_NAT_Handle *
  91 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
  92                      int is_tcp,
  93                      uint16_t adv_port,
  94                      unsigned int num_addrs,
  95                      const struct sockaddr **addrs,
  96                      const socklen_t *addrlens,
  97                      GNUNET_NAT_AddressCallback address_callback,
  98                      GNUNET_NAT_ReversalCallback 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
 113 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
 114                          const void *addr,
 115                          socklen_t addrlen);
 116
 117
 118 /**
 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).
 122  *
 123  * @param h handle (used for configuration)
 124  * @param sa the address of the peer (IPv4-only)
 125  */
 126 void
 127 GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
 128                        const struct sockaddr_in *sa);
 129
 130
 131
 132 /**
 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.
 135  *
 136  * @param h the handle to stop
 137  */
 138 void
 139 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
 140
 141 #endif
 142
 143 /* end of gnunet_nat_lib.h */