forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pgp_import_key.go
338 lines (286 loc) · 7.45 KB
/
pgp_import_key.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
// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package engine
//
// engine.PGPKeyImportEngine is a class for optionally generating PGP keys,
// and pushing them into the keybase sigchain via the Delegator.
//
import (
"errors"
"os/exec"
"strings"
"github.com/keybase/client/go/libkb"
)
type PGPKeyImportEngine struct {
me *libkb.User
bundle *libkb.PGPKeyBundle
arg PGPKeyImportEngineArg
epk string
del *libkb.Delegator
libkb.Contextified
}
type PGPKeyImportEngineArg struct {
Gen *libkb.PGPGenArg
Pregen *libkb.PGPKeyBundle
SigningKey libkb.GenericKey
Me *libkb.User
Ctx *libkb.GlobalContext
Lks *libkb.LKSec
NoSave bool
PushSecret bool
OnlySave bool
AllowMulti bool
DoExport bool
DoUnlock bool
}
func NewPGPKeyImportEngineFromBytes(key []byte, pushPrivate bool, gc *libkb.GlobalContext) (eng *PGPKeyImportEngine, err error) {
var bundle *libkb.PGPKeyBundle
if libkb.IsArmored(key) {
bundle, err = libkb.ReadPrivateKeyFromString(string(key))
} else {
bundle, err = libkb.ReadOneKeyFromBytes(key)
}
if err != nil {
return
}
arg := PGPKeyImportEngineArg{
Pregen: bundle,
PushSecret: pushPrivate,
AllowMulti: true,
DoExport: false,
DoUnlock: true,
Ctx: gc,
}
eng = NewPGPKeyImportEngine(arg)
return
}
func (e *PGPKeyImportEngine) loadMe() (err error) {
if e.me = e.arg.Me; e.me != nil {
return
}
e.me, err = libkb.LoadMe(libkb.NewLoadUserPubOptionalArg(e.G()))
return err
}
func (e *PGPKeyImportEngine) loadLoginSession(ctx *Context) error {
var err error
if ctx.LoginContext != nil {
err = ctx.LoginContext.LoadLoginSession(e.me.GetName())
} else {
aerr := e.G().LoginState().Account(func(a *libkb.Account) {
err = a.LoadLoginSession(e.me.GetName())
}, "PGPKeyImportEngine - loadLoginSession")
if aerr != nil {
return aerr
}
}
return err
}
func (e *PGPKeyImportEngine) generateKey(ctx *Context) (err error) {
gen := e.arg.Gen
if err = gen.CreatePGPIDs(); err != nil {
return
}
e.bundle, err = libkb.GeneratePGPKeyBundle(*gen, ctx.LogUI)
return
}
func (e *PGPKeyImportEngine) saveLKS(ctx *Context) (err error) {
e.G().Log.Debug("+ PGPKeyImportEngine::saveLKS")
defer func() {
e.G().Log.Debug("- PGPKeyImportEngine::saveLKS -> %v", libkb.ErrToOk(err))
}()
lks := e.arg.Lks
if lks == nil {
lks, err = libkb.NewLKSForEncrypt(ctx.SecretUI, e.me.GetUID(), e.G())
if err != nil {
return err
}
}
_, err = libkb.WriteLksSKBToKeyring(e.G(), e.bundle, lks, ctx.LoginContext)
return
}
var ErrKeyGenArgNoDefNoCustom = errors.New("invalid args: NoDefPGPUid set, but no custom PGPUids")
func NewPGPKeyImportEngine(arg PGPKeyImportEngineArg) *PGPKeyImportEngine {
return &PGPKeyImportEngine{arg: arg, Contextified: libkb.NewContextified(arg.Ctx)}
}
func (e *PGPKeyImportEngine) Name() string {
return "PGPKeyImportEngine"
}
func (e *PGPKeyImportEngine) Prereqs() Prereqs {
return Prereqs{
Session: true,
}
}
func (e *PGPKeyImportEngine) RequiredUIs() []libkb.UIKind {
return []libkb.UIKind{
libkb.LogUIKind,
libkb.SecretUIKind,
}
}
func (e *PGPKeyImportEngine) SubConsumers() []libkb.UIConsumer {
return nil
}
func (e *PGPKeyImportEngine) init() (err error) {
if e.arg.Gen != nil {
err = e.arg.Gen.Init()
}
return err
}
func (e *PGPKeyImportEngine) testExisting() (err error) {
return PGPCheckMulti(e.me, e.arg.AllowMulti)
}
// checkPregenPrivate makes sure that the pregenerated key is a
// private key.
func (e *PGPKeyImportEngine) checkPregenPrivate() error {
if e.arg.Pregen == nil {
return nil
}
if e.arg.Pregen.HasSecretKey() {
return nil
}
return libkb.NoSecretKeyError{}
}
func (e *PGPKeyImportEngine) Run(ctx *Context) error {
e.G().Log.Debug("+ PGPKeyImportEngine::Run")
defer func() {
e.G().Log.Debug("- PGPKeyImportEngine::Run")
}()
if err := e.init(); err != nil {
return err
}
if err := e.loadMe(); err != nil {
return err
}
if err := e.loadLoginSession(ctx); err != nil {
return err
}
if err := e.checkPregenPrivate(); err != nil {
return err
}
if !e.arg.OnlySave {
if err := e.testExisting(); err != nil {
return err
}
if err := e.loadDelegator(ctx); err != nil {
return err
}
}
if err := e.unlock(ctx); err != nil {
return err
}
if err := e.generate(ctx); err != nil {
return err
}
if !e.arg.OnlySave {
if err := e.push(ctx); err != nil {
return err
}
if err := e.exportToGPG(ctx); err != nil {
return err
}
}
return nil
}
func (e *PGPKeyImportEngine) exportToGPG(ctx *Context) (err error) {
if !e.arg.DoExport || e.arg.Pregen != nil {
e.G().Log.Debug("| Skipping export to GPG")
return
}
gpg := e.G().GetGpgClient()
if err := gpg.Configure(); err != nil {
if err == exec.ErrNotFound {
e.G().Log.Debug("Not saving new key to GPG since no gpg install was found")
err = nil
}
return err
}
err = gpg.ExportKey(*e.bundle)
if err == nil {
ctx.LogUI.Info("Exported new key to the local GPG keychain")
}
return err
}
func (e *PGPKeyImportEngine) unlock(ctx *Context) (err error) {
e.G().Log.Debug("+ PGPKeyImportEngine::unlock")
defer func() {
e.G().Log.Debug("- PGPKeyImportEngine::unlock -> %s", libkb.ErrToOk(err))
}()
if e.arg.Pregen == nil || !e.arg.DoUnlock || !e.arg.Pregen.HasSecretKey() {
e.G().Log.Debug("| short circuit unlock function")
} else {
err = e.arg.Pregen.Unlock("import into private keychain", ctx.SecretUI)
}
return
}
func (e *PGPKeyImportEngine) loadDelegator(ctx *Context) (err error) {
e.del = &libkb.Delegator{
ExistingKey: e.arg.SigningKey,
Me: e.me,
Expire: libkb.KeyExpireIn,
DelegationType: libkb.SibkeyType,
Contextified: libkb.NewContextified(e.G()),
}
return e.del.LoadSigningKey(ctx.LoginContext, ctx.SecretUI)
}
func (e *PGPKeyImportEngine) generate(ctx *Context) (err error) {
e.G().Log.Debug("+ PGP::Generate")
defer func() {
e.G().Log.Debug("- PGP::Generate -> %s", libkb.ErrToOk(err))
}()
e.G().Log.Debug("| GenerateKey")
if e.arg.Pregen != nil {
e.bundle = e.arg.Pregen
} else if e.arg.Gen == nil {
err = libkb.InternalError{Msg: "PGPKeyImportEngine: need either Gen or Pregen"}
return
} else if err = e.generateKey(ctx); err != nil {
return
}
e.G().Log.Debug("| WriteKey (hasSecret = %v)", e.bundle.HasSecretKey())
if !e.arg.NoSave && e.bundle.HasSecretKey() {
if err = e.saveLKS(ctx); err != nil {
return
}
}
if e.arg.PushSecret {
if err = e.prepareSecretPush(ctx); err != nil {
return
}
}
return
}
func (e *PGPKeyImportEngine) prepareSecretPush(ctx *Context) error {
tsec, gen, err := e.G().LoginState().GetVerifiedTriplesec(ctx.SecretUI)
if err != nil {
return err
}
skb, err := e.bundle.ToServerSKB(e.G(), tsec, gen)
if err != nil {
return err
}
e.epk, err = skb.ArmoredEncode()
return err
}
func (e *PGPKeyImportEngine) push(ctx *Context) (err error) {
e.G().Log.Debug("+ PGP::Push")
e.del.NewKey = e.bundle
e.del.EncodedPrivateKey = e.epk
if err = e.del.Run(ctx.LoginContext); err != nil {
return err
}
e.G().Log.Debug("- PGP::Push -> %s", libkb.ErrToOk(err))
ctx.LogUI.Info("Generated new PGP key:")
d := e.bundle.VerboseDescription()
for _, line := range strings.Split(d, "\n") {
ctx.LogUI.Info(" %s", line)
}
return nil
}
func PGPCheckMulti(me *libkb.User, allowMulti bool) (err error) {
if allowMulti {
return
}
if pgps := me.GetActivePGPKeys(false); len(pgps) > 0 {
err = libkb.KeyExistsError{Key: pgps[0].GetFingerprintP()}
}
return
}