indentation
[oweals/gnunet.git] / src / include / gnunet_block_lib.h
index ace4f23bb7f971b0b91dfa87f379afdaade8188a..ae68848693a6830ba9b3eab3b7dd26dbb1688379 100644 (file)
@@ -39,250 +39,113 @@ extern "C"
 /**
  * Blocks in the datastore and the datacache must have a unique type.
  */
-enum GNUNET_BLOCK_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,
+  GNUNET_BLOCK_TYPE_ANY = 0,
 
     /**
      * Data block (leaf) in the CHK tree.
      */
-    GNUNET_BLOCK_TYPE_DBLOCK = 1,
+  GNUNET_BLOCK_TYPE_FS_DBLOCK = 1,
 
     /**
      * Inner block in the CHK tree.
      */
-    GNUNET_BLOCK_TYPE_IBLOCK = 2,
+  GNUNET_BLOCK_TYPE_FS_IBLOCK = 2,
 
     /**
-     * Type of a block representing a keyword search result.
+     * Type of a block representing a keyword search result.  Note that
+     * the values for KBLOCK, SBLOCK and NBLOCK must be consecutive.
      */
-    GNUNET_BLOCK_TYPE_KBLOCK = 3,
+  GNUNET_BLOCK_TYPE_FS_KBLOCK = 3,
 
     /**
      * Type of a block that is used to advertise content in a namespace.
      */
-    GNUNET_BLOCK_TYPE_SBLOCK = 4,
+  GNUNET_BLOCK_TYPE_FS_SBLOCK = 4,
+
+    /**
+     * Type of a block that is used to advertise a namespace.  
+     */
+  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_ONDEMAND = 5,
+  GNUNET_BLOCK_TYPE_FS_ONDEMAND = 6,
 
     /**
-     * Type of a block that is used to advertise a namespace.  
+     * Type of a block that contains a HELLO for a peer (for
+     * DHT find-peer operations).
      */
-    GNUNET_BLOCK_TYPE_NBLOCK = 6,
-
-    GNUNET_BLOCK_TYPE_TEST = 9999
-
-  };
-
-
-/* **************** FIXME: move these to block_fs.h or so ***************** */
-
-/**
- * @brief keyword block (advertising data under a keyword)
- */
-struct KBlock
-{
-
-  /**
-   * GNUNET_RSA_Signature using RSA-key generated from search keyword.
-   */
-  struct GNUNET_CRYPTO_RsaSignature signature;
-
-  /**
-   * What is being signed and why?
-   */
-  struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
-
-  /**
-   * Key generated (!) from the H(keyword) as the seed!
-   */
-  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
-
-  /* 0-terminated URI here */
-
-  /* variable-size Meta-Data follows here */
-
-};
-
-
-/**
- * @brief namespace content block (advertising data under an identifier in a namespace)
- */
-struct SBlock
-{
-
-  /**
-   * GNUNET_RSA_Signature using RSA-key of the namespace
-   */
-  struct GNUNET_CRYPTO_RsaSignature signature;
-
-  /**
-   * What is being signed and why?
-   */
-  struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
-
-  /**
-   * Hash of the hash of the human-readable identifier used for
-   * this entry (the hash of the human-readable identifier is
-   * used as the key for decryption; the xor of this identifier
-   * and the hash of the "keyspace" is the datastore-query hash).
-   */
-  GNUNET_HashCode identifier;
-
-  /**
-   * Public key of the namespace.
-   */
-  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
-
-  /* 0-terminated update-identifier here */
-
-  /* 0-terminated URI here (except for NBlocks) */
-
-  /* variable-size Meta-Data follows here */
-
-};
-
-
-/**
- * @brief namespace advertisement block (advertising root of a namespace)
- */
-struct NBlock
-{
-
-  /**
-   * GNUNET_RSA_Signature using RSA-key generated from search keyword.
-   */
-  struct GNUNET_CRYPTO_RsaSignature ksk_signature;
-
-  /**
-   * What is being signed and why?
-   */
-  struct GNUNET_CRYPTO_RsaSignaturePurpose ksk_purpose;
-
-  /**
-   * Key generated (!) from the H(keyword) as the seed!
-   */
-  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded keyspace;
-
-  /**
-   * GNUNET_RSA_Signature using RSA-key of the namespace
-   */
-  struct GNUNET_CRYPTO_RsaSignature ns_signature;
-
-  /**
-   * What is being signed and why?
-   */
-  struct GNUNET_CRYPTO_RsaSignaturePurpose ns_purpose;
-
-  /**
-   * Public key of the namespace.
-   */
-  struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded subspace;
-
-  /* from here on, data is encrypted with H(keyword) */
-
-  /* 0-terminated root identifier here */
-
-  /* variable-size Meta-Data follows here */
-
-};
+  GNUNET_BLOCK_TYPE_DHT_HELLO = 7,
 
+    /**
+     * Block for testing.
+     */
+  GNUNET_BLOCK_TYPE_TEST = 8,
 
