src/include/gnunet_block_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_block_lib.h
  23  * @brief library for data block manipulation
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_BLOCK_LIB_H
  27 #define GNUNET_BLOCK_LIB_H
  28
  29 #include "gnunet_util_lib.h"
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38
  39 /**
  40  * Blocks in the datastore and the datacache must have a unique type.
  41  */
  42 enum GNUNET_BLOCK_Type
  43   {
  44     /**
  45      * Any type of block, used as a wildcard when searching.  Should
  46      * never be attached to a specific block.
  47      */
  48     GNUNET_BLOCK_TYPE_ANY = 0,
  49
  50     /**
  51      * Data block (leaf) in the CHK tree.
  52      */
  53     GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
  54
  55     /**
  56      * Inner block in the CHK tree.
  57      */
  58     GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
  59
  60     /**
  61      * Type of a block representing a keyword search result.
  62      */
  63     GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
  64
  65     /**
  66      * Type of a block that is used to advertise content in a namespace.
  67      */
  68     GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
  69
  70     /**
  71      * Type of a block representing a block to be encoded on demand from disk.
  72      * Should never appear on the network directly.
  73      */
  74     GNUNET_BLOCK_TYPE_FS_ONDEMAND = 5,
  75
  76     /**
  77      * Type of a block that is used to advertise a namespace.
  78      */
  79     GNUNET_BLOCK_TYPE_FS_NBLOCK = 6,
  80
  81     /**
  82      * Type of a block that contains a HELLO for a peer (for
  83      * DHT find-peer operations).
  84      */
  85     GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
  86
  87     /**
  88      * Block for testing.
  89      */
  90     GNUNET_BLOCK_TYPE_TEST = 8,
  91
  92 #if HAVE_MALICIOUS
  93     /**
  94      * Block for simulating malicious peers.
  95      */
  96     GNUNET_BLOCK_DHT_MALICIOUS_MESSAGE_TYPE = 9
  97 #endif
  98   };
  99
 100
 101 /**
 102  * Possible ways for how a block may relate to a query.
 103  */
 104 enum GNUNET_BLOCK_EvaluationResult
 105   {
 106     /**
 107      * Valid result, and there may be more.
 108      */
 109     GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 110
 111     /**
 112      * Last possible valid result.
 113      */
 114     GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
 115
 116     /**
 117      * Valid result, but suppressed because it is a duplicate.
 118      */
 119     GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
 120
 121     /**
 122      * Block does not match query (invalid result)
 123      */
 124     GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
 125
 126     /**
 127      * Query is valid, no reply given.
 128      */
 129     GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
 130
 131     /**
 132      * Query format does not match block type (invalid query).  For
 133      * example, xquery not given or xquery_size not appropriate for
 134      * type.
 135      */
 136     GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
 137
 138     /**
 139      * Specified block type not supported by this plugin.
 140      */
 141     GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
 142   };
 143
 144
 145 /**
 146  * Handle to an initialized block library.
 147  */
 148 struct GNUNET_BLOCK_Context;
 149
 150
 151 /**
 152  * Mingle hash with the mingle_number to produce different bits.
 153  *
 154  * @param in original hash code
 155  * @param mingle_number number for hash permutation
 156  * @param hc where to store the result.
 157  */
 158 void
 159 GNUNET_BLOCK_mingle_hash (const GNUNET_HashCode * in,
 160                           int32_t mingle_number,
 161                           GNUNET_HashCode * hc);
 162
 163
 164 /**
 165  * Create a block context.  Loads the block plugins.
 166  *
 167  * @param cfg configuration to use
 168  * @return NULL on error
 169  */
 170 struct GNUNET_BLOCK_Context *
 171 GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
 172
 173
 174 /**
 175  * Destroy the block context.
 176  *
 177  * @param ctx context to destroy
 178  */
 179 void
 180 GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
 181
 182
 183 /**
 184  * Function called to validate a reply or a request.  For
 185  * request evaluation, simply pass "NULL" for the reply_block.
 186  * Note that it is assumed that the reply has already been
 187  * matched to the key (and signatures checked) as it would
 188  * be done with the "get_key" function.
 189  *
 190  * @param ctx block contxt
 191  * @param type block type
 192  * @param query original query (hash)
 193  * @param bf pointer to bloom filter associated with query; possibly updated (!)
 194  * @param bf_mutator mutation value for bf
 195  * @param xquery extrended query data (can be NULL, depending on type)
 196  * @param xquery_size number of bytes in xquery
 197  * @param reply_block response to validate
 198  * @param reply_block_size number of bytes in reply block
 199  * @return characterization of result
 200  */
 201 enum GNUNET_BLOCK_EvaluationResult
 202 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
 203                        enum GNUNET_BLOCK_Type type,
 204                        const GNUNET_HashCode *query,
 205                        struct GNUNET_CONTAINER_BloomFilter **bf,
 206                        int32_t bf_mutator,
 207                        const void *xquery,
 208                        size_t xquery_size,
 209                        const void *reply_block,
 210                        size_t reply_block_size);
 211
 212
 213 /**
 214  * Function called to obtain the key for a block.
 215  *
 216  * @param ctx block context
 217  * @param type block type
 218  * @param block block to get the key for
 219  * @param block_size number of bytes in block
 220  * @param key set to the key (query) for the given block
 221  * @return GNUNET_OK on success,
 222  *         GNUNET_NO if the block is malformed
 223  *         GNUNET_SYSERR if type not supported
 224  *         (or if extracting a key from a block of this type does not work)
 225  */
 226 int
 227 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
 228                       enum GNUNET_BLOCK_Type type,
 229                       const void *block,
 230                       size_t block_size,
 231                       GNUNET_HashCode *key);
 232
 233
 234 #if 0                           /* keep Emacsens' auto-indent happy */
 235 {
 236 #endif
 237 #ifdef __cplusplus
 238 }
 239 #endif
 240
 241
 242 /* ifndef GNUNET_BLOCK_LIB_H */
 243 #endif
 244 /* end of gnunet_block_lib.h */