/
prove.go
471 lines (431 loc) · 12.6 KB
/
prove.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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package engine
import (
"fmt"
"strings"
"time"
"github.com/keybase/client/go/externals"
libkb "github.com/keybase/client/go/libkb"
keybase1 "github.com/keybase/client/go/protocol/keybase1"
"golang.org/x/net/context"
)
// Prove is an engine used for proving ownership of remote accounts,
// like Twitter, GitHub, etc.
type Prove struct {
arg *keybase1.StartProofArg
me *libkb.User
serviceType libkb.ServiceType
serviceParameters *keybase1.ProveParameters
supersede bool
proof *libkb.ProofMetadataRes
sig string
sigID keybase1.SigID
linkID libkb.LinkID
postRes *libkb.PostProofRes
signingKey libkb.GenericKey
sigInner []byte
remoteNameNormalized string
libkb.Contextified
}
// NewProve makes a new Prove Engine given an RPC-friendly ProveArg.
func NewProve(g *libkb.GlobalContext, arg *keybase1.StartProofArg) *Prove {
if arg.SigVersion == nil || libkb.SigVersion(*arg.SigVersion) == libkb.KeybaseNullSigVersion {
tmp := keybase1.SigVersion(libkb.GetDefaultSigVersion(g))
arg.SigVersion = &tmp
}
return &Prove{
arg: arg,
Contextified: libkb.NewContextified(g),
}
}
// Name provides the name of this engine for the engine interface contract
func (p *Prove) Name() string {
return "Prove"
}
// GetPrereqs returns the engine prereqs.
func (p *Prove) Prereqs() Prereqs {
return Prereqs{Device: true}
}
// RequiredUIs returns the required UIs.
func (p *Prove) RequiredUIs() []libkb.UIKind {
return []libkb.UIKind{
libkb.LogUIKind,
libkb.ProveUIKind,
libkb.SecretUIKind,
}
}
// SubConsumers returns the other UI consumers for this engine.
func (p *Prove) SubConsumers() []libkb.UIConsumer {
return nil
}
func (p *Prove) loadMe(m libkb.MetaContext) (err error) {
p.me, err = libkb.LoadMe(libkb.NewLoadUserArgWithMetaContext(m).WithForceReload())
return err
}
func (p *Prove) checkExists1(m libkb.MetaContext) (err error) {
proofs := p.me.IDTable().GetActiveProofsFor(p.serviceType)
if len(proofs) != 0 && !p.arg.Force && p.serviceType.LastWriterWins() {
lst := proofs[len(proofs)-1]
var redo bool
redo, err = m.UIs().ProveUI.PromptOverwrite(m.Ctx(), keybase1.PromptOverwriteArg{
Account: lst.ToDisplayString(),
Typ: keybase1.PromptOverwriteType_SOCIAL,
})
if err != nil {
return err
}
if !redo {
return libkb.NotConfirmedError{}
}
p.supersede = true
}
return nil
}
func (p *Prove) promptRemoteName(m libkb.MetaContext) error {
// If the name is already supplied, there's no need to prompt.
if len(p.arg.Username) > 0 {
remoteNameNormalized, err := p.serviceType.NormalizeRemoteName(m, p.arg.Username)
if err == nil {
p.remoteNameNormalized = remoteNameNormalized
}
return err
}
// Prompt for the name, retrying if it's invalid.
var normalizationError error
for {
un, err := m.UIs().ProveUI.PromptUsername(m.Ctx(), keybase1.PromptUsernameArg{
Prompt: p.serviceType.GetPrompt(),
PrevError: libkb.ExportErrorAsStatus(m.G(), normalizationError),
Parameters: p.serviceParameters,
})
if err != nil {
// Errors here are conditions like EOF. Return them rather than retrying.
return err
}
var remoteNameNormalized string
remoteNameNormalized, normalizationError = p.serviceType.NormalizeRemoteName(m, un)
if normalizationError == nil {
p.remoteNameNormalized = remoteNameNormalized
return nil
}
}
}
func (p *Prove) checkExists2(m libkb.MetaContext) (err error) {
defer m.Trace("Prove#CheckExists2", &err)()
if !p.serviceType.LastWriterWins() {
var found libkb.RemoteProofChainLink
for _, proof := range p.me.IDTable().GetActiveProofsFor(p.serviceType) {
_, name := proof.ToKeyValuePair()
if libkb.Cicmp(name, p.remoteNameNormalized) {
found = proof
break
}
}
if found != nil {
var redo bool
redo, err = m.UIs().ProveUI.PromptOverwrite(m.Ctx(), keybase1.PromptOverwriteArg{
Account: found.ToDisplayString(),
Typ: keybase1.PromptOverwriteType_SITE,
})
if err != nil {
return err
}
if !redo {
err = libkb.NotConfirmedError{}
return err
}
p.supersede = true
}
}
return nil
}
func (p *Prove) doPrechecks(m libkb.MetaContext) (err error) {
var w *libkb.Markup
w, err = p.serviceType.PreProofCheck(m, p.remoteNameNormalized)
if w != nil {
if uierr := m.UIs().ProveUI.OutputPrechecks(m.Ctx(), keybase1.OutputPrechecksArg{Text: w.Export()}); uierr != nil {
m.Warning("prove ui OutputPrechecks call error: %s", uierr)
}
}
return err
}
func (p *Prove) doWarnings(m libkb.MetaContext) (err error) {
if mu := p.serviceType.PreProofWarning(p.remoteNameNormalized); mu != nil {
var ok bool
arg := keybase1.PreProofWarningArg{Text: mu.Export()}
if ok, err = m.UIs().ProveUI.PreProofWarning(m.Ctx(), arg); err == nil && !ok {
err = libkb.NotConfirmedError{}
}
if err != nil {
return err
}
}
return nil
}
func (p *Prove) generateProof(m libkb.MetaContext) (err error) {
ska := libkb.SecretKeyArg{
Me: p.me,
KeyType: libkb.DeviceSigningKeyType,
}
p.signingKey, err = m.G().Keyrings.GetSecretKeyWithPrompt(m, m.SecretKeyPromptArg(ska, "tracking signature"))
if err != nil {
return err
}
sigVersion := libkb.SigVersion(*p.arg.SigVersion)
if p.proof, err = p.me.ServiceProof(m, p.signingKey, p.serviceType, p.remoteNameNormalized, sigVersion); err != nil {
return err
}
if p.sigInner, err = p.proof.J.Marshal(); err != nil {
return err
}
p.sig, p.sigID, p.linkID, err = libkb.MakeSig(
m,
p.signingKey,
libkb.LinkTypeWebServiceBinding,
p.sigInner,
libkb.SigHasRevokes(false),
keybase1.SeqType_PUBLIC,
libkb.SigIgnoreIfUnsupported(false),
p.me,
sigVersion,
)
return err
}
func (p *Prove) postProofToServer(m libkb.MetaContext) (err error) {
arg := libkb.PostProofArg{
UID: p.me.GetUID(),
Seqno: p.proof.Seqno,
Sig: p.sig,
ProofType: p.serviceType.GetProofType(),
RemoteServiceType: p.serviceType.GetTypeName(),
SigID: p.sigID,
LinkID: p.linkID,
Supersede: p.supersede,
RemoteUsername: p.remoteNameNormalized,
RemoteKey: p.serviceType.GetAPIArgKey(),
SigningKey: p.signingKey,
}
if libkb.SigVersion(*p.arg.SigVersion) == libkb.KeybaseSignatureV2 {
arg.SigInner = p.sigInner
}
p.postRes, err = libkb.PostProof(m, arg)
return err
}
func (p *Prove) instructAction(m libkb.MetaContext) (err error) {
mkp := p.serviceType.PostInstructions(p.remoteNameNormalized)
var txt string
if txt, err = p.serviceType.FormatProofText(m, p.postRes, p.me.GetNormalizedName().String(), p.remoteNameNormalized, p.sigID); err != nil {
return err
}
err = m.UIs().ProveUI.OutputInstructions(m.Ctx(), keybase1.OutputInstructionsArg{
Instructions: mkp.Export(),
// If we don't trim newlines here, we'll run into an issue where e.g.
// Facebook links get corrupted on iOS. See:
// - https://keybase.atlassian.net/browse/DESKTOP-3335
// - https://keybase.atlassian.net/browse/CORE-4941
// All of our proof verifying code (PVL) should already be flexible
// with surrounding whitespace, because users are pasting proofs by
// hand anyway.
Proof: strings.TrimSpace(txt),
Parameters: p.serviceParameters,
})
if err != nil {
return err
}
return p.checkAutoPost(m, txt)
}
func (p *Prove) checkAutoPost(m libkb.MetaContext, txt string) error {
if !p.arg.Auto {
return nil
}
if libkb.RemoteServiceTypes[p.arg.Service] != keybase1.ProofType_ROOTER {
return nil
}
m.Debug("making automatic post of proof to rooter")
apiArg := libkb.APIArg{
Endpoint: "rooter",
SessionType: libkb.APISessionTypeREQUIRED,
Args: libkb.HTTPArgs{
"post": libkb.S{Val: txt},
"username": libkb.S{Val: p.arg.Username},
},
}
if _, err := m.G().API.Post(m, apiArg); err != nil {
m.Debug("error posting to rooter: %s", err)
return err
}
return nil
}
// Keep asking the user whether they posted the proof
// until it works or they give up.
func (p *Prove) promptPostedLoop(m libkb.MetaContext) (err error) {
found := false
for i := 0; ; i++ {
var retry bool
var status keybase1.ProofStatus
var warn *libkb.Markup
retry, err = m.UIs().ProveUI.OkToCheck(m.Ctx(), keybase1.OkToCheckArg{
Name: p.serviceType.DisplayName(),
Attempt: i,
})
if !retry || err != nil {
break
}
found, status, _, err = libkb.CheckPosted(m, p.sigID)
if found || err != nil {
break
}
warn, err = p.serviceType.RecheckProofPosting(i, status, p.remoteNameNormalized)
if warn != nil {
uierr := m.UIs().ProveUI.DisplayRecheckWarning(m.Ctx(), keybase1.DisplayRecheckWarningArg{
Text: warn.Export(),
})
if uierr != nil {
m.Warning("prove ui DisplayRecheckWarning call error: %s", uierr)
}
}
if err != nil {
break
}
}
if !found && err == nil {
err = libkb.ProofNotYetAvailableError{}
}
return err
}
// Poll until the proof succeeds, limited to an hour.
func (p *Prove) verifyLoop(m libkb.MetaContext) (err error) {
timeout := time.Hour
m, cancel := m.WithTimeout(timeout)
defer cancel()
defer func() {
if err != nil && m.Ctx().Err() == context.DeadlineExceeded {
m.Debug("Prove.verifyLoop rewriting error after timeout: %v", err)
err = fmt.Errorf("Timed out after looking for proof for %v", timeout)
}
}()
uierr := m.UIs().ProveUI.Checking(m.Ctx(), keybase1.CheckingArg{
Name: p.serviceType.DisplayName(),
})
if uierr != nil {
m.Warning("prove ui Checking call error: %s", uierr)
}
for i := 0; ; i++ {
if shouldContinue, uierr := m.UIs().ProveUI.ContinueChecking(m.Ctx(), 0); !shouldContinue || uierr != nil {
if uierr != nil {
m.Warning("prove ui ContinueChecking call error: %s", uierr)
}
return libkb.CanceledError{}
}
found, status, _, err := libkb.CheckPosted(m, p.sigID)
if err != nil {
return err
}
m.Debug("Prove.verifyLoop round:%v found:%v status:%v", i, found, status)
if found {
return nil
}
wakeAt := m.G().Clock().Now().Add(2 * time.Second)
err = libkb.SleepUntilWithContext(m.Ctx(), m.G().Clock(), wakeAt)
if err != nil {
return err
}
}
}
func (p *Prove) checkProofText(m libkb.MetaContext) error {
m.Debug("p.postRes.Text: %q", p.postRes.Text)
m.Debug("p.sigID: %q", p.sigID)
return p.serviceType.CheckProofText(p.postRes.Text, p.sigID, p.sig)
}
func (p *Prove) getServiceType(m libkb.MetaContext) (err error) {
p.serviceType = m.G().GetProofServices().GetServiceType(m.Ctx(), p.arg.Service)
if p.serviceType == nil {
return libkb.BadServiceError{Service: p.arg.Service}
}
if !p.serviceType.CanMakeNewProofs(m) {
return libkb.ServiceDoesNotSupportNewProofsError{Service: p.arg.Service}
}
if serviceType, ok := p.serviceType.(*externals.GenericSocialProofServiceType); ok {
tmp := serviceType.ProveParameters(m)
p.serviceParameters = &tmp
}
return nil
}
// SigID returns the signature id of the proof posted to the
// server.
func (p *Prove) SigID() keybase1.SigID {
return p.sigID
}
// Run runs the Prove engine, performing all steps of the proof process.
func (p *Prove) Run(m libkb.MetaContext) (err error) {
defer m.Trace("ProofEngine.Run", &err)()
stage := func(s string) {
m.Debug("| ProofEngine.Run() %s", s)
}
stage("GetServiceType")
if err = p.getServiceType(m); err != nil {
return err
}
stage("LoadMe")
if err = p.loadMe(m); err != nil {
return err
}
stage("CheckExists1")
if err = p.checkExists1(m); err != nil {
return err
}
stage("PromptRemoteName")
if err = p.promptRemoteName(m); err != nil {
return err
}
stage("CheckExists2")
if err = p.checkExists2(m); err != nil {
return err
}
stage("DoPrechecks")
if err = p.doPrechecks(m); err != nil {
return err
}
stage("DoWarnings")
if err = p.doWarnings(m); err != nil {
return err
}
m.G().LocalSigchainGuard().Set(m.Ctx(), "Prove")
defer m.G().LocalSigchainGuard().Clear(m.Ctx(), "Prove")
stage("GenerateProof")
if err = p.generateProof(m); err != nil {
return err
}
stage("PostProofToServer")
if err = p.postProofToServer(m); err != nil {
return err
}
m.G().LocalSigchainGuard().Clear(m.Ctx(), "Prove")
stage("CheckProofText")
if err = p.checkProofText(m); err != nil {
return err
}
stage("InstructAction")
if err = p.instructAction(m); err != nil {
return err
}
if !p.arg.PromptPosted {
m.Debug("PromptPosted not set, prove run finished")
return nil
}
stage("CheckStart")
if p.serviceParameters == nil {
stage("PromptPostedLoop")
if err = p.promptPostedLoop(m); err != nil {
return err
}
} else {
stage("VerifyLoop")
if err = p.verifyLoop(m); err != nil {
return err
}
}
m.UIs().LogUI.Notice("Success!")
return nil
}