forked from decred/politeia
-
Notifications
You must be signed in to change notification settings - Fork 0
/
record.go
1188 lines (1066 loc) · 33.1 KB
/
record.go
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
// Copyright (c) 2020-2021 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.
package tstore
import (
"bytes"
"encoding/base64"
"encoding/hex"
"encoding/json"
"fmt"
"sort"
backend "github.com/decred/politeia/politeiad/backendv2"
"github.com/decred/politeia/politeiad/backendv2/tstorebe/store"
"github.com/decred/politeia/util"
"github.com/google/trillian"
"google.golang.org/grpc/codes"
)
const (
// Blob entry data descriptors
dataDescriptorRecordMetadata = "pd-recordmd-v1"
dataDescriptorMetadataStream = "pd-mdstream-v1"
dataDescriptorFile = "pd-file-v1"
dataDescriptorRecordIndex = "pd-rindex-v1"
dataDescriptorAnchor = "pd-anchor-v1"
)
// RecordNew creates a new record in the tstore and returns the record token
// that serves as the unique identifier for the record. Creating a new record
// means creating a tlog tree for the record. Nothing is saved to the tree yet.
func (t *Tstore) RecordNew() ([]byte, error) {
var token []byte
for retries := 0; retries < 10; retries++ {
tree, _, err := t.tlog.TreeNew()
if err != nil {
return nil, err
}
token = tokenFromTreeID(tree.TreeId)
// Check for shortened token collisions
if t.tokenCollision(token) {
// This is a collision. We cannot use this tree. Try again.
log.Infof("Token collision %x, creating new token", token)
continue
}
// We've found a valid token. Update the tokens cache. This must
// be done even if the record creation fails since the tree will
// still exist.
t.tokenAdd(token)
break
}
return token, nil
}
// recordSave saves the provided record content to the kv store, appends a leaf
// to the trillian tree for each piece of content, then returns a record
// index for the newly saved record. If the record state is unvetted the record
// content will be saved to the key-value store encrypted.
//
// If the record is being made public the record version and iteration are both
// reset back to 1. This function detects when a record is being made public
// and re-saves any encrypted content that is part of the public record as
// clear text in the key-value store.
func (t *Tstore) recordSave(treeID int64, recordMD backend.RecordMetadata, metadata []backend.MetadataStream, files []backend.File) (*recordIndex, error) {
// Get tree leaves
leavesAll, err := t.leavesAll(treeID)
if err != nil {
return nil, err
}
// Get the existing record index
currIdx, err := t.recordIndexLatest(leavesAll)
if err == backend.ErrRecordNotFound {
// No record versions exist yet. This is ok.
currIdx = &recordIndex{
Metadata: make(map[string]map[uint32][]byte),
Files: make(map[string][]byte),
}
} else if err != nil {
return nil, fmt.Errorf("recordIndexLatest: %v", err)
}
// Verify tree is not frozen
if currIdx.Frozen {
return nil, backend.ErrRecordLocked
}
// Verify there are no duplicate metadata streams
md := make(map[string]map[uint32]struct{}, len(metadata))
for _, v := range metadata {
if v.PluginID == "" || v.StreamID == 0 {
return nil, fmt.Errorf("invalid metadata stream: '%v' %v",
v.PluginID, v.StreamID)
}
pmd, ok := md[v.PluginID]
if !ok {
pmd = make(map[uint32]struct{}, len(metadata))
}
_, ok = pmd[v.StreamID]
if ok {
return nil, fmt.Errorf("duplicate metadata stream: %v %v",
v.PluginID, v.StreamID)
}
pmd[v.StreamID] = struct{}{}
md[v.PluginID] = pmd
}
// Verify there are no duplicate files
fn := make(map[string]struct{}, len(files))
for _, v := range files {
if v.Name == "" {
return nil, fmt.Errorf("empty filename")
}
_, ok := fn[v.Name]
if ok {
return nil, fmt.Errorf("duplicate filename found: %v", v.Name)
}
fn[v.Name] = struct{}{}
}
// Prepare the blob entries. The record index can also be created
// during this step.
var (
// [pluginID][streamID]BlobEntry
beMetadata = make(map[string]map[uint32]store.BlobEntry, len(metadata))
// [filename]BlobEntry
beFiles = make(map[string]store.BlobEntry, len(files))
idx = recordIndex{
State: recordMD.State,
Version: recordMD.Version,
Iteration: recordMD.Iteration,
Metadata: make(map[string]map[uint32][]byte, len(metadata)),
Files: make(map[string][]byte, len(files)),
}
// digests is used to aggregate the digests from all record
// content. This is used later on to see if any of the content
// already exists in the tstore.
digests = make(map[string]struct{}, 256)
)
// Setup record metadata
beRecordMD, err := convertBlobEntryFromRecordMetadata(recordMD)
if err != nil {
return nil, err
}
m, err := merkleLeafHashForBlobEntry(*beRecordMD)
if err != nil {
return nil, err
}
idx.RecordMetadata = m
digests[beRecordMD.Digest] = struct{}{}
// Setup metdata streams
for _, v := range metadata {
// Blob entry
be, err := convertBlobEntryFromMetadataStream(v)
if err != nil {
return nil, err
}
streams, ok := beMetadata[v.PluginID]
if !ok {
streams = make(map[uint32]store.BlobEntry, len(metadata))
}
streams[v.StreamID] = *be
beMetadata[v.PluginID] = streams
// Record index
m, err := merkleLeafHashForBlobEntry(*be)
if err != nil {
return nil, err
}
streamsIdx, ok := idx.Metadata[v.PluginID]
if !ok {
streamsIdx = make(map[uint32][]byte, len(metadata))
}
streamsIdx[v.StreamID] = m
idx.Metadata[v.PluginID] = streamsIdx
// Aggregate digest
digests[be.Digest] = struct{}{}
}
// Setup files
for _, v := range files {
// Blob entry
be, err := convertBlobEntryFromFile(v)
if err != nil {
return nil, err
}
beFiles[v.Name] = *be
// Record Index
m, err := merkleLeafHashForBlobEntry(*be)
if err != nil {
return nil, err
}
idx.Files[v.Name] = m
// Aggregate digest
digests[be.Digest] = struct{}{}
}
// Check if any of the content already exists. Different record
// versions that reference the same data is fine, but this data
// should not be saved to the store again. We can find duplicates
// by comparing the blob entry digest to the log leaf value. They
// will be the same if the record content is the same.
dups := make(map[string]struct{}, len(digests))
for _, v := range leavesAll {
d := hex.EncodeToString(v.LeafValue)
_, ok := digests[d]
if ok {
// A piece of the new record content already exsits in the
// tstore. Save the digest as a duplcate.
dups[d] = struct{}{}
}
}
// Prepare blobs for the kv store
var (
blobs = make(map[string][]byte, len(digests))
leaves = make([]*trillian.LogLeaf, 0, len(blobs))
// dupBlobs contains the blob entries for record content that
// already exists. We may need these blob entries later on if
// the duplicate content is encrypted and it needs to be saved
// plain text.
dupBlobs = make(map[string]store.BlobEntry, len(digests))
)
// Only vetted data should be saved plain text
var encrypt bool
switch idx.State {
case backend.StateUnvetted:
encrypt = true
case backend.StateVetted:
// Save plain text
encrypt = false
default:
// Something is wrong
panic(fmt.Sprintf("invalid record state %v %v", treeID, idx.State))
}
// Prepare record metadata blobs and leaves
_, ok := dups[beRecordMD.Digest]
if !ok {
// Not a duplicate. Prepare kv store blob.
b, err := store.Blobify(*beRecordMD)
if err != nil {
return nil, err
}
k := storeKeyNew(encrypt)
blobs[k] = b
// Prepare tlog leaf
extraData, err := extraDataEncode(k,
dataDescriptorRecordMetadata, idx.State)
if err != nil {
return nil, err
}
digest, err := hex.DecodeString(beRecordMD.Digest)
if err != nil {
return nil, err
}
leaves = append(leaves, newLogLeaf(digest, extraData))
} else {
// This is a duplicate. Stash is for now. We may need to save
// it as plain text later.
dupBlobs[beRecordMD.Digest] = *beRecordMD
}
// Prepare metadata stream blobs and leaves
for _, v := range beMetadata {
for _, be := range v {
_, ok := dups[be.Digest]
if ok {
// This is a duplicate. Stash is for now. We may need to save
// it as plain text later.
dupBlobs[be.Digest] = be
continue
}
// Not a duplicate. Prepare kv store blob.
b, err := store.Blobify(be)
if err != nil {
return nil, err
}
k := storeKeyNew(encrypt)
blobs[k] = b
// Prepare tlog leaf
extraData, err := extraDataEncode(k,
dataDescriptorMetadataStream, idx.State)
if err != nil {
return nil, err
}
digest, err := hex.DecodeString(be.Digest)
if err != nil {
return nil, err
}
leaves = append(leaves, newLogLeaf(digest, extraData))
}
}
// Prepare file blobs and leaves
for _, be := range beFiles {
_, ok := dups[be.Digest]
if ok {
// This is a duplicate. Stash is for now. We may need to save
// it as plain text later.
dupBlobs[be.Digest] = be
continue
}
// Not a duplicate. Prepare kv store blob.
b, err := store.Blobify(be)
if err != nil {
return nil, err
}
k := storeKeyNew(encrypt)
blobs[k] = b
// Prepare tlog leaf
extraData, err := extraDataEncode(k, dataDescriptorFile, idx.State)
if err != nil {
return nil, err
}
digest, err := hex.DecodeString(be.Digest)
if err != nil {
return nil, err
}
leaves = append(leaves, newLogLeaf(digest, extraData))
}
// Verify at least one new blob is being saved to the kv store
if len(blobs) == 0 {
return nil, backend.ErrNoRecordChanges
}
log.Debugf("Saving %v record content blobs", len(blobs))
// Save blobs to the kv store
err = t.store.Put(blobs, encrypt)
if err != nil {
return nil, fmt.Errorf("store Put: %v", err)
}
// Append leaves onto the trillian tree
queued, _, err := t.tlog.LeavesAppend(treeID, leaves)
if err != nil {
return nil, fmt.Errorf("LeavesAppend: %v", err)
}
failed := make([]string, 0, len(queued))
for _, v := range queued {
c := codes.Code(v.QueuedLeaf.GetStatus().GetCode())
if c != codes.OK {
failed = append(failed, fmt.Sprintf("%v", c))
}
}
if len(failed) > 0 {
return nil, fmt.Errorf("append leaves failed: %v", failed)
}
// When a record is made public the record content needs to be
// resaved to the key-value store as unencrypted.
var (
isPublic = recordMD.Status == backend.StatusPublic
// Iteration and version are reset back to 1 when a record is
// made public.
iterIsReset = recordMD.Iteration == 1
)
if !isPublic || !iterIsReset {
// Record is not being made public. Nothing else to do.
return &idx, nil
}
// Resave all of the duplicate blobs as plain text. A duplicate
// blob means the record content existed prior to the status
// change.
blobs = make(map[string][]byte, len(dupBlobs))
for _, v := range leavesAll {
d := hex.EncodeToString(v.LeafValue)
_, ok := dups[d]
if !ok {
// Not a duplicate
continue
}
// This is a duplicate. If its unvetted it will need to be
// resaved as plain text.
ed, err := extraDataDecode(v.ExtraData)
if err != nil {
return nil, err
}
if ed.State == backend.StateVetted {
// Not unvetted. No need to resave it.
continue
}
// Prepare plain text blob
be, ok := dupBlobs[d]
if !ok {
// Should not happen
return nil, fmt.Errorf("blob entry not found %v", d)
}
b, err := store.Blobify(be)
if err != nil {
return nil, err
}
blobs[ed.storeKeyNoPrefix()] = b
}
if len(blobs) == 0 {
// This should not happen
return nil, fmt.Errorf("no blobs found to resave as plain text")
}
log.Debugf("Resaving %v encrypted blobs as plain text", len(blobs))
err = t.store.Put(blobs, false)
if err != nil {
return nil, fmt.Errorf("store Put: %v", err)
}
return &idx, nil
}
// RecordSave saves the provided record to tstore. Once the record contents
// have been successfully saved to tstore, a recordIndex is created for this
// version of the record and saved to tstore as well. The record update is not
// considered to be valid until the record index has been successfully saved.
// If the record content makes it in but the record index does not, the record
// content blobs are orphaned and ignored.
func (t *Tstore) RecordSave(token []byte, rm backend.RecordMetadata, metadata []backend.MetadataStream, files []backend.File) error {
log.Tracef("RecordSave: %x", token)
// Verify token is valid. The full length token must be used when
// writing data.
if !tokenIsFullLength(token) {
return backend.ErrTokenInvalid
}
// Save the record
treeID := treeIDFromToken(token)
idx, err := t.recordSave(treeID, rm, metadata, files)
if err != nil {
return err
}
// Save the record index
err = t.recordIndexSave(treeID, *idx)
if err != nil {
return fmt.Errorf("recordIndexSave: %v", err)
}
return nil
}
// RecordDel walks the provided tree and deletes all blobs in the store that
// correspond to record files. This is done for all versions and all iterations
// of the record. Record metadata and metadata stream blobs are not deleted.
func (t *Tstore) RecordDel(token []byte) error {
log.Tracef("RecordDel: %x", token)
// Verify token is valid. The full length token must be used when
// writing data.
if !tokenIsFullLength(token) {
return backend.ErrTokenInvalid
}
// Get all tree leaves
treeID := treeIDFromToken(token)
leavesAll, err := t.leavesAll(treeID)
if err != nil {
return err
}
// Ensure tree is frozen. Deleting files from the store is only
// allowed on frozen trees.
currIdx, err := t.recordIndexLatest(leavesAll)
if err != nil {
return err
}
if !currIdx.Frozen {
return fmt.Errorf("tree is not frozen")
}
// Retrieve all record indexes
indexes, err := t.recordIndexes(leavesAll)
if err != nil {
return err
}
// Aggregate the keys for all file blobs of all versions. The
// record index points to the log leaf merkle leaf hash. The log
// leaf contains the kv store key.
merkles := make(map[string]struct{}, len(leavesAll))
for _, v := range indexes {
for _, merkle := range v.Files {
merkles[hex.EncodeToString(merkle)] = struct{}{}
}
}
keys := make([]string, 0, len(merkles))
for _, v := range leavesAll {
_, ok := merkles[hex.EncodeToString(v.MerkleLeafHash)]
if ok {
ed, err := extraDataDecode(v.ExtraData)
if err != nil {
return err
}
keys = append(keys, ed.storeKey())
// When a record is made public the encrypted blobs in the kv
// store are re-saved as clear text, but the tlog leaf remains
// the same since the record content did not actually change.
// Both of these blobs need to be deleted.
if ed.storeKey() != ed.storeKeyNoPrefix() {
// This blob might have a clear text entry and an encrypted
// entry. Add both keys to be sure all content is deleted.
keys = append(keys, ed.storeKeyNoPrefix())
}
}
}
// Delete file blobs from the store
err = t.store.Del(keys)
if err != nil {
return fmt.Errorf("store Del: %v", err)
}
return nil
}
// RecordFreeze updates the status of a record then freezes the trillian tree
// to prevent any additional updates.
//
// A tree is considered to be frozen once the record index has been saved with
// its Frozen field set to true. The only thing that can be appended onto a
// frozen tree is one additional anchor record. Once a frozen tree has been
// anchored, the tstore fsck function will update the status of the tree to
// frozen in trillian, at which point trillian will prevent any changes to the
// tree.
func (t *Tstore) RecordFreeze(token []byte, rm backend.RecordMetadata, metadata []backend.MetadataStream, files []backend.File) error {
log.Tracef("RecordFreeze: %x", token)
// Verify token is valid. The full length token must be used when
// writing data.
if !tokenIsFullLength(token) {
return backend.ErrTokenInvalid
}
// Save updated record
treeID := treeIDFromToken(token)
idx, err := t.recordSave(treeID, rm, metadata, files)
if err != nil {
return err
}
// Mark the record as frozen
idx.Frozen = true
// Save the record index
return t.recordIndexSave(treeID, *idx)
}
// RecordExists returns whether a record exists.
//
// This method only returns whether a tree exists for the provided token. It's
// possible for a tree to exist that does not correspond to a record in the
// rare case that a tree was created but an unexpected error, such as a network
// error, was encoutered prior to the record being saved to the tree. We ignore
// this edge case because:
//
// 1. A user has no way to obtain this token unless the trillian instance has
// been opened to the public.
//
// 2. Even if they have the token they cannot do anything with it. Any attempt
// to read from the tree or write to the tree will return a RecordNotFound
// error.
//
// Pulling the leaves from the tree to see if a record has been saved to the
// tree adds a large amount of overhead to this call, which should be a very
// light weight. Its for this reason that we rely on the tree exists call
// despite the edge case.
func (t *Tstore) RecordExists(token []byte) bool {
// Read methods are allowed to use short tokens. Lookup the full
// length token.
var err error
token, err = t.fullLengthToken(token)
if err != nil {
return false
}
_, err = t.tlog.Tree(treeIDFromToken(token))
return err == nil
}
// record returns the specified record.
//
// Version is used to request a specific version of a record. If no version is
// provided then the most recent version of the record will be returned.
//
// Filenames can be used to request specific files. If filenames is not empty
// then the specified files will be the only files returned.
//
// OmitAllFiles can be used to retrieve a record without any of the record
// files. This supersedes the filenames argument.
func (t *Tstore) record(treeID int64, version uint32, filenames []string, omitAllFiles bool) (*backend.Record, error) {
// Get tree leaves
leaves, err := t.leavesAll(treeID)
if err != nil {
return nil, err
}
// Use the record index to pull the record content from the store.
// The keys for the record content first need to be extracted from
// their log leaf.
idx, err := t.recordIndex(leaves, version)
if err != nil {
return nil, err
}
// Compile merkle root hashes of record content
merkles := make(map[string]struct{}, 64)
merkles[hex.EncodeToString(idx.RecordMetadata)] = struct{}{}
for _, streams := range idx.Metadata {
for _, v := range streams {
merkles[hex.EncodeToString(v)] = struct{}{}
}
}
switch {
case omitAllFiles:
// Don't include any files
case len(filenames) > 0:
// Only included the specified files
filesToInclude := make(map[string]struct{}, len(filenames))
for _, v := range filenames {
filesToInclude[v] = struct{}{}
}
for fn, v := range idx.Files {
if _, ok := filesToInclude[fn]; ok {
merkles[hex.EncodeToString(v)] = struct{}{}
}
}
default:
// Include all files
for _, v := range idx.Files {
merkles[hex.EncodeToString(v)] = struct{}{}
}
}
// Walk the tree and extract the record content keys
keys := make([]string, 0, len(idx.Metadata)+len(idx.Files)+1)
for _, v := range leaves {
_, ok := merkles[hex.EncodeToString(v.MerkleLeafHash)]
if !ok {
// Not part of the record content
continue
}
// Leaf is part of record content. Save the kv store key.
ed, err := extraDataDecode(v.ExtraData)
if err != nil {
return nil, err
}
var key string
switch idx.State {
case backend.StateVetted:
// If the record is vetted the content may exist in the store
// as both an encrypted blob and a plain text blob. Always pull
// the plaintext blob.
key = ed.storeKeyNoPrefix()
default:
// Pull the encrypted blob
key = ed.storeKey()
}
keys = append(keys, key)
}
// Get record content from store
blobs, err := t.store.Get(keys)
if err != nil {
return nil, fmt.Errorf("store Get: %v", err)
}
if len(keys) != len(blobs) {
// One or more blobs were not found. This is allowed since the
// blobs for a censored record will not exist, but the record
// metadata and metadata streams should still be returned.
log.Tracef("Blobs not found %v: want %v, got %v",
treeID, len(keys), len(blobs))
}
// Decode blobs
entries := make([]store.BlobEntry, 0, len(keys))
// To ensure that the ordering of the record's files and metadata streams
// is always consistent, we need iterate over the blobs map in a
// deterministic manner, which requires sorting the map keys.
sortedKeys := getSortedKeys(blobs)
for _, key := range sortedKeys {
v := blobs[key]
be, err := store.Deblob(v)
if err != nil {
return nil, err
}
entries = append(entries, *be)
}
// Decode blob entries
var (
recordMD *backend.RecordMetadata
metadata = make([]backend.MetadataStream, 0, len(idx.Metadata))
files = make([]backend.File, 0, len(idx.Files))
)
for _, v := range entries {
// Decode the data hint
b, err := base64.StdEncoding.DecodeString(v.DataHint)
if err != nil {
return nil, fmt.Errorf("decode DataHint: %v", err)
}
var dd store.DataDescriptor
err = json.Unmarshal(b, &dd)
if err != nil {
return nil, fmt.Errorf("unmarshal DataHint: %v", err)
}
if dd.Type != store.DataTypeStructure {
return nil, fmt.Errorf("invalid data type; got %v, want %v",
dd.Type, store.DataTypeStructure)
}
// Decode the data
b, err = base64.StdEncoding.DecodeString(v.Data)
if err != nil {
return nil, fmt.Errorf("decode Data: %v", err)
}
digest, err := hex.DecodeString(v.Digest)
if err != nil {
return nil, fmt.Errorf("decode Hash: %v", err)
}
if !bytes.Equal(util.Digest(b), digest) {
return nil, fmt.Errorf("data is not coherent; got %x, want %x",
util.Digest(b), digest)
}
switch dd.Descriptor {
case dataDescriptorRecordMetadata:
var rm backend.RecordMetadata
err = json.Unmarshal(b, &rm)
if err != nil {
return nil, fmt.Errorf("unmarshal RecordMetadata: %v", err)
}
recordMD = &rm
case dataDescriptorMetadataStream:
var ms backend.MetadataStream
err = json.Unmarshal(b, &ms)
if err != nil {
return nil, fmt.Errorf("unmarshal MetadataStream: %v", err)
}
metadata = append(metadata, ms)
case dataDescriptorFile:
var f backend.File
err = json.Unmarshal(b, &f)
if err != nil {
return nil, fmt.Errorf("unmarshal File: %v", err)
}
files = append(files, f)
default:
return nil, fmt.Errorf("invalid descriptor %v", dd.Descriptor)
}
}
return &backend.Record{
RecordMetadata: *recordMD,
Metadata: metadata,
Files: files,
}, nil
}
// getSortedKeys accepts a map of record blobs indexed by string keys,
// and it returns the keys in a sorted slice.
func getSortedKeys(blobs map[string][]byte) []string {
keys := make([]string, 0, len(blobs))
for k := range blobs {
keys = append(keys, k)
}
// Sort keys
sort.Strings(keys)
return keys
}
// Record returns the specified version of the record.
func (t *Tstore) Record(token []byte, version uint32) (*backend.Record, error) {
log.Tracef("Record: %x %v", token, version)
// Read methods are allowed to use short tokens. Lookup the full
// length token.
var err error
token, err = t.fullLengthToken(token)
if err != nil {
return nil, err
}
treeID := treeIDFromToken(token)
return t.record(treeID, version, []string{}, false)
}
// RecordLatest returns the latest version of a record.
func (t *Tstore) RecordLatest(token []byte) (*backend.Record, error) {
log.Tracef("RecordLatest: %x", token)
// Read methods are allowed to use short tokens. Lookup the full
// length token.
var err error
token, err = t.fullLengthToken(token)
if err != nil {
return nil, err
}
treeID := treeIDFromToken(token)
return t.record(treeID, 0, []string{}, false)
}
// RecordPartial returns a partial record. This method gives the caller fine
// grained control over what version and what files are returned. The only
// required field is the token. All other fields are optional.
//
// Version is used to request a specific version of a record. If no version is
// provided then the most recent version of the record will be returned.
//
// Filenames can be used to request specific files. If filenames is not empty
// then the specified files will be the only files returned.
//
// OmitAllFiles can be used to retrieve a record without any of the record
// files. This supersedes the filenames argument.
func (t *Tstore) RecordPartial(token []byte, version uint32, filenames []string, omitAllFiles bool) (*backend.Record, error) {
log.Tracef("RecordPartial: %x %v %v %v",
token, version, omitAllFiles, filenames)
// Read methods are allowed to use short tokens. Lookup the full
// length token.
var err error
token, err = t.fullLengthToken(token)
if err != nil {
return nil, err
}
treeID := treeIDFromToken(token)
return t.record(treeID, version, filenames, omitAllFiles)
}
// RecordState returns the state of a record. This call does not require
// retrieving any blobs from the kv store. The record state can be derived from
// only the tlog leaves.
func (t *Tstore) RecordState(token []byte) (backend.StateT, error) {
log.Tracef("RecordState: %x", token)
// Read methods are allowed to use short tokens. Lookup the full
// length token.
var err error
token, err = t.fullLengthToken(token)
if err != nil {
return backend.StateInvalid, err
}
treeID := treeIDFromToken(token)
leaves, err := t.leavesAll(treeID)
if err != nil {
return backend.StateInvalid, err
}
if recordIsVetted(leaves) {
return backend.StateVetted, nil
}
return backend.StateUnvetted, nil
}
// timestamp returns the timestamp given a tlog tree merkle leaf hash.
func (t *Tstore) timestamp(treeID int64, merkleLeafHash []byte, leaves []*trillian.LogLeaf) (*backend.Timestamp, error) {
// Find the leaf
var l *trillian.LogLeaf
for _, v := range leaves {
if bytes.Equal(merkleLeafHash, v.MerkleLeafHash) {
l = v
break
}
}
if l == nil {
return nil, fmt.Errorf("leaf not found")
}
// Get blob entry from the kv store
ed, err := extraDataDecode(l.ExtraData)
if err != nil {
return nil, err
}
blobs, err := t.store.Get([]string{ed.storeKey()})
if err != nil {
return nil, fmt.Errorf("store get: %v", err)
}
// Extract the data blob. Its possible for the data blob to not
// exist if it has been censored. This is ok. We'll still return
// the rest of the timestamp.
var data []byte
if len(blobs) == 1 {
b, ok := blobs[ed.storeKey()]
if !ok {
return nil, fmt.Errorf("blob not found %v", ed.storeKey())
}
be, err := store.Deblob(b)
if err != nil {
return nil, err
}
data, err = base64.StdEncoding.DecodeString(be.Data)
if err != nil {
return nil, err
}
// Sanity check
if !bytes.Equal(l.LeafValue, util.Digest(data)) {
return nil, fmt.Errorf("data digest does not match leaf value")
}
}
// Setup timestamp
ts := backend.Timestamp{
Data: string(data),
Digest: hex.EncodeToString(l.LeafValue),
Proofs: []backend.Proof{},
}
// Get the anchor record for this leaf
a, err := t.anchorForLeaf(treeID, merkleLeafHash, leaves)
if err != nil {
if err == errAnchorNotFound {
// This data has not been anchored yet
return &ts, nil
}
return nil, fmt.Errorf("anchor: %v", err)
}
// Get trillian inclusion proof
p, err := t.tlog.InclusionProof(treeID, l.MerkleLeafHash, a.LogRoot)
if err != nil {
return nil, fmt.Errorf("InclusionProof %v %x: %v",
treeID, l.MerkleLeafHash, err)
}
// Setup proof for data digest inclusion in the log merkle root
edt := backend.ExtraDataTrillianRFC6962{
LeafIndex: p.LeafIndex,
TreeSize: int64(a.LogRoot.TreeSize),
}
extraData, err := json.Marshal(edt)
if err != nil {
return nil, err
}
merklePath := make([]string, 0, len(p.Hashes))
for _, v := range p.Hashes {
merklePath = append(merklePath, hex.EncodeToString(v))
}
trillianProof := backend.Proof{
Type: backend.ProofTypeTrillianRFC6962,
Digest: ts.Digest,
MerkleRoot: hex.EncodeToString(a.LogRoot.RootHash),
MerklePath: merklePath,
ExtraData: string(extraData),
}
// Setup proof for log merkle root inclusion in the dcrtime merkle
// root
if a.VerifyDigest.Digest != trillianProof.MerkleRoot {
return nil, fmt.Errorf("trillian merkle root not anchored")
}
var (
numLeaves = a.VerifyDigest.ChainInformation.MerklePath.NumLeaves
hashes = a.VerifyDigest.ChainInformation.MerklePath.Hashes
flags = a.VerifyDigest.ChainInformation.MerklePath.Flags
)
edd := backend.ExtraDataDcrtime{
NumLeaves: numLeaves,
Flags: base64.StdEncoding.EncodeToString(flags),
}
extraData, err = json.Marshal(edd)
if err != nil {
return nil, err
}
merklePath = make([]string, 0, len(hashes))
for _, v := range hashes {
merklePath = append(merklePath, hex.EncodeToString(v[:]))