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  * @author Christian Grothoff
  26  */
  27
  28 #include "platform.h"
  29 #include "gnunet_block_group_lib.h"
  30 #include "gnunet_block_plugin.h"
  31 #include "gnunet_namestore_service.h"
  32 #include "gnunet_signatures.h"
  33
  34 /**
  35  * Number of bits we set per entry in the bloomfilter.
  36  * Do not change! -from fs
  37  */
  38 #define BLOOMFILTER_K 16
  39
  40 /**
  41  * How big is the BF we use for GNS blocks?
  42  */
  43 #define GNS_BF_SIZE 8
  44
  45
  46 /**
  47  * Create a new block group.
  48  *
  49  * @param ctx block context in which the block group is created
  50  * @param type type of the block for which we are creating the group
  51  * @param nonce random value used to seed the group creation
  52  * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
  53  * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
  54  * @param va variable arguments specific to @a type
  55  * @return block group handle, NULL if block groups are not supported
  56  *         by this @a type of block (this is not an error)
  57  */
  58 static struct GNUNET_BLOCK_Group *
  59 block_plugin_gns_create_group (void *cls,
  60                                enum GNUNET_BLOCK_Type type,
  61                                uint32_t nonce,
  62                                const void *raw_data,
  63                                size_t raw_data_size,
  64                                va_list va)
  65 {
  66   unsigned int bf_size;
  67   const char *guard;
  68
  69   guard = va_arg (va, const char *);
  70   if (0 == strcmp (guard,
  71                    "seen-set-size"))
  72     bf_size = GNUNET_BLOCK_GROUP_compute_bloomfilter_size (va_arg (va, unsigned int),
  73                                                            BLOOMFILTER_K);
  74   else if (0 == strcmp (guard,
  75                         "filter-size"))
  76     bf_size = va_arg (va, unsigned int);
  77   else
  78   {
  79     GNUNET_break (0);
  80     bf_size = GNS_BF_SIZE;
  81   }
  82   GNUNET_break (NULL == va_arg (va, const char *));
  83   return GNUNET_BLOCK_GROUP_bf_create (cls,
  84                                        bf_size,
  85                                        BLOOMFILTER_K,
  86                                        type,
  87                                        nonce,
  88                                        raw_data,
  89                                        raw_data_size);
  90 }
  91
  92
  93 /**
  94  * Function called to validate a reply or a request.  For
  95  * request evaluation, simply pass "NULL" for the reply_block.
  96  * Note that it is assumed that the reply has already been
  97  * matched to the key (and signatures checked) as it would
  98  * be done with the "get_key" function.
  99  *
 100  * @param cls closure
 101  * @param ctx block context
 102  * @param type block type
 103  * @param bg block group to use for evaluation
 104  * @param eo control flags
 105  * @param query original query (hash)
 106  * @param xquery extrended query data (can be NULL, depending on @a type)
 107  * @param xquery_size number of bytes in @a xquery
 108  * @param reply_block response to validate
 109  * @param reply_block_size number of bytes in @a reply_block
 110  * @return characterization of result
 111  */
 112 static enum GNUNET_BLOCK_EvaluationResult
 113 block_plugin_gns_evaluate (void *cls,
 114                            struct GNUNET_BLOCK_Context *ctx,
 115                            enum GNUNET_BLOCK_Type type,
 116                            struct GNUNET_BLOCK_Group *bg,
 117                            enum GNUNET_BLOCK_EvaluationOptions eo,
 118                            const struct GNUNET_HashCode *query,
 119                            const void *xquery,
 120                            size_t xquery_size,
 121                            const void *reply_block,
 122                            size_t reply_block_size)
 123 {
 124   const struct GNUNET_GNSRECORD_Block *block;
 125   struct GNUNET_HashCode h;
 126   struct GNUNET_HashCode chash;
 127
 128   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
 129     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 130   if (NULL == reply_block)
 131   {
 132     if (0 != xquery_size)
 133     {
 134       GNUNET_break_op (0);
 135       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 136     }
 137     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 138   }
 139
 140   /* this is a reply */
 141   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
 142     {
 143       GNUNET_break_op (0);
 144       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 145     }
 146   block = reply_block;
 147   if (ntohl (block->purpose.size) + sizeof (struct GNUNET_CRYPTO_EcdsaSignature) + sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) !=
 148       reply_block_size)
 149     {
 150       GNUNET_break_op (0);
 151       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 152     }
 153   GNUNET_CRYPTO_hash (&block->derived_key,
 154                       sizeof (block->derived_key),
 155                       &h);
 156   if (0 != memcmp (&h, query, sizeof (struct GNUNET_HashCode)))
 157     {
 158       GNUNET_break_op (0);
 159       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 160     }
 161   if (GNUNET_OK !=
 162       GNUNET_GNSRECORD_block_verify (block))
 163     {
 164       GNUNET_break_op (0);
 165       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 166     }
 167   GNUNET_CRYPTO_hash (reply_block,
 168                       reply_block_size,
 169                       &chash);
 170   if (GNUNET_YES ==
 171       GNUNET_BLOCK_GROUP_bf_test_and_set (bg,
 172                                           &chash))
 173     return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 174   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 175 }
 176
 177
 178 /**
 179  * Function called to obtain the key for a block.
 180  *
 181  * @param cls closure
 182  * @param type block type
 183  * @param reply_block block to get the key for
 184  * @param reply_block_size number of bytes in @a reply_block
 185  * @param key set to the key (query) for the given block
 186  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 187  *         (or if extracting a key from a block of this type does not work)
 188  */
 189 static int
 190 block_plugin_gns_get_key (void *cls,
 191                           enum GNUNET_BLOCK_Type type,
 192                           const void *reply_block,
 193                           size_t reply_block_size,
 194                           struct GNUNET_HashCode *key)
 195 {
 196   const struct GNUNET_GNSRECORD_Block *block;
 197
 198   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
 199     return GNUNET_SYSERR;
 200   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
 201     {
 202       GNUNET_break_op (0);
 203       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 204     }
 205   block = reply_block;
 206   GNUNET_CRYPTO_hash (&block->derived_key,
 207                       sizeof (block->derived_key),
 208                       key);
 209   return GNUNET_OK;
 210 }
 211
 212
 213 /**
 214  * Entry point for the plugin.
 215  */
 216 void *
 217 libgnunet_plugin_block_gns_init (void *cls)
 218 {
 219   static enum GNUNET_BLOCK_Type types[] =
 220   {
 221     GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
 222     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 223   };
 224   struct GNUNET_BLOCK_PluginFunctions *api;
 225
 226   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 227   api->evaluate = &block_plugin_gns_evaluate;
 228   api->get_key = &block_plugin_gns_get_key;
 229   api->create_group = &block_plugin_gns_create_group;
 230   api->types = types;
 231   return api;
 232 }
 233
 234
 235 /**
 236  * Exit point from the plugin.
 237  */
 238 void *
 239 libgnunet_plugin_block_gns_done (void *cls)
 240 {
 241   struct GNUNET_BLOCK_PluginFunctions *api = cls;
 242
 243   GNUNET_free (api);
 244   return NULL;
 245 }
 246
 247 /* end of plugin_block_gns.c */