src/gns/plugin_block_gns.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2010-2013 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, 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 eo control flags
  48  * @param query original query (hash)
  49  * @param bf pointer to bloom filter associated with @a query; possibly updated (!)
  50  * @param bf_mutator mutation value for @a bf
  51  * @param xquery extrended query data (can be NULL, depending on @a type)
  52  * @param xquery_size number of bytes in @a xquery
  53  * @param reply_block response to validate
  54  * @param reply_block_size number of bytes in @a reply_block
  55  * @return characterization of result
  56  */
  57 static enum GNUNET_BLOCK_EvaluationResult
  58 block_plugin_gns_evaluate (void *cls,
  59                            enum GNUNET_BLOCK_Type type,
  60                            enum GNUNET_BLOCK_EvaluationOptions eo,
  61                            const struct GNUNET_HashCode *query,
  62                            struct GNUNET_CONTAINER_BloomFilter **bf,
  63                            int32_t bf_mutator,
  64                            const void *xquery,
  65                            size_t xquery_size,
  66                            const void *reply_block,
  67                            size_t reply_block_size)
  68 {
  69   const struct GNUNET_GNSRECORD_Block *block;
  70   struct GNUNET_HashCode h;
  71   struct GNUNET_HashCode chash;
  72   struct GNUNET_HashCode mhash;
  73
  74   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
  75     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  76   if (NULL == reply_block)
  77   {
  78     if (0 != xquery_size)
  79     {
  80       GNUNET_break_op (0);
  81       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  82     }
  83     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  84   }
  85
  86   /* this is a reply */
  87   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
  88     {
  89       GNUNET_break_op (0);
  90       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  91     }
  92   block = reply_block;
  93   if (ntohl (block->purpose.size) + sizeof (struct GNUNET_CRYPTO_EcdsaSignature) + sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) !=
  94       reply_block_size)
  95     {
  96       GNUNET_break_op (0);
  97       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  98     }
  99   GNUNET_CRYPTO_hash (&block->derived_key,
 100                       sizeof (block->derived_key),
 101                       &h);
 102   if (0 != memcmp (&h, query, sizeof (struct GNUNET_HashCode)))
 103     {
 104       GNUNET_break_op (0);
 105       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 106     }
 107   if (GNUNET_OK !=
 108       GNUNET_GNSRECORD_block_verify (block))
 109     {
 110       GNUNET_break_op (0);
 111       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 112     }
 113   if (NULL != bf)
 114     {
 115       GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
 116       GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
 117       if (NULL != *bf)
 118         {
 119           if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test(*bf, &mhash))
 120             return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 121         }
 122       else
 123         {
 124           *bf = GNUNET_CONTAINER_bloomfilter_init(NULL, 8, BLOOMFILTER_K);
 125         }
 126       GNUNET_CONTAINER_bloomfilter_add(*bf, &mhash);
 127     }
 128   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 129 }
 130
 131
 132 /**
 133  * Function called to obtain the key for a block.
 134  *
 135  * @param cls closure
 136  * @param type block type
 137  * @param reply_block block to get the key for
 138  * @param reply_block_size number of bytes in @a reply_block
 139  * @param key set to the key (query) for the given block
 140  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 141  *         (or if extracting a key from a block of this type does not work)
 142  */
 143 static int
 144 block_plugin_gns_get_key (void *cls, enum GNUNET_BLOCK_Type type,
 145                          const void *reply_block, size_t reply_block_size,
 146                          struct GNUNET_HashCode *key)
 147 {
 148   const struct GNUNET_GNSRECORD_Block *block;
 149
 150   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
 151     return GNUNET_SYSERR;
 152   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
 153     {
 154       GNUNET_break_op (0);
 155       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 156     }
 157   block = reply_block;
 158   GNUNET_CRYPTO_hash (&block->derived_key,
 159                       sizeof (block->derived_key),
 160                       key);
 161   return GNUNET_OK;
 162 }
 163
 164
 165 /**
 166  * Entry point for the plugin.
 167  */
 168 void *
 169 libgnunet_plugin_block_gns_init (void *cls)
 170 {
 171   static enum GNUNET_BLOCK_Type types[] =
 172   {
 173     GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
 174     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 175   };
 176   struct GNUNET_BLOCK_PluginFunctions *api;
 177
 178   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 179   api->evaluate = &block_plugin_gns_evaluate;
 180   api->get_key = &block_plugin_gns_get_key;
 181   api->types = types;
 182   return api;
 183 }
 184
 185
 186 /**
 187  * Exit point from the plugin.
 188  */
 189 void *
 190 libgnunet_plugin_block_gns_done (void *cls)
 191 {
 192   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 193
 194   GNUNET_free (api);
 195   return NULL;
 196 }
 197
 198 /* end of plugin_block_gns.c */