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 block/plugin_block_fs.c
23 * @brief blocks used for file-sharing
24 * @author Christian Grothoff
28 #include "plugin_block.h"
30 #include "gnunet_signatures.h"
32 #define DEBUG_FS_BLOCK GNUNET_NO
35 * Number of bits we set per entry in the bloomfilter.
38 #define BLOOMFILTER_K 16
41 * Function called to validate a reply or a request. For
42 * request evaluation, simply pass "NULL" for the reply_block.
43 * Note that it is assumed that the reply has already been
44 * matched to the key (and signatures checked) as it would
45 * be done with the "get_key" function.
48 * @param type block type
49 * @param query original query (hash)
50 * @param bf pointer to bloom filter associated with query; possibly updated (!)
51 * @param bf_mutator mutation value for bf
52 * @param xquery extrended query data (can be NULL, depending on type)
53 * @param xquery_size number of bytes in xquery
54 * @param reply_block response to validate
55 * @param reply_block_size number of bytes in reply block
56 * @return characterization of result
58 static enum GNUNET_BLOCK_EvaluationResult
59 block_plugin_fs_evaluate (void *cls,
60 enum GNUNET_BLOCK_Type type,
61 const GNUNET_HashCode *query,
62 struct GNUNET_CONTAINER_BloomFilter **bf,
66 const void *reply_block,
67 size_t reply_block_size)
69 const struct SBlock *sb;
70 GNUNET_HashCode chash;
71 GNUNET_HashCode mhash;
72 const GNUNET_HashCode *nsid;
77 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
78 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
82 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
84 if (reply_block == NULL)
85 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
86 return GNUNET_BLOCK_EVALUATION_OK_LAST;
87 case GNUNET_BLOCK_TYPE_FS_KBLOCK:
88 case GNUNET_BLOCK_TYPE_FS_NBLOCK:
92 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
94 if (reply_block == NULL)
95 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
96 GNUNET_CRYPTO_hash (reply_block,
99 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
102 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf,
104 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
108 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
112 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
113 return GNUNET_BLOCK_EVALUATION_OK_MORE;
114 case GNUNET_BLOCK_TYPE_FS_SBLOCK:
115 if (xquery_size != sizeof (GNUNET_HashCode))
118 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
120 if (reply_block == NULL)
121 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
123 if (reply_block_size < sizeof (struct SBlock))
126 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
129 GNUNET_CRYPTO_hash (&sb->subspace,
130 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
132 if (0 != memcmp (nsid,
134 sizeof (GNUNET_HashCode)))
136 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
138 _("Reply mismatched in terms of namespace. Discarded.\n"));
139 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
141 GNUNET_CRYPTO_hash (reply_block,
144 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
147 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf,
149 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
153 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL,
157 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
158 return GNUNET_BLOCK_EVALUATION_OK_MORE;
160 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
166 * Function called to obtain the key for a block.
169 * @param type block type
170 * @param block block to get the key for
171 * @param block_size number of bytes in block
172 * @param key set to the key (query) for the given block
173 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
174 * (or if extracting a key from a block of this type does not work)
177 block_plugin_fs_get_key (void *cls,
178 enum GNUNET_BLOCK_Type type,
181 GNUNET_HashCode *key)
183 const struct KBlock *kb;
184 const struct SBlock *sb;
185 const struct NBlock *nb;
189 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
190 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
191 GNUNET_CRYPTO_hash (block, block_size, key);
193 case GNUNET_BLOCK_TYPE_FS_KBLOCK:
194 if (block_size < sizeof (struct KBlock))
197 return GNUNET_SYSERR;
200 if (block_size - sizeof (struct KBlock) !=
201 ntohl (kb->purpose.size)
202 - sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose)
203 - sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) )
206 return GNUNET_SYSERR;
209 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_KBLOCK,
215 return GNUNET_SYSERR;
218 GNUNET_CRYPTO_hash (&kb->keyspace,
219 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
222 case GNUNET_BLOCK_TYPE_FS_SBLOCK:
223 if (block_size < sizeof (struct SBlock))
226 return GNUNET_SYSERR;
230 ntohl (sb->purpose.size) + sizeof (struct GNUNET_CRYPTO_RsaSignature))
233 return GNUNET_SYSERR;
236 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_SBLOCK,
242 return GNUNET_SYSERR;
245 *key = sb->identifier;
247 case GNUNET_BLOCK_TYPE_FS_NBLOCK:
248 if (block_size < sizeof (struct NBlock))
251 return GNUNET_SYSERR;
254 if (block_size - sizeof (struct NBlock) !=
255 ntohl (nb->ns_purpose.size)
256 - sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose)
257 - sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) )
260 return GNUNET_SYSERR;
263 ntohl (nb->ksk_purpose.size) + sizeof (struct GNUNET_CRYPTO_RsaSignature))
266 return GNUNET_SYSERR;
269 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK_KSIG,
275 return GNUNET_SYSERR;
278 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK,
284 return GNUNET_SYSERR;
286 /* FIXME: we used to xor ID with NSID,
289 GNUNET_CRYPTO_hash (&nb->keyspace,
290 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
294 return GNUNET_SYSERR;
300 * Entry point for the plugin.
303 libgnunet_plugin_block_fs_init (void *cls)
305 static enum GNUNET_BLOCK_Type types[] =
307 GNUNET_BLOCK_TYPE_FS_DBLOCK,
308 GNUNET_BLOCK_TYPE_FS_IBLOCK,
309 GNUNET_BLOCK_TYPE_FS_KBLOCK,
310 GNUNET_BLOCK_TYPE_FS_SBLOCK,
311 GNUNET_BLOCK_TYPE_FS_NBLOCK,
312 GNUNET_BLOCK_TYPE_ANY /* end of list */
314 struct GNUNET_BLOCK_PluginFunctions *api;
316 api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
317 api->evaluate = &block_plugin_fs_evaluate;
318 api->get_key = &block_plugin_fs_get_key;
325 * Exit point from the plugin.
328 libgnunet_plugin_block_fs_done (void *cls)
330 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
336 /* end of plugin_block_fs.c */