GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
#endif
#endif
+
/**
* Blocks in the datastore and the datacache must have a unique type.
*/
-enum GNUNET_BLOCK_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,
+ GNUNET_BLOCK_TYPE_ANY = 0,
/**
* Data block (leaf) in the CHK tree.
*/
- GNUNET_BLOCK_TYPE_DBLOCK = 1,
+ GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
/**
* Inner block in the CHK tree.
*/
- GNUNET_BLOCK_TYPE_IBLOCK = 2,
+ GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
/**
- * Type of a block representing a keyword search result.
+ * Type of a block representing a keyword search result. Note that
+ * the values for KBLOCK, SBLOCK and NBLOCK must be consecutive.
*/
- GNUNET_BLOCK_TYPE_KBLOCK = 3,
+ GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
/**
* Type of a block that is used to advertise content in a namespace.
*/
- GNUNET_BLOCK_TYPE_SBLOCK = 4,
+ GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
+
+ /**
+ * Type of a block that is used to advertise a namespace.
+ */
+ 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_ONDEMAND = 5,
+ GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
/**
- * Type of a block that is used to advertise a namespace.
+ * Type of a block that contains a HELLO for a peer (for
+ * DHT find-peer operations).
*/
- GNUNET_BLOCK_TYPE_NBLOCK = 6
-
- };
+ GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
+ /**
+ * Block for testing.
+ */
+ GNUNET_BLOCK_TYPE_TEST = 8,
+#if HAVE_MALICIOUS
+ /**
+ * Block for simulating malicious peers.
+ */
+ GNUNET_BLOCK_DHT_MALICIOUS_MESSAGE_TYPE = 9,
+#endif
+ /**
+ * Block for storing .gnunet-domains
+ */
+ GNUNET_BLOCK_TYPE_DNS = 10
+};
/**
- * @brief keyword block (advertising data under a keyword)
+ * Possible ways for how a block may relate to a query.
*/
-struct KBlock
+enum GNUNET_BLOCK_EvaluationResult
{
+ /**
+ * Valid result, and there may be more.
+ */
+ GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
- /**
- * GNUNET_RSA_Signature using RSA-key generated from search keyword.
- */
- struct GNUNET_CRYPTO_RsaSignature signature;
+ /**
+ * Last possible valid result.
+ */
+ GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
- /**
- * What is being signed and why?
- */
- struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
+ /**
+ * Valid result, but suppressed because it is a duplicate.
+ */
+ GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
- /**
- * Key generated (!) from the H(keyword) as the seed!
- */
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
+ /**
+ * Block does not match query (invalid result)
+ */
+ GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
- /* 0-terminated URI here */
+ /**
+ * Query is valid, no reply given.
+ */
+ GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
- /* variable-size Meta-Data follows here */
+ /**
+ * Query format does not match block type (invalid query). For
+ * example, xquery not given or xquery_size not appropriate for
+ * type.
+ */
+ GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
+ /**
+ * Specified block type not supported by this plugin.
+ */
+ GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
};
+
/**
- * @brief namespace content block (advertising data under an identifier in a namespace)
+ * Handle to an initialized block library.
*/
-struct SBlock
-{
-
- /**
- * GNUNET_RSA_Signature using RSA-key of the namespace
- */
- struct GNUNET_CRYPTO_RsaSignature signature;
-
- /**
- * What is being signed and why?
- */
- struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
-
- /**
- * 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).
- */
- GNUNET_HashCode identifier;
-
- /**
- * Public key of the namespace.
- */
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
-
- /* 0-terminated update-identifier here */
-
- /* 0-terminated URI here (except for NBlocks) */
-
- /* variable-size Meta-Data follows here */
-
-};
+struct GNUNET_BLOCK_Context;
/**
- * @brief namespace advertisement block (advertising root of a namespace)
+ * 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.
*/
-struct NBlock
-{
-
- /**
- * GNUNET_RSA_Signature using RSA-key generated from search keyword.
- */
- struct GNUNET_CRYPTO_RsaSignature ksk_signature;
-
- /**
- * What is being signed and why?
- */
- struct GNUNET_CRYPTO_RsaSignaturePurpose ksk_purpose;
-
- /**
- * Key generated (!) from the H(keyword) as the seed!
- */
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
-
- /**
- * GNUNET_RSA_Signature using RSA-key of the namespace
- */
- struct GNUNET_CRYPTO_RsaSignature ns_signature;
+void
+GNUNET_BLOCK_mingle_hash (const GNUNET_HashCode * in,
+ uint32_t mingle_number, GNUNET_HashCode * hc);
- /**
- * What is being signed and why?
- */
- struct GNUNET_CRYPTO_RsaSignaturePurpose ns_purpose;
- /**
- * Public key of the namespace.
- */
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
-
- /* from here on, data is encrypted with H(keyword) */
-
- /* 0-terminated root identifier here */
-
- /* variable-size Meta-Data follows here */
-
-};
+/**
+ * Create a block context. Loads the block plugins.
+ *
+ * @param cfg configuration to use
+ * @return NULL on error
+ */
+struct GNUNET_BLOCK_Context *GNUNET_BLOCK_context_create (const struct
+ GNUNET_CONFIGURATION_Handle
+ *cfg);
+/**
+ * Destroy the block context.
+ *
+ * @param ctx context to destroy
+ */
+void GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
/**
- * @brief index block (indexing a DBlock that
- * can be obtained directly from reading
- * the plaintext file)
+ * Function called to validate a reply or a request. For
+ * request evaluation, simply pass "NULL" for the 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 "get_key" function.
+ *
+ * @param ctx block contxt
+ * @param type block type
+ * @param query original query (hash)
+ * @param bf pointer to bloom filter associated with query; possibly updated (!)
+ * @param bf_mutator mutation value for bf
+ * @param xquery extrended query data (can be NULL, depending on type)
+ * @param xquery_size number of bytes in xquery
+ * @param reply_block response to validate
+ * @param reply_block_size number of bytes in reply block
+ * @return characterization of result
*/
-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;
-
- /**
- * At which offset should we be able to find
- * this on-demand encoded block? (in NBO)
- */
- uint64_t offset GNUNET_PACKED;
-
-};
+enum GNUNET_BLOCK_EvaluationResult
+GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
+ enum GNUNET_BLOCK_Type type,
+ const 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 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, GNUNET_HashCode * key);
#if 0 /* keep Emacsens' auto-indent happy */
projects / oweals / gnunet.git / blobdiff