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