2 This file is part of GNUnet
3 Copyright (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 @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 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
80 if (reply_block_size < sizeof (struct GNUNET_MessageHeader))
83 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
86 if (reply_block_size != ntohs (msg->size))
89 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
92 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
95 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
99 GNUNET_CRYPTO_hash (&pid, sizeof (pid), &phash);
100 GNUNET_BLOCK_mingle_hash (&phash, bf_mutator, &mhash);
103 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
104 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
108 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8,
109 GNUNET_CONSTANTS_BLOOMFILTER_K);
111 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
113 return GNUNET_BLOCK_EVALUATION_OK_MORE;
118 * Function called to obtain the key for a block.
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 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)
129 block_plugin_dht_get_key (void *cls, enum GNUNET_BLOCK_Type type,
130 const void *block, size_t block_size,
131 struct GNUNET_HashCode * key)
133 const struct GNUNET_MessageHeader *msg;
134 const struct GNUNET_HELLO_Message *hello;
135 struct GNUNET_PeerIdentity *pid;
137 if (type != GNUNET_BLOCK_TYPE_DHT_HELLO)
138 return GNUNET_SYSERR;
139 if (block_size < sizeof (struct GNUNET_MessageHeader))
141 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
142 _("Block not of type %u\n"), GNUNET_BLOCK_TYPE_DHT_HELLO);
146 if (block_size != ntohs (msg->size))
148 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
149 _("Size mismatch for block\n"),
150 GNUNET_BLOCK_TYPE_DHT_HELLO);
154 memset (key, 0, sizeof (*key));
155 pid = (struct GNUNET_PeerIdentity *) key;
156 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, pid))
158 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "block-dht",
159 _("Block of type %u is malformed\n"),
160 GNUNET_BLOCK_TYPE_DHT_HELLO);
168 * Entry point for the plugin.
171 libgnunet_plugin_block_dht_init (void *cls)
173 static enum GNUNET_BLOCK_Type types[] =
175 GNUNET_BLOCK_TYPE_DHT_HELLO,
176 GNUNET_BLOCK_TYPE_ANY /* end of list */
178 struct GNUNET_BLOCK_PluginFunctions *api;
180 api = GNUNET_new (struct GNUNET_BLOCK_PluginFunctions);
181 api->evaluate = &block_plugin_dht_evaluate;
182 api->get_key = &block_plugin_dht_get_key;
189 * Exit point from the plugin.
192 libgnunet_plugin_block_dht_done (void *cls)
194 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
200 /* end of plugin_block_dht.c */