-/**
- * @brief index block (indexing a DBlock that 
- *        can be obtained directly from reading
- *        the plaintext file)
- */
-struct OnDemandBlock
-{
-  /**
-   * Hash code of the entire content of the
-   * file that was indexed (used to uniquely
-   * identify the plaintext file).
-   */
-  GNUNET_HashCode file_id;
-
-  /**
-   * At which offset should we be able to find
-   * this on-demand encoded block? (in NBO)
-   */
-  uint64_t offset GNUNET_PACKED;
+#if HAVE_MALICIOUS
+    /**
+     * Block for simulating malicious peers.
+     */
+  GNUNET_BLOCK_DHT_MALICIOUS_MESSAGE_TYPE = 9,
+#endif
 
+    /**
+     * Block for storing .gnunet-domains
+     */
+  GNUNET_BLOCK_TYPE_DNS = 10
 };
 
 
-/* **************** OLD API ***************** */
-
-/**
- * Check if the given block is well-formed (and of the given type).
- *
- * @param type type of the block
- * @param block the block data (or at least "size" bytes claiming to be one)
- * @param size size of "kb" in bytes; check that it is large enough
- * @param query where to store the query that this block answers
- * @return GNUNET_OK if this is actually a well-formed KBlock
- *         GNUNET_NO if we could not determine the query,
- *         GNUNET_SYSERR if the block is malformed
- */
-int
-GNUNET_BLOCK_check_block (enum GNUNET_BLOCK_Type type,
-                         const void *block,
-                         size_t size,
-                         GNUNET_HashCode *query);
-
-
-/* **************** NEW API ***************** */
-
 /**
  * Possible ways for how a block may relate to a query.
  */
 enum GNUNET_BLOCK_EvaluationResult
-  {
+{
     /**
      * Valid result, and there may be more.
      */
-    GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
+  GNUNET_BLOCK_EVALUATION_OK_MORE = 0,
 
     /**
      * Last possible valid result.
      */
-    GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
+  GNUNET_BLOCK_EVALUATION_OK_LAST = 1,
 
     /**
      * Valid result, but suppressed because it is a duplicate.
      */
-    GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
+  GNUNET_BLOCK_EVALUATION_OK_DUPLICATE = 2,
 
     /**
      * Block does not match query (invalid result)
      */
-    GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
+  GNUNET_BLOCK_EVALUATION_RESULT_INVALID = 3,
 
     /**
      * Query is valid, no reply given.
      */
-    GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
+  GNUNET_BLOCK_EVALUATION_REQUEST_VALID = 4,
 
     /**
      * Query format does not match block type (invalid query).  For
      * example, xquery not given or xquery_size not appropriate for
      * type.
      */
-    GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
+  GNUNET_BLOCK_EVALUATION_REQUEST_INVALID = 5,
 
     /**
      * Specified block type not supported by this plugin.
      */
-    GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
-  };
+  GNUNET_BLOCK_EVALUATION_TYPE_NOT_SUPPORTED = 6
+};
 
 
 /**
@@ -291,14 +154,27 @@ enum GNUNET_BLOCK_EvaluationResult
 struct GNUNET_BLOCK_Context;
 
 
+/**
+ * Mingle hash with the mingle_number to produce different bits.
+ * 
+ * @param in original hash code
+ * @param mingle_number number for hash permutation
+ * @param hc where to store the result.
+ */
+void
+GNUNET_BLOCK_mingle_hash (const GNUNET_HashCode * in,
+                          uint32_t mingle_number, GNUNET_HashCode * hc);
+
+
 /**
  * Create a block context.  Loads the block plugins.
  *
  * @param cfg configuration to use
  * @return NULL on error
  */
-struct GNUNET_BLOCK_Context *
-GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
+struct GNUNET_BLOCK_Context *GNUNET_BLOCK_context_create (const struct
+                                                          GNUNET_CONFIGURATION_Handle
+                                                          *cfg);
 
 
 /**
@@ -306,8 +182,7 @@ GNUNET_BLOCK_context_create (const struct GNUNET_CONFIGURATION_Handle *cfg);
  *
  * @param ctx context to destroy
  */
-void
-GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
+void GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
 
 
 /**
@@ -330,14 +205,13 @@ GNUNET_BLOCK_context_destroy (struct GNUNET_BLOCK_Context *ctx);
  */
 enum GNUNET_BLOCK_EvaluationResult
 GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
-                      enum GNUNET_BLOCK_Type type,
-                      const GNUNET_HashCode *query,
-                      struct GNUNET_CONTAINER_BloomFilter **bf,
-                      int32_t bf_mutator,
-                      const void *xquery,
-                      size_t xquery_size,
-                      const void *reply_block,
-                      size_t reply_block_size);
+                       enum GNUNET_BLOCK_Type type,
+                       const GNUNET_HashCode * query,
+                       struct GNUNET_CONTAINER_BloomFilter **bf,
+                       int32_t bf_mutator,
+                       const void *xquery,
+                       size_t xquery_size,
+                       const void *reply_block, size_t reply_block_size);
 
 
 /**
@@ -348,15 +222,16 @@ GNUNET_BLOCK_evaluate (struct GNUNET_BLOCK_Context *ctx,
  * @param block block to get the key for
  * @param block_size number of bytes in block
  * @param key set to the key (query) for the given block
- * @return GNUNET_OK on success, GNUNET_SYSERR if type not supported
+ * @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)
  */
 int
 GNUNET_BLOCK_get_key (struct GNUNET_BLOCK_Context *ctx,
-                     enum GNUNET_BLOCK_Type type,
-                     const void *block,
-                     size_t block_size,
-                     GNUNET_HashCode *key);
+                      enum GNUNET_BLOCK_Type type,
+                      const void *block,
+                      size_t block_size, GNUNET_HashCode * key);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */