GNUnet  0.10.x
plugin_block_regex.c
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet
3  Copyright (C) 2013 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 
26 #include "platform.h"
27 #include "gnunet_block_plugin.h"
28 #include "gnunet_block_group_lib.h"
29 #include "block_regex.h"
30 #include "regex_block_lib.h"
31 #include "gnunet_signatures.h"
32 
33 
38 #define BLOOMFILTER_K 16
39 
40 
44 #define REGEX_BF_SIZE 8
45 
46 
59 static struct GNUNET_BLOCK_Group *
62  uint32_t nonce,
63  const void *raw_data,
64  size_t raw_data_size,
65  va_list va)
66 {
67  unsigned int bf_size;
68  const char *guard;
69 
70  guard = va_arg(va, const char *);
71  if (0 == strcmp(guard,
72  "seen-set-size"))
73  bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size(va_arg(va, unsigned int),
75  else if (0 == strcmp(guard,
76  "filter-size"))
77  bf_size = va_arg(va, unsigned int);
78  else
79  {
80  GNUNET_break(0);
81  bf_size = REGEX_BF_SIZE;
82  }
83  GNUNET_break(NULL == va_arg(va, const char *));
85  bf_size,
87  type,
88  nonce,
89  raw_data,
90  raw_data_size);
91 }
92 
93 
115  enum GNUNET_BLOCK_Type type,
116  struct GNUNET_BLOCK_Group *bg,
118  const struct GNUNET_HashCode *query,
119  const void *xquery,
120  size_t xquery_size,
121  const void *reply_block,
122  size_t reply_block_size)
123 {
124  struct GNUNET_HashCode chash;
125 
126  if (NULL == reply_block)
127  {
128  if (0 != xquery_size)
129  {
130  const char *s;
131 
132  s = (const char *)xquery;
133  if ('\0' != s[xquery_size - 1]) /* must be valid 0-terminated string */
134  {
135  GNUNET_break_op(0);
137  }
138  }
140  }
141  if (0 != xquery_size)
142  {
143  const char *s;
144 
145  s = (const char *)xquery;
146  if ('\0' != s[xquery_size - 1]) /* must be valid 0-terminated string */
147  {
148  GNUNET_break_op(0);
150  }
151  }
152  else if (NULL != query)
153  {
154  /* xquery is required for regex GETs, at least an empty string */
155  GNUNET_break_op(0);
156  GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "type %d, query %p, xquery %p\n",
157  type, query, xquery);
159  }
160  switch (REGEX_BLOCK_check(reply_block,
161  reply_block_size,
162  query,
163  xquery))
164  {
165  case GNUNET_SYSERR:
166  GNUNET_break_op(0);
168 
169  case GNUNET_NO:
170  /* xquery missmatch, can happen */
172 
173  default:
174  break;
175  }
176  GNUNET_CRYPTO_hash(reply_block,
177  reply_block_size,
178  &chash);
179  if (GNUNET_YES ==
181  &chash))
184 }
185 
186 
208  enum GNUNET_BLOCK_Type type,
209  struct GNUNET_BLOCK_Group *bg,
211  const struct GNUNET_HashCode *query,
212  const void *xquery,
213  size_t xquery_size, const void *reply_block,
214  size_t reply_block_size)
215 {
216  const struct RegexAcceptBlock *rba;
217  struct GNUNET_HashCode chash;
218 
219  if (0 != xquery_size)
220  {
221  GNUNET_break_op(0);
223  }
224  if (NULL == reply_block)
226  if (sizeof(struct RegexAcceptBlock) != reply_block_size)
227  {
228  GNUNET_break_op(0);
230  }
231  rba = reply_block;
232  if (ntohl(rba->purpose.size) !=
233  sizeof(struct GNUNET_CRYPTO_EccSignaturePurpose) +
234  sizeof(struct GNUNET_TIME_AbsoluteNBO) +
235  sizeof(struct GNUNET_HashCode))
236  {
237  GNUNET_break_op(0);
239  }
241  {
242  /* technically invalid, but can happen without an error, so
243  we're nice by reporting it as a 'duplicate' */
245  }
246  if (GNUNET_OK !=
248  &rba->purpose,
249  &rba->signature,
250  &rba->peer.public_key))
251  {
252  GNUNET_break_op(0);
254  }
255  GNUNET_CRYPTO_hash(reply_block,
256  reply_block_size,
257  &chash);
258  if (GNUNET_YES ==
260  &chash))
263 }
264 
265 
287  struct GNUNET_BLOCK_Context *ctx,
288  enum GNUNET_BLOCK_Type type,
289  struct GNUNET_BLOCK_Group *bg,
291  const struct GNUNET_HashCode *query,
292  const void *xquery,
293  size_t xquery_size,
294  const void *reply_block,
295  size_t reply_block_size)
296 {
298 
299  switch (type)
300  {
302  result = evaluate_block_regex(cls,
303  type,
304  bg,
305  eo,
306  query,
307  xquery, xquery_size,
308  reply_block, reply_block_size);
309  break;
310 
312  result = evaluate_block_regex_accept(cls,
313  type,
314  bg,
315  eo,
316  query,
317  xquery, xquery_size,
318  reply_block, reply_block_size);
319  break;
320 
321  default:
323  }
324  return result;
325 }
326 
327 
339 static int
341  enum GNUNET_BLOCK_Type type,
342  const void *block,
343  size_t block_size,
344  struct GNUNET_HashCode *key)
345 {
346  switch (type)
347  {
349  if (GNUNET_OK !=
350  REGEX_BLOCK_get_key(block, block_size,
351  key))
352  {
353  GNUNET_break_op(0);
354  return GNUNET_NO;
355  }
356  return GNUNET_OK;
357 
359  if (sizeof(struct RegexAcceptBlock) != block_size)
360  {
361  GNUNET_break_op(0);
362  return GNUNET_NO;
363  }
364  *key = ((struct RegexAcceptBlock *)block)->key;
365  return GNUNET_OK;
366 
367  default:
368  GNUNET_break(0);
369  return GNUNET_SYSERR;
370  }
371 }
372 
373 
377 void *
379 {
380  static enum GNUNET_BLOCK_Type types[] =
381  {
384  GNUNET_BLOCK_TYPE_ANY /* end of list */
385  };
386  struct GNUNET_BLOCK_PluginFunctions *api;
387 
392  api->types = types;
393  return api;
394 }
395 
396 
400 void *
402 {
403  struct GNUNET_BLOCK_PluginFunctions *api = cls;
404 
405  GNUNET_free(api);
406  return NULL;
407 }
408 
409 /* end of plugin_block_regex.c */
Block does not match query (invalid result)
Block to store a cadet regex accepting state.
Handle to an initialized block library.
Definition: block.c:53
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_ntoh(struct GNUNET_TIME_AbsoluteNBO a)
Convert absolute time from network byte order.
Definition: time.c:671
uint64_t rel_value_us
The actual value.
enum GNUNET_BLOCK_Type * types
0-terminated array of block types supported by this plugin.
static int 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.
Any type of block, used as a wildcard when searching.
GNUNET_BLOCK_EvaluationFunction evaluate
Main function of a block plugin.
GNUNET_BLOCK_Type
Blocks in the datastore and the datacache must have a unique type.
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.
struct GNUNET_CRYPTO_EddsaSignature signature
The signature.
Definition: block_regex.h:74
static struct GNUNET_BLOCK_Group * block_plugin_regex_create_group(void *cls, enum GNUNET_BLOCK_Type type, uint32_t nonce, const void *raw_data, size_t raw_data_size, va_list va)
Create a new block group.
struct GNUNET_BLOCK_Group * GNUNET_BLOCK_GROUP_bf_create(void *cls, size_t bf_size, unsigned int bf_k, enum GNUNET_BLOCK_Type type, uint32_t nonce, 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
Each plugin is required to return a pointer to a struct of this type as the return value from its ent...
Block does not match xquery (valid result, not relevant for the request)
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Block to announce a peer accepting a state.
Definition: block_regex.h:49
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? Sized so that do not have to re-size the filter too often (to keep it cheap).
Definition: bg_bf.c:248
static enum GNUNET_BLOCK_EvaluationResult evaluate_block_regex_accept(void *cls, enum GNUNET_BLOCK_Type type, struct GNUNET_BLOCK_Group *bg, enum GNUNET_BLOCK_EvaluationOptions eo, 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 or a request of type GNUNET_BLOCK_TYPE_REGEX_ACCEPT.
Time for absolute time used by GNUnet, in microseconds and in network byte order. ...
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
static struct GNUNET_DNSSTUB_Context * ctx
Context for DNS resolution.
struct GNUNET_PeerIdentity peer
Public key of the peer signing.
Definition: block_regex.h:69
header of what an ECC signature signs this must be followed by "size - 8" bytes of the actual signed ...
int 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:1116
Valid result, but suppressed because it is a duplicate.
static enum GNUNET_BLOCK_EvaluationResult block_plugin_regex_evaluate(void *cls, struct GNUNET_BLOCK_Context *ctx, enum GNUNET_BLOCK_Type type, struct GNUNET_BLOCK_Group *bg, enum GNUNET_BLOCK_EvaluationOptions eo, 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 or a request.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:44
static int result
Global testing status.
uint32_t size
How many bytes does this signature sign? (including this purpose header); in network byte order (!)...
struct GNUNET_CRYPTO_EccSignaturePurpose purpose
Accept blocks must be signed.
Definition: block_regex.h:54
A 512-bit hashcode.
Valid result, and there may be more.
struct GNUNET_HashCode key
The key used in the DHT.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
GNUNET_BLOCK_GroupCreateFunction create_group
Create a block group to process a bunch of blocks in a shared context (i.e.
GNUNET_BLOCK_EvaluationResult
Possible ways for how a block may relate to a query.
static enum GNUNET_BLOCK_EvaluationResult evaluate_block_regex(void *cls, enum GNUNET_BLOCK_Type type, struct GNUNET_BLOCK_Group *bg, enum GNUNET_BLOCK_EvaluationOptions eo, 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 or a request of type GNUNET_BLOCK_TYPE_REGEX. ...
Specified block type not supported by this plugin.
void * libgnunet_plugin_block_regex_done(void *cls)
Exit point from the plugin.
GNUNET_BLOCK_GetKeyFunction get_key
Obtain the key for a given block (if possible).
#define GNUNET_SIGNATURE_PURPOSE_REGEX_ACCEPT
Accept state in regex DFA.
Query format does not match block type (invalid query).
common function to manipulate blocks stored by regex in the DHT
#define GNUNET_log(kind,...)
#define BLOOMFILTER_K
Number of bits we set per entry in the bloomfilter.
Block group data.
void * libgnunet_plugin_block_regex_init(void *cls)
Entry point for the plugin.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
#define GNUNET_YES
Definition: gnunet_common.h:77
#define REGEX_BF_SIZE
How big is the BF we use for REGEX blocks?
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.
Block to store a cadet regex state.
int 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:212
void * cls
Closure for all of the callbacks.
GNUNET_BLOCK_EvaluationOptions
Flags that can be set to control the evaluation.
Query is valid, no reply given.
regex block formats
#define GNUNET_free(ptr)
Wrapper around free.
struct GNUNET_CRYPTO_EddsaPublicKey public_key
struct GNUNET_TIME_AbsoluteNBO expiration_time
When does the signature expire?
Definition: block_regex.h:59