GNUnet  0.17.6
Macros | Functions
plugin_block_regex.c File Reference

blocks used for regex storage and search More...

#include "platform.h"
#include "gnunet_block_plugin.h"
#include "gnunet_block_group_lib.h"
#include "block_regex.h"
#include "regex_block_lib.h"
#include "gnunet_signatures.h"
Include dependency graph for plugin_block_regex.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 REGEX_BF_SIZE   8
 How big is the BF we use for REGEX blocks? More...
 

Functions

static struct GNUNET_BLOCK_Groupblock_plugin_regex_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_regex_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_regex_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_regex_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...
 
static enum GNUNET_GenericReturnValue block_plugin_regex_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. More...
 
void * libgnunet_plugin_block_regex_init (void *cls)
 Entry point for the plugin. More...
 
void * libgnunet_plugin_block_regex_done (void *cls)
 Exit point from the plugin. More...
 

Detailed Description

blocks used for regex storage and search

Author
Bartlomiej Polot

Definition in file plugin_block_regex.c.

Macro Definition Documentation

◆ BLOOMFILTER_K

#define BLOOMFILTER_K   16

Number of bits we set per entry in the bloomfilter.

Do not change!

Definition at line 38 of file plugin_block_regex.c.

◆ REGEX_BF_SIZE

#define REGEX_BF_SIZE   8

How big is the BF we use for REGEX blocks?

Definition at line 44 of file plugin_block_regex.c.

Function Documentation

◆ block_plugin_regex_create_group()

static struct GNUNET_BLOCK_Group* block_plugin_regex_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 59 of file plugin_block_regex.c.

64 {
65  unsigned int bf_size;
66  const char *guard;
67 
68  guard = va_arg (va, const char *);
69  if (0 == strcmp (guard,
70  "seen-set-size"))
71  bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned
72  int),
74  else if (0 == strcmp (guard,
75  "filter-size"))
76  bf_size = va_arg (va, unsigned int);
77  else
78  {
79  GNUNET_break (0);
80  bf_size = REGEX_BF_SIZE;
81  }
82  GNUNET_break (NULL == va_arg (va, const char *));
83  return GNUNET_BLOCK_GROUP_bf_create (cls,
84  bf_size,
86  type,
87  raw_data,
88  raw_data_size);
89 }
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 REGEX_BF_SIZE
How big is the BF we use for REGEX blocks?
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model

Referenced by libgnunet_plugin_block_regex_init().

Here is the caller graph for this function:

◆ block_plugin_regex_check_query()

static enum GNUNET_GenericReturnValue block_plugin_regex_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 59 of file plugin_block_regex.c.

109 {
110  switch (type)
111  {
113  if (0 != xquery_size)
114  {
115  const char *s;
116 
117  s = (const char *) xquery;
118  if ('\0' != s[xquery_size - 1]) /* must be valid 0-terminated string */
119  {
120  GNUNET_break_op (0);
121  return GNUNET_NO;
122  }
123  }
124  return GNUNET_OK;
126  if (0 != xquery_size)
127  {
128  GNUNET_break_op (0);
129  return GNUNET_NO;
130  }
131  return GNUNET_OK;
132  default:
133  GNUNET_break (0);
134  return GNUNET_SYSERR;
135  }
136 }
@ GNUNET_BLOCK_TYPE_REGEX_ACCEPT
Block to store a cadet regex accepting state.
@ GNUNET_BLOCK_TYPE_REGEX
Block to store a cadet regex state.
@ GNUNET_OK
Definition: gnunet_common.h:99
@ GNUNET_NO
Definition: gnunet_common.h:98
@ 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_regex_init().

Here is the caller graph for this function:

◆ block_plugin_regex_check_block()

static enum GNUNET_GenericReturnValue block_plugin_regex_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 59 of file plugin_block_regex.c.

