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 include/gnunet_block_lib.h
23 * @brief library for data block manipulation
24 * @author Christian Grothoff
26 #ifndef GNUNET_BLOCK_LIB_H
27 #define GNUNET_BLOCK_LIB_H
29 #include "gnunet_util_lib.h"
33 #if 0 /* keep Emacsens' auto-indent happy */
40 * Blocks in the datastore and the datacache must have a unique type.
42 enum GNUNET_BLOCK_Type
45 * Any type of block, used as a wildcard when searching. Should
46 * never be attached to a specific block.
48 GNUNET_BLOCK_TYPE_ANY = 0,
51 * Data block (leaf) in the CHK tree.
53 GNUNET_BLOCK_TYPE_DBLOCK = 1,
56 * Inner block in the CHK tree.
58 GNUNET_BLOCK_TYPE_IBLOCK = 2,
61 * Type of a block representing a keyword search result.
63 GNUNET_BLOCK_TYPE_KBLOCK = 3,
66 * Type of a block that is used to advertise content in a namespace.
68 GNUNET_BLOCK_TYPE_SBLOCK = 4,
71 * Type of a block representing a block to be encoded on demand from disk.
72 * Should never appear on the network directly.
74 GNUNET_BLOCK_TYPE_ONDEMAND = 5,
77 * Type of a block that is used to advertise a namespace.
79 GNUNET_BLOCK_TYPE_NBLOCK = 6,
81 GNUNET_BLOCK_TYPE_TEST = 9999
86 /* **************** FIXME: move these to block_fs.h or so ***************** */
89 * @brief keyword block (advertising data under a keyword)
95 * GNUNET_RSA_Signature using RSA-key generated from search keyword.
97 struct GNUNET_CRYPTO_RsaSignature signature;
100 * What is being signed and why?
102 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
105 * Key generated (!) from the H(keyword) as the seed!
107 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
109 /* 0-terminated URI here */
111 /* variable-size Meta-Data follows here */
117 * @brief namespace content block (advertising data under an identifier in a namespace)
123 * GNUNET_RSA_Signature using RSA-key of the namespace
125 struct GNUNET_CRYPTO_RsaSignature signature;
128 * What is being signed and why?
130 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
133 * Hash of the hash of the human-readable identifier used for
134 * this entry (the hash of the human-readable identifier is
135 * used as the key for decryption; the xor of this identifier
136 * and the hash of the "keyspace" is the datastore-query hash).
138 GNUNET_HashCode identifier;
141 * Public key of the namespace.
143 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
145 /* 0-terminated update-identifier here */
147 /* 0-terminated URI here (except for NBlocks) */
149 /* variable-size Meta-Data follows here */
155 * @brief namespace advertisement block (advertising root of a namespace)
161 * GNUNET_RSA_Signature using RSA-key generated from search keyword.
163 struct GNUNET_CRYPTO_RsaSignature ksk_signature;
166 * What is being signed and why?
168 struct GNUNET_CRYPTO_RsaSignaturePurpose ksk_purpose;
171 * Key generated (!) from the H(keyword) as the seed!
173 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
176 * GNUNET_RSA_Signature using RSA-key of the namespace
178 struct GNUNET_CRYPTO_RsaSignature ns_signature;
181 * What is being signed and why?
183 struct GNUNET_CRYPTO_RsaSignaturePurpose ns_purpose;
186 * Public key of the namespace.
188 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
190 /* from here on, data is encrypted with H(keyword) */
192 /* 0-terminated root identifier here */
194 /* variable-size Meta-Data follows here */
200 * @brief index block (indexing a DBlock that
201 * can be obtained directly from reading
202 * the plaintext file)
207 * Hash code of the entire content of the
208 * file that was indexed (used to uniquely
209 * identify the plaintext file).
211 GNUNET_HashCode file_id;
214 * At which offset should we be able to find
215 * this on-demand encoded block? (in NBO)
217 uint64_t offset GNUNET_PACKED;
222 /* **************** OLD API ***************** */
225 * Check if the given block is well-formed (and of the given type).
227 * @param type type of the block
228 * @param block the block data (or at least "size" bytes claiming to be one)
229 * @param size size of "kb" in bytes; check that it is large enough
230 * @param query where to store the query that this block answers
231 * @return GNUNET_OK if this is actually a well-formed KBlock
232 * GNUNET_NO if we could not determine the query,
233 * GNUNET_SYSERR if the block is malformed
236 GNUNET_BLOCK_check_block (enum GNUNET_BLOCK_Type type,
239 GNUNET_HashCode *query);
242 /* **************** NEW API ***************** */
245 * Possible ways for how a block may relate to a query.
247 enum GNUNET_BLOCK_EvaluationResult
250 * Valid result, and there may be more.
252 GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
255 * Last possible valid result.
257 GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
260 * Valid result, but suppressed because it is a duplicate.
262 GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
265 * Block does not match query (invalid result)
267 GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
270 * Query is valid, no reply given.
272 GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
275 * Query format does not match block type (invalid query). For
276 * example, xquery not given or xquery_size not appropriate for
279 GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
282 * Specified block type not supported by this plugin.
284 GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
289 * Handle to an initialized block library.
291 struct GNUNET_BLOCK_Context;
295 * Create a block context. Loads the block plugins.
297 * @param cfg configuration to use
298 * @return NULL on error
300 struct GNUNET_BLOCK_Context *
301 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
305 * Destroy the block context.
307 * @param ctx context to destroy
310 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
314 * Function called to validate a reply or a request. For
315 * request evaluation, simply pass "NULL" for the reply_block.
316 * Note that it is assumed that the reply has already been
317 * matched to the key (and signatures checked) as it would
318 * be done with the "get_key" function.
320 * @param ctx block contxt
321 * @param type block type
322 * @param query original query (hash)
323 * @param bf pointer to bloom filter associated with query; possibly updated (!)
324 * @param bf_mutator mutation value for bf
325 * @param xquery extrended query data (can be NULL, depending on type)
326 * @param xquery_size number of bytes in xquery
327 * @param reply_block response to validate
328 * @param reply_block_size number of bytes in reply block
329 * @return characterization of result
331 enum GNUNET_BLOCK_EvaluationResult
332 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
333 enum GNUNET_BLOCK_Type type,
334 const GNUNET_HashCode *query,
335 struct GNUNET_CONTAINER_BloomFilter **bf,
339 const void *reply_block,
340 size_t reply_block_size);
344 * Function called to obtain the key for a block.
346 * @param ctx block context
347 * @param type block type
348 * @param block block to get the key for
349 * @param block_size number of bytes in block
350 * @param key set to the key (query) for the given block
351 * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
352 * (or if extracting a key from a block of this type does not work)
355 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
356 enum GNUNET_BLOCK_Type type,
359 GNUNET_HashCode *key);
362 #if 0 /* keep Emacsens' auto-indent happy */
370 /* ifndef GNUNET_BLOCK_LIB_H */
372 /* end of gnunet_block_lib.h */