2 This file is part of GNUnet
3 Copyright (C) 2013 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file regex/plugin_block_regex.c
23 * @brief blocks used for regex storage and search
24 * @author Bartlomiej Polot
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"
35 * Number of bits we set per entry in the bloomfilter.
38 #define BLOOMFILTER_K 16
42 * How big is the BF we use for REGEX blocks?
44 #define REGEX_BF_SIZE 8
48 * Create a new block group.
50 * @param ctx block context in which the block group is created
51 * @param type type of the block for which we are creating the group
52 * @param nonce random value used to seed the group creation
53 * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
54 * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
55 * @param va variable arguments specific to @a type
56 * @return block group handle, NULL if block groups are not supported
57 * by this @a type of block (this is not an error)
59 static struct GNUNET_BLOCK_Group *
60 block_plugin_regex_create_group (void *cls,
61 enum GNUNET_BLOCK_Type type,
70 guard = va_arg (va, const char *);
71 if (0 == strcmp (guard,
73 bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned
76 else if (0 == strcmp (guard,
78 bf_size = va_arg (va, unsigned int);
82 bf_size = REGEX_BF_SIZE;
84 GNUNET_break (NULL == va_arg (va, const char *));
85 return GNUNET_BLOCK_GROUP_bf_create (cls,
96 * Function called to validate a reply or a request of type
97 * #GNUNET_BLOCK_TYPE_REGEX.
98 * For request evaluation, pass "NULL" for the reply_block.
99 * Note that it is assumed that the reply has already been
100 * matched to the key (and signatures checked) as it would
101 * be done with the #GNUNET_BLOCK_get_key() function.
104 * @param type block type
105 * @param bg block group to evaluate against
106 * @param eo control flags
107 * @param query original query (hash)
108 * @param xquery extrended query data (can be NULL, depending on type)
109 * @param xquery_size number of bytes in @a xquery
110 * @param reply_block response to validate
111 * @param reply_block_size number of bytes in @a reply_block
112 * @return characterization of result
114 static enum GNUNET_BLOCK_EvaluationResult
115 evaluate_block_regex (void *cls,
116 enum GNUNET_BLOCK_Type type,
117 struct GNUNET_BLOCK_Group *bg,
118 enum GNUNET_BLOCK_EvaluationOptions eo,
119 const struct GNUNET_HashCode *query,
122 const void *reply_block,
123 size_t reply_block_size)
125 struct GNUNET_HashCode chash;
127 if (NULL == reply_block)
129 if (0 != xquery_size)
133 s = (const char *) xquery;
134 if ('\0' != s[xquery_size - 1]) /* must be valid 0-terminated string */
137 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
140 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
142 if (0 != xquery_size)
146 s = (const char *) xquery;
147 if ('\0' != s[xquery_size - 1]) /* must be valid 0-terminated string */
150 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
153 else if (NULL != query)
155 /* xquery is required for regex GETs, at least an empty string */
157 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "type %d, query %p, xquery %p\n",
158 type, query, xquery);
159 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
161 switch (REGEX_BLOCK_check (reply_block,
168 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
171 /* xquery missmatch, can happen */
172 return GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT;
177 GNUNET_CRYPTO_hash (reply_block,
181 GNUNET_BLOCK_GROUP_bf_test_and_set (bg,
183 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
184 return GNUNET_BLOCK_EVALUATION_OK_MORE;
189 * Function called to validate a reply or a request of type
190 * #GNUNET_BLOCK_TYPE_REGEX_ACCEPT.
191 * For request evaluation, pass "NULL" for the reply_block.
192 * Note that it is assumed that the reply has already been
193 * matched to the key (and signatures checked) as it would
194 * be done with the #GNUNET_BLOCK_get_key() function.
197 * @param type block type
198 * @param bg block group to evaluate against
199 * @param eo control flags
200 * @param query original query (hash)
201 * @param xquery extrended query data (can be NULL, depending on type)
202 * @param xquery_size number of bytes in @a xquery
203 * @param reply_block response to validate
204 * @param reply_block_size number of bytes in @a reply_block
205 * @return characterization of result
207 static enum GNUNET_BLOCK_EvaluationResult
208 evaluate_block_regex_accept (void *cls,
209 enum GNUNET_BLOCK_Type type,
210 struct GNUNET_BLOCK_Group *bg,
211 enum GNUNET_BLOCK_EvaluationOptions eo,
212 const struct GNUNET_HashCode *query,
214 size_t xquery_size, const void *reply_block,
215 size_t reply_block_size)
217 const struct RegexAcceptBlock *rba;
218 struct GNUNET_HashCode chash;
220 if (0 != xquery_size)
223 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
225 if (NULL == reply_block)
226 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
227 if (sizeof(struct RegexAcceptBlock) != reply_block_size)
230 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
233 if (ntohl (rba->purpose.size) !=
234 sizeof(struct GNUNET_CRYPTO_EccSignaturePurpose)
235 + sizeof(struct GNUNET_TIME_AbsoluteNBO)
236 + sizeof(struct GNUNET_HashCode))
239 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
241 if (0 == GNUNET_TIME_absolute_get_remaining (GNUNET_TIME_absolute_ntoh (
242 rba->expiration_time)).
245 /* technically invalid, but can happen without an error, so
246 we're nice by reporting it as a 'duplicate' */
247 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
250 GNUNET_CRYPTO_eddsa_verify (GNUNET_SIGNATURE_PURPOSE_REGEX_ACCEPT,
253 &rba->peer.public_key))
256 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
258 GNUNET_CRYPTO_hash (reply_block,
262 GNUNET_BLOCK_GROUP_bf_test_and_set (bg,
264 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
265 return GNUNET_BLOCK_EVALUATION_OK_MORE;
270 * Function called to validate a reply or a request. For
271 * request evaluation, simply pass "NULL" for the reply_block.
272 * Note that it is assumed that the reply has already been
273 * matched to the key (and signatures checked) as it would
274 * be done with the #GNUNET_BLOCK_get_key() function.
277 * @param ctx block context
278 * @param type block type
279 * @param bg group to evaluate against
280 * @param eo control flags
281 * @param query original query (hash)
282 * @param xquery extrended query data (can be NULL, depending on type)
283 * @param xquery_size number of bytes in xquery
284 * @param reply_block response to validate
285 * @param reply_block_size number of bytes in reply block
286 * @return characterization of result
288 static enum GNUNET_BLOCK_EvaluationResult
289 block_plugin_regex_evaluate (void *cls,
290 struct GNUNET_BLOCK_Context *ctx,
291 enum GNUNET_BLOCK_Type type,
292 struct GNUNET_BLOCK_Group *bg,
293 enum GNUNET_BLOCK_EvaluationOptions eo,
294 const struct GNUNET_HashCode *query,
297 const void *reply_block,
298 size_t reply_block_size)
300 enum GNUNET_BLOCK_EvaluationResult result;
304 case GNUNET_BLOCK_TYPE_REGEX:
305 result = evaluate_block_regex (cls,
311 reply_block, reply_block_size);
314 case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
315 result = evaluate_block_regex_accept (cls,
321 reply_block, reply_block_size);
325 result = GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
332 * Function called to obtain the key for a block.
335 * @param type block type
336 * @param block block to get the key for
337 * @param block_size number of bytes in @a block
338 * @param key set to the key (query) for the given block
339 * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
340 * (or if extracting a key from a block of this type does not work)
343 block_plugin_regex_get_key (void *cls,
344 enum GNUNET_BLOCK_Type type,
347 struct GNUNET_HashCode *key)
351 case GNUNET_BLOCK_TYPE_REGEX:
353 REGEX_BLOCK_get_key (block, block_size,
361 case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
362 if (sizeof(struct RegexAcceptBlock) != block_size)
367 *key = ((struct RegexAcceptBlock *) block)->key;
372 return GNUNET_SYSERR;
378 * Entry point for the plugin.
381 libgnunet_plugin_block_regex_init (void *cls)
383 static enum GNUNET_BLOCK_Type types[] = {
384 GNUNET_BLOCK_TYPE_REGEX,
385 GNUNET_BLOCK_TYPE_REGEX_ACCEPT,
386 GNUNET_BLOCK_TYPE_ANY /* end of list */
388 struct GNUNET_BLOCK_PluginFunctions *api;
390 api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
391 api->evaluate = &block_plugin_regex_evaluate;
392 api->get_key = &block_plugin_regex_get_key;
393 api->create_group = &block_plugin_regex_create_group;
400 * Exit point from the plugin.
403 libgnunet_plugin_block_regex_done (void *cls)
405 struct GNUNET_BLOCK_PluginFunctions *api = cls;
412 /* end of plugin_block_regex.c */