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
  31 /**
  32  * Number of bits we set per entry in the bloomfilter.
  33  * Do not change!
  34  */
  35 #define BLOOMFILTER_K 16
  36
  37
  38 /**
  39  * Function called to validate a reply or a request.  For
  40  * request evaluation, simply pass "NULL" for the reply_block.
  41  * Note that it is assumed that the reply has already been
  42  * matched to the key (and signatures checked) as it would
  43  * be done with the "get_key" function.
  44  *
  45  * @param cls closure
  46  * @param type block type
  47  * @param query original query (hash)
  48  * @param bf pointer to bloom filter associated with query; possibly updated (!)
  49  * @param bf_mutator mutation value for bf
  50  * @param xquery extrended query data (can be NULL, depending on type)
  51  * @param xquery_size number of bytes in xquery
  52  * @param reply_block response to validate
  53  * @param reply_block_size number of bytes in reply block
  54  * @return characterization of result
  55  */
  56 static enum GNUNET_BLOCK_EvaluationResult
  57 block_plugin_mesh_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
  58                             const struct GNUNET_HashCode * query,
  59                             struct GNUNET_CONTAINER_BloomFilter **bf,
  60                             int32_t bf_mutator, const void *xquery,
  61                             size_t xquery_size, const void *reply_block,
  62                             size_t reply_block_size)
  63 {
  64   struct GNUNET_HashCode chash;
  65   struct GNUNET_HashCode mhash;
  66
  67   switch (type)
  68   {
  69   case GNUNET_BLOCK_TYPE_MESH_PEER:
  70     if (0 != xquery_size)
  71     {
  72       GNUNET_break_op (0);
  73       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  74     }
  75     if (NULL == reply_block)
  76       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  77     if (sizeof (struct PBlock) != reply_block_size)
  78       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  79     return GNUNET_BLOCK_EVALUATION_OK_LAST;
  80   case GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE:
  81     /* FIXME: have an xquery? not sure */
  82     if (0 != xquery_size)
  83     {
  84       GNUNET_break_op (0);
  85       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  86     }
  87     if (NULL == reply_block)
  88       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  89     if (sizeof (struct PBlock) != reply_block_size)
  90       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  91     if (NULL != bf)
  92     {
  93       GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
  94       GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
  95       if (NULL != *bf)
  96       {
  97         if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
  98           return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
  99       }
 100       else
 101       {
 102         *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 103       }
 104       GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 105     }
 106     return GNUNET_BLOCK_EVALUATION_OK_MORE;
 107   default:
 108     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 109   }
 110 }
 111
 112
 113 /**
 114  * Function called to obtain the key for a block.
 115  *
 116  * @param cls closure
 117  * @param type block type
 118  * @param block block to get the key for
 119  * @param block_size number of bytes in block
 120  * @param key set to the key (query) for the given block
 121  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
 122  *         (or if extracting a key from a block of this type does not work)
 123  */
 124 static int
 125 block_plugin_mesh_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 126                            const void *block, size_t block_size,
 127                            struct GNUNET_HashCode * key)
 128 {
 129   const struct PBlock *pb;
 130   pb = block;
 131
 132   switch (type)
 133   {
 134   case GNUNET_BLOCK_TYPE_MESH_PEER:
 135     if (sizeof (struct PBlock) != block_size)
 136       return GNUNET_SYSERR;
 137     *key = pb->id.hashPubKey;
 138     return GNUNET_OK;
 139   case GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE:
 140     GNUNET_CRYPTO_hash (&pb->type, sizeof(GNUNET_MESH_ApplicationType), key);
 141     return GNUNET_OK;
 142   default:
 143     return GNUNET_SYSERR;
 144   }
 145 }
 146
 147
 148 /**
 149  * Entry point for the plugin.
 150  */
 151 void *
 152 libgnunet_plugin_block_mesh_init (void *cls)
 153 {
 154   static enum GNUNET_BLOCK_Type types[] =
 155   {
 156     GNUNET_BLOCK_TYPE_MESH_PEER,
 157     GNUNET_BLOCK_TYPE_MESH_PEER_BY_TYPE,
 158     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 159   };
 160   struct GNUNET_BLOCK_PluginFunctions *api;
 161
 162   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
 163   api->evaluate = &block_plugin_mesh_evaluate;
 164   api->get_key = &block_plugin_mesh_get_key;
 165   api->types = types;
 166   return api;
 167 }
 168
 169
 170 /**
 171  * Exit point from the plugin.
 172  */
 173 void *
 174 libgnunet_plugin_block_mesh_done (void *cls)
 175 {
 176   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 177
 178   GNUNET_free (api);
 179   return NULL;
 180 }
 181
 182 /* end of plugin_block_mesh.c */