This repository has been archived by the owner on Jul 7, 2020. It is now read-only.
forked from keybase/client
/
gpg_import_key.go
290 lines (249 loc) · 7.02 KB
/
gpg_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
// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package engine
//
// engine.GPGImportKeyEngine is a class that selects key from the GPG keyring via
// shell-out to the gpg command line client. It's useful in `client mykey select`
// and other places in which the user picks existing PGP keys on the existing
// system for use in Keybase tasks.
//
import (
"fmt"
"github.com/keybase/client/go/libkb"
keybase1 "github.com/keybase/client/go/protocol/keybase1"
)
type GPGImportKeyArg struct {
Query string
Signer libkb.GenericKey
AllowMulti bool
SkipImport bool
OnlyImport bool
HasProvisionedDevice bool
Me *libkb.User
Lks *libkb.LKSec
}
type GPGImportKeyEngine struct {
last *libkb.PGPKeyBundle
arg *GPGImportKeyArg
duplicatedFingerprints []libkb.PGPFingerprint
libkb.Contextified
}
func NewGPGImportKeyEngine(g *libkb.GlobalContext, arg *GPGImportKeyArg) *GPGImportKeyEngine {
return &GPGImportKeyEngine{
arg: arg,
Contextified: libkb.NewContextified(g),
}
}
func (e *GPGImportKeyEngine) Prereqs() Prereqs {
if !e.arg.HasProvisionedDevice {
return Prereqs{TemporarySession: true}
}
return Prereqs{Device: true}
}
func (e *GPGImportKeyEngine) Name() string {
return "GPGImportKeyEngine"
}
func (e *GPGImportKeyEngine) RequiredUIs() []libkb.UIKind {
return []libkb.UIKind{
libkb.GPGUIKind,
libkb.SecretUIKind,
}
}
func (e *GPGImportKeyEngine) SubConsumers() []libkb.UIConsumer {
return []libkb.UIConsumer{
&PGPKeyImportEngine{},
&PGPUpdateEngine{},
}
}
func (e *GPGImportKeyEngine) WantsGPG(m libkb.MetaContext) (bool, error) {
gpg := e.G().GetGpgClient()
canExec, err := gpg.CanExec()
if err != nil {
return false, err
}
if !canExec {
return false, nil
}
// they have gpg
// get an index of all the secret keys
index, _, err := gpg.Index(true, "")
if err != nil {
return false, err
}
if index.Len() == 0 {
// no private keys available, so don't offer
return false, nil
}
res, err := m.UIs().GPGUI.WantToAddGPGKey(m.Ctx(), 0)
if err != nil {
return false, err
}
return res, nil
}
func (e *GPGImportKeyEngine) Run(m libkb.MetaContext) (err error) {
gpg := e.G().GetGpgClient()
me := e.arg.Me
if me == nil {
if me, err = libkb.LoadMe(libkb.NewLoadUserPubOptionalArg(e.G())); err != nil {
return err
}
}
if !e.arg.OnlyImport {
if err = PGPCheckMulti(me, e.arg.AllowMulti); err != nil {
return err
}
}
if err = gpg.Configure(); err != nil {
return err
}
index, warns, err := gpg.Index(true, e.arg.Query)
if err != nil {
return err
}
warns.Warn(e.G())
var gks []keybase1.GPGKey
for _, key := range index.Keys {
gk := keybase1.GPGKey{
Algorithm: fmt.Sprintf("%d%s", key.Bits, key.AlgoString()),
KeyID: key.GetFingerprint().ToKeyID(),
Expiration: key.ExpirationString(),
Identities: key.GetPGPIdentities(),
}
gks = append(gks, gk)
}
if len(gks) == 0 {
return fmt.Errorf("No PGP keys available to choose from.")
}
res, err := m.UIs().GPGUI.SelectKeyAndPushOption(m.Ctx(), keybase1.SelectKeyAndPushOptionArg{Keys: gks})
if err != nil {
return err
}
m.CDebugf("SelectKey result: %+v", res)
var selected *libkb.GpgPrimaryKey
for _, key := range index.Keys {
if key.GetFingerprint().ToKeyID() == res.KeyID {
selected = key
break
}
}
if selected == nil {
return nil
}
publicKeys := me.GetActivePGPKeys(false)
duplicate := false
for _, key := range publicKeys {
if key.GetFingerprint().Eq(*(selected.GetFingerprint())) {
duplicate = true
break
}
}
if duplicate && !e.arg.OnlyImport {
// This key's already been posted to the server.
res, err := m.UIs().GPGUI.ConfirmDuplicateKeyChosen(m.Ctx(), 0)
if err != nil {
return err
}
if !res {
return libkb.SibkeyAlreadyExistsError{}
}
// We're sending a key update, then.
fp := fmt.Sprintf("%s", *(selected.GetFingerprint()))
eng := NewPGPUpdateEngine(e.G(), []string{fp}, false)
err = RunEngine2(m, eng)
e.duplicatedFingerprints = eng.duplicatedFingerprints
if err != nil {
return err
}
if !e.arg.SkipImport {
// Key is duplicate, but caller wants to import secret
// half.
res, err := m.UIs().GPGUI.ConfirmImportSecretToExistingKey(m.Ctx(), 0)
if err != nil {
return err
}
if !res {
// But update itself has finished, so this
// cancellation is not an error.
m.CInfof("User cancelled secret key import.")
return nil
}
// Fall through with OnlyImport=true so it skips sig posting
// (which would be rejected because of duplicate kid).
e.arg.OnlyImport = true
} else {
// Nothing to more do.
return nil
}
}
tty, err := m.UIs().GPGUI.GetTTY(m.Ctx())
if err != nil {
m.CWarningf("error getting TTY for GPG: %s", err)
err = nil
}
var bundle *libkb.PGPKeyBundle
if e.arg.SkipImport {
// If we don't need secret key to save in Keybase keyring,
// just import public key and rely on GPG fallback for reverse
// signature.
bundle, err = gpg.ImportKey(false, *(selected.GetFingerprint()), tty)
if err != nil {
return fmt.Errorf("ImportKey (secret: false) error: %s", err)
}
} else {
bundle, err = gpg.ImportKey(true, *(selected.GetFingerprint()), tty)
if err != nil {
return fmt.Errorf("ImportKey (secret: true) error: %s", err)
}
if err := bundle.Unlock(m, "Import of key into Keybase keyring", m.UIs().SecretUI); err != nil {
return err
}
if !libkb.FindPGPPrivateKey(bundle) {
return PGPImportStubbedError{KeyIDString: selected.GetFingerprint().ToKeyID()}
}
}
if e.arg.OnlyImport {
if err := e.ensurePublicPartIsPublished(me, bundle.GetKID()); err != nil {
// Make sure key is active in user's sigchain. Otherwise,
// after importing to local keychain, Keybase will refuse
// to use it for any operation anyway.
return err
}
}
m.CDebugf("Bundle unlocked: %s", selected.GetFingerprint().ToKeyID())
eng := NewPGPKeyImportEngine(m.G(), PGPKeyImportEngineArg{
Pregen: bundle,
SigningKey: e.arg.Signer,
Me: me,
AllowMulti: e.arg.AllowMulti,
NoSave: e.arg.SkipImport,
OnlySave: e.arg.OnlyImport,
Lks: e.arg.Lks,
GPGFallback: true,
})
if err = RunEngine2(m, eng); err != nil {
// It's important to propagate a CanceledError unmolested,
// since the UI needs to know that. See:
// https://github.com/keybase/client/issues/226
if _, ok := err.(libkb.CanceledError); !ok {
err = libkb.KeyGenError{Msg: err.Error()}
}
return
}
m.CDebugf("Key %s imported", selected.GetFingerprint().ToKeyID())
e.last = bundle
return nil
}
func (e *GPGImportKeyEngine) LastKey() *libkb.PGPKeyBundle {
return e.last
}
func (e *GPGImportKeyEngine) ensurePublicPartIsPublished(me *libkb.User, kid keybase1.KID) error {
ckf := me.GetComputedKeyFamily()
if ckf == nil {
return fmt.Errorf("cannot get ComputedKeyFamily")
}
active := ckf.GetKeyRole(kid)
if active != libkb.DLGSibkey {
return PGPNotActiveForLocalImport{kid}
}
return nil
}