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