forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
root_metadata.go
1098 lines (945 loc) · 36.8 KB
/
root_metadata.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 2016 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.
package libkbfs
import (
"fmt"
"reflect"
"strings"
"time"
"github.com/keybase/client/go/kbfs/data"
"github.com/keybase/client/go/kbfs/idutil"
"github.com/keybase/client/go/kbfs/kbfscodec"
"github.com/keybase/client/go/kbfs/kbfscrypto"
"github.com/keybase/client/go/kbfs/kbfsmd"
"github.com/keybase/client/go/kbfs/libkey"
"github.com/keybase/client/go/kbfs/tlf"
"github.com/keybase/client/go/kbfs/tlfhandle"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/logger"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/keybase/go-codec/codec"
"github.com/pkg/errors"
"golang.org/x/net/context"
)
// PrivateMetadata contains the portion of metadata that's secret for private
// directories
type PrivateMetadata struct {
// directory entry for the root directory block
Dir data.DirEntry
// m_f as described in § 4.1.1 of https://keybase.io/docs/crypto/kbfs.
TLFPrivateKey kbfscrypto.TLFPrivateKey
// The block changes done as part of the update that created this MD
Changes BlockChanges
// The last revision up to and including which garbage collection
// was performed on this TLF.
LastGCRevision kbfsmd.Revision `codec:"lgc"`
codec.UnknownFieldSetHandler
// When the above Changes field gets unembedded into its own
// block, we may want to temporarily keep around the old
// BlockChanges for easy reference.
cachedChanges BlockChanges
}
type verboseOp struct {
op
indent string
}
func (o verboseOp) String() string {
return o.op.StringWithRefs(o.indent)
}
// DumpPrivateMetadata returns a detailed dump of the given
// PrivateMetadata's contents.
func DumpPrivateMetadata(
codec kbfscodec.Codec, serializedPMDLength int, pmd PrivateMetadata) (string, error) {
s := fmt.Sprintf("Size: %d bytes\n", serializedPMDLength)
eq, err := kbfscodec.Equal(codec, pmd, PrivateMetadata{})
if err != nil {
return "", err
}
if eq {
s += "<Undecryptable>\n"
} else {
c := kbfsmd.DumpConfig()
// Hardcode the indent level, which depends on the
// position of the Ops list.
indent := strings.Repeat(c.Indent, 4)
var pmdCopy PrivateMetadata
kbfscodec.Update(codec, &pmdCopy, pmd)
ops := pmdCopy.Changes.Ops
for i, op := range ops {
ops[i] = verboseOp{op, indent}
}
s += c.Sdump(pmdCopy)
}
return s, nil
}
func (p PrivateMetadata) checkValid() error {
for i, op := range p.Changes.Ops {
err := op.checkValid()
if err != nil {
return fmt.Errorf("op[%d]=%v invalid: %v", i, op, err)
}
}
return nil
}
// ChangesBlockInfo returns the block info for any unembedded changes.
func (p PrivateMetadata) ChangesBlockInfo() data.BlockInfo {
return p.cachedChanges.Info
}
// A RootMetadata is a BareRootMetadata but with a deserialized
// PrivateMetadata. However, note that it is possible that the
// PrivateMetadata has to be left serialized due to not having the
// right keys.
type RootMetadata struct {
bareMd kbfsmd.MutableRootMetadata
// ExtraMetadata currently contains key bundles for post-v2
// metadata.
extra kbfsmd.ExtraMetadata
// The plaintext, deserialized PrivateMetadata
//
// TODO: This should really be a pointer so that it's more
// clear when the data has been successfully deserialized.
data PrivateMetadata
// The TLF handle for this MD. May be nil if this object was
// deserialized (more common on the server side).
tlfHandle *tlfhandle.Handle
}
var _ libkey.KeyMetadata = (*RootMetadata)(nil)
// makeRootMetadata makes a RootMetadata object from the given
// parameters.
func makeRootMetadata(bareMd kbfsmd.MutableRootMetadata,
extra kbfsmd.ExtraMetadata, handle *tlfhandle.Handle) *RootMetadata {
if bareMd == nil {
panic("nil kbfsmd.MutableRootMetadata")
}
// extra can be nil.
if handle == nil {
panic("nil handle")
}
return &RootMetadata{
bareMd: bareMd,
extra: extra,
tlfHandle: handle,
}
}
// makeInitialRootMetadata creates a new RootMetadata with the given
// MetadataVer, revision RevisionInitial, and the given TLF ID
// and handle. Note that if the given ID/handle are private, rekeying
// must be done separately.
func makeInitialRootMetadata(
ver kbfsmd.MetadataVer, tlfID tlf.ID, h *tlfhandle.Handle) (*RootMetadata, error) {
bh, err := h.ToBareHandle()
if err != nil {
return nil, err
}
bareMD, err := kbfsmd.MakeInitialRootMetadata(ver, tlfID, bh)
if err != nil {
return nil, err
}
// Need to keep the TLF handle around long enough to rekey the
// metadata for the first time.
rmd := makeRootMetadata(bareMD, nil, h)
// The initial revision never has any unrefs, so set the
// last GC revision to 1 to avoid having to walk backwards
// through all the MDs during the first QR for this TLF.
rmd.data.LastGCRevision = kbfsmd.RevisionInitial
return rmd, nil
}
// Data returns the private metadata of this RootMetadata.
func (md *RootMetadata) Data() *PrivateMetadata {
return &md.data
}
// GetRootDirEntry implements the KeyMetadataWithRootDirEntry
// interface for RootMetadata.
func (md *RootMetadata) GetRootDirEntry() data.DirEntry {
return md.data.Dir
}
// Extra returns the extra metadata of this RootMetadata.
func (md *RootMetadata) Extra() kbfsmd.ExtraMetadata {
return md.extra
}
// IsReadable returns true if the private metadata can be read.
func (md *RootMetadata) IsReadable() bool {
return md.TlfID().Type() == tlf.Public || md.data.Dir.IsInitialized()
}
func (md *RootMetadata) clearLastRevision() {
md.ClearBlockChanges()
// remove the copied flag (if any.)
md.clearWriterMetadataCopiedBit()
}
func (md *RootMetadata) deepCopy(codec kbfscodec.Codec) (*RootMetadata, error) {
brmdCopy, err := md.bareMd.DeepCopy(codec)
if err != nil {
return nil, err
}
var extraCopy kbfsmd.ExtraMetadata
if md.extra != nil {
extraCopy, err = md.extra.DeepCopy(codec)
if err != nil {
return nil, err
}
}
handleCopy := md.tlfHandle.DeepCopy()
rmd := makeRootMetadata(brmdCopy, extraCopy, handleCopy)
err = kbfscodec.Update(codec, &rmd.data, md.data)
if err != nil {
return nil, err
}
err = kbfscodec.Update(
codec, &rmd.data.cachedChanges, md.data.cachedChanges)
if err != nil {
return nil, err
}
// Preserve all the final op paths in the copy.
for i, op := range md.data.Changes.Ops {
rmd.data.Changes.Ops[i].setFinalPath(op.getFinalPath())
}
return rmd, nil
}
// MakeSuccessor returns a complete copy of this RootMetadata (but
// with cleared block change lists and cleared serialized metadata),
// with the revision incremented and a correct backpointer.
func (md *RootMetadata) MakeSuccessor(
ctx context.Context, latestMDVer kbfsmd.MetadataVer, codec kbfscodec.Codec,
keyManager KeyManager, merkleGetter idutil.MerkleRootGetter,
teamKeyer teamKeysGetter, osg idutil.OfflineStatusGetter, mdID kbfsmd.ID,
isWriter bool) (*RootMetadata, error) {
if mdID == (kbfsmd.ID{}) {
return nil, errors.New("Empty MdID in MakeSuccessor")
}
if md.IsFinal() {
return nil, kbfsmd.MetadataIsFinalError{}
}
isReadableAndWriter := md.IsReadable() && isWriter
brmdCopy, extraCopy, err := md.bareMd.MakeSuccessorCopy(
codec, md.extra, latestMDVer,
func() ([]kbfscrypto.TLFCryptKey, error) {
return keyManager.GetTLFCryptKeyOfAllGenerations(ctx, md)
}, isReadableAndWriter)
if err != nil {
return nil, err
}
handleCopy := md.tlfHandle.DeepCopy()
newMd := makeRootMetadata(brmdCopy, extraCopy, handleCopy)
if err := kbfscodec.Update(codec, &newMd.data, md.data); err != nil {
return nil, err
}
if isReadableAndWriter {
newMd.clearLastRevision()
// clear the serialized data.
newMd.SetSerializedPrivateMetadata(nil)
if newMd.TypeForKeying() == tlf.TeamKeying {
tid, err := handleCopy.FirstResolvedWriter().AsTeam()
if err != nil {
return nil, err
}
offline := keybase1.OfflineAvailability_NONE
if osg != nil {
offline = osg.OfflineAvailabilityForID(md.TlfID())
}
_, keyGen, err := teamKeyer.GetTeamTLFCryptKeys(
ctx, tid, kbfsmd.UnspecifiedKeyGen, offline)
if err != nil {
return nil, err
}
newMd.bareMd.SetLatestKeyGenerationForTeamTLF(keyGen)
}
} else {
// if we can't read it it means we're simply setting the rekey bit
// and copying the previous data.
newMd.SetRekeyBit()
newMd.SetWriterMetadataCopiedBit()
}
newMd.SetPrevRoot(mdID)
// bump revision
if md.Revision() < kbfsmd.RevisionInitial {
return nil, errors.New("MD with invalid revision")
}
newMd.SetRevision(md.Revision() + 1)
return newMd, nil
}
// MakeSuccessorWithNewHandle does the same thing as MakeSuccessor,
// plus it changes the handle. (The caller is responsible for
// ensuring that the handle change is valid.)
func (md *RootMetadata) MakeSuccessorWithNewHandle(
ctx context.Context, newHandle *tlfhandle.Handle, latestMDVer kbfsmd.MetadataVer,
codec kbfscodec.Codec, keyManager KeyManager,
merkleGetter idutil.MerkleRootGetter, teamKeyer teamKeysGetter,
osg idutil.OfflineStatusGetter, mdID kbfsmd.ID, isWriter bool) (
*RootMetadata, error) {
mdCopy, err := md.deepCopy(codec)
if err != nil {
return nil, err
}
mdCopy.extra = nil
mdCopy.tlfHandle = newHandle.DeepCopy()
mdCopy.SetWriters(newHandle.ResolvedWriters())
// Readers are not tracked explicitly in the MD, but their key
// bundles are cleared out with the `ClearForV4Migration()` call
// below.
mdCopy.SetUnresolvedWriters(newHandle.UnresolvedWriters())
mdCopy.SetUnresolvedReaders(newHandle.UnresolvedReaders())
mdCopy.bareMd.ClearForV4Migration()
return mdCopy.MakeSuccessor(
ctx, latestMDVer, codec, keyManager, merkleGetter, teamKeyer, osg,
mdID, isWriter)
}
// GetTlfHandle returns the TlfHandle for this RootMetadata.
func (md *RootMetadata) GetTlfHandle() *tlfhandle.Handle {
if md.tlfHandle == nil {
panic(fmt.Sprintf("RootMetadata %v with no handle", md))
}
return md.tlfHandle
}
// TypeForKeying returns the keying type for the RootMetadata.
func (md *RootMetadata) TypeForKeying() tlf.KeyingType {
return md.bareMd.TypeForKeying()
}
// MakeBareTlfHandle makes a BareTlfHandle for this
// RootMetadata. Should be used only by servers and MDOps.
func (md *RootMetadata) MakeBareTlfHandle() (tlf.Handle, error) {
if md.tlfHandle != nil {
panic(errors.New("MakeBareTlfHandle called when md.tlfHandle exists"))
}
return md.bareMd.MakeBareTlfHandle(md.extra)
}
// IsInitialized returns whether or not this RootMetadata has been initialized
func (md *RootMetadata) IsInitialized() bool {
keyGen := md.LatestKeyGeneration()
if md.TypeForKeying() == tlf.PublicKeying {
return keyGen == kbfsmd.PublicKeyGen
}
// The data is only initialized once we have at least one set of keys
return keyGen >= kbfsmd.FirstValidKeyGen
}
// AddRefBlock adds the newly-referenced block to the add block change list.
func (md *RootMetadata) AddRefBlock(info data.BlockInfo) {
md.AddRefBytes(uint64(info.EncodedSize))
md.AddDiskUsage(uint64(info.EncodedSize))
md.data.Changes.AddRefBlock(info.BlockPointer)
}
// AddUnrefBlock adds the newly-unreferenced block to the add block change list.
func (md *RootMetadata) AddUnrefBlock(info data.BlockInfo) {
if info.EncodedSize > 0 {
md.AddUnrefBytes(uint64(info.EncodedSize))
md.SetDiskUsage(md.DiskUsage() - uint64(info.EncodedSize))
md.data.Changes.AddUnrefBlock(info.BlockPointer)
}
}
// AddUpdate adds the newly-updated block to the add block change list.
func (md *RootMetadata) AddUpdate(oldInfo data.BlockInfo, newInfo data.BlockInfo) {
md.AddUnrefBytes(uint64(oldInfo.EncodedSize))
md.AddRefBytes(uint64(newInfo.EncodedSize))
md.AddDiskUsage(uint64(newInfo.EncodedSize))
md.SetDiskUsage(md.DiskUsage() - uint64(oldInfo.EncodedSize))
md.data.Changes.AddUpdate(oldInfo.BlockPointer, newInfo.BlockPointer)
}
// AddOp starts a new operation for this MD update. Subsequent
// AddRefBlock, AddUnrefBlock, and AddUpdate calls will be applied to
// this operation.
func (md *RootMetadata) AddOp(o op) {
md.data.Changes.AddOp(o)
}
// ClearBlockChanges resets the block change lists to empty for this
// RootMetadata.
func (md *RootMetadata) ClearBlockChanges() {
md.SetRefBytes(0)
md.SetUnrefBytes(0)
md.SetMDRefBytes(0)
md.data.Changes.sizeEstimate = 0
md.data.Changes.Info = data.BlockInfo{}
md.data.Changes.Ops = nil
}
// SetLastGCRevision sets the last revision up to and including which
// garbage collection was performed on this TLF.
func (md *RootMetadata) SetLastGCRevision(rev kbfsmd.Revision) {
md.data.LastGCRevision = rev
}
// updateFromTlfHandle updates the current RootMetadata's fields to
// reflect the given handle, which must be the result of running the
// current handle with ResolveAgain().
func (md *RootMetadata) updateFromTlfHandle(newHandle *tlfhandle.Handle) error {
// TODO: Strengthen check, e.g. make sure every writer/reader
// in the old handle is also a writer/reader of the new
// handle.
valid := true
newBareHandle, err := newHandle.ToBareHandle()
if err != nil {
return err
}
switch md.TypeForKeying() {
case tlf.PrivateKeying:
// Private-keyed TLFs can move to team keying, but not to
// public keying.
valid = newBareHandle.TypeForKeying() != tlf.PublicKeying
case tlf.PublicKeying:
// Public-keyed TLFs can move to team keying, but not to
// private keying.
valid = newBareHandle.TypeForKeying() != tlf.PrivateKeying
case tlf.TeamKeying:
// Team-keyed TLFs must always remain team-keyed.
valid = newBareHandle.TypeForKeying() == tlf.TeamKeying
default:
return fmt.Errorf("Unexpected keying type %s", md.TypeForKeying())
}
if !valid {
return fmt.Errorf(
"Trying to update rmd with id type=%s, keying type=%s with "+
"handle of type=%s, keying type=%s",
md.TlfID().Type(), md.TypeForKeying(),
newHandle.Type(), newBareHandle.TypeForKeying())
}
if newBareHandle.TypeForKeying() == tlf.PrivateKeying {
md.SetUnresolvedReaders(newHandle.UnresolvedReaders())
} else {
md.SetWriters(newHandle.ResolvedWriters())
}
md.SetUnresolvedWriters(newHandle.UnresolvedWriters())
md.SetConflictInfo(newHandle.ConflictInfo())
md.SetFinalizedInfo(newHandle.FinalizedInfo())
bareHandle, err := md.bareMd.MakeBareTlfHandle(md.extra)
if err != nil {
return err
}
if !reflect.DeepEqual(bareHandle, newBareHandle) {
return fmt.Errorf(
"bareHandle=%+v != newBareHandle=%+v",
bareHandle, newBareHandle)
}
md.tlfHandle = newHandle
return nil
}
// loadCachedBlockChanges swaps any cached block changes so that
// future local accesses to this MD (from the cache) can directly
// access the ops without needing to re-embed the block changes.
// Possibly copies the MD, returns the copy if so, and whether copied.
func (md *RootMetadata) loadCachedBlockChanges(
ctx context.Context, bps blockPutState, log logger.Logger,
vlog *libkb.VDebugLog, codec kbfscodec.Codec) (*RootMetadata, bool) {
if md.data.Changes.Ops != nil {
return md, false
}
md, err := md.deepCopy(codec)
if err != nil {
panic("MD could not be copied")
}
if len(md.data.cachedChanges.Ops) == 0 {
panic("MD with no ops passed to loadCachedBlockChanges")
}
md.data.Changes, md.data.cachedChanges =
md.data.cachedChanges, md.data.Changes
// We always add the ref blocks to the first operation in the MD
// update. Most MD updates will only have one op anyway, and for
// those that have more (like conflict resolution), it is
// arbitrary which one lists them as references, so putting them
// in the first op is the easiest thing to do.
md.data.Changes.Ops[0].
AddRefBlock(md.data.cachedChanges.Info.BlockPointer)
// Find the block and ref any children, if any.
if bps == nil {
panic("Must provide blocks when changes are unembedded")
}
// Prepare a map of all FileBlocks for easy access by fileData
// below.
fileBlocks := make(map[data.BlockPointer]*data.FileBlock)
for _, ptr := range bps.ptrs() {
if block, err := bps.getBlock(ctx, ptr); err == nil {
if fblock, ok := block.(*data.FileBlock); ok {
fileBlocks[ptr] = fblock
}
}
}
// uid, crypto and bsplitter aren't used for simply getting the
// indirect pointers, so set them to nil.
var id keybase1.UserOrTeamID
file := data.Path{
FolderBranch: data.FolderBranch{
Tlf: md.TlfID(), Branch: data.MasterBranch},
Path: []data.PathNode{{
BlockPointer: md.data.cachedChanges.Info.BlockPointer,
Name: data.NewPathPartString(
fmt.Sprintf("<MD with revision %d>", md.Revision()), nil),
}},
}
fd := data.NewFileData(file, id, nil, md.ReadOnly(),
func(_ context.Context, _ libkey.KeyMetadata, ptr data.BlockPointer,
_ data.Path, _ data.BlockReqType) (*data.FileBlock, bool, error) {
fblock, ok := fileBlocks[ptr]
if !ok {
return nil, false, fmt.Errorf(
"No unembedded block change pointer %v in bps", ptr)
}
return fblock, false, nil
},
func(_ context.Context, ptr data.BlockPointer, block data.Block) error {
return nil
}, log, vlog)
infos, err := fd.GetIndirectFileBlockInfos(ctx)
if err != nil {
panic(fmt.Sprintf(
"Couldn't find all unembedded change blocks for %v: %v",
md.data.cachedChanges.Info.BlockPointer, err))
}
for _, info := range infos {
md.data.Changes.Ops[0].AddRefBlock(info.BlockPointer)
}
return md, true
}
// GetTLFCryptKeyParams wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) GetTLFCryptKeyParams(
keyGen kbfsmd.KeyGen, user keybase1.UID, key kbfscrypto.CryptPublicKey) (
kbfscrypto.TLFEphemeralPublicKey, kbfscrypto.EncryptedTLFCryptKeyClientHalf,
kbfscrypto.TLFCryptKeyServerHalfID, bool, error) {
return md.bareMd.GetTLFCryptKeyParams(keyGen, user, key, md.extra)
}
// KeyGenerationsToUpdate wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) KeyGenerationsToUpdate() (kbfsmd.KeyGen, kbfsmd.KeyGen) {
return md.bareMd.KeyGenerationsToUpdate()
}
// LatestKeyGeneration wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) LatestKeyGeneration() kbfsmd.KeyGen {
return md.bareMd.LatestKeyGeneration()
}
// TlfID wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) TlfID() tlf.ID {
if md == nil || md.bareMd == nil {
return tlf.NullID
}
return md.bareMd.TlfID()
}
// LastModifyingWriter wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) LastModifyingWriter() keybase1.UID {
return md.bareMd.LastModifyingWriter()
}
// LastModifyingUser wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) LastModifyingUser() keybase1.UID {
return md.bareMd.GetLastModifyingUser()
}
// RefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) RefBytes() uint64 {
return md.bareMd.RefBytes()
}
// UnrefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) UnrefBytes() uint64 {
return md.bareMd.UnrefBytes()
}
// MDRefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) MDRefBytes() uint64 {
return md.bareMd.MDRefBytes()
}
// DiskUsage wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) DiskUsage() uint64 {
return md.bareMd.DiskUsage()
}
// MDDiskUsage wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) MDDiskUsage() uint64 {
return md.bareMd.MDDiskUsage()
}
// SetRefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetRefBytes(refBytes uint64) {
md.bareMd.SetRefBytes(refBytes)
}
// SetUnrefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetUnrefBytes(unrefBytes uint64) {
md.bareMd.SetUnrefBytes(unrefBytes)
}
// SetMDRefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetMDRefBytes(mdRefBytes uint64) {
md.bareMd.SetMDRefBytes(mdRefBytes)
}
// SetDiskUsage wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetDiskUsage(diskUsage uint64) {
md.bareMd.SetDiskUsage(diskUsage)
}
// SetMDDiskUsage wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetMDDiskUsage(mdDiskUsage uint64) {
md.bareMd.SetMDDiskUsage(mdDiskUsage)
}
// AddRefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) AddRefBytes(refBytes uint64) {
md.bareMd.AddRefBytes(refBytes)
}
// AddUnrefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) AddUnrefBytes(unrefBytes uint64) {
md.bareMd.AddUnrefBytes(unrefBytes)
}
// AddMDRefBytes wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) AddMDRefBytes(mdRefBytes uint64) {
md.bareMd.AddMDRefBytes(mdRefBytes)
}
// AddDiskUsage wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) AddDiskUsage(diskUsage uint64) {
md.bareMd.AddDiskUsage(diskUsage)
}
// AddMDDiskUsage wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) AddMDDiskUsage(mdDiskUsage uint64) {
md.bareMd.AddMDDiskUsage(mdDiskUsage)
}
// IsWriterMetadataCopiedSet wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) IsWriterMetadataCopiedSet() bool {
return md.bareMd.IsWriterMetadataCopiedSet()
}
// IsRekeySet wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) IsRekeySet() bool {
return md.bareMd.IsRekeySet()
}
// IsUnmergedSet wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) IsUnmergedSet() bool {
return md.bareMd.IsUnmergedSet()
}
// Revision wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) Revision() kbfsmd.Revision {
return md.bareMd.RevisionNumber()
}
// MergedStatus wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) MergedStatus() kbfsmd.MergeStatus {
return md.bareMd.MergedStatus()
}
// BID wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) BID() kbfsmd.BranchID {
return md.bareMd.BID()
}
// PrevRoot wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) PrevRoot() kbfsmd.ID {
return md.bareMd.GetPrevRoot()
}
// Version returns the underlying BareRootMetadata version.
func (md *RootMetadata) Version() kbfsmd.MetadataVer {
return md.bareMd.Version()
}
func (md *RootMetadata) clearRekeyBit() {
md.bareMd.ClearRekeyBit()
}
func (md *RootMetadata) clearWriterMetadataCopiedBit() {
md.bareMd.ClearWriterMetadataCopiedBit()
}
// SetUnmerged wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetUnmerged() {
md.bareMd.SetUnmerged()
}
// SetBranchID wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetBranchID(bid kbfsmd.BranchID) {
md.bareMd.SetBranchID(bid)
}
// SetPrevRoot wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetPrevRoot(mdID kbfsmd.ID) {
md.bareMd.SetPrevRoot(mdID)
}
// GetSerializedPrivateMetadata wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) GetSerializedPrivateMetadata() []byte {
return md.bareMd.GetSerializedPrivateMetadata()
}
// GetSerializedWriterMetadata wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) GetSerializedWriterMetadata(
codec kbfscodec.Codec) ([]byte, error) {
return md.bareMd.GetSerializedWriterMetadata(codec)
}
// IsFinal wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) IsFinal() bool {
return md.bareMd.IsFinal()
}
// SetSerializedPrivateMetadata wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetSerializedPrivateMetadata(spmd []byte) {
md.bareMd.SetSerializedPrivateMetadata(spmd)
}
// SetRekeyBit wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetRekeyBit() {
md.bareMd.SetRekeyBit()
}
// SetFinalBit wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetFinalBit() {
md.bareMd.SetFinalBit()
}
// SetWriterMetadataCopiedBit wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetWriterMetadataCopiedBit() {
md.bareMd.SetWriterMetadataCopiedBit()
}
// SetRevision wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetRevision(revision kbfsmd.Revision) {
md.bareMd.SetRevision(revision)
}
// SetWriters wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetWriters(writers []keybase1.UserOrTeamID) {
md.bareMd.SetWriters(writers)
}
// SetUnresolvedReaders wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetUnresolvedReaders(readers []keybase1.SocialAssertion) {
md.bareMd.SetUnresolvedReaders(readers)
}
// SetUnresolvedWriters wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetUnresolvedWriters(writers []keybase1.SocialAssertion) {
md.bareMd.SetUnresolvedWriters(writers)
}
// SetConflictInfo wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetConflictInfo(ci *tlf.HandleExtension) {
md.bareMd.SetConflictInfo(ci)
}
// SetFinalizedInfo wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetFinalizedInfo(fi *tlf.HandleExtension) {
md.bareMd.SetFinalizedInfo(fi)
}
// SetLastModifyingWriter wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetLastModifyingWriter(user keybase1.UID) {
md.bareMd.SetLastModifyingWriter(user)
}
// SetLastModifyingUser wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetLastModifyingUser(user keybase1.UID) {
md.bareMd.SetLastModifyingUser(user)
}
// SetTlfID wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) SetTlfID(tlf tlf.ID) {
md.bareMd.SetTlfID(tlf)
}
// HasKeyForUser wraps the respective method of the underlying BareRootMetadata for convenience.
func (md *RootMetadata) HasKeyForUser(user keybase1.UID) (
bool, error) {
writers, readers, err := md.bareMd.GetUserDevicePublicKeys(md.extra)
if err != nil {
return false, err
}
return len(writers[user]) > 0 || len(readers[user]) > 0, nil
}
// fakeInitialRekey wraps the FakeInitialRekey test function for
// convenience.
func (md *RootMetadata) fakeInitialRekey() {
bh, err := md.tlfHandle.ToBareHandle()
if err != nil {
panic(err)
}
md.extra = kbfsmd.FakeInitialRekey(md.bareMd, bh, kbfscrypto.TLFPublicKey{})
}
// GetBareRootMetadata returns an interface to the underlying serializeable metadata.
func (md *RootMetadata) GetBareRootMetadata() kbfsmd.RootMetadata {
return md.bareMd
}
// AddKeyGeneration adds a new key generation to this revision of metadata.
func (md *RootMetadata) AddKeyGeneration(codec kbfscodec.Codec,
wKeys, rKeys kbfsmd.UserDevicePublicKeys,
ePubKey kbfscrypto.TLFEphemeralPublicKey,
ePrivKey kbfscrypto.TLFEphemeralPrivateKey,
pubKey kbfscrypto.TLFPublicKey,
privKey kbfscrypto.TLFPrivateKey,
currCryptKey, nextCryptKey kbfscrypto.TLFCryptKey) (
serverHalves kbfsmd.UserDeviceKeyServerHalves, err error) {
nextExtra, serverHalves, err := md.bareMd.AddKeyGeneration(
codec, md.extra, wKeys, rKeys, ePubKey, ePrivKey,
pubKey, currCryptKey, nextCryptKey)
if err != nil {
return nil, err
}
md.extra = nextExtra
md.data.TLFPrivateKey = privKey
return serverHalves, nil
}
func (md *RootMetadata) promoteReaders(
readersToPromote map[keybase1.UID]bool) error {
return md.bareMd.PromoteReaders(readersToPromote, md.extra)
}
func (md *RootMetadata) revokeRemovedDevices(
wKeys, rKeys kbfsmd.UserDevicePublicKeys) (
kbfsmd.ServerHalfRemovalInfo, error) {
return md.bareMd.RevokeRemovedDevices(wKeys, rKeys, md.extra)
}
func (md *RootMetadata) updateKeyBundles(
codec kbfscodec.Codec, wKeys, rKeys kbfsmd.UserDevicePublicKeys,
ePubKey kbfscrypto.TLFEphemeralPublicKey,
ePrivKey kbfscrypto.TLFEphemeralPrivateKey,
tlfCryptKeys []kbfscrypto.TLFCryptKey) (
[]kbfsmd.UserDeviceKeyServerHalves, error) {
return md.bareMd.UpdateKeyBundles(codec, md.extra,
wKeys, rKeys, ePubKey, ePrivKey, tlfCryptKeys)
}
func (md *RootMetadata) finalizeRekey(codec kbfscodec.Codec) error {
return md.bareMd.FinalizeRekey(codec, md.extra)
}
func (md *RootMetadata) getUserDevicePublicKeys() (
writers, readers kbfsmd.UserDevicePublicKeys, err error) {
return md.bareMd.GetUserDevicePublicKeys(md.extra)
}
// GetTLFWriterKeyBundleID returns the ID of the externally-stored
// writer key bundle, or the zero value if this object stores it
// internally.
func (md *RootMetadata) GetTLFWriterKeyBundleID() kbfsmd.TLFWriterKeyBundleID {
return md.bareMd.GetTLFWriterKeyBundleID()
}
// GetTLFReaderKeyBundleID returns the ID of the externally-stored
// reader key bundle, or the zero value if this object stores it
// internally.
func (md *RootMetadata) GetTLFReaderKeyBundleID() kbfsmd.TLFReaderKeyBundleID {
return md.bareMd.GetTLFReaderKeyBundleID()
}
// StoresHistoricTLFCryptKeys implements the KeyMetadata interface for RootMetadata.
func (md *RootMetadata) StoresHistoricTLFCryptKeys() bool {
return md.bareMd.StoresHistoricTLFCryptKeys()
}
// GetHistoricTLFCryptKey implements the KeyMetadata interface for RootMetadata.
func (md *RootMetadata) GetHistoricTLFCryptKey(
codec kbfscodec.Codec, keyGen kbfsmd.KeyGen,
currentKey kbfscrypto.TLFCryptKey) (kbfscrypto.TLFCryptKey, error) {
return md.bareMd.GetHistoricTLFCryptKey(
codec, keyGen, currentKey, md.extra)
}
// IsWriter checks that the given user is a valid writer of the TLF
// right now. Implements the KeyMetadata interface for RootMetadata.
func (md *RootMetadata) IsWriter(
ctx context.Context, checker kbfsmd.TeamMembershipChecker,
osg idutil.OfflineStatusGetter, uid keybase1.UID,
verifyingKey kbfscrypto.VerifyingKey) (bool, error) {
h := md.GetTlfHandle()
return IsWriterFromHandle(ctx, h, checker, osg, uid, verifyingKey)
}
// IsReader checks that the given user is a valid reader of the TLF
// right now.
func (md *RootMetadata) IsReader(
ctx context.Context, checker kbfsmd.TeamMembershipChecker,
osg idutil.OfflineStatusGetter, uid keybase1.UID) (bool, error) {
h := md.GetTlfHandle()
return isReaderFromHandle(ctx, h, checker, osg, uid)
}
// A ReadOnlyRootMetadata is a thin wrapper around a
// *RootMetadata. Functions that take a ReadOnlyRootMetadata parameter
// must not modify it, and therefore code that passes a
// ReadOnlyRootMetadata to a function can assume that it is not
// modified by that function. However, callers that convert a
// *RootMetadata to a ReadOnlyRootMetadata may still modify the
// underlying RootMetadata through the original pointer, so care must
// be taken if a function stores a ReadOnlyRootMetadata object past
// the end of the function, or when a function takes both a
// *RootMetadata and a ReadOnlyRootMetadata (see
// decryptMDPrivateData).
type ReadOnlyRootMetadata struct {
*RootMetadata
}
// CheckValidSuccessor makes sure the given ReadOnlyRootMetadata is a
// valid successor to the current one, and returns an error otherwise.
func (md ReadOnlyRootMetadata) CheckValidSuccessor(
currID kbfsmd.ID, nextMd ReadOnlyRootMetadata) error {
return md.bareMd.CheckValidSuccessor(currID, nextMd.bareMd)
}
// ReadOnly makes a ReadOnlyRootMetadata from the current
// *RootMetadata.
func (md *RootMetadata) ReadOnly() ReadOnlyRootMetadata {
return ReadOnlyRootMetadata{md}
}
// ImmutableRootMetadata is a thin wrapper around a
// ReadOnlyRootMetadata that takes ownership of it and does not ever
// modify it again. Thus, its MdID can be calculated and
// stored. Unlike ReadOnlyRootMetadata, ImmutableRootMetadata objects
// can be assumed to never alias a (modifiable) *RootMetadata.
type ImmutableRootMetadata struct {
ReadOnlyRootMetadata
mdID kbfsmd.ID
lastWriterVerifyingKey kbfscrypto.VerifyingKey
// localTimestamp represents the time at which the MD update was
// applied at the server, adjusted for the local clock. So for
// example, it can be used to show how long ago a particular
// update happened (e.g., "5 hours ago"). Note that the update
// time supplied by the server is technically untrusted (i.e., not
// signed by a writer of the TLF, only provided by the server).
// If this ImmutableRootMetadata was generated locally and still
// persists in the journal or in the cache, localTimestamp comes
// directly from the local clock.
localTimestamp time.Time
// putToServer indicates whether this MD has been put successfully
// to the remote server (e.g., it isn't just local to the
// process's journal).
putToServer bool
}
// MakeImmutableRootMetadata makes a new ImmutableRootMetadata from
// the given RMD and its corresponding MdID.
func MakeImmutableRootMetadata(
rmd *RootMetadata, writerVerifyingKey kbfscrypto.VerifyingKey,
mdID kbfsmd.ID, localTimestamp time.Time,
putToServer bool) ImmutableRootMetadata {
if writerVerifyingKey == (kbfscrypto.VerifyingKey{}) {
panic("zero writerVerifyingKey passed to MakeImmutableRootMetadata")