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