forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mdserver_remote.go
1538 lines (1366 loc) · 45.7 KB
/
mdserver_remote.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"
"sync"
"time"
"github.com/keybase/backoff"
"github.com/keybase/client/go/kbfs/idutil"
"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/libkb"
"github.com/keybase/client/go/logger"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/keybase/go-framed-msgpack-rpc/rpc"
"github.com/pkg/errors"
"golang.org/x/net/context"
)
const (
// MdServerBackgroundRekeyPeriod is how long the rekey checker
// waits between runs on average. The timer gets reset after
// every incoming FolderNeedsRekey RPC.
// The amount of wait is calculated in nextRekeyTime.
MdServerBackgroundRekeyPeriod = 1 * time.Hour
// MdServerDefaultPingIntervalSeconds is the default interval on which the
// client should contact the MD Server
MdServerDefaultPingIntervalSeconds = 10
// MdServerPingTimeout is how long to wait for a ping response
// before breaking the connection and trying to reconnect.
MdServerPingTimeout = 30 * time.Second
// mdServerLatestHandleTimeout is the timeout for checking the
// server for the latest handle before we use the cached value
// instead.
mdServerLatestHandleTimeout = 500 * time.Millisecond
// mdServerTimeoutWhenMDCached defines how long we wait for the
// latest MD to return from the server, when we've already read it
// from the disk cache.
mdServerTimeoutWhenMDCached = 500 * time.Millisecond
)
// MDServerRemote is an implementation of the MDServer interface.
type MDServerRemote struct {
kbCtx Context
config Config
log traceLogger
deferLog traceLogger
mdSrvRemote rpc.Remote
connOpts rpc.ConnectionOpts
rpcLogFactory rpc.LogFactory
authToken *kbfscrypto.AuthToken
squelchRekey bool
pinger pinger
authenticatedMtx sync.RWMutex
isAuthenticated bool
connMu sync.RWMutex
conn *rpc.Connection
client keybase1.MetadataClient
observerMu sync.Mutex // protects observers
// chan is nil if we have unregistered locally, but not yet with
// the server.
observers map[tlf.ID]chan<- error
rekeyCancel context.CancelFunc
rekeyTimer *time.Timer
serverOffsetMu sync.RWMutex
serverOffsetKnown bool
serverOffset time.Duration
}
// Test that MDServerRemote fully implements the MDServer interface.
var _ MDServer = (*MDServerRemote)(nil)
// Test that MDServerRemote fully implements the KeyServer interface.
var _ libkey.KeyServer = (*MDServerRemote)(nil)
// Test that MDServerRemote fully implements the AuthTokenRefreshHandler interface.
var _ kbfscrypto.AuthTokenRefreshHandler = (*MDServerRemote)(nil)
// Test that MDServerRemote fully implements the ConnectionHandler interface.
var _ rpc.ConnectionHandler = (*MDServerRemote)(nil)
// NewMDServerRemote returns a new instance of MDServerRemote.
func NewMDServerRemote(kbCtx Context, config Config, srvRemote rpc.Remote,
rpcLogFactory rpc.LogFactory) *MDServerRemote {
log := config.MakeLogger("")
deferLog := log.CloneWithAddedDepth(1)
mdServer := &MDServerRemote{
kbCtx: kbCtx,
config: config,
observers: make(map[tlf.ID]chan<- error),
log: traceLogger{log},
deferLog: traceLogger{deferLog},
mdSrvRemote: srvRemote,
rpcLogFactory: rpcLogFactory,
rekeyTimer: time.NewTimer(nextRekeyTime()),
}
mdServer.pinger = pinger{
name: "MDServerRemote",
doPing: mdServer.pingOnce,
timeout: MdServerPingTimeout,
log: mdServer.log,
}
mdServer.authToken = kbfscrypto.NewAuthToken(config.Crypto(),
kbfsmd.ServerTokenServer, kbfsmd.ServerTokenExpireIn,
"libkbfs_mdserver_remote", VersionString(), mdServer)
constBackoff := backoff.NewConstantBackOff(RPCReconnectInterval)
mdServer.connOpts = rpc.ConnectionOpts{
WrapErrorFunc: libkb.WrapError,
TagsFunc: libkb.LogTagsFromContext,
ReconnectBackoff: func() backoff.BackOff { return constBackoff },
DialerTimeout: dialerTimeout,
InitialReconnectBackoffWindow: func() time.Duration { return mdserverReconnectBackoffWindow },
}
mdServer.initNewConnection()
// Check for rekey opportunities periodically.
rekeyCtx, rekeyCancel := context.WithCancel(context.Background())
mdServer.rekeyCancel = rekeyCancel
if config.Mode().RekeyWorkers() > 0 {
go mdServer.backgroundRekeyChecker(rekeyCtx)
}
return mdServer
}
func (md *MDServerRemote) getIsAuthenticated() bool {
md.authenticatedMtx.RLock()
defer md.authenticatedMtx.RUnlock()
return md.isAuthenticated
}
func (md *MDServerRemote) setIsAuthenticated(isAuthenticated bool) {
md.authenticatedMtx.Lock()
defer md.authenticatedMtx.Unlock()
md.isAuthenticated = isAuthenticated
}
func (md *MDServerRemote) initNewConnection() {
md.connMu.Lock()
defer md.connMu.Unlock()
if md.conn != nil {
md.conn.Shutdown()
}
md.conn = rpc.NewTLSConnectionWithDialable(md.mdSrvRemote, kbfscrypto.GetRootCerts(
md.mdSrvRemote.Peek(), libkb.GetBundledCAsFromHost),
kbfsmd.ServerErrorUnwrapper{}, md, md.rpcLogFactory,
logger.LogOutputWithDepthAdder{Logger: md.config.MakeLogger("")},
rpc.DefaultMaxFrameLength, md.connOpts,
libkb.NewProxyDialable(md.kbCtx.GetEnv()))
md.client = keybase1.MetadataClient{Cli: md.conn.GetClient()}
}
const reconnectTimeout = 10 * time.Second
func (md *MDServerRemote) reconnectContext(ctx context.Context) error {
md.connMu.Lock()
defer md.connMu.Unlock()
if md.conn != nil {
_, hasDeadline := ctx.Deadline()
if !hasDeadline {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, reconnectTimeout)
defer cancel()
}
return md.conn.ForceReconnect(ctx)
}
md.initNewConnection()
return nil
}
func (md *MDServerRemote) reconnect() error {
return md.reconnectContext(context.Background())
}
// RemoteAddress returns the remote mdserver this client is talking to
func (md *MDServerRemote) RemoteAddress() string {
return md.mdSrvRemote.String()
}
// HandlerName implements the ConnectionHandler interface.
func (*MDServerRemote) HandlerName() string {
return "MDServerRemote"
}
// OnConnect implements the ConnectionHandler interface.
func (md *MDServerRemote) OnConnect(ctx context.Context,
conn *rpc.Connection, client rpc.GenericClient,
server *rpc.Server) (err error) {
defer func() {
md.config.Reporter().OnlineStatusChanged(ctx, err == nil)
if err == nil {
md.config.Reporter().Notify(ctx,
connectionNotification(connectionStatusConnected))
}
}()
md.log.CInfof(ctx, "OnConnect called with a new connection")
// we'll get replies asynchronously as to not block the connection
// for doing other active work for the user. they will be sent to
// the FolderNeedsRekey handler.
if err := server.Register(keybase1.MetadataUpdateProtocol(md)); err != nil {
if _, ok := err.(rpc.AlreadyRegisteredError); !ok {
return err
}
}
// reset auth -- using md.client here would cause problematic recursion.
c := keybase1.MetadataClient{Cli: client}
pingIntervalSeconds, err := md.resetAuth(ctx, c)
switch err.(type) {
case nil:
case idutil.NoCurrentSessionError:
md.log.CInfof(ctx, "Logged-out user")
default:
return err
}
md.config.KBFSOps().PushConnectionStatusChange(MDServiceName, nil)
// start pinging
md.pinger.resetTicker(pingIntervalSeconds)
return nil
}
type ctxMDServerResetKeyType int
const (
// ctxMDServerResetKey identifies whether the current context has
// already passed through `MDServerRemote.resetAuth`.
ctxMDServerResetKey ctxMDServerResetKeyType = iota
)
// resetAuth is called to reset the authorization on an MDServer
// connection. If this function returns
// idutil.NoCurrentSessionError, the caller should treat this as a
// logged-out user.
func (md *MDServerRemote) resetAuth(
ctx context.Context, c keybase1.MetadataClient) (int, error) {
ctx = context.WithValue(ctx, ctxMDServerResetKey, "1")
isAuthenticated := false
defer func() {
md.setIsAuthenticated(isAuthenticated)
}()
session, err := md.config.KBPKI().GetCurrentSession(ctx)
if err != nil {
md.log.CInfof(ctx,
"Error getting current session (%+v), skipping resetAuth", err)
return MdServerDefaultPingIntervalSeconds, err
}
challenge, err := c.GetChallenge(ctx)
if err != nil {
md.log.CWarningf(ctx, "challenge request error: %v", err)
return 0, err
}
md.log.CDebugf(ctx, "received challenge")
// get a new signature
signature, err := md.authToken.Sign(ctx, session.Name, session.UID,
session.VerifyingKey, challenge)
if err != nil {
md.log.CWarningf(ctx, "error signing authentication token: %v", err)
return 0, err
}
md.log.CDebugf(ctx, "authentication token signed")
// authenticate
pingIntervalSeconds, err := c.Authenticate(ctx, signature)
if err != nil {
md.log.CWarningf(ctx, "authentication error: %v", err)
return 0, err
}
md.log.CInfof(ctx, "authentication successful; ping interval: %ds",
pingIntervalSeconds)
isAuthenticated = true
md.authenticatedMtx.Lock()
if !md.isAuthenticated && md.config.Mode().RekeyWorkers() > 0 {
defer func() {
// request a list of folders needing rekey action
if err := md.getFoldersForRekey(ctx, c); err != nil {
md.log.CWarningf(ctx, "getFoldersForRekey failed with %v", err)
}
md.deferLog.CDebugf(ctx,
"requested list of folders for rekey")
}()
}
// Need to ensure that any conflicting thread gets the updated value
md.isAuthenticated = true
md.authenticatedMtx.Unlock()
return pingIntervalSeconds, nil
}
func (md *MDServerRemote) getClient() keybase1.MetadataClient {
md.connMu.RLock()
defer md.connMu.RUnlock()
return md.client
}
// RefreshAuthToken implements the AuthTokenRefreshHandler interface.
func (md *MDServerRemote) RefreshAuthToken(ctx context.Context) {
md.log.CDebugf(ctx, "MDServerRemote: Refreshing auth token...")
if v := ctx.Value(ctxMDServerResetKey); v != nil {
md.log.CDebugf(ctx, "Avoiding resetAuth recursion")
return
}
_, err := md.resetAuth(ctx, md.getClient())
switch err.(type) {
case nil:
md.log.CInfof(ctx, "MDServerRemote: auth token refreshed")
case idutil.NoCurrentSessionError:
md.log.CInfof(ctx,
"MDServerRemote: no session available, connection remains anonymous")
default:
md.log.CInfof(ctx,
"MDServerRemote: error refreshing auth token: %v", err)
err = md.reconnect()
if err != nil {
md.log.CWarningf(ctx,
"MDServerRemote: error calling md.reconnect(): %v", err)
}
}
}
func (md *MDServerRemote) pingOnce(ctx context.Context) {
clock := md.config.Clock()
beforePing := clock.Now()
resp, err := md.getClient().Ping2(ctx)
if err == context.DeadlineExceeded {
if md.getIsAuthenticated() {
md.log.CInfof(ctx, "Ping timeout -- reinitializing connection")
if err = md.reconnect(); err != nil {
md.log.CInfof(ctx, "reconnect error: %v", err)
}
} else {
md.log.CInfof(ctx, "Ping timeout but not reinitializing")
}
return
} else if err != nil {
md.log.CInfof(ctx, "MDServerRemote: ping error %s", err)
return
}
afterPing := clock.Now()
pingLatency := afterPing.Sub(beforePing)
if md.serverOffset > 0 && pingLatency > 5*time.Second {
md.log.CDebugf(ctx, "Ignoring large ping time: %s",
pingLatency)
return
}
serverTimeNow :=
keybase1.FromTime(resp.Timestamp).Add(pingLatency / 2)
func() {
md.serverOffsetMu.Lock()
defer md.serverOffsetMu.Unlock()
// Estimate the server offset, assuming a balanced
// round trip latency (and 0 server processing
// latency). Calculate it so that it can be added
// to a server timestamp in order to get the local
// time of a server-timestamped event.
md.serverOffset = afterPing.Sub(serverTimeNow)
md.serverOffsetKnown = true
}()
}
// OnConnectError implements the ConnectionHandler interface.
func (md *MDServerRemote) OnConnectError(err error, wait time.Duration) {
md.log.CWarningf(context.TODO(),
"MDServerRemote: connection error: %q; retrying in %s", err, wait)
// TODO: it might make sense to show something to the user if this is
// due to authentication, for example.
md.cancelObservers()
md.pinger.cancelTicker()
if md.authToken != nil {
md.authToken.Shutdown()
}
md.config.KBFSOps().PushConnectionStatusChange(MDServiceName, err)
md.config.Reporter().OnlineStatusChanged(context.Background(), false)
}
// OnDoCommandError implements the ConnectionHandler interface.
func (md *MDServerRemote) OnDoCommandError(err error, wait time.Duration) {
md.log.CWarningf(context.TODO(),
"MDServerRemote: DoCommand error: %q; retrying in %s", err, wait)
// Only push errors that should not be retried as connection status changes.
if !md.ShouldRetry("", err) {
md.config.KBFSOps().PushConnectionStatusChange(MDServiceName, err)
md.config.Reporter().OnlineStatusChanged(context.Background(), false)
}
}
// OnDisconnected implements the ConnectionHandler interface.
func (md *MDServerRemote) OnDisconnected(ctx context.Context,
status rpc.DisconnectStatus) {
if status == rpc.StartingNonFirstConnection {
md.log.CWarningf(ctx, "MDServerRemote is disconnected")
md.config.Reporter().Notify(ctx,
connectionNotification(connectionStatusDisconnected))
md.config.Reporter().OnlineStatusChanged(ctx, false)
}
func() {
md.serverOffsetMu.Lock()
defer md.serverOffsetMu.Unlock()
md.serverOffsetKnown = false
md.serverOffset = 0
}()
md.setIsAuthenticated(false)
md.cancelObservers()
md.pinger.cancelTicker()
if md.authToken != nil {
md.authToken.Shutdown()
}
md.config.RekeyQueue().Shutdown()
md.config.SetRekeyQueue(NewRekeyQueueStandard(md.config))
// Reset the timer since we will get folders for rekey again on
// the re-connect.
md.resetRekeyTimer()
if status == rpc.StartingNonFirstConnection {
md.config.KBFSOps().PushConnectionStatusChange(MDServiceName, errDisconnected{})
md.config.Reporter().OnlineStatusChanged(ctx, false)
}
}
// ShouldRetry implements the ConnectionHandler interface.
func (md *MDServerRemote) ShouldRetry(name string, err error) bool {
_, shouldThrottle := err.(kbfsmd.ServerErrorThrottle)
return shouldThrottle
}
// ShouldRetryOnConnect implements the ConnectionHandler interface.
func (md *MDServerRemote) ShouldRetryOnConnect(err error) bool {
_, inputCanceled := err.(libkb.InputCanceledError)
return !inputCanceled
}
// CheckReachability implements the MDServer interface.
func (md *MDServerRemote) CheckReachability(ctx context.Context) {
conn, err := libkb.ProxyDialTimeout(md.kbCtx.GetEnv(), "tcp",
// The peeked address is the top choice in most cases.
md.mdSrvRemote.Peek(), MdServerPingTimeout)
if err != nil {
if md.getIsAuthenticated() {
md.log.CInfof(ctx, "MDServerRemote: CheckReachability(): "+
"failed to connect, reconnecting: %s", err.Error())
if err = md.reconnectContext(ctx); err != nil {
md.log.CInfof(ctx, "reconnect error: %v", err)
}
} else {
md.log.CInfof(ctx, "MDServerRemote: CheckReachability(): "+
"failed to connect (%s), but not reconnecting", err.Error())
}
} else {
md.log.CInfof(ctx, "MDServerRemote: CheckReachability(): "+
"dial succeeded; fast forwarding any pending reconnect")
md.conn.FastForwardInitialBackoffTimer()
}
if conn != nil {
conn.Close()
}
}
// Signal errors and clear any registered observers.
func (md *MDServerRemote) cancelObservers() {
md.observerMu.Lock()
defer md.observerMu.Unlock()
// fire errors for any registered observers
for id, observerChan := range md.observers {
md.signalObserverLocked(observerChan, id, MDServerDisconnected{})
}
}
// CancelRegistration implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) CancelRegistration(ctx context.Context, id tlf.ID) {
md.observerMu.Lock()
defer md.observerMu.Unlock()
observerChan, ok := md.observers[id]
if !ok {
// not registered
return
}
// signal that we've seen the update
md.signalObserverLocked(
observerChan, id, errors.New("Registration canceled"))
// Setting nil here indicates that the remote MD server thinks
// we're still registered, though locally no one is listening.
md.observers[id] = nil
}
// Signal an observer. The observer lock must be held.
func (md *MDServerRemote) signalObserverLocked(observerChan chan<- error, id tlf.ID, err error) {
if observerChan != nil {
observerChan <- err
close(observerChan)
}
delete(md.observers, id)
}
func (md *MDServerRemote) getLatestFromCache(
ctx context.Context, tlfID tlf.ID) (*RootMetadataSigned, error) {
if md.config.DiskMDCache() == nil {
return nil, nil
}
buf, ver, timestamp, err := md.config.DiskMDCache().Get(ctx, tlfID)
if err != nil {
return nil, err
}
return DecodeRootMetadataSigned(
md.config.Codec(), tlfID, ver, md.config.MetadataVersion(), buf,
timestamp)
}
// Helper used to retrieve metadata blocks from the MD server.
func (md *MDServerRemote) get(ctx context.Context, arg keybase1.GetMetadataArg) (
tlfID tlf.ID, rmdses []*RootMetadataSigned, err error) {
// request
response, err := md.getClient().GetMetadata(ctx, arg)
if err != nil {
return tlf.ID{}, nil, err
}
// response
tlfID, err = tlf.ParseID(response.FolderID)
if err != nil {
return tlf.ID{}, nil, err
}
// deserialize blocks
rmdses = make([]*RootMetadataSigned, len(response.MdBlocks))
diskMDCache := md.config.DiskMDCache()
for i, block := range response.MdBlocks {
ver, max := kbfsmd.MetadataVer(block.Version), md.config.MetadataVersion()
timestamp := keybase1.FromTime(block.Timestamp)
rmds, err := DecodeRootMetadataSigned(
md.config.Codec(), tlfID, ver, max, block.Block,
keybase1.FromTime(block.Timestamp))
if err != nil {
return tlf.ID{}, nil, err
}
rmdses[i] = rmds
if diskMDCache != nil && rmds.MD.MergedStatus() == kbfsmd.Merged {
err = diskMDCache.Stage(
ctx, tlfID, rmds.MD.RevisionNumber(), block.Block, ver,
timestamp)
if err != nil {
return tlf.ID{}, nil, err
}
}
}
return tlfID, rmdses, nil
}
// GetForHandle implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) GetForHandle(ctx context.Context,
handle tlf.Handle, mStatus kbfsmd.MergeStatus, lockBeforeGet *keybase1.LockID) (
tlfID tlf.ID, rmds *RootMetadataSigned, err error) {
ctx = rpc.WithFireNow(ctx)
// TODO: Ideally, *tlf.Handle would have a nicer String() function.
md.log.LazyTrace(ctx, "MDServer: GetForHandle %+v %s", handle, mStatus)
defer func() {
md.deferLog.LazyTrace(ctx, "MDServer: GetForHandle %+v %s done (err=%v)", handle, mStatus, err)
}()
encodedHandle, err := md.config.Codec().Encode(handle)
if err != nil {
return tlf.ID{}, nil, err
}
// kbfsmd.BranchID needs to be present when Unmerged is true;
// kbfsmd.NullBranchID signals that the folder's current branch ID
// should be looked up.
arg := keybase1.GetMetadataArg{
FolderHandle: encodedHandle,
BranchID: kbfsmd.NullBranchID.String(),
Unmerged: mStatus == kbfsmd.Unmerged,
LockBeforeGet: lockBeforeGet,
}
id, rmdses, err := md.get(ctx, arg)
if err != nil {
return tlf.ID{}, nil, err
}
if len(rmdses) == 0 {
return id, nil, nil
}
// TODO: Error if server returns more than one rmds.
return id, rmdses[0], nil
}
// GetForTLF implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) GetForTLF(ctx context.Context, id tlf.ID,
bid kbfsmd.BranchID, mStatus kbfsmd.MergeStatus, lockBeforeGet *keybase1.LockID) (rmds *RootMetadataSigned, err error) {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx, "MDServer: GetForTLF %s %s %s", id, bid, mStatus)
defer func() {
md.deferLog.LazyTrace(ctx, "MDServer: GetForTLF %s %s %s done (err=%v)", id, bid, mStatus, err)
}()
var cachedRmds *RootMetadataSigned
getCtx := ctx
if mStatus == kbfsmd.Merged && lockBeforeGet == nil {
cachedRmds, err = md.getLatestFromCache(ctx, id)
if err == nil && cachedRmds != nil {
md.log.CDebugf(ctx,
"Read revision %d for TLF %s from the disk cache",
cachedRmds.MD.RevisionNumber(), id)
var cancel context.CancelFunc
getCtx, cancel = context.WithTimeout(
ctx, mdServerTimeoutWhenMDCached)
defer cancel()
}
}
arg := keybase1.GetMetadataArg{
FolderID: id.String(),
BranchID: bid.String(),
Unmerged: mStatus == kbfsmd.Unmerged,
LockBeforeGet: lockBeforeGet,
}
_, rmdses, err := md.get(getCtx, arg)
switch errors.Cause(err) {
case nil:
case context.DeadlineExceeded:
if cachedRmds != nil {
md.log.CDebugf(ctx, "Can't contact server; using cached MD")
return cachedRmds, nil
}
return nil, err
default:
return nil, err
}
if len(rmdses) == 0 {
return nil, nil
}
if cachedRmds != nil {
md.log.CDebugf(ctx, "Read revision %d for TLF %s from the server",
rmdses[0].MD.RevisionNumber(), id)
}
// TODO: Error if server returns more than one rmds.
return rmdses[0], nil
}
// GetForTLFByTime implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) GetForTLFByTime(
ctx context.Context, id tlf.ID, serverTime time.Time) (
rmds *RootMetadataSigned, err error) {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx, "MDServer: GetForTLFByTime %s %s", id, serverTime)
defer func() {
md.deferLog.LazyTrace(
ctx, "MDServer: GetForTLFByTime %s %s done (err=%v)",
id, serverTime, err)
}()
arg := keybase1.GetMetadataByTimestampArg{
FolderID: id.String(),
ServerTime: keybase1.ToTime(serverTime),
}
block, err := md.getClient().GetMetadataByTimestamp(ctx, arg)
if err != nil {
return nil, err
} else if len(block.Block) == 0 {
return nil, errors.Errorf("No revision available at %s", serverTime)
}
ver, max := kbfsmd.MetadataVer(block.Version), md.config.MetadataVersion()
rmds, err = DecodeRootMetadataSigned(
md.config.Codec(), id, ver, max, block.Block,
keybase1.FromTime(block.Timestamp))
if err != nil {
return nil, err
}
return rmds, nil
}
// GetRange implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) GetRange(ctx context.Context, id tlf.ID,
bid kbfsmd.BranchID, mStatus kbfsmd.MergeStatus,
start, stop kbfsmd.Revision, lockBeforeGet *keybase1.LockID) (
rmdses []*RootMetadataSigned, err error) {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx, "MDServer: GetRange %s %s %s %d-%d", id, bid, mStatus, start, stop)
defer func() {
md.deferLog.LazyTrace(ctx, "MDServer: GetRange %s %s %s %d-%d done (err=%v)", id, bid, mStatus, start, stop, err)
}()
arg := keybase1.GetMetadataArg{
FolderID: id.String(),
BranchID: bid.String(),
Unmerged: mStatus == kbfsmd.Unmerged,
StartRevision: start.Number(),
StopRevision: stop.Number(),
LockBeforeGet: lockBeforeGet,
}
_, rmds, err := md.get(ctx, arg)
return rmds, err
}
// Put implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) Put(ctx context.Context, rmds *RootMetadataSigned,
extra kbfsmd.ExtraMetadata, lockContext *keybase1.LockContext,
priority keybase1.MDPriority) (err error) {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx, "MDServer: Put %s %d", rmds.MD.TlfID(), rmds.MD.RevisionNumber())
defer func() {
md.deferLog.LazyTrace(ctx, "MDServer: Put %s %d done (err=%v)", rmds.MD.TlfID(), rmds.MD.RevisionNumber(), err)
}()
// encode MD block
rmdsBytes, err := kbfsmd.EncodeRootMetadataSigned(md.config.Codec(), &rmds.RootMetadataSigned)
if err != nil {
return err
}
// put request
arg := keybase1.PutMetadataArg{
MdBlock: keybase1.MDBlock{
Version: int(rmds.Version()),
Block: rmdsBytes,
},
LogTags: nil,
Priority: priority,
}
if lockContext != nil {
copied := *lockContext
arg.LockContext = &copied
}
if rmds.Version() != kbfsmd.SegregatedKeyBundlesVer {
if extra != nil {
return fmt.Errorf("Unexpected non-nil extra: %+v", extra)
}
} else if extra != nil {
// For now, if we have a non-nil extra, it must be
// *ExtraMetadataV3, but in the future it might be
// some other type (e.g., *ExtraMetadataV4).
extraV3, ok := extra.(*kbfsmd.ExtraMetadataV3)
if !ok {
return fmt.Errorf("Extra of unexpected type %T", extra)
}
// Add any new key bundles.
if extraV3.IsWriterKeyBundleNew() {
wkbBytes, err := md.config.Codec().Encode(extraV3.GetWriterKeyBundle())
if err != nil {
return err
}
arg.WriterKeyBundle = keybase1.KeyBundle{
Version: int(rmds.Version()),
Bundle: wkbBytes,
}
}
if extraV3.IsReaderKeyBundleNew() {
rkbBytes, err := md.config.Codec().Encode(extraV3.GetReaderKeyBundle())
if err != nil {
return err
}
arg.ReaderKeyBundle = keybase1.KeyBundle{
Version: int(rmds.Version()),
Bundle: rkbBytes,
}
}
}
err = md.getClient().PutMetadata(ctx, arg)
if err != nil {
return err
}
// Stage the new MD if needed.
diskMDCache := md.config.DiskMDCache()
if diskMDCache != nil && rmds.MD.MergedStatus() == kbfsmd.Merged {
// Guess the server timestamp by using the local offset.
// TODO: the server should return this, and/or we should fetch
// it explicitly.
revTime := md.config.Clock().Now()
if offset, ok := md.OffsetFromServerTime(); ok {
revTime = revTime.Add(-offset)
}
err = diskMDCache.Stage(
ctx, rmds.MD.TlfID(), rmds.MD.RevisionNumber(), rmdsBytes,
rmds.Version(), revTime)
if err != nil {
return err
}
}
return nil
}
// Lock implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) Lock(ctx context.Context,
tlfID tlf.ID, lockID keybase1.LockID) error {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx, "MDServer: Lock %s %s", tlfID, lockID)
defer func() {
md.deferLog.LazyTrace(ctx, "MDServer: Lock %s %s", tlfID, lockID)
}()
return md.getClient().Lock(ctx, keybase1.LockArg{
FolderID: tlfID.String(),
LockID: lockID,
})
}
// ReleaseLock implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) ReleaseLock(ctx context.Context,
tlfID tlf.ID, lockID keybase1.LockID) error {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx, "MDServer: ReleaseLock %s %s", tlfID, lockID)
defer func() {
md.deferLog.LazyTrace(ctx, "MDServer: ReleaseLock %s %s", tlfID, lockID)
}()
return md.getClient().ReleaseLock(ctx, keybase1.ReleaseLockArg{
FolderID: tlfID.String(),
LockID: lockID,
})
}
// StartImplicitTeamMigration implements the MDServer interface.
func (md *MDServerRemote) StartImplicitTeamMigration(
ctx context.Context, id tlf.ID) (err error) {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx,
"MDServer: StartImplicitTeamMigration %s", id)
defer func() {
md.deferLog.LazyTrace(ctx,
"MDServer: StartImplicitTeamMigration %s (err=%v)", id, err)
}()
return md.getClient().StartImplicitTeamMigration(ctx, id.String())
}
// PruneBranch implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) PruneBranch(
ctx context.Context, id tlf.ID, bid kbfsmd.BranchID) (err error) {
ctx = rpc.WithFireNow(ctx)
md.log.LazyTrace(ctx, "MDServer: PruneBranch %s %s", id, bid)
defer func() {
md.deferLog.LazyTrace(ctx, "MDServer: PruneBranch %s %s (err=%v)", id, bid, err)
}()
arg := keybase1.PruneBranchArg{
FolderID: id.String(),
BranchID: bid.String(),
LogTags: nil,
}
return md.getClient().PruneBranch(ctx, arg)
}
// MetadataUpdate implements the MetadataUpdateProtocol interface.
func (md *MDServerRemote) MetadataUpdate(_ context.Context, arg keybase1.MetadataUpdateArg) error {
id, err := tlf.ParseID(arg.FolderID)
if err != nil {
return err
}
md.observerMu.Lock()
defer md.observerMu.Unlock()
observerChan, ok := md.observers[id]
if !ok {
// not registered
return nil
}
// signal that we've seen the update
md.signalObserverLocked(observerChan, id, nil)
return nil
}
// FoldersNeedRekey implements the MetadataUpdateProtocol interface.
func (md *MDServerRemote) FoldersNeedRekey(ctx context.Context,
requests []keybase1.RekeyRequest) error {
if md.squelchRekey {
md.log.CDebugf(ctx, "MDServerRemote: rekey updates squelched for testing")
return nil
}
for _, req := range requests {
id, err := tlf.ParseID(req.FolderID)
if err != nil {
return err
}
md.log.CDebugf(ctx, "MDServerRemote: folder needs rekey: %s", id.String())
// queue the folder for rekeying
md.config.RekeyQueue().Enqueue(id)
}
// Reset the timer in case there are a lot of rekey folders
// dribbling in from the server still.
md.resetRekeyTimer()
return nil
}
// FolderNeedsRekey implements the MetadataUpdateProtocol interface.
func (md *MDServerRemote) FolderNeedsRekey(ctx context.Context,
arg keybase1.FolderNeedsRekeyArg) error {
id, err := tlf.ParseID(arg.FolderID)
if err != nil {
return err
}
md.log.CDebugf(ctx, "MDServerRemote: folder needs rekey: %s", id.String())
if md.squelchRekey {
md.log.CDebugf(ctx, "MDServerRemote: rekey updates squelched for testing")
return nil
}
// queue the folder for rekeying
md.config.RekeyQueue().Enqueue(id)
// Reset the timer in case there are a lot of rekey folders
// dribbling in from the server still.
md.resetRekeyTimer()
return nil
}
func (md *MDServerRemote) getConn() *rpc.Connection {
md.connMu.RLock()
defer md.connMu.RUnlock()
return md.conn
}
// RegisterForUpdate implements the MDServer interface for MDServerRemote.
func (md *MDServerRemote) RegisterForUpdate(ctx context.Context, id tlf.ID,
currHead kbfsmd.Revision) (<-chan error, error) {
arg := keybase1.RegisterForUpdatesArg{
FolderID: id.String(),
CurrRevision: currHead.Number(),
LogTags: nil,
}
// register
var c chan error
conn := md.getConn()
err := conn.DoCommand(ctx, "register", 0, func(rawClient rpc.GenericClient) error {
// set up the server to receive updates, since we may
// get disconnected between retries.
server := conn.GetServer()
err := server.Register(keybase1.MetadataUpdateProtocol(md))
if err != nil {
if _, ok := err.(rpc.AlreadyRegisteredError); !ok {
return err
}
}
// TODO: Do something with server.Err() when server is
// done?
server.Run()
// keep re-adding the observer on retries, since
// disconnects or connection errors clear observers.
alreadyRegistered := func() bool {
md.observerMu.Lock()
defer md.observerMu.Unlock()
// It's possible for a nil channel to be in
// `md.observers`, if we are still registered with the
// server after a previous cancellation.
existingCh, alreadyRegistered := md.observers[id]
if existingCh != nil {
panic(fmt.Sprintf(
"Attempted double-registration for folder: %s", id))
}
c = make(chan error, 1)
md.observers[id] = c
return alreadyRegistered
}()
if alreadyRegistered {
return nil
}
// Use this instead of md.client since we're already