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
|
/*
This file is part of GNUnet
Copyright (C) 2012, 2013, 2018 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
*/
/**
* @addtogroup GNS
* @{
*
* @author Christian Grothoff
*
* @file
* Plugin API for the namestore database backend
*
* @defgroup namestore-plugin Name Store service plugin API
* Plugin API for the namestore database backend
* @{
*/
#ifndef GNUNET_NAMESTORE_PLUGIN_H
#define GNUNET_NAMESTORE_PLUGIN_H
#include "gnunet_util_lib.h"
#include "gnunet_namestore_service.h"
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* Function called for each matching record.
*
* @param cls closure
* @param serial unique serial number of the record, MUST NOT BE ZERO,
* and must be monotonically increasing while iterating
* @param editor_hint content of the editor field when record was read (may be NULL)
* @param zone_key private key of the zone
* @param label name that is being mapped (at most 255 characters long)
* @param rd_count number of entries in @a rd array
* @param rd array of records with data to store
*/
typedef void
(*GNUNET_NAMESTORE_RecordIterator) (void *cls,
uint64_t serial,
const char *editor_hint,
const struct
GNUNET_CRYPTO_PrivateKey *private_key,
const char *label,
unsigned int rd_count,
const struct GNUNET_GNSRECORD_Data *rd);
/**
* @brief struct returned by the initialization function of the plugin
*/
struct GNUNET_NAMESTORE_PluginFunctions
{
/**
* Closure to pass to all plugin functions.
*/
void *cls;
/**
* Store a record in the datastore for which we are the authority.
* Removes any existing record in the same zone with the same name.
*
* @param cls closure (internal context for the plugin)
* @param zone private key of the zone
* @param label name of the record in the zone
* @param rd_count number of entries in @a rd array, 0 to delete all records
* @param rd array of records with data to store
* @return #GNUNET_OK on success, else #GNUNET_SYSERR
*/
enum GNUNET_GenericReturnValue
(*store_records)(void *cls,
const struct GNUNET_CRYPTO_PrivateKey *zone,
const char *label,
unsigned int rd_count,
const struct GNUNET_GNSRECORD_Data *rd);
/**
* Lookup records in the datastore for which we are the authority.
*
* @param cls closure (internal context for the plugin)
* @param zone private key of the zone
* @param label name of the record in the zone
* @param iter function to call with the result
* @param iter_cls closure for @a iter
* @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
*/
enum GNUNET_GenericReturnValue
(*lookup_records)(void *cls,
const struct GNUNET_CRYPTO_PrivateKey *zone,
const char *label,
GNUNET_NAMESTORE_RecordIterator iter,
void *iter_cls);
/**
* Iterate over the results for a particular zone in the
* datastore. Will return at most @a limit results to the iterator.
*
* @param cls closure (internal context for the plugin)
* @param zone private key of the zone, NULL for all zones
* @param serial serial (to exclude) in the list of matching records;
* 0 means to exclude nothing; results must be returned using
* the minimum possible sequence number first (ordered by serial)
* @param limit maximum number of results to return to @a iter
* @param iter function to call with the result
* @param iter_cls closure for @a iter
* @return #GNUNET_OK on success, #GNUNET_NO if there were no more results, #GNUNET_SYSERR on error
*/
enum GNUNET_GenericReturnValue
(*iterate_records)(void *cls,
const struct GNUNET_CRYPTO_PrivateKey *zone,
uint64_t serial,
uint64_t limit,
GNUNET_NAMESTORE_RecordIterator iter,
void *iter_cls);
/**
* Look for an existing PKEY delegation record for a given public key.
* Returns at most one result to the iterator.
*
* @param cls closure (internal context for the plugin)
* @param zone private key of the zone to look up in, never NULL
* @param value_zone public key of the target zone (value), never NULL
* @param iter function to call with the result
* @param iter_cls closure for @a iter
* @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
*/
enum GNUNET_GenericReturnValue
(*zone_to_name)(void *cls,
const struct GNUNET_CRYPTO_PrivateKey *zone,
const struct GNUNET_CRYPTO_PublicKey *value_zone,
GNUNET_NAMESTORE_RecordIterator iter,
void *iter_cls);
/** Transaction-based API draft **/
/**
* Edit records in the namestore.
* This modifies the editor hint, an advisory lock entry.
* The record iterator will be called with the old editor hint (if any).
*
* @param cls closure (internal context for the plugin)
* @param zone private key of the zone
* @param editor_hint the new value for the advisory lock field
* @param label name of the record in the zone
* @param iter function to call with the result
* @param iter_cls closure for @a iter
* @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
*/
enum GNUNET_GenericReturnValue
(*edit_records)(void *cls,
const char *editor_hint,
const struct GNUNET_CRYPTO_PrivateKey *zone,
const char *label,
GNUNET_NAMESTORE_RecordIterator iter,
void *iter_cls);
/**
* This clears the editor hint, unless it does not match the
* given editor hint, in which case this is a NOP.
* If a replacement hint is given, it hint is not cleared, but
* set to the replacement.
*
* @param cls closure (internal context for the plugin)
* @param zone private key of the zone
* @param editor_hint the new value for the advisory lock field
* @param editor_hint_replacement an optional value to use instead of a clear
* @param label name of the record in the zone
* @param iter function to call with the result
* @param iter_cls closure for @a iter
* @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
*/
enum GNUNET_GenericReturnValue
(*clear_editor_hint)(void *cls,
const char *editor_hint,
const char *editor_hint_replacement,
const struct GNUNET_CRYPTO_PrivateKey *zone,
const char *label);
/**
* Setup the database.
*
* @param cls closure (internal context for the plugin)
* @return #GNUNET_OK on success, else fails with #GNUNET_SYSERR
*/
enum GNUNET_GenericReturnValue
(*create_tables)(void *cls);
/**
* Drop existing tables.
* DANGEROUS: All existing data in the dabase will be lost!
*
* @param cls closure (internal context for the plugin)
* @return #GNUNET_OK on success, else fails with #GNUNET_SYSERR
*/
enum GNUNET_GenericReturnValue
(*drop_tables)(void *cls);
};
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group */
/** @} */ /* end of group addition */
|
