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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
/*
This file is part of TALER
Copyright (C) 2022 Taler Systems SA
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU 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. If not, see <http://www.gnu.org/licenses/>
*/
/**
* @file include/taler_kyclogic_plugin.h
* @brief KYC API specific logic C interface
* @author Christian Grothoff
*/
#ifndef TALER_KYCLOGIC_PLUGIN_H
#define TALER_KYCLOGIC_PLUGIN_H
#include <jansson.h>
#include <gnunet/gnunet_util_lib.h>
#include <gnunet/gnunet_db_lib.h>
#include "taler_util.h"
/**
* Possible states of a KYC check.
*/
enum TALER_KYCLOGIC_KycStatus
{
/**
* The provider has passed the customer.
*/
TALER_KYCLOGIC_STATUS_SUCCESS = 0,
/**
* Something to do with the user (bit!).
*/
TALER_KYCLOGIC_STATUS_USER = 1,
/**
* Something to do with the provider (bit!).
*/
TALER_KYCLOGIC_STATUS_PROVIDER = 2,
/**
* The interaction ended in definitive failure.
* (kind of with both parties).
*/
TALER_KYCLOGIC_STATUS_FAILED
= TALER_KYCLOGIC_STATUS_USER
| TALER_KYCLOGIC_STATUS_PROVIDER,
/**
* The interaction is still ongoing.
*/
TALER_KYCLOGIC_STATUS_PENDING = 4,
/**
* One of the parties hat a temporary failure.
*/
TALER_KYCLOGIC_STATUS_ABORTED = 8,
/**
* The interaction with the user is ongoing.
*/
TALER_KYCLOGIC_STATUS_USER_PENDING
= TALER_KYCLOGIC_STATUS_USER
| TALER_KYCLOGIC_STATUS_PENDING,
/**
* The provider is still checking.
*/
TALER_KYCLOGIC_STATUS_PROVIDER_PENDING
= TALER_KYCLOGIC_STATUS_PROVIDER
| TALER_KYCLOGIC_STATUS_PENDING,
/**
* The user aborted the check (possibly recoverable)
* or made some other type of (recoverable) mistake.
*/
TALER_KYCLOGIC_STATUS_USER_ABORTED
= TALER_KYCLOGIC_STATUS_USER
| TALER_KYCLOGIC_STATUS_ABORTED,
/**
* The provider had an (internal) failure.
*/
TALER_KYCLOGIC_STATUS_PROVIDER_FAILED
= TALER_KYCLOGIC_STATUS_PROVIDER
| TALER_KYCLOGIC_STATUS_ABORTED,
/**
* Return code set to not update the KYC status
* at all.
*/
TALER_KYCLOGIC_STATUS_KEEP = 16
};
/**
* Plugin-internal specification of the configuration
* of the plugin for a given KYC provider.
*/
struct TALER_KYCLOGIC_ProviderDetails;
/**
* Handle for an initiation operation.
*/
struct TALER_KYCLOGIC_InitiateHandle;
/**
* Handle for an KYC proof operation.
*/
struct TALER_KYCLOGIC_ProofHandle;
/**
* Handle for an KYC Web hook operation.
*/
struct TALER_KYCLOGIC_WebhookHandle;
/**
* Function called with the result of a KYC initiation
* operation.
*
* @param cls closure
* @param ec #TALER_EC_NONE on success
* @param redirect_url set to where to redirect the user on success, NULL on failure
* @param provider_user_id set to user ID at the provider, or NULL if not supported or unknown
* @param provider_legitimization_id set to legitimization process ID at the provider, or NULL if not supported or unknown
* @param error_msg_hint set to additional details to return to user, NULL on success
*/
typedef void
(*TALER_KYCLOGIC_InitiateCallback)(
void *cls,
enum TALER_ErrorCode ec,
const char *redirect_url,
const char *provider_user_id,
const char *provider_legitimization_id,
const char *error_msg_hint);
/**
* Function called with the result of a proof check operation.
*
* Note that the "decref" for the @a response
* will be done by the callee and MUST NOT be done by the plugin.
*
* @param cls closure
* @param status KYC status
* @param provider_user_id set to user ID at the provider, or NULL if not supported or unknown
* @param provider_legitimization_id set to legitimization process ID at the provider, or NULL if not supported or unknown
* @param attributes user attributes returned by the provider
* @param expiration until when is the KYC check valid
* @param http_status HTTP status code of @a response
* @param[in] response to return to the HTTP client
*/
typedef void
(*TALER_KYCLOGIC_ProofCallback)(
void *cls,
enum TALER_KYCLOGIC_KycStatus status,
const char *provider_user_id,
const char *provider_legitimization_id,
struct GNUNET_TIME_Absolute expiration,
const json_t *attributes,
unsigned int http_status,
struct MHD_Response *response);
/**
* Function called with the result of a webhook operation.
*
* Note that the "decref" for the @a response will be done by the callee and
* MUST NOT be done by the plugin!
*
* @param cls closure
* @param process_row legitimization process the webhook was about
* @param account_id account the webhook was about
* @param provider_section name of the configuration section of the logic that was run
* @param provider_user_id set to user ID at the provider, or NULL if not supported or unknown
* @param provider_legitimization_id set to legitimization process ID at the provider, or NULL if not supported or unknown
* @param status KYC status
* @param expiration until when is the KYC check valid
* @param attributes user attributes returned by the provider
* @param http_status HTTP status code of @a response
* @param[in] response to return to the HTTP client
*/
typedef void
(*TALER_KYCLOGIC_WebhookCallback)(
void *cls,
uint64_t process_row,
const struct TALER_PaytoHashP *account_id,
const char *provider_section,
const char *provider_user_id,
const char *provider_legitimization_id,
enum TALER_KYCLOGIC_KycStatus status,
struct GNUNET_TIME_Absolute expiration,
const json_t *attributes,
unsigned int http_status,
struct MHD_Response *response);
/**
* Function the plugin can use to lookup an @a h_payto by @a
* provider_legitimization_id. Must match the `kyc_provider_account_lookup`
* of the exchange's database plugin.
*
* @param cls closure
* @param provider_section
* @param provider_legitimization_id legi to look up
* @param[out] h_payto where to write the result
* @param[out] process_row where to write the row of the entry
* @return database transaction status
*/
typedef enum GNUNET_DB_QueryStatus
(*TALER_KYCLOGIC_ProviderLookupCallback)(
void *cls,
const char *provider_section,
const char *provider_legitimization_id,
struct TALER_PaytoHashP *h_payto,
uint64_t *process_row);
/**
* @brief The plugin API, returned from the plugin's "init" function.
* The argument given to "init" is simply a configuration handle.
*/
struct TALER_KYCLOGIC_Plugin
{
/**
* Closure for all callbacks.
*/
void *cls;
/**
* Name of the library which generated this plugin. Set by the
* plugin loader.
*/
char *library_name;
/**
* Name of the logic, for webhook matching. Set by the
* plugin loader.
*/
char *name;
/**
* Load the configuration of the KYC provider.
*
* @param cls closure
* @param provider_section_name configuration section to parse
* @return NULL if configuration is invalid
*/
struct TALER_KYCLOGIC_ProviderDetails *
(*load_configuration)(void *cls,
const char *provider_section_name);
/**
* Release configuration resources previously loaded
*
* @param[in] pd configuration to release
*/
void
(*unload_configuration)(struct TALER_KYCLOGIC_ProviderDetails *pd);
/**
* Initiate KYC check.
*
* @param cls the @e cls of this struct with the plugin-specific state
* @param pd provider configuration details
* @param account_id which account to trigger process for
* @param process_row unique ID for the legitimization process
* @param cb function to call with the result
* @param cb_cls closure for @a cb
* @return handle to cancel operation early
*/
struct TALER_KYCLOGIC_InitiateHandle *
(*initiate)(void *cls,
const struct TALER_KYCLOGIC_ProviderDetails *pd,
const struct TALER_PaytoHashP *account_id,
uint64_t process_row,
TALER_KYCLOGIC_InitiateCallback cb,
void *cb_cls);
/**
* Cancel KYC check initiation.
*
* @param[in] ih handle of operation to cancel
*/
void
(*initiate_cancel) (struct TALER_KYCLOGIC_InitiateHandle *ih);
/**
* Check KYC status and return status to human.
*
* @param cls the @e cls of this struct with the plugin-specific state
* @param pd provider configuration details
* @param connection MHD connection object (for HTTP headers)
* @param account_id which account to trigger process for
* @param process_row row in the legitimization processes table the legitimization is for
* @param provider_user_id user ID (or NULL) the proof is for
* @param provider_legitimization_id legitimization ID the proof is for
* @param cb function to call with the result
* @param cb_cls closure for @a cb
* @return handle to cancel operation early
*/
struct TALER_KYCLOGIC_ProofHandle *
(*proof)(void *cls,
const struct TALER_KYCLOGIC_ProviderDetails *pd,
struct MHD_Connection *connection,
const struct TALER_PaytoHashP *account_id,
uint64_t process_row,
const char *provider_user_id,
const char *provider_legitimization_id,
TALER_KYCLOGIC_ProofCallback cb,
void *cb_cls);
/**
* Cancel KYC proof.
*
* @param[in] ph handle of operation to cancel
*/
void
(*proof_cancel) (struct TALER_KYCLOGIC_ProofHandle *ph);
/**
* Check KYC status and return result for Webhook.
*
* @param cls the @e cls of this struct with the plugin-specific state
* @param pd provider configuration details
* @param plc callback to lookup accounts with
* @param plc_cls closure for @a plc
* @param http_method HTTP method used for the webhook
* @param url_path rest of the URL after `/kyc-webhook/$LOGIC/`
* @param connection MHD connection object (for HTTP headers)
* @param body_size number of bytes in @a body
* @param body HTTP request body
* @param cb function to call with the result
* @param cb_cls closure for @a cb
* @return handle to cancel operation early
*/
struct TALER_KYCLOGIC_WebhookHandle *
(*webhook)(void *cls,
const struct TALER_KYCLOGIC_ProviderDetails *pd,
TALER_KYCLOGIC_ProviderLookupCallback plc,
void *plc_cls,
const char *http_method,
const char *const url_path[],
struct MHD_Connection *connection,
const json_t *upload,
TALER_KYCLOGIC_WebhookCallback cb,
void *cb_cls);
/**
* Cancel KYC webhook execution.
*
* @param[in] wh handle of operation to cancel
*/
void
(*webhook_cancel) (struct TALER_KYCLOGIC_WebhookHandle *wh);
};
#endif /* _TALER_KYCLOGIC_PLUGIN_H */
|