2 This file is part of GNUnet
3 (C) 2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file regex/plugin_block_regex.c
23 * @brief blocks used for regex storage and search
24 * @author Bartlomiej Polot
28 #include "gnunet_block_plugin.h"
29 #include "block_regex.h"
30 #include "regex_block_lib.h"
33 * Number of bits we set per entry in the bloomfilter.
36 #define BLOOMFILTER_K 16
40 * Show debug info about outgoing edges from a block.
42 * @param cls Closure (uunsed).
43 * @param token Edge label.
44 * @param len Length of @c token.
45 * @param key Block the edge point to.
47 * @return GNUNET_YES to keep iterating.
53 const struct GNUNET_HashCode *key)
55 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " %s: %.*s\n",
56 GNUNET_h2s (key), len, token);
62 * Function called to validate a reply or a request of type
63 * GNUNET_BLOCK_TYPE_REGEX.
64 * For request evaluation, pass "NULL" for the reply_block.
65 * Note that it is assumed that the reply has already been
66 * matched to the key (and signatures checked) as it would
67 * be done with the "get_key" function.
70 * @param type block type
71 * @param query original query (hash)
72 * @param bf pointer to bloom filter associated with query; possibly updated (!)
73 * @param bf_mutator mutation value for bf
74 * @param xquery extrended query data (can be NULL, depending on type)
75 * @param xquery_size number of bytes in xquery
76 * @param reply_block response to validate
77 * @param reply_block_size number of bytes in reply block
78 * @return characterization of result
80 static enum GNUNET_BLOCK_EvaluationResult
81 evaluate_block_regex (void *cls, enum GNUNET_BLOCK_Type type,
82 const struct GNUNET_HashCode * query,
83 struct GNUNET_CONTAINER_BloomFilter **bf,
84 int32_t bf_mutator, const void *xquery,
85 size_t xquery_size, const void *reply_block,
86 size_t reply_block_size)
88 if (NULL == reply_block) /* queries (GET) are always valid */
89 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
94 query = (const char *) xquery;
95 if ('\0' != query[xquery_size - 1]) /* must be valid string */
97 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
98 "Block xquery not a valid string\n");
99 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
102 else if (NULL != query) /* PUTs don't need xquery */
104 const struct RegexBlock *rblock = reply_block;
107 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Block with no xquery\n");
108 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, " key: %s, %u edges\n",
109 GNUNET_h2s (&rblock->key), ntohl (rblock->n_edges));
110 GNUNET_REGEX_block_iterate (rblock, reply_block_size, &rdebug, NULL);
111 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
113 switch (GNUNET_REGEX_block_check (reply_block,
119 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
121 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
122 "BLOCK XQUERY %s not accepted\n", xquery);
123 return GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT;
125 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
126 "BLOCK XQUERY %s accepted\n", xquery);
131 struct GNUNET_HashCode chash;
132 struct GNUNET_HashCode mhash;
134 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
135 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
138 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
139 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
143 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
145 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
147 return GNUNET_BLOCK_EVALUATION_OK_MORE;
152 * Function called to validate a reply or a request of type
153 * GNUNET_BLOCK_TYPE_REGEX_ACCEPT.
154 * For request evaluation, pass "NULL" for the reply_block.
155 * Note that it is assumed that the reply has already been
156 * matched to the key (and signatures checked) as it would
157 * be done with the "get_key" function.
160 * @param type block type
161 * @param query original query (hash)
162 * @param bf pointer to bloom filter associated with query; possibly updated (!)
163 * @param bf_mutator mutation value for bf
164 * @param xquery extrended query data (can be NULL, depending on type)
165 * @param xquery_size number of bytes in xquery
166 * @param reply_block response to validate
167 * @param reply_block_size number of bytes in reply block
168 * @return characterization of result
170 static enum GNUNET_BLOCK_EvaluationResult
171 evaluate_block_regex_accept (void *cls, enum GNUNET_BLOCK_Type type,
172 const struct GNUNET_HashCode * query,
173 struct GNUNET_CONTAINER_BloomFilter **bf,
174 int32_t bf_mutator, const void *xquery,
175 size_t xquery_size, const void *reply_block,
176 size_t reply_block_size)
178 if (0 != xquery_size)
181 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
183 if (NULL == reply_block)
184 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
185 if (sizeof (struct RegexAccept) != reply_block_size)
188 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
192 struct GNUNET_HashCode chash;
193 struct GNUNET_HashCode mhash;
195 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
196 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
199 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
200 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
204 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
206 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
208 return GNUNET_BLOCK_EVALUATION_OK_MORE;
213 * Function called to validate a reply or a request. For
214 * request evaluation, simply pass "NULL" for the reply_block.
215 * Note that it is assumed that the reply has already been
216 * matched to the key (and signatures checked) as it would
217 * be done with the "get_key" function.
220 * @param type block type
221 * @param query original query (hash)
222 * @param bf pointer to bloom filter associated with query; possibly updated (!)
223 * @param bf_mutator mutation value for bf
224 * @param xquery extrended query data (can be NULL, depending on type)
225 * @param xquery_size number of bytes in xquery
226 * @param reply_block response to validate
227 * @param reply_block_size number of bytes in reply block
228 * @return characterization of result
230 static enum GNUNET_BLOCK_EvaluationResult
231 block_plugin_regex_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
232 const struct GNUNET_HashCode * query,
233 struct GNUNET_CONTAINER_BloomFilter **bf,
234 int32_t bf_mutator, const void *xquery,
235 size_t xquery_size, const void *reply_block,
236 size_t reply_block_size)
238 enum GNUNET_BLOCK_EvaluationResult result;
242 case GNUNET_BLOCK_TYPE_REGEX:
243 result = evaluate_block_regex (cls, type, query, bf, bf_mutator,
245 reply_block, reply_block_size);
248 case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
249 result = evaluate_block_regex_accept (cls, type, query, bf, bf_mutator,
251 reply_block, reply_block_size);
255 result = GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
262 * Function called to obtain the key for a block.
265 * @param type block type
266 * @param block block to get the key for
267 * @param block_size number of bytes in block
268 * @param key set to the key (query) for the given block
269 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
270 * (or if extracting a key from a block of this type does not work)
273 block_plugin_regex_get_key (void *cls, enum GNUNET_BLOCK_Type type,
274 const void *block, size_t block_size,
275 struct GNUNET_HashCode * key)
279 case GNUNET_BLOCK_TYPE_REGEX:
280 GNUNET_assert (sizeof (struct RegexBlock) <= block_size);
281 *key = ((struct RegexBlock *) block)->key;
283 case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
284 GNUNET_assert (sizeof (struct RegexAccept) <= block_size);
285 *key = ((struct RegexAccept *) block)->key;
289 return GNUNET_SYSERR;
295 * Entry point for the plugin.
298 libgnunet_plugin_block_regex_init (void *cls)
300 static enum GNUNET_BLOCK_Type types[] =
302 GNUNET_BLOCK_TYPE_REGEX,
303 GNUNET_BLOCK_TYPE_REGEX_ACCEPT,
304 GNUNET_BLOCK_TYPE_ANY /* end of list */
306 struct GNUNET_BLOCK_PluginFunctions *api;
308 api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
309 api->evaluate = &block_plugin_regex_evaluate;
310 api->get_key = &block_plugin_regex_get_key;
317 * Exit point from the plugin.
320 libgnunet_plugin_block_regex_done (void *cls)
322 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
328 /* end of plugin_block_regex.c */