1 files changed, 89 insertions, 46 deletions

diff --git a/src/include/gnunet_block_plugin.h b/src/include/gnunet_block_plugin.h
index ee237ac03..16e93c780 100644
--- a/src/include/gnunet_block_plugin.h
+++ b/src/include/gnunet_block_plugin.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     Copyright (C) 2010,2013,2017 GNUnet e.V.
+     Copyright (C) 2010, 2013, 2017, 2021, 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
@@ -35,6 +38,7 @@
 #ifndef PLUGIN_BLOCK_H
 #define PLUGIN_BLOCK_H
 
+
 #include "gnunet_util_lib.h"
 #include "gnunet_block_lib.h"
 
@@ -48,10 +52,10 @@
  * @param seen_results_count number of entries in @a seen_results
  */
 typedef void
-(*GNUNET_BLOCK_GroupMarkSeenFunction)(struct GNUNET_BLOCK_Group *bg,
-                                      const struct
-                                      GNUNET_HashCode *seen_results,
-                                      unsigned int seen_results_count);
+(*GNUNET_BLOCK_GroupMarkSeenFunction)(
+  struct GNUNET_BLOCK_Group *bg,
+  const struct GNUNET_HashCode *seen_results,
+  unsigned int seen_results_count);
 
 
 /**
@@ -63,7 +67,7 @@ typedef void
  * @return #GNUNET_OK on success, #GNUNET_NO if the nonces were different and thus
  *         we failed.
  */
-typedef int
+typedef enum GNUNET_GenericReturnValue
 (*GNUNET_BLOCK_GroupMergeFunction)(struct GNUNET_BLOCK_Group *bg1,
                                    const struct GNUNET_BLOCK_Group *bg2);
 
@@ -72,15 +76,13 @@ typedef int
  * 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
  */
-typedef int
+typedef enum GNUNET_GenericReturnValue
 (*GNUNET_BLOCK_GroupSerializeFunction)(struct GNUNET_BLOCK_Group *bg,
-                                       uint32_t *nonce,
                                        void **raw_data,
                                        size_t *raw_data_size);
 
@@ -156,24 +158,54 @@ struct GNUNET_BLOCK_Group
 typedef struct GNUNET_BLOCK_Group *
 (*GNUNET_BLOCK_GroupCreateFunction)(void *cls,
                                     enum GNUNET_BLOCK_Type type,
-                                    uint32_t nonce,
                                     const void *raw_data,
                                     size_t raw_data_size,
                                     va_list va);
 
 
 /**
- * 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 "get_key" function.
+ * Function called to validate a query.
+ *
+ * @param cls closure
+ * @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 query is fine, #GNUNET_NO if not
+ */
+typedef enum GNUNET_GenericReturnValue
+(*GNUNET_BLOCK_QueryEvaluationFunction)(void *cls,
+                                        enum GNUNET_BLOCK_Type type,
+                                        const struct GNUNET_HashCode *query,
+                                        const void *xquery,
+                                        size_t xquery_size);
+
+
+/**
+ * Function called to validate a @a block for storage.
+ *
+ * @param cls closure
+ * @param type block type
+ * @param block block data to validate
+ * @param block_size number of bytes in @a block
+ * @return #GNUNET_OK if the @a block is fine, #GNUNET_NO if not, #GNUNET_SYSERR if the @a type is not supported
+ */
+typedef enum GNUNET_GenericReturnValue
+(*GNUNET_BLOCK_BlockEvaluationFunction)(void *cls,
+                                        enum GNUNET_BLOCK_Type type,
+                                        const void *block,
+                                        size_t block_size);
+
+
+/**
+ * Function called to validate a reply to a request.  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 GetKeyFunction and the
+ * BlockEvaluationFunction.
  *
  * @param cls closure
- * @param ctx block context
  * @param type block type
  * @param group which 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
@@ -181,38 +213,37 @@ typedef struct GNUNET_BLOCK_Group *
  * @param reply_block_size number of bytes in @a reply_block
  * @return characterization of result
  */
-typedef enum GNUNET_BLOCK_EvaluationResult
-(*GNUNET_BLOCK_EvaluationFunction)(void *cls,
-                                   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);
+typedef enum GNUNET_BLOCK_ReplyEvaluationResult
+(*GNUNET_BLOCK_ReplyEvaluationFunction)(void *cls,
+                                        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 obtain the @a key for a block.
+ * If the @a block is malformed, the function should
+ * zero-out @a key and return #GNUNET_OK.
  *
  * @param cls closure
  * @param type block type
- * @param block block to get the key for
+ * @param block block to get the @a key for
  * @param block_size number of bytes in @a block
- * @param key set to the key (query) for the given block
+ * @param[out] 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 for this @a type does not work
+ *         #GNUNET_SYSERR if @a type not supported
  */
-typedef int
-(*GNUNET_BLOCK_GetKeyFunction) (void *cls,
-                                enum GNUNET_BLOCK_Type type,
-                                const void *block,
-                                size_t block_size,
-                                struct GNUNET_HashCode *key);
+typedef enum GNUNET_GenericReturnValue
+(*GNUNET_BLOCK_GetKeyFunction)(void *cls,
+                               enum GNUNET_BLOCK_Type type,
+                               const void *block,
+                               size_t block_size,
+                               struct GNUNET_HashCode *key);
 
 
 /**
@@ -232,12 +263,6 @@ struct GNUNET_BLOCK_PluginFunctions
   const enum GNUNET_BLOCK_Type *types;
 
   /**
-   * Main function of a block plugin.  Allows us to check if a
-   * block matches a query.
-   */
-  GNUNET_BLOCK_EvaluationFunction evaluate;
-
-  /**
    * Obtain the key for a given block (if possible).
    */
   GNUNET_BLOCK_GetKeyFunction get_key;
@@ -247,8 +272,26 @@ struct GNUNET_BLOCK_PluginFunctions
    * context (i.e. to detect duplicates).
    */
   GNUNET_BLOCK_GroupCreateFunction create_group;
+
+  /**
+   * Check that a query is well-formed.
+   */
+  GNUNET_BLOCK_QueryEvaluationFunction check_query;
+
+  /**
+   * Check that a block is well-formed.
+   */
+  GNUNET_BLOCK_BlockEvaluationFunction check_block;
+
+  /**
+   * Check that a reply block matches a query.
+   */
+  GNUNET_BLOCK_ReplyEvaluationFunction check_reply;
+
 };
 
 #endif
 
 /** @} */  /* end of group */
+
+/** @} */ /* end of group addition */