GNUnet  0.19.2
plugin_block_gns.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2010-2013, 2021, 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_block_group_lib.h"
30 #include "gnunet_block_plugin.h"
32 #include "gnunet_signatures.h"
33 
38 #define BLOOMFILTER_K 16
39 
43 #define GNS_BF_SIZE 8
44 
45 
57 static struct GNUNET_BLOCK_Group *
60  const void *raw_data,
61  size_t raw_data_size,
62  va_list va)
63 {
64  unsigned int bf_size;
65  const char *guard;
66 
67  guard = va_arg (va, const char *);
68  if (0 == strcmp (guard,
69  "seen-set-size"))
70  bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned
71  int),
73  else if (0 == strcmp (guard,
74  "filter-size"))
75  bf_size = va_arg (va, unsigned int);
76  else
77  {
78  GNUNET_break (0);
79  bf_size = GNS_BF_SIZE;
80  }
81  GNUNET_break (NULL == va_arg (va, const char *));
82  return GNUNET_BLOCK_GROUP_bf_create (cls,
83  bf_size,
85  type,
86  raw_data,
87  raw_data_size);
88 }
89 
90 
103 static enum GNUNET_GenericReturnValue
104 block_plugin_gns_get_key (void *cls,
105  enum GNUNET_BLOCK_Type type,
106  const void *reply_block,
107  size_t reply_block_size,
108  struct GNUNET_HashCode *key)
109 {
110  const struct GNUNET_GNSRECORD_Block *block;
111 
113  {
114  GNUNET_break (0);
115  return GNUNET_SYSERR;
116  }
117  if (reply_block_size < sizeof(struct GNUNET_GNSRECORD_Block))
118  {
119  GNUNET_break_op (0);
120  memset (key,
121  0,
122  sizeof (*key));
123  return GNUNET_OK;
124  }
125  block = reply_block;
127  key);
128  return GNUNET_OK;
129 }
130 
131 
142 static enum GNUNET_GenericReturnValue
144  enum GNUNET_BLOCK_Type type,
145  const struct GNUNET_HashCode *query,
146  const void *xquery,
147  size_t xquery_size)
148 {
150  {
151  GNUNET_break (0);
152  return GNUNET_SYSERR;
153  }
154  if (0 != xquery_size)
155  {
156  GNUNET_break_op (0);
157  return GNUNET_NO;
158  }
159  return GNUNET_OK;
160 }
161 
162 
172 static enum GNUNET_GenericReturnValue
174  enum GNUNET_BLOCK_Type type,
175  const void *block,
176  size_t block_size)
177 {
178  const struct GNUNET_GNSRECORD_Block *gblock;
179 
181  {
182  GNUNET_break (0);
183  return GNUNET_SYSERR;
184  }
185  if (block_size < sizeof(struct GNUNET_GNSRECORD_Block))
186  {
187  GNUNET_break_op (0);
188  return GNUNET_NO;
189  }
190  gblock = block;
191  if (GNUNET_GNSRECORD_block_get_size (gblock) > block_size)
192  {
193  GNUNET_break_op (0);
194  return GNUNET_NO;
195  }
196  if (GNUNET_OK !=
198  {
199  GNUNET_break_op (0);
200  return GNUNET_NO;
201  }
202  return GNUNET_OK;
203 }
204 
205 
224  enum GNUNET_BLOCK_Type type,
225  struct GNUNET_BLOCK_Group *group,
226  const struct GNUNET_HashCode *query,
227  const void *xquery,
228  size_t xquery_size,
229  const void *reply_block,
230  size_t reply_block_size)
231 {
232  const struct GNUNET_GNSRECORD_Block *block = reply_block;
233  struct GNUNET_HashCode chash;
234 
236  {
237  GNUNET_break (0);
239  }
240  GNUNET_assert (reply_block_size >= sizeof(struct GNUNET_GNSRECORD_Block));
241  GNUNET_assert (reply_block_size >= GNUNET_GNSRECORD_block_get_size (block));
242  GNUNET_CRYPTO_hash (reply_block,
243  reply_block_size,
244  &chash);
245  if (GNUNET_YES ==
247  &chash))
250 }
251 
252 
256 void *
258 {
259  static const enum GNUNET_BLOCK_Type types[] = {
261  GNUNET_BLOCK_TYPE_ANY /* end of list */
262  };
263  struct GNUNET_BLOCK_PluginFunctions *api;
264 
271  api->types = types;
272  return api;
273 }
274 
275 
279 void *
281 {
282  struct GNUNET_BLOCK_PluginFunctions *api = cls;
283 
284  GNUNET_free (api);
285  return NULL;
286 }
287 
288 
289 /* end of plugin_block_gns.c */
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_GNS_NAMERECORD
Block for storing GNS record data.
struct GNUNET_HashCode key
The key used in the DHT.
API for block plugins.
API that can be used to store naming information on a GNUnet node;.
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.
enum GNUNET_GenericReturnValue GNUNET_GNSRECORD_block_verify(const struct GNUNET_GNSRECORD_Block *block)
Check if a signature is valid.
size_t GNUNET_GNSRECORD_block_get_size(const struct GNUNET_GNSRECORD_Block *block)
Returns the length of this block in bytes.
enum GNUNET_GenericReturnValue GNUNET_GNSRECORD_query_from_block(const struct GNUNET_GNSRECORD_Block *block, struct GNUNET_HashCode *query)
Builds the query hash from a block.
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
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_assert(cond)
Use this for fatal errors that cannot be handled.
#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_gns_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.
static enum GNUNET_GenericReturnValue block_plugin_gns_check_block(void *cls, enum GNUNET_BLOCK_Type type, const void *block, size_t block_size)
Function called to validate a block for storage.
void * libgnunet_plugin_block_gns_done(void *cls)
Exit point from the plugin.
static enum GNUNET_GenericReturnValue block_plugin_gns_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.
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
void * libgnunet_plugin_block_gns_init(void *cls)
Entry point for the plugin.
static struct GNUNET_BLOCK_Group * block_plugin_gns_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_gns_get_key(void *cls, enum GNUNET_BLOCK_Type type, const void *reply_block, size_t reply_block_size, struct GNUNET_HashCode *key)
Function called to obtain the key for a block.
#define GNS_BF_SIZE
How big is the BF we use for GNS blocks?
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.
A 512-bit hashcode.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model