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
|
/*
This file is part of GNU Taler
Copyright (C) 2021-2023 Taler Systems SA
Taler 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, 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with
Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/>
*/
/**
* @file include/taler_merchant_bank_lib.h
* @brief C interface to access the Taler merchant facade of LibEuFin
* See https://docs.taler.net/TBD
* @author Christian Grothoff
*/
#ifndef TALER_MERCHANT_BANK_LIB_H
#define TALER_MERCHANT_BANK_LIB_H
#include <taler/taler_error_codes.h>
#include <jansson.h>
#include <gnunet/gnunet_curl_lib.h>
#include <taler/taler_util.h>
/**
* Authentication method types.
*/
enum TALER_MERCHANT_BANK_AuthenticationMethod
{
/**
* No authentication.
*/
TALER_MERCHANT_BANK_AUTH_NONE,
/**
* Basic authentication with cleartext username and password.
*/
TALER_MERCHANT_BANK_AUTH_BASIC,
};
/**
* Information used to authenticate to the bank.
*/
struct TALER_MERCHANT_BANK_AuthenticationData
{
/**
* Base URL we use to talk to the wire gateway,
* which talks to the bank for us.
*/
char *wire_gateway_url;
/**
* Which authentication method should we use?
*/
enum TALER_MERCHANT_BANK_AuthenticationMethod method;
/**
* Further details as per @e method.
*/
union
{
/**
* Details for #TALER_MERCHANT_BANK_AUTH_BASIC.
*/
struct
{
/**
* Username to use.
*/
char *username;
/**
* Password to use.
*/
char *password;
} basic;
} details;
};
/* ********************* /history/incoming *********************** */
/**
* Handle for querying the bank for transactions
* made to the exchange.
*/
struct TALER_MERCHANT_BANK_CreditHistoryHandle;
/**
* Details about a wire transfer to the exchange.
*/
struct TALER_MERCHANT_BANK_CreditDetails
{
/**
* Amount that was transferred
*/
struct TALER_Amount amount;
/**
* Time of the the transfer
*/
struct GNUNET_TIME_Timestamp execution_date;
/**
* The wire transfer subject.
*/
const char *wire_subject;
/**
* payto://-URL of the source account that
* send the funds.
*/
const char *debit_account_uri;
/**
* payto://-URL of the target account that
* received the funds.
*/
const char *credit_account_uri;
};
/**
* Callbacks of this type are used to serve the result of asking
* the bank for the credit transaction history.
*
* @param cls closure
* @param http_status HTTP response code, #MHD_HTTP_OK (200) for successful status request
* 0 if the bank's reply is bogus (fails to follow the protocol),
* #MHD_HTTP_NO_CONTENT if there are no more results; on success the
* last callback is always of this status (even if `abs(num_results)` were
* already returned).
* @param ec detailed error code
* @param serial_id monotonically increasing counter corresponding to the transaction
* @param details details about the wire transfer
* @return #GNUNET_OK to continue, #GNUNET_SYSERR to abort iteration
*/
typedef enum GNUNET_GenericReturnValue
(*TALER_MERCHANT_BANK_CreditHistoryCallback)(
void *cls,
unsigned int http_status,
enum TALER_ErrorCode ec,
uint64_t serial_id,
const struct TALER_MERCHANT_BANK_CreditDetails *details);
/**
* Request the wire credit history of an exchange's bank account.
*
* @param ctx curl context for the event loop
* @param auth authentication data to use
* @param start_row from which row on do we want to get results, use UINT64_MAX for the latest; exclusive
* @param num_results how many results do we want; negative numbers to go into the past,
* positive numbers to go into the future starting at @a start_row;
* must not be zero.
* @param timeout how long the client is willing to wait for more results
* (only useful if @a num_results is positive)
* @param hres_cb the callback to call with the transaction history
* @param hres_cb_cls closure for the above callback
* @return NULL
* if the inputs are invalid (i.e. zero value for @e num_results).
* In this case, the callback is not called.
*/
struct TALER_MERCHANT_BANK_CreditHistoryHandle *
TALER_MERCHANT_BANK_credit_history (
struct GNUNET_CURL_Context *ctx,
const struct TALER_MERCHANT_BANK_AuthenticationData *auth,
uint64_t start_row,
int64_t num_results,
struct GNUNET_TIME_Relative timeout,
TALER_MERCHANT_BANK_CreditHistoryCallback hres_cb,
void *hres_cb_cls);
/**
* Cancel an history request. This function cannot be used on a request
* handle if the last response (anything with a status code other than
* 200) is already served for it.
*
* @param hh the history request handle
*/
void
TALER_MERCHANT_BANK_credit_history_cancel (
struct TALER_MERCHANT_BANK_CreditHistoryHandle *hh);
/* ******************** Convenience functions **************** */
/**
* Convenience method for parsing configuration section with bank
* authentication data.
*
* @param cfg configuration to parse
* @param section the section with the configuration data
* @param[out] auth set to the configuration data found
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TALER_MERCHANT_BANK_auth_parse_cfg (
const struct
GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
struct TALER_MERCHANT_BANK_AuthenticationData *auth);
/**
* Convenience method for parsing JSON with bank
* authentication data.
*
* @param cred configuration to parse
* @param backend_url URL of the backend (not in the JSON)
* @param[out] auth set to the configuration data found
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TALER_MERCHANT_BANK_auth_parse_json (
const json_t *cred,
const char *backend_url,
struct TALER_MERCHANT_BANK_AuthenticationData *auth);
/**
* Free memory inside of @a auth (but not @a auth itself).
* Dual to #TALER_MERCHANT_BANK_auth_parse_cfg().
*
* @param auth authentication data to free
*/
void
TALER_MERCHANT_BANK_auth_free (
struct TALER_MERCHANT_BANK_AuthenticationData *auth);
#endif
/* _TALER_MERCHANT_BANK_LIB_H */
|
