2 This file is part of GNUnet
3 Copyright (C) 2010 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, 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 @a reply_block.
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
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,
62 const void *reply_block,
63 size_t reply_block_size)
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;
71 if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
72 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
76 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
78 if ( (NULL == reply_block) ||
79 (0 == reply_block_size) )
80 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
81 if (reply_block_size < sizeof (struct GNUNET_MessageHeader))
84 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
87 if (reply_block_size != ntohs (msg->size))
90 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
93 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
96 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
100 GNUNET_CRYPTO_hash (&pid, sizeof (pid), &phash);
101 GNUNET_BLOCK_mingle_hash (&phash, bf_mutator, &mhash);
104 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
105 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
109 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8,
110 GNUNET_CONSTANTS_BLOOMFILTER_K);
112 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
114 return GNUNET_BLOCK_EVALUATION_OK_MORE;
119 * Function called to obtain the key for a block.
122 * @param type block type
123 * @param block block to get the key for
124 * @param block_size number of bytes @a block
125 * @param[out] key set to the key (query) for the given block
126 * @return #GNUNET_OK on success, #GNUNET_SYSERR if type not supported
127 * (or if extracting a key from a block of this type does not work)
130 block_plugin_dht_get_key (void *cls,
131 enum GNUNET_BLOCK_Type type,
134 struct GNUNET_HashCode *key)
136 const struct GNUNET_MessageHeader *msg;
137 const struct GNUNET_HELLO_Message *hello;
138 struct GNUNET_PeerIdentity *pid;
140 if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
141 return GNUNET_SYSERR;
142 if (block_size < sizeof (struct GNUNET_MessageHeader))
144 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
145 _("Block not of type %u\n"), GNUNET_BLOCK_TYPE_DHT_HELLO);
149 if (block_size != ntohs (msg->size))
151 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
152 _("Size mismatch for block\n"),
153 GNUNET_BLOCK_TYPE_DHT_HELLO);
157 memset (key, 0, sizeof (*key));
158 pid = (struct GNUNET_PeerIdentity *) key;
159 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, pid))
161 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
162 _("Block of type %u is malformed\n"),
163 GNUNET_BLOCK_TYPE_DHT_HELLO);
171 * Entry point for the plugin.
174 libgnunet_plugin_block_dht_init (void *cls)
176 static enum GNUNET_BLOCK_Type types[] =
178 GNUNET_BLOCK_TYPE_DHT_HELLO,
179 GNUNET_BLOCK_TYPE_ANY /* end of list */
181 struct GNUNET_BLOCK_PluginFunctions *api;
183 api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
184 api->evaluate = &block_plugin_dht_evaluate;
185 api->get_key = &block_plugin_dht_get_key;
192 * Exit point from the plugin.
195 libgnunet_plugin_block_dht_done (void *cls)
197 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
203 /* end of plugin_block_dht.c */