src/fs/plugin_block_fs.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2010 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 SBlock *sb;
  66   struct GNUNET_HashCode chash;
  67   struct GNUNET_HashCode mhash;
  68   const struct GNUNET_HashCode *nsid;
  69   struct GNUNET_HashCode sh;
  70
  71   switch (type)
  72   {
  73   case GNUNET_BLOCK_TYPE_FS_DBLOCK:
  74   case GNUNET_BLOCK_TYPE_FS_IBLOCK:
  75     if (xquery_size != 0)
  76     {
  77       GNUNET_break_op (0);
  78       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  79     }
  80     if (reply_block == NULL)
  81       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  82     return GNUNET_BLOCK_EVALUATION_OK_LAST;
  83   case GNUNET_BLOCK_TYPE_FS_KBLOCK:
  84   case GNUNET_BLOCK_TYPE_FS_NBLOCK:
  85     if (xquery_size != 0)
  86     {
  87       GNUNET_break_op (0);
  88       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  89     }
  90     if (reply_block == NULL)
  91       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  92     if (NULL != bf)
  93     {
  94       GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
  95       GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
  96       if (NULL != *bf)
  97       {
  98         if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
  99           return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 100       }
 101       else
 102       {
 103         *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 104       }
 105       GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 106     }
 107     return GNUNET_BLOCK_EVALUATION_OK_MORE;
 108   case GNUNET_BLOCK_TYPE_FS_SBLOCK:
 109     if (xquery_size != sizeof (struct GNUNET_HashCode))
 110     {
 111       GNUNET_break_op (0);
 112       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 113     }
 114     if (reply_block == NULL)
 115       return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 116     nsid = xquery;
 117     if (reply_block_size < sizeof (struct SBlock))
 118     {
 119       GNUNET_break_op (0);
 120       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 121     }
 122     sb = reply_block;
 123     GNUNET_CRYPTO_hash (&sb->subspace,
 124                         sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
 125                         &sh);
 126     if (0 != memcmp (nsid, &sh, sizeof (struct GNUNET_HashCode)))
 127     {
 128       GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "block-fs",
 129                        _
 130                        ("Reply mismatched in terms of namespace.  Discarded.\n"));
 131       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 132     }
 133     if (NULL != bf)
 134     {
 135       GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 136       GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 137       if (NULL != *bf)
 138       {
 139         if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 140           return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 141       }
 142       else
 143       {
 144         *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
 145       }
 146       GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 147     }
 148     return GNUNET_BLOCK_EVALUATION_OK_MORE;
 149   default:
 150     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 151   }
 152 }
 153
 154
 155 /**
 156  * Function called to obtain the key for a block.
 157  *
 158  * @param cls closure
 159  * @param type block type
 160  * @param block block to get the key for
 161  * @param block_size number of bytes in block
 162  * @param key set to the key (query) for the given block
 163  * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
 164  *         (or if extracting a key from a block of this type does not work)
 165  */
 166 static int
 167 block_plugin_fs_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 168                          const void *block, size_t block_size,
 169                          struct GNUNET_HashCode * key)
 170 {
 171   const struct KBlock *kb;
 172   const struct SBlock *sb;
 173   const struct NBlock *nb;
 174
 175   switch (type)
 176   {
 177   case GNUNET_BLOCK_TYPE_FS_DBLOCK:
 178   case GNUNET_BLOCK_TYPE_FS_IBLOCK:
 179     GNUNET_CRYPTO_hash (block, block_size, key);
 180     return GNUNET_OK;
 181   case GNUNET_BLOCK_TYPE_FS_KBLOCK:
 182     if (block_size < sizeof (struct KBlock))
 183     {
 184       GNUNET_break_op (0);
 185       return GNUNET_NO;
 186     }
 187     kb = block;
 188     if (block_size - sizeof (struct KBlock) !=
 189         ntohl (kb->purpose.size) -
 190         sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) -
 191         sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded))
 192     {
 193       GNUNET_break_op (0);
 194       return GNUNET_NO;
 195     }
 196     if (GNUNET_OK !=
 197         GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_KBLOCK,
 198                                   &kb->purpose, &kb->signature, &kb->keyspace))
 199     {
 200       GNUNET_break_op (0);
 201       return GNUNET_NO;
 202     }
 203     if (key != NULL)
 204       GNUNET_CRYPTO_hash (&kb->keyspace,
 205                           sizeof (struct
 206                                   GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
 207                           key);
 208     return GNUNET_OK;
 209   case GNUNET_BLOCK_TYPE_FS_SBLOCK:
 210     if (block_size < sizeof (struct SBlock))
 211     {
 212       GNUNET_break_op (0);
 213       return GNUNET_NO;
 214     }
 215     sb = block;
 216     if (block_size !=
 217         ntohl (sb->purpose.size) + sizeof (struct GNUNET_CRYPTO_RsaSignature))
 218     {
 219       GNUNET_break_op (0);
 220       return GNUNET_NO;
 221     }
 222     if (GNUNET_OK !=
 223         GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_SBLOCK,
 224                                   &sb->purpose, &sb->signature, &sb->subspace))
 225     {
 226       GNUNET_break_op (0);
 227       return GNUNET_NO;
 228     }
 229     if (key != NULL)
 230       *key = sb->identifier;
 231     return GNUNET_OK;
 232   case GNUNET_BLOCK_TYPE_FS_NBLOCK:
 233     if (block_size < sizeof (struct NBlock))
 234     {
 235       GNUNET_break_op (0);
 236       return GNUNET_NO;
 237     }
 238     nb = block;
 239     if (block_size - sizeof (struct NBlock) !=
 240         ntohl (nb->ns_purpose.size) -
 241         sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) -
 242         sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded))
 243     {
 244       GNUNET_break_op (0);
 245       return GNUNET_NO;
 246     }
 247     if (block_size !=
 248         ntohl (nb->ksk_purpose.size) +
 249         sizeof (struct GNUNET_CRYPTO_RsaSignature))
 250     {
 251       GNUNET_break_op (0);
 252       return GNUNET_NO;
 253     }
 254     if (GNUNET_OK !=
 255         GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK_KSIG,
 256                                   &nb->ksk_purpose, &nb->ksk_signature,
 257                                   &nb->keyspace))
 258     {
 259       GNUNET_break_op (0);
 260       return GNUNET_NO;
 261     }
 262     if (GNUNET_OK !=
 263         GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK,
 264                                   &nb->ns_purpose, &nb->ns_signature,
 265                                   &nb->subspace))
 266     {
 267       GNUNET_break_op (0);
 268       return GNUNET_NO;
 269     }
 270     /* FIXME: we used to xor ID with NSID,
 271      * why not here? */
 272     if (key != NULL)
 273       GNUNET_CRYPTO_hash (&nb->keyspace,
 274                           sizeof (struct
 275                                   GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
 276                           key);
 277     return GNUNET_OK;
 278   default:
 279     return GNUNET_SYSERR;
 280   }
 281 }
 282
 283
 284 /**
 285  * Entry point for the plugin.
 286  */
 287 void *
 288 libgnunet_plugin_block_fs_init (void *cls)
 289 {
 290   static enum GNUNET_BLOCK_Type types[] =
 291   {
 292     GNUNET_BLOCK_TYPE_FS_DBLOCK,
 293     GNUNET_BLOCK_TYPE_FS_IBLOCK,
 294     GNUNET_BLOCK_TYPE_FS_KBLOCK,
 295     GNUNET_BLOCK_TYPE_FS_SBLOCK,
 296     GNUNET_BLOCK_TYPE_FS_NBLOCK,
 297     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 298   };
 299   struct GNUNET_BLOCK_PluginFunctions *api;
 300
 301   api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
 302   api->evaluate = &block_plugin_fs_evaluate;
 303   api->get_key = &block_plugin_fs_get_key;
 304   api->types = types;
 305   return api;
 306 }
 307
 308
 309 /**
 310  * Exit point from the plugin.
 311  */
 312 void *
 313 libgnunet_plugin_block_fs_done (void *cls)
 314 {
 315   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 316
 317   GNUNET_free (api);
 318   return NULL;
 319 }
 320
 321 /* end of plugin_block_fs.c */