2 This file is part of GNUnet
3 (C) 2010 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
30 #include "gnunet_constants.h"
31 #include "gnunet_hello_lib.h"
32 #include "gnunet_block_plugin.h"
34 #define DEBUG_DHT GNUNET_EXTRA_LOGGING
38 * Function called to validate a reply or a request. For
39 * request evaluation, simply pass "NULL" for the reply_block.
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 bf
46 * @param xquery extended query data (can be NULL, depending on type)
47 * @param xquery_size number of bytes in xquery
48 * @param reply_block response to validate
49 * @param reply_block_size number of bytes in reply block
50 * @return characterization of result
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)
60 struct GNUNET_HashCode mhash;
61 const struct GNUNET_HELLO_Message *hello;
62 struct GNUNET_PeerIdentity pid;
63 const struct GNUNET_MessageHeader *msg;
65 if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
66 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
70 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
72 if (NULL == reply_block)
73 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
74 if (reply_block_size < sizeof (struct GNUNET_MessageHeader))
77 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
80 if (reply_block_size != ntohs (msg->size))
83 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
86 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
89 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
93 GNUNET_BLOCK_mingle_hash (&pid.hashPubKey, bf_mutator, &mhash);
96 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
97 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
102 GNUNET_CONTAINER_bloomfilter_init (NULL, 8,
103 GNUNET_CONSTANTS_BLOOMFILTER_K);
105 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
107 return GNUNET_BLOCK_EVALUATION_OK_MORE;
112 * Function called to obtain the key for a block.
115 * @param type block type
116 * @param block block to get the key for
117 * @param block_size number of bytes in block
118 * @param key set to the key (query) for the given block
119 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
120 * (or if extracting a key from a block of this type does not work)
123 block_plugin_dht_get_key (void *cls, enum GNUNET_BLOCK_Type type,
124 const void *block, size_t block_size,
125 struct GNUNET_HashCode * key)
127 const struct GNUNET_MessageHeader *msg;
128 const struct GNUNET_HELLO_Message *hello;
129 struct GNUNET_PeerIdentity *pid;
131 if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
132 return GNUNET_SYSERR;
133 if (block_size < sizeof (struct GNUNET_MessageHeader))
135 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
136 _("Block not of type %u\n"), GNUNET_BLOCK_TYPE_DHT_HELLO);
140 if (block_size != ntohs (msg->size))
142 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
143 _("Size mismatch for block\n"),
144 GNUNET_BLOCK_TYPE_DHT_HELLO);
148 pid = (struct GNUNET_PeerIdentity *) key;
149 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, pid))
151 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
152 _("Block of type %u is malformed\n"),
153 GNUNET_BLOCK_TYPE_DHT_HELLO);
161 * Entry point for the plugin.
164 libgnunet_plugin_block_dht_init (void *cls)
166 static enum GNUNET_BLOCK_Type types[] =
168 GNUNET_BLOCK_TYPE_DHT_HELLO,
169 GNUNET_BLOCK_TYPE_ANY /* end of list */
171 struct GNUNET_BLOCK_PluginFunctions *api;
173 api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
174 api->evaluate = &block_plugin_dht_evaluate;
175 api->get_key = &block_plugin_dht_get_key;
182 * Exit point from the plugin.
185 libgnunet_plugin_block_dht_done (void *cls)
187 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
193 /* end of plugin_block_dht.c */