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 * Function called to validate a reply or a request. For
41 * request evaluation, simply pass "NULL" for the reply_block.
42 * Note that it is assumed that the reply has already been
43 * matched to the key (and signatures checked) as it would
44 * be done with the "get_key" function.
47 * @param type block type
48 * @param query original query (hash)
49 * @param bf pointer to bloom filter associated with query; possibly updated (!)
50 * @param bf_mutator mutation value for bf
51 * @param xquery extrended query data (can be NULL, depending on type)
52 * @param xquery_size number of bytes in xquery
53 * @param reply_block response to validate
54 * @param reply_block_size number of bytes in reply block
55 * @return characterization of result
57 static enum GNUNET_BLOCK_EvaluationResult
58 block_plugin_regex_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
59 const struct GNUNET_HashCode * query,
60 struct GNUNET_CONTAINER_BloomFilter **bf,
61 int32_t bf_mutator, const void *xquery,
62 size_t xquery_size, const void *reply_block,
63 size_t reply_block_size)
65 struct GNUNET_HashCode chash;
66 struct GNUNET_HashCode mhash;
70 case GNUNET_BLOCK_TYPE_REGEX:
71 if (NULL == reply_block)
72 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
77 query = (const char *) xquery;
78 if ('\0' != query[xquery_size - 1]) /* must be valid string */
80 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
81 "Block xquery not a valid string\n");
82 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
88 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
90 switch (GNUNET_REGEX_block_check (reply_block,
96 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
98 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
99 "BLOCK XQUERY %s not accepted\n", xquery);
100 return GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT;
102 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
103 "BLOCK XQUERY %s accepted\n", xquery);
108 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
109 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
112 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
113 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
117 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
119 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
121 return GNUNET_BLOCK_EVALUATION_OK_MORE;
124 case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
125 if (0 != xquery_size)
128 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
130 if (NULL == reply_block)
131 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
132 if (sizeof (struct RegexAccept) != reply_block_size)
135 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
139 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
140 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
143 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
144 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
148 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
150 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
152 return GNUNET_BLOCK_EVALUATION_OK_MORE;
156 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
162 * Function called to obtain the key for a block.
165 * @param type block type
166 * @param block block to get the key for
167 * @param block_size number of bytes in block
168 * @param key set to the key (query) for the given block
169 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
170 * (or if extracting a key from a block of this type does not work)
173 block_plugin_regex_get_key (void *cls, enum GNUNET_BLOCK_Type type,
174 const void *block, size_t block_size,
175 struct GNUNET_HashCode * key)
179 case GNUNET_BLOCK_TYPE_REGEX:
180 GNUNET_assert (sizeof (struct RegexBlock) <= block_size);
181 *key = ((struct RegexBlock *) block)->key;
183 case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
184 GNUNET_assert (sizeof (struct RegexAccept) <= block_size);
185 *key = ((struct RegexAccept *) block)->key;
189 return GNUNET_SYSERR;
195 * Entry point for the plugin.
198 libgnunet_plugin_block_regex_init (void *cls)
200 static enum GNUNET_BLOCK_Type types[] =
202 GNUNET_BLOCK_TYPE_REGEX,
203 GNUNET_BLOCK_TYPE_REGEX_ACCEPT,
204 GNUNET_BLOCK_TYPE_ANY /* end of list */
206 struct GNUNET_BLOCK_PluginFunctions *api;
208 api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
209 api->evaluate = &block_plugin_regex_evaluate;
210 api->get_key = &block_plugin_regex_get_key;
217 * Exit point from the plugin.
220 libgnunet_plugin_block_regex_done (void *cls)
222 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
228 /* end of plugin_block_regex.c */