-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
root_metadata_v2.go
1406 lines (1217 loc) · 42.7 KB
/
root_metadata_v2.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 kbfsmd
import (
"errors"
"fmt"
"github.com/keybase/client/go/kbfs/kbfscodec"
"github.com/keybase/client/go/kbfs/kbfscrypto"
"github.com/keybase/client/go/kbfs/tlf"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/keybase/go-codec/codec"
"golang.org/x/net/context"
)
// WriterMetadataV2 stores the metadata for a TLF that is
// only editable by users with writer permissions.
//
// NOTE: Don't add new fields to this type! Instead, add them to
// WriterMetadataExtraV2. This is because we want old clients to
// preserve unknown fields, and we're unable to do that for
// WriterMetadata directly because it's embedded in RootMetadata.
type WriterMetadataV2 struct {
// Serialized, possibly encrypted, version of the PrivateMetadata
SerializedPrivateMetadata []byte `codec:"data"`
// The last KB user with writer permissions to this TLF
// who modified this WriterMetadata
LastModifyingWriter keybase1.UID
// For public and single-team TLFs (since those don't have any
// keys at all).
Writers []keybase1.UserOrTeamID `codec:",omitempty"`
// For private TLFs. Writer key generations for this metadata. The
// most recent one is last in the array. Must be same length as
// RootMetadata.RKeys.
WKeys TLFWriterKeyGenerationsV2 `codec:",omitempty"`
// The directory ID, signed over to make verification easier
ID tlf.ID
// The branch ID, currently only set if this is in unmerged per-device history.
BID BranchID
// Flags
WFlags WriterFlags
// Estimated disk usage at this revision
DiskUsage uint64
// Estimated MD disk usage at this revision (for testing only --
// real v2 MDs in the wild won't ever have this set).
MDDiskUsage uint64 `codec:",omitempty"`
// The total number of bytes in new data blocks
RefBytes uint64
// The total number of bytes in unreferenced blocks
UnrefBytes uint64
// The total number of bytes in new MD blocks (for testing only --
// real v2 MDs in the wild won't ever have this set).
MDRefBytes uint64 `codec:",omitempty"`
// TODO: Remove omitempty and omitemptycheckstruct once we use
// a version of go-codec that supports omitemptyrecursive.
Extra WriterMetadataExtraV2 `codec:"x,omitemptyrecursive,omitempty,omitemptycheckstruct"`
}
// ToWriterMetadataV3 converts the WriterMetadataV2 to a
// WriterMetadataV3.
func (wmdV2 *WriterMetadataV2) ToWriterMetadataV3() WriterMetadataV3 {
var wmdV3 WriterMetadataV3
wmdV3.Writers = make([]keybase1.UserOrTeamID, len(wmdV2.Writers))
copy(wmdV3.Writers, wmdV2.Writers)
wmdV3.UnresolvedWriters = make([]keybase1.SocialAssertion, len(wmdV2.Extra.UnresolvedWriters))
copy(wmdV3.UnresolvedWriters, wmdV2.Extra.UnresolvedWriters)
wmdV3.ID = wmdV2.ID
wmdV3.BID = wmdV2.BID
wmdV3.WFlags = wmdV2.WFlags
wmdV3.DiskUsage = wmdV2.DiskUsage
wmdV3.MDDiskUsage = wmdV2.MDDiskUsage
wmdV3.RefBytes = wmdV2.RefBytes
wmdV3.UnrefBytes = wmdV2.UnrefBytes
wmdV3.MDRefBytes = wmdV2.MDRefBytes
if wmdV2.ID.Type() == tlf.Public {
wmdV3.LatestKeyGen = PublicKeyGen
} else {
wmdV3.LatestKeyGen = wmdV2.WKeys.LatestKeyGeneration()
}
return wmdV3
}
// WriterMetadataExtraV2 stores more fields for WriterMetadataV2. (See
// WriterMetadataV2 comments as to why this type is needed.)
type WriterMetadataExtraV2 struct {
UnresolvedWriters []keybase1.SocialAssertion `codec:"uw,omitempty"`
codec.UnknownFieldSetHandler
}
// RootMetadataV2 is the MD that is signed by the reader or
// writer. Unlike RootMetadata, it contains exactly the serializable
// metadata.
type RootMetadataV2 struct {
// The metadata that is only editable by the writer.
//
// TODO: If we ever get a chance to update RootMetadata
// without having to be backwards-compatible, WriterMetadata
// should be unembedded; see comments to WriterMetadata as for
// why.
WriterMetadataV2
// The signature for the writer metadata, to prove
// that it's only been changed by writers.
WriterMetadataSigInfo kbfscrypto.SignatureInfo
// The last KB user who modified this RootMetadata
LastModifyingUser keybase1.UID
// Flags
Flags MetadataFlags
// The revision number
Revision Revision
// Pointer to the previous root block ID
PrevRoot ID
// For private TLFs. Reader key generations for this metadata. The
// most recent one is last in the array. Must be same length as
// WriterMetadata.WKeys. If there are no readers, each generation
// is empty.
RKeys TLFReaderKeyGenerationsV2 `codec:",omitempty"`
// For private TLFs. Any unresolved social assertions for readers.
UnresolvedReaders []keybase1.SocialAssertion `codec:"ur,omitempty"`
// ConflictInfo is set if there's a conflict for the given folder's
// handle after a social assertion resolution.
ConflictInfo *tlf.HandleExtension `codec:"ci,omitempty"`
// FinalizedInfo is set if there are no more valid writer keys capable
// of writing to the given folder.
FinalizedInfo *tlf.HandleExtension `codec:"fi,omitempty"`
codec.UnknownFieldSetHandler
}
// MakeInitialRootMetadataV2 creates a new RootMetadataV2
// object with revision RevisionInitial, and the given TLF ID
// and handle. Note that if the given ID/handle are private, rekeying
// must be done separately.
func MakeInitialRootMetadataV2(tlfID tlf.ID, h tlf.Handle) (
*RootMetadataV2, error) {
if tlfID.Type() != h.Type() {
return nil, errors.New("TlfID and TlfHandle disagree on TLF type")
}
var writers []keybase1.UserOrTeamID
var wKeys TLFWriterKeyGenerationsV2
var rKeys TLFReaderKeyGenerationsV2
if tlfID.Type() == tlf.Private {
wKeys = make(TLFWriterKeyGenerationsV2, 0, 1)
rKeys = make(TLFReaderKeyGenerationsV2, 0, 1)
} else {
writers = make([]keybase1.UserOrTeamID, len(h.Writers))
copy(writers, h.Writers)
}
var unresolvedWriters, unresolvedReaders []keybase1.SocialAssertion
if len(h.UnresolvedWriters) > 0 {
unresolvedWriters = make(
[]keybase1.SocialAssertion, len(h.UnresolvedWriters))
copy(unresolvedWriters, h.UnresolvedWriters)
}
if len(h.UnresolvedReaders) > 0 {
unresolvedReaders = make(
[]keybase1.SocialAssertion, len(h.UnresolvedReaders))
copy(unresolvedReaders, h.UnresolvedReaders)
}
return &RootMetadataV2{
WriterMetadataV2: WriterMetadataV2{
Writers: writers,
WKeys: wKeys,
ID: tlfID,
Extra: WriterMetadataExtraV2{
UnresolvedWriters: unresolvedWriters,
},
},
Revision: RevisionInitial,
RKeys: rKeys,
UnresolvedReaders: unresolvedReaders,
// Normally an MD wouldn't start out with extensions, but this
// is useful for tests.
ConflictInfo: h.ConflictInfo,
FinalizedInfo: h.FinalizedInfo,
}, nil
}
// TlfID implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) TlfID() tlf.ID {
return md.ID
}
// TypeForKeying implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) TypeForKeying() tlf.KeyingType {
return md.TlfID().Type().ToKeyingType()
}
// KeyGenerationsToUpdate implements the RootMetadata interface
// for RootMetadataV2.
func (md *RootMetadataV2) KeyGenerationsToUpdate() (KeyGen, KeyGen) {
latest := md.LatestKeyGeneration()
if latest < FirstValidKeyGen {
return 0, 0
}
// We keep track of all known key generations.
return FirstValidKeyGen, latest + 1
}
// LatestKeyGeneration implements the RootMetadata interface for
// RootMetadataV2.
func (md *RootMetadataV2) LatestKeyGeneration() KeyGen {
if md.ID.Type() == tlf.Public {
return PublicKeyGen
}
return md.WKeys.LatestKeyGeneration()
}
func (md *RootMetadataV2) haveOnlyUserRKeysChanged(
codec kbfscodec.Codec, prevMD *RootMetadataV2,
user keybase1.UID) (bool, error) {
// Require the same number of generations
if len(md.RKeys) != len(prevMD.RKeys) {
return false, nil
}
for i, gen := range md.RKeys {
prevMDGen := prevMD.RKeys[i]
if len(gen.RKeys) != len(prevMDGen.RKeys) {
return false, nil
}
for u, keys := range gen.RKeys {
if u != user {
prevKeys := prevMDGen.RKeys[u]
keysEqual, err :=
kbfscodec.Equal(codec, keys, prevKeys)
if err != nil {
return false, err
}
if !keysEqual {
return false, nil
}
}
}
}
return true, nil
}
// IsValidRekeyRequest implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsValidRekeyRequest(
codec kbfscodec.Codec, prevBareMd RootMetadata,
user keybase1.UID, _, _ ExtraMetadata) (bool, error) {
if !md.IsWriterMetadataCopiedSet() {
// Not a copy.
return false, nil
}
prevMd, ok := prevBareMd.(*RootMetadataV2)
if !ok {
// Not the same type so not a copy.
return false, nil
}
writerEqual, err := kbfscodec.Equal(
codec, md.WriterMetadataV2, prevMd.WriterMetadataV2)
if err != nil {
return false, err
}
if !writerEqual {
// Copy mismatch.
return false, nil
}
writerSigInfoEqual, err := kbfscodec.Equal(codec,
md.WriterMetadataSigInfo, prevMd.WriterMetadataSigInfo)
if err != nil {
return false, err
}
if !writerSigInfoEqual {
// Signature/public key mismatch.
return false, nil
}
onlyUserRKeysChanged, err := md.haveOnlyUserRKeysChanged(
codec, prevMd, user)
if err != nil {
return false, err
}
if !onlyUserRKeysChanged {
// Keys outside of this user's reader key set have changed.
return false, nil
}
return true, nil
}
// MergedStatus implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) MergedStatus() MergeStatus {
if md.WFlags&MetadataFlagUnmerged != 0 {
return Unmerged
}
return Merged
}
// IsRekeySet implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsRekeySet() bool {
return md.Flags&MetadataFlagRekey != 0
}
// IsWriterMetadataCopiedSet implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsWriterMetadataCopiedSet() bool {
return md.Flags&MetadataFlagWriterMetadataCopied != 0
}
// IsFinal implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsFinal() bool {
return md.Flags&MetadataFlagFinal != 0
}
// IsWriter implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsWriter(
_ context.Context, user keybase1.UID, deviceKey kbfscrypto.CryptPublicKey,
_ kbfscrypto.VerifyingKey, _ TeamMembershipChecker, _ ExtraMetadata,
_ keybase1.OfflineAvailability) (bool, error) {
if md.ID.Type() != tlf.Private {
for _, w := range md.Writers {
if w == user.AsUserOrTeam() {
return true, nil
}
}
return false, nil
}
return md.WKeys.IsWriter(user, deviceKey), nil
}
// IsReader implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsReader(
_ context.Context, user keybase1.UID, deviceKey kbfscrypto.CryptPublicKey,
_ TeamMembershipChecker, _ ExtraMetadata,
_ keybase1.OfflineAvailability) (bool, error) {
switch md.ID.Type() {
case tlf.Public:
return true, nil
case tlf.Private:
return md.RKeys.IsReader(user, deviceKey), nil
case tlf.SingleTeam:
// There are no read-only users of single-team TLFs.
return false, nil
default:
panic(fmt.Sprintf("Unexpected TLF type: %s", md.ID.Type()))
}
}
func (md *RootMetadataV2) deepCopy(
codec kbfscodec.Codec) (*RootMetadataV2, error) {
var newMd RootMetadataV2
if err := kbfscodec.Update(codec, &newMd, md); err != nil {
return nil, err
}
return &newMd, nil
}
// DeepCopy implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) DeepCopy(
codec kbfscodec.Codec) (MutableRootMetadata, error) {
return md.deepCopy(codec)
}
// MakeSuccessorCopy implements the ImmutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) MakeSuccessorCopy(
codec kbfscodec.Codec, extra ExtraMetadata, latestMDVer MetadataVer,
tlfCryptKeyGetter func() ([]kbfscrypto.TLFCryptKey, error),
isReadableAndWriter bool) (
MutableRootMetadata, ExtraMetadata, error) {
if !isReadableAndWriter || (latestMDVer < SegregatedKeyBundlesVer) {
// Continue with the current version. If we're just a reader,
// or can't decrypt the MD, we have to continue with v2
// because we can't just copy a v2 signature into a v3 MD
// blindly.
mdCopy, err := md.makeSuccessorCopyV2(
codec, isReadableAndWriter)
if err != nil {
return nil, nil, err
}
return mdCopy, nil, nil
}
// Upconvert to the new version.
return md.makeSuccessorCopyV3(codec, tlfCryptKeyGetter)
}
func (md *RootMetadataV2) makeSuccessorCopyV2(
codec kbfscodec.Codec, isReadableAndWriter bool) (
*RootMetadataV2, error) {
mdCopy, err := md.deepCopy(codec)
if err != nil {
return nil, err
}
if isReadableAndWriter {
mdCopy.WriterMetadataSigInfo = kbfscrypto.SignatureInfo{}
}
return mdCopy, nil
}
func (md *RootMetadataV2) makeSuccessorCopyV3(
codec kbfscodec.Codec,
tlfCryptKeyGetter func() ([]kbfscrypto.TLFCryptKey, error)) (
*RootMetadataV3, ExtraMetadata, error) {
mdV3 := &RootMetadataV3{}
// Fill out the writer metadata.
mdV3.WriterMetadata = md.WriterMetadataV2.ToWriterMetadataV3()
// Have this as ExtraMetadata so we return an untyped nil
// instead of a typed nil.
var extraCopy ExtraMetadata
if md.LatestKeyGeneration() != PublicKeyGen && md.WKeys != nil {
// Fill out the writer key bundle.
wkbV2, wkbV3, err := md.WKeys.ToTLFWriterKeyBundleV3(
codec, tlfCryptKeyGetter)
if err != nil {
return nil, nil, err
}
mdV3.WriterMetadata.WKeyBundleID, err =
MakeTLFWriterKeyBundleID(codec, wkbV3)
if err != nil {
return nil, nil, err
}
// Fill out the reader key bundle. wkbV2 is passed
// because in V2 metadata ephemeral public keys for
// readers were sometimes in the writer key bundles.
rkbV3, err := md.RKeys.ToTLFReaderKeyBundleV3(codec, wkbV2)
if err != nil {
return nil, nil, err
}
mdV3.RKeyBundleID, err =
MakeTLFReaderKeyBundleID(codec, rkbV3)
if err != nil {
return nil, nil, err
}
extraCopy = NewExtraMetadataV3(wkbV3, rkbV3, true, true)
}
mdV3.LastModifyingUser = md.LastModifyingUser
mdV3.Flags = md.Flags
mdV3.Revision = md.Revision // Incremented by the caller.
// PrevRoot is set by the caller.
mdV3.UnresolvedReaders = make([]keybase1.SocialAssertion, len(md.UnresolvedReaders))
copy(mdV3.UnresolvedReaders, md.UnresolvedReaders)
if md.ConflictInfo != nil {
ci := *md.ConflictInfo
mdV3.ConflictInfo = &ci
}
// Metadata with finalized info is never succeeded.
if md.FinalizedInfo != nil {
// Shouldn't be possible.
return nil, nil, errors.New("Non-nil finalized info")
}
return mdV3, extraCopy, nil
}
// CheckValidSuccessor implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) CheckValidSuccessor(
currID ID, nextMd RootMetadata) error {
// (1) Verify current metadata is non-final.
if md.IsFinal() {
return MetadataIsFinalError{}
}
// (2) Check TLF ID.
if nextMd.TlfID() != md.ID {
return MDTlfIDMismatch{
CurrID: md.ID,
NextID: nextMd.TlfID(),
}
}
// (3) Check revision.
if nextMd.RevisionNumber() != md.RevisionNumber()+1 {
return MDRevisionMismatch{
Rev: nextMd.RevisionNumber(),
Curr: md.RevisionNumber(),
}
}
// (4) Check PrevRoot pointer.
expectedPrevRoot := currID
if nextMd.IsFinal() {
expectedPrevRoot = md.GetPrevRoot()
}
if nextMd.GetPrevRoot() != expectedPrevRoot {
return MDPrevRootMismatch{
prevRoot: nextMd.GetPrevRoot(),
expectedPrevRoot: expectedPrevRoot,
}
}
// (5) Check branch ID.
if md.MergedStatus() == nextMd.MergedStatus() && md.BID() != nextMd.BID() {
return fmt.Errorf("Unexpected branch ID on successor: %s vs. %s",
md.BID(), nextMd.BID())
} else if md.MergedStatus() == Unmerged && nextMd.MergedStatus() == Merged {
return errors.New("merged MD can't follow unmerged MD")
}
// (6) Check disk usage.
expectedUsage := md.DiskUsage()
if !nextMd.IsWriterMetadataCopiedSet() {
expectedUsage += nextMd.RefBytes() - nextMd.UnrefBytes()
}
if nextMd.DiskUsage() != expectedUsage {
return MDDiskUsageMismatch{
expectedDiskUsage: expectedUsage,
actualDiskUsage: nextMd.DiskUsage(),
}
}
expectedMDUsage := md.MDDiskUsage()
if !nextMd.IsWriterMetadataCopiedSet() {
expectedMDUsage += nextMd.MDRefBytes()
}
if nextMd.MDDiskUsage() != expectedMDUsage {
return MDDiskUsageMismatch{
expectedDiskUsage: expectedMDUsage,
actualDiskUsage: nextMd.MDDiskUsage(),
}
}
// TODO: Check that the successor (bare) TLF handle is the
// same or more resolved.
return nil
}
// CheckValidSuccessorForServer implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) CheckValidSuccessorForServer(
currID ID, nextMd RootMetadata) error {
err := md.CheckValidSuccessor(currID, nextMd)
switch err := err.(type) {
case nil:
break
case MDRevisionMismatch:
return ServerErrorConflictRevision{
Expected: err.Curr + 1,
Actual: err.Rev,
}
case MDPrevRootMismatch:
return ServerErrorConflictPrevRoot{
Expected: err.expectedPrevRoot,
Actual: err.prevRoot,
}
case MDDiskUsageMismatch:
return ServerErrorConflictDiskUsage{
Expected: err.expectedDiskUsage,
Actual: err.actualDiskUsage,
}
default:
return ServerError{Err: err}
}
return nil
}
// MakeBareTlfHandle implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) MakeBareTlfHandle(_ ExtraMetadata) (
tlf.Handle, error) {
var writers, readers []keybase1.UserOrTeamID
if md.ID.Type() == tlf.Private {
if len(md.WKeys) == 0 {
return tlf.Handle{}, errors.New("No writer key generations; need rekey?")
}
if len(md.RKeys) == 0 {
return tlf.Handle{}, errors.New("No reader key generations; need rekey?")
}
wkb := md.WKeys[len(md.WKeys)-1]
rkb := md.RKeys[len(md.RKeys)-1]
writers = make([]keybase1.UserOrTeamID, 0, len(wkb.WKeys))
readers = make([]keybase1.UserOrTeamID, 0, len(rkb.RKeys))
for w := range wkb.WKeys {
writers = append(writers, w.AsUserOrTeam())
}
for r := range rkb.RKeys {
// TODO: Return an error instead if r is
// PublicUID. Maybe return an error if r is in
// WKeys also. Or do all this in
// MakeBareTlfHandle.
if _, ok := wkb.WKeys[r]; !ok &&
r != keybase1.PublicUID {
readers = append(readers, r.AsUserOrTeam())
}
}
} else {
writers = md.Writers
if md.ID.Type() == tlf.Public {
readers = []keybase1.UserOrTeamID{keybase1.PublicUID.AsUserOrTeam()}
}
}
return tlf.MakeHandle(
writers, readers,
md.Extra.UnresolvedWriters, md.UnresolvedReaders,
md.TlfHandleExtensions())
}
// TlfHandleExtensions implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) TlfHandleExtensions() (
extensions []tlf.HandleExtension) {
if md.ConflictInfo != nil {
extensions = append(extensions, *md.ConflictInfo)
}
if md.FinalizedInfo != nil {
extensions = append(extensions, *md.FinalizedInfo)
}
return extensions
}
// PromoteReaders implements the RootMetadata interface for
// RootMetadataV2.
func (md *RootMetadataV2) PromoteReaders(
readersToPromote map[keybase1.UID]bool,
_ ExtraMetadata) error {
if md.TlfID().Type() != tlf.Private {
return InvalidNonPrivateTLFOperation{md.TlfID(), "PromoteReaders", md.Version()}
}
for i, rkb := range md.RKeys {
for reader := range readersToPromote {
dkim, ok := rkb.RKeys[reader]
if !ok {
return fmt.Errorf("Could not find %s in key gen %d",
reader, FirstValidKeyGen+KeyGen(i))
}
// TODO: This may be incorrect, since dkim may
// contain negative EPubKey indices, and the
// upconversion code assumes that writers will
// only contain non-negative EPubKey indices.
//
// See KBFS-1719.
md.WKeys[i].WKeys[reader] = dkim
delete(rkb.RKeys, reader)
}
}
return nil
}
// RevokeRemovedDevices implements the RootMetadata interface for
// RootMetadataV2.
func (md *RootMetadataV2) RevokeRemovedDevices(
updatedWriterKeys, updatedReaderKeys UserDevicePublicKeys,
_ ExtraMetadata) (ServerHalfRemovalInfo, error) {
if md.TlfID().Type() != tlf.Private {
return nil, InvalidNonPrivateTLFOperation{
md.TlfID(), "RevokeRemovedDevices", md.Version()}
}
var wRemovalInfo ServerHalfRemovalInfo
for _, wkb := range md.WKeys {
removalInfo := wkb.WKeys.RemoveDevicesNotIn(updatedWriterKeys)
if wRemovalInfo == nil {
wRemovalInfo = removalInfo
} else {
err := wRemovalInfo.AddGeneration(removalInfo)
if err != nil {
return nil, err
}
}
}
var rRemovalInfo ServerHalfRemovalInfo
for _, rkb := range md.RKeys {
removalInfo := rkb.RKeys.RemoveDevicesNotIn(updatedReaderKeys)
if rRemovalInfo == nil {
rRemovalInfo = removalInfo
} else {
err := rRemovalInfo.AddGeneration(removalInfo)
if err != nil {
return nil, err
}
}
}
return wRemovalInfo.MergeUsers(rRemovalInfo)
}
// getTLFKeyBundles returns the bundles for a given key generation.
// Note that it is legal a writer or a reader to have no keys in their
// bundle, if they only have a Keybase username with no device keys
// yet.
func (md *RootMetadataV2) getTLFKeyBundles(keyGen KeyGen) (
*TLFWriterKeyBundleV2, *TLFReaderKeyBundleV2, error) {
if md.ID.Type() != tlf.Private {
return nil, nil, InvalidNonPrivateTLFOperation{md.ID, "getTLFKeyBundles", md.Version()}
}
if keyGen < FirstValidKeyGen {
return nil, nil, InvalidKeyGenerationError{md.ID, keyGen}
}
i := int(keyGen - FirstValidKeyGen)
if i >= len(md.WKeys) || i >= len(md.RKeys) {
return nil, nil, NewKeyGenerationError{md.ID, keyGen}
}
return &md.WKeys[i], &md.RKeys[i], nil
}
// GetUserDevicePublicKeys implements the RootMetadata interface
// for RootMetadataV2.
func (md *RootMetadataV2) GetUserDevicePublicKeys(_ ExtraMetadata) (
writerDeviceKeys, readerDeviceKeys UserDevicePublicKeys, err error) {
if md.TlfID().Type() != tlf.Private {
return nil, nil, InvalidNonPrivateTLFOperation{
md.TlfID(), "GetUserDevicePublicKeys", md.Version()}
}
if len(md.WKeys) == 0 || len(md.RKeys) == 0 {
return nil, nil, errors.New(
"GetUserDevicePublicKeys called with no key generations (V2)")
}
wUDKIM := md.WKeys[len(md.WKeys)-1]
rUDKIM := md.RKeys[len(md.RKeys)-1]
return wUDKIM.WKeys.ToPublicKeys(), rUDKIM.RKeys.ToPublicKeys(), nil
}
// GetTLFCryptKeyParams implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) GetTLFCryptKeyParams(
keyGen KeyGen, user keybase1.UID, key kbfscrypto.CryptPublicKey,
_ ExtraMetadata) (
kbfscrypto.TLFEphemeralPublicKey, kbfscrypto.EncryptedTLFCryptKeyClientHalf,
kbfscrypto.TLFCryptKeyServerHalfID, bool, error) {
wkb, rkb, err := md.getTLFKeyBundles(keyGen)
if err != nil {
return kbfscrypto.TLFEphemeralPublicKey{},
kbfscrypto.EncryptedTLFCryptKeyClientHalf{},
kbfscrypto.TLFCryptKeyServerHalfID{}, false, err
}
dkim := wkb.WKeys[user]
if dkim == nil {
dkim = rkb.RKeys[user]
if dkim == nil {
return kbfscrypto.TLFEphemeralPublicKey{},
kbfscrypto.EncryptedTLFCryptKeyClientHalf{},
kbfscrypto.TLFCryptKeyServerHalfID{}, false, nil
}
}
info, ok := dkim[key.KID()]
if !ok {
return kbfscrypto.TLFEphemeralPublicKey{},
kbfscrypto.EncryptedTLFCryptKeyClientHalf{},
kbfscrypto.TLFCryptKeyServerHalfID{}, false, nil
}
_, _, ePubKey, err := GetEphemeralPublicKeyInfoV2(info, *wkb, *rkb)
if err != nil {
return kbfscrypto.TLFEphemeralPublicKey{},
kbfscrypto.EncryptedTLFCryptKeyClientHalf{},
kbfscrypto.TLFCryptKeyServerHalfID{}, false, err
}
return ePubKey, info.ClientHalf, info.ServerHalfID, true, nil
}
// IsValidAndSigned implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsValidAndSigned(
_ context.Context, codec kbfscodec.Codec,
_ TeamMembershipChecker, extra ExtraMetadata,
_ kbfscrypto.VerifyingKey, _ keybase1.OfflineAvailability) error {
// Optimization -- if the WriterMetadata signature is nil, it
// will fail verification.
if md.WriterMetadataSigInfo.IsNil() {
return errors.New("Missing WriterMetadata signature")
}
if md.IsFinal() {
if md.Revision < RevisionInitial+1 {
return fmt.Errorf("Invalid final revision %d", md.Revision)
}
if md.Revision == (RevisionInitial + 1) {
if md.PrevRoot != (ID{}) {
return fmt.Errorf("Invalid PrevRoot %s for initial final revision", md.PrevRoot)
}
} else {
if md.PrevRoot == (ID{}) {
return errors.New("No PrevRoot for non-initial final revision")
}
}
} else {
if md.Revision < RevisionInitial {
return fmt.Errorf("Invalid revision %d", md.Revision)
}
if md.Revision == RevisionInitial {
if md.PrevRoot != (ID{}) {
return fmt.Errorf("Invalid PrevRoot %s for initial revision", md.PrevRoot)
}
} else {
if md.PrevRoot == (ID{}) {
return errors.New("No PrevRoot for non-initial revision")
}
}
}
if len(md.SerializedPrivateMetadata) == 0 {
return errors.New("No private metadata")
}
if (md.MergedStatus() == Merged) != (md.BID() == NullBranchID) {
return fmt.Errorf("Branch ID %s doesn't match merged status %s",
md.BID(), md.MergedStatus())
}
handle, err := md.MakeBareTlfHandle(extra)
if err != nil {
return err
}
// Make sure the last writer is valid. TODO(KBFS-2185): for a
// team TLF, check that the writer is part of the team.
writer := md.LastModifyingWriter()
if !handle.IsWriter(writer.AsUserOrTeam()) {
return fmt.Errorf("Invalid modifying writer %s", writer)
}
// Make sure the last modifier is valid.
user := md.LastModifyingUser
if !handle.IsReader(user.AsUserOrTeam()) {
return fmt.Errorf("Invalid modifying user %s", user)
}
// Verify signature. We have to re-marshal the WriterMetadata,
// since it's embedded.
buf, err := codec.Encode(md.WriterMetadataV2)
if err != nil {
return err
}
err = kbfscrypto.Verify(buf, md.WriterMetadataSigInfo)
if err != nil {
return fmt.Errorf("Could not verify writer metadata: %v", err)
}
return nil
}
// IsLastModifiedBy implements the RootMetadata interface for
// RootMetadataV2.
func (md *RootMetadataV2) IsLastModifiedBy(
uid keybase1.UID, key kbfscrypto.VerifyingKey) error {
// Verify the user and device are the writer.
writer := md.LastModifyingWriter()
if !md.IsWriterMetadataCopiedSet() {
if writer != uid {
return fmt.Errorf("Last writer %s != %s", writer, uid)
}
if md.WriterMetadataSigInfo.VerifyingKey != key {
return fmt.Errorf(
"Last writer verifying key %v != %v",
md.WriterMetadataSigInfo.VerifyingKey, key)
}
}
// Verify the user and device are the last modifier.
user := md.GetLastModifyingUser()
if user != uid {
return fmt.Errorf("Last modifier %s != %s", user, uid)
}
return nil
}
// LastModifyingWriter implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) LastModifyingWriter() keybase1.UID {
return md.WriterMetadataV2.LastModifyingWriter
}
// GetLastModifyingUser implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) GetLastModifyingUser() keybase1.UID {
return md.LastModifyingUser
}
// RefBytes implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) RefBytes() uint64 {
return md.WriterMetadataV2.RefBytes
}
// UnrefBytes implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) UnrefBytes() uint64 {
return md.WriterMetadataV2.UnrefBytes
}
// MDRefBytes implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) MDRefBytes() uint64 {
return md.WriterMetadataV2.MDRefBytes
}
// DiskUsage implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) DiskUsage() uint64 {
return md.WriterMetadataV2.DiskUsage
}
// MDDiskUsage implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) MDDiskUsage() uint64 {
return md.WriterMetadataV2.MDDiskUsage
}
// SetRefBytes implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) SetRefBytes(refBytes uint64) {
md.WriterMetadataV2.RefBytes = refBytes
}
// SetUnrefBytes implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) SetUnrefBytes(unrefBytes uint64) {
md.WriterMetadataV2.UnrefBytes = unrefBytes
}
// SetMDRefBytes implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) SetMDRefBytes(mdRefBytes uint64) {
md.WriterMetadataV2.MDRefBytes = mdRefBytes
}
// SetDiskUsage implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) SetDiskUsage(diskUsage uint64) {
md.WriterMetadataV2.DiskUsage = diskUsage
}
// SetMDDiskUsage implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) SetMDDiskUsage(mdDiskUsage uint64) {
md.WriterMetadataV2.MDDiskUsage = mdDiskUsage
}
// AddRefBytes implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) AddRefBytes(refBytes uint64) {
md.WriterMetadataV2.RefBytes += refBytes
}
// AddUnrefBytes implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) AddUnrefBytes(unrefBytes uint64) {
md.WriterMetadataV2.UnrefBytes += unrefBytes
}
// AddMDRefBytes implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) AddMDRefBytes(mdRefBytes uint64) {
md.WriterMetadataV2.MDRefBytes += mdRefBytes
}
// AddDiskUsage implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) AddDiskUsage(diskUsage uint64) {
md.WriterMetadataV2.DiskUsage += diskUsage
}
// AddMDDiskUsage implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) AddMDDiskUsage(mdDiskUsage uint64) {
md.WriterMetadataV2.MDDiskUsage += mdDiskUsage
}
// RevisionNumber implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) RevisionNumber() Revision {
return md.Revision
}
// BID implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) BID() BranchID {
return md.WriterMetadataV2.BID
}
// GetPrevRoot implements the RootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) GetPrevRoot() ID {
return md.PrevRoot
}
// ClearRekeyBit implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) ClearRekeyBit() {
md.Flags &= ^MetadataFlagRekey
}
// ClearWriterMetadataCopiedBit implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) ClearWriterMetadataCopiedBit() {
md.Flags &= ^MetadataFlagWriterMetadataCopied
}
// IsUnmergedSet implements the MutableRootMetadata interface for RootMetadataV2.
func (md *RootMetadataV2) IsUnmergedSet() bool {
return (md.WriterMetadataV2.WFlags & MetadataFlagUnmerged) != 0
}
// SetUnmerged implements the MutableRootMetadata interface for RootMetadataV2.