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