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
|
/*
This file is part of GNU Taler
Copyright (C) 2019 Taler Systems SA
Taler is free software; you can redistribute it and/or modify it under the
terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 3, or (at your option) any later version.
Taler 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 General Public License for more details.
You should have received a copy of the GNU General Public License along with
Taler; see the file COPYING.GPL. If not, see <http://www.gnu.org/licenses/>
*/
/**
* @file include/sync_database_plugin.h
* @brief database access for Sync
* @author Christian Grothoff
*/
#ifndef SYNC_DATABASE_PLUGIN_H
#define SYNC_DATABASE_PLUGIN_H
#include <gnunet/gnunet_util_lib.h>
#include <sync_error_codes.h>
#include "sync_service.h"
#include <jansson.h>
#include <taler/taler_util.h>
/**
* Private key identifying an account.
*/
struct SYNC_AccountPrivateKey
{
/**
* We use EdDSA.
*/
struct GNUNET_EdDSAPrivateKey eddsa_priv;
};
/**
* Public key identifying an account.
*/
struct SYNC_AccountPublicKey
{
/**
* We use EdDSA.
*/
struct GNUNET_EdDSAPrivateKey eddsa_priv;
};
/**
* Signature made with an account's public key.
*/
struct SYNC_AccountSignature
{
/**
* We use EdDSA.
*/
struct GNUNET_EdDSASignature eddsa_sig;
};
/**
* Possible status codes returned from the SYNC database.
*/
enum SYNC_DB_QueryStatus
{
/**
* Update failed because the old backup hash does not match what we previously had in the DB.
*/
SYNC_DB_OLD_BACKUP_MISSMATCH = -4,
/**
* Account is unpaid.
*/
SYNC_DB_QS_PAYMENT_REQUIRED = -3,
/**
* Hard database issue, retries futile.
*/
SYNC_DB_HARD_ERROR = -2,
/**
* Soft database error, retrying may help.
*/
SYNC_DB_SOFT_ERROR = -1,
/**
* Database succeeded, but no results.
*/
SYNC_DB_NO_RESULTS = 0,
/**
* Database succeeded, one change or result.
*/
SYNC_DB_ONE_RESULT = 1
};
/**
* Handle to interact with the database.
*
* Functions ending with "_TR" run their OWN transaction scope
* and MUST NOT be called from within a transaction setup by the
* caller. Functions ending with "_NT" require the caller to
* setup a transaction scope. Functions without a suffix are
* simple, single SQL queries that MAY be used either way.
*/
struct SYNC_DatabasePlugin
{
/**
* Closure for all callbacks.
*/
void *cls;
/**
* Name of the library which generated this plugin. Set by the
* plugin loader.
*/
char *library_name;
/**
* Drop sync tables. Used for testcases.
*
* @param cls closure
* @return #GNUNET_OK upon success; #GNUNET_SYSERR upon failure
*/
int
(*drop_tables) (void *cls);
/**
* Function called to perform "garbage collection" on the
* database, expiring records we no longer require. Deletes
* all user records that are not paid up (and by cascade deletes
* the associated recovery documents). Also deletes expired
* truth and financial records older than @a fin_expire.
*
* @param cls closure
* @param expire backups older than the given time stamp should be garbage collected
* @return transaction status
*/
enum SYNC_DB_QueryStatus
(*gc)(void *cls,
struct GNUNET_TIME_Absolute expire);
/**
* Store backup. Only applicable for the FIRST backup under
* an @a account_pub. Use @e update_backup_TR to update an
* existing backup.
*
* @param cls closure
* @param account_pub account to store @a backup under
* @param account_sig signature affirming storage request
* @param backup_hash hash of @a backup
* @param backup_size number of bytes in @a backup
* @param backup raw data to backup
* @return transaction status
*/
enum SYNC_DB_QueryStatus
(*store_backup_TR)(void *cls,
const struct SYNC_AccountPublicKey *account_pub,
const struct SYNC_AccountSignature *account_sig,
const struct GNUNET_HashCode *backup_hash,
size_t backup_size,
const void *backup);
/**
* Update backup.
*
* @param cls closure
* @param account_pub account to store @a backup under
* @param account_sig signature affirming storage request
* @param old_backup_hash hash of the previous backup (must match)
* @param backup_hash hash of @a backup
* @param backup_size number of bytes in @a backup
* @param backup raw data to backup
* @return transaction status
*/
enum SYNC_DB_QueryStatus
(*update_backup_TR)(void *cls,
const struct SYNC_AccountPublicKey *account_pub,
const struct GNUNET_HashCode *old_backup_hash,
const struct SYNC_AccountSignature *account_sig,
const struct GNUNET_HashCode *backup_hash,
size_t backup_size,
const void *backup);
/**
* Obtain backup.
*
* @param cls closure
* @param account_pub account to store @a backup under
* @param account_sig[OUT] set to signature affirming storage request
* @param backup_hash[OUT] set to hash of @a backup
* @param backup_size[OUT] set to number of bytes in @a backup
* @param backup[OUT] set to raw data to backup, caller MUST FREE
*/
enum SYNC_DB_QueryStatus
(*lookup_backup_TR)(void *cls,
const struct SYNC_AccountPublicKey *account_pub,
struct SYNC_AccountSignature *account_sig,
struct GNUNET_HashCode *backup_hash,
size_t *backup_size,
void **backup);
/**
* Increment account lifetime.
*
* @param cls closure
* @param account_pub which account received a payment
* @param lifetime for how long is the account now paid (increment)
* @return transaction status
*/
enum SYNC_DB_QueryStatus
(*increment_lifetime_TR)(void *cls,
const struct SYNC_AccountPublicKey *account_pub,
struct GNUNET_TIME_Relative lifetime);
};
#endif
|
