/*
This file is part of GNUnet.
- (C) 2010 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
#endif
#endif
-/**
- * Blocks in the datastore and the datacache must have a unique type.
- */
-enum GNUNET_BLOCK_Type
- {
- /**
- * Any type of block, used as a wildcard when searching. Should
- * never be attached to a specific block.
- */
- GNUNET_BLOCK_TYPE_ANY = 0,
-
- /**
- * Data block (leaf) in the CHK tree.
- */
- GNUNET_BLOCK_TYPE_DBLOCK = 1,
-
- /**
- * Inner block in the CHK tree.
- */
- GNUNET_BLOCK_TYPE_IBLOCK = 2,
-
- /**
- * Type of a block representing a keyword search result.
- */
- GNUNET_BLOCK_TYPE_KBLOCK = 3,
-
- /**
- * Type of a block that is used to advertise content in a namespace.
- */
- GNUNET_BLOCK_TYPE_SBLOCK = 4,
-
- /**
- * Type of a block representing a block to be encoded on demand from disk.
- * Should never appear on the network directly.
- */
- GNUNET_BLOCK_TYPE_ONDEMAND = 5,
-
- /**
- * Type of a block that is used to advertise a namespace.
- */
- GNUNET_BLOCK_TYPE_NBLOCK = 6,
-
- GNUNET_BLOCK_TYPE_TEST = 9999
-
- };
-
/**
- * @brief keyword block (advertising data under a keyword)
+ * Blocks in the datastore and the datacache must have a unique type.
*/
-struct KBlock
+enum GNUNET_BLOCK_Type
{
+ /**
+ * Any type of block, used as a wildcard when searching. Should
+ * never be attached to a specific block.
+ */
+ GNUNET_BLOCK_TYPE_ANY = 0,
/**
- * GNUNET_RSA_Signature using RSA-key generated from search keyword.
+ * Data block (leaf) in the CHK tree.
*/
- struct GNUNET_CRYPTO_RsaSignature signature;
+ GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
/**
- * What is being signed and why?
+ * Inner block in the CHK tree.
*/
- struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
+ GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
/**
- * Key generated (!) from the H(keyword) as the seed!
+ * Legacy type, no longer in use.
*/
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
+ GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
- /* 0-terminated URI here */
+ /**
+ * Legacy type, no longer in use.
+ */
+ GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
- /* variable-size Meta-Data follows here */
+ /**
+ * Legacy type, no longer in use.
+ */
+ GNUNET_BLOCK_TYPE_FS_NBLOCK = 5,
-};
+ /**
+ * Type of a block representing a block to be encoded on demand from disk.
+ * Should never appear on the network directly.
+ */
+ GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
+ /**
+ * Type of a block that contains a HELLO for a peer (for
+ * DHT and CADET find-peer operations).
+ */
+ GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
-/**
- * @brief namespace content block (advertising data under an identifier in a namespace)
- */
-struct SBlock
-{
+ /**
+ * Block for testing.
+ */
+ GNUNET_BLOCK_TYPE_TEST = 8,
/**
- * GNUNET_RSA_Signature using RSA-key of the namespace
+ * Type of a block representing any type of search result
+ * (universal). Implemented in the context of #2564, replaces
+ * SBLOCKS, KBLOCKS and NBLOCKS.
*/
- struct GNUNET_CRYPTO_RsaSignature signature;
+ GNUNET_BLOCK_TYPE_FS_UBLOCK = 9,
/**
- * What is being signed and why?
+ * Block for storing DNS exit service advertisements.
*/
- struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
+ GNUNET_BLOCK_TYPE_DNS = 10,
/**
- * Hash of the hash of the human-readable identifier used for
- * this entry (the hash of the human-readable identifier is
- * used as the key for decryption; the xor of this identifier
- * and the hash of the "keyspace" is the datastore-query hash).
+ * Block for storing record data
*/
- GNUNET_HashCode identifier;
+ GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
/**
- * Public key of the namespace.
+ * Block to store a cadet regex state
*/
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
+ GNUNET_BLOCK_TYPE_REGEX = 22,
+
+ /**
+ * Block to store a cadet regex accepting state
+ */
+ GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23
+};
- /* 0-terminated update-identifier here */
- /* 0-terminated URI here (except for NBlocks) */
+/**
+ * Flags that can be set to control the evaluation.
+ */
+enum GNUNET_BLOCK_EvaluationOptions
+{
- /* variable-size Meta-Data follows here */
+ /**
+ * Default behavior.
+ */
+ GNUNET_BLOCK_EO_NONE = 0,
+ /**
+ * The block is obtained from the local database, skip cryptographic
+ * checks.
+ */
+ GNUNET_BLOCK_EO_LOCAL_SKIP_CRYPTO = 1
};
/**
- * @brief namespace advertisement block (advertising root of a namespace)
+ * Possible ways for how a block may relate to a query.
*/
-struct NBlock
+enum GNUNET_BLOCK_EvaluationResult
{
+ /**
+ * Valid result, and there may be more.
+ */
+ GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
+
+ /**
+ * Last possible valid result.
+ */
+ GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
/**
- * GNUNET_RSA_Signature using RSA-key generated from search keyword.
+ * Valid result, but suppressed because it is a duplicate.
*/
- struct GNUNET_CRYPTO_RsaSignature ksk_signature;
+ GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
/**
- * What is being signed and why?
+ * Block does not match query (invalid result)
*/
- struct GNUNET_CRYPTO_RsaSignaturePurpose ksk_purpose;
+ GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
/**
- * Key generated (!) from the H(keyword) as the seed!
+ * Block does not match xquery (valid result, not relevant for the request)
*/
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
+ GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
/**
- * GNUNET_RSA_Signature using RSA-key of the namespace
+ * Query is valid, no reply given.
*/
- struct GNUNET_CRYPTO_RsaSignature ns_signature;
+ GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
/**
- * What is being signed and why?
+ * Query format does not match block type (invalid query). For
+ * example, xquery not given or xquery_size not appropriate for
+ * type.
*/
- struct GNUNET_CRYPTO_RsaSignaturePurpose ns_purpose;
+ GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
/**
- * Public key of the namespace.
+ * Specified block type not supported by this plugin.
*/
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
+ GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
+};
- /* from here on, data is encrypted with H(keyword) */
- /* 0-terminated root identifier here */
+/**
+ * Handle to an initialized block library.
+ */
+struct GNUNET_BLOCK_Context;
- /* variable-size Meta-Data follows here */
-};
+/**
+ * Mingle hash with the mingle_number to produce different bits.
+ *
+ * @param in original hash code
+ * @param mingle_number number for hash permutation
+ * @param hc where to store the result.
+ */
+void
+GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in,
+ uint32_t mingle_number,
+ struct GNUNET_HashCode *hc);
/**
- * @brief index block (indexing a DBlock that
- * can be obtained directly from reading
- * the plaintext file)
+ * Create a block context. Loads the block plugins.
+ *
+ * @param cfg configuration to use
+ * @return NULL on error
*/
-struct OnDemandBlock
-{
- /**
- * Hash code of the entire content of the
- * file that was indexed (used to uniquely
- * identify the plaintext file).
- */
- GNUNET_HashCode file_id;
+struct GNUNET_BLOCK_Context *
+GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
- /**
- * At which offset should we be able to find
- * this on-demand encoded block? (in NBO)
- */
- uint64_t offset GNUNET_PACKED;
-};
+/**
+ * Destroy the block context.
+ *
+ * @param ctx context to destroy
+ */
+void
+GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
+
+
+/**
+ * Function called to validate a reply or a request. For
+ * request evaluation, simply pass "NULL" for the @a reply_block.
+ * Note that it is assumed that the reply has already been
+ * matched to the key (and signatures checked) as it would
+ * be done with the #GNUNET_BLOCK_get_key() function.
+ *
+ * @param ctx block contxt
+ * @param type block type
+ * @param eo evaluation options to control evaluation
+ * @param query original query (hash)
+ * @param bf pointer to bloom filter associated with query; possibly updated (!)
+ * @param bf_mutator mutation value for @a bf
+ * @param xquery extrended query data (can be NULL, depending on type)
+ * @param xquery_size number of bytes in @a xquery
+ * @param reply_block response to validate
+ * @param reply_block_size number of bytes in @a reply_block
+ * @return characterization of result
+ */
+enum GNUNET_BLOCK_EvaluationResult
+GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
+ enum GNUNET_BLOCK_Type type,
+ enum GNUNET_BLOCK_EvaluationOptions eo,
+ const struct GNUNET_HashCode *query,
+ struct GNUNET_CONTAINER_BloomFilter **bf,
+ int32_t bf_mutator,
+ const void *xquery,
+ size_t xquery_size,
+ const void *reply_block,
+ size_t reply_block_size);
/**
- * Check if the given block is well-formed (and of the given type).
+ * Function called to obtain the key for a block.
*
- * @param type type of the block
- * @param block the block data (or at least "size" bytes claiming to be one)
- * @param size size of "kb" in bytes; check that it is large enough
- * @param query where to store the query that this block answers
- * @return GNUNET_OK if this is actually a well-formed KBlock
- * GNUNET_NO if we could not determine the query,
- * GNUNET_SYSERR if the block is malformed
+ * @param ctx block context
+ * @param type block type
+ * @param block block to get the key for
+ * @param block_size number of bytes in @a block
+ * @param key set to the key (query) for the given block
+ * @return #GNUNET_YES on success,
+ * #GNUNET_NO if the block is malformed
+ * #GNUNET_SYSERR if type not supported
+ * (or if extracting a key from a block of this type does not work)
*/
int
-GNUNET_BLOCK_check_block (enum GNUNET_BLOCK_Type type,
- const void *block,
- size_t size,
- GNUNET_HashCode *query);
+GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
+ enum GNUNET_BLOCK_Type type,
+ const void *block,
+ size_t block_size,
+ struct GNUNET_HashCode * key);
+
+
+
+/**
+ * Construct a bloom filter that would filter out the given
+ * results.
+ *
+ * @param bf_mutator mutation value to use
+ * @param seen_results results already seen
+ * @param seen_results_count number of entries in @a seen_results
+ * @return NULL if seen_results_count is 0, otherwise a BF
+ * that would match the given results.
+ */
+struct GNUNET_CONTAINER_BloomFilter *
+GNUNET_BLOCK_construct_bloomfilter (int32_t bf_mutator,
+ const struct GNUNET_HashCode *seen_results,
+ unsigned int seen_results_count);
#if 0 /* keep Emacsens' auto-indent happy */
projects / oweals / gnunet.git / blobdiff