/*
This file is part of GNUnet.
- (C) 2007-2014 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2007-2014 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_nat_lib.h
- * @brief Library handling UPnP and NAT-PMP port forwarding and
- * external IP address retrieval
* @author Christian Grothoff
* @author Milan Bouchet-Valat
+ *
+ * @file
+ * Library handling UPnP and NAT-PMP port forwarding
+ * and external IP address retrieval
+ *
+ * @defgroup nat NAT library
+ * Library handling UPnP and NAT-PMP port forwarding
+ * and external IP address retrieval
+ *
+ * @{
*/
#ifndef GNUNET_NAT_LIB_H
struct GNUNET_NAT_Handle;
+
+/**
+ * What the situation of the NAT connectivity
+ */
+enum GNUNET_NAT_Type
+{
+ /**
+ * We have a direct connection
+ */
+ GNUNET_NAT_TYPE_NO_NAT = GNUNET_OK,
+
+ /**
+ * We are under a NAT but cannot traverse it
+ */
+ GNUNET_NAT_TYPE_UNREACHABLE_NAT,
+
+ /**
+ * We can traverse using STUN
+ */
+ GNUNET_NAT_TYPE_STUN_PUNCHED_NAT,
+
+ /**
+ * WE can traverse using UPNP
+ */
+ GNUNET_NAT_TYPE_UPNP_NAT
+
+};
+
/**
* Error Types for the NAT subsystem (which can then later be converted/resolved to a string)
*/
-enum GNUNET_NAT_FailureCode {
+enum GNUNET_NAT_StatusCode
+{
/**
* Just the default
*/
- GNUNET_NAT_ERROR_SUCCESS = 0,
-
+ GNUNET_NAT_ERROR_SUCCESS = GNUNET_OK,
+
+ /**
+ * IPC Failure
+ */
+ GNUNET_NAT_ERROR_IPC_FAILURE,
+
+ /**
+ * Failure in network subsystem, check permissions
+ */
+ GNUNET_NAT_ERROR_INTERNAL_NETWORK_ERROR,
+
+ /**
+ * test timed out
+ */
+ GNUNET_NAT_ERROR_TIMEOUT,
+
+ /**
+ * detected that we are offline
+ */
+ GNUNET_NAT_ERROR_NOT_ONLINE,
+
/**
* `upnpc` command not found
*/
GNUNET_NAT_ERROR_UPNPC_NOT_FOUND,
-
+
/**
* Failed to run `upnpc` command
*/
GNUNET_NAT_ERROR_UPNPC_FAILED,
-
+
/**
* `upnpc' command took too long, process killed
*/
GNUNET_NAT_ERROR_UPNPC_TIMEOUT,
-
+
/**
* `upnpc' command failed to establish port mapping
*/
GNUNET_NAT_ERROR_UPNPC_PORTMAP_FAILED,
-
+
/**
* `external-ip' command not found
*/
GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_NOT_FOUND,
-
+
+ /**
+ * Failed to run `external-ip` command
+ */
+ GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_FAILED,
+
+ /**
+ * `external-ip' command output invalid
+ */
+ GNUNET_NAT_ERROR_EXTERNAL_IP_UTILITY_OUTPUT_INVALID,
+
/**
* "no valid address was returned by `external-ip'"
*/
- GNUNET_NAT_ERROR_EXTERNAL_IP_NO_VALID_ADDRESS_FOUND,
-
-
-
+ GNUNET_NAT_ERROR_EXTERNAL_IP_ADDRESS_INVALID,
+
+ /**
+ * Could not determine interface with internal/local network address
+ */
+ GNUNET_NAT_ERROR_NO_VALID_IF_IP_COMBO,
+
+ /**
+ * No working gnunet-helper-nat-server found
+ */
+ GNUNET_NAT_ERROR_HELPER_NAT_SERVER_NOT_FOUND,
+
+ /**
+ * NAT test could not be initialized
+ */
+ GNUNET_NAT_ERROR_NAT_TEST_START_FAILED,
+
+ /**
+ * NAT test timeout
+ */
+ GNUNET_NAT_ERROR_NAT_TEST_TIMEOUT,
+
+ /**
+ * NAT test failed to initiate
+ */
+ GNUNET_NAT_ERROR_NAT_REGISTER_FAILED,
+
+ /**
+ *
+ */
+ GNUNET_NAT_ERROR_HELPER_NAT_CLIENT_NOT_FOUND,
+
/**
- *
+ *
*/
- GNUNET_NAT_ERROR_,
-
-
+ GNUNET_NAT_ERROR_
};
+/**
+ * Converts `enum GNUNET_NAT_StatusCode` to string
+ *
+ * @param err error code to resolve to a string
+ * @return point to a static string containing the error code
+ */
+const char *
+GNUNET_NAT_status2string (enum GNUNET_NAT_StatusCode err);
+
+
/**
* Attempt to enable port redirection and detect public IP address
* contacting UPnP or NAT-PMP routers on the local network. Use addr
const socklen_t *addrlens,
GNUNET_NAT_AddressCallback address_callback,
GNUNET_NAT_ReversalCallback reversal_callback,
- void *callback_cls);
+ void *callback_cls,
+ struct GNUNET_NETWORK_Handle* sock);
/**
* NAT configuration test.
*
* @param cls closure
- * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
*/
typedef void (*GNUNET_NAT_TestCallback) (void *cls,
- enum GNUNET_NAT_FailureCode result);
+ enum GNUNET_NAT_StatusCode result);
/**
* @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
* @param bnd_port port to bind to, 0 for connection reversal
* @param adv_port externally advertised port to use
- * @param report function to call with the result of the test
+ * @param timeout delay after which the test should be aborted
+ * @param report function to call with the result of the test;
+ * you still must call #GNUNET_NAT_test_stop().
* @param report_cls closure for @a report
* @return handle to cancel NAT test
*/
int is_tcp,
uint16_t bnd_port,
uint16_t adv_port,
+ struct GNUNET_TIME_Relative timeout,
GNUNET_NAT_TestCallback report,
void *report_cls);
*
* @param cls closure
* @param addr the address, NULL on errors
- * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
*/
-typedef void (*GNUNET_NAT_IPCallback) (void *cls,
- const struct in_addr *addr,
- enum GNUNET_NAT_FailureCode result);
-
+typedef void
+(*GNUNET_NAT_IPCallback) (void *cls,
+ const struct in_addr *addr,
+ enum GNUNET_NAT_StatusCode result);
/**
*
* @param cls closure
* @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
- * the previous (now invalid) one
+ * the previous (now invalid) one, #GNUNET_SYSERR indicates an error
* @param addr either the previous or the new public IP address
* @param addrlen actual length of the @a addr
- * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
*/
typedef void
(*GNUNET_NAT_MiniAddressCallback) (void *cls,
int add_remove,
const struct sockaddr *addr,
socklen_t addrlen,
- enum GNUNET_NAT_FailureCode result);
+ enum GNUNET_NAT_StatusCode result);
/**
* @param cls closure
* @param diff minimal suggested changes to the original configuration
* to make it work (as best as we can)
- * @param result GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param result #GNUNET_NAT_ERROR_SUCCESS on success, otherwise the specific error code
+ * @param type what the situation of the NAT
*/
typedef void
(*GNUNET_NAT_AutoResultCallback)(void *cls,
const struct GNUNET_CONFIGURATION_Handle *diff,
- enum GNUNET_NAT_FailureCode result);
+ enum GNUNET_NAT_StatusCode result,
+ enum GNUNET_NAT_Type type);
/**
void
GNUNET_NAT_autoconfig_cancel (struct GNUNET_NAT_AutoHandle *ah);
+/**
+ * Handle for active STUN Requests.
+ */
+struct GNUNET_NAT_STUN_Handle;
+
+
+/**
+ * Function called with the result if an error happened during STUN request.
+ *
+ * @param cls closure
+ * @param result the specific error code
+ */
+typedef void
+(*GNUNET_NAT_STUN_ErrorCallback)(void *cls,
+ enum GNUNET_NAT_StatusCode error);
+
+
+/**
+ * Handle to a request given to the resolver. Can be used to cancel
+ * the request prior to the timeout or successful execution. Also
+ * used to track our internal state for the request.
+ */
+struct GNUNET_NAT_STUN_Handle;
+
+
+/**
+ * Make generic STUN request. Sends a generic stun request to the
+ * server specified using the specified socket. The caller must
+ * wait for a reply on the @a sock and call
+ * #GNUNET_NAT_stun_handle_packet() if a reply is received.
+ *
+ * @param server the address of the stun server
+ * @param port port of the stun server
+ * @param sock the socket used to send the request
+ * @param cb callback in case of error (or completion)
+ * @param cb_cls closure for @a cb
+ * @return NULL on error
+ */
+struct GNUNET_NAT_STUN_Handle *
+GNUNET_NAT_stun_make_request (const char *server,
+ uint16_t port,
+ struct GNUNET_NETWORK_Handle *sock,
+ GNUNET_NAT_STUN_ErrorCallback cb,
+ void *cb_cls);
+
+
+/**
+ * Cancel active STUN request. Frees associated resources
+ * and ensures that the callback is no longer invoked.
+ *
+ * @param rh request to cancel
+ */
+void
+GNUNET_NAT_stun_make_request_cancel (struct GNUNET_NAT_STUN_Handle *rh);
+
+
+/**
+ * Handle an incoming STUN message. Do some basic sanity checks on
+ * packet size and content, try to extract a bit of information, and
+ * possibly reply. At the moment this only processes BIND requests,
+ * and returns the externally visible address of the request. If a
+ * callback is specified, invoke it with the attribute.
+ *
+ * @param data the packet
+ * @param len the length of the packet
+ * @param arg sockaddr_in where we will set our discovered packet
+ * @return #GNUNET_OK on OK,
+ * #GNUNET_NO if the packet is not a stun packet
+ */
+int
+GNUNET_NAT_stun_handle_packet (const void *data,
+ size_t len,
+ struct sockaddr_in *arg);
+
+
+/**
+ * CHECK if is a valid STUN packet sending to #GNUNET_NAT_stun_handle_packet().
+ * It also check if it can handle the packet based on the NAT handler.
+ * You don't need to call anything else to check if the packet is valid,
+ *
+ * @param cls the NAT handle
+ * @param data packet
+ * @param len length of @a data
+ * @return #GNUNET_NO if it can't decode, #GNUNET_YES if is a packet
+ */
+int
+GNUNET_NAT_is_valid_stun_packet (void *cls,
+ const void *data,
+ size_t len);
+
+
#endif
+/** @} */ /* end of group */
+
/* end of gnunet_nat_lib.h */
projects / oweals / gnunet.git / blobdiff