X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_block_lib.h;h=c85d3702bbc9bbea84c0aeba4e7514ddc8e2d942;hb=0d4f151374efb1972361c40b6624bf4fd0e3fcaa;hp=513605eb2c45d76c719c6db00eb7f24b1b98cc12;hpb=8d9525a642c6bd74a2903ccb6358da8ebb081864;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h index 513605eb2..c85d3702b 100644 --- a/src/include/gnunet_block_lib.h +++ b/src/include/gnunet_block_lib.h @@ -1,27 +1,32 @@ /* This file is part of GNUnet. - (C) 2010 Christian Grothoff (and other contributing authors) + Copyright (C) 2010 GNUnet e.V. - 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 - option) any later version. + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . - You should have received a copy of the GNU General Public License - along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + SPDX-License-Identifier: AGPL3.0-or-later */ /** - * @file include/gnunet_block_lib.h - * @brief library for data block manipulation * @author Christian Grothoff + * + * @file + * Library for data block manipulation + * + * @defgroup block Block library + * Library for data block manipulation + * @{ */ #ifndef GNUNET_BLOCK_LIB_H #define GNUNET_BLOCK_LIB_H @@ -35,205 +40,350 @@ extern "C" #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 - - }; +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_FS_DBLOCK = 1, + /** + * Inner block in the CHK tree. + */ + GNUNET_BLOCK_TYPE_FS_IBLOCK = 2, + /** + * Legacy type, no longer in use. + */ + GNUNET_BLOCK_TYPE_FS_KBLOCK = 3, + /** + * Legacy type, no longer in use. + */ + GNUNET_BLOCK_TYPE_FS_SBLOCK = 4, -/** - * @brief keyword block (advertising data under a keyword) - */ -struct KBlock -{ + /** + * Legacy type, no longer in use. + */ + GNUNET_BLOCK_TYPE_FS_NBLOCK = 5, /** - * GNUNET_RSA_Signature using RSA-key generated from search keyword. + * Type of a block representing a block to be encoded on demand from disk. + * Should never appear on the network directly. */ - struct GNUNET_CRYPTO_RsaSignature signature; + GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6, /** - * What is being signed and why? + * Type of a block that contains a HELLO for a peer (for + * DHT and CADET find-peer operations). */ - struct GNUNET_CRYPTO_RsaSignaturePurpose purpose; + GNUNET_BLOCK_TYPE_DHT_HELLO = 7, /** - * Key generated (!) from the H(keyword) as the seed! + * Block for testing. */ - struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace; + GNUNET_BLOCK_TYPE_TEST = 8, - /* 0-terminated URI here */ + /** + * Type of a block representing any type of search result + * (universal). Implemented in the context of #2564, replaces + * SBLOCKS, KBLOCKS and NBLOCKS. + */ + GNUNET_BLOCK_TYPE_FS_UBLOCK = 9, - /* variable-size Meta-Data follows here */ + /** + * Block for storing DNS exit service advertisements. + */ + GNUNET_BLOCK_TYPE_DNS = 10, -}; + /** + * Block for storing record data + */ + GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11, -/** - * @brief namespace content block (advertising data under an identifier in a namespace) - */ -struct SBlock -{ + /** + * Block type for a revocation message by which a key is revoked. + */ + GNUNET_BLOCK_TYPE_REVOCATION = 12, /** - * GNUNET_RSA_Signature using RSA-key of the namespace + * Block to store a cadet regex state */ - struct GNUNET_CRYPTO_RsaSignature signature; + GNUNET_BLOCK_TYPE_REGEX = 22, /** - * What is being signed and why? + * Block to store a cadet regex accepting state */ - struct GNUNET_CRYPTO_RsaSignaturePurpose purpose; + GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23, /** - * 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 testing set/consensus. If first byte of the block + * is non-zero, the block is considered invalid. */ - GNUNET_HashCode identifier; + GNUNET_BLOCK_TYPE_SET_TEST = 24, /** - * Public key of the namespace. + * Block type for consensus elements. + * Contains either special marker elements or a nested block. */ - struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace; + GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT = 25, +}; - /* 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) */ +/** + * Handle to an initialized block library. + */ +struct GNUNET_BLOCK_Context; - /* 0-terminated root identifier here */ - /* 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); -}; + +/** + * 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) + * Handle for a group of elements that will be evaluated together. + * They must all be of the same type. A block group allows the + * plugin to keep some state across individual evaluations. */ -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_Group; - /** - * At which offset should we be able to find - * this on-demand encoded block? (in NBO) - */ - uint64_t offset GNUNET_PACKED; -}; +/** + * Create a new block group. + * + * @param ctx block context in which the block group is created + * @param type type of the block for which we are creating the group + * @param nonce random value used to seed the group creation + * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh + * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh + * @param ... type-specific additional data, can be empty + * @return block group handle, NULL if block groups are not supported + * by this @a type of block (this is not an error) + */ +struct GNUNET_BLOCK_Group * +GNUNET_BLOCK_group_create (struct GNUNET_BLOCK_Context *ctx, + enum GNUNET_BLOCK_Type type, + uint32_t nonce, + const void *raw_data, + size_t raw_data_size, + ...); /** - * Check if the given block is well-formed (and of the given type). + * Serialize state of a block group. * - * @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 bg group to serialize + * @param[out] nonce set to the nonce of the @a bg + * @param[out] raw_data set to the serialized state + * @param[out] raw_data_size set to the number of bytes in @a raw_data + * @return #GNUNET_OK on success, #GNUNET_NO if serialization is not + * supported, #GNUNET_SYSERR on error */ int -GNUNET_BLOCK_check_block (enum GNUNET_BLOCK_Type type, - const void *block, - size_t size, - GNUNET_HashCode *query); +GNUNET_BLOCK_group_serialize (struct GNUNET_BLOCK_Group *bg, + uint32_t *nonce, + void **raw_data, + size_t *raw_data_size); + + +/** + * Destroy resources used by a block group. + * + * @param bg group to destroy, NULL is allowed + */ +void +GNUNET_BLOCK_group_destroy (struct GNUNET_BLOCK_Group *bg); + + +/** + * 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 group block group to use for evaluation + * @param eo evaluation options to control evaluation + * @param query original query (hash) + * @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, + struct GNUNET_BLOCK_Group *group, + enum GNUNET_BLOCK_EvaluationOptions eo, + const struct GNUNET_HashCode *query, + const void *xquery, + size_t xquery_size, + const void *reply_block, + size_t reply_block_size); + + +/** + * Function called to obtain the key for a block. + * + * @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_get_key (struct GNUNET_BLOCK_Context *ctx, + enum GNUNET_BLOCK_Type type, + const void *block, + size_t block_size, + struct GNUNET_HashCode *key); + + +/** + * Update block group to filter out the given results. Note that the + * use of a hash for seen results implies that the caller magically + * knows how the specific block engine hashes for filtering + * duplicates, so this API may not always apply. + * + * @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 #GNUNET_SYSERR if not supported, #GNUNET_OK on success + */ +int +GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg, + const struct GNUNET_HashCode *seen_results, + unsigned int seen_results_count); + + +/** + * Try merging two block groups. Afterwards, @a bg1 should remain + * valid and contain the rules from both @a bg1 and @bg2, and + * @a bg2 should be destroyed (as part of this call). The latter + * should happen even if merging is not supported. + * + * @param[in,out] bg1 first group to merge, is updated + * @param bg2 second group to merge, is destroyed + * @return #GNUNET_OK on success, + * #GNUNET_NO if merge failed due to different nonce + * #GNUNET_SYSERR if merging is not supported + */ +int +GNUNET_BLOCK_group_merge (struct GNUNET_BLOCK_Group *bg1, + struct GNUNET_BLOCK_Group *bg2); #if 0 /* keep Emacsens' auto-indent happy */ @@ -243,7 +393,9 @@ GNUNET_BLOCK_check_block (enum GNUNET_BLOCK_Type type, } #endif - /* ifndef GNUNET_BLOCK_LIB_H */ #endif + +/** @} */ /* end of group */ + /* end of gnunet_block_lib.h */