-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
device_keygen.go
454 lines (384 loc) · 12.3 KB
/
device_keygen.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 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package engine
import (
"errors"
"fmt"
"github.com/keybase/client/go/kbcrypto"
"github.com/keybase/client/go/libkb"
keybase1 "github.com/keybase/client/go/protocol/keybase1"
)
type DeviceKeygenArgs struct {
Me *libkb.User
DeviceID keybase1.DeviceID
DeviceName string
DeviceType keybase1.DeviceTypeV2
Lks *libkb.LKSec
IsEldest bool
IsSelfProvision bool
PerUserKeyring *libkb.PerUserKeyring
EkReboxer *ephemeralKeyReboxer
// Used in tests for reproducible key generation
naclSigningKeyPair libkb.NaclKeyPair
naclEncryptionKeyPair libkb.NaclKeyPair
}
// DeviceKeygenPushArgs determines how the push will run. There are
// currently three different paths it can take:
//
// 1. this device is the eldest device: pushes eldest signing
// key, encryption subkey. (IsEldest => true)
//
// 2. this device is a sibling (but we're not in a key exchange
// scenario): pushes sibkey signing key, encryption subkey.
// (IsEldest => False, SkipSignerPush => false, Signer != nil,
// EldestKID != nil)
//
// 3. this device is a sibling, but another device pushed
// the signing key, so skip that part.
// (IsEldest => False, SkipSignerPush => true, Signer != nil,
// EldestKID != nil)
//
// The User argument is optional, but it is necessary if the
// user's sigchain changes between key generation and key push.
type DeviceKeygenPushArgs struct {
SkipSignerPush bool
Signer libkb.GenericKey
EldestKID keybase1.KID
User *libkb.User // optional
}
type DeviceKeygen struct {
args *DeviceKeygenArgs
runErr error
pushErr error
naclSignGen *libkb.NaclKeyGen
naclEncGen *libkb.NaclKeyGen
// can be nil
perUserKeySeed *libkb.PerUserKeySeed
libkb.Contextified
}
// NewDeviceKeygen creates a DeviceKeygen engine.
func NewDeviceKeygen(g *libkb.GlobalContext, args *DeviceKeygenArgs) *DeviceKeygen {
return &DeviceKeygen{
args: args,
Contextified: libkb.NewContextified(g),
}
}
// Name is the unique engine name.
func (e *DeviceKeygen) Name() string {
return "DeviceKeygen"
}
// GetPrereqs returns the engine prereqs.
func (e *DeviceKeygen) Prereqs() Prereqs {
return Prereqs{TemporarySession: true}
}
// RequiredUIs returns the required UIs.
func (e *DeviceKeygen) RequiredUIs() []libkb.UIKind {
return []libkb.UIKind{
libkb.LogUIKind,
}
}
// SubConsumers returns the other UI consumers for this engine.
func (e *DeviceKeygen) SubConsumers() []libkb.UIConsumer {
return nil
}
// Run starts the engine.
func (e *DeviceKeygen) Run(m libkb.MetaContext) (err error) {
defer m.Trace("DeviceKeygen#Run", &err)()
e.setup(m)
e.generate(m)
e.localSave(m)
return e.runErr
}
func (e *DeviceKeygen) SigningKeyPublic() (kbcrypto.NaclSigningKeyPublic, error) {
s, ok := e.naclSignGen.GetKeyPair().(libkb.NaclSigningKeyPair)
if !ok {
return kbcrypto.NaclSigningKeyPublic{}, kbcrypto.BadKeyError{Msg: fmt.Sprintf("invalid key type %T", e.naclSignGen.GetKeyPair())}
}
return s.Public, nil
}
func (e *DeviceKeygen) SigningKey() libkb.NaclKeyPair {
return e.naclSignGen.GetKeyPair()
}
func (e *DeviceKeygen) EncryptionKey() libkb.NaclDHKeyPair {
return e.naclEncGen.GetKeyPair().(libkb.NaclDHKeyPair)
}
// Push pushes the generated keys to the api server and stores the
// local key security server half on the api server as well.
func (e *DeviceKeygen) Push(m libkb.MetaContext, pargs *DeviceKeygenPushArgs) (err error) {
var encSigner libkb.GenericKey
eldestKID := pargs.EldestKID
ds := []libkb.Delegator{}
m.Debug("DeviceKeygen#Push PUK(upgrade:%v)", m.G().Env.GetUpgradePerUserKey())
var pukBoxes = []keybase1.PerUserKeyBox{}
if e.G().Env.GetUpgradePerUserKey() && e.args.IsEldest {
if e.perUserKeySeed == nil {
return errors.New("missing new per user key")
}
// Encrypt the new per-user-key for this eldest device.
pukBox, err := libkb.NewPerUserKeyBox(
*e.perUserKeySeed, // inner key to be encrypted
e.EncryptionKey(), // receiver key (device enc key)
e.EncryptionKey(), // sender key (device enc key)
keybase1.PerUserKeyGeneration(1))
if err != nil {
return err
}
pukBoxes = append(pukBoxes, pukBox)
}
if !e.args.IsEldest || e.args.IsSelfProvision {
boxes, err := e.preparePerUserKeyBoxFromProvisioningKey(m)
if err != nil {
return err
}
pukBoxes = append(pukBoxes, boxes...)
}
// append the signing key
if e.args.IsEldest {
ds = e.appendEldest(m, ds, pargs)
encSigner = e.naclSignGen.GetKeyPair()
eldestKID = encSigner.GetKID()
} else if !pargs.SkipSignerPush {
ds = e.appendSibkey(m, ds, pargs)
encSigner = e.naclSignGen.GetKeyPair()
} else {
encSigner = pargs.Signer
}
ds = e.appendEncKey(m, ds, encSigner, eldestKID, pargs.User)
var userEKReboxArg *keybase1.UserEkReboxArg
if e.args.IsSelfProvision {
userEKReboxArg, err = e.reboxUserEK(m, encSigner)
if err != nil {
return err
}
}
var pukSigProducer libkb.AggSigProducer // = nil
// PerUserKey does not use Delegator.
if e.G().Env.GetUpgradePerUserKey() && e.args.IsEldest {
// Sign in the new per-user-key
if e.perUserKeySeed == nil {
return errors.New("missing new per user key")
}
pukSigProducer = func() (libkb.JSONPayload, keybase1.Seqno, libkb.LinkID, error) {
gen := keybase1.PerUserKeyGeneration(1)
rev, err := libkb.PerUserKeyProofReverseSigned(m, e.args.Me, *e.perUserKeySeed, gen, encSigner)
if err != nil {
return nil, 0, nil, err
}
return rev.Payload, rev.Seqno, rev.LinkID, nil
}
}
e.pushErr = libkb.DelegatorAggregator(m, ds, pukSigProducer, pukBoxes, nil, userEKReboxArg)
// push the LKS server half
e.pushLKS(m)
return e.pushErr
}
func (e *DeviceKeygen) setup(m libkb.MetaContext) {
defer m.Trace("DeviceKeygen#setup", &e.runErr)()
if e.runErr != nil {
return
}
e.naclSignGen = e.newNaclKeyGen(m, func() (libkb.NaclKeyPair, error) {
if e.args.naclSigningKeyPair != nil {
return e.args.naclSigningKeyPair, nil
}
kp, err := libkb.GenerateNaclSigningKeyPair()
if err != nil {
return nil, err
}
return kp, nil
}, e.device(), libkb.NaclEdDSAExpireIn)
e.naclEncGen = e.newNaclKeyGen(m, func() (libkb.NaclKeyPair, error) {
if e.args.naclEncryptionKeyPair != nil {
return e.args.naclEncryptionKeyPair, nil
}
kp, err := libkb.GenerateNaclDHKeyPair()
if err != nil {
return nil, err
}
return kp, nil
}, e.device(), libkb.NaclDHExpireIn)
}
func (e *DeviceKeygen) generate(m libkb.MetaContext) {
defer m.Trace("DeviceKeygen#generate", &e.runErr)()
if e.runErr != nil {
return
}
if e.runErr = e.naclSignGen.Generate(); e.runErr != nil {
return
}
if e.runErr = e.naclEncGen.Generate(); e.runErr != nil {
return
}
if e.G().Env.GetUpgradePerUserKey() && e.args.IsEldest {
seed, err := libkb.GeneratePerUserKeySeed()
if err != nil {
e.runErr = err
return
}
e.perUserKeySeed = &seed
}
}
func (e *DeviceKeygen) localSave(m libkb.MetaContext) {
defer m.Trace("DeviceKeygen#localSave", &e.runErr)()
if e.runErr != nil {
return
}
if e.args.DeviceType == keybase1.DeviceTypeV2_PAPER {
m.Debug("Not writing out paper key to local storage")
return
}
if e.runErr = e.naclSignGen.SaveLKS(m, e.args.Lks); e.runErr != nil {
return
}
if e.runErr = e.naclEncGen.SaveLKS(m, e.args.Lks); e.runErr != nil {
return
}
}
func (e *DeviceKeygen) reboxUserEK(m libkb.MetaContext, signingKey libkb.GenericKey) (reboxArg *keybase1.UserEkReboxArg, err error) {
defer m.Trace("DeviceKeygen#reboxUserEK", &err)()
ekKID, err := e.args.EkReboxer.getDeviceEKKID(m)
if err != nil {
return nil, err
}
userEKBox, err := makeUserEKBoxForProvisionee(m, ekKID)
if err != nil {
return nil, err
}
return e.args.EkReboxer.getReboxArg(m, userEKBox, e.args.DeviceID, signingKey)
}
func (e *DeviceKeygen) appendEldest(m libkb.MetaContext, ds []libkb.Delegator, pargs *DeviceKeygenPushArgs) []libkb.Delegator {
defer m.Trace("DeviceKeygen#appendEldest", &e.pushErr)()
if e.pushErr != nil {
return ds
}
var d libkb.Delegator
d, e.pushErr = e.naclSignGen.Push(m, true)
if e.pushErr == nil {
return append(ds, d)
}
return ds
}
func (e *DeviceKeygen) appendSibkey(m libkb.MetaContext, ds []libkb.Delegator, pargs *DeviceKeygenPushArgs) []libkb.Delegator {
defer m.Trace("DeviceKeygen#appendSibkey", &e.pushErr)()
if e.pushErr != nil {
return ds
}
var d libkb.Delegator
e.naclSignGen.UpdateArg(pargs.Signer, pargs.EldestKID, libkb.DelegationTypeSibkey, pargs.User)
d, e.pushErr = e.naclSignGen.Push(m, true)
if e.pushErr == nil {
return append(ds, d)
}
return ds
}
func (e *DeviceKeygen) appendEncKey(m libkb.MetaContext, ds []libkb.Delegator, signer libkb.GenericKey, eldestKID keybase1.KID, user *libkb.User) []libkb.Delegator {
defer m.Trace("DeviceKeygen#appendEncKey", &e.pushErr)()
if e.pushErr != nil {
return ds
}
e.naclEncGen.UpdateArg(signer, eldestKID, libkb.DelegationTypeSubkey, user)
var d libkb.Delegator
d, e.pushErr = e.naclEncGen.Push(m, true)
if e.pushErr == nil {
return append(ds, d)
}
return ds
}
func (e *DeviceKeygen) generateClientHalfRecovery(m libkb.MetaContext) (ctext string, kid keybase1.KID, err error) {
defer m.Trace("DeviceKeygen#generateClientHalfRecovery", &err)()
key := e.naclEncGen.GetKeyPair()
kid = key.GetKID()
ctext, err = e.args.Lks.EncryptClientHalfRecovery(key)
return ctext, kid, err
}
func (e *DeviceKeygen) pushLKS(m libkb.MetaContext) {
defer m.Trace("DeviceKeygen#pushLKS", &e.pushErr)()
if e.pushErr != nil {
return
}
if e.args.Lks == nil {
e.pushErr = errors.New("no local key security set")
return
}
serverHalf := e.args.Lks.GetServerHalf()
if serverHalf.IsNil() {
e.pushErr = errors.New("LKS server half is empty, and should not be")
return
}
var chr string
var chrk keybase1.KID
if chr, chrk, e.pushErr = e.generateClientHalfRecovery(m); e.pushErr != nil {
return
}
e.pushErr = libkb.PostDeviceLKS(m, e.args.DeviceID, e.args.DeviceType, serverHalf, e.args.Lks.Generation(), chr, chrk)
if e.pushErr != nil {
return
}
}
func (e *DeviceKeygen) newNaclKeyGen(m libkb.MetaContext, gen libkb.NaclGenerator, device *libkb.Device, expire int) *libkb.NaclKeyGen {
return libkb.NewNaclKeyGen(libkb.NaclKeyGenArg{
Generator: gen,
Device: device,
Me: e.args.Me,
ExpireIn: expire,
})
}
func (e *DeviceKeygen) device() *libkb.Device {
s := libkb.DeviceStatusActive
return &libkb.Device{
ID: e.args.DeviceID,
Description: &e.args.DeviceName,
Type: e.args.DeviceType,
Status: &s,
}
}
// Can return no boxes if there are no per-user-keys.
func (e *DeviceKeygen) preparePerUserKeyBoxFromProvisioningKey(m libkb.MetaContext) ([]keybase1.PerUserKeyBox, error) {
// Assuming this is a paperkey or self provision.
upak := e.args.Me.ExportToUserPlusAllKeys()
if len(upak.Base.PerUserKeys) == 0 {
m.Debug("DeviceKeygen skipping per-user-keys, none exist")
return nil, nil
}
pukring := e.args.PerUserKeyring
if pukring == nil {
return nil, errors.New("missing PerUserKeyring")
}
provisioningKey := m.ActiveDevice().ProvisioningKey(m)
var provisioningSigKey, provisioningEncKeyGeneric libkb.GenericKey
if provisioningKey != nil {
provisioningSigKey = provisioningKey.SigningKey()
provisioningEncKeyGeneric = provisioningKey.EncryptionKey()
}
if provisioningSigKey == nil && provisioningEncKeyGeneric == nil {
// GPG provisioning is not supported when the user has per-user-keys.
// This is the error that manifests. See CORE-4960
return nil, errors.New("missing provisioning key in login context")
}
if provisioningSigKey == nil {
return nil, errors.New("missing provisioning sig key")
}
if provisioningEncKeyGeneric == nil {
return nil, errors.New("missing provisioning enc key")
}
provisioningEncKey, ok := provisioningEncKeyGeneric.(libkb.NaclDHKeyPair)
if !ok {
return nil, errors.New("Unexpected encryption key type")
}
provisioningDeviceID, err := upak.GetDeviceID(provisioningSigKey.GetKID())
if err != nil {
return nil, err
}
err = pukring.SyncAsProvisioningKey(m, &upak, provisioningDeviceID, provisioningEncKey)
if err != nil {
return nil, err
}
if !pukring.HasAnyKeys() {
return nil, nil
}
pukBox, err := pukring.PrepareBoxForNewDevice(m,
e.EncryptionKey(), // receiver key: provisionee enc
provisioningEncKey, // sender key: provisioning key enc
)
return []keybase1.PerUserKeyBox{pukBox}, err
}