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
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
|
/*
This file is part of GNUnet
Copyright (C) 2014, 2015, 2016, 2020 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
*/
/**
* @file gnunet_json_lib.h
* @brief functions to parse JSON objects into GNUnet objects
* @author Florian Dold
* @author Benedikt Mueller
* @author Christian Grothoff
*/
#ifndef GNUNET_JSON_LIB_H
#define GNUNET_JSON_LIB_H
#include "gnunet_util_lib.h"
#include <jansson.h>
#include <microhttpd.h>
/* ****************** Generic parser interface ******************* */
/**
* @brief Entry in parser specification for #GNUNET_JSON_parse().
*/
struct GNUNET_JSON_Specification;
/**
* Function called to parse JSON argument.
*
* @param cls closure
* @param root JSON to parse
* @param spec our specification entry with further details
* @return #GNUNET_SYSERR on error,
* #GNUNET_OK on success
*/
typedef enum GNUNET_GenericReturnValue
(*GNUNET_JSON_Parser)(void *cls,
json_t *root,
struct GNUNET_JSON_Specification *spec);
/**
* Function called to clean up data from earlier parsing.
*
* @param cls closure
* @param spec our specification entry with data to clean.
*/
typedef void
(*GNUNET_JSON_Cleaner) (void *cls,
struct GNUNET_JSON_Specification *spec);
/**
* @brief Entry in parser specification for #GNUNET_JSON_parse().
*/
struct GNUNET_JSON_Specification
{
/**
* Function for how to parse this type of entry.
*/
GNUNET_JSON_Parser parser;
/**
* Function for how to clean up this type of entry.
*/
GNUNET_JSON_Cleaner cleaner;
/**
* Closure for @e parser and @e cleaner.
*/
void *cls;
/**
* Name of the field to parse, use NULL to get the JSON
* of the main object instead of the JSON of an individual field.
*/
const char *field;
/**
* Pointer, details specific to the @e parser.
*/
void *ptr;
/**
* Pointer to set to true if this argument is
* indeed missing. Can be NULL.
*/
bool *missing;
/**
* Where should we store the final size of @e ptr.
*/
size_t *size_ptr;
/**
* Number of bytes available in @e ptr.
*/
size_t ptr_size;
/**
* Set to true if this component is optional.
*/
bool is_optional;
};
/**
* Navigate and parse data in a JSON tree. Tries to parse the @a root
* to find all of the values given in the @a spec. If one of the
* entries in @a spec cannot be found or parsed, the name of the JSON
* field is returned in @a error_json_name, and the offset of the
* entry in @a spec is returned in @a error_line.
*
* @param root the JSON node to start the navigation at.
* @param spec parse specification array
* @param[out] error_json_name which JSON field was problematic
* @param[out] error_line which index into @a spec did we encounter an error
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
enum GNUNET_GenericReturnValue
GNUNET_JSON_parse (const json_t *root,
struct GNUNET_JSON_Specification *spec,
const char **error_json_name,
unsigned int *error_line);
/**
* Frees all elements allocated during a #GNUNET_JSON_parse()
* operation. Convenience function to be called if cleaning
* up all heap-allocated data from a #GNUNET_JSON_parse() is
* desired. The function does not have to be called if no data
* was heap-allocated (e.g. only integers, strings and fixed-sized
* data was used), or if the application calls the respective
* code to free the heap (not always #GNUNET_free(), depends
* on the data type!) on the returned heap-allocated data itself.
*
* @param spec specification of the parse operation
*/
void
GNUNET_JSON_parse_free (struct GNUNET_JSON_Specification *spec);
/* ****************** Canonical parser specifications ******************* */
/**
* End of a parser specification.
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_end (void);
/**
* Set the "optional" flag for a parser specification entry.
*
* @param spec specification to modify
* @param[out] missing set to true if the argument is missing, NULL is allowed.
* @return spec copy of @a spec with optional bit set
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_mark_optional (struct GNUNET_JSON_Specification spec,
bool *missing);
/**
* Variable size object (in network byte order, encoded using Crockford
* Base32hex encoding).
*
* @param name name of the JSON field
* @param[out] obj pointer where to write the data, must have @a size bytes
* @param size number of bytes expected in @a obj
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_fixed (const char *name,
void *obj,
size_t size);
/**
* Fixed size object (in network byte order, encoded using Crockford
* Base32hex encoding).
*
* @param name name of the JSON field
* @param obj pointer where to write the data (type of `*obj` will determine size)
*/
#define GNUNET_JSON_spec_fixed_auto(name, obj) \
GNUNET_JSON_spec_fixed (name, obj, sizeof(*obj))
/**
* Variable size object (in network byte order, encoded using base64 encoding).
*
* @param name name of the JSON field
* @param[out] obj pointer where to write the data, must have @a size bytes
* @param size number of bytes expected in @a obj
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_fixed64 (const char *name,
void *obj,
size_t size);
/**
* Fixed size object (in network byte order, encoded using base64 encoding).
*
* @param name name of the JSON field
* @param obj pointer where to write the data (type of `*obj` will determine size)
*/
#define GNUNET_JSON_spec_fixed64_auto(name, obj) \
GNUNET_JSON_spec_fixed (name, obj, sizeof(*obj))
/**
* Variable size object (in network byte order, encoded using
* Crockford Base32hex encoding).
*
* @param name name of the JSON field
* @param[out] obj pointer where to write the data, will be allocated
* @param[out] size where to store the number of bytes allocated for @a obj
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_varsize (const char *name,
void **obj,
size_t *size);
/**
* The expected field stores a string.
*
* @param name name of the JSON field
* @param strptr where to store a pointer to the field
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_string (const char *name,
const char **strptr);
/**
* JSON object or array. Reference counter is
* incremented.
*
* @param name name of the JSON field
* @param[out] jsonp where to store the JSON found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_json (const char *name,
json_t **jsonp);
/**
* JSON object, reference counter not incremented.
*
* @param name name of the JSON field
* @param[out] jsonp where to store the JSON found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_object_const (const char *name,
const json_t **jsonp);
/**
* JSON array, reference counter not incremented.
*
* @param name name of the JSON field
* @param[out] jsonp where to store the JSON found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_array_const (const char *name,
const json_t **jsonp);
/**
* boolean.
*
* @param name name of the JSON field
* @param[out] b where to store the boolean found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_bool (const char *name,
bool *b);
/**
* double.
*
* @param name name of the JSON field
* @param[out] f where to store the double found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_double (const char *name,
double *f);
/**
* 8-bit integer.
*
* @param name name of the JSON field
* @param[out] u8 where to store the integer found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_uint8 (const char *name,
uint8_t *u8);
/**
* 16-bit integer.
*
* @param name name of the JSON field
* @param[out] u16 where to store the integer found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_uint16 (const char *name,
uint16_t *u16);
/**
* 32-bit integer.
*
* @param name name of the JSON field
* @param[out] u32 where to store the integer found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_uint32 (const char *name,
uint32_t *u32);
/**
* 64-bit integer.
*
* @param name name of the JSON field
* @param[out] u64 where to store the integer found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_uint64 (const char *name,
uint64_t *u64);
/**
* 64-bit signed integer.
*
* @param name name of the JSON field
* @param[out] i64 where to store the integer found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_int64 (const char *name,
int64_t *i64);
/**
* Boolean (true mapped to #GNUNET_YES, false mapped to #GNUNET_NO).
*
* @param name name of the JSON field
* @param[out] boolean where to store the boolean found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_boolean (const char *name,
int *boolean);
/* ************ GNUnet-specific parser specifications ******************* */
/**
* Timestamp.
*
* @param name name of the JSON field
* @param[out] t at where to store the absolute time found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_timestamp (const char *name,
struct GNUNET_TIME_Timestamp *t);
/**
* Timestamp in network byte order.
*
* @param name name of the JSON field
* @param[out] tn where to store the absolute time found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_timestamp_nbo (const char *name,
struct GNUNET_TIME_TimestampNBO *tn);
/**
* Relative time.
*
* @param name name of the JSON field
* @param[out] rt where to store the relative time found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_relative_time (const char *name,
struct GNUNET_TIME_Relative *rt);
/**
* Specification for parsing an RSA public key.
*
* @param name name of the JSON field
* @param pk where to store the RSA key found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_rsa_public_key (const char *name,
struct GNUNET_CRYPTO_RsaPublicKey **pk);
/**
* Specification for parsing an RSA signature.
*
* @param name name of the JSON field
* @param sig where to store the RSA signature found under @a name
*/
struct GNUNET_JSON_Specification
GNUNET_JSON_spec_rsa_signature (const char *name,
struct GNUNET_CRYPTO_RsaSignature **sig);
/* ****************** Generic generator interface ******************* */
/**
* Convert binary data to a JSON string with the base32crockford
* encoding.
*
* @param data binary data
* @param size size of @a data in bytes
* @return json string that encodes @a data
*/
json_t *
GNUNET_JSON_from_data (const void *data,
size_t size);
/**
* Convert binary data to a JSON string with base64
* encoding.
*
* @param data binary data
* @param size size of @a data in bytes
* @return json string that encodes @a data
*/
json_t *
GNUNET_JSON_from_data64 (const void *data,
size_t size);
/**
* Convert binary data to a JSON string with the base32crockford
* encoding.
*
* @param ptr binary data, sizeof (*ptr) must yield correct size
* @return json string that encodes @a data
*/
#define GNUNET_JSON_from_data_auto(ptr) \
GNUNET_JSON_from_data (ptr, sizeof(*ptr))
/**
* Convert binary data to a JSON string with base64
* encoding.
*
* @param ptr binary data, sizeof (*ptr) must yield correct size
* @return json string that encodes @a data
*/
#define GNUNET_JSON_from_data64_auto(ptr) \
GNUNET_JSON_from_data64 (ptr, sizeof(*ptr))
/**
* Convert timestamp to a json string.
*
* @param stamp the time stamp
* @return a json string with the timestamp in @a stamp
*/
json_t *
GNUNET_JSON_from_timestamp (struct GNUNET_TIME_Timestamp stamp);
/**
* Convert timestamp to a json string.
*
* @param stamp the time stamp
* @return a json string with the timestamp in @a stamp
*/
json_t *
GNUNET_JSON_from_timestamp_nbo (struct GNUNET_TIME_TimestampNBO stamp);
/**
* Convert relative timestamp to a json string.
*
* @param stamp the time stamp
* @return a json string with the timestamp in @a stamp
*/
json_t *
GNUNET_JSON_from_time_rel (struct GNUNET_TIME_Relative stamp);
/**
* Convert RSA public key to JSON.
*
* @param pk public key to convert
* @return corresponding JSON encoding
*/
json_t *
GNUNET_JSON_from_rsa_public_key (const struct GNUNET_CRYPTO_RsaPublicKey *pk);
/**
* Convert RSA signature to JSON.
*
* @param sig signature to convert
* @return corresponding JSON encoding
*/
json_t *
GNUNET_JSON_from_rsa_signature (const struct GNUNET_CRYPTO_RsaSignature *sig);
/* ******************* Helpers for MHD upload handling ******************* */
/**
* Return codes from #GNUNET_JSON_post_parser().
*/
enum GNUNET_JSON_PostResult
{
/**
* Parsing successful, JSON result is in `*json`.
*/
GNUNET_JSON_PR_SUCCESS,
/**
* Parsing continues, call again soon!
*/
GNUNET_JSON_PR_CONTINUE,
/**
* Sorry, memory allocation (malloc()) failed.
*/
GNUNET_JSON_PR_OUT_OF_MEMORY,
/**
* Request size exceeded `buffer_max` argument.
*/
GNUNET_JSON_PR_REQUEST_TOO_LARGE,
/**
* JSON parsing failed. This was not a JSON upload.
*/
GNUNET_JSON_PR_JSON_INVALID
};
/**
* 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 @a con_cls, which must be cleaned up using
* #GNUNET_JSON_post_parser_callback().
*
* @param buffer_max maximum allowed size for the buffer
* @param connection MHD connection handle (for meta data about the upload)
* @param con_cls the closure (will point 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 result code indicating the status of the operation
*/
enum GNUNET_JSON_PostResult
GNUNET_JSON_post_parser (size_t buffer_max,
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
* #GNUNET_JSON_post_parser(), to be cleaned up
*/
void
GNUNET_JSON_post_parser_cleanup (void *con_cls);
/* ****************** GETOPT JSON helper ******************* */
/**
* Allow user to specify a JSON input value.
*
* @param shortName short name of the option
* @param name long name of the option
* @param argumentHelp help text for the option argument
* @param description long help text for the option
* @param[out] val set to the JSON specified at the command line
*/
struct GNUNET_GETOPT_CommandLineOption
GNUNET_JSON_getopt (char shortName,
const char *name,
const char *argumentHelp,
const char *description,
json_t **json);
/* ****************** JSON PACK helper ******************* */
/**
* Element in the array to give to the packer.
*/
struct GNUNET_JSON_PackSpec;
/**
* Function called to pack an element into the JSON
* object as part of #GNUNET_JSON_pack_().
*
* @param se pack specification to execute
* @return json object to pack, NULL to pack nothing
*/
typedef json_t *
(*GNUNET_JSON_PackCallback)(const struct GNUNET_JSON_PackSpec *se);
/**
* Element in the array to give to the packer.
*/
struct GNUNET_JSON_PackSpec
{
/**
* Name of the field to pack.
*/
const char *field_name;
/**
* Object to pack.
*/
json_t *object;
/**
* True if a NULL (or 0) argument is allowed. In this
* case, if the argument is NULL the @e packer should
* return NULL and the field should be skipped (omitted from
* the generated object) and not be serialized at all.
*/
bool allow_null;
};
/**
* Pack a JSON object from a @a spec. Aborts if
* packing fails.
*
* @param spec specification object
* @return JSON object
*/
json_t *
GNUNET_JSON_pack_ (struct GNUNET_JSON_PackSpec spec[]);
/**
* Pack a JSON object from a @a spec. Aborts if
* packing fails.
*
* @param ... list of specification objects
* @return JSON object
*/
#define GNUNET_JSON_PACK(...) \
GNUNET_JSON_pack_ ((struct GNUNET_JSON_PackSpec[]) {__VA_ARGS__, \
GNUNET_JSON_pack_end_ ()})
/**
* Do not use directly. Use #GNUNET_JSON_PACK.
*
* @return array terminator
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_end_ (void);
/**
* Modify packer instruction to allow NULL as a value.
*
* @param in json pack specification to modify
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_allow_null (struct GNUNET_JSON_PackSpec in);
/**
* Generate packer instruction for a JSON field of type
* bool.
*
* @param name name of the field to add to the object
* @param b boolean value
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_bool (const char *name,
bool b);
/**
* Generate packer instruction for a JSON field of type
* double.
*
* @param name name of the field to add to the object
* @param f double value
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_double (const char *name,
double f);
/**
* Generate packer instruction for a JSON field of type
* string.
*
* @param name name of the field to add to the object
* @param s string value
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_string (const char *name,
const char *s);
/**
* Generate packer instruction for a JSON field of type
* unsigned integer. Note that the maximum allowed
* value is still limited by JSON and not UINT64_MAX.
*
* @param name name of the field to add to the object
* @param num numeric value
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_uint64 (const char *name,
uint64_t num);
/**
* Generate packer instruction for a JSON field of type
* signed integer.
*
* @param name name of the field to add to the object
* @param num numeric value
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_int64 (const char *name,
int64_t num);
/**
* Generate packer instruction for a JSON field of type
* JSON object where the reference is taken over by
* the packer.
*
* @param name name of the field to add to the object
* @param o object to steal
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_object_steal (const char *name,
json_t *o);
/**
* Generate packer instruction for a JSON field of type JSON object where the
* reference counter is incremented by the packer. Note that a deep copy is
* not performed.
*
* @param name name of the field to add to the object
* @param o object to increment reference counter of
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_object_incref (const char *name,
json_t *o);
/**
* Generate packer instruction for a JSON field of type
* JSON array where the reference is taken over by
* the packer.
*
* @param name name of the field to add to the object
* @param a array to steal
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_array_steal (const char *name,
json_t *a);
/**
* Generate packer instruction for a JSON field of type JSON array where the
* reference counter is incremented by the packer. Note that a deep copy is
* not performed.
*
* @param name name of the field to add to the object
* @param a array to increment reference counter of
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_array_incref (const char *name,
json_t *a);
/**
* Generate packer instruction for a JSON field of type
* variable size binary blob.
*
* @param name name of the field to add to the object
* @param blob binary data to pack
* @param blob_size number of bytes in @a blob
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_data_varsize (const char *name,
const void *blob,
size_t blob_size);
/**
* Generate packer instruction for a JSON field where the
* size is automatically determined from the argument.
*
* @param name name of the field to add to the object
* @param blob data to pack, must not be an array
* @return json pack specification
*/
#define GNUNET_JSON_pack_data_auto(name,blob) \
GNUNET_JSON_pack_data_varsize (name, blob, sizeof (*blob))
/**
* Generate packer instruction for a JSON field of type
* variable size binary blob.
* Use base64-encoding, instead of the more common
* Crockford base32-encoding.
*
* @param name name of the field to add to the object
* @param blob binary data to pack
* @param blob_size number of bytes in @a blob
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_data64_varsize (const char *name,
const void *blob,
size_t blob_size);
/**
* Generate packer instruction for a JSON field where the
* size is automatically determined from the argument.
* Use base64-encoding, instead of the more common
* Crockford base32-encoding.
*
* @param name name of the field to add to the object
* @param blob data to pack, must not be an array
* @return json pack specification
*/
#define GNUNET_JSON_pack_data64_auto(name,blob) \
GNUNET_JSON_pack_data64_varsize (name, blob, sizeof (*blob))
/**
* Generate packer instruction for a JSON field of type
* timestamp.
*
* @param name name of the field to add to the object
* @param at timestamp pack, a value of 0 is only
* allowed with #GNUNET_JSON_pack_allow_null()!
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_timestamp (const char *name,
struct GNUNET_TIME_Timestamp at);
/**
* Generate packer instruction for a JSON field of type
* timestamp in network byte order.
*
* @param name name of the field to add to the object
* @param at timestamp to pack, a value of 0 is only
* allowed with #GNUNET_JSON_pack_allow_null()!
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_timestamp_nbo (const char *name,
struct GNUNET_TIME_TimestampNBO at);
/**
* Generate packer instruction for a JSON field of type
* relative time.
*
* @param name name of the field to add to the object
* @param rt relative time to pack
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_time_rel (const char *name,
struct GNUNET_TIME_Relative rt);
/**
* Generate packer instruction for a JSON field of type
* relative time in network byte order.
*
* @param name name of the field to add to the object
* @param rt relative time to pack
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_time_rel_nbo (const char *name,
struct GNUNET_TIME_RelativeNBO rt);
/**
* Generate packer instruction for a JSON field of type
* RSA public key.
*
* @param name name of the field to add to the object
* @param pk RSA public key
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_rsa_public_key (const char *name,
const struct GNUNET_CRYPTO_RsaPublicKey *pk);
/**
* Generate packer instruction for a JSON field of type
* RSA signature.
*
* @param name name of the field to add to the object
* @param sig RSA signature
* @return json pack specification
*/
struct GNUNET_JSON_PackSpec
GNUNET_JSON_pack_rsa_signature (const char *name,
const struct GNUNET_CRYPTO_RsaSignature *sig);
#endif
/* end of gnunet_json_lib.h */
|