153 {
154  switch (type)
155  {
157  if (GNUNET_SYSERR ==
158  REGEX_BLOCK_check (block,
159  block_size,
160  NULL,
161  NULL))
162  return GNUNET_NO;
163  return GNUNET_OK;
165  {
166  const struct RegexAcceptBlock *rba;
167 
168  if (sizeof(struct RegexAcceptBlock) != block_size)
169  {
170  GNUNET_break_op (0);
171  return GNUNET_NO;
172  }
173  rba = block;
174  if (ntohl (rba->purpose.size) !=
175  sizeof(struct GNUNET_CRYPTO_EccSignaturePurpose)
176  + sizeof(struct GNUNET_TIME_AbsoluteNBO)
177  + sizeof(struct GNUNET_HashCode))
178  {
179  GNUNET_break_op (0);
180  return GNUNET_NO;
181  }
183  rba->expiration_time)))
184  {
185  return GNUNET_NO;
186  }
187  if (GNUNET_OK !=
189  &rba->purpose,
190  &rba->signature,
191  &rba->peer.public_key))
192  {
193  GNUNET_break_op (0);
194  return GNUNET_NO;
195  }
196  return GNUNET_OK;
197  }
198  default:
199  GNUNET_break (0);
200  return GNUNET_SYSERR;
201  }
202 }
#define GNUNET_SIGNATURE_PURPOSE_REGEX_ACCEPT
Accept state in regex DFA.
enum GNUNET_GenericReturnValue GNUNET_CRYPTO_eddsa_verify_(uint32_t purpose, const struct GNUNET_CRYPTO_EccSignaturePurpose *validate, const struct GNUNET_CRYPTO_EddsaSignature *sig, const struct GNUNET_CRYPTO_EddsaPublicKey *pub)
Verify EdDSA signature.
Definition: crypto_ecc.c:702
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_ntoh(struct GNUNET_TIME_AbsoluteNBO a)
Convert absolute time from network byte order.
Definition: time.c:736
bool GNUNET_TIME_absolute_is_past(struct GNUNET_TIME_Absolute abs)
Test if abs is truly in the past (excluding now).
Definition: time.c:668
int REGEX_BLOCK_check(const struct RegexBlock *block, size_t size, const struct GNUNET_HashCode *query, const char *xquery)
Check if the regex block is well formed, including all edges.
header of what an ECC signature signs this must be followed by "size - 8" bytes of the actual signed ...
uint32_t size
How many bytes does this signature sign? (including this purpose header); in network byte order (!...
A 512-bit hashcode.
struct GNUNET_CRYPTO_EddsaPublicKey public_key
Time for absolute time used by GNUnet, in microseconds and in network byte order.
Block to announce a peer accepting a state.
Definition: block_regex.h:50
struct GNUNET_TIME_AbsoluteNBO expiration_time
When does the signature expire?
Definition: block_regex.h:60
struct GNUNET_CRYPTO_EccSignaturePurpose purpose
Accept blocks must be signed.
Definition: block_regex.h:55
struct GNUNET_CRYPTO_EddsaSignature signature
The signature.
Definition: block_regex.h:75
struct GNUNET_PeerIdentity peer
Public key of the peer signing.
Definition: block_regex.h:70

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

Referenced by libgnunet_plugin_block_regex_init().

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

◆ block_plugin_regex_check_reply()

static enum GNUNET_BLOCK_ReplyEvaluationResult block_plugin_regex_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 59 of file plugin_block_regex.c.

231 {
232  struct GNUNET_HashCode chash;
233 
234  switch (type)
235  {
237  if (0 != xquery_size)
238  {
239  const char *s;
240 
241  s = (const char *) xquery;
242  GNUNET_assert ('\0' == s[xquery_size - 1]);
243  }
244  switch (REGEX_BLOCK_check (reply_block,
245  reply_block_size,
246  query,
247  xquery))
248  {
249  case GNUNET_SYSERR:
250  GNUNET_assert (0);
251  case GNUNET_NO:
252  /* xquery mismatch, can happen */
254  default:
255  break;
256  }
257  GNUNET_CRYPTO_hash (reply_block,
258  reply_block_size,
259  &chash);
260  if (GNUNET_YES ==
262  &chash))
266  {
267  const struct RegexAcceptBlock *rba;
268 
269  GNUNET_assert (sizeof(struct RegexAcceptBlock) == reply_block_size);
270  rba = reply_block;
271  GNUNET_assert (ntohl (rba->purpose.size) ==
272  sizeof(struct GNUNET_CRYPTO_EccSignaturePurpose)
273  + sizeof(struct GNUNET_TIME_AbsoluteNBO)
274  + sizeof(struct GNUNET_HashCode));
275  GNUNET_CRYPTO_hash (reply_block,
276  reply_block_size,
277  &chash);
278  if (GNUNET_YES ==
280  &chash))
283  }
284  default:
285  GNUNET_break (0);
287  }
289 }
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.
@ 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
@ GNUNET_YES
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.

