src/mesh/plugin_block_mesh.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2012 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 mesh/plugin_block_mesh.c
  23  * @brief blocks used for mesh peer discovery
  24  * @author Bartlomiej Polot
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_block_plugin.h"
  29 #include "block_mesh.h"
  30 #include "mesh_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  * 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.
  45  *
  46  * @param cls closure
  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
  56  */
  57 static enum GNUNET_BLOCK_EvaluationResult
  58 block_plugin_mesh_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)
  64 {
  65   struct GNUNET_HashCode chash;
  66   struct GNUNET_HashCode mhash;
  67
  68   switch (type)
  69   {
  70     case GNUNET_BLOCK_TYPE_MESH_PEER:
  71       if (0 != xquery_size)
  72       {
  73         GNUNET_break_op (0);
  74         return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  75       }
  76       if (NULL == reply_block)
  77         return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  78       if (sizeof (struct PBlock) != reply_block_size)
  79         return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  80       if (NULL != bf)
  81       {
  82         GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
  83         GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
  84         if (NULL != *bf)
  85         {
  86           if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
  87             return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
  88         }
  89         else
  90         {
  91           *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
  92         }
  93         GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
  94       }
  95
  96       return GNUNET_BLOCK_EVALUATION_OK_LAST;
  97
  98
  99     case GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE:
 100       /* FIXME: have an xquery? not sure */
 101       if (0 != xquery_size)
 102       {
 103         GNUNET_break_op (0);
 104         return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 105       }
 106       if (NULL == reply_block)
 107         return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 108       if (sizeof (struct PBlock) != reply_block_size)
 109       {
 110         GNUNET_break_op(0);
 111         return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 112       }
 113       if (NULL != bf)
 114       {
 115         GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 116         GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 117         if (NULL != *bf)
 118         {
 119           if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 120             return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 121         }
 122         else
 123         {
 124           *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 125         }
 126         GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 127       }
 128       return GNUNET_BLOCK_EVALUATION_OK_MORE;
 129
 130
 131     case GNUNET_BLOCK_TYPE_MESH_REGEX:
 132       if (NULL == reply_block)
 133         return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 134       if (0 != xquery_size)
 135       {
 136         const char *query;
 137
 138         query = (const char *) xquery;
 139         if ('\0' != query[xquery_size - 1]) /* must be valid string */
 140         {
 141           GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 142                       "Block xquery not a valid string\n");
 143           return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 144         }
 145       }
 146       else
 147       {
 148         GNUNET_break_op (0);
 149         return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 150       }
 151       switch (GNUNET_MESH_regex_block_check (reply_block,
 152                                              reply_block_size,
 153                                              xquery))
 154       {
 155         case GNUNET_SYSERR:
 156           GNUNET_break_op(0);
 157           return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 158         case GNUNET_NO:
 159           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 160                       "BLOCK XQUERY %s not accepted\n", xquery);
 161           return GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT;
 162         default:
 163           GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 164                       "BLOCK XQUERY %s accepted\n", xquery);
 165           break;
 166       }
 167       if (NULL != bf)
 168       {
 169         GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 170         GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 171         if (NULL != *bf)
 172         {
 173           if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 174             return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 175         }
 176         else
 177         {
 178           *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 179         }
 180         GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 181       }
 182       return GNUNET_BLOCK_EVALUATION_OK_MORE;
 183
 184
 185     case GNUNET_BLOCK_TYPE_MESH_REGEX_ACCEPT:
 186       if (0 != xquery_size)
 187       {
 188         GNUNET_break_op (0);
 189         return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 190       }
 191       if (NULL == reply_block)
 192         return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 193       if (sizeof (struct MeshRegexAccept) != reply_block_size)
 194       {
 195         GNUNET_break_op(0);
 196         return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 197       }
 198       if (NULL != bf)
 199       {
 200         GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 201         GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 202         if (NULL != *bf)
 203         {
 204           if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 205             return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 206         }
 207         else
 208         {
 209           *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 210         }
 211         GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 212       }
 213       return GNUNET_BLOCK_EVALUATION_OK_MORE;
 214
 215
 216     default:
 217       return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 218   }
 219 }
 220
 221
 222 /**
 223  * Function called to obtain the key for a block.
 224  *
 225  * @param cls closure
 226  * @param type block type
 227  * @param block block to get the key for
 228  * @param block_size number of bytes in block
 229  * @param key set to the key (query) for the given block
 230  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
 231  *         (or if extracting a key from a block of this type does not work)
 232  */
 233 static int
 234 block_plugin_mesh_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 235                            const void *block, size_t block_size,
 236                            struct GNUNET_HashCode * key)
 237 {
 238   const struct PBlock *pb;
 239   pb = block;
 240
 241   switch (type)
 242   {
 243   case GNUNET_BLOCK_TYPE_MESH_PEER:
 244     if (sizeof (struct PBlock) != block_size)
 245       return GNUNET_SYSERR;
 246     *key = pb->id.hashPubKey;
 247     return GNUNET_OK;
 248   case GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE:
 249     GNUNET_CRYPTO_hash (&pb->type, sizeof(GNUNET_MESH_ApplicationType), key);
 250     return GNUNET_OK;
 251   default:
 252     return GNUNET_SYSERR;
 253   }
 254 }
 255
 256
 257 /**
 258  * Entry point for the plugin.
 259  */
 260 void *
 261 libgnunet_plugin_block_mesh_init (void *cls)
 262 {
 263   static enum GNUNET_BLOCK_Type types[] =
 264   {
 265     GNUNET_BLOCK_TYPE_MESH_PEER,
 266     GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE,
 267     GNUNET_BLOCK_TYPE_MESH_REGEX,
 268     GNUNET_BLOCK_TYPE_MESH_REGEX_ACCEPT,
 269     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 270   };
 271   struct GNUNET_BLOCK_PluginFunctions *api;
 272
 273   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
 274   api->evaluate = &block_plugin_mesh_evaluate;
 275   api->get_key = &block_plugin_mesh_get_key;
 276   api->types = types;
 277   return api;
 278 }
 279
 280
 281 /**
 282  * Exit point from the plugin.
 283  */
 284 void *
 285 libgnunet_plugin_block_mesh_done (void *cls)
 286 {
 287   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 288
 289   GNUNET_free (api);
 290   return NULL;
 291 }
 292
 293 /* end of plugin_block_mesh.c */