GNUnet  0.17.6
Macros | Functions
plugin_block_gns.c File Reference

blocks used for GNS records More...

#include "platform.h"
#include "gnunet_block_group_lib.h"
#include "gnunet_block_plugin.h"
#include "gnunet_namestore_service.h"
#include "gnunet_signatures.h"
Include dependency graph for plugin_block_gns.c:

Go to the source code of this file.

Macros

#define BLOOMFILTER_K   16
 Number of bits we set per entry in the bloomfilter. More...
 
#define GNS_BF_SIZE   8
 How big is the BF we use for GNS blocks? More...
 

Functions

static struct GNUNET_BLOCK_Groupblock_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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void * libgnunet_plugin_block_gns_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_block_gns_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

blocks used for GNS records

Author
Martin Schanzenbach
Christian Grothoff

Definition in file plugin_block_gns.c.

Macro Definition Documentation

◆ BLOOMFILTER_K

#define BLOOMFILTER_K   16

Number of bits we set per entry in the bloomfilter.

Do not change! -from fs

Definition at line 38 of file plugin_block_gns.c.

◆ GNS_BF_SIZE

#define GNS_BF_SIZE   8

How big is the BF we use for GNS blocks?

Definition at line 43 of file plugin_block_gns.c.

Function Documentation

◆ block_plugin_gns_create_group()

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 
)
static

Create a new block group.

Parameters
ctxblock context in which the block group is created
typetype of the block for which we are creating the group
raw_dataoptional serialized prior state of the group, NULL if unavailable/fresh
raw_data_sizenumber of bytes in raw_data, 0 if unavailable/fresh
vavariable arguments specific to type
Returns
block group handle, NULL if block groups are not supported by this type of block (this is not an error)

Definition at line 58 of file plugin_block_gns.c.

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 }
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
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
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur.
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
#define GNS_BF_SIZE
How big is the BF we use for GNS blocks?
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model

Referenced by libgnunet_plugin_block_gns_init().

Here is the caller graph for this function:

◆ block_plugin_gns_get_key()

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 
)
static

Function called to obtain the key for a block.

If the block is malformed, the function should zero-out key and return GNUNET_OK.

Parameters
clsclosure
typeblock type
reply_blockblock to get the key for
reply_block_sizenumber of bytes in reply_block
keyset to the key (query) for the given block
Returns
GNUNET_OK on success, GNUNET_SYSERR if type not supported, GNUNET_NO if extracting a key from a block of this type does not work

Definition at line 58 of file plugin_block_gns.c.

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 }
@ GNUNET_BLOCK_TYPE_GNS_NAMERECORD
Block for storing GNS record data.
struct GNUNET_HashCode key
The key used in the DHT.
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.
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_SYSERR
Definition: gnunet_common.h:97
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.

Referenced by libgnunet_plugin_block_gns_init().

Here is the caller graph for this function:

◆ block_plugin_gns_check_query()

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 
)
static

Function called to validate a query.

Parameters
clsclosure
ctxblock context
typeblock type
queryoriginal query (hash)
xqueryextrended query data (can be NULL, depending on type)
xquery_sizenumber of bytes in xquery
Returns
GNUNET_OK if the query is fine, GNUNET_NO if not

Definition at line 58 of file plugin_block_gns.c.

149 {
151  {
152  GNUNET_break (0);
153  return GNUNET_SYSERR;
154  }
155  if (0 != xquery_size)
156  {
157  GNUNET_break_op (0);
158  return GNUNET_NO;
159  }
160  return GNUNET_OK;
161 }
@ GNUNET_NO
Definition: gnunet_common.h:98

Referenced by libgnunet_plugin_block_gns_init().

Here is the caller graph for this function:

◆ block_plugin_gns_check_block()

static enum GNUNET_GenericReturnValue block_plugin_gns_check_block ( void *  cls,
enum GNUNET_BLOCK_Type  type,
const void *  block,
size_t  block_size 
)
static

Function called to validate a block for storage.

Parameters
clsclosure
typeblock type
blockblock data to validate
block_sizenumber of bytes in block
Returns
GNUNET_OK if the block is fine, GNUNET_NO if not

