1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/*
This file is part of GNUnet.
(C) 2007, 2008, 2009, 2010 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, 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
General Public License for more details.
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.
*/
/**
* @file include/gnunet_nat_lib.h
* @brief Library handling UPnP and NAT-PMP port forwarding and
* external IP address retrieval
*
* @author Milan Bouchet-Valat
*/
#ifndef GNUNET_NAT_LIB_H
#define GNUNET_NAT_LIB_H
#include "gnunet_util_lib.h"
/**
* Signature of the callback passed to GNUNET_NAT_register for
* a function to call whenever our set of 'valid' addresses changes.
*
* @param cls closure
* @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
* the previous (now invalid) one
* @param addr either the previous or the new public IP address
* @param addrlen actual lenght of the address
*/
typedef void (*GNUNET_NAT_AddressCallback) (void *cls,
int add_remove,
const struct sockaddr *addr,
socklen_t addrlen);
/**
* Signature of the callback passed to GNUNET_NAT_register
* for a function to call whenever someone asks us to do connection
* reversal.
*
* @param cls closure
* @param addr public IP address of the other peer
* @param addrlen actual lenght of the address
*/
typedef void (*GNUNET_NAT_ReversalCallback) (void *cls,
const struct sockaddr *addr,
socklen_t addrlen);
/**
* Handle for active NAT registrations.
*/
struct GNUNET_NAT_Handle;
/**
* Attempt to enable port redirection and detect public IP address contacting
* UPnP or NAT-PMP routers on the local network. Use addr to specify to which
* of the local host's addresses should the external port be mapped. The port
* is taken from the corresponding sockaddr_in[6] field. The NAT module
* should call the given callback for any 'plausible' external address.
*
* @param cfg configuration to use
* @param is_tcp GNUNET_YES for TCP, GNUNET_NO for UDP
* @param adv_port advertised port (port we are either bound to or that our OS
* locally performs redirection from to our bound port).
* @param num_addrs number of addresses in 'addrs'
* @param addrs list of local addresses packets should be redirected to
* @param addrlens actual lengths of the addresses
* @param address_callback function to call everytime the public IP address changes
* @param reversal_callback function to call if someone wants connection reversal from us,
* NULL if connection reversal is not supported
* @param callback_cls closure for callback
* @return NULL on error, otherwise handle that can be used to unregister
*/
struct GNUNET_NAT_Handle *
GNUNET_NAT_register (const struct GNUNET_CONFIGURATION_Handle *cfg,
int is_tcp,
uint16_t adv_port,
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);
/**
* Test if the given address is (currently) a plausible IP address for this peer.
*
* @param h the handle returned by register
* @param addr IP address to test (IPv4 or IPv6)
* @param addrlen number of bytes in addr
* @return GNUNET_YES if the address is plausible,
* GNUNET_NO if the address is not plausible,
* GNUNET_SYSERR if the address is malformed
*/
int
GNUNET_NAT_test_address (struct GNUNET_NAT_Handle *h,
const void *addr,
socklen_t addrlen);
/**
* We learned about a peer (possibly behind NAT) so run the
* gnunet-nat-client to send dummy ICMP responses to cause
* that peer to connect to us (connection reversal).
*
* @param h handle (used for configuration)
* @param sa the address of the peer (IPv4-only)
*/
void
GNUNET_NAT_run_client (struct GNUNET_NAT_Handle *h,
const struct sockaddr_in *sa);
/**
* Stop port redirection and public IP address detection for the given handle.
* This frees the handle, after having sent the needed commands to close open ports.
*
* @param h the handle to stop
*/
void
GNUNET_NAT_unregister (struct GNUNET_NAT_Handle *h);
#endif
/* end of gnunet_nat_lib.h */
|
