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      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @author Christian Grothoff
  23  *
  24  * @file
  25  * FS block formats (shared between FS and Block)
  26  *
  27  * @defgroup block-fs  FS block formats
  28  * Shared between the [FS service](@ref fs) and the [Block library](@ref block).
  29  * @{
  30  */
  31 #ifndef BLOCK_FS_H
  32 #define BLOCK_FS_H
  33
  34 #include "gnunet_util_lib.h"
  35 #include "gnunet_fs_service.h"
  36
  37
  38 /**
  39  * Maximum legal size for a ublock.
  40  */
  41 #define MAX_UBLOCK_SIZE (60 * 1024)
  42
  43
  44 GNUNET_NETWORK_STRUCT_BEGIN
  45
  46 /**
  47  * @brief universal block for keyword and namespace search results
  48  */
  49 struct UBlock
  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  * @brief index block (indexing a DBlock that
  78  *        can be obtained directly from reading
  79  *        the plaintext file)
  80  */
  81 struct OnDemandBlock
  82 {
  83   /**
  84    * Hash code of the entire content of the
  85    * file that was indexed (used to uniquely
  86    * identify the plaintext file).
  87    */
  88   struct GNUNET_HashCode file_id;
  89
  90   /**
  91    * At which offset should we be able to find
  92    * this on-demand encoded block? (in NBO)
  93    */
  94   uint64_t offset GNUNET_PACKED;
  95 };
  96 GNUNET_NETWORK_STRUCT_END
  97
  98 #endif
  99
 100 /** @} */  /* end of group */