Definition at line 58 of file plugin_block_gns.c.

178 {
179  const struct GNUNET_GNSRECORD_Block *gblock;
180 
182  {
183  GNUNET_break (0);
184  return GNUNET_SYSERR;
185  }
186  if (block_size < sizeof(struct GNUNET_GNSRECORD_Block))
187  {
188  GNUNET_break_op (0);
189  return GNUNET_NO;
190  }
191  gblock = block;
192  if (GNUNET_GNSRECORD_block_get_size (gblock) > block_size)
193  {
194  GNUNET_break_op (0);
195  return GNUNET_NO;
196  }
197  if (GNUNET_OK !=
199  {
200  GNUNET_break_op (0);
201  return GNUNET_NO;
202  }
203  return GNUNET_OK;
204 }
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.

References BLOOMFILTER_K, GNS_BF_SIZE, GNUNET_BLOCK_GROUP_bf_create(), GNUNET_BLOCK_GROUP_compute_bloomfilter_size(), GNUNET_break, and type.

Referenced by libgnunet_plugin_block_gns_init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ block_plugin_gns_check_reply()

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 
)
static

Function called to validate a reply to a request.

Note that it is assumed that the reply has already been matched to the key (and signatures checked) as it would be done with the GetKeyFunction and the BlockEvaluationFunction.

Parameters
clsclosure
typeblock type
groupwhich block group to use for evaluation
queryoriginal query (hash)
xqueryextrended query data (can be NULL, depending on type)
xquery_sizenumber of bytes in xquery
reply_blockresponse to validate
reply_block_sizenumber of bytes in reply_block
Returns
characterization of result

Definition at line 58 of file plugin_block_gns.c.

232 {
233  const struct GNUNET_GNSRECORD_Block *block = reply_block;
234  struct GNUNET_HashCode chash;
235 
237  {
238  GNUNET_break (0);
240  }
241  GNUNET_assert (reply_block_size >= sizeof(struct GNUNET_GNSRECORD_Block));
242  GNUNET_assert (reply_block_size >= GNUNET_GNSRECORD_block_get_size (block));
243  GNUNET_CRYPTO_hash (reply_block,
244  reply_block_size,
245  &chash);
246  if (GNUNET_YES ==
248  &chash))
251 }
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
@ 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.
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_YES
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
A 512-bit hashcode.

Referenced by libgnunet_plugin_block_gns_init().

Here is the caller graph for this function:

◆ libgnunet_plugin_block_gns_init()

void* libgnunet_plugin_block_gns_init ( void *  cls)

Entry point for the plugin.

Definition at line 258 of file plugin_block_gns.c.

259 {
260  static const enum GNUNET_BLOCK_Type types[] = {
262  GNUNET_BLOCK_TYPE_ANY /* end of list */
263  };
264  struct GNUNET_BLOCK_PluginFunctions *api;
265 
272  api->types = types;
273  return api;
274 }
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.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
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.
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.
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.
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.

References block_plugin_gns_check_block(), block_plugin_gns_check_query(), block_plugin_gns_check_reply(), block_plugin_gns_create_group(), block_plugin_gns_get_key(), GNUNET_BLOCK_PluginFunctions::check_block, GNUNET_BLOCK_PluginFunctions::check_query, GNUNET_BLOCK_PluginFunctions::check_reply, GNUNET_BLOCK_PluginFunctions::create_group, GNUNET_BLOCK_PluginFunctions::get_key, GNUNET_BLOCK_TYPE_ANY, GNUNET_BLOCK_TYPE_GNS_NAMERECORD, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

Here is the call graph for this function:

◆ libgnunet_plugin_block_gns_done()

void* libgnunet_plugin_block_gns_done ( void *  cls)

Exit point from the plugin.

Definition at line 281 of file plugin_block_gns.c.

282 {
283  struct GNUNET_BLOCK_PluginFunctions *api = cls;
284 
285  GNUNET_free (api);
286  return NULL;
287 }
#define GNUNET_free(ptr)
Wrapper around free.
void * cls
Closure for all of the callbacks.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.