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  * How many bytes should a bloomfilter be if we have already seen
  48  * entry_count responses?  Note that #GNUNET_CONSTANTS_BLOOMFILTER_K
  49  * gives us the number of bits set per entry.  Furthermore, we should
  50  * not re-size the filter too often (to keep it cheap).
  51  *
  52  * Since other peers will also add entries but not resize the filter,
  53  * we should generally pick a slightly larger size than what the
  54  * strict math would suggest.
  55  *
  56  * @param entry_count expected number of entries in the Bloom filter
  57  * @return must be a power of two and smaller or equal to 2^15.
  58  */
  59 static size_t
  60 compute_bloomfilter_size (unsigned int entry_count)
  61 {
  62   size_t size;
  63   unsigned int ideal = (entry_count * BLOOMFILTER_K) / 4;
  64   uint16_t max = 1 << 15;
  65
  66   if (entry_count > max)
  67     return max;
  68   size = 8;
  69   while ((size < max) && (size < ideal))
  70     size *= 2;
  71   if (size > max)
  72     return max;
  73   return size;
  74 }
  75
  76
  77 /**
  78  * Create a new block group.
  79  *
  80  * @param ctx block context in which the block group is created
  81  * @param type type of the block for which we are creating the group
  82  * @param nonce random value used to seed the group creation
  83  * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
  84  * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
  85  * @param va variable arguments specific to @a type
  86  * @return block group handle, NULL if block groups are not supported
  87  *         by this @a type of block (this is not an error)
  88  */
  89 static struct GNUNET_BLOCK_Group *
  90 block_plugin_gns_create_group (void *cls,
  91                                enum GNUNET_BLOCK_Type type,
  92                                uint32_t nonce,
  93                                const void *raw_data,
  94                                size_t raw_data_size,
  95                                va_list va)
  96 {
  97   unsigned int bf_size;
  98   const char *guard;
  99
 100   guard = va_arg (va, const char *);
 101   if (0 == strcmp (guard,
 102                    "seen-set-size"))
 103     bf_size = compute_bloomfilter_size (va_arg (va, unsigned int));
 104   else if (0 == strcmp (guard,
 105                         "filter-size"))
 106     bf_size = va_arg (va, unsigned int);
 107   else
 108   {
 109     GNUNET_break (0);
 110     bf_size = GNS_BF_SIZE;
 111   }
 112   GNUNET_break (NULL == va_arg (va, const char *));
 113   return GNUNET_BLOCK_GROUP_bf_create (cls,
 114                                        bf_size,
 115                                        BLOOMFILTER_K,
 116                                        type,
 117                                        nonce,
 118                                        raw_data,
 119                                        raw_data_size);
 120 }
 121
 122
 123 /**
 124  * Function called to validate a reply or a request.  For
 125  * request evaluation, simply pass "NULL" for the reply_block.
 126  * Note that it is assumed that the reply has already been
 127  * matched to the key (and signatures checked) as it would
 128  * be done with the "get_key" function.
 129  *
 130  * @param cls closure
 131  * @param type block type
 132  * @param bg block group to use for evaluation
 133  * @param eo control flags
 134  * @param query original query (hash)
 135  * @param xquery extrended query data (can be NULL, depending on @a type)
 136  * @param xquery_size number of bytes in @a xquery
 137  * @param reply_block response to validate
 138  * @param reply_block_size number of bytes in @a reply_block
 139  * @return characterization of result
 140  */
 141 static enum GNUNET_BLOCK_EvaluationResult
 142 block_plugin_gns_evaluate (void *cls,
 143                            enum GNUNET_BLOCK_Type type,
 144                            struct GNUNET_BLOCK_Group *bg,
 145                            enum GNUNET_BLOCK_EvaluationOptions eo,
 146                            const struct GNUNET_HashCode *query,
 147                            const void *xquery,
 148                            size_t xquery_size,
 149                            const void *reply_block,
 150                            size_t reply_block_size)
 151 {
 152   const struct GNUNET_GNSRECORD_Block *block;
 153   struct GNUNET_HashCode h;
 154   struct GNUNET_HashCode chash;
 155
 156   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
 157     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
 158   if (NULL == reply_block)
 159   {
 160     if (0 != xquery_size)
 161     {
 162       GNUNET_break_op (0);
 163       return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
 164     }
 165     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
 166   }
 167
 168   /* this is a reply */
 169   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
 170     {
 171       GNUNET_break_op (0);
 172       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 173     }
 174   block = reply_block;
 175   if (ntohl (block->purpose.size) + sizeof (struct GNUNET_CRYPTO_EcdsaSignature) + sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) !=
 176       reply_block_size)
 177     {
 178       GNUNET_break_op (0);
 179       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 180     }
 181   GNUNET_CRYPTO_hash (&block->derived_key,
 182                       sizeof (block->derived_key),
 183                       &h);
 184   if (0 != memcmp (&h, query, sizeof (struct GNUNET_HashCode)))
 185     {
 186       GNUNET_break_op (0);
 187       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 188     }
 189   if (GNUNET_OK !=
 190       GNUNET_GNSRECORD_block_verify (block))
 191     {
 192       GNUNET_break_op (0);
 193       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 194     }
 195   GNUNET_CRYPTO_hash (reply_block,
 196                       reply_block_size,
 197                       &chash);
 198   if (GNUNET_YES ==
 199       GNUNET_BLOCK_GROUP_bf_test_and_set (bg,
 200                                           &chash))
 201     return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 202   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 203 }
 204
 205
 206 /**
 207  * Function called to obtain the key for a block.
 208  *
 209  * @param cls closure
 210  * @param type block type
 211  * @param reply_block block to get the key for
 212  * @param reply_block_size number of bytes in @a reply_block
 213  * @param key set to the key (query) for the given block
 214  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 215  *         (or if extracting a key from a block of this type does not work)
 216  */
 217 static int
 218 block_plugin_gns_get_key (void *cls,
 219                           enum GNUNET_BLOCK_Type type,
 220                           const void *reply_block,
 221                           size_t reply_block_size,
 222                           struct GNUNET_HashCode *key)
 223 {
 224   const struct GNUNET_GNSRECORD_Block *block;
 225
 226   if (type != GNUNET_BLOCK_TYPE_GNS_NAMERECORD)
 227     return GNUNET_SYSERR;
 228   if (reply_block_size < sizeof (struct GNUNET_GNSRECORD_Block))
 229     {
 230       GNUNET_break_op (0);
 231       return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
 232     }
 233   block = reply_block;
 234   GNUNET_CRYPTO_hash (&block->derived_key,
 235                       sizeof (block->derived_key),
 236                       key);
 237   return GNUNET_OK;
 238 }
 239
 240
 241 /**
 242  * Entry point for the plugin.
 243  */
 244 void *
 245 libgnunet_plugin_block_gns_init (void *cls)
 246 {
 247   static enum GNUNET_BLOCK_Type types[] =
 248   {
 249     GNUNET_BLOCK_TYPE_GNS_NAMERECORD,
 250     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 251   };
 252   struct GNUNET_BLOCK_PluginFunctions *api;
 253
 254   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 255   api->evaluate = &block_plugin_gns_evaluate;
 256   api->get_key = &block_plugin_gns_get_key;
 257   api->create_group = &block_plugin_gns_create_group;
 258   api->types = types;
 259   return api;
 260 }
 261
 262
 263 /**
 264  * Exit point from the plugin.
 265  */
 266 void *
 267 libgnunet_plugin_block_gns_done (void *cls)
 268 {
 269   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 270
 271   GNUNET_free (api);
 272   return NULL;
 273 }
 274
 275 /* end of plugin_block_gns.c */