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
|
/*
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
* Plugin API for escrow methods
*
* @defgroup escrow-plugin escrow plugin API for escrow methods
* @{
*/
#ifndef GNUNET_ESCROW_PLUGIN_H
#define GNUNET_ESCROW_PLUGIN_H
#include "gnunet_util_lib.h"
#include "gnunet_escrow_lib.h"
#include "gnunet_identity_service.h"
#include "../escrow/escrow.h"
#include "gnunet_scheduler_lib.h"
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* Function called to start the escrow of the key
*
* @param h the handle for the escrow component
* @param ego the identity ego containing the private key
* @param userSecret the user secret (e.g. for derivation of escrow identities)
* for GNS escrow, this has to be UNIQUE in the whole network!
* @param cb the function called upon completion
* @param op_id unique ID of the respective ESCROW_Operation
*
* @return a wrapper for the plugin operation
*/
typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_StartKeyEscrowFunction) (
struct GNUNET_ESCROW_Handle *h,
struct GNUNET_IDENTITY_Ego *ego,
const char *userSecret,
GNUNET_SCHEDULER_TaskCallback cb,
uint32_t op_id);
/**
* Function called to verify the escrow of the key
*
* @param h the handle for the escrow component
* @param ego the identity ego containing the private key
* @param anchor the escrow anchor needed to restore the key
* @param cb the function called upon completion
* @param op_id unique ID of the respective ESCROW_Operation
*
* @return a wrapper for the plugin operation
*/
typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_VerifyKeyEscrowFunction) (
struct GNUNET_ESCROW_Handle *h,
struct GNUNET_IDENTITY_Ego *ego,
struct GNUNET_ESCROW_Anchor *anchor,
GNUNET_SCHEDULER_TaskCallback cb,
uint32_t op_id);
/**
* Function called to restore a key from an escrow
*
* @param h the handle for the escrow component
* @param anchor the escrow anchor needed to restore the key
* @param cb the function called upon completion
* @param op_id unique ID of the respective ESCROW_Operation
*
* @return a wrapper for the plugin operation
*/
typedef struct ESCROW_PluginOperationWrapper *(*GNUNET_ESCROW_RestoreKeyFunction) (
struct GNUNET_ESCROW_Handle *h,
struct GNUNET_ESCROW_Anchor *anchor,
GNUNET_SCHEDULER_TaskCallback cb,
uint32_t op_id);
/**
* Function called to get the status of an escrow, i.e.
* -> when the last successful escrow was
* -> when the next recommended escrow is
*
* @param h the handle for the escrow component
* @param ego the identity ego of which the status has to be obtained
*
* @return the status of the escrow packed into a GNUNET_ESCROW_Status struct
*/
typedef struct GNUNET_ESCROW_Status *(*GNUNET_ESCROW_GetEscrowStatusFunction) (
struct GNUNET_ESCROW_Handle *h,
struct GNUNET_IDENTITY_Ego *ego);
/**
* Function called to cancel a plugin operation
*
* @param plugin_op_wrap plugin operation wrapper containing the plugin operation
*/
typedef void (*GNUNET_ESCROW_CancelPluginOperationFunction) (
struct ESCROW_PluginOperationWrapper *plugin_op_wrap);
/**
* Each plugin is required to return a pointer to a struct of this
* type as the return value from its entry point.
*/
struct GNUNET_ESCROW_KeyPluginFunctions
{
/**
* Closure for all of the callbacks.
*/
void *cls;
/**
* Start key escrow
*/
GNUNET_ESCROW_StartKeyEscrowFunction start_key_escrow;
/**
* Verify key escrow
*/
GNUNET_ESCROW_VerifyKeyEscrowFunction verify_key_escrow;
/**
* Restore key escrow
*/
GNUNET_ESCROW_RestoreKeyFunction restore_key;
/**
* Get the status of an escrow
*/
GNUNET_ESCROW_GetEscrowStatusFunction get_status;
/**
* Cancel plugin operation
*/
GNUNET_ESCROW_CancelPluginOperationFunction cancel_plugin_operation;
};
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group */
|
