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