src/include/block_fs.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
  19 /**
  20  * @author Christian Grothoff
  21  *
  22  * @file
  23  * FS block formats (shared between FS and Block)
  24  *
  25  * @defgroup block-fs  FS block formats
  26  * Shared between the [FS service](@ref fs) and the [Block library](@ref block).
  27  * @{
  28  */
  29 #ifndef BLOCK_FS_H
  30 #define BLOCK_FS_H
  31
  32 #include "gnunet_util_lib.h"
  33 #include "gnunet_fs_service.h"
  34
  35
  36 /**
  37  * Maximum legal size for a ublock.
  38  */
  39 #define MAX_UBLOCK_SIZE (60 * 1024)
  40
  41
  42
  43 GNUNET_NETWORK_STRUCT_BEGIN
  44
  45 /**
  46  * @brief universal block for keyword and namespace search results
  47  */
  48 struct UBlock
  49 {
  50
  51   /**
  52    * Signature using pseudonym and search keyword / identifier.
  53    */
  54   struct GNUNET_CRYPTO_EcdsaSignature signature;
  55
  56   /**
  57    * What is being signed and why?
  58    */
  59   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
  60
  61   /**
  62    * Public key used to sign this block.
  63    */
  64   struct GNUNET_CRYPTO_EcdsaPublicKey verification_key;
  65
  66   /* rest of the data is encrypted */
  67
  68   /* 0-terminated update-identifier here (ignored for keyword results) */
  69
  70   /* 0-terminated URI here */
  71
  72   /* variable-size Meta-Data follows here */
  73
  74 };
  75
  76
  77 /**
  78  * @brief index block (indexing a DBlock that
  79  *        can be obtained directly from reading
  80  *        the plaintext file)
  81  */
  82 struct OnDemandBlock
  83 {
  84   /**
  85    * Hash code of the entire content of the
  86    * file that was indexed (used to uniquely
  87    * identify the plaintext file).
  88    */
  89   struct GNUNET_HashCode file_id;
  90
  91   /**
  92    * At which offset should we be able to find
  93    * this on-demand encoded block? (in NBO)
  94    */
  95   uint64_t offset GNUNET_PACKED;
  96
  97 };
  98 GNUNET_NETWORK_STRUCT_END
  99
 100 #endif
 101
 102 /** @} */  /* end of group */