forked from keybase/client
/
signup.go
320 lines (267 loc) · 8.01 KB
/
signup.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
// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package engine
import (
"fmt"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/protocol/keybase1"
triplesec "github.com/keybase/go-triplesec"
)
type SignupEngine struct {
libkb.Contextified
pwsalt []byte
ppStream *libkb.PassphraseStream
tsec libkb.Triplesec
uid keybase1.UID
me *libkb.User
signingKey libkb.GenericKey
encryptionKey libkb.NaclDHKeyPair
arg *SignupEngineRunArg
lks *libkb.LKSec
perUserKeyring *libkb.PerUserKeyring // Created after provisioning. Sent to paperkey gen.
}
type SignupEngineRunArg struct {
Username string
Email string
InviteCode string
Passphrase string
StoreSecret bool
DeviceName string
DeviceType keybase1.DeviceType
SkipGPG bool
SkipMail bool
SkipPaper bool
GenPGPBatch bool // if true, generate and push a pgp key to the server (no interaction)
}
func NewSignupEngine(arg *SignupEngineRunArg, g *libkb.GlobalContext) *SignupEngine {
return &SignupEngine{
arg: arg,
Contextified: libkb.NewContextified(g),
}
}
func (s *SignupEngine) Name() string {
return "Signup"
}
func (s *SignupEngine) RequiredUIs() []libkb.UIKind {
return nil
}
func (s *SignupEngine) Prereqs() Prereqs { return Prereqs{} }
func (s *SignupEngine) SubConsumers() []libkb.UIConsumer {
return []libkb.UIConsumer{
&GPGImportKeyEngine{},
&DeviceWrap{},
&PaperKeyPrimary{},
}
}
func (s *SignupEngine) GetMe() *libkb.User {
return s.me
}
func (s *SignupEngine) Run(ctx *Context) error {
// make sure we're starting with a clear login state:
if err := s.G().Logout(); err != nil {
return err
}
f := func(a libkb.LoginContext) error {
if err := s.genPassphraseStream(a, s.arg.Passphrase); err != nil {
return err
}
if err := s.join(a, s.arg.Username, s.arg.Email, s.arg.InviteCode, s.arg.SkipMail); err != nil {
return err
}
var err error
s.perUserKeyring, err = libkb.NewPerUserKeyring(s.G(), s.uid)
if err != nil {
return err
}
if err := s.registerDevice(a, ctx, s.arg.DeviceName); err != nil {
return err
}
if !s.arg.SkipPaper {
if err := s.genPaperKeys(ctx, a); err != nil {
return err
}
}
// GenPGPBatch can be set in devel CLI to generate
// a pgp key and push it to the server without any
// user interaction to make testing easier.
if s.arg.GenPGPBatch {
if err := s.genPGPBatch(ctx); err != nil {
return err
}
}
if s.arg.SkipGPG {
return nil
}
// only desktop potentially has gpg, so if not desktop then
// bail out
if s.arg.DeviceType != keybase1.DeviceType_DESKTOP {
return nil
}
if wantsGPG, err := s.checkGPG(ctx); err != nil {
return err
} else if wantsGPG {
if err := s.addGPG(a, ctx, true); err != nil {
return fmt.Errorf("addGPG error: %s", err)
}
}
return nil
}
if err := s.G().LoginState().ExternalFunc(f, "SignupEngine - Run"); err != nil {
return err
}
// signup complete, notify anyone interested.
// (and don't notify inside a LoginState action to avoid
// a chance of timing out)
s.G().NotifyRouter.HandleLogin(s.arg.Username)
// For instance, setup gregor and friends...
s.G().CallLoginHooks()
return nil
}
func (s *SignupEngine) genPassphraseStream(a libkb.LoginContext, passphrase string) error {
if len(passphrase) < libkb.MinPassphraseLength {
return libkb.PassphraseError{Msg: fmt.Sprintf("Passphrase must be at least %d characters", libkb.MinPassphraseLength)}
}
salt, err := libkb.RandBytes(triplesec.SaltLen)
if err != nil {
return err
}
s.pwsalt = salt
s.tsec, s.ppStream, err = libkb.StretchPassphrase(s.G(), passphrase, salt)
if err != nil {
return err
}
return nil
}
func (s *SignupEngine) join(a libkb.LoginContext, username, email, inviteCode string, skipMail bool) error {
s.G().Log.Debug("SignupEngine#join")
joinEngine := NewSignupJoinEngine(s.G())
pdpkda5kid, err := s.ppStream.PDPKA5KID()
if err != nil {
return err
}
arg := SignupJoinEngineRunArg{
Username: username,
Email: email,
InviteCode: inviteCode,
PWHash: s.ppStream.PWHash(),
PWSalt: s.pwsalt,
SkipMail: skipMail,
PDPKA5KID: pdpkda5kid,
}
res := joinEngine.Run(a, arg)
if res.Err != nil {
return res
}
s.ppStream.SetGeneration(res.PpGen)
a.CreateStreamCache(s.tsec, s.ppStream)
s.uid = res.UID
user, err := libkb.LoadUser(libkb.LoadUserArg{Self: true, UID: res.UID, PublicKeyOptional: true, Contextified: libkb.NewContextified(s.G())})
if err != nil {
return err
}
s.me = user
return nil
}
func (s *SignupEngine) registerDevice(a libkb.LoginContext, ctx *Context, deviceName string) error {
s.G().Log.CDebugf(ctx.NetContext, "SignupEngine#registerDevice")
s.lks = libkb.NewLKSec(s.ppStream, s.uid, s.G())
args := &DeviceWrapArgs{
Me: s.me,
DeviceName: deviceName,
Lks: s.lks,
IsEldest: true,
}
switch s.arg.DeviceType {
case keybase1.DeviceType_DESKTOP:
args.DeviceType = libkb.DeviceTypeDesktop
case keybase1.DeviceType_MOBILE:
args.DeviceType = libkb.DeviceTypeMobile
default:
return fmt.Errorf("unknown device type: %v", s.arg.DeviceType)
}
eng := NewDeviceWrap(args, s.G())
ctx.LoginContext = a
if err := RunEngine(eng, ctx); err != nil {
return err
}
s.signingKey = eng.SigningKey()
s.encryptionKey = eng.EncryptionKey()
did := s.G().Env.GetDeviceID()
if err := ctx.LoginContext.LocalSession().SetDeviceProvisioned(did); err != nil {
// this isn't a fatal error, session will stay in memory...
s.G().Log.Warning("error saving session file: %s", err)
}
// Create the secret store as late as possible here, as the username may
// change during the signup process.
if s.arg.StoreSecret {
secretStore := libkb.NewSecretStore(s.G(), s.me.GetNormalizedName())
if secretStore != nil {
secret, err := s.lks.GetSecret(a)
if err != nil {
return err
}
// Ignore any errors storing the secret.
storeSecretErr := secretStore.StoreSecret(secret)
if storeSecretErr != nil {
s.G().Log.Warning("StoreSecret error: %s", storeSecretErr)
}
}
}
s.G().Log.Debug("registered new device: %s", s.G().Env.GetDeviceID())
s.G().Log.Debug("eldest kid: %s", s.me.GetEldestKID())
return nil
}
func (s *SignupEngine) genPaperKeys(ctx *Context, lctx libkb.LoginContext) error {
s.G().Log.CDebugf(ctx.NetContext, "SignupEngine#genPaperKeys")
// Load me again so that keys will be up to date.
var err error
s.me, err = libkb.LoadUser(libkb.LoadUserArg{Self: true, UID: s.me.GetUID(), PublicKeyOptional: true, Contextified: libkb.NewContextified(s.G())})
if err != nil {
return err
}
args := &PaperKeyPrimaryArgs{
Me: s.me,
SigningKey: s.signingKey,
EncryptionKey: s.encryptionKey,
LoginContext: lctx,
PerUserKeyring: s.perUserKeyring,
}
eng := NewPaperKeyPrimary(s.G(), args)
return RunEngine(eng, ctx)
}
func (s *SignupEngine) checkGPG(ctx *Context) (bool, error) {
eng := NewGPGImportKeyEngine(nil, s.G())
return eng.WantsGPG(ctx)
}
func (s *SignupEngine) addGPG(lctx libkb.LoginContext, ctx *Context, allowMulti bool) error {
s.G().Log.Debug("SignupEngine.addGPG. signingKey: %v\n", s.signingKey)
arg := GPGImportKeyArg{Signer: s.signingKey, AllowMulti: allowMulti, Me: s.me, Lks: s.lks}
eng := NewGPGImportKeyEngine(&arg, s.G())
ctx.LoginContext = lctx
if err := RunEngine(eng, ctx); err != nil {
return err
}
if s.signingKey == nil {
s.signingKey = eng.LastKey()
}
return nil
}
func (s *SignupEngine) genPGPBatch(ctx *Context) error {
s.G().Log.CDebugf(ctx.NetContext, "SignupEngine#genPGPBatch")
gen := libkb.PGPGenArg{
PrimaryBits: 1024,
SubkeyBits: 1024,
}
gen.AddDefaultUID()
tsec := ctx.LoginContext.PassphraseStreamCache().Triplesec()
sgen := ctx.LoginContext.GetStreamGeneration()
eng := NewPGPKeyImportEngine(PGPKeyImportEngineArg{
Gen: &gen,
PushSecret: true,
Lks: s.lks,
NoSave: true,
PreloadTsec: tsec,
PreloadStreamGen: sgen,
})
return RunEngine(eng, ctx)
}