GNUnet debian-0.24.3-24-gfea921bd2
plugin_block_dht.c
Go to the documentation of this file.
1/*
2 This file is part of GNUnet
3 Copyright (C) 2010, 2017, 2022 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
9
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 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
28#include "platform.h"
29#include "gnunet_constants.h"
31#include "gnunet_block_plugin.h"
33
34#define DEBUG_DHT GNUNET_EXTRA_LOGGING
35
40#define BLOOMFILTER_K 16
41
42
54static struct GNUNET_BLOCK_Group *
57 const void *raw_data,
58 size_t raw_data_size,
59 va_list va)
60{
61 unsigned int bf_size;
62 const char *guard;
63
64 guard = va_arg (va, const char *);
65 if (0 == strcmp (guard,
66 "seen-set-size"))
68 unsigned int)
69 ,
71 else if (0 == strcmp (guard,
72 "filter-size"))
73 bf_size = va_arg (va, unsigned int);
74 else
75 {
76 GNUNET_break (0);
77 bf_size = 8;
78 }
79 GNUNET_break (NULL == va_arg (va, const char *));
81 bf_size,
83 type,
84 raw_data,
85 raw_data_size);
86}
87
88
102 const struct GNUNET_HashCode *query,
103 const void *xquery,
104 size_t xquery_size)
105{
106 switch (type)
107 {
109 if (0 != xquery_size)
110 {
111 GNUNET_break_op (0);
112 return GNUNET_NO;
113 }
114 return GNUNET_OK;
115 default:
116 GNUNET_break (0);
117 return GNUNET_SYSERR;
118 }
119}
120
121
134 const void *block,
135 size_t block_size)
136{
137 switch (type)
138 {
140 {
141 struct GNUNET_HELLO_Parser *b;
142 const struct GNUNET_PeerIdentity *pid;
143 struct GNUNET_HashCode h_pid;
144
146 block_size);
147 if (NULL == b)
148 {
149 GNUNET_break (0);
150 return GNUNET_NO;
151 }
153 NULL, NULL);
155 sizeof (*pid),
156 &h_pid);
158 return GNUNET_OK;
159 }
160 default:
161 GNUNET_break (0);
162 return GNUNET_SYSERR;
163 }
164}
165
166
185 void *cls,
187 struct GNUNET_BLOCK_Group *group,
188 const struct GNUNET_HashCode *query,
189 const void *xquery,
190 size_t xquery_size,
191 const void *reply_block,
192 size_t reply_block_size)
193{
194 switch (type)
195 {
197 {
198 struct GNUNET_HELLO_Parser *b;
199 const struct GNUNET_PeerIdentity *pid;
200 struct GNUNET_HashCode h_pid;
201
202 b = GNUNET_HELLO_parser_from_block (reply_block,
203 reply_block_size);
204 if (NULL == b)
205 {
207 }
209 NULL, NULL);
211 sizeof (*pid),
212 &h_pid);
214 if (GNUNET_YES ==
216 &h_pid))
219 }
220 default:
222 }
223}
224
225
240 const void *block,
241 size_t block_size,
242 struct GNUNET_HashCode *key)
243{
244 switch (type)
245 {
247 {
248 struct GNUNET_HELLO_Parser *b;
249 const struct GNUNET_PeerIdentity *pid;
250
252 block_size);
253 if (NULL == b)
254 {
255 GNUNET_break (0);
256 memset (key,
257 0,
258 sizeof (*key));
259 return GNUNET_OK;
260 }
262 NULL, NULL);
264 sizeof (*pid),
265 key);
267 return GNUNET_OK;
268 }
269 default:
270 GNUNET_break (0);
271 return GNUNET_SYSERR;
272 }
273}
274
275
276void *
278
282void *
284{
285 static enum GNUNET_BLOCK_Type types[] = {
287 GNUNET_BLOCK_TYPE_ANY /* end of list */
288 };
290
297 api->types = types;
298 return api;
299}
300
301
302void *
304
308void *
310{
311 struct GNUNET_BLOCK_PluginFunctions *api = cls;
312
313 GNUNET_free (api);
314 return NULL;
315}
316
317
318/* end of plugin_block_dht.c */
struct GNUNET_HashCode key
The key used in the DHT.
static uint32_t type
Type string converted to DNS type value.
static struct GNUNET_PeerIdentity pid
Identity of the peer we transmit to / connect to.
API for block plugins.
GNUNET_BLOCK_Type
WARNING: This header is generated! In order to add DHT block types, you must register them in GANA,...
@ GNUNET_BLOCK_TYPE_ANY
Identifier for any block.
@ GNUNET_BLOCK_TYPE_DHT_HELLO
Type of a block that contains a DHT-NG HELLO for a peer.
Helper library for handling HELLO URIs.
enum GNUNET_GenericReturnValue GNUNET_BLOCK_GROUP_bf_test_and_set(struct GNUNET_BLOCK_Group *bg, const struct GNUNET_HashCode *hc)
Test if hc is contained in the Bloom filter of bg.
Definition: bg_bf.c:232
size_t GNUNET_BLOCK_GROUP_compute_bloomfilter_size(unsigned int entry_count, unsigned int k)
How many bytes should a bloomfilter be if we have already seen entry_count responses?...
Definition: bg_bf.c:268
GNUNET_BLOCK_ReplyEvaluationResult
Possible ways for how a block may relate to a query.
struct GNUNET_BLOCK_Group * GNUNET_BLOCK_GROUP_bf_create(void *cls, size_t bf_size, unsigned int bf_k, enum GNUNET_BLOCK_Type type, const void *raw_data, size_t raw_data_size)
Create a new block group that filters duplicates using a Bloom filter.
Definition: bg_bf.c:173
@ GNUNET_BLOCK_REPLY_OK_MORE
Valid result, and there may be more.
@ GNUNET_BLOCK_REPLY_OK_DUPLICATE
Valid result, but suppressed because it is a duplicate.
@ GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED
Specified block type not supported by any plugin.
@ GNUNET_BLOCK_REPLY_IRRELEVANT
Block does not match xquery (valid result, not relevant for the request)
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:41
void GNUNET_HELLO_parser_free(struct GNUNET_HELLO_Parser *parser)
Release resources of a builder.
Definition: hello-uri.c:379
const struct GNUNET_PeerIdentity * GNUNET_HELLO_parser_iterate(const struct GNUNET_HELLO_Parser *parser, GNUNET_HELLO_UriCallback uc, void *uc_cls)
Iterate over URIs in a parser.
Definition: hello-uri.c:975
struct GNUNET_HELLO_Parser * GNUNET_HELLO_parser_from_block(const void *block, size_t block_size)
Parse block.
Definition: hello-uri.c:523
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_OK
@ GNUNET_YES
@ GNUNET_NO
@ GNUNET_SYSERR
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_dht_check_reply(void *cls, enum GNUNET_BLOCK_Type type, struct GNUNET_BLOCK_Group *group, const struct GNUNET_HashCode *query, const void *xquery, size_t xquery_size, const void *reply_block, size_t reply_block_size)
Function called to validate a reply to a request.
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
void * libgnunet_plugin_block_dht_init(void *cls)
Entry point for the plugin.
void * libgnunet_plugin_block_dht_done(void *cls)
Exit point from the plugin.
static enum GNUNET_GenericReturnValue block_plugin_dht_check_query(void *cls, enum GNUNET_BLOCK_Type type, const struct GNUNET_HashCode *query, const void *xquery, size_t xquery_size)
Function called to validate a query.
static struct GNUNET_BLOCK_Group * block_plugin_dht_create_group(void *cls, enum GNUNET_BLOCK_Type type, const void *raw_data, size_t raw_data_size, va_list va)
Create a new block group.
static enum GNUNET_GenericReturnValue block_plugin_dht_get_key(void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size, struct GNUNET_HashCode *key)
Function called to obtain the key for a block.
static enum GNUNET_GenericReturnValue block_plugin_dht_check_block(void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size)
Function called to validate a block for storage.
Block group data.
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
enum GNUNET_BLOCK_Type * types
0-terminated array of block types supported by this plugin.
GNUNET_BLOCK_QueryEvaluationFunction check_query
Check that a query is well-formed.
GNUNET_BLOCK_BlockEvaluationFunction check_block
Check that a block is well-formed.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
GNUNET_BLOCK_ReplyEvaluationFunction check_reply
Check that a reply block matches a query.
GNUNET_BLOCK_GroupCreateFunction create_group
Create a block group to process a bunch of blocks in a shared context (i.e.
void * cls
Closure for all of the callbacks.
Context for parsing HELLOs.
Definition: hello-uri.c:232
A 512-bit hashcode.
The identity of the host (wraps the signing key of the peer).