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 fs/plugin_block_fs.c
23 * @brief blocks used for file-sharing
24 * @author Christian Grothoff
28 #include "gnunet_block_plugin.h"
30 #include "gnunet_signatures.h"
34 * Number of bits we set per entry in the bloomfilter.
37 #define BLOOMFILTER_K 16
40 * Function called to validate a reply or a request. For
41 * request evaluation, simply pass "NULL" for the reply_block.
42 * Note that it is assumed that the reply has already been
43 * matched to the key (and signatures checked) as it would
44 * be done with the "get_key" function.
47 * @param type block type
48 * @param query original query (hash)
49 * @param bf pointer to bloom filter associated with query; possibly updated (!)
50 * @param bf_mutator mutation value for bf
51 * @param xquery extrended query data (can be NULL, depending on type)
52 * @param xquery_size number of bytes in xquery
53 * @param reply_block response to validate
54 * @param reply_block_size number of bytes in reply block
55 * @return characterization of result
57 static enum GNUNET_BLOCK_EvaluationResult
58 block_plugin_fs_evaluate (void *cls, enum GNUNET_BLOCK_Type type,
59 const struct GNUNET_HashCode * query,
60 struct GNUNET_CONTAINER_BloomFilter **bf,
61 int32_t bf_mutator, const void *xquery,
62 size_t xquery_size, const void *reply_block,
63 size_t reply_block_size)
65 const struct SBlock *sb;
66 struct GNUNET_HashCode chash;
67 struct GNUNET_HashCode mhash;
68 const struct GNUNET_HashCode *nsid;
69 struct GNUNET_HashCode sh;
73 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
74 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
78 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
80 if (reply_block == NULL)
81 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
82 return GNUNET_BLOCK_EVALUATION_OK_LAST;
83 case GNUNET_BLOCK_TYPE_FS_KBLOCK:
84 case GNUNET_BLOCK_TYPE_FS_NBLOCK:
88 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
90 if (reply_block == NULL)
91 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
94 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
95 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
98 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
99 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
103 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
105 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
107 return GNUNET_BLOCK_EVALUATION_OK_MORE;
108 case GNUNET_BLOCK_TYPE_FS_SBLOCK:
109 if (xquery_size != sizeof (struct GNUNET_HashCode))
112 return GNUNET_BLOCK_EVALUATION_REQUEST_INVALID;
114 if (reply_block == NULL)
115 return GNUNET_BLOCK_EVALUATION_REQUEST_VALID;
117 if (reply_block_size < sizeof (struct SBlock))
120 return GNUNET_BLOCK_EVALUATION_RESULT_INVALID;
123 GNUNET_CRYPTO_hash (&sb->subspace,
124 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
126 if (0 != memcmp (nsid, &sh, sizeof (struct GNUNET_HashCode)))
127 return GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT;
130 GNUNET_CRYPTO_hash (reply_block, reply_block_size, &chash);
131 GNUNET_BLOCK_mingle_hash (&chash, bf_mutator, &mhash);
134 if (GNUNET_YES == GNUNET_CONTAINER_bloomfilter_test (*bf, &mhash))
135 return GNUNET_BLOCK_EVALUATION_OK_DUPLICATE;
139 *bf = GNUNET_CONTAINER_bloomfilter_init (NULL, 8, BLOOMFILTER_K);
141 GNUNET_CONTAINER_bloomfilter_add (*bf, &mhash);
143 return GNUNET_BLOCK_EVALUATION_OK_MORE;
145 return GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED;
151 * Function called to obtain the key for a block.
154 * @param type block type
155 * @param block block to get the key for
156 * @param block_size number of bytes in block
157 * @param key set to the key (query) for the given block
158 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
159 * (or if extracting a key from a block of this type does not work)
162 block_plugin_fs_get_key (void *cls, enum GNUNET_BLOCK_Type type,
163 const void *block, size_t block_size,
164 struct GNUNET_HashCode * key)
166 const struct KBlock *kb;
167 const struct SBlock *sb;
168 const struct NBlock *nb;
172 case GNUNET_BLOCK_TYPE_FS_DBLOCK:
173 case GNUNET_BLOCK_TYPE_FS_IBLOCK:
174 GNUNET_CRYPTO_hash (block, block_size, key);
176 case GNUNET_BLOCK_TYPE_FS_KBLOCK:
177 if (block_size < sizeof (struct KBlock))
183 if (block_size - sizeof (struct KBlock) !=
184 ntohl (kb->purpose.size) -
185 sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) -
186 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded))
192 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_KBLOCK,
193 &kb->purpose, &kb->signature, &kb->keyspace))
199 GNUNET_CRYPTO_hash (&kb->keyspace,
201 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
204 case GNUNET_BLOCK_TYPE_FS_SBLOCK:
205 if (block_size < sizeof (struct SBlock))
212 ntohl (sb->purpose.size) + sizeof (struct GNUNET_CRYPTO_RsaSignature))
218 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_SBLOCK,
219 &sb->purpose, &sb->signature, &sb->subspace))
225 *key = sb->identifier;
227 case GNUNET_BLOCK_TYPE_FS_NBLOCK:
228 if (block_size < sizeof (struct NBlock))
234 if (block_size - sizeof (struct NBlock) !=
235 ntohl (nb->ns_purpose.size) -
236 sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) -
237 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded))
243 ntohl (nb->ksk_purpose.size) +
244 sizeof (struct GNUNET_CRYPTO_RsaSignature))
250 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK_KSIG,
251 &nb->ksk_purpose, &nb->ksk_signature,
258 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_FS_NBLOCK,
259 &nb->ns_purpose, &nb->ns_signature,
265 /* FIXME: we used to xor ID with NSID,
268 GNUNET_CRYPTO_hash (&nb->keyspace,
270 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
274 return GNUNET_SYSERR;
280 * Entry point for the plugin.
283 libgnunet_plugin_block_fs_init (void *cls)
285 static enum GNUNET_BLOCK_Type types[] =
287 GNUNET_BLOCK_TYPE_FS_DBLOCK,
288 GNUNET_BLOCK_TYPE_FS_IBLOCK,
289 GNUNET_BLOCK_TYPE_FS_KBLOCK,
290 GNUNET_BLOCK_TYPE_FS_SBLOCK,
291 GNUNET_BLOCK_TYPE_FS_NBLOCK,
292 GNUNET_BLOCK_TYPE_ANY /* end of list */
294 struct GNUNET_BLOCK_PluginFunctions *api;
296 api = GNUNET_malloc (sizeof (struct GNUNET_BLOCK_PluginFunctions));
297 api->evaluate = &block_plugin_fs_evaluate;
298 api->get_key = &block_plugin_fs_get_key;
305 * Exit point from the plugin.
308 libgnunet_plugin_block_fs_done (void *cls)
310 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
316 /* end of plugin_block_fs.c */