gnunet_nat_service.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2007-2017 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_NAT_SERVICE_H
#define GNUNET_NAT_SERVICE_H
 
 
#include "gnunet_util_lib.h"
 
 
enum GNUNET_NAT_AddressClass
{
  GNUNET_NAT_AC_NONE = 0,
 
  GNUNET_NAT_AC_OTHER = 1,
 
  GNUNET_NAT_AC_PRIVATE = 2,
 
  GNUNET_NAT_AC_GLOBAL = 4,
 
  GNUNET_NAT_AC_GLOBAL_PRIVATE = 6,
 
  GNUNET_NAT_AC_LAN = 8,
 
  GNUNET_NAT_AC_LAN_PRIVATE = 10,
 
  GNUNET_NAT_AC_WLAN = 16,
 
  GNUNET_NAT_AC_BT = 32,
 
  GNUNET_NAT_AC_LOOPBACK = 64,
 
  GNUNET_NAT_AC_EXTERN = 128,
 
  GNUNET_NAT_AC_MANUAL = 256,
 
  GNUNET_NAT_AC_ANY = 65535
};
 
 
enum GNUNET_NAT_StatusCode
{
  GNUNET_NAT_ERROR_SUCCESS = GNUNET_OK,
 
  GNUNET_NAT_ERROR_IPC_FAILURE,
 
  GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR,
 
  GNUNET_NAT_ERROR_TIMEOUT,
 
  GNUNET_NAT_ERROR_NOT_ONLINE,
 
  GNUNET_NAT_ERROR_UPNPC_NOT_FOUND,
 
  GNUNET_NAT_ERROR_UPNPC_FAILED,
 
  GNUNET_NAT_ERROR_UPNPC_TIMEOUT,
 
  GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED,
 
  GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND,
 
  GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED,
 
  GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID,
 
  GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID,
 
  GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO,
 
  GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND,
 
  GNUNET_NAT_ERROR_NAT_TEST_START_FAILED,
 
  GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT,
 
  GNUNET_NAT_ERROR_NAT_REGISTER_FAILED,
 
  GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND
};
 
 
enum GNUNET_NAT_Type
{
  GNUNET_NAT_TYPE_NO_NAT = GNUNET_OK,
 
  GNUNET_NAT_TYPE_UNREACHABLE_NAT,
 
  GNUNET_NAT_TYPE_STUN_PUNCHED_NAT,
 
  GNUNET_NAT_TYPE_UPNP_NAT,
 
  GNUNET_NAT_TYPE_UNKNOWN
};
 
 
typedef void
(*GNUNET_NAT_AddressCallback) (void *cls,
                               void **app_ctx,
                               int add_remove,
                               enum GNUNET_NAT_AddressClass ac,
                               const struct sockaddr *addr,
                               socklen_t addrlen);
 
 
typedef void
(*GNUNET_NAT_ReversalCallback) (void *cls,
                                const struct sockaddr *remote_addr,
                                socklen_t remote_addrlen);
 
 
struct GNUNET_NAT_Handle;
 
 
struct GNUNET_NAT_Handle *
GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
                     const char *config_section,
                     uint8_t proto,
                     unsigned int num_addrs,
                     const struct sockaddr **addrs,
                     const socklen_t *addrlens,
                     GNUNET_NAT_AddressCallback address_callback,
                     GNUNET_NAT_ReversalCallback reversal_callback,
                     void *callback_cls);
 
 
int
GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *nh,
                         const void *addr,
                         socklen_t addrlen);
 
 
int
GNUNET_NAT_request_reversal (struct GNUNET_NAT_Handle *nh,
                             const struct sockaddr_in *local_sa,
                             const struct sockaddr_in *remote_sa);
 
 
void
GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *nh);
 
 
int
GNUNET_NAT_stun_handle_packet (struct GNUNET_NAT_Handle *nh,
                               const struct sockaddr *sender_addr,
                               size_t sender_addr_len,
                               const void *data,
                               size_t data_size);
 
 
struct GNUNET_NAT_STUN_Handle;
 
 
typedef void
(*GNUNET_NAT_TestCallback) (void *cls,
                            enum GNUNET_NAT_StatusCode result);
 
 
struct GNUNET_NAT_STUN_Handle *
GNUNET_NAT_stun_make_request (const char *server,
                              uint16_t port,
                              struct GNUNET_NETWORK_Handle *sock,
                              GNUNET_NAT_TestCallback cb,
                              void *cb_cls);
 
 
void
GNUNET_NAT_stun_make_request_cancel (struct GNUNET_NAT_STUN_Handle *rh);
 
 
#endif
  /* end of group */
 
/* end of gnunet_nat_service.h */