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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
|
/*
This file is part of TALER
Copyright (C) 2014-2020 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 taler_mhd_lib.h
* @brief API for generating MHD replies
* @author Florian Dold
* @author Benedikt Mueller
* @author Christian Grothoff
*/
#ifndef TALER_MHD_LIB_H
#define TALER_MHD_LIB_H
#include <gnunet/gnunet_util_lib.h>
#include <gnunet/gnunet_json_lib.h>
#include <jansson.h>
#include <microhttpd.h>
#include "taler_error_codes.h"
#include <gnunet/gnunet_mhd_compat.h>
/**
* Maximum POST request size.
*/
#define TALER_MHD_REQUEST_BUFFER_MAX (1024 * 1024 * 16)
/**
* Global options for response generation.
*/
enum TALER_MHD_GlobalOptions
{
/**
* Use defaults.
*/
TALER_MHD_GO_NONE = 0,
/**
* Add "Connection: Close" header.
*/
TALER_MHD_GO_FORCE_CONNECTION_CLOSE = 1,
/**
* Disable use of compression, even if the client
* supports it.
*/
TALER_MHD_GO_DISABLE_COMPRESSION = 2
};
/**
* Set global options for response generation within libtalermhd.
*
* @param go global options to use
*/
void
TALER_MHD_setup (enum TALER_MHD_GlobalOptions go);
/**
* Add headers we want to return in every response. Useful for testing, like
* if we want to always close connections.
*
* @param response response to modify
*/
void
TALER_MHD_add_global_headers (struct MHD_Response *response);
/**
* Try to compress a response body. Updates @a buf and @a buf_size.
*
* @param[in,out] buf pointer to body to compress
* @param[in,out] buf_size pointer to initial size of @a buf
* @return #MHD_YES if @a buf was compressed
*/
MHD_RESULT
TALER_MHD_body_compress (void **buf,
size_t *buf_size);
/**
* Is HTTP body deflate compression supported by the client?
*
* @param connection connection to check
* @return #MHD_YES if 'deflate' compression is allowed
*/
MHD_RESULT
TALER_MHD_can_compress (struct MHD_Connection *connection);
/**
* Check if @a mime matches the @a accept_pattern. For this function, the @a
* accept_pattern may include multiple values separated by ";".
*
* @param accept_pattern a mime pattern like "text/plain"
* or "image/STAR" or "text/plain; text/xml"
* @param mime the mime type to match
* @return true if @a mime matches the @a accept_pattern
*/
bool
TALER_MHD_xmime_matches (const char *accept_pattern,
const char *mime);
/**
* Send JSON object as response.
*
* @param connection the MHD connection
* @param json the json object
* @param response_code the http response code
* @return MHD result code
*/
MHD_RESULT
TALER_MHD_reply_json (struct MHD_Connection *connection,
const json_t *json,
unsigned int response_code);
/**
* Send JSON object as response, and free the @a json
* object.
*
* @param connection the MHD connection
* @param json the json object (freed!)
* @param response_code the http response code
* @return MHD result code
*/
MHD_RESULT
TALER_MHD_reply_json_steal (struct MHD_Connection *connection,
json_t *json,
unsigned int response_code);
/**
* Function to call to handle the request by building a JSON
* reply from a format string and varargs.
*
* @param connection the MHD connection to handle
* @param response_code HTTP response code to use
* @param fmt format string for pack
* @param ... varargs
* @return MHD result code
*/
MHD_RESULT
TALER_MHD_reply_json_pack (struct MHD_Connection *connection,
unsigned int response_code,
const char *fmt,
...);
/**
* Function to call to handle the request by building a JSON
* reply from varargs.
*
* @param connection the MHD connection to handle
* @param response_code HTTP response code to use
* @param ... varargs of JSON pack specification
* @return MHD result code
*/
#define TALER_MHD_REPLY_JSON_PACK(connection,response_code,...) \
TALER_MHD_reply_json_steal (connection, GNUNET_JSON_PACK (__VA_ARGS__), \
response_code)
/**
* Send a response indicating an error.
*
* @param connection the MHD connection to use
* @param ec error code uniquely identifying the error
* @param http_status HTTP status code to use
* @param detail additional optional detail about the error
* @return a MHD result code
*/
MHD_RESULT
TALER_MHD_reply_with_error (struct MHD_Connection *connection,
unsigned int http_status,
enum TALER_ErrorCode ec,
const char *detail);
/**
* Send a response indicating an error. The HTTP status code is
* to be derived from the @a ec.
*
* @param connection the MHD connection to use
* @param ec error code uniquely identifying the error
* @param detail additional optional detail about the error
* @return a MHD result code
*/
MHD_RESULT
TALER_MHD_reply_with_ec (struct MHD_Connection *connection,
enum TALER_ErrorCode ec,
const char *detail);
/**
* Make JSON response object.
*
* @param json the json object
* @return MHD response object
*/
struct MHD_Response *
TALER_MHD_make_json (const json_t *json);
/**
* Make JSON response object and free @a json.
*
* @param json the json object, freed.
* @return MHD response object
*/
struct MHD_Response *
TALER_MHD_make_json_steal (json_t *json);
/**
* Make JSON response object.
*
* @param fmt format string for pack
* @param ... varargs
* @return MHD response object
*/
struct MHD_Response *
TALER_MHD_make_json_pack (const char *fmt,
...);
/**
* Make JSON response object.
*
* @param ... varargs
* @return MHD response object
*/
#define TALER_MHD_MAKE_JSON_PACK(...) \
TALER_MHD_make_json_steal (GNUNET_JSON_PACK (__VA_ARGS__))
/**
* Pack Taler error code @a ec and associated hint into a
* JSON object.
*
* @param ec error code to pack
* @return packer array entries (two!)
*/
#define TALER_MHD_PACK_EC(ec) \
GNUNET_JSON_pack_uint64 ("code", ec), \
GNUNET_JSON_pack_string ("hint", TALER_ErrorCode_get_hint (ec))
/**
* Create a response indicating an internal error.
*
* @param ec error code to return
* @param detail additional optional detail about the error, can be NULL
* @return a MHD response object
*/
struct MHD_Response *
TALER_MHD_make_error (enum TALER_ErrorCode ec,
const char *detail);
/**
* Send a response indicating that the request was too big.
*
* @param connection the MHD connection to use
* @return a MHD result code
*/
MHD_RESULT
TALER_MHD_reply_request_too_large (struct MHD_Connection *connection);
/**
* Function to call to handle the request by sending
* back a redirect to the AGPL source code.
*
* @param connection the MHD connection to handle
* @param url where to redirect for the sources
* @return MHD result code
*/
MHD_RESULT
TALER_MHD_reply_agpl (struct MHD_Connection *connection,
const char *url);
/**
* Function to call to handle the request by sending
* back static data.
*
* @param connection the MHD connection to handle
* @param http_status status code to return
* @param mime_type content-type to use
* @param body response payload
* @param body_size number of bytes in @a body
* @return MHD result code
*/
MHD_RESULT
TALER_MHD_reply_static (struct MHD_Connection *connection,
unsigned int http_status,
const char *mime_type,
const char *body,
size_t body_size);
/**
* Process a POST request containing a JSON object. This
* function realizes an MHD POST processor that will
* (incrementally) process JSON data uploaded to the HTTP
* server. It will store the required state in the
* "connection_cls", which must be cleaned up using
* #TALER_MHD_parse_post_cleanup_callback().
*
* @param connection the MHD connection
* @param con_cls the closure (points to a `struct Buffer *`)
* @param upload_data the POST data
* @param upload_data_size number of bytes in @a upload_data
* @param json the JSON object for a completed request
* @return
* #GNUNET_YES if json object was parsed or at least
* may be parsed in the future (call again);
* `*json` will be NULL if we need to be called again,
* and non-NULL if we are done.
* #GNUNET_NO is request incomplete or invalid
* (error message was generated)
* #GNUNET_SYSERR on internal error
* (we could not even queue an error message,
* close HTTP session with MHD_NO)
*/
enum GNUNET_GenericReturnValue
TALER_MHD_parse_post_json (struct MHD_Connection *connection,
void **con_cls,
const char *upload_data,
size_t *upload_data_size,
json_t **json);
/**
* Function called whenever we are done with a request
* to clean up our state.
*
* @param con_cls value as it was left by
* #TALER_MHD_parse_post_json(), to be cleaned up
*/
void
TALER_MHD_parse_post_cleanup_callback (void *con_cls);
/**
* Parse JSON object into components based on the given field
* specification. If parsing fails, we return an HTTP
* status code of 400 (#MHD_HTTP_BAD_REQUEST).
*
* @param connection the connection to send an error response to
* @param root the JSON node to start the navigation at.
* @param spec field specification for the parser
* @return
* #GNUNET_YES if navigation was successful (caller is responsible
* for freeing allocated variable-size data using
* GNUNET_JSON_parse_free() when done)
* #GNUNET_NO if json is malformed, error response was generated
* #GNUNET_SYSERR on internal error
*/
enum GNUNET_GenericReturnValue
TALER_MHD_parse_json_data (struct MHD_Connection *connection,
const json_t *root,
struct GNUNET_JSON_Specification *spec);
/**
* Parse JSON object that we (the server!) generated into components based on
* the given field specification. The difference to
* #TALER_MHD_parse_json_data() is that this function will fail
* with an HTTP failure of 500 (internal server error) in case
* parsing fails, instead of blaming it on the client with a
* 400 (#MHD_HTTP_BAD_REQUEST).
*
* @param connection the connection to send an error response to
* @param root the JSON node to start the navigation at.
* @param spec field specification for the parser
* @return
* #GNUNET_YES if navigation was successful (caller is responsible
* for freeing allocated variable-size data using
* GNUNET_JSON_parse_free() when done)
* #GNUNET_NO if json is malformed, error response was generated
* #GNUNET_SYSERR on internal error
*/
enum GNUNET_GenericReturnValue
TALER_MHD_parse_internal_json_data (struct MHD_Connection *connection,
const json_t *root,
struct GNUNET_JSON_Specification *spec);
/**
* Parse JSON array into components based on the given field
* specification. Generates error response on parse errors.
*
* @param connection the connection to send an error response to
* @param root the JSON node to start the navigation at.
* @param[in,out] spec field specification for the parser
* @param ... -1-terminated list of array offsets of type 'int'
* @return
* #GNUNET_YES if navigation was successful (caller is responsible
* for freeing allocated variable-size data using
* GNUNET_JSON_parse_free() when done)
* #GNUNET_NO if json is malformed, error response was generated
* #GNUNET_SYSERR on internal error
*/
enum GNUNET_GenericReturnValue
TALER_MHD_parse_json_array (struct MHD_Connection *connection,
const json_t *root,
struct GNUNET_JSON_Specification *spec,
...);
/**
* Extract fixed-size base32crockford encoded data from request.
*
* Queues an error response to the connection if the parameter is missing or
* invalid.
*
* @param connection the MHD connection
* @param param_name the name of the parameter with the key
* @param[out] out_data pointer to store the result
* @param out_size expected size of @a out_data
* @return
* #GNUNET_YES if the the argument is present
* #GNUNET_NO if the argument is absent or malformed
* #GNUNET_SYSERR on internal error (error response could not be sent)
*/
enum GNUNET_GenericReturnValue
TALER_MHD_parse_request_arg_data (struct MHD_Connection *connection,
const char *param_name,
void *out_data,
size_t out_size);
/**
* Parse the configuration to determine on which port
* or UNIX domain path we should run an HTTP service.
*
* @param cfg configuration to parse
* @param section section of the configuration to parse (usually "exchange")
* @param[out] rport set to the port number, or 0 for none
* @param[out] unix_path set to the UNIX path, or NULL for none
* @param[out] unix_mode set to the mode to be used for @a unix_path
* @return #GNUNET_OK on success
*/
enum GNUNET_GenericReturnValue
TALER_MHD_parse_config (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
uint16_t *rport,
char **unix_path,
mode_t *unix_mode);
/**
* Function called for logging by MHD.
*
* @param cls closure, NULL
* @param fm format string (`printf()`-style)
* @param ap arguments to @a fm
*/
void
TALER_MHD_handle_logs (void *cls,
const char *fm,
va_list ap);
/**
* Open UNIX domain socket for listining at @a unix_path with
* permissions @a unix_mode.
*
* @param unix_path where to listen
* @param unix_mode access permissions to set
* @return -1 on error, otherwise the listen socket
*/
int
TALER_MHD_open_unix_path (const char *unix_path,
mode_t unix_mode);
/**
* Bind a listen socket to the UNIX domain path or the TCP port and IP address
* as specified in @a cfg in section @a section. IF only a port was
* specified, set @a port and return -1. Otherwise, return the bound file
* descriptor.
*
* @param cfg configuration to parse
* @param section configuration section to use
* @param[out] port port to set, if TCP without BINDTO
* @return -1 and a port of zero on error, otherwise
* either -1 and a port, or a bound stream socket
*/
int
TALER_MHD_bind (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
uint16_t *port);
/**
* Start to run an event loop for @a daemon.
* Only one daemon can be running per process
* using this API.
*
* @param daemon the MHD service to run
*/
void
TALER_MHD_daemon_start (struct MHD_Daemon *daemon);
/**
* Stop running the event loop for MHD.
*
* @return the daemon that we were previously running,
* or NULL if none was active
*/
struct MHD_Daemon *
TALER_MHD_daemon_stop (void);
/**
* Trigger MHD daemon that is running. Needed when
* a connection was resumed.
*/
void
TALER_MHD_daemon_trigger (void);
/**
* Prepared responses for legal documents
* (terms of service, privacy policy).
*/
struct TALER_MHD_Legal;
/**
* Load set of legal documents as specified in @a cfg in section @a section
* where the Etag is given under the @a tagoption and the directory under
* the @a diroption.
*
* @param cfg configuration to use
* @param section section to load values from
* @param diroption name of the option with the
* path to the legal documents
* @param tagoption name of the files to use
* for the legal documents and the Etag
* @return NULL on error
*/
struct TALER_MHD_Legal *
TALER_MHD_legal_load (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *diroption,
const char *tagoption);
/**
* Free set of legal documents
*
* @param legal legal documents to free
*/
void
TALER_MHD_legal_free (struct TALER_MHD_Legal *legal);
/**
* Generate a response with a legal document in
* the format and language of the user's choosing.
*
* @param conn HTTP connection to handle
* @param legal legal document to serve
* @return MHD result code
*/
MHD_RESULT
TALER_MHD_reply_legal (struct MHD_Connection *conn,
struct TALER_MHD_Legal *legal);
/**
* Send back a "204 No Content" response with headers
* for the CORS pre-flight request.
*
* @param connection the MHD connection
* @return MHD result code
*/
MHD_RESULT
TALER_MHD_reply_cors_preflight (struct MHD_Connection *connection);
#endif
|