src/fs/plugin_block_fs.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2010, 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 fs/plugin_block_fs.c
  23  * @brief blocks used for file-sharing
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_block_plugin.h"
  29 #include "block_fs.h"
  30 #include "gnunet_signatures.h"
  31
  32
  33 /**
  34  * Number of bits we set per entry in the bloomfilter.
  35  * Do not change!
  36  */
  37 #define BLOOMFILTER_K 16
  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_fs_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   const struct UBlock *ub;
  66   struct GNUNET_HashCode hc;
  67   struct GNUNET_HashCode chash;
  68   struct GNUNET_HashCode mhash;
  69
  70   switch (type)
  71   {
  72   case GNUNET_BLOCK_TYPE_FS_DBLOCK:
  73   case GNUNET_BLOCK_TYPE_FS_IBLOCK:
  74     if (0 != xquery_size)
  75     {
  76       GNUNET_break_op (0);
  77       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  78     }
  79     if (NULL == reply_block)
  80       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  81     return GNUNET_BLOCK_EVALUATION_OK_LAST;
  82   case GNUNET_BLOCK_TYPE_FS_UBLOCK:
  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
  91     if (reply_block_size < sizeof (struct UBlock))
  92     {
  93       GNUNET_break_op (0);
  94       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  95     }
  96     ub = reply_block;
  97     GNUNET_CRYPTO_hash (&ub->verification_key,
  98                         sizeof (ub->verification_key),
  99                         &hc);
 100     if (0 != memcmp (&hc,
 101                      query,
 102                      sizeof (struct GNUNET_HashCode)))
 103     {
 104       GNUNET_break_op (0);
 105       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 106     }
 107     if (reply_block_size != ntohl (ub->purpose.size) + sizeof (struct GNUNET_PseudonymSignature))
 108     {
 109       GNUNET_break_op (0);
 110       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 111     }
 112     if (GNUNET_OK !=
 113         GNUNET_PSEUDONYM_verify (&ub->purpose,
 114                                  &ub->signature,
 115                                  &ub->verification_key))
 116     {
 117       GNUNET_break_op (0);
 118       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 119     }
 120     if (NULL != bf)
 121     {
 122       GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 123       GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 124       if (NULL != *bf)
 125       {
 126         if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 127           return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 128       }
 129       else
 130       {
 131         *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 132       }
 133       GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 134     }
 135     return GNUNET_BLOCK_EVALUATION_OK_MORE;
 136   default:
 137     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 138   }
 139 }
 140
 141
 142 /**
 143  * Function called to obtain the key for a block.
 144  *
 145  * @param cls closure
 146  * @param type block type
 147  * @param block block to get the key for
 148  * @param block_size number of bytes in block
 149  * @param key set to the key (query) for the given block
 150  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
 151  *         (or if extracting a key from a block of this type does not work)
 152  */
 153 static int
 154 block_plugin_fs_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 155                          const void *block, size_t block_size,
 156                          struct GNUNET_HashCode *key)
 157 {
 158   const struct UBlock *ub;
 159
 160   switch (type)
 161   {
 162   case GNUNET_BLOCK_TYPE_FS_DBLOCK:
 163   case GNUNET_BLOCK_TYPE_FS_IBLOCK:
 164     GNUNET_CRYPTO_hash (block, block_size, key);
 165     return GNUNET_OK;
 166   case GNUNET_BLOCK_TYPE_FS_UBLOCK:
 167     if (block_size < sizeof (struct UBlock))
 168     {
 169       GNUNET_break (0);
 170       return GNUNET_SYSERR;
 171     }
 172     ub = block;
 173     GNUNET_CRYPTO_hash (&ub->verification_key,
 174                         sizeof (ub->verification_key),
 175                         key);
 176     return GNUNET_OK;
 177   default:
 178     GNUNET_break (0);
 179     return GNUNET_SYSERR;
 180   }
 181 }
 182
 183
 184 /**
 185  * Entry point for the plugin.
 186  */
 187 void *
 188 libgnunet_plugin_block_fs_init (void *cls)
 189 {
 190   static enum GNUNET_BLOCK_Type types[] =
 191   {
 192     GNUNET_BLOCK_TYPE_FS_DBLOCK,
 193     GNUNET_BLOCK_TYPE_FS_IBLOCK,
 194     GNUNET_BLOCK_TYPE_FS_UBLOCK,
 195     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 196   };
 197   struct GNUNET_BLOCK_PluginFunctions *api;
 198
 199   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
 200   api->evaluate = &block_plugin_fs_evaluate;
 201   api->get_key = &block_plugin_fs_get_key;
 202   api->types = types;
 203   return api;
 204 }
 205
 206
 207 /**
 208  * Exit point from the plugin.
 209  */
 210 void *
 211 libgnunet_plugin_block_fs_done (void *cls)
 212 {
 213   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 214
 215   GNUNET_free (api);
 216   return NULL;
 217 }
 218
 219 /* end of plugin_block_fs.c */