src/dht/plugin_block_dht.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2010 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 dht/plugin_block_dht.c
  23  * @brief block plugin for DHT internals (right now, find-peer requests only);
  24  *        other plugins should be used to store "useful" data in the
  25  *        DHT (see fs block plugin)
  26  * @author Christian Grothoff
  27  */
  28
  29 #include "platform.h"
  30 #include "gnunet_constants.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_block_plugin.h"
  33
  34 #define DEBUG_DHT GNUNET_EXTRA_LOGGING
  35
  36
  37 /**
  38  * Function called to validate a reply or a request.  For
  39  * request evaluation, simply pass "NULL" for the @a reply_block.
  40  *
  41  * @param cls closure
  42  * @param type block type
  43  * @param eo control flags
  44  * @param query original query (hash)
  45  * @param bf pointer to bloom filter associated with query; possibly updated (!)
  46  * @param bf_mutator mutation value for @a bf
  47  * @param xquery extended query data (can be NULL, depending on type)
  48  * @param xquery_size number of bytes in @a xquery
  49  * @param reply_block response to validate
  50  * @param reply_block_size number of bytes in @a reply_block
  51  * @return characterization of result
  52  */
  53 static enum GNUNET_BLOCK_EvaluationResult
  54 block_plugin_dht_evaluate (void *cls,
  55                            enum GNUNET_BLOCK_Type type,
  56                            enum GNUNET_BLOCK_EvaluationOptions eo,
  57                            const struct GNUNET_HashCode *query,
  58                            struct GNUNET_CONTAINER_BloomFilter **bf,
  59                            int32_t bf_mutator,
  60                            const void *xquery,
  61                            size_t xquery_size,
  62                            const void *reply_block,
  63                            size_t reply_block_size)
  64 {
  65   struct GNUNET_HashCode mhash;
  66   const struct GNUNET_HELLO_Message *hello;
  67   struct GNUNET_PeerIdentity pid;
  68   const struct GNUNET_MessageHeader *msg;
  69   struct GNUNET_HashCode phash;
  70
  71   if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
  72     return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
  73   if (0 != xquery_size)
  74   {
  75     GNUNET_break_op (0);
  76     return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
  77   }
  78   if (NULL == reply_block)
  79     return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
  80   if (reply_block_size < sizeof (struct GNUNET_MessageHeader))
  81   {
  82     GNUNET_break_op (0);
  83     return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  84   }
  85   msg = reply_block;
  86   if (reply_block_size != ntohs (msg->size))
  87   {
  88     GNUNET_break_op (0);
  89     return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  90   }
  91   hello = reply_block;
  92   if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
  93   {
  94     GNUNET_break_op (0);
  95     return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
  96   }
  97   if (NULL != bf)
  98   {
  99     GNUNET_CRYPTO_hash (&pid, sizeof (pid), &phash);
 100     GNUNET_BLOCK_mingle_hash (&phash, bf_mutator, &mhash);
 101     if (NULL != *bf)
 102     {
 103       if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
 104         return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
 105     }
 106     else
 107     {
 108       *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8,
 109                                                GNUNET_CONSTANTS_BLOOMFILTER_K);
 110     }
 111     GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
 112   }
 113   return GNUNET_BLOCK_EVALUATION_OK_MORE;
 114 }
 115
 116
 117 /**
 118  * Function called to obtain the key for a block.
 119  *
 120  * @param cls closure
 121  * @param type block type
 122  * @param block block to get the key for
 123  * @param block_size number of bytes @a block
 124  * @param[out] key set to the key (query) for the given block
 125  * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
 126  *         (or if extracting a key from a block of this type does not work)
 127  */
 128 static int
 129 block_plugin_dht_get_key (void *cls,
 130                           enum GNUNET_BLOCK_Type type,
 131                           const void *block,
 132                           size_t block_size,
 133                           struct GNUNET_HashCode *key)
 134 {
 135   const struct GNUNET_MessageHeader *msg;
 136   const struct GNUNET_HELLO_Message *hello;
 137   struct GNUNET_PeerIdentity *pid;
 138
 139   if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
 140     return GNUNET_SYSERR;
 141   if (block_size < sizeof (struct GNUNET_MessageHeader))
 142   {
 143     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
 144                      _("Block not of type %u\n"), GNUNET_BLOCK_TYPE_DHT_HELLO);
 145     return GNUNET_NO;
 146   }
 147   msg = block;
 148   if (block_size != ntohs (msg->size))
 149   {
 150     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
 151                      _("Size mismatch for block\n"),
 152                      GNUNET_BLOCK_TYPE_DHT_HELLO);
 153     return GNUNET_NO;
 154   }
 155   hello = block;
 156   memset (key, 0, sizeof (*key));
 157   pid = (struct GNUNET_PeerIdentity *) key;
 158   if (GNUNET_OK != GNUNET_HELLO_get_id (hello, pid))
 159   {
 160     GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
 161                      _("Block of type %u is malformed\n"),
 162                      GNUNET_BLOCK_TYPE_DHT_HELLO);
 163     return GNUNET_NO;
 164   }
 165   return GNUNET_OK;
 166 }
 167
 168
 169 /**
 170  * Entry point for the plugin.
 171  */
 172 void *
 173 libgnunet_plugin_block_dht_init (void *cls)
 174 {
 175   static enum GNUNET_BLOCK_Type types[] =
 176   {
 177     GNUNET_BLOCK_TYPE_DHT_HELLO,
 178     GNUNET_BLOCK_TYPE_ANY       /* end of list */
 179   };
 180   struct GNUNET_BLOCK_PluginFunctions *api;
 181
 182   api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
 183   api->evaluate = &block_plugin_dht_evaluate;
 184   api->get_key = &block_plugin_dht_get_key;
 185   api->types = types;
 186   return api;
 187 }
 188
 189
 190 /**
 191  * Exit point from the plugin.
 192  */
 193 void *
 194 libgnunet_plugin_block_dht_done (void *cls)
 195 {
 196   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 197
 198   GNUNET_free (api);
 199   return NULL;
 200 }
 201
 202 /* end of plugin_block_dht.c */