src/regex/plugin_block_regex.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2013 Christian Grothoff (and other contributing authors)
   4
   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.
   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      General Public License for more details.
  14
  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.
  19 */
  20
  21 /**
  22  * @file regex/plugin_block_regex.c
  23  * @brief blocks used for regex storage and search
  24  * @author Bartlomiej Polot
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_block_plugin.h"
  29 #include "block_regex.h"
  30 #include "regex_block_lib.h"
  31
  32 /**
  33  * Number of bits we set per entry in the bloomfilter.
  34  * Do not change!
  35  */
  36 #define BLOOMFILTER_K 16
  37
  38
  39 /**
  40  * Show debug info about outgoing edges from a block.
  41  *
  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.
  46  *
  47  * @return GNUNET_YES to keep iterating.
  48  */
  49 static int
  50 rdebug (void *cls,
  51              const char *token,
  52              size_t len,
  53              const struct GNUNET_HashCode *key)
  54 {
  55   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "    %s: %.*s\n",
  56               GNUNET_h2s (key), len, token);
  57   return GNUNET_YES;
  58 }
  59
  60
  61 /**
  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.
  68  *
  69  * @param cls closure
  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
  79  */
  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)
  87 {
  88   if (NULL == reply_block) /* queries (GET) are always valid */
  89     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  90   if (0 != xquery_size)
  91   {
  92     const char *query;
  93
  94     query = (const char *) xquery;
  95     if ('\0' != query[xquery_size - 1]) /* must be valid string */
  96     {
  97       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
  98                   "Block xquery not a valid string\n");
  99       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 100     }
 101   }
 102   else if (NULL != query) /* PUTs don't need xquery */
 103   {
 104     const struct RegexBlock *rblock = reply_block;
 105
 106     GNUNET_break_op (0);
 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     REGEX_INTERNAL_block_iterate (rblock, reply_block_size, &rdebug, NULL);
 111     return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 112   }
 113   switch (REGEX_INTERNAL_block_check (reply_block,
 114                                     reply_block_size,
 115                                     xquery))
 116   {
 117     case GNUNET_SYSERR:
 118       GNUNET_break_op(0);
 119       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 120     case GNUNET_NO:
 121       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 122                   "BLOCK XQUERY %s not accepted\n", xquery);
 123       return GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT;
 124     default:
 125       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 126                   "BLOCK XQUERY %s accepted\n", xquery);
 127       break;
 128   }
 129   if (NULL != bf)
 130   {
 131     struct GNUNET_HashCode chash;
 132     struct GNUNET_HashCode mhash;
 133
 134     GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 135     GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 136     if (NULL != *bf)
 137     {
 138       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 139         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 140     }
 141     else
 142     {
 143       *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 144     }
 145     GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 146   }
 147   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 148 }
 149
 150
 151 /**
 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.
 158  *
 159  * @param cls closure
 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
 169  */
 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)
 177 {
 178   if (0 != xquery_size)
 179   {
 180     GNUNET_break_op (0);
 181     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 182   }
 183   if (NULL == reply_block)
 184     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 185   if (sizeof (struct RegexAccept) != reply_block_size)
 186   {
 187     GNUNET_break_op(0);
 188     return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 189   }
 190   if (NULL != bf)
 191   {
 192     struct GNUNET_HashCode chash;
 193     struct GNUNET_HashCode mhash;
 194
 195     GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 196     GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 197     if (NULL != *bf)
 198     {
 199       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 200         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 201     }
 202     else
 203     {
 204       *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 205     }
 206     GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 207   }
 208   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 209 }
 210
 211
 212 /**
 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.
 218  *
 219  * @param cls closure
 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
 229  */
 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)
 237 {
 238   enum GNUNET_BLOCK_EvaluationResult result;
 239
 240   switch (type)
 241   {
 242     case GNUNET_BLOCK_TYPE_REGEX:
 243       result = evaluate_block_regex (cls, type, query, bf, bf_mutator,
 244                                      xquery, xquery_size,
 245                                      reply_block, reply_block_size);
 246       break;
 247
 248     case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
 249       result = evaluate_block_regex_accept (cls, type, query, bf, bf_mutator,
 250                                             xquery, xquery_size,
 251                                             reply_block, reply_block_size);
 252       break;
 253
 254     default:
 255       result = GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 256   }
 257   return result;
 258 }
 259
 260
 261 /**
 262  * Function called to obtain the key for a block.
 263  *
 264  * @param cls closure
 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)
 271  */
 272 static int
 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)
 276 {
 277   switch (type)
 278   {
 279     case GNUNET_BLOCK_TYPE_REGEX:
 280       GNUNET_assert (sizeof (struct RegexBlock) <= block_size);
 281       *key = ((struct RegexBlock *) block)->key;
 282       return GNUNET_OK;
 283     case GNUNET_BLOCK_TYPE_REGEX_ACCEPT:
 284       GNUNET_assert (sizeof (struct RegexAccept) <= block_size);
 285       *key = ((struct RegexAccept *) block)->key;
 286       return GNUNET_OK;
 287     default:
 288       GNUNET_break (0);
 289       return GNUNET_SYSERR;
 290   }
 291 }
 292
 293
 294 /**
 295  * Entry point for the plugin.
 296  */
 297 void *
 298 libgnunet_plugin_block_regex_init (void *cls)
 299 {
 300   static enum GNUNET_BLOCK_Type types[] =
 301   {
 302     GNUNET_BLOCK_TYPE_REGEX,
 303     GNUNET_BLOCK_TYPE_REGEX_ACCEPT,
 304     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 305   };
 306   struct GNUNET_BLOCK_PluginFunctions *api;
 307
 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;
 311   api->types = types;
 312   return api;
 313 }
 314
 315
 316 /**
 317  * Exit point from the plugin.
 318  */
 319 void *
 320 libgnunet_plugin_block_regex_done (void *cls)
 321 {
 322   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 323
 324   GNUNET_free (api);
 325   return NULL;
 326 }
 327
 328 /* end of plugin_block_regex.c */