Referenced by libgnunet_plugin_block_regex_init().

Here is the caller graph for this function:

◆ block_plugin_regex_get_key()

static enum GNUNET_GenericReturnValue block_plugin_regex_get_key ( void *  cls,
enum GNUNET_BLOCK_Type  type,
const void *  block,
size_t  block_size,
struct GNUNET_HashCode key 
)
static

Function called to obtain the key for a block.

Parameters
clsclosure
typeblock type
blockblock to get the key for
block_sizenumber of bytes in 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 59 of file plugin_block_regex.c.

309 {
310  switch (type)
311  {
313  if (GNUNET_OK !=
314  REGEX_BLOCK_get_key (block,
315  block_size,
316  key))
317  {
318  GNUNET_break_op (0);
319  memset (key,
320  0,
321  sizeof (*key));
322  return GNUNET_OK;
323  }
324  return GNUNET_OK;
326  if (sizeof(struct RegexAcceptBlock) != block_size)
327  {
328  GNUNET_break_op (0);
329  memset (key,
330  0,
331  sizeof (*key));
332  return GNUNET_OK;
333  }
334  *key = ((struct RegexAcceptBlock *) block)->key;
335  return GNUNET_OK;
336  default:
337  GNUNET_break (0);
338  return GNUNET_SYSERR;
339  }
340 }
struct GNUNET_HashCode key
The key used in the DHT.
int REGEX_BLOCK_get_key(const struct RegexBlock *block, size_t block_len, struct GNUNET_HashCode *key)
Obtain the key that a particular block is to be stored under.

Referenced by libgnunet_plugin_block_regex_init().

Here is the caller graph for this function:

◆ libgnunet_plugin_block_regex_init()

void* libgnunet_plugin_block_regex_init ( void *  cls)

Entry point for the plugin.

Definition at line 347 of file plugin_block_regex.c.

348 {
349  static const enum GNUNET_BLOCK_Type types[] = {
352  GNUNET_BLOCK_TYPE_ANY /* end of list */
353  };
354  struct GNUNET_BLOCK_PluginFunctions *api;
355 
362  api->types = types;
363  return api;
364 }
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_GenericReturnValue block_plugin_regex_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 struct GNUNET_BLOCK_Group * block_plugin_regex_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_BLOCK_ReplyEvaluationResult block_plugin_regex_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_regex_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_regex_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.
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_regex_check_block(), block_plugin_regex_check_query(), block_plugin_regex_check_reply(), block_plugin_regex_create_group(), block_plugin_regex_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_REGEX, GNUNET_BLOCK_TYPE_REGEX_ACCEPT, GNUNET_new, and GNUNET_BLOCK_PluginFunctions::types.

Here is the call graph for this function:

◆ libgnunet_plugin_block_regex_done()

void* libgnunet_plugin_block_regex_done ( void *  cls)

Exit point from the plugin.

Definition at line 371 of file plugin_block_regex.c.

372 {
373  struct GNUNET_BLOCK_PluginFunctions *api = cls;
374 
375  GNUNET_free (api);
376  return NULL;
377 }
#define GNUNET_free(ptr)
Wrapper around free.
void * cls
Closure for all of the callbacks.

References GNUNET_BLOCK_PluginFunctions::cls, and GNUNET_free.