src/gns/plugin_block_gns.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 gns/plugin_block_gns.c
  23  * @brief blocks used for GNS records
  24  * @author Martin Schanzenbach
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_block_plugin.h"
  29 #include "gnunet_namestore_service.h"
  30 #include "gnunet_signatures.h"
  31
  32 /**
  33  * Number of bits we set per entry in the bloomfilter.
  34  * Do not change! -from fs
  35  */
  36 #define BLOOMFILTER_K 16
  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 @a query; possibly updated (!)
  49  * @param bf_mutator mutation value for @a bf
  50  * @param xquery extrended query data (can be NULL, depending on @a type)
  51  * @param xquery_size number of bytes in @a xquery
  52  * @param reply_block response to validate
  53  * @param reply_block_size number of bytes in @a reply_block
  54  * @return characterization of result
  55  */
  56 static enum GNUNET_BLOCK_EvaluationResult
  57 block_plugin_gns_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   const struct GNUNET_GNSRECORD_Block *block;
  65   struct GNUNET_HashCode h;
  66   struct GNUNET_HashCode chash;
  67   struct GNUNET_HashCode mhash;
  68
  69   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
  70     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  71   if (NULL == reply_block)
  72   {
  73     if (0 != xquery_size)
  74     {
  75       GNUNET_break_op (0);
  76       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  77     }
  78     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  79   }
  80
  81   /* this is a reply */
  82   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
  83     {
  84       GNUNET_break_op (0);
  85       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  86     }
  87   block = reply_block;
  88   if (ntohl (block->purpose.size) + sizeof (struct GNUNET_CRYPTO_EcdsaSignature) + sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) !=
  89       reply_block_size)
  90     {
  91       GNUNET_break_op (0);
  92       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  93     }
  94   GNUNET_CRYPTO_hash (&block->derived_key,
  95                       sizeof (block->derived_key),
  96                       &h);
  97   if (0 != memcmp (&h, query, sizeof (struct GNUNET_HashCode)))
  98     {
  99       GNUNET_break_op (0);
 100       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 101     }
 102   if (GNUNET_OK !=
 103       GNUNET_GNSRECORD_block_verify (block))
 104     {
 105       GNUNET_break_op (0);
 106       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 107     }
 108   if (NULL != bf)
 109     {
 110       GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 111       GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 112       if (NULL != *bf)
 113         {
 114           if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test(*bf, &mhash))
 115             return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 116         }
 117       else
 118         {
 119           *bf = GNUNET_CONTAINER_bloomfilter_init(NULL, 8, BLOOMFILTER_K);
 120         }
 121       GNUNET_CONTAINER_bloomfilter_add(*bf, &mhash);
 122     }
 123   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 124 }
 125
 126
 127 /**
 128  * Function called to obtain the key for a block.
 129  *
 130  * @param cls closure
 131  * @param type block type
 132  * @param reply_block block to get the key for
 133  * @param reply_block_size number of bytes in @a reply_block
 134  * @param key set to the key (query) for the given block
 135  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 136  *         (or if extracting a key from a block of this type does not work)
 137  */
 138 static int
 139 block_plugin_gns_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 140                          const void *reply_block, size_t reply_block_size,
 141                          struct GNUNET_HashCode *key)
 142 {
 143   const struct GNUNET_GNSRECORD_Block *block;
 144
 145   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
 146     return GNUNET_SYSERR;
 147   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
 148     {
 149       GNUNET_break_op (0);
 150       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 151     }
 152   block = reply_block;
 153   GNUNET_CRYPTO_hash (&block->derived_key,
 154                       sizeof (block->derived_key),
 155                       key);
 156   return GNUNET_OK;
 157 }
 158
 159
 160 /**
 161  * Entry point for the plugin.
 162  */
 163 void *
 164 libgnunet_plugin_block_gns_init (void *cls)
 165 {
 166   static enum GNUNET_BLOCK_Type types[] =
 167   {
 168     GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
 169     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 170   };
 171   struct GNUNET_BLOCK_PluginFunctions *api;
 172
 173   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 174   api->evaluate = &block_plugin_gns_evaluate;
 175   api->get_key = &block_plugin_gns_get_key;
 176   api->types = types;
 177   return api;
 178 }
 179
 180
 181 /**
 182  * Exit point from the plugin.
 183  */
 184 void *
 185 libgnunet_plugin_block_gns_done (void *cls)
 186 {
 187   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 188
 189   GNUNET_free (api);
 190   return NULL;
 191 }
 192
 193 /* end of plugin_block_gns.c */