/
kvstore.go
454 lines (423 loc) · 15.5 KB
/
kvstore.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
// Copyright 2019 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
// RPC handlers for kvstore operations
package service
import (
"fmt"
"strings"
"sync"
"github.com/adamwalz/keybase-client/go/kvstore"
"github.com/adamwalz/keybase-client/go/libkb"
keybase1 "github.com/adamwalz/keybase-client/go/protocol/keybase1"
"github.com/adamwalz/keybase-client/go/teams"
"github.com/keybase/go-framed-msgpack-rpc/rpc"
"golang.org/x/net/context"
)
type KVStoreHandler struct {
*BaseHandler
sync.Mutex
libkb.Contextified
Boxer kvstore.KVStoreBoxer
}
var _ keybase1.KvstoreInterface = (*KVStoreHandler)(nil)
func NewKVStoreHandler(xp rpc.Transporter, g *libkb.GlobalContext) *KVStoreHandler {
if g.GetKVRevisionCache() == nil {
g.SetKVRevisionCache(kvstore.NewKVRevisionCache(g))
}
return &KVStoreHandler{
BaseHandler: NewBaseHandler(g, xp),
Contextified: libkb.NewContextified(g),
Boxer: kvstore.NewKVStoreBoxer(g),
}
}
func (h *KVStoreHandler) resolveTeam(mctx libkb.MetaContext, userInputTeamName string) (teamID keybase1.TeamID, err error) {
if strings.Contains(userInputTeamName, ",") {
// it's an implicit team that might not exist yet
team, _, _, err := teams.LookupOrCreateImplicitTeam(mctx.Ctx(), mctx.G(), userInputTeamName, false /*public*/)
if err != nil {
mctx.Debug("error loading implicit team %s: %v", userInputTeamName, err)
err = libkb.AppStatusError{
Code: libkb.SCTeamReadError,
Desc: "You are not a member of this team",
}
return teamID, err
}
return team.ID, nil
}
teamID, err = teams.GetTeamIDByNameRPC(mctx, userInputTeamName)
if err != nil {
mctx.Debug("error resolving team with name %s: %v", userInputTeamName, err)
}
return teamID, err
}
type getEntryAPIRes struct {
libkb.AppStatusEmbed
TeamID keybase1.TeamID `json:"team_id"`
Namespace string `json:"namespace"`
EntryKey string `json:"entry_key"`
TeamKeyGen keybase1.PerTeamKeyGeneration `json:"team_key_gen"`
Revision int `json:"revision"`
Ciphertext *string `json:"ciphertext"`
FormatVersion int `json:"format_version"`
WriterUID keybase1.UID `json:"uid"`
WriterEldestSeqno keybase1.Seqno `json:"eldest_seqno"`
WriterDeviceID keybase1.DeviceID `json:"device_id"`
}
func (h *KVStoreHandler) serverFetch(mctx libkb.MetaContext, entryID keybase1.KVEntryID) (emptyRes getEntryAPIRes, err error) {
var apiRes getEntryAPIRes
apiArg := libkb.APIArg{
Endpoint: "team/storage",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{
"team_id": libkb.S{Val: entryID.TeamID.String()},
"namespace": libkb.S{Val: entryID.Namespace},
"entry_key": libkb.S{Val: entryID.EntryKey},
},
}
err = mctx.G().API.GetDecode(mctx, apiArg, &apiRes)
if err != nil {
mctx.Debug("error fetching %+v from server: %v", entryID, err)
return emptyRes, err
}
if apiRes.TeamID != entryID.TeamID {
return emptyRes, fmt.Errorf("api returned an unexpected teamID: %s isn't %s", apiRes.TeamID, entryID.TeamID)
}
if apiRes.Namespace != entryID.Namespace {
return emptyRes, fmt.Errorf("api returned an unexpected namespace: %s isn't %s", apiRes.Namespace, entryID.Namespace)
}
if apiRes.EntryKey != entryID.EntryKey {
return emptyRes, fmt.Errorf("api returned an unexpected entryKey: %s isn't %s", apiRes.EntryKey, entryID.EntryKey)
}
return apiRes, nil
}
func (h *KVStoreHandler) GetKVEntry(ctx context.Context, arg keybase1.GetKVEntryArg) (res keybase1.KVGetResult, err error) {
h.Lock()
defer h.Unlock()
return h.getKVEntryLocked(ctx, arg)
}
func (h *KVStoreHandler) getKVEntryLocked(ctx context.Context, arg keybase1.GetKVEntryArg) (res keybase1.KVGetResult, err error) {
ctx = libkb.WithLogTag(ctx, "KV")
mctx := libkb.NewMetaContext(ctx, h.G())
defer mctx.Trace(fmt.Sprintf("KVStoreHandler#GetKVEntry: t:%s, n:%s, k:%s", arg.TeamName, arg.Namespace, arg.EntryKey), &err)()
if err := assertLoggedIn(ctx, h.G()); err != nil {
mctx.Debug("not logged in err: %v", err)
return res, err
}
teamID, err := h.resolveTeam(mctx, arg.TeamName)
if err != nil {
return res, err
}
entryID := keybase1.KVEntryID{
TeamID: teamID,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
}
apiRes, err := h.serverFetch(mctx, entryID)
if err != nil {
mctx.Debug("error fetching %+v from server: %v", entryID, err)
return res, err
}
// check the server response against the local cache
err = mctx.G().GetKVRevisionCache().Check(mctx, entryID, apiRes.Ciphertext, apiRes.TeamKeyGen, apiRes.Revision)
if err != nil {
err = fmt.Errorf("error comparing the entry from the server to what's in the local cache: %s", err)
mctx.Debug("%+v: %s", entryID, err)
return res, err
}
var entryValue *string
if apiRes.Ciphertext != nil && len(*apiRes.Ciphertext) > 0 {
// ciphertext coming back from the server is available to be unboxed (has previously been set, and was not previously deleted)
cleartext, err := h.Boxer.Unbox(mctx, entryID, apiRes.Revision, *apiRes.Ciphertext, apiRes.TeamKeyGen, apiRes.FormatVersion, apiRes.WriterUID, apiRes.WriterEldestSeqno, apiRes.WriterDeviceID)
if err != nil {
mctx.Debug("error unboxing %+v: %v", entryID, err)
return res, err
}
entryValue = &cleartext
}
err = mctx.G().GetKVRevisionCache().Put(mctx, entryID, apiRes.Ciphertext, apiRes.TeamKeyGen, apiRes.Revision)
if err != nil {
err = fmt.Errorf("error putting newly fetched values into the local cache: %s", err)
mctx.Debug("%+v: %s", entryID, err)
return res, err
}
return keybase1.KVGetResult{
TeamName: arg.TeamName,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
EntryValue: entryValue,
Revision: apiRes.Revision,
}, nil
}
type putEntryAPIRes struct {
libkb.AppStatusEmbed
Revision int `json:"revision"`
}
func (h *KVStoreHandler) PutKVEntry(ctx context.Context, arg keybase1.PutKVEntryArg) (res keybase1.KVPutResult, err error) {
h.Lock()
defer h.Unlock()
return h.putKVEntryLocked(ctx, arg)
}
func (h *KVStoreHandler) putKVEntryLocked(ctx context.Context, arg keybase1.PutKVEntryArg) (res keybase1.KVPutResult, err error) {
ctx = libkb.WithLogTag(ctx, "KV")
mctx := libkb.NewMetaContext(ctx, h.G())
defer mctx.Trace(fmt.Sprintf("KVStoreHandler#PutKVEntry: t:%s, n:%s, k:%s, r:%d", arg.TeamName, arg.Namespace, arg.EntryKey, arg.Revision), &err)()
if err := assertLoggedIn(ctx, h.G()); err != nil {
mctx.Debug("not logged in err: %v", err)
return res, err
}
teamID, err := h.resolveTeam(mctx, arg.TeamName)
if err != nil {
return res, err
}
entryID := keybase1.KVEntryID{
TeamID: teamID,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
}
revision := arg.Revision
if revision == 0 {
// fetch to get the correct revision when it's not specified
getRes, err := h.getKVEntryLocked(ctx, keybase1.GetKVEntryArg{
SessionID: arg.SessionID,
TeamName: arg.TeamName,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
})
if err != nil {
err = fmt.Errorf("error fetching the revision before writing this entry: %s", err)
mctx.Debug("%+v: %s", entryID, err)
return res, err
}
revision = getRes.Revision + 1
}
mctx.Debug("updating %+v to revision %d", entryID, revision)
ciphertext, teamKeyGen, ciphertextVersion, err := h.Boxer.Box(mctx, entryID, revision, arg.EntryValue)
if err != nil {
mctx.Debug("error boxing %+v: %v", entryID, err)
return res, err
}
err = mctx.G().GetKVRevisionCache().CheckForUpdate(mctx, entryID, revision)
if err != nil {
mctx.Debug("error from cache for updating %+v: %s", entryID, err)
return res, err
}
apiArg := libkb.APIArg{
Endpoint: "team/storage",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{
"team_id": libkb.S{Val: entryID.TeamID.String()},
"team_key_gen": libkb.I{Val: int(teamKeyGen)},
"namespace": libkb.S{Val: entryID.Namespace},
"entry_key": libkb.S{Val: entryID.EntryKey},
"ciphertext": libkb.S{Val: ciphertext},
"ciphertext_version": libkb.I{Val: ciphertextVersion},
"revision": libkb.I{Val: revision},
},
}
var apiRes putEntryAPIRes
err = mctx.G().API.PostDecode(mctx, apiArg, &apiRes)
if err != nil {
mctx.Debug("error posting update for %+v to the server: %v", entryID, err)
return res, err
}
if apiRes.Revision != revision {
mctx.Debug("expected the server to return revision %d but got %d for %+v", revision, apiRes.Revision, entryID)
return res, fmt.Errorf("kvstore PUT revision error. expected %d, got %d", revision, apiRes.Revision)
}
err = mctx.G().GetKVRevisionCache().Put(mctx, entryID, &ciphertext, teamKeyGen, revision)
if err != nil {
err = fmt.Errorf("error caching this new entry (try fetching it again): %s", err)
mctx.Debug("%+v: %s", entryID, err)
return res, err
}
return keybase1.KVPutResult{
TeamName: arg.TeamName,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
Revision: apiRes.Revision,
}, nil
}
func (h *KVStoreHandler) DelKVEntry(ctx context.Context, arg keybase1.DelKVEntryArg) (res keybase1.KVDeleteEntryResult, err error) {
h.Lock()
defer h.Unlock()
return h.delKVEntryLocked(ctx, arg)
}
func (h *KVStoreHandler) delKVEntryLocked(ctx context.Context, arg keybase1.DelKVEntryArg) (res keybase1.KVDeleteEntryResult, err error) {
ctx = libkb.WithLogTag(ctx, "KV")
mctx := libkb.NewMetaContext(ctx, h.G())
defer mctx.Trace(fmt.Sprintf("KVStoreHandler#DeleteKVEntry: t:%s, n:%s, k:%s, r:%d", arg.TeamName, arg.Namespace, arg.EntryKey, arg.Revision), &err)()
if err := assertLoggedIn(ctx, h.G()); err != nil {
mctx.Debug("not logged in err: %v", err)
return res, err
}
teamID, err := h.resolveTeam(mctx, arg.TeamName)
if err != nil {
return res, err
}
entryID := keybase1.KVEntryID{
TeamID: teamID,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
}
revision := arg.Revision
if revision == 0 {
getArg := keybase1.GetKVEntryArg{
SessionID: arg.SessionID,
TeamName: arg.TeamName,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
}
getRes, err := h.getKVEntryLocked(ctx, getArg)
if err != nil {
err = fmt.Errorf("error fetching the revision before deleting this entry: %s", err)
mctx.Debug("%+v: %s", entryID, err)
return res, err
}
revision = getRes.Revision + 1
}
mctx.Debug("deleting %+v at revision %d", entryID, revision)
err = mctx.G().GetKVRevisionCache().CheckForUpdate(mctx, entryID, revision)
if err != nil {
mctx.Debug("error from cache for deleting %+v: %s", entryID, err)
return res, err
}
apiArg := libkb.APIArg{
Endpoint: "team/storage",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{
"team_id": libkb.S{Val: entryID.TeamID.String()},
"namespace": libkb.S{Val: entryID.Namespace},
"entry_key": libkb.S{Val: entryID.EntryKey},
"revision": libkb.I{Val: revision},
},
}
apiRes, err := mctx.G().API.Delete(mctx, apiArg)
if err != nil {
mctx.Debug("error making delete request for entry %v: %v", entryID, err)
return res, err
}
responseRevision, err := apiRes.Body.AtKey("revision").GetInt()
if err != nil {
mctx.Debug("error getting the revision from the server response: %v", err)
err = fmt.Errorf("server response doesnt have a revision field: %s", err)
return res, err
}
if responseRevision != revision {
mctx.Debug("expected the server to return revision %d but got %d for %+v", revision, responseRevision, entryID)
return res, fmt.Errorf("kvstore DEL revision error. expected %d, got %d", revision, responseRevision)
}
err = mctx.G().GetKVRevisionCache().MarkDeleted(mctx, entryID, revision)
if err != nil {
err = fmt.Errorf("error caching this now-deleted entry (try fetching it): %s", err)
mctx.Debug("%+v: %s", entryID, err)
return res, err
}
return keybase1.KVDeleteEntryResult{
TeamName: arg.TeamName,
Namespace: arg.Namespace,
EntryKey: arg.EntryKey,
Revision: revision,
}, nil
}
type getListNamespacesAPIRes struct {
libkb.AppStatusEmbed
TeamID keybase1.TeamID `json:"team_id"`
Namespaces []string `json:"namespaces"`
}
func (h *KVStoreHandler) ListKVNamespaces(ctx context.Context, arg keybase1.ListKVNamespacesArg) (res keybase1.KVListNamespaceResult, err error) {
h.Lock()
defer h.Unlock()
return h.listKVNamespaceLocked(ctx, arg)
}
func (h *KVStoreHandler) listKVNamespaceLocked(ctx context.Context, arg keybase1.ListKVNamespacesArg) (res keybase1.KVListNamespaceResult, err error) {
ctx = libkb.WithLogTag(ctx, "KV")
mctx := libkb.NewMetaContext(ctx, h.G())
defer mctx.Trace(fmt.Sprintf("KVStoreHandler#ListKVNamespaces: t:%s", arg.TeamName), &err)()
if err := assertLoggedIn(ctx, h.G()); err != nil {
mctx.Debug("not logged in err: %v", err)
return res, err
}
teamID, err := h.resolveTeam(mctx, arg.TeamName)
if err != nil {
return res, err
}
var apiRes getListNamespacesAPIRes
apiArg := libkb.APIArg{
Endpoint: "team/storage/list",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{
"team_id": libkb.S{Val: teamID.String()},
},
}
err = mctx.G().API.GetDecode(mctx, apiArg, &apiRes)
if err != nil {
return res, err
}
if apiRes.TeamID != teamID {
mctx.Debug("list KV Namespaces server returned an unexpected, mismatching teamID")
return res, fmt.Errorf("expected teamID %s from the server, got %s", teamID, apiRes.TeamID)
}
return keybase1.KVListNamespaceResult{
TeamName: arg.TeamName,
Namespaces: apiRes.Namespaces,
}, nil
}
type getListEntriesAPIRes struct {
libkb.AppStatusEmbed
TeamID keybase1.TeamID `json:"team_id"`
Namespace string `json:"namespace"`
EntryKeys []compressedEntryKey `json:"entry_keys"`
}
type compressedEntryKey struct {
EntryKey string `json:"k"`
Revision int `json:"r"`
}
func (h *KVStoreHandler) ListKVEntries(ctx context.Context, arg keybase1.ListKVEntriesArg) (res keybase1.KVListEntryResult, err error) {
h.Lock()
defer h.Unlock()
return h.listKVEntriesLocked(ctx, arg)
}
func (h *KVStoreHandler) listKVEntriesLocked(ctx context.Context, arg keybase1.ListKVEntriesArg) (res keybase1.KVListEntryResult, err error) {
ctx = libkb.WithLogTag(ctx, "KV")
mctx := libkb.NewMetaContext(ctx, h.G())
defer mctx.Trace(fmt.Sprintf("KVStoreHandler#ListKVEntries: t:%s, n:%s", arg.TeamName, arg.Namespace), &err)()
if err := assertLoggedIn(ctx, h.G()); err != nil {
mctx.Debug("not logged in err: %v", err)
return res, err
}
teamID, err := h.resolveTeam(mctx, arg.TeamName)
if err != nil {
return res, err
}
var apiRes getListEntriesAPIRes
apiArg := libkb.APIArg{
Endpoint: "team/storage/list",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{
"team_id": libkb.S{Val: teamID.String()},
"namespace": libkb.S{Val: arg.Namespace},
},
}
err = mctx.G().API.GetDecode(mctx, apiArg, &apiRes)
if err != nil {
return res, err
}
if apiRes.TeamID != teamID {
mctx.Debug("list KV Namespaces server returned an unexpected, mismatching teamID")
return res, fmt.Errorf("expected teamID %s from the server, got %s", teamID, apiRes.TeamID)
}
if apiRes.Namespace != arg.Namespace {
mctx.Debug("list KV EntryKeys server returned an unexpected, mismatching namespace")
return res, fmt.Errorf("expected namespace %s from the server, got %s", arg.Namespace, apiRes.Namespace)
}
resKeys := []keybase1.KVListEntryKey{}
for _, ek := range apiRes.EntryKeys {
k := keybase1.KVListEntryKey{EntryKey: ek.EntryKey, Revision: ek.Revision}
resKeys = append(resKeys, k)
}
return keybase1.KVListEntryResult{
TeamName: arg.TeamName,
Namespace: arg.Namespace,
EntryKeys: resKeys,
}, nil
}