2 This file is part of GNUnet.
3 (C) 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file include/gnunet_nat_lib.h
23 * @brief Library handling UPnP and NAT-PMP port forwarding and
24 * external IP address retrieval
26 * @author Milan Bouchet-Valat
29 #ifndef GNUNET_NAT_LIB_H
30 #define GNUNET_NAT_LIB_H 1
33 #include "gnunet_util_lib.h"
40 * Used to communicate with the UPnP and NAT-PMP plugins
41 * FIXME: move to src/nat/common.h
43 enum GNUNET_NAT_port_forwarding
45 GNUNET_NAT_PORT_ERROR,
46 GNUNET_NAT_PORT_UNMAPPED,
47 GNUNET_NAT_PORT_UNMAPPING,
48 GNUNET_NAT_PORT_MAPPING,
49 GNUNET_NAT_PORT_MAPPED
54 * Signature of the callback passed to GNUNET_NAT_register.
57 * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
58 * the previous (now invalid) one
59 * @param addr either the previous or the new public IP address
60 * @param addrlen actual lenght of the address
62 typedef void (*GNUNET_NAT_AddressCallback) (void *cls, int add_remove,
63 const struct sockaddr * addr,
67 * Handle for active NAT registrations.
69 struct GNUNET_NAT_Handle;
72 * Attempt to enable port redirection and detect public IP address contacting
73 * UPnP or NAT-PMP routers on the local network. Use addr to specify to which
74 * of the local host's addresses should the external port be mapped. The port
75 * is taken from the corresponding sockaddr_in[6] field.
77 * @param sched the sheduler used in the program
78 * @param addr the local address packets should be redirected to
79 * @param addrlen actual lenght of the address
80 * @param callback function to call everytime the public IP address changes
81 * @param callback_cls closure for callback
82 * @return NULL on error, otherwise handle that can be used to unregister
84 struct GNUNET_NAT_Handle *GNUNET_NAT_register (struct GNUNET_SCHEDULER_Handle
86 const struct sockaddr *addr,
88 GNUNET_NAT_AddressCallback
89 callback, void *callback_cls);
92 * Stop port redirection and public IP address detection for the given handle.
93 * This frees the handle, after having sent the needed commands to close open ports.
95 * @param h the handle to stop
97 void GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
100 * Compare the sin(6)_addr fields of AF_INET or AF_INET(6) sockaddr.
101 * FIXME: move to src/nat/common.h or so.
103 * @param a first sockaddr
104 * @param b second sockaddr
105 * @return 0 if addresses are equal, non-null value otherwise
107 int GNUNET_NAT_cmp_addr (const struct sockaddr *a,
108 const struct sockaddr *b);
113 /* end of gnunet_nat_lib.h */