-introducing signing of regex accept states, removing PID from regex API
[oweals/gnunet.git] / src / include / block_regex.h
1 /*
2      This file is part of GNUnet.
3      (C) 2012,2013 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_regex.h
23  * @brief regex block formats
24  * @author Bartlomiej Polot
25  */
26 #ifndef BLOCK_REGEX_H
27 #define BLOCK_REGEX_H
28
29 #ifdef __cplusplus
30 extern "C"
31 {
32 #if 0
33   /* keep Emacsens' auto-indent happy */
34 }
35 #endif
36 #endif
37
38 #include "gnunet_util_lib.h"
39 #include <stdint.h>
40
41
42 GNUNET_NETWORK_STRUCT_BEGIN
43
44
45 /**
46  * @brief A RegexBlock contains one or more of this struct in the payload.
47  */
48 struct RegexEdge
49 {
50   /**
51    * Destination of this edge.
52    */
53   struct GNUNET_HashCode key;
54   
55   /**
56    * Length of the token towards the new state.
57    */
58   uint32_t n_token GNUNET_PACKED;
59
60   /* char token[n_token] */
61 };
62
63
64 /**
65  * @brief Block to announce a regex state.
66  */
67 struct RegexBlock
68 {
69
70   /**
71    * Length of the proof regex string.
72    */
73   uint16_t proof_len GNUNET_PACKED;
74
75   /**
76    * Is this state an accepting state?
77    */
78   int16_t is_accepting GNUNET_PACKED;
79
80   /**
81    * Numer of edges parting from this state.
82    */
83   uint32_t n_edges GNUNET_PACKED;
84
85   /* char proof[n_proof] */
86   /* struct RegexEdge edges[n_edges] */
87 };
88
89
90 /**
91  * @brief Block to announce a peer accepting a state.
92  */
93 struct RegexAcceptBlock
94 {
95
96   /**
97    * Accept blocks must be signed.  Signature
98    * goes over expiration time and key.
99    */
100   struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
101
102   /**
103    * When does the signature expire?
104    */
105   struct GNUNET_TIME_AbsoluteNBO expiration_time;
106
107   /**
108    * The key of the state.
109    */
110   struct GNUNET_HashCode key;
111   
112   /**
113    * Public key of the peer signing.
114    */
115   struct GNUNET_CRYPTO_EccPublicKeyBinaryEncoded public_key;
116
117   /**
118    * The signature.
119    */
120   struct GNUNET_CRYPTO_EccSignature signature;
121 };
122
123
124 GNUNET_NETWORK_STRUCT_END
125
126
127 #if 0                           /* keep Emacsens' auto-indent happy */
128 {
129 #endif
130 #ifdef __cplusplus
131 }
132 #endif
133
134 #endif