forked from litecoin-foundation/loafwallet-core
-
Notifications
You must be signed in to change notification settings - Fork 2
/
BRPaymentProtocol.c
1427 lines (1174 loc) · 56.4 KB
/
BRPaymentProtocol.c
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
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// BRPaymentProtocol.c
//
// Created by Aaron Voisine on 9/7/15.
// Copyright (c) 2015 breadwallet LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#include "BRPaymentProtocol.h"
#include "BRCrypto.h"
#include "BRArray.h"
#include <string.h>
#include <inttypes.h>
#include <stdio.h>
// BIP70 payment protocol: https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki
// BIP75 payment protocol encryption: https://github.com/bitcoin/bips/blob/master/bip-0075.mediawiki
#define PROTOBUF_VARINT 0 // int32, int64, uint32, uint64, sint32, sint64, bool, enum
#define PROTOBUF_64BIT 1 // fixed64, sfixed64, double
#define PROTOBUF_LENDELIM 2 // string, bytes, embedded messages, packed repeated fields
#define PROTOBUF_32BIT 5 // fixed32, sfixed32, float
typedef struct {
uint8_t *defaults;
uint8_t *unknown;
} ProtoBufContext;
static uint64_t _ProtoBufVarInt(const uint8_t *buf, size_t bufLen, size_t *off)
{
uint64_t varInt = 0;
uint8_t b = 0x80;
size_t i = 0;
while ((b & 0x80) && buf && *off < bufLen) {
b = buf[(*off)++];
varInt += (uint64_t)(b & 0x7f) << 7*i++;
}
return (b & 0x80) ? 0 : varInt;
}
static void _ProtoBufSetVarInt(uint8_t *buf, size_t bufLen, uint64_t i, size_t *off)
{
uint8_t b;
do {
b = i & 0x7f;
i >>= 7;
if (i > 0) b |= 0x80;
if (buf && *off + 1 <= bufLen) buf[*off] = b;
(*off)++;
} while (i > 0);
}
static const uint8_t *_ProtoBufLenDelim(const uint8_t *buf, size_t *len, size_t *off)
{
const uint8_t *data = NULL;
size_t dataLen = (size_t)_ProtoBufVarInt(buf, *len, off);
if (buf && *off + dataLen <= *len) data = &buf[*off];
*off += dataLen;
*len = dataLen;
return data;
}
static void _ProtoBufSetLenDelim(uint8_t *buf, size_t bufLen, const void *data, size_t dataLen, size_t *off)
{
if (data || dataLen == 0) {
_ProtoBufSetVarInt(buf, bufLen, dataLen, off);
if (buf && *off + dataLen <= bufLen) memcpy(&buf[*off], data, dataLen);
*off += dataLen;
}
}
// the following fixed int functions are not used by payment protocol, and only work for parsing/serializing unknown
// fields - the values returned or set are unconverted raw byte values
static uint64_t _ProtoBufFixed(const uint8_t *buf, size_t bufLen, size_t *off, size_t size)
{
uint64_t i = 0;
if (buf && *off + size <= bufLen && size <= sizeof(i)) memcpy(&i, &buf[*off], size);
*off += size;
return i;
}
static void _ProtoBufSetFixed(uint8_t *buf, size_t bufLen, uint64_t i, size_t *off, size_t size)
{
if (buf && *off + size <= bufLen && size <= sizeof(i)) memcpy(&buf[*off], &i, size);
*off += size;
}
// sets either i or data depending on field type, and returns field key
static uint64_t _ProtoBufField(uint64_t *i, const uint8_t **data, const uint8_t *buf, size_t *len, size_t *off)
{
uint64_t varInt = 0, fixedInt = 0, key = _ProtoBufVarInt(buf, *len, off);
const uint8_t *lenDelim = NULL;
switch (key & 0x07) {
case PROTOBUF_VARINT: varInt = _ProtoBufVarInt(buf, *len, off); if (i) *i = varInt; break;
case PROTOBUF_64BIT: fixedInt = _ProtoBufFixed(buf, *len, off, sizeof(uint64_t)); if (i) *i = fixedInt; break;
case PROTOBUF_LENDELIM: lenDelim = _ProtoBufLenDelim(buf, len, off); if (data) *data = lenDelim; break;
case PROTOBUF_32BIT: fixedInt = _ProtoBufFixed(buf, *len, off, sizeof(uint32_t)); if (i) *i = fixedInt; break;
default: break;
}
return key;
}
static void _ProtoBufString(char **str, const void *data, size_t dataLen)
{
if (data || dataLen == 0) {
if (! *str) array_new(*str, dataLen + 1);
array_clear(*str);
array_add_array(*str, (const char *)data, dataLen);
array_add(*str, '\0');
}
}
static void _ProtoBufSetString(uint8_t *buf, size_t bufLen, const char *str, uint64_t key, size_t *off)
{
size_t strLen = (str) ? strlen(str) : 0;
_ProtoBufSetVarInt(buf, bufLen, (key << 3) | PROTOBUF_LENDELIM, off);
_ProtoBufSetLenDelim(buf, bufLen, str, strLen, off);
}
static size_t _ProtoBufBytes(uint8_t **bytes, const void *data, size_t dataLen)
{
if (data || dataLen == 0) {
if (! *bytes) array_new(*bytes, dataLen);
array_clear(*bytes);
array_add_array(*bytes, (const uint8_t *)data, dataLen);
}
return (*bytes) ? array_count(*bytes) : 0;
}
static void _ProtoBufSetBytes(uint8_t *buf, size_t bufLen, const uint8_t *bytes, size_t bytesLen, uint64_t key,
size_t *off)
{
_ProtoBufSetVarInt(buf, bufLen, (key << 3) | PROTOBUF_LENDELIM, off);
_ProtoBufSetLenDelim(buf, bufLen, bytes, bytesLen, off);
}
static void _ProtoBufSetInt(uint8_t *buf, size_t bufLen, uint64_t i, uint64_t key, size_t *off)
{
_ProtoBufSetVarInt(buf, bufLen, (key << 3) | PROTOBUF_VARINT, off);
_ProtoBufSetVarInt(buf, bufLen, i, off);
}
static void _ProtoBufUnknown(uint8_t **unknown, uint64_t key, uint64_t i, const void *data, size_t dataLen)
{
size_t bufLen = 10 + ((key & 0x07) == PROTOBUF_LENDELIM ? dataLen : 0);
uint8_t _buf[(bufLen <= 0x1000) ? bufLen : 0], *buf = (bufLen <= 0x1000) ? _buf : malloc(bufLen);
size_t off = 0, o = 0, l;
uint64_t k;
assert(buf != NULL);
_ProtoBufSetVarInt(buf, bufLen, key, &off);
switch (key & 0x07) {
case PROTOBUF_VARINT: _ProtoBufSetVarInt(buf, bufLen, i, &off); break;
case PROTOBUF_64BIT: _ProtoBufSetFixed(buf, bufLen, i, &off, sizeof(uint64_t)); break;
case PROTOBUF_LENDELIM: _ProtoBufSetLenDelim(buf, bufLen, data, dataLen, &off); break;
case PROTOBUF_32BIT: _ProtoBufSetFixed(buf, bufLen, i, &off, sizeof(uint32_t)); break;
default: break;
}
if (off < bufLen) bufLen = off;
if (! *unknown) array_new(*unknown, bufLen);
off = 0;
while (off < array_count(*unknown)) {
l = array_count(*unknown);
o = off;
k = _ProtoBufField(NULL, NULL, *unknown, &l, &off);
if (k == key) array_rm_range(*unknown, o, off - o);
if (k >= key) break;
}
array_insert_array(*unknown, o, buf, bufLen);
if (buf != _buf) free(buf);
}
typedef enum {
output_amount = 1,
output_script = 2
} output_key;
typedef enum {
details_network = 1,
details_outputs = 2,
details_time = 3,
details_expires = 4,
details_memo = 5,
details_payment_url = 6,
details_merch_data = 7
} details_key;
typedef enum {
request_version = 1,
request_pki_type = 2,
request_pki_data = 3,
request_details = 4,
request_signature = 5
} request_key;
typedef enum {
certificates_cert = 1
} certificates_key;
typedef enum {
payment_merch_data = 1,
payment_transactions = 2,
payment_refund_to = 3,
payment_memo = 4
} payment_key;
typedef enum {
ack_payment = 1,
ack_memo = 2
} ack_key;
typedef enum {
invoice_req_sender_pk = 1,
invoice_req_amount = 2,
invoice_req_pki_type = 3,
invoice_req_pki_data = 4,
invoice_req_memo = 5,
invoice_req_notify_url = 6,
invoice_req_signature = 7
} invoice_req_key;
typedef enum {
message_msg_type = 1,
message_message = 2,
message_status_code = 3,
message_status_msg = 4,
message_identifier = 5
} message_key;
typedef enum {
encrypted_msg_msg_type = 1,
encrypted_msg_message = 2,
encrypted_msg_receiver_pk = 3,
encrypted_msg_sender_pk = 4,
encrypted_msg_nonce = 5,
encrypted_msg_signature = 6,
encrypted_msg_identifier = 7,
encrypted_msg_status_code = 8,
encrypted_msg_status_msg = 9
} encrypted_msg_key;
static BRTxOutput _BRPaymentProtocolOutput(uint64_t amount, uint8_t *script, size_t scriptLen)
{
BRTxOutput out = BR_TX_OUTPUT_NONE;
ProtoBufContext ctx = { NULL, NULL };
assert(script != NULL || scriptLen == 0);
array_new(ctx.defaults, output_script + 1);
array_set_count(ctx.defaults, output_script + 1);
out.amount = amount;
BRTxOutputSetScript(&out, script, scriptLen);
if (! out.script) array_new(out.script, sizeof(ctx));
array_add_array(out.script, (uint8_t *)&ctx, sizeof(ctx)); // store context at end of script data
return out;
}
static BRTxOutput _BRPaymentProtocolOutputParse(const uint8_t *buf, size_t bufLen)
{
BRTxOutput out = BR_TX_OUTPUT_NONE;
ProtoBufContext ctx = { NULL, NULL };
size_t off = 0;
array_new(ctx.defaults, output_script + 1);
array_set_count(ctx.defaults, output_script + 1);
out.amount = 0;
ctx.defaults[output_amount] = 1;
while (off < bufLen) {
const uint8_t *data = NULL;
size_t dataLen = bufLen;
uint64_t i = 0, key = _ProtoBufField(&i, &data, buf, &dataLen, &off);
switch (key >> 3) {
case output_amount: out.amount = i, ctx.defaults[output_amount] = 0; break;
case output_script: BRTxOutputSetScript(&out, data, dataLen); break;
default: _ProtoBufUnknown(&ctx.unknown, key, i, data, dataLen); break;
}
}
if (! out.script) { // required
out = BR_TX_OUTPUT_NONE;
if (ctx.defaults) array_free(ctx.defaults);
if (ctx.unknown) array_free(ctx.unknown);
}
else array_add_array(out.script, (uint8_t *)&ctx, sizeof(ctx)); // store context at end of script data
return out;
}
static size_t _BRPaymentProtocolOutputSerialize(BRTxOutput out, uint8_t *buf, size_t bufLen)
{
ProtoBufContext ctx;
size_t off = 0;
assert(out.script != NULL);
memcpy(&ctx, &out.script[out.scriptLen], sizeof(ctx)); // context is stored at end of script data
if (! ctx.defaults[output_amount]) _ProtoBufSetInt(buf, bufLen, out.amount, output_amount, &off);
if (! ctx.defaults[output_script]) _ProtoBufSetBytes(buf, bufLen, out.script, out.scriptLen, output_script, &off);
if (ctx.unknown) {
if (buf && off + array_count(ctx.unknown) <= bufLen) memcpy(&buf[off], ctx.unknown, array_count(ctx.unknown));
off += array_count(ctx.unknown);
}
return (! buf || off <= bufLen) ? off : 0;
}
static void _BRPaymentProtocolOutputFree(BRTxOutput out)
{
ProtoBufContext ctx;
if (out.script) {
memcpy(&ctx, &out.script[out.scriptLen], sizeof(ctx));
if (ctx.defaults) array_free(ctx.defaults);
if (ctx.unknown) array_free(ctx.unknown);
BRTxOutputSetScript(&out, NULL, 0);
}
}
// returns a newly allocated details struct that must be freed by calling BRPaymentProtocolDetailsFree()
BRPaymentProtocolDetails *BRPaymentProtocolDetailsNew(const char *network, const BRTxOutput outputs[], size_t outCount,
uint64_t time, uint64_t expires, const char *memo,
const char *paymentURL, const uint8_t *merchantData,
size_t merchDataLen)
{
BRPaymentProtocolDetails *details = calloc(1, sizeof(*details) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&details[1];
assert(details != NULL);
assert(outputs != NULL || outCount == 0);
array_new(ctx->defaults, details_merch_data + 1);
array_set_count(ctx->defaults, details_merch_data + 1);
if (! network) {
_ProtoBufString(&details->network, "main", strlen("main"));
ctx->defaults[details_network] = 1;
}
else _ProtoBufString(&details->network, network, strlen(network));
array_new(details->outputs, outCount);
for (size_t i = 0; i < outCount; i++) {
array_add(details->outputs, _BRPaymentProtocolOutput(outputs[i].amount, outputs[i].script, outputs[i].scriptLen));
}
details->time = time;
details->expires = expires;
if (memo) _ProtoBufString(&details->memo, memo, strlen(memo));
if (paymentURL) _ProtoBufString(&details->paymentURL, paymentURL, strlen(paymentURL));
if (merchantData) details->merchDataLen = _ProtoBufBytes(&details->merchantData, merchantData, merchDataLen);
return details;
}
// buf must contain a serialized details struct
// returns a details struct that must be freed by calling BRPaymentProtocolDetailsFree()
BRPaymentProtocolDetails *BRPaymentProtocolDetailsParse(const uint8_t *buf, size_t bufLen)
{
BRPaymentProtocolDetails *details = calloc(1, sizeof(*details) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&details[1];
size_t off = 0;
assert(details != NULL);
assert(buf != NULL || bufLen == 0);
array_new(ctx->defaults, details_merch_data + 1);
array_set_count(ctx->defaults, details_merch_data + 1);
ctx->defaults[details_time] = 1;
ctx->defaults[details_expires] = 1;
array_new(details->outputs, 1);
while (buf && off < bufLen) {
BRTxOutput out = BR_TX_OUTPUT_NONE;
const uint8_t *data = NULL;
size_t dLen = bufLen;
uint64_t i = 0, key = _ProtoBufField(&i, &data, buf, &dLen, &off);
switch (key >> 3) {
case details_network: _ProtoBufString(&details->network, data, dLen); break;
case details_outputs: out = _BRPaymentProtocolOutputParse(data, dLen); break;
case details_time: details->time = i, ctx->defaults[details_time] = 0; break;
case details_expires: details->expires = i, ctx->defaults[details_expires] = 0; break;
case details_memo: _ProtoBufString(&details->memo, data, dLen); break;
case details_payment_url: _ProtoBufString(&details->paymentURL, data, dLen); break;
case details_merch_data: details->merchDataLen = _ProtoBufBytes(&details->merchantData, data, dLen); break;
default: _ProtoBufUnknown(&ctx->unknown, key, i, data, dLen); break;
}
if (out.script) array_add(details->outputs, out);
}
details->outCount = array_count(details->outputs);
if (! details->network) {
_ProtoBufString(&details->network, "main", strlen("main"));
ctx->defaults[details_network] = 1;
}
return details;
}
// writes serialized details struct to buf and returns number of bytes written, or total bufLen needed if buf is NULL
size_t BRPaymentProtocolDetailsSerialize(const BRPaymentProtocolDetails *details, uint8_t *buf, size_t bufLen)
{
const ProtoBufContext *ctx = (const ProtoBufContext *)&details[1];
size_t i, off = 0, outLen = 0x100, l;
uint8_t *outBuf = malloc(outLen);
assert(outBuf != NULL);
assert(details != NULL);
if (! ctx->defaults[details_network]) _ProtoBufSetString(buf, bufLen, details->network, details_network, &off);
for (i = 0; i < details->outCount; i++) {
l = _BRPaymentProtocolOutputSerialize(details->outputs[i], NULL, 0);
if (l > outLen) outBuf = realloc(outBuf, (outLen = l));
assert(outBuf != NULL);
l = _BRPaymentProtocolOutputSerialize(details->outputs[i], outBuf, outLen);
_ProtoBufSetBytes(buf, bufLen, outBuf, l, details_outputs, &off);
}
free(outBuf);
if (! ctx->defaults[details_time]) _ProtoBufSetInt(buf, bufLen, details->time, details_time, &off);
if (! ctx->defaults[details_expires]) _ProtoBufSetInt(buf, bufLen, details->expires, details_expires, &off);
if (details->memo) _ProtoBufSetString(buf, bufLen, details->memo, details_memo, &off);
if (details->paymentURL) _ProtoBufSetString(buf, bufLen, details->paymentURL, details_payment_url, &off);
if (details->merchantData) _ProtoBufSetBytes(buf, bufLen, details->merchantData, details->merchDataLen,
details_merch_data, &off);
if (ctx->unknown) {
if (buf && off + array_count(ctx->unknown) <= bufLen) memcpy(&buf[off], ctx->unknown,array_count(ctx->unknown));
off += array_count(ctx->unknown);
}
return (! buf || off <= bufLen) ? off : 0;
}
// frees memory allocated for details struct
void BRPaymentProtocolDetailsFree(BRPaymentProtocolDetails *details)
{
ProtoBufContext *ctx = (ProtoBufContext *)&details[1];
assert(details != NULL);
if (details->network) array_free(details->network);
for (size_t i = 0; i < details->outCount; i++) _BRPaymentProtocolOutputFree(details->outputs[i]);
if (details->outputs) array_free(details->outputs);
if (details->memo) array_free(details->memo);
if (details->paymentURL) array_free(details->paymentURL);
if (details->merchantData) array_free(details->merchantData);
if (ctx->defaults) array_free(ctx->defaults);
if (ctx->unknown) array_free(ctx->unknown);
free(details);
}
// returns a newly allocated request struct that must be freed by calling BRPaymentProtocolRequestFree()
BRPaymentProtocolRequest *BRPaymentProtocolRequestNew(uint32_t version, const char *pkiType, const uint8_t *pkiData,
size_t pkiDataLen, BRPaymentProtocolDetails *details,
const uint8_t *signature, size_t sigLen)
{
BRPaymentProtocolRequest *req = calloc(1, sizeof(*req) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&req[1];
assert(req != NULL);
assert(details != NULL);
array_new(ctx->defaults, request_signature + 1);
array_set_count(ctx->defaults, request_signature + 1);
if (! version) {
req->version = 1;
ctx->defaults[request_version] = 1;
}
else req->version = version;
if (! pkiType) {
_ProtoBufString(&req->pkiType, "none", strlen("none"));
ctx->defaults[request_pki_type] = 1;
}
else _ProtoBufString(&req->pkiType, pkiType, strlen(pkiType));
if (pkiData) req->pkiDataLen = _ProtoBufBytes(&req->pkiData, pkiData, pkiDataLen);
req->details = details;
if (signature) req->sigLen = _ProtoBufBytes(&req->signature, signature, sigLen);
if (! req->details) { // required
BRPaymentProtocolRequestFree(req);
req = NULL;
}
return req;
}
// buf must contain a serialized request struct
// returns a request struct that must be freed by calling BRPaymentProtocolRequestFree()
BRPaymentProtocolRequest *BRPaymentProtocolRequestParse(const uint8_t *buf, size_t bufLen)
{
BRPaymentProtocolRequest *req = calloc(1, sizeof(*req) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&req[1];
size_t off = 0;
assert(req != NULL);
assert(buf != NULL || bufLen == 0);
array_new(ctx->defaults, request_signature + 1);
array_set_count(ctx->defaults, request_signature + 1);
req->version = 1;
ctx->defaults[request_version] = 1;
while (buf && off < bufLen) {
const uint8_t *data = NULL;
size_t dataLen = bufLen;
uint64_t i = 0, key = _ProtoBufField(&i, &data, buf, &dataLen, &off);
switch (key >> 3) {
case request_version: req->version = (uint32_t)i, ctx->defaults[request_version] = 0; break;
case request_pki_type: _ProtoBufString(&req->pkiType, data, dataLen); break;
case request_pki_data: req->pkiDataLen = _ProtoBufBytes(&req->pkiData, data, dataLen); break;
case request_details: req->details = BRPaymentProtocolDetailsParse(data, dataLen); break;
case request_signature: req->sigLen = _ProtoBufBytes(&req->signature, data, dataLen); break;
default: _ProtoBufUnknown(&ctx->unknown, key, i, data, dataLen); break;
}
}
if (! req->pkiType) {
_ProtoBufString(&req->pkiType, "none", strlen("none"));
ctx->defaults[request_pki_type] = 1;
}
if (! req->details) { // required
BRPaymentProtocolRequestFree(req);
req = NULL;
}
return req;
}
// writes serialized request struct to buf and returns number of bytes written, or total bufLen needed if buf is NULL
size_t BRPaymentProtocolRequestSerialize(const BRPaymentProtocolRequest *req, uint8_t *buf, size_t bufLen)
{
const ProtoBufContext *ctx = (const ProtoBufContext *)&req[1];
size_t off = 0;
assert(req != NULL);
assert(req->details != NULL);
if (! ctx->defaults[request_version]) _ProtoBufSetInt(buf, bufLen, req->version, request_version, &off);
if (! ctx->defaults[request_pki_type]) _ProtoBufSetString(buf, bufLen, req->pkiType, request_pki_type, &off);
if (req->pkiData) _ProtoBufSetBytes(buf, bufLen, req->pkiData, req->pkiDataLen, request_pki_data, &off);
if (req->details) {
size_t detailsLen = BRPaymentProtocolDetailsSerialize(req->details, NULL, 0);
uint8_t *detailsBuf = malloc(detailsLen);
assert(detailsBuf != NULL);
detailsLen = BRPaymentProtocolDetailsSerialize(req->details, detailsBuf, detailsLen);
_ProtoBufSetBytes(buf, bufLen, detailsBuf, detailsLen, request_details, &off);
free(detailsBuf);
}
if (req->signature) _ProtoBufSetBytes(buf, bufLen, req->signature, req->sigLen, request_signature, &off);
if (ctx->unknown) {
if (buf && off + array_count(ctx->unknown) <= bufLen) memcpy(&buf[off], ctx->unknown,array_count(ctx->unknown));
off += array_count(ctx->unknown);
}
return (! buf || off <= bufLen) ? off : 0;
}
// writes the DER encoded certificate corresponding to index to cert
// returns the number of bytes written to cert, or the total certLen needed if cert is NULL
// returns 0 if index is out-of-bounds
size_t BRPaymentProtocolRequestCert(const BRPaymentProtocolRequest *req, uint8_t *cert, size_t certLen, size_t idx)
{
size_t off = 0, len = 0;
assert(req != NULL);
while (req->pkiData && off < req->pkiDataLen) {
const uint8_t *data = NULL;
size_t dataLen = req->pkiDataLen;
uint64_t i = 0, key = _ProtoBufField(&i, &data, req->pkiData, &dataLen, &off);
if ((key >> 3) == certificates_cert && data) {
if (idx == 0) {
len = dataLen;
if (cert && len <= certLen) memcpy(cert, data, len);
break;
}
else idx--;
}
}
return (idx == 0 && (! cert || len <= certLen)) ? len : 0;
}
// writes the hash of the request to md needed to sign or verify the request
// returns the number of bytes written, or the total mdLen needed if md is NULL
size_t BRPaymentProtocolRequestDigest(BRPaymentProtocolRequest *req, uint8_t *md, size_t mdLen)
{
uint8_t *buf;
size_t bufLen;
assert(req != NULL);
req->sigLen = 0; // set signature to 0 bytes, a signature can't sign itself
bufLen = BRPaymentProtocolRequestSerialize(req, NULL, 0);
buf = malloc(bufLen);
assert(buf != NULL);
bufLen = BRPaymentProtocolRequestSerialize(req, buf, bufLen);
if (req->pkiType && strncmp(req->pkiType, "x509+sha256", strlen("x509+sha256") + 1) == 0) {
if (md && 256/8 <= mdLen) BRSHA256(md, buf, bufLen);
bufLen = 256/8;
}
else if (req->pkiType && strncmp(req->pkiType, "x509+sha1", strlen("x509+sha1") + 1) == 0) {
if (md && 160/8 <= mdLen) BRSHA1(md, buf, bufLen);
bufLen = 160/8;
}
else bufLen = 0;
free(buf);
if (req->signature) req->sigLen = array_count(req->signature);
return (! md || bufLen <= mdLen) ? bufLen : 0;
}
// frees memory allocated for request struct
void BRPaymentProtocolRequestFree(BRPaymentProtocolRequest *req)
{
ProtoBufContext *ctx = (ProtoBufContext *)&req[1];
assert(req != NULL);
if (req->pkiType) array_free(req->pkiType);
if (req->pkiData) array_free(req->pkiData);
if (req->details) BRPaymentProtocolDetailsFree(req->details);
if (req->signature) array_free(req->signature);
if (ctx->defaults) array_free(ctx->defaults);
if (ctx->unknown) array_free(ctx->unknown);
free(req);
}
// returns a newly allocated payment struct that must be freed by calling BRPaymentProtocolPaymentFree()
BRPaymentProtocolPayment *BRPaymentProtocolPaymentNew(const uint8_t *merchantData, size_t merchDataLen,
BRTransaction *transactions[], size_t txCount,
const uint64_t refundToAmounts[],
const BRAddress refundToAddresses[], size_t refundToCount,
const char *memo)
{
BRPaymentProtocolPayment *payment = calloc(1, sizeof(*payment) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&payment[1];
assert(payment != NULL);
assert(transactions != NULL || txCount == 0);
assert(refundToAmounts != NULL || refundToCount == 0);
assert(refundToAddresses != NULL || refundToCount == 0);
array_new(ctx->defaults, payment_merch_data + 1);
array_set_count(ctx->defaults, payment_merch_data + 1);
if (merchantData) payment->merchDataLen = _ProtoBufBytes(&payment->merchantData, merchantData, merchDataLen);
if (transactions) {
array_new(payment->transactions, txCount);
array_add_array(payment->transactions, transactions, txCount);
payment->txCount = txCount;
}
array_new(payment->refundTo, refundToCount);
for (size_t i = 0; i < refundToCount; i++) {
uint8_t script[BRAddressScriptPubKey(NULL, 0, refundToAddresses[i].s)];
size_t scriptLen = BRAddressScriptPubKey(script, sizeof(script), refundToAddresses[i].s);
array_add(payment->refundTo, _BRPaymentProtocolOutput(refundToAmounts[i], script, scriptLen));
}
payment->refundToCount = refundToCount;
if (memo) _ProtoBufString(&payment->memo, memo, strlen(memo));
return payment;
}
// buf must contain a serialized payment struct
// returns a payment struct that must be freed by calling BRPaymentProtocolPaymentFree()
BRPaymentProtocolPayment *BRPaymentProtocolPaymentParse(const uint8_t *buf, size_t bufLen)
{
BRPaymentProtocolPayment *payment = calloc(1, sizeof(*payment) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&payment[1];
size_t off = 0;
assert(payment != NULL);
assert(buf != NULL || bufLen == 0);
array_new(ctx->defaults, payment_merch_data + 1);
array_set_count(ctx->defaults, payment_merch_data + 1);
array_new(payment->transactions, 1);
array_new(payment->refundTo, 1);
while (buf && off < bufLen) {
BRTransaction *tx = NULL;
BRTxOutput out = BR_TX_OUTPUT_NONE;
const uint8_t *data = NULL;
size_t dLen = bufLen;
uint64_t i = 0, key = _ProtoBufField(&i, &data, buf, &dLen, &off);
switch (key >> 3) {
case payment_transactions: tx = BRTransactionParse(data, dLen); break;
case payment_refund_to: out = _BRPaymentProtocolOutputParse(data, dLen); break;
case payment_memo: _ProtoBufString(&payment->memo, data, dLen); break;
case payment_merch_data: payment->merchDataLen = _ProtoBufBytes(&payment->merchantData, data, dLen); break;
default: _ProtoBufUnknown(&ctx->unknown, key, i, data, dLen); break;
}
if (tx) array_add(payment->transactions, tx);
if (out.script) array_add(payment->refundTo, out);
}
payment->txCount = array_count(payment->transactions);
payment->refundToCount = array_count(payment->refundTo);
return payment;
}
// writes serialized payment struct to buf, returns number of bytes written, or total bufLen needed if buf is NULL
size_t BRPaymentProtocolPaymentSerialize(const BRPaymentProtocolPayment *payment, uint8_t *buf, size_t bufLen)
{
const ProtoBufContext *ctx = (const ProtoBufContext *)&payment[1];
size_t off = 0, sLen = 0x100, l;
uint8_t *sBuf = malloc(sLen);
assert(sBuf != NULL);
assert(payment != NULL);
if (payment->merchantData) {
_ProtoBufSetBytes(buf, bufLen, payment->merchantData, payment->merchDataLen, payment_merch_data, &off);
}
for (size_t i = 0; i < payment->txCount; i++) {
l = BRTransactionSerialize(payment->transactions[i], NULL, 0);
if (l > sLen) sBuf = realloc(sBuf, (sLen = l));
assert(sBuf != NULL);
l = BRTransactionSerialize(payment->transactions[i], sBuf, sLen);
_ProtoBufSetBytes(buf, bufLen, sBuf, l, payment_transactions, &off);
}
for (size_t i = 0; i < payment->refundToCount; i++) {
l = _BRPaymentProtocolOutputSerialize(payment->refundTo[i], NULL, 0);
if (l > sLen) sBuf = realloc(sBuf, (sLen = l));
assert(sBuf != NULL);
l = _BRPaymentProtocolOutputSerialize(payment->refundTo[i], sBuf, l);
_ProtoBufSetBytes(buf, bufLen, sBuf, l, payment_refund_to, &off);
}
free(sBuf);
if (payment->memo) _ProtoBufSetString(buf, bufLen, payment->memo, payment_memo, &off);
if (ctx->unknown) {
if (buf && off + array_count(ctx->unknown) <= bufLen) memcpy(&buf[off], ctx->unknown,array_count(ctx->unknown));
off += array_count(ctx->unknown);
}
return (! buf || off <= bufLen) ? off : 0;
}
// frees memory allocated for payment struct (does not call BRTransactionFree() on transactions)
void BRPaymentProtocolPaymentFree(BRPaymentProtocolPayment *payment)
{
ProtoBufContext *ctx = (ProtoBufContext *)&payment[1];
assert(payment != NULL);
if (payment->merchantData) array_free(payment->merchantData);
if (payment->transactions) array_free(payment->transactions);
for (size_t i = 0; i < payment->refundToCount; i++) _BRPaymentProtocolOutputFree(payment->refundTo[i]);
if (payment->refundTo) array_free(payment->refundTo);
if (payment->memo) array_free(payment->memo);
if (ctx->defaults) array_free(ctx->defaults);
if (ctx->unknown) array_free(ctx->unknown);
}
// returns a newly allocated ACK struct that must be freed by calling BRPaymentProtocolACKFree()
BRPaymentProtocolACK *BRPaymentProtocolACKNew(BRPaymentProtocolPayment *payment, const char *memo)
{
BRPaymentProtocolACK *ack = calloc(1, sizeof(*ack) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&ack[1];
assert(ack != NULL);
assert(payment != NULL);
array_new(ctx->defaults, ack_memo + 1);
array_set_count(ctx->defaults, ack_memo + 1);
ack->payment = payment;
if (memo) _ProtoBufString(&ack->memo, memo, strlen(memo));
if (! ack->payment) { // required
BRPaymentProtocolACKFree(ack);
ack = NULL;
}
return ack;
}
// buf must contain a serialized ACK struct
// returns a ACK struct that must be freed by calling BRPaymentProtocolACKFree()
BRPaymentProtocolACK *BRPaymentProtocolACKParse(const uint8_t *buf, size_t bufLen)
{
BRPaymentProtocolACK *ack = calloc(1, sizeof(*ack) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&ack[1];
size_t off = 0;
assert(ack != NULL);
assert(buf != NULL || bufLen == 0);
array_new(ctx->defaults, ack_memo + 1);
array_set_count(ctx->defaults, ack_memo + 1);
while (buf && off < bufLen) {
const uint8_t *data = NULL;
size_t dataLen = bufLen;
uint64_t i = 0, key = _ProtoBufField(&i, &data, buf, &dataLen, &off);
switch (key >> 3) {
case ack_payment: ack->payment = BRPaymentProtocolPaymentParse(data, dataLen); break;
case ack_memo: _ProtoBufString(&ack->memo, data, dataLen); break;
default: _ProtoBufUnknown(&ctx->unknown, key, i, data, dataLen); break;
}
}
if (! ack->payment) { // required
BRPaymentProtocolACKFree(ack);
ack = NULL;
}
return ack;
}
// writes serialized ACK struct to buf and returns number of bytes written, or total bufLen needed if buf is NULL
size_t BRPaymentProtocolACKSerialize(const BRPaymentProtocolACK *ack, uint8_t *buf, size_t bufLen)
{
const ProtoBufContext *ctx = (const ProtoBufContext *)&ack[1];
size_t off = 0;
assert(ack != NULL);
assert(ack->payment != NULL);
if (ack->payment) {
size_t paymentLen = BRPaymentProtocolPaymentSerialize(ack->payment, NULL, 0);
uint8_t *paymentBuf = malloc(paymentLen);
assert(paymentBuf != NULL);
paymentLen = BRPaymentProtocolPaymentSerialize(ack->payment, paymentBuf, paymentLen);
_ProtoBufSetBytes(buf, bufLen, paymentBuf, paymentLen, ack_payment, &off);
free(paymentBuf);
}
if (ack->memo) _ProtoBufSetString(buf, bufLen, ack->memo, ack_memo, &off);
if (ctx->unknown) {
if (buf && off + array_count(ctx->unknown) <= bufLen) memcpy(&buf[off], ctx->unknown,array_count(ctx->unknown));
off += array_count(ctx->unknown);
}
return (! buf || off <= bufLen) ? off : 0;
}
// frees memory allocated for ACK struct
void BRPaymentProtocolACKFree(BRPaymentProtocolACK *ack)
{
ProtoBufContext *ctx = (ProtoBufContext *)&ack[1];
assert(ack != NULL);
if (ack->payment) BRPaymentProtocolPaymentFree(ack->payment);
if (ack->memo) array_free(ack->memo);
if (ctx->defaults) array_free(ctx->defaults);
if (ctx->unknown) array_free(ctx->unknown);
free(ack);
}
// returns a newly allocated invoice request struct that must be freed by calling BRPaymentProtocolInvoiceRequestFree()
BRPaymentProtocolInvoiceRequest *BRPaymentProtocolInvoiceRequestNew(BRKey *senderPubKey, uint64_t amount,
const char *pkiType, uint8_t *pkiData,
size_t pkiDataLen, const char *memo,
const char *notifyUrl, const uint8_t *signature,
size_t sigLen)
{
BRPaymentProtocolInvoiceRequest *req = calloc(1, sizeof(*req) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&req[1];
uint8_t pk[65];
size_t pkLen;
assert(req != NULL);
assert(senderPubKey != NULL);
array_new(ctx->defaults, invoice_req_signature + 1);
array_set_count(ctx->defaults, invoice_req_signature + 1);
pkLen = BRKeyPubKey(senderPubKey, pk, sizeof(pk));
BRKeySetPubKey(&req->senderPubKey, pk, pkLen);
req->amount = amount;
if (! pkiType) {
_ProtoBufString(&req->pkiType, "none", strlen("none"));
ctx->defaults[invoice_req_pki_type] = 1;
}
else _ProtoBufString(&req->pkiType, pkiType, strlen(pkiType));
if (pkiData) req->pkiDataLen = _ProtoBufBytes(&req->pkiData, pkiData, pkiDataLen);
if (memo) _ProtoBufString(&req->memo, memo, strlen(memo));
if (notifyUrl) _ProtoBufString(&req->notifyUrl, notifyUrl, strlen(notifyUrl));
if (signature) req->sigLen = _ProtoBufBytes(&req->signature, signature, sigLen);
return req;
}
// buf must contain a serialized invoice request
// returns an invoice request struct that must be freed by calling BRPaymentProtocolInvoiceRequestFree()
BRPaymentProtocolInvoiceRequest *BRPaymentProtocolInvoiceRequestParse(const uint8_t *buf, size_t bufLen)
{
BRPaymentProtocolInvoiceRequest *req = calloc(1, sizeof(*req) + sizeof(ProtoBufContext));
ProtoBufContext *ctx = (ProtoBufContext *)&req[1];
size_t off = 0;
int gotSenderPK = 0;
assert(req != NULL);
assert(buf != NULL || bufLen == 0);
array_new(ctx->defaults, invoice_req_signature + 1);
array_set_count(ctx->defaults, invoice_req_signature + 1);
ctx->defaults[invoice_req_amount] = 1;
while (buf && off < bufLen) {
const uint8_t *data = NULL;
size_t dataLen = bufLen;
uint64_t i = 0, key = _ProtoBufField(&i, &data, buf, &dataLen, &off);
switch (key >> 3) {
case invoice_req_sender_pk: gotSenderPK = BRKeySetPubKey(&req->senderPubKey, data, dataLen); break;
case invoice_req_amount: req->amount = i, ctx->defaults[invoice_req_amount] = 0; break;
case invoice_req_pki_type: _ProtoBufString(&req->pkiType, data, dataLen); break;
case invoice_req_pki_data: req->pkiDataLen = _ProtoBufBytes(&req->pkiData, data, dataLen); break;
case invoice_req_memo: _ProtoBufString(&req->memo, data, dataLen); break;
case invoice_req_notify_url: _ProtoBufString(&req->notifyUrl, data, dataLen); break;
case invoice_req_signature: req->sigLen = _ProtoBufBytes(&req->signature, data, dataLen); break;
default: _ProtoBufUnknown(&ctx->unknown, key, i, data, dataLen); break;
}
}
if (! req->pkiType) {
_ProtoBufString(&req->pkiType, "none", strlen("none"));
ctx->defaults[invoice_req_pki_type] = 1;
}
if (! gotSenderPK) { // required
BRPaymentProtocolInvoiceRequestFree(req);
req = NULL;
}
return req;
}
// writes serialized invoice request to buf and returns number of bytes written, or total bufLen needed if buf is NULL
size_t BRPaymentProtocolInvoiceRequestSerialize(BRPaymentProtocolInvoiceRequest *req, uint8_t *buf, size_t bufLen)
{
const ProtoBufContext *ctx = (const ProtoBufContext *)&req[1];
uint8_t pk[65];
size_t pkLen, off = 0;
assert(req != NULL);
pkLen = BRKeyPubKey(&req->senderPubKey, pk, sizeof(pk));