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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
This file is part of GNUnet.
Copyright (C) 2009-2016 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
* obtain information about our current address
*
* @defgroup transport Transport service
* address information
*
* @see [Documentation](https://gnunet.org/transport-service)
*
* @{
*/
#ifndef GNUNET_TRANSPORT_HELLO_SERVICE_H
#define GNUNET_TRANSPORT_HELLO_SERVICE_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_util_lib.h"
#include "gnunet_ats_service.h"
/**
* Version number of the transport API.
*/
#define GNUNET_TRANSPORT_HELLO_VERSION 0x00000000
/**
* Some addresses contain sensitive information or are
* not suitable for global distribution. We use address
* classes to filter addresses by which domain they make
* sense to be used in. These are used in a bitmask.
*/
enum GNUNET_TRANSPORT_AddressClass
{
/**
* No address.
*/
GNUNET_TRANSPORT_AC_NONE = 0,
/**
* Addresses that fall into no other category
* (i.e. incoming which we cannot use elsewhere).
*/
GNUNET_TRANSPORT_AC_OTHER = 1,
/**
* Addresses that are global and are insensitive
* (i.e. IPv4).
*/
GNUNET_TRANSPORT_AC_GLOBAL = 2,
/**
* Addresses that are global and are sensitive
* (i.e. IPv6 with our MAC).
*/
GNUNET_TRANSPORT_AC_GLOBAL_PRIVATE = 4,
/**
* Addresses useful in the local wired network,
* i.e. a MAC. Sensitive, but obvious to people nearby.
* Useful for broadcasts.
*/
GNUNET_TRANSPORT_AC_LAN = 8,
/**
* Addresses useful in the local wireless network,
* i.e. a MAC. Sensitive, but obvious to people nearby.
* Useful for broadcasts.
*/
GNUNET_TRANSPORT_AC_WLAN = 16,
/**
* Addresses useful in the local bluetooth network. Sensitive, but
* obvious to people nearby. Useful for broadcasts.
*/
GNUNET_TRANSPORT_AC_BT = 32,
/**
* Bitmask for "any" address.
*/
GNUNET_TRANSPORT_AC_ANY = 65535
};
/**
* Function called whenever there is an update to the
* HELLO of this peer.
*
* @param cls closure
* @param hello our updated HELLO
*/
typedef void
(*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
const struct GNUNET_MessageHeader *hello);
/**
* Handle to cancel a #GNUNET_TRANSPORT_hello_get() operation.
*/
struct GNUNET_TRANSPORT_HelloGetHandle;
/**
* Obtain updates on changes to the HELLO message for this peer. The callback
* given in this function is never called synchronously.
*
* @param cfg configuration to use
* @param ac which network type should the addresses from the HELLO belong to?
* @param rec function to call with the HELLO
* @param rec_cls closure for @a rec
* @return handle to cancel the operation
*/
struct GNUNET_TRANSPORT_HelloGetHandle *
GNUNET_TRANSPORT_hello_get (const struct GNUNET_CONFIGURATION_Handle *cfg,
enum GNUNET_TRANSPORT_AddressClass ac,
GNUNET_TRANSPORT_HelloUpdateCallback rec,
void *rec_cls);
/**
* Stop receiving updates about changes to our HELLO message.
*
* @param ghh handle to cancel
*/
void
GNUNET_TRANSPORT_hello_get_cancel (struct GNUNET_TRANSPORT_HelloGetHandle *ghh);
/**
* Function with addresses found in a HELLO.
*
* @param cls closure
* @param peer identity of the peer
* @param address the address (UTF-8, 0-terminated)
* @param nt network type of the address
* @param expiration when does this address expire?
*/
typedef void
(*GNUNET_TRANSPORT_AddressCallback) (void *cls,
const struct GNUNET_PeerIdentity *peer,
const char *address,
enum GNUNET_ATS_Network_Type nt,
struct GNUNET_TIME_Absolute expiration);
/**
* Parse a HELLO message that we have received into its
* constituent addresses.
*
* @param hello message to parse
* @param cb function to call on each address found
* @param cb_cls closure for @a cb
* @return #GNUNET_OK if hello was well-formed, #GNUNET_SYSERR if not
*/
int
GNUNET_TRANSPORT_hello_parse (const struct GNUNET_MessageHeader *hello,
GNUNET_TRANSPORT_AddressCallback cb,
void *cb_cls);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_TRANSPORT_HELLO_SERVICE_H */
#endif
/** @} */ /* end of group */
/* end of gnunet_transport_hello_service.h */
|
