src/mesh/plugin_block_mesh.c

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