aboutsummaryrefslogtreecommitdiff
path: root/src/escrow/escrow.h
blob: 8fc9123c11dfc8e6f9ed720f01c8eb17445f7b28 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
/*
   This file is part of GNUnet.
   Copyright (C) 2020 GNUnet e.V.

   GNUnet is free software: you can redistribute it and/or modify it
   under the terms of the GNU Affero General Public License as published
   by the Free Software Foundation, either version 3 of the License,
   or (at your option) any later version.

   GNUnet is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

   SPDX-License-Identifier: AGPL3.0-or-later
 */

/**
 * @author Johannes Späth
 * @file escrow/escrow.h
 * 
 * @brief Common type definitions for the escrow component
 */

#ifndef ESCROW_H
#define ESCROW_H

#include "gnunet_escrow_lib.h"


/**
 * State while collecting all egos
 */
#define ESCROW_PLUGIN_STATE_INIT 0

/**
 * Done collecting egos
 */
#define ESCROW_PLUGIN_STATE_POST_INIT 1

/**
 * State while cleaning up
 */
#define ESCROW_PLUGIN_STATE_CLEANUP 2


/**
 * The ego list
 */
struct EgoEntry
{
  /**
   * DLL
   */
  struct EgoEntry *next;

  /**
   * DLL
   */
  struct EgoEntry *prev;

  /**
   * Ego Identifier
   */
  char *identifier;

  /**
   * Public key string
   */
  char *keystring;

  /**
   * The Ego
   */
  struct GNUNET_IDENTITY_Ego *ego;
};

/**
 * Handle for a plugin instance
 */
struct ESCROW_PluginHandle
{
  /**
   * The identity init continuation.
   */
  GNUNET_ESCROW_IdentityInitContinuation id_init_cont;

  /**
   * The ego create continuation.
   */
  GNUNET_ESCROW_EgoCreateContinuation ego_create_cont;

  /**
   * The current restore callback.
   */
  GNUNET_ESCROW_EgoContinuation curr_restore_cb;

  /**
   * The handle to the escrow component.
   */
  struct GNUNET_ESCROW_Handle *escrow_handle;

  /**
   * The state of the plugin (in the initialization phase).
   */
  int state;

  /**
   * The head of the ego list.
   */
  struct EgoEntry *ego_head;

  /**
   * The tail of the ego list
   */
  struct EgoEntry *ego_tail;

  /**
   * The head of the plugin operation list
   */
  struct ESCROW_PluginOperationWrapper *plugin_op_head;

  /**
   * The tail of the plugin operation list
   */
  struct ESCROW_PluginOperationWrapper *plugin_op_tail;
};

/**
 * Wrapper for an escrow plugin operation
 */
struct ESCROW_PluginOperationWrapper
{
  /**
   * Plugin operations are kept in a DLL.
   */
  struct ESCROW_PluginOperationWrapper *prev;

  /**
   * Plugin operations are kept in a DLL.
   */
  struct ESCROW_PluginOperationWrapper *next;

  /**
   * The actual plugin operation
   */
  void *plugin_op;
};


/**
 * Continuation for a plugin operation (e.g. used for restore, as this
 * callback has to be called from the IDENTITY service after finishing)
 */
typedef void (*ESCROW_Plugin_Continuation) (void *cls);


/**
 * Wrapper for the Plugin_AnchorContinuation.
 * 
 * As this type of function is called from the scheduler, which only takes
 * one argument as closure, this struct is used to pass more arguments.
 */
struct ESCROW_Plugin_AnchorContinuationWrapper
{
  /**
   * Handle for the escrow component
   */
  struct GNUNET_ESCROW_Handle *h;

  /**
   * The escrow anchor
   */
  struct GNUNET_ESCROW_Anchor *anchor;

  /**
   * The unique ID of the respective ESCROW_Operation
   */
  uint32_t op_id;

  /**
   * The error message, NULL on success
   */
  const char *emsg;
};

/**
 * Wrapper for the Plugin_EgoContinuation.
 * 
 * As this type of function is called from the scheduler, which only takes
 * one argument as closure, this struct is used to pass more arguments.
 */
struct ESCROW_Plugin_EgoContinuationWrapper
{
  /**
   * Handle for the escrow component
   */
  struct GNUNET_ESCROW_Handle *h;

  /**
   * The restored ego
   */
  struct GNUNET_IDENTITY_Ego *ego;

  /**
   * The unique ID of the respective ESCROW_Operation
   */
  uint32_t op_id;

  /**
   * The error message, NULL on success
   */
  const char *emsg;
};

/**
 * Wrapper for the Plugin_VerifyContinuation.
 * 
 * As this type of function is called from the scheduler, which only takes
 * one argument as closure, this struct is used to pass more arguments.
 */
struct ESCROW_Plugin_VerifyContinuationWrapper
{
  /**
   * Handle for the escrow component
   */
  struct GNUNET_ESCROW_Handle *h;

  /**
   * The result of the verification
   */
  int verificationResult;

  /**
   * The unique ID of the respective ESCROW_Operation
   */
  uint32_t op_id;

  /**
   * The error message, NULL on success
   */
  const char *emsg;
};


#endif