This repository has been archived by the owner on Jul 7, 2020. It is now read-only.
forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
user_ek.go
406 lines (358 loc) · 15.2 KB
/
user_ek.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
package ephemeral
import (
"context"
"encoding/json"
"fmt"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/protocol/keybase1"
)
type UserEKSeed keybase1.Bytes32
func newUserEphemeralSeed() (seed UserEKSeed, err error) {
randomSeed, err := makeNewRandomSeed()
if err != nil {
return seed, err
}
return UserEKSeed(randomSeed), nil
}
func newUserEKSeedFromBytes(b []byte) (s UserEKSeed, err error) {
seed, err := newEKSeedFromBytes(b)
if err != nil {
return s, err
}
return UserEKSeed(seed), nil
}
func (s *UserEKSeed) DeriveDHKey() *libkb.NaclDHKeyPair {
return deriveDHKey(keybase1.Bytes32(*s), libkb.DeriveReasonUserEKEncryption)
}
// Upload a new userEK directly, when we're not adding it to a PUK or device
// transaction.
func postNewUserEK(ctx context.Context, g *libkb.GlobalContext, sig string, boxes []keybase1.UserEkBoxMetadata) (err error) {
defer g.CTraceTimed(ctx, "postNewUserEK", func() error { return err })()
boxesJSON, err := json.Marshal(boxes)
if err != nil {
return err
}
apiArg := libkb.APIArg{
Endpoint: "user/user_ek",
SessionType: libkb.APISessionTypeREQUIRED,
NetContext: ctx,
Args: libkb.HTTPArgs{
"sig": libkb.S{Val: sig},
"boxes": libkb.S{Val: string(boxesJSON)},
},
}
_, err = g.GetAPI().Post(apiArg)
return err
}
// There are two cases where we need to generate a new userEK. One is where
// we're rolling the userEK by itself, and we need to sign it with the current
// PUK. The other is where we're rolling the PUK, and we need to sign a new
// userEK with the new PUK to upload both together. This helper covers the
// steps common to both cases.
func prepareNewUserEK(ctx context.Context, g *libkb.GlobalContext, merkleRoot libkb.MerkleRoot, pukSigning *libkb.NaclSigningKeyPair) (sig string, boxes []keybase1.UserEkBoxMetadata, newMetadata keybase1.UserEkMetadata, myBox *keybase1.UserEkBoxed, err error) {
defer g.CTraceTimed(ctx, "prepareNewUserEK", func() error { return err })()
seed, err := newUserEphemeralSeed()
if err != nil {
return "", nil, newMetadata, nil, err
}
prevStatement, latestGeneration, wrongKID, err := fetchUserEKStatement(ctx, g, g.Env.GetUID())
if !wrongKID && err != nil {
return "", nil, newMetadata, nil, err
}
var newGeneration keybase1.EkGeneration
var existingMaybeStaleMetadata []keybase1.UserEkMetadata
if prevStatement == nil {
// Even if the userEK statement was signed by the wrong key (this can
// happen when legacy clients roll the PUK), fetchUserEKStatement will
// return the generation number from the last (unverifiable) statement.
// If there was never any statement, latestGeneration will be 0, so
// adding one is correct in all cases.
newGeneration = latestGeneration + 1
} else {
newGeneration = prevStatement.CurrentUserEkMetadata.Generation + 1
existingMaybeStaleMetadata = append(existingMaybeStaleMetadata, prevStatement.ExistingUserEkMetadata...)
existingMaybeStaleMetadata = append(existingMaybeStaleMetadata, prevStatement.CurrentUserEkMetadata)
}
dhKeypair := seed.DeriveDHKey()
metadata := keybase1.UserEkMetadata{
Kid: dhKeypair.GetKID(),
Generation: newGeneration,
HashMeta: merkleRoot.HashMeta(),
// The ctime is derivable from the hash meta, by fetching the hashed
// root from the server, but including it saves readers a potential
// extra round trip.
Ctime: keybase1.TimeFromSeconds(merkleRoot.Ctime()),
}
// Filter out the still-active userEKs, those less than a week old. Make
// sure that if there are none, we use an empty slice instead of nil.
// Although those are practically the same in Go, they get serialized to
// different JSON.
existingActiveMetadata := []keybase1.UserEkMetadata{}
for _, metadata := range existingMaybeStaleMetadata {
if ctimeIsStale(metadata.Ctime, merkleRoot) {
g.Log.CDebugf(ctx, "skipping stale UserEkMetadata for KID: %s", metadata.Kid)
continue
}
existingActiveMetadata = append(existingActiveMetadata, metadata)
}
statement := keybase1.UserEkStatement{
CurrentUserEkMetadata: metadata,
ExistingUserEkMetadata: existingActiveMetadata,
}
statementJSON, err := json.Marshal(statement)
if err != nil {
return "", nil, newMetadata, nil, err
}
sig, _, err = pukSigning.SignToString(statementJSON)
if err != nil {
return "", nil, newMetadata, nil, err
}
boxes, myUserEKBoxed, err := boxUserEKForDevices(ctx, g, merkleRoot, seed, metadata)
if err != nil {
return "", nil, newMetadata, nil, err
}
return sig, boxes, metadata, myUserEKBoxed, nil
}
// Create a new userEK and upload it. Add our box to the local box store.
func publishNewUserEK(ctx context.Context, g *libkb.GlobalContext, merkleRoot libkb.MerkleRoot) (metadata keybase1.UserEkMetadata, err error) {
defer g.CTraceTimed(ctx, "publishNewUserEK", func() error { return err })()
// Sign the statement blob with the latest PUK.
pukKeyring, err := g.GetPerUserKeyring()
if err != nil {
return metadata, err
}
pukSigning, err := pukKeyring.GetLatestSigningKey(libkb.NewMetaContext(ctx, g))
if err != nil {
return metadata, err
}
sig, boxes, newMetadata, myBox, err := prepareNewUserEK(ctx, g, merkleRoot, pukSigning)
if err != nil {
return metadata, err
}
err = postNewUserEK(ctx, g, sig, boxes)
if err != nil {
return metadata, err
}
// Cache the new box after we see the post succeeded.
if myBox == nil {
g.Log.CDebugf(ctx, "No box made for own deviceEK")
} else {
storage := g.GetUserEKBoxStorage()
err = storage.Put(ctx, newMetadata.Generation, *myBox)
}
return newMetadata, err
}
func ForcePublishNewUserEKForTesting(ctx context.Context, g *libkb.GlobalContext, merkleRoot libkb.MerkleRoot) (metadata keybase1.UserEkMetadata, err error) {
defer g.CTraceTimed(ctx, "ForcePublishNewUserEKForTesting", func() error { return err })()
return publishNewUserEK(ctx, g, merkleRoot)
}
func boxUserEKForDevices(ctx context.Context, g *libkb.GlobalContext, merkleRoot libkb.MerkleRoot, seed UserEKSeed, userMetadata keybase1.UserEkMetadata) (boxes []keybase1.UserEkBoxMetadata, myUserEKBoxed *keybase1.UserEkBoxed, err error) {
defer g.CTraceTimed(ctx, "boxUserEKForDevices", func() error { return err })()
devicesMetadata, err := allActiveDeviceEKMetadata(ctx, g, merkleRoot)
if err != nil {
return nil, nil, err
}
myDeviceID := g.Env.GetDeviceID()
for deviceID, deviceMetadata := range devicesMetadata {
recipientKey, err := libkb.ImportKeypairFromKID(deviceMetadata.Kid)
if err != nil {
return nil, nil, err
}
// Encrypting with a nil sender means we'll generate a random sender private key.
box, err := recipientKey.EncryptToString(seed[:], nil)
if err != nil {
return nil, nil, err
}
boxMetadata := keybase1.UserEkBoxMetadata{
RecipientDeviceID: deviceID,
RecipientGeneration: deviceMetadata.Generation,
Box: box,
}
boxes = append(boxes, boxMetadata)
if deviceID == myDeviceID {
myUserEKBoxed = &keybase1.UserEkBoxed{
Box: box,
DeviceEkGeneration: deviceMetadata.Generation,
Metadata: userMetadata,
}
}
}
return boxes, myUserEKBoxed, nil
}
type userEKStatementResponse struct {
Sigs map[keybase1.UID]*string `json:"sigs"`
}
// Returns nil if the user has never published a userEK. If the user has
// published a userEK, but has since rolled their PUK without publishing a new
// one, this function will also return nil and log a warning. This is a
// transitional thing, and eventually when all "reasonably up to date" clients
// in the wild have EK support, we will make that case an error.
func fetchUserEKStatements(ctx context.Context, g *libkb.GlobalContext, uids []keybase1.UID) (statements map[keybase1.UID]*keybase1.UserEkStatement, err error) {
defer g.CTraceTimed(ctx, fmt.Sprintf("fetchUserEKStatements: numUids: %v", len(uids)), func() error { return err })()
apiArg := libkb.APIArg{
Endpoint: "user/user_ek",
SessionType: libkb.APISessionTypeREQUIRED,
NetContext: ctx,
Args: libkb.HTTPArgs{
"uids": libkb.S{Val: libkb.UidsToString(uids)},
},
}
res, err := g.GetAPI().Get(apiArg)
if err != nil {
return nil, err
}
parsedResponse := userEKStatementResponse{}
err = res.Body.UnmarshalAgain(&parsedResponse)
if err != nil {
return nil, err
}
statements = make(map[keybase1.UID]*keybase1.UserEkStatement)
for uid, sig := range parsedResponse.Sigs {
statement, _, wrongKID, err := verifySigWithLatestPUK(ctx, g, uid, *sig)
// Check the wrongKID condition before checking the error, since an error
// is still returned in this case. TODO: Turn this warning into an error
// after EK support is sufficiently widespread.
if wrongKID {
g.Log.CDebugf(ctx, "It looks like you revoked a device without generating new ephemeral keys. Are you running an old version?")
// Don't include this statement since it is invalid.
continue
} else if err != nil {
return nil, err
}
statements[uid] = statement
}
return statements, nil
}
// Returns nil if the user has never published a userEK. If the user has
// published a userEK, but has since rolled their PUK without publishing a new
// one, this function will return wrongKID. This allows clients to chose the
// correct generation number but not include the statement when generating a
// new userEK.
func fetchUserEKStatement(ctx context.Context, g *libkb.GlobalContext, uid keybase1.UID) (statement *keybase1.UserEkStatement, latestGeneration keybase1.EkGeneration, wrongKID bool, err error) {
defer g.CTraceTimed(ctx, "fetchUserEKStatement", func() error { return err })()
apiArg := libkb.APIArg{
Endpoint: "user/user_ek",
SessionType: libkb.APISessionTypeREQUIRED,
NetContext: ctx,
Args: libkb.HTTPArgs{
"uids": libkb.S{Val: libkb.UidsToString([]keybase1.UID{uid})},
},
}
res, err := g.GetAPI().Get(apiArg)
if err != nil {
return nil, latestGeneration, false, err
}
parsedResponse := userEKStatementResponse{}
err = res.Body.UnmarshalAgain(&parsedResponse)
if err != nil {
return nil, latestGeneration, false, err
}
// User has no statements
if len(parsedResponse.Sigs) == 0 {
return nil, latestGeneration, false, nil
}
if len(parsedResponse.Sigs) != 1 {
return nil, latestGeneration, false, fmt.Errorf("Invalid server response, multiple userEK statements returned")
}
sig, ok := parsedResponse.Sigs[uid]
if !ok {
return nil, latestGeneration, false, fmt.Errorf("Invalid server response, wrong uid returned")
}
statement, latestGeneration, wrongKID, err = verifySigWithLatestPUK(ctx, g, uid, *sig)
// Check the wrongKID condition before checking the error, since an error
// is still returned in this case. TODO: Turn this warning into an error
// after EK support is sufficiently widespread.
if wrongKID {
g.Log.CDebugf(ctx, "It looks like you revoked a device without generating new ephemeral keys. Are you running an old version?")
return nil, latestGeneration, true, nil
} else if err != nil {
return nil, latestGeneration, false, err
}
return statement, latestGeneration, false, nil
}
func extractUserEKStatementFromSig(sig string) (signerKey libkb.GenericKey, statement *keybase1.UserEkStatement, err error) {
signerKey, payload, _, err := libkb.NaclVerifyAndExtract(sig)
if err != nil {
return signerKey, nil, err
}
parsedStatement := keybase1.UserEkStatement{}
if err = json.Unmarshal(payload, &parsedStatement); err != nil {
return signerKey, nil, err
}
return signerKey, &parsedStatement, nil
}
// Verify that the blob is validly signed, and that the signing key is the
// given user's latest PUK, then parse its contents. If the blob is signed by
// the wrong KID, that's still an error, but we'll also return this special
// `wrongKID` flag. As a transitional measure while we wait for all clients in
// the wild to have EK support, callers will treat that case as "there is no
// key" and convert the error to a warning. We set `latestGeneration` so that
// callers can use this value to generate a new key even if `wrongKID` is set.
func verifySigWithLatestPUK(ctx context.Context, g *libkb.GlobalContext, uid keybase1.UID, sig string) (statement *keybase1.UserEkStatement, latestGeneration keybase1.EkGeneration, wrongKID bool, err error) {
defer g.CTraceTimed(ctx, "verifySigWithLatestPUK", func() error { return err })()
// Parse the statement before we verify the signing key. Even if the
// signing key is bad (likely because of a legacy PUK roll that didn't
// include a userEK statement), we'll still return the generation number.
signerKey, parsedStatement, err := extractUserEKStatementFromSig(sig)
if err != nil {
return nil, latestGeneration, false, err
}
latestGeneration = parsedStatement.CurrentUserEkMetadata.Generation
// Verify the signing key corresponds to the latest PUK. We load the user's
// UPAK from cache, but if the KID doesn't match, we try a forced reload to
// see if the cache might've been stale. Only if the KID still doesn't
// match after the reload do we complain.
upak, _, err := g.GetUPAKLoader().LoadV2(libkb.NewLoadUserByUIDArg(ctx, g, uid))
if err != nil {
return nil, latestGeneration, false, err
}
latestPUK := upak.Current.GetLatestPerUserKey()
if latestPUK == nil || !latestPUK.SigKID.Equal(signerKey.GetKID()) {
// The latest PUK might be stale. Force a reload, then check this over again.
upak, _, err = g.GetUPAKLoader().LoadV2(libkb.NewLoadUserByUIDForceArg(g, uid))
if err != nil {
return nil, latestGeneration, false, err
}
latestPUK = upak.Current.GetLatestPerUserKey()
if latestPUK == nil || !latestPUK.SigKID.Equal(signerKey.GetKID()) {
// The latest PUK still doesn't match the signing key after a
// forced reload. Bail out, and set the `wrongKID` flag.
latestPUKSigningKIDString := "<nil>"
if latestPUK != nil {
latestPUKSigningKIDString = fmt.Sprint(latestPUK.SigKID)
}
err = fmt.Errorf("userEK returned for PUK signing KID %s, but latest is %s",
signerKey.GetKID(), latestPUKSigningKIDString)
return nil, latestGeneration, true, err
}
}
return parsedStatement, latestGeneration, false, nil
}
func filterStaleUserEKStatements(ctx context.Context, g *libkb.GlobalContext, statementMap map[keybase1.UID]*keybase1.UserEkStatement, merkleRoot libkb.MerkleRoot) (activeMap map[keybase1.UID]keybase1.UserEkStatement, err error) {
defer g.CTraceTimed(ctx, fmt.Sprintf("filterStaleUserEKStatements: numStatements: %v", len(statementMap)), func() error { return err })()
activeMap = make(map[keybase1.UID]keybase1.UserEkStatement)
for uid, statement := range statementMap {
if statement == nil {
g.Log.CDebugf(ctx, "found stale userStatement for uid: %s", uid)
continue
}
metadata := statement.CurrentUserEkMetadata
if ctimeIsStale(metadata.Ctime, merkleRoot) {
g.Log.CDebugf(ctx, "found stale userStatement for KID: %s", metadata.Kid)
continue
}
activeMap[uid] = *statement
}
return activeMap, nil
}
func activeUserEKMetadata(ctx context.Context, g *libkb.GlobalContext, statementMap map[keybase1.UID]*keybase1.UserEkStatement, merkleRoot libkb.MerkleRoot) (activeMetadata map[keybase1.UID]keybase1.UserEkMetadata, err error) {
activeMap, err := filterStaleUserEKStatements(ctx, g, statementMap, merkleRoot)
if err != nil {
return nil, err
}
activeMetadata = make(map[keybase1.UID]keybase1.UserEkMetadata)
for uid, statement := range activeMap {
activeMetadata[uid] = statement.CurrentUserEkMetadata
}
return activeMetadata, nil
}