src/dht/plugin_block_dht.c

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