1 files changed, 76 insertions, 185 deletions

diff --git a/src/include/gnunet_block_lib.h b/src/include/gnunet_block_lib.h
index 73b51252e..fdccbab78 100644
--- a/src/include/gnunet_block_lib.h
+++ b/src/include/gnunet_block_lib.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2010 GNUnet e.V.
+     Copyright (C) 2010, 2022 GNUnet e.V.
 
      GNUnet is free software: you can redistribute it and/or modify it
      under the terms of the GNU Affero General Public License as published
@@ -19,6 +19,9 @@
  */
 
 /**
+ * @addtogroup dht_libs  DHT and support libraries
+ * @{
+ *
  * @author Christian Grothoff
  *
  * @file
@@ -31,7 +34,10 @@
 #ifndef GNUNET_BLOCK_LIB_H
 #define GNUNET_BLOCK_LIB_H
 
+
 #include "gnunet_util_lib.h"
+#include "gnunet_dht_block_types.h"
+
 #ifdef __cplusplus
 extern "C"
 {
@@ -42,181 +48,36 @@ extern "C"
 
 
 /**
- * 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_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,
-
-  /**
-   * 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,
-
-  /**
-   * Block for testing.
-   */
-  GNUNET_BLOCK_TYPE_TEST = 8,
-
-  /**
-   * 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,
-
-  /**
-   * Block for storing DNS exit service advertisements.
-   */
-  GNUNET_BLOCK_TYPE_DNS = 10,
-
-  /**
-   * Block for storing record data
-   */
-  GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
-
-  /**
-   * Block type for a revocation message by which a key is revoked.
-   */
-  GNUNET_BLOCK_TYPE_REVOCATION = 12,
-
-  /**
-   * Block to store a cadet regex state
-   */
-  GNUNET_BLOCK_TYPE_REGEX = 22,
-
-  /**
-   * Block to store a cadet regex accepting state
-   */
-  GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23,
-
-  /**
-   * Block for testing set/consensus.  If first byte of the block
-   * is non-zero, the block is considered invalid.
-   */
-  GNUNET_BLOCK_TYPE_SET_TEST = 24,
-
-  /**
-   * Block type for consensus elements.
-   * Contains either special marker elements or a nested block.
-   */
-  GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT = 25,
-
-  /**
-   * Block for testing set intersection.  If first byte of the block
-   * is non-zero, the block is considered invalid.
-   */
-  GNUNET_BLOCK_TYPE_SETI_TEST = 24,
-
-  /**
-   * Block for testing set union.  If first byte of the block
-   * is non-zero, the block is considered invalid.
-   */
-  GNUNET_BLOCK_TYPE_SETU_TEST = 24,
-
-};
-
-
-/**
- * Flags that can be set to control the evaluation.
- */
-enum GNUNET_BLOCK_EvaluationOptions
-{
-  /**
-   * 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
-};
-
-
-/**
  * Possible ways for how a block may relate to a query.
  */
-enum GNUNET_BLOCK_EvaluationResult
+enum GNUNET_BLOCK_ReplyEvaluationResult
 {
-  /**
-   * Valid result, and there may be more.
-   */
-  GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 
   /**
-   * Last possible valid result.
+   * Specified block type not supported by any plugin.
    */
-  GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
+  GNUNET_BLOCK_REPLY_TYPE_NOT_SUPPORTED = -1,
 
   /**
    * Valid result, but suppressed because it is a duplicate.
    */
-  GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
-
-  /**
-   * Block does not match query (invalid result)
-   */
-  GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
+  GNUNET_BLOCK_REPLY_OK_DUPLICATE = 0,
 
   /**
    * Block does not match xquery (valid result, not relevant for the request)
    */
-  GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
+  GNUNET_BLOCK_REPLY_IRRELEVANT = 1,
 
   /**
-   * Query is valid, no reply given.
+   * Valid result, and there may be more.
    */
-  GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
+  GNUNET_BLOCK_REPLY_OK_MORE = 2,
 
   /**
-   * Query format does not match block type (invalid query).  For
-   * example, xquery not given or xquery_size not appropriate for
-   * type.
+   * Last possible valid result.
    */
-  GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
+  GNUNET_BLOCK_REPLY_OK_LAST = 3
 
-  /**
-   * Specified block type not supported by this plugin.
-   */
-  GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
 };
 
 
@@ -271,7 +132,6 @@ struct GNUNET_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
@@ -281,7 +141,6 @@ struct GNUNET_BLOCK_Group;
 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,
                            ...);
@@ -291,15 +150,13 @@ GNUNET_BLOCK_group_create (struct GNUNET_BLOCK_Context *ctx,
  * Serialize state of a block group.
  *
  * @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
+enum GNUNET_GenericReturnValue
 GNUNET_BLOCK_group_serialize (struct GNUNET_BLOCK_Group *bg,
-                              uint32_t *nonce,
                               void **raw_data,
                               size_t *raw_data_size);
 
@@ -314,16 +171,12 @@ 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.
+ * Function called to validate if a reply is good for a
+ * particular query.
  *
  * @param ctx block contxt
  * @param type block type
- * @param group block group to use for evaluation
- * @param eo evaluation options to control evaluation
+ * @param[in,out] group block group to use for 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
@@ -331,20 +184,57 @@ GNUNET_BLOCK_group_destroy (struct GNUNET_BLOCK_Group *bg);
  * @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);
+enum GNUNET_BLOCK_ReplyEvaluationResult
+GNUNET_BLOCK_check_reply (struct GNUNET_BLOCK_Context *ctx,
+                          enum GNUNET_BLOCK_Type type,
+                          struct GNUNET_BLOCK_Group *group,
+                          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.
+ * Function called to validate a request.
+ *
+ * @param ctx block contxt
+ * @param type block type
+ * @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
+ * @return #GNUNET_OK if the block is fine, #GNUNET_NO if not,
+ *   #GNUNET_SYSERR if @a type is not supported
+ */
+enum GNUNET_GenericReturnValue
+GNUNET_BLOCK_check_query (struct GNUNET_BLOCK_Context *ctx,
+                          enum GNUNET_BLOCK_Type type,
+                          const struct GNUNET_HashCode *query,
+                          const void *xquery,
+                          size_t xquery_size);
+
+
+/**
+ * Function called to validate a block.
+ *
+ * @param ctx block contxt
+ * @param type block type
+ * @param block payload to put
+ * @param block_size number of bytes in @a block
+ * @return #GNUNET_OK if the block is fine, #GNUNET_NO if not,
+ *   #GNUNET_SYSERR if @a type is not supported
+ */
+enum GNUNET_GenericReturnValue
+GNUNET_BLOCK_check_block (struct GNUNET_BLOCK_Context *ctx,
+                          enum GNUNET_BLOCK_Type type,
+                          const void *block,
+                          size_t block_size);
+
+
+/**
+ * Function called to obtain the @a key for a @a block.
+ * If the @a block is malformed, the function should
+ * zero-out @a key and return #GNUNET_OK.
  *
  * @param ctx block context
  * @param type block type
@@ -352,11 +242,10 @@ GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
  * @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)
+ *         #GNUNET_NO if extracting a key from a block of this @a type does not work
+ *         #GNUNET_SYSERR if @a type not supported
  */
-int
+enum GNUNET_GenericReturnValue
 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
                       enum GNUNET_BLOCK_Type type,
                       const void *block,
@@ -375,7 +264,7 @@ GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
  * @param seen_results_count number of entries in @a seen_results
  * @return #GNUNET_SYSERR if not supported, #GNUNET_OK on success
  */
-int
+enum GNUNET_GenericReturnValue
 GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg,
                              const struct GNUNET_HashCode *seen_results,
                              unsigned int seen_results_count);
@@ -383,7 +272,7 @@ GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg,
 
 /**
  * Try merging two block groups.  Afterwards, @a bg1 should remain
- * valid and contain the rules from both @a bg1 and @bg2, and
+ * valid and contain the rules from both @a bg1 and @a bg2, and
  * @a bg2 should be destroyed (as part of this call).  The latter
  * should happen even if merging is not supported.
  *
@@ -393,7 +282,7 @@ GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg,
  *         #GNUNET_NO if merge failed due to different nonce
  *         #GNUNET_SYSERR if merging is not supported
  */
-int
+enum GNUNET_GenericReturnValue
 GNUNET_BLOCK_group_merge (struct GNUNET_BLOCK_Group *bg1,
                           struct GNUNET_BLOCK_Group *bg2);
 
@@ -410,4 +299,6 @@ GNUNET_BLOCK_group_merge (struct GNUNET_BLOCK_Group *bg1,
 
 /** @} */  /* end of group */
 
+/** @} */ /* end of group addition */
+
 /* end of gnunet_block_lib.h */