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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/*
This file is part of GNUnet
Copyright (C) 2012 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/>.
*/
/**
* @author Christian Grothoff
*
* @file
* API to access the VPN service.
*
* @defgroup vpn VPN service
*
* @{
*/
#ifndef GNUNET_VPN_SERVICE_H
#define GNUNET_VPN_SERVICE_H
#include "gnunet_util_lib.h"
/**
* Opaque VPN handle
*/
struct GNUNET_VPN_Handle;
/**
* Opaque redirection request handle.
*/
struct GNUNET_VPN_RedirectionRequest;
/**
* Callback invoked from the VPN service once a redirection is
* available. Provides the IP address that can now be used to
* reach the requested destination.
*
* @param cls closure
* @param af address family, AF_INET or AF_INET6; AF_UNSPEC on error;
* will match 'result_af' from the request
* @param address IP address (struct in_addr or struct in_addr6, depending on 'af')
* that the VPN allocated for the redirection;
* traffic to this IP will now be redirected to the
* specified target peer; NULL on error
*/
typedef void (*GNUNET_VPN_AllocationCallback)(void *cls,
int af,
const void *address);
/**
* Cancel redirection request with the service.
*
* @param rr request to cancel
*/
void
GNUNET_VPN_cancel_request (struct GNUNET_VPN_RedirectionRequest *rr);
/**
* Tell the VPN that a forwarding to a particular peer offering a
* particular service is requested. The VPN is to reserve a
* particular IP for the redirection and return it. The VPN will
* begin the redirection as soon as possible and maintain it as long
* as it is actively used and keeping it is feasible. Given resource
* limitations, the longest inactive mappings will be destroyed.
*
* @param vh VPN handle
* @param result_af desired address family for the returned allocation
* can also be AF_UNSPEC
* @param protocol protocol, IPPROTO_UDP or IPPROTO_TCP
* @param peer target peer for the redirection
* @param serv service descriptor to give to the peer
* @param expiration_time at what time should the redirection expire?
* (this should not impact connections that are active at that time)
* @param cb function to call with the IP
* @param cb_cls closure for cb
* @return handle to cancel the request (means the callback won't be
* invoked anymore; the mapping may or may not be established
* anyway)
*/
struct GNUNET_VPN_RedirectionRequest *
GNUNET_VPN_redirect_to_peer (struct GNUNET_VPN_Handle *vh,
int result_af,
uint8_t protocol,
const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_HashCode *serv,
struct GNUNET_TIME_Absolute expiration_time,
GNUNET_VPN_AllocationCallback cb,
void *cb_cls);
/**
* Tell the VPN that forwarding to the Internet via some exit node is
* requested. Note that both UDP and TCP traffic will be forwarded,
* but possibly to different exit nodes. The VPN is to reserve a
* particular IP for the redirection and return it. The VPN will
* begin the redirection as soon as possible and maintain it as long
* as it is actively used and keeping it is feasible. Given resource
* limitations, the longest inactive mappings will be destroyed.
*
* @param vh VPN handle
* @param result_af desired address family for the returned allocation,
* can also be AF_UNSPEC
* @param addr_af address family for 'addr', AF_INET or AF_INET6
* @param addr destination IP address on the Internet; destination
* port is to be taken from the VPN packet itself
* @param expiration_time at what time should the redirection expire?
* (this should not impact connections that are active at that time)
* @param cb function to call with the IP
* @param cb_cls closure for cb
* @return handle to cancel the request (means the callback won't be
* invoked anymore; the mapping may or may not be established
* anyway)
*/
struct GNUNET_VPN_RedirectionRequest *
GNUNET_VPN_redirect_to_ip (struct GNUNET_VPN_Handle *vh,
int result_af,
int addr_af,
const void *addr,
struct GNUNET_TIME_Absolute expiration_time,
GNUNET_VPN_AllocationCallback cb,
void *cb_cls);
/**
* Connect to the VPN service
*
* @param cfg configuration to use
* @return VPN handle
*/
struct GNUNET_VPN_Handle *
GNUNET_VPN_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* Disconnect from the VPN service.
*
* @param vh VPN handle
*/
void
GNUNET_VPN_disconnect (struct GNUNET_VPN_Handle *vh);
#endif
/** @} */ /* end of group */
|
