src/include/gnunet_block_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @author Christian Grothoff
  23  *
  24  * @file
  25  * Library for data block manipulation
  26  *
  27  * @defgroup block  Block library
  28  * Library for data block manipulation
  29  * @{
  30  */
  31 #ifndef GNUNET_BLOCK_LIB_H
  32 #define GNUNET_BLOCK_LIB_H
  33
  34 #include "gnunet_util_lib.h"
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #if 0                           /* keep Emacsens' auto-indent happy */
  39 }
  40 #endif
  41 #endif
  42
  43
  44 /**
  45  * Blocks in the datastore and the datacache must have a unique type.
  46  */
  47 enum GNUNET_BLOCK_Type
  48 {
  49   /**
  50    * Any type of block, used as a wildcard when searching.  Should
  51    * never be attached to a specific block.
  52    */
  53   GNUNET_BLOCK_TYPE_ANY = 0,
  54
  55   /**
  56    * Data block (leaf) in the CHK tree.
  57    */
  58   GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
  59
  60   /**
  61    * Inner block in the CHK tree.
  62    */
  63   GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
  64
  65   /**
  66    * Legacy type, no longer in use.
  67    */
  68   GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
  69
  70   /**
  71    * Legacy type, no longer in use.
  72    */
  73   GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
  74
  75   /**
  76    * Legacy type, no longer in use.
  77    */
  78   GNUNET_BLOCK_TYPE_FS_NBLOCK = 5,
  79
  80   /**
  81    * Type of a block representing a block to be encoded on demand from disk.
  82    * Should never appear on the network directly.
  83    */
  84   GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
  85
  86   /**
  87    * Type of a block that contains a HELLO for a peer (for
  88    * DHT and CADET find-peer operations).
  89    */
  90   GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
  91
  92   /**
  93    * Block for testing.
  94    */
  95   GNUNET_BLOCK_TYPE_TEST = 8,
  96
  97   /**
  98    * Type of a block representing any type of search result
  99    * (universal).  Implemented in the context of #2564, replaces
 100    * SBLOCKS, KBLOCKS and NBLOCKS.
 101    */
 102   GNUNET_BLOCK_TYPE_FS_UBLOCK = 9,
 103
 104   /**
 105    * Block for storing DNS exit service advertisements.
 106    */
 107   GNUNET_BLOCK_TYPE_DNS = 10,
 108
 109   /**
 110    * Block for storing record data
 111    */
 112   GNUNET_BLOCK_TYPE_GNS_NAMERECORD = 11,
 113
 114   /**
 115    * Block type for a revocation message by which a key is revoked.
 116    */
 117   GNUNET_BLOCK_TYPE_REVOCATION = 12,
 118
 119   /**
 120    * Block to store a cadet regex state
 121    */
 122   GNUNET_BLOCK_TYPE_REGEX = 22,
 123
 124   /**
 125    * Block to store a cadet regex accepting state
 126    */
 127   GNUNET_BLOCK_TYPE_REGEX_ACCEPT = 23,
 128
 129   /**
 130    * Block for testing set/consensus.  If first byte of the block
 131    * is non-zero, the block is considered invalid.
 132    */
 133   GNUNET_BLOCK_TYPE_SET_TEST = 24,
 134
 135   /**
 136    * Block type for consensus elements.
 137    * Contains either special marker elements or a nested block.
 138    */
 139   GNUNET_BLOCK_TYPE_CONSENSUS_ELEMENT = 25,
 140 };
 141
 142
 143 /**
 144  * Flags that can be set to control the evaluation.
 145  */
 146 enum GNUNET_BLOCK_EvaluationOptions
 147 {
 148   /**
 149    * Default behavior.
 150    */
 151   GNUNET_BLOCK_EO_NONE = 0,
 152
 153   /**
 154    * The block is obtained from the local database, skip cryptographic
 155    * checks.
 156    */
 157   GNUNET_BLOCK_EO_LOCAL_SKIP_CRYPTO = 1
 158 };
 159
 160
 161 /**
 162  * Possible ways for how a block may relate to a query.
 163  */
 164 enum GNUNET_BLOCK_EvaluationResult
 165 {
 166   /**
 167    * Valid result, and there may be more.
 168    */
 169   GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 170
 171   /**
 172    * Last possible valid result.
 173    */
 174   GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
 175
 176   /**
 177    * Valid result, but suppressed because it is a duplicate.
 178    */
 179   GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
 180
 181   /**
 182    * Block does not match query (invalid result)
 183    */
 184   GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
 185
 186   /**
 187    * Block does not match xquery (valid result, not relevant for the request)
 188    */
 189   GNUNET_BLOCK_EVALUATION_RESULT_IRRELEVANT = 4,
 190
 191   /**
 192    * Query is valid, no reply given.
 193    */
 194   GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 10,
 195
 196   /**
 197    * Query format does not match block type (invalid query).  For
 198    * example, xquery not given or xquery_size not appropriate for
 199    * type.
 200    */
 201   GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 11,
 202
 203   /**
 204    * Specified block type not supported by this plugin.
 205    */
 206   GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 20
 207 };
 208
 209
 210 /**
 211  * Handle to an initialized block library.
 212  */
 213 struct GNUNET_BLOCK_Context;
 214
 215
 216 /**
 217  * Mingle hash with the mingle_number to produce different bits.
 218  *
 219  * @param in original hash code
 220  * @param mingle_number number for hash permutation
 221  * @param hc where to store the result.
 222  */
 223 void
 224 GNUNET_BLOCK_mingle_hash (const struct GNUNET_HashCode *in,
 225                           uint32_t mingle_number,
 226                           struct GNUNET_HashCode *hc);
 227
 228
 229 /**
 230  * Create a block context.  Loads the block plugins.
 231  *
 232  * @param cfg configuration to use
 233  * @return NULL on error
 234  */
 235 struct GNUNET_BLOCK_Context *
 236 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
 237
 238
 239 /**
 240  * Destroy the block context.
 241  *
 242  * @param ctx context to destroy
 243  */
 244 void
 245 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
 246
 247
 248 /**
 249  * Handle for a group of elements that will be evaluated together.
 250  * They must all be of the same type.  A block group allows the
 251  * plugin to keep some state across individual evaluations.
 252  */
 253 struct GNUNET_BLOCK_Group;
 254
 255
 256 /**
 257  * Create a new block group.
 258  *
 259  * @param ctx block context in which the block group is created
 260  * @param type type of the block for which we are creating the group
 261  * @param nonce random value used to seed the group creation
 262  * @param raw_data optional serialized prior state of the group, NULL if unavailable/fresh
 263  * @param raw_data_size number of bytes in @a raw_data, 0 if unavailable/fresh
 264  * @param ... type-specific additional data, can be empty
 265  * @return block group handle, NULL if block groups are not supported
 266  *         by this @a type of block (this is not an error)
 267  */
 268 struct GNUNET_BLOCK_Group *
 269 GNUNET_BLOCK_group_create (struct GNUNET_BLOCK_Context *ctx,
 270                            enum GNUNET_BLOCK_Type type,
 271                            uint32_t nonce,
 272                            const void *raw_data,
 273                            size_t raw_data_size,
 274                            ...);
 275
 276
 277 /**
 278  * Serialize state of a block group.
 279  *
 280  * @param bg group to serialize
 281  * @param[out] nonce set to the nonce of the @a bg
 282  * @param[out] raw_data set to the serialized state
 283  * @param[out] raw_data_size set to the number of bytes in @a raw_data
 284  * @return #GNUNET_OK on success, #GNUNET_NO if serialization is not
 285  *         supported, #GNUNET_SYSERR on error
 286  */
 287 int
 288 GNUNET_BLOCK_group_serialize (struct GNUNET_BLOCK_Group *bg,
 289                               uint32_t *nonce,
 290                               void **raw_data,
 291                               size_t *raw_data_size);
 292
 293
 294 /**
 295  * Destroy resources used by a block group.
 296  *
 297  * @param bg group to destroy, NULL is allowed
 298  */
 299 void
 300 GNUNET_BLOCK_group_destroy (struct GNUNET_BLOCK_Group *bg);
 301
 302
 303 /**
 304  * Function called to validate a reply or a request.  For
 305  * request evaluation, simply pass "NULL" for the @a reply_block.
 306  * Note that it is assumed that the reply has already been
 307  * matched to the key (and signatures checked) as it would
 308  * be done with the #GNUNET_BLOCK_get_key() function.
 309  *
 310  * @param ctx block contxt
 311  * @param type block type
 312  * @param group block group to use for evaluation
 313  * @param eo evaluation options to control evaluation
 314  * @param query original query (hash)
 315  * @param xquery extrended query data (can be NULL, depending on type)
 316  * @param xquery_size number of bytes in @a xquery
 317  * @param reply_block response to validate
 318  * @param reply_block_size number of bytes in @a reply_block
 319  * @return characterization of result
 320  */
 321 enum GNUNET_BLOCK_EvaluationResult
 322 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
 323                        enum GNUNET_BLOCK_Type type,
 324                        struct GNUNET_BLOCK_Group *group,
 325                        enum GNUNET_BLOCK_EvaluationOptions eo,
 326                        const struct GNUNET_HashCode *query,
 327                        const void *xquery,
 328                        size_t xquery_size,
 329                        const void *reply_block,
 330                        size_t reply_block_size);
 331
 332
 333 /**
 334  * Function called to obtain the key for a block.
 335  *
 336  * @param ctx block context
 337  * @param type block type
 338  * @param block block to get the key for
 339  * @param block_size number of bytes in @a block
 340  * @param key set to the key (query) for the given block
 341  * @return #GNUNET_YES on success,
 342  *         #GNUNET_NO if the block is malformed
 343  *         #GNUNET_SYSERR if type not supported
 344  *         (or if extracting a key from a block of this type does not work)
 345  */
 346 int
 347 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
 348                       enum GNUNET_BLOCK_Type type,
 349                       const void *block,
 350                       size_t block_size,
 351                       struct GNUNET_HashCode *key);
 352
 353
 354 /**
 355  * Update block group to filter out the given results.  Note that the
 356  * use of a hash for seen results implies that the caller magically
 357  * knows how the specific block engine hashes for filtering
 358  * duplicates, so this API may not always apply.
 359  *
 360  * @param bf_mutator mutation value to use
 361  * @param seen_results results already seen
 362  * @param seen_results_count number of entries in @a seen_results
 363  * @return #GNUNET_SYSERR if not supported, #GNUNET_OK on success
 364  */
 365 int
 366 GNUNET_BLOCK_group_set_seen (struct GNUNET_BLOCK_Group *bg,
 367                              const struct GNUNET_HashCode *seen_results,
 368                              unsigned int seen_results_count);
 369
 370
 371 /**
 372  * Try merging two block groups.  Afterwards, @a bg1 should remain
 373  * valid and contain the rules from both @a bg1 and @bg2, and
 374  * @a bg2 should be destroyed (as part of this call).  The latter
 375  * should happen even if merging is not supported.
 376  *
 377  * @param[in,out] bg1 first group to merge, is updated
 378  * @param bg2 second group to merge, is destroyed
 379  * @return #GNUNET_OK on success,
 380  *         #GNUNET_NO if merge failed due to different nonce
 381  *         #GNUNET_SYSERR if merging is not supported
 382  */
 383 int
 384 GNUNET_BLOCK_group_merge (struct GNUNET_BLOCK_Group *bg1,
 385                           struct GNUNET_BLOCK_Group *bg2);
 386
 387
 388 #if 0                           /* keep Emacsens' auto-indent happy */
 389 {
 390 #endif
 391 #ifdef __cplusplus
 392 }
 393 #endif
 394
 395 /* ifndef GNUNET_BLOCK_LIB_H */
 396 #endif
 397
 398 /** @} */  /* end of group */
 399
 400 /* end of gnunet_block_lib.h */