src/include/gnunet_nat_service.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2007-2016 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Christian Grothoff
  23  * @author Milan Bouchet-Valat
  24  *
  25  * @file
  26  * Service for handling UPnP and NAT-PMP port forwarding
  27  * and external IP address retrieval
  28  *
  29  * @defgroup nat  NAT library
  30  * Service for handling UPnP and NAT-PMP port forwarding
  31  * and external IP address retrieval
  32  *
  33  * @{
  34  */
  35
  36 #ifndef GNUNET_NAT_SERVICE_H
  37 #define GNUNET_NAT_SERVICE_H
  38
  39 #include "gnunet_util_lib.h"
  40
  41
  42 /**
  43  * Some addresses contain sensitive information or are
  44  * not suitable for global distribution.  We use address
  45  * classes to filter addresses by which domain they make
  46  * sense to be used in.  These are used in a bitmask.
  47  *
  48  * FIXME: might want to define this elsewhere; we have
  49  * an equivalent enum in gnunet_transport_hello_service.h;
  50  * might ultimately belong with the new HELLO definition.
  51  */
  52 enum GNUNET_NAT_AddressClass
  53 {
  54
  55   /**
  56    * No address.
  57    */
  58   GNUNET_NAT_AC_NONE = 0,
  59
  60   /**
  61    * Addresses that fall into no other category
  62    * (i.e. incoming which we cannot use elsewhere).
  63    */
  64   GNUNET_NAT_AC_OTHER = 1,
  65
  66   /**
  67    * Flag for addresses that are highly sensitive
  68    * (i.e. IPv6 with our MAC).
  69    */
  70   GNUNET_NAT_AC_PRIVATE = 2,
  71
  72   /**
  73    * Addresses that are global (i.e. IPv4).
  74    */
  75   GNUNET_NAT_AC_GLOBAL = 4,
  76
  77   /**
  78    * Addresses that are global and are sensitive
  79    * (i.e. IPv6 with our MAC).
  80    */
  81   GNUNET_NAT_AC_GLOBAL_PRIVATE = 6,
  82
  83   /**
  84    * Addresses useful in the local wired network,
  85    * i.e. a MAC.  Sensitive, but obvious to people nearby.
  86    *
  87    * Useful for broadcasts.
  88    */
  89   GNUNET_NAT_AC_LAN = 8,
  90
  91   /**
  92    * Addresses useful in the local wired network,
  93    * i.e. a MAC.  Sensitive, but obvious to people nearby.
  94    * Useful for broadcasts.
  95    */
  96   GNUNET_NAT_AC_LAN_PRIVATE = 10,
  97
  98   /**
  99    * Addresses useful in the local wireless network,
 100    * i.e. a MAC.  Sensitive, but obvious to people nearby.
 101    * Useful for broadcasts.
 102    */
 103   GNUNET_NAT_AC_WLAN = 16,
 104
 105   /**
 106    * Addresses useful in the local bluetooth network.  Sensitive, but
 107    * obvious to people nearby.  Useful for broadcasts.
 108    */
 109   GNUNET_NAT_AC_BT = 32,
 110
 111   /**
 112    * Loopback addresses, only useful under special cirumstances.
 113    */
 114   GNUNET_NAT_AC_LOOPBACK = 64,
 115
 116   /**
 117    * Addresses that should be our external IP address
 118    * on the outside of a NAT.  Might be incorrectly determined.
 119    * Used as a bit in combination with #GNUNET_NAT_AC_GLOBAL,
 120    * or in case of double-NAT with
 121    * #GNUNET_NAT_AC_LAN.
 122    */
 123   GNUNET_NAT_AC_EXTERN = 128,
 124
 125   /**
 126    * Addresses that were manually configured by the user.
 127    * Used as a bit in combination with #GNUNET_NAT_AC_GLOBAL.
 128    */
 129   GNUNET_NAT_AC_MANUAL = 256,
 130
 131   /**
 132    * Bitmask for "any" address.
 133    */
 134   GNUNET_NAT_AC_ANY = 65535
 135
 136 };
 137
 138
 139 /**
 140  * Signature of the callback passed to #GNUNET_NAT_register() for
 141  * a function to call whenever our set of 'valid' addresses changes.
 142  *
 143  * @param cls closure
 144  * @param add_remove #GNUNET_YES to add a new public IP address,
 145  *                   #GNUNET_NO to remove a previous (now invalid) one
 146  * @param ac address class the address belongs to
 147  * @param addr either the previous or the new public IP address
 148  * @param addrlen actual length of the @a addr
 149  */
 150 typedef void
 151 (*GNUNET_NAT_AddressCallback) (void *cls,
 152                                int add_remove,
 153                                enum GNUNET_NAT_AddressClass ac,
 154                                const struct sockaddr *addr,
 155                                socklen_t addrlen);
 156
 157
 158 /**
 159  * Signature of the callback passed to #GNUNET_NAT_register().
 160  * for a function to call whenever someone asks us to do connection
 161  * reversal.
 162  *
 163  * @param cls closure
 164  * @param remote_addr public IP address of the other peer
 165  * @param remote_addrlen actual length of the @a remote_addr
 166  */
 167 typedef void
 168 (*GNUNET_NAT_ReversalCallback) (void *cls,
 169                                 const struct sockaddr *remote_addr,
 170                                 socklen_t remote_addrlen);
 171
 172
 173 /**
 174  * Handle for active NAT registrations.
 175  */
 176 struct GNUNET_NAT_Handle;
 177
 178
 179 /**
 180  * Attempt to enable port redirection and detect public IP address
 181  * contacting UPnP or NAT-PMP routers on the local network. Use @a
 182  * addr to specify to which of the local host's addresses should the
 183  * external port be mapped. The port is taken from the corresponding
 184  * sockaddr_in[6] field.  The NAT module should call the given @a
 185  * address_callback for any 'plausible' external address.
 186  *
 187  * @param cfg configuration to use
 188  * @param proto protocol this is about, IPPROTO_TCP or IPPROTO_UDP
 189  * @param hole_external hostname and port of manually punched hole in NAT, otherwise NULL (or empty string)
 190  * @param num_addrs number of addresses in @a addrs
 191  * @param addrs list of local addresses packets should be redirected to
 192  * @param addrlens actual lengths of the addresses in @a addrs
 193  * @param address_callback function to call everytime the public IP address changes
 194  * @param reversal_callback function to call if someone wants connection reversal from us,
 195  *        NULL if connection reversal is not supported
 196  * @param callback_cls closure for callbacks
 197  * @return NULL on error, otherwise handle that can be used to unregister
 198  */
 199 struct GNUNET_NAT_Handle *
 200 GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
 201                      uint8_t proto,
 202                      const char *hole_external,
 203                      unsigned int num_addrs,
 204                      const struct sockaddr **addrs,
 205                      const socklen_t *addrlens,
 206                      GNUNET_NAT_AddressCallback address_callback,
 207                      GNUNET_NAT_ReversalCallback reversal_callback,
 208                      void *callback_cls);
 209
 210
 211 /**
 212  * Test if the given address is (currently) a plausible IP address for
 213  * this peer.  Mostly a convenience function so that clients do not
 214  * have to explicitly track all IPs that the #GNUNET_NAT_AddressCallback
 215  * has returned so far.
 216  *
 217  * @param nh the handle returned by register
 218  * @param addr IP address to test (IPv4 or IPv6)
 219  * @param addrlen number of bytes in @a addr
 220  * @return #GNUNET_YES if the address is plausible,
 221  *         #GNUNET_NO if the address is not plausible,
 222  *         #GNUNET_SYSERR if the address is malformed
 223  */
 224 int
 225 GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *nh,
 226                          const void *addr,
 227                          socklen_t addrlen);
 228
 229
 230 /**
 231  * We learned about a peer (possibly behind NAT) so run the
 232  * gnunet-nat-client to send dummy ICMP responses to cause
 233  * that peer to connect to us (connection reversal).
 234  *
 235  * @param nh handle (used for configuration)
 236  * @param local_sa our local address of the peer (IPv4-only)
 237  * @param remote_sa the remote address of the peer (IPv4-only)
 238  * @return #GNUNET_SYSERR on error,
 239  *         #GNUNET_NO if connection reversal is unavailable,
 240  *         #GNUNET_OK otherwise (presumably in progress)
 241  */
 242 int
 243 GNUNET_NAT_request_reversal (struct GNUNET_NAT_Handle *nh,
 244                              const struct sockaddr_in *local_sa,
 245                              const struct sockaddr_in *remote_sa);
 246
 247
 248 /**
 249  * Stop port redirection and public IP address detection for the given
 250  * handle.  This frees the handle, after having sent the needed
 251  * commands to close open ports.
 252  *
 253  * @param nh the handle to unregister
 254  */
 255 void
 256 GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *nh);
 257
 258
 259 /**
 260  * Handle to a NAT test.
 261  */
 262 struct GNUNET_NAT_Test;
 263
 264
 265 /**
 266  * Error Types for the NAT subsystem (which can then later be converted/resolved to a string)
 267  */
 268 enum GNUNET_NAT_StatusCode
 269 {
 270   /**
 271    * Just the default
 272    */
 273   GNUNET_NAT_ERROR_SUCCESS = GNUNET_OK,
 274
 275   /**
 276    * IPC Failure
 277    */
 278   GNUNET_NAT_ERROR_IPC_FAILURE,
 279
 280   /**
 281    * Failure in network subsystem, check permissions
 282    */
 283   GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR,
 284
 285   /**
 286    * test timed out
 287    */
 288   GNUNET_NAT_ERROR_TIMEOUT,
 289
 290   /**
 291    * detected that we are offline
 292    */
 293   GNUNET_NAT_ERROR_NOT_ONLINE,
 294
 295   /**
 296    * `upnpc` command not found
 297    */
 298   GNUNET_NAT_ERROR_UPNPC_NOT_FOUND,
 299
 300   /**
 301    * Failed to run `upnpc` command
 302    */
 303   GNUNET_NAT_ERROR_UPNPC_FAILED,
 304
 305   /**
 306    * `upnpc' command took too long, process killed
 307    */
 308   GNUNET_NAT_ERROR_UPNPC_TIMEOUT,
 309
 310   /**
 311    * `upnpc' command failed to establish port mapping
 312    */
 313   GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED,
 314
 315   /**
 316    * `external-ip' command not found
 317    */
 318   GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND,
 319
 320   /**
 321    * Failed to run `external-ip` command
 322    */
 323   GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED,
 324
 325   /**
 326    * `external-ip' command output invalid
 327    */
 328   GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID,
 329
 330   /**
 331    * "no valid address was returned by `external-ip'"
 332    */
 333   GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID,
 334
 335   /**
 336    * Could not determine interface with internal/local network address
 337    */
 338   GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO,
 339
 340   /**
 341    * No working gnunet-helper-nat-server found
 342    */
 343   GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND,
 344
 345   /**
 346    * NAT test could not be initialized
 347    */
 348   GNUNET_NAT_ERROR_NAT_TEST_START_FAILED,
 349
 350   /**
 351    * NAT test timeout
 352    */
 353   GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT,
 354
 355   /**
 356    * NAT test failed to initiate
 357    */
 358   GNUNET_NAT_ERROR_NAT_REGISTER_FAILED,
 359
 360   /**
 361    *
 362    */
 363   GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND
 364
 365 };
 366
 367
 368 /**
 369  * Function called to report success or failure for
 370  * NAT configuration test.
 371  *
 372  * @param cls closure
 373  * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
 374  */
 375 typedef void
 376 (*GNUNET_NAT_TestCallback) (void *cls,
 377                             enum GNUNET_NAT_StatusCode result);
 378
 379
 380 /**
 381  * Handle an incoming STUN message.  This function is useful as
 382  * some GNUnet service may be listening on a UDP port and might
 383  * thus receive STUN messages while trying to receive other data.
 384  * In this case, this function can be used to process replies
 385  * to STUN requests.
 386  *
 387  * The function does some basic sanity checks on packet size and
 388  * content, try to extract a bit of information.
 389  *
 390  * At the moment this only processes BIND requests, and returns the
 391  * externally visible address of the request to the rest of the
 392  * NAT logic.
 393  *
 394  * @param nh handle to the NAT service
 395  * @param sender_addr address from which we got @a data
 396  * @param sender_addr_len number of bytes in @a sender_addr
 397  * @param data the packet
 398  * @param data_size number of bytes in @a data
 399  * @return #GNUNET_OK on success
 400  *         #GNUNET_NO if the packet is not a STUN packet
 401  *         #GNUNET_SYSERR on internal error handling the packet
 402  */
 403 int
 404 GNUNET_NAT_stun_handle_packet (struct GNUNET_NAT_Handle *nh,
 405                                const struct sockaddr *sender_addr,
 406                                size_t sender_addr_len,
 407                                const void *data,
 408                                size_t data_size);
 409
 410
 411 /**
 412  * Handle to a request given to the resolver.  Can be used to cancel
 413  * the request prior to the timeout or successful execution.  Also
 414  * used to track our internal state for the request.
 415  */
 416 struct GNUNET_NAT_STUN_Handle;
 417
 418
 419 /**
 420  * Make Generic STUN request. Sends a generic stun request to the
 421  * server specified using the specified socket.  If we do this,
 422  * we need to watch for possible responses and call
 423  * #GNUNET_NAT_stun_handle_packet() on incoming packets.
 424  *
 425  * @param server the address of the stun server
 426  * @param port port of the stun server, in host byte order
 427  * @param sock the socket used to send the request, must be a
 428  *             UDP socket
 429  * @param cb callback in case of error
 430  * @param cb_cls closure for @a cb
 431  * @return NULL on error
 432  */
 433 struct GNUNET_NAT_STUN_Handle *
 434 GNUNET_NAT_stun_make_request (const char *server,
 435                               uint16_t port,
 436                               struct GNUNET_NETWORK_Handle *sock,
 437                               GNUNET_NAT_TestCallback cb,
 438                               void *cb_cls);
 439
 440
 441 /**
 442  * Cancel active STUN request. Frees associated resources
 443  * and ensures that the callback is no longer invoked.
 444  *
 445  * @param rh request to cancel
 446  */
 447 void
 448 GNUNET_NAT_stun_make_request_cancel (struct GNUNET_NAT_STUN_Handle *rh);
 449
 450
 451 /**
 452  * Start testing if NAT traversal works using the given configuration
 453  * (IPv4-only).  The transport adapters should be down while using
 454  * this function.
 455  *
 456  * @param cfg configuration for the NAT traversal
 457  * @param proto protocol to test, i.e. IPPROTO_TCP or IPPROTO_UDP
 458  * @param bind_ip IPv4 address to bind to
 459  * @param bnd_port port to bind to, 0 to test connection reversal
 460  * @param extern_ip IPv4 address to externally advertise
 461  * @param extern_port externally advertised port to use
 462  * @param report function to call with the result of the test
 463  * @param report_cls closure for @a report
 464  * @return handle to cancel NAT test
 465  */
 466 struct GNUNET_NAT_Test *
 467 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 468                        uint8_t proto,
 469                        struct in_addr bind_ip,
 470                        uint16_t bnd_port,
 471                        struct in_addr extern_ip,
 472                        uint16_t extern_port,
 473                        GNUNET_NAT_TestCallback report,
 474                        void *report_cls);
 475
 476
 477 /**
 478  * Stop an active NAT test.
 479  *
 480  * @param tst test to stop.
 481  */
 482 void
 483 GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst);
 484
 485
 486 /**
 487  * Handle to auto-configuration in progress.
 488  */
 489 struct GNUNET_NAT_AutoHandle;
 490
 491
 492 /**
 493  * What the situation of the NAT connectivity
 494  */
 495 enum GNUNET_NAT_Type
 496 {
 497   /**
 498    * We have a direct connection
 499    */
 500   GNUNET_NAT_TYPE_NO_NAT = GNUNET_OK,
 501
 502   /**
 503    * We are under a NAT but cannot traverse it
 504    */
 505   GNUNET_NAT_TYPE_UNREACHABLE_NAT,
 506
 507   /**
 508    * We can traverse using STUN
 509    */
 510   GNUNET_NAT_TYPE_STUN_PUNCHED_NAT,
 511
 512   /**
 513    * We can traverse using UPNP
 514    */
 515   GNUNET_NAT_TYPE_UPNP_NAT,
 516
 517   /**
 518    * We know nothing about the NAT.
 519    */
 520   GNUNET_NAT_TYPE_UNKNOWN
 521
 522 };
 523
 524
 525 /**
 526  * Converts `enum GNUNET_NAT_StatusCode` to string
 527  *
 528  * @param err error code to resolve to a string
 529  * @return point to a static string containing the error code
 530  */
 531 const char *
 532 GNUNET_NAT_status2string (enum GNUNET_NAT_StatusCode err);
 533
 534
 535 /**
 536  * Function called with the result from the autoconfiguration.
 537  *
 538  * @param cls closure
 539  * @param diff minimal suggested changes to the original configuration
 540  *             to make it work (as best as we can)
 541  * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
 542  * @param type what the situation of the NAT
 543  */
 544 typedef void
 545 (*GNUNET_NAT_AutoResultCallback)(void *cls,
 546                                  const struct GNUNET_CONFIGURATION_Handle *diff,
 547                                  enum GNUNET_NAT_StatusCode result,
 548                                  enum GNUNET_NAT_Type type);
 549
 550
 551 /**
 552  * Start auto-configuration routine.  The transport adapters should
 553  * be stopped while this function is called.
 554  *
 555  * @param cfg initial configuration
 556  * @param cb function to call with autoconfiguration result
 557  * @param cb_cls closure for @a cb
 558  * @return handle to cancel operation
 559  */
 560 struct GNUNET_NAT_AutoHandle *
 561 GNUNET_NAT_autoconfig_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 562                              GNUNET_NAT_AutoResultCallback cb,
 563                              void *cb_cls);
 564
 565
 566 /**
 567  * Abort autoconfiguration.
 568  *
 569  * @param ah handle for operation to abort
 570  */
 571 void
 572 GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah);
 573
 574
 575 #endif
 576
 577 /** @} */  /* end of group */
 578
 579 /* end of gnunet_nat_service.h */