src/include/gnunet_nat_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2007-2014 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  * @author Christian Grothoff
  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 /**
  36  * Signature of the callback passed to #GNUNET_NAT_register() for
  37  * a function to call whenever our set of 'valid' addresses changes.
  38  *
  39  * @param cls closure
  40  * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
  41  *     the previous (now invalid) one
  42  * @param addr either the previous or the new public IP address
  43  * @param addrlen actual length of the @a addr
  44  */
  45 typedef void
  46 (*GNUNET_NAT_AddressCallback) (void *cls,
  47                                int add_remove,
  48                                const struct sockaddr *addr,
  49                                socklen_t addrlen);
  50
  51
  52 /**
  53  * Signature of the callback passed to #GNUNET_NAT_register().
  54  * for a function to call whenever someone asks us to do connection
  55  * reversal.
  56  *
  57  * @param cls closure
  58  * @param addr public IP address of the other peer
  59  * @param addrlen actual lenght of the @a addr
  60  */
  61 typedef void
  62 (*GNUNET_NAT_ReversalCallback) (void *cls,
  63                                 const struct sockaddr *addr,
  64                                 socklen_t addrlen);
  65
  66
  67 /**
  68  * Handle for active NAT registrations.
  69  */
  70 struct GNUNET_NAT_Handle;
  71
  72
  73 /**
  74  * Error Types for the NAT subsystem (which can then later be converted/resolved to a string)
  75  */
  76 enum GNUNET_NAT_FailureCode
  77 {
  78   /**
  79    * Just the default
  80    */
  81   GNUNET_NAT_ERROR_SUCCESS = GNUNET_OK,
  82
  83   /**
  84    * `external-ip' command not found
  85    */
  86   GNUNET_NAT_ERROR_IPC_FAILURE,
  87
  88   /**
  89    * `external-ip' command not found
  90    */
  91   GNUNET_NAT_ERROR_TIMEOUT,
  92
  93   /**
  94    * `external-ip' command not found
  95    */
  96   GNUNET_NAT_ERROR_NOT_ONLINE,
  97
  98   /**
  99    * `upnpc` command not found
 100    */
 101   GNUNET_NAT_ERROR_UPNPC_NOT_FOUND,
 102
 103   /**
 104    * Failed to run `upnpc` command
 105    */
 106   GNUNET_NAT_ERROR_UPNPC_FAILED,
 107
 108   /**
 109    * `upnpc' command took too long, process killed
 110    */
 111   GNUNET_NAT_ERROR_UPNPC_TIMEOUT,
 112
 113   /**
 114    * `upnpc' command failed to establish port mapping
 115    */
 116   GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED,
 117
 118   /**
 119    * `external-ip' command not found
 120    */
 121   GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND,
 122
 123   /**
 124    * `external-ip' command not found
 125    */
 126   GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_EXECUTEABLE,
 127
 128   /**
 129    * `external-ip' command not found
 130    */
 131   GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID,
 132
 133   /**
 134    * "no valid address was returned by `external-ip'"
 135    */
 136   GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID,
 137
 138   /**
 139    * Could not determine interface with internal/local network address
 140    */
 141   GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO,
 142
 143   /**
 144    * No working gnunet-helper-nat-server found
 145    */
 146   GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND,
 147
 148   /**
 149    * NAT test could not be initialized
 150    */
 151   GNUNET_NAT_ERROR_NAT_TEST_START_FAILED,
 152
 153   /**
 154    * NAT test timeout
 155    */
 156   GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT,
 157
 158   /**
 159    *
 160    */
 161   GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND,
 162
 163
 164   /**
 165    *
 166    */
 167   GNUNET_NAT_ERROR_
 168 };
 169
 170
 171 /**
 172  * Attempt to enable port redirection and detect public IP address
 173  * contacting UPnP or NAT-PMP routers on the local network. Use addr
 174  * to specify to which of the local host's addresses should the
 175  * external port be mapped. The port is taken from the corresponding
 176  * sockaddr_in[6] field.  The NAT module should call the given
 177  * callback for any 'plausible' external address.
 178  *
 179  * @param cfg configuration to use
 180  * @param is_tcp #GNUNET_YES for TCP, #GNUNET_NO for UDP
 181  * @param adv_port advertised port (port we are either bound to or that our OS
 182  *                 locally performs redirection from to our bound port).
 183  * @param num_addrs number of addresses in @a addrs
 184  * @param addrs list of local addresses packets should be redirected to
 185  * @param addrlens actual lengths of the addresses in @a addrs
 186  * @param address_callback function to call everytime the public IP address changes
 187  * @param reversal_callback function to call if someone wants connection reversal from us,
 188  *        NULL if connection reversal is not supported
 189  * @param callback_cls closure for callbacks
 190  * @return NULL on error, otherwise handle that can be used to unregister
 191  */
 192 struct GNUNET_NAT_Handle *
 193 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
 194                      int is_tcp,
 195                      uint16_t adv_port,
 196                      unsigned int num_addrs,
 197                      const struct sockaddr **addrs,
 198                      const socklen_t *addrlens,
 199                      GNUNET_NAT_AddressCallback address_callback,
 200                      GNUNET_NAT_ReversalCallback reversal_callback,
 201                      void *callback_cls);
 202
 203
 204 /**
 205  * Test if the given address is (currently) a plausible IP address for
 206  * this peer.
 207  *
 208  * @param h the handle returned by register
 209  * @param addr IP address to test (IPv4 or IPv6)
 210  * @param addrlen number of bytes in @a addr
 211  * @return #GNUNET_YES if the address is plausible,
 212  *         #GNUNET_NO if the address is not plausible,
 213  *         #GNUNET_SYSERR if the address is malformed
 214  */
 215 int
 216 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
 217                          const void *addr,
 218                          socklen_t addrlen);
 219
 220
 221 /**
 222  * We learned about a peer (possibly behind NAT) so run the
 223  * gnunet-nat-client to send dummy ICMP responses to cause
 224  * that peer to connect to us (connection reversal).
 225  *
 226  * @param h handle (used for configuration)
 227  * @param sa the address of the peer (IPv4-only)
 228  * @return #GNUNET_SYSERR on error, #GNUNET_NO if nat client is disabled,
 229  *         #GNUNET_OK otherwise
 230  */
 231 int
 232 GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
 233                        const struct sockaddr_in *sa);
 234
 235
 236 /**
 237  * Stop port redirection and public IP address detection for the given
 238  * handle.  This frees the handle, after having sent the needed
 239  * commands to close open ports.
 240  *
 241  * @param h the handle to stop
 242  */
 243 void
 244 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
 245
 246
 247 /**
 248  * Handle to a NAT test.
 249  */
 250 struct GNUNET_NAT_Test;
 251
 252
 253 /**
 254  * Function called to report success or failure for
 255  * NAT configuration test.
 256  *
 257  * @param cls closure
 258  * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
 259  */
 260 typedef void (*GNUNET_NAT_TestCallback) (void *cls,
 261                                          enum GNUNET_NAT_FailureCode result);
 262
 263
 264 /**
 265  * Start testing if NAT traversal works using the
 266  * given configuration (IPv4-only).
 267  *
 268  * @param cfg configuration for the NAT traversal
 269  * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
 270  * @param bnd_port port to bind to, 0 for connection reversal
 271  * @param adv_port externally advertised port to use
 272  * @param timeout delay after which the test should be aborted
 273  * @param report function to call with the result of the test
 274  * @param report_cls closure for @a report
 275  * @return handle to cancel NAT test
 276  */
 277 struct GNUNET_NAT_Test *
 278 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 279                        int is_tcp,
 280                        uint16_t bnd_port,
 281                        uint16_t adv_port,
 282                        struct GNUNET_TIME_Relative timeout,
 283                        GNUNET_NAT_TestCallback report,
 284                        void *report_cls);
 285
 286
 287 /**
 288  * Stop an active NAT test.
 289  *
 290  * @param tst test to stop.
 291  */
 292 void
 293 GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst);
 294
 295
 296 /**
 297  * Signature of a callback that is given an IP address.
 298  *
 299  * @param cls closure
 300  * @param addr the address, NULL on errors
 301  * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
 302  */
 303 typedef void (*GNUNET_NAT_IPCallback) (void *cls,
 304                                        const struct in_addr *addr,
 305                                        enum GNUNET_NAT_FailureCode result);
 306
 307
 308
 309 /**
 310  * Opaque handle to cancel #GNUNET_NAT_mini_get_external_ipv4() operation.
 311  */
 312 struct GNUNET_NAT_ExternalHandle;
 313
 314
 315 /**
 316  * Try to get the external IPv4 address of this peer.
 317  *
 318  * @param timeout when to fail
 319  * @param cb function to call with result
 320  * @param cb_cls closure for @a cb
 321  * @return handle for cancellation (can only be used until @a cb is called), NULL on error
 322  */
 323 struct GNUNET_NAT_ExternalHandle *
 324 GNUNET_NAT_mini_get_external_ipv4 (struct GNUNET_TIME_Relative timeout,
 325                                    GNUNET_NAT_IPCallback cb,
 326                                    void *cb_cls);
 327
 328
 329 /**
 330  * Cancel operation.
 331  *
 332  * @param eh operation to cancel
 333  */
 334 void
 335 GNUNET_NAT_mini_get_external_ipv4_cancel (struct GNUNET_NAT_ExternalHandle *eh);
 336
 337
 338 /**
 339  * Handle to a mapping created with upnpc.
 340  */
 341 struct GNUNET_NAT_MiniHandle;
 342
 343
 344 /**
 345  * Signature of the callback passed to #GNUNET_NAT_register() for
 346  * a function to call whenever our set of 'valid' addresses changes.
 347  *
 348  * @param cls closure
 349  * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
 350  *     the previous (now invalid) one, #GNUNET_SYSERR indicates an error
 351  * @param addr either the previous or the new public IP address
 352  * @param addrlen actual length of the @a addr
 353  * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
 354  */
 355 typedef void
 356 (*GNUNET_NAT_MiniAddressCallback) (void *cls,
 357                                    int add_remove,
 358                                    const struct sockaddr *addr,
 359                                    socklen_t addrlen,
 360                                    enum GNUNET_NAT_FailureCode result);
 361
 362
 363 /**
 364  * Start mapping the given port using (mini)upnpc.  This function
 365  * should typically not be used directly (it is used within the
 366  * general-purpose #GNUNET_NAT_register() code).  However, it can be
 367  * used if specifically UPnP-based NAT traversal is to be used or
 368  * tested.
 369  *
 370  * @param port port to map
 371  * @param is_tcp #GNUNET_YES to map TCP, #GNUNET_NO for UDP
 372  * @param ac function to call with mapping result
 373  * @param ac_cls closure for @a ac
 374  * @return NULL on error
 375  */
 376 struct GNUNET_NAT_MiniHandle *
 377 GNUNET_NAT_mini_map_start (uint16_t port,
 378                            int is_tcp,
 379                            GNUNET_NAT_MiniAddressCallback ac,
 380                            void *ac_cls);
 381
 382
 383 /**
 384  * Remove a mapping created with (mini)upnpc.  Calling
 385  * this function will give 'upnpc' 1s to remove the mapping,
 386  * so while this function is non-blocking, a task will be
 387  * left with the scheduler for up to 1s past this call.
 388  *
 389  * @param mini the handle
 390  */
 391 void
 392 GNUNET_NAT_mini_map_stop (struct GNUNET_NAT_MiniHandle *mini);
 393
 394
 395 /**
 396  * Handle to auto-configuration in progress.
 397  */
 398 struct GNUNET_NAT_AutoHandle;
 399
 400
 401 /**
 402  * Function called with the result from the autoconfiguration.
 403  *
 404  * @param cls closure
 405  * @param diff minimal suggested changes to the original configuration
 406  *             to make it work (as best as we can)
 407  * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
 408  */
 409 typedef void
 410 (*GNUNET_NAT_AutoResultCallback)(void *cls,
 411                                  const struct GNUNET_CONFIGURATION_Handle *diff,
 412                                  enum GNUNET_NAT_FailureCode result);
 413
 414
 415 /**
 416  * Start auto-configuration routine.  The resolver service should
 417  * be available when this function is called.
 418  *
 419  * @param cfg initial configuration
 420  * @param cb function to call with autoconfiguration result
 421  * @param cb_cls closure for @a cb
 422  * @return handle to cancel operation
 423  */
 424 struct GNUNET_NAT_AutoHandle *
 425 GNUNET_NAT_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 426                              GNUNET_NAT_AutoResultCallback cb,
 427                              void *cb_cls);
 428
 429
 430 /**
 431  * Abort autoconfiguration.
 432  *
 433  * @param ah handle for operation to abort
 434  */
 435 void
 436 GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah);
 437
 438 #endif
 439
 440 /* end of gnunet_nat_lib.h */