forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kbpki_client.go
450 lines (399 loc) · 15 KB
/
kbpki_client.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
// 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 (
"context"
"fmt"
"time"
lru "github.com/hashicorp/golang-lru"
"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/tlf"
kbname "github.com/keybase/client/go/kbun"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/logger"
"github.com/keybase/client/go/protocol/keybase1"
)
const (
idToUserCacheSize = 50
)
// keybaseServiceOwner is a wrapper around a KeybaseService, to allow
// switching the underlying service at runtime. It is usually
// implemented by Config.
type keybaseServiceOwner interface {
KeybaseService() KeybaseService
}
// KBPKIClient uses a KeybaseService.
type KBPKIClient struct {
serviceOwner keybaseServiceOwner
log logger.Logger
idToUserCache *lru.Cache
}
var _ KBPKI = (*KBPKIClient)(nil)
// NewKBPKIClient returns a new KBPKIClient with the given service.
func NewKBPKIClient(
serviceOwner keybaseServiceOwner, log logger.Logger) *KBPKIClient {
cache, err := lru.New(idToUserCacheSize)
if err != nil {
cache = nil
log.CDebugf(context.TODO(), "Error creating LRU cache: %+v", err)
}
return &KBPKIClient{serviceOwner, log, cache}
}
// GetCurrentSession implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) GetCurrentSession(ctx context.Context) (
idutil.SessionInfo, error) {
const sessionID = 0
return k.serviceOwner.KeybaseService().CurrentSession(ctx, sessionID)
}
// Resolve implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) Resolve(
ctx context.Context, assertion string,
offline keybase1.OfflineAvailability) (
kbname.NormalizedUsername, keybase1.UserOrTeamID, error) {
return k.serviceOwner.KeybaseService().Resolve(ctx, assertion, offline)
}
// Identify implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) Identify(
ctx context.Context, assertion, reason string,
offline keybase1.OfflineAvailability) (
kbname.NormalizedUsername, keybase1.UserOrTeamID, error) {
return k.serviceOwner.KeybaseService().Identify(
ctx, assertion, reason, offline)
}
// NormalizeSocialAssertion implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) NormalizeSocialAssertion(
ctx context.Context, assertion string) (keybase1.SocialAssertion, error) {
return k.serviceOwner.KeybaseService().NormalizeSocialAssertion(ctx, assertion)
}
// ResolveImplicitTeam implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) ResolveImplicitTeam(
ctx context.Context, assertions, suffix string, tlfType tlf.Type,
offline keybase1.OfflineAvailability) (
idutil.ImplicitTeamInfo, error) {
return k.serviceOwner.KeybaseService().ResolveIdentifyImplicitTeam(
ctx, assertions, suffix, tlfType, false, "", offline)
}
// ResolveImplicitTeamByID implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) ResolveImplicitTeamByID(
ctx context.Context, teamID keybase1.TeamID, tlfType tlf.Type,
offline keybase1.OfflineAvailability) (
idutil.ImplicitTeamInfo, error) {
name, err := k.serviceOwner.KeybaseService().ResolveImplicitTeamByID(
ctx, teamID)
if err != nil {
return idutil.ImplicitTeamInfo{}, err
}
assertions, suffix, err := tlf.SplitExtension(name)
if err != nil {
return idutil.ImplicitTeamInfo{}, err
}
return k.serviceOwner.KeybaseService().ResolveIdentifyImplicitTeam(
ctx, assertions, suffix, tlfType, false, "", offline)
}
// ResolveTeamTLFID implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) ResolveTeamTLFID(
ctx context.Context, teamID keybase1.TeamID,
offline keybase1.OfflineAvailability) (tlf.ID, error) {
settings, err := k.serviceOwner.KeybaseService().GetTeamSettings(
ctx, teamID, offline)
if err != nil {
return tlf.NullID, err
}
if settings.TlfID.IsNil() {
return tlf.NullID, err
}
tlfID, err := tlf.ParseID(settings.TlfID.String())
if err != nil {
return tlf.NullID, err
}
return tlfID, nil
}
// IdentifyImplicitTeam identifies (and creates if necessary) the
// given implicit team.
func (k *KBPKIClient) IdentifyImplicitTeam(
ctx context.Context, assertions, suffix string, tlfType tlf.Type,
reason string, offline keybase1.OfflineAvailability) (
idutil.ImplicitTeamInfo, error) {
return k.serviceOwner.KeybaseService().ResolveIdentifyImplicitTeam(
ctx, assertions, suffix, tlfType, true, reason, offline)
}
// GetNormalizedUsername implements the KBPKI interface for
// KBPKIClient.
func (k *KBPKIClient) GetNormalizedUsername(
ctx context.Context, id keybase1.UserOrTeamID,
offline keybase1.OfflineAvailability) (
username kbname.NormalizedUsername, err error) {
if k.idToUserCache != nil {
tmp, ok := k.idToUserCache.Get(id)
if ok {
username, ok = tmp.(kbname.NormalizedUsername)
if ok {
return username, nil
}
}
}
var assertion string
if id.IsUser() {
assertion = fmt.Sprintf("uid:%s", id)
} else {
assertion = fmt.Sprintf("tid:%s", id)
}
username, _, err = k.Resolve(ctx, assertion, offline)
if err != nil {
return kbname.NormalizedUsername(""), err
}
k.idToUserCache.Add(id, username)
return username, nil
}
func (k *KBPKIClient) hasVerifyingKey(
ctx context.Context, uid keybase1.UID, verifyingKey kbfscrypto.VerifyingKey,
atServerTime time.Time, offline keybase1.OfflineAvailability) (
bool, error) {
userInfo, err := k.loadUserPlusKeys(ctx, uid, verifyingKey.KID(), offline)
if err != nil {
return false, err
}
for _, key := range userInfo.VerifyingKeys {
if verifyingKey.KID().Equal(key.KID()) {
return true, nil
}
}
info, ok := userInfo.RevokedVerifyingKeys[verifyingKey]
if !ok {
return false, nil
}
// We add some slack to the revoke time, because the MD server
// won't instanteneously find out about the revoke -- it might
// keep accepting writes from the revoked device for a short
// period of time until it learns about the revoke.
const revokeSlack = 1 * time.Minute
revokedTime := keybase1.FromTime(info.Time)
// Check the server times -- if the key was valid at the given
// time, the caller can proceed with their merkle checking if
// desired.
if atServerTime.Before(revokedTime.Add(revokeSlack)) {
k.log.CDebugf(ctx, "Revoked verifying key %s for user %s passes time "+
"check (revoked time: %v vs. server time %v, slack=%s)",
verifyingKey.KID(), uid, revokedTime, atServerTime, revokeSlack)
return false, RevokedDeviceVerificationError{info}
}
k.log.CDebugf(ctx, "Not trusting revoked verifying key %s for "+
"user %s (revoked time: %v vs. server time %v, slack=%s)",
verifyingKey.KID(), uid, revokedTime, atServerTime, revokeSlack)
return false, nil
}
// HasVerifyingKey implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) HasVerifyingKey(
ctx context.Context, uid keybase1.UID, verifyingKey kbfscrypto.VerifyingKey,
atServerTime time.Time, offline keybase1.OfflineAvailability) error {
ok, err := k.hasVerifyingKey(ctx, uid, verifyingKey, atServerTime, offline)
if err != nil {
return err
}
if ok {
return nil
}
// If the first attempt couldn't find the key, try again after
// clearing our local cache. We might have stale info if the
// service hasn't learned of the users' new key yet.
k.serviceOwner.KeybaseService().FlushUserFromLocalCache(ctx, uid)
ok, err = k.hasVerifyingKey(ctx, uid, verifyingKey, atServerTime, offline)
if err != nil {
return err
}
if !ok {
return VerifyingKeyNotFoundError{verifyingKey}
}
return nil
}
func (k *KBPKIClient) loadUserPlusKeys(ctx context.Context,
uid keybase1.UID, pollForKID keybase1.KID,
offline keybase1.OfflineAvailability) (idutil.UserInfo, error) {
return k.serviceOwner.KeybaseService().LoadUserPlusKeys(
ctx, uid, pollForKID, offline)
}
// GetCryptPublicKeys implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) GetCryptPublicKeys(
ctx context.Context, uid keybase1.UID,
offline keybase1.OfflineAvailability) (
keys []kbfscrypto.CryptPublicKey, err error) {
userInfo, err := k.loadUserPlusKeys(ctx, uid, "", offline)
if err != nil {
return nil, err
}
return userInfo.CryptPublicKeys, nil
}
// GetTeamTLFCryptKeys implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) GetTeamTLFCryptKeys(
ctx context.Context, tid keybase1.TeamID, desiredKeyGen kbfsmd.KeyGen,
offline keybase1.OfflineAvailability) (
map[kbfsmd.KeyGen]kbfscrypto.TLFCryptKey, kbfsmd.KeyGen, error) {
teamInfo, err := k.serviceOwner.KeybaseService().LoadTeamPlusKeys(
ctx, tid, tlf.Unknown, desiredKeyGen, keybase1.UserVersion{},
kbfscrypto.VerifyingKey{}, keybase1.TeamRole_NONE, offline)
if err != nil {
return nil, 0, err
}
return teamInfo.CryptKeys, teamInfo.LatestKeyGen, nil
}
// GetCurrentMerkleRoot implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) GetCurrentMerkleRoot(ctx context.Context) (
keybase1.MerkleRootV2, time.Time, error) {
return k.serviceOwner.KeybaseService().GetCurrentMerkleRoot(ctx)
}
// VerifyMerkleRoot implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) VerifyMerkleRoot(
ctx context.Context, root keybase1.MerkleRootV2,
kbfsRoot keybase1.KBFSRoot) error {
return k.serviceOwner.KeybaseService().VerifyMerkleRoot(
ctx, root, kbfsRoot)
}
// IsTeamWriter implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) IsTeamWriter(
ctx context.Context, tid keybase1.TeamID, uid keybase1.UID,
verifyingKey kbfscrypto.VerifyingKey,
offline keybase1.OfflineAvailability) (bool, error) {
if uid.IsNil() || verifyingKey.IsNil() {
// A sessionless user can never be a writer.
return false, nil
}
// Use the verifying key to find out the eldest seqno of the user.
userInfo, err := k.loadUserPlusKeys(ctx, uid, verifyingKey.KID(), offline)
if err != nil {
return false, err
}
found := false
for _, key := range userInfo.VerifyingKeys {
if verifyingKey.KID().Equal(key.KID()) {
found = true
break
}
}
if !found {
// For the purposes of finding the eldest seqno, we need to
// check the verified key against the list of revoked keys as
// well. (The caller should use `HasVerifyingKey` later to
// check whether the revoked key was valid at the time of the
// update or not.)
_, found = userInfo.RevokedVerifyingKeys[verifyingKey]
}
if !found {
// The user doesn't currently have this KID, therefore they
// shouldn't be treated as a writer. The caller should check
// historical device records and team membership.
k.log.CDebugf(ctx, "User %s doesn't currently have verifying key %s",
uid, verifyingKey.KID())
return false, nil
}
desiredUser := keybase1.UserVersion{
Uid: uid,
EldestSeqno: userInfo.EldestSeqno,
}
teamInfo, err := k.serviceOwner.KeybaseService().LoadTeamPlusKeys(
ctx, tid, tlf.Unknown, kbfsmd.UnspecifiedKeyGen, desiredUser,
kbfscrypto.VerifyingKey{}, keybase1.TeamRole_WRITER, offline)
if err != nil {
if tid.IsPublic() {
if _, notFound := err.(libkb.NotFoundError); notFound {
// We are probably just not a writer of this public team.
k.log.CDebugf(ctx,
"Ignoring not found error for public team: %+v", err)
return false, nil
}
}
return false, err
}
return teamInfo.Writers[uid], nil
}
// NoLongerTeamWriter implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) NoLongerTeamWriter(
ctx context.Context, tid keybase1.TeamID, tlfType tlf.Type,
uid keybase1.UID, verifyingKey kbfscrypto.VerifyingKey,
offline keybase1.OfflineAvailability) (keybase1.MerkleRootV2, error) {
if uid.IsNil() || verifyingKey.IsNil() {
// A sessionless user can never be a writer.
return keybase1.MerkleRootV2{}, nil
}
// We don't need the eldest seqno when we look up an older writer,
// the service takes care of that for us.
desiredUser := keybase1.UserVersion{
Uid: uid,
}
teamInfo, err := k.serviceOwner.KeybaseService().LoadTeamPlusKeys(
ctx, tid, tlfType, kbfsmd.UnspecifiedKeyGen, desiredUser,
verifyingKey, keybase1.TeamRole_WRITER, offline)
if err != nil {
return keybase1.MerkleRootV2{}, err
}
return teamInfo.LastWriters[verifyingKey], nil
}
// IsTeamReader implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) IsTeamReader(
ctx context.Context, tid keybase1.TeamID, uid keybase1.UID,
offline keybase1.OfflineAvailability) (bool, error) {
desiredUser := keybase1.UserVersion{Uid: uid}
teamInfo, err := k.serviceOwner.KeybaseService().LoadTeamPlusKeys(
ctx, tid, tlf.Unknown, kbfsmd.UnspecifiedKeyGen, desiredUser,
kbfscrypto.VerifyingKey{}, keybase1.TeamRole_READER, offline)
if err != nil {
return false, err
}
return tid.IsPublic() || teamInfo.Writers[uid] || teamInfo.Readers[uid], nil
}
// GetTeamRootID implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) GetTeamRootID(
ctx context.Context, tid keybase1.TeamID,
offline keybase1.OfflineAvailability) (keybase1.TeamID, error) {
if !tid.IsSubTeam() {
return tid, nil
}
teamInfo, err := k.serviceOwner.KeybaseService().LoadTeamPlusKeys(
ctx, tid, tlf.Unknown, kbfsmd.UnspecifiedKeyGen, keybase1.UserVersion{},
kbfscrypto.VerifyingKey{}, keybase1.TeamRole_NONE, offline)
if err != nil {
return keybase1.TeamID(""), err
}
return teamInfo.RootID, nil
}
// CreateTeamTLF implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) CreateTeamTLF(
ctx context.Context, teamID keybase1.TeamID, tlfID tlf.ID) error {
return k.serviceOwner.KeybaseService().CreateTeamTLF(ctx, teamID, tlfID)
}
// FavoriteAdd implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) FavoriteAdd(ctx context.Context, folder keybase1.FolderHandle) error {
return k.serviceOwner.KeybaseService().FavoriteAdd(ctx, folder)
}
// FavoriteDelete implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) FavoriteDelete(ctx context.Context, folder keybase1.FolderHandle) error {
return k.serviceOwner.KeybaseService().FavoriteDelete(ctx, folder)
}
// FavoriteList implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) FavoriteList(ctx context.Context) (
keybase1.FavoritesResult, error) {
const sessionID = 0
return k.serviceOwner.KeybaseService().FavoriteList(ctx, sessionID)
}
// Notify implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) Notify(ctx context.Context, notification *keybase1.FSNotification) error {
return k.serviceOwner.KeybaseService().Notify(ctx, notification)
}
// NotifyPathUpdated implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) NotifyPathUpdated(
ctx context.Context, path string) error {
return k.serviceOwner.KeybaseService().NotifyPathUpdated(ctx, path)
}
// PutGitMetadata implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) PutGitMetadata(
ctx context.Context, folder keybase1.FolderHandle, repoID keybase1.RepoID,
metadata keybase1.GitLocalMetadata) error {
return k.serviceOwner.KeybaseService().PutGitMetadata(
ctx, folder, repoID, metadata)
}
// InvalidateTeamCacheForID implements the KBPKI interface for KBPKIClient.
func (k *KBPKIClient) InvalidateTeamCacheForID(tid keybase1.TeamID) {
k.idToUserCache.Remove(tid.AsUserOrTeam())
}