forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cmdline.go
496 lines (449 loc) · 12.3 KB
/
cmdline.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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
// Copyright 2015 Keybase, Inc. All rights reserved. Use of
// this source code is governed by the included BSD license.
package libcmdline
import (
"fmt"
"io"
"regexp"
"strings"
"time"
"github.com/keybase/cli"
"github.com/keybase/client/go/libkb"
)
type Command interface {
libkb.Command
ParseArgv(*cli.Context) error // A command-specific parse-args
Run() error // Run in client mode
}
type ForkCmd int
type LogForward int
const (
NormalFork ForkCmd = iota
NoFork
ForceFork
)
const (
LogForwardNormal LogForward = iota
LogForwardNone
)
type CommandLine struct {
app *cli.App
ctx *cli.Context
cmd Command
name string // the name of the chosen command
service bool // The server is a special command
fork ForkCmd // If the command is to stop (then don't start the server)
noStandalone bool // On if this command can't run in standalone mode
logForward LogForward // What do to about log forwarding
defaultCmd string
}
func (p CommandLine) IsService() bool { return p.service }
func (p *CommandLine) SetService() { p.service = true }
func (p CommandLine) GetForkCmd() ForkCmd { return p.fork }
func (p *CommandLine) SetForkCmd(v ForkCmd) { p.fork = v }
func (p *CommandLine) SetNoStandalone() { p.noStandalone = true }
func (p CommandLine) IsNoStandalone() bool { return p.noStandalone }
func (p *CommandLine) SetLogForward(f LogForward) { p.logForward = f }
func (p *CommandLine) GetLogForward() LogForward { return p.logForward }
func (p CommandLine) GetSplitLogOutput() (bool, bool) {
return p.GetBool("split-log-output", true)
}
func (p CommandLine) GetNoAutoFork() (bool, bool) {
return p.GetBool("no-auto-fork", true)
}
func (p CommandLine) GetAutoFork() (bool, bool) {
return p.GetBool("auto-fork", true)
}
func (p CommandLine) GetHome() string {
return p.GetGString("home")
}
func (p CommandLine) GetServerURI() string {
return p.GetGString("server")
}
func (p CommandLine) GetConfigFilename() string {
return p.GetGString("config-file")
}
func (p CommandLine) GetSessionFilename() string {
return p.GetGString("session-file")
}
func (p CommandLine) GetDbFilename() string {
return p.GetGString("db")
}
func (p CommandLine) GetDebug() (bool, bool) {
return p.GetBool("debug", true)
}
func (p CommandLine) GetVDebugSetting() string {
return p.GetGString("vdebug")
}
func (p CommandLine) GetPGPFingerprint() *libkb.PGPFingerprint {
return libkb.PGPFingerprintFromHexNoError(p.GetGString("fingerprint"))
}
func (p CommandLine) GetProxy() string {
return p.GetGString("proxy")
}
func (p CommandLine) GetLogFormat() string {
return p.GetGString("log-format")
}
func (p CommandLine) GetGpgHome() string {
return p.GetGString("gpg-home")
}
func (p CommandLine) GetAPIDump() (bool, bool) {
return p.GetBool("api-dump-unsafe", true)
}
func (p CommandLine) GetRunMode() (libkb.RunMode, error) {
return libkb.StringToRunMode(p.GetGString("run-mode"))
}
func (p CommandLine) GetPinentry() string {
return p.GetGString("pinentry")
}
func (p CommandLine) GetGString(s string) string {
return p.ctx.GlobalString(s)
}
func (p CommandLine) GetString(s string) string {
return p.ctx.String(s)
}
func (p CommandLine) GetGInt(s string) int {
return p.ctx.GlobalInt(s)
}
func (p CommandLine) GetGDuration(s string) (time.Duration, error) {
return time.ParseDuration(p.GetGString(s))
}
func (p CommandLine) GetGpg() string {
return p.GetGString("gpg")
}
func (p CommandLine) GetSecretKeyringTemplate() string {
return p.GetGString("secret-keyring")
}
func (p CommandLine) GetSocketFile() string {
return p.GetGString("socket-file")
}
func (p CommandLine) GetPidFile() string {
return p.GetGString("pid-file")
}
func (p CommandLine) GetScraperTimeout() (time.Duration, bool) {
ret, err := p.GetGDuration("scraper-timeout")
if err != nil {
return 0, false
}
return ret, true
}
func (p CommandLine) GetAPITimeout() (time.Duration, bool) {
ret, err := p.GetGDuration("api-timeout")
if err != nil {
return 0, false
}
return ret, true
}
func (p CommandLine) GetGpgOptions() []string {
var ret []string
s := p.GetGString("gpg-options")
if len(s) > 0 {
ret = regexp.MustCompile(`\s+`).Split(s, -1)
}
return ret
}
func (p CommandLine) getKIDs(name string) []string {
s := p.GetGString(name)
if len(s) == 0 {
return nil
}
return strings.Split(s, ":")
}
func (p CommandLine) GetMerkleKIDs() []string {
return p.getKIDs("merkle-kids")
}
func (p CommandLine) GetCodeSigningKIDs() []string {
return p.getKIDs("code-signing-kids")
}
func (p CommandLine) GetUserCacheMaxAge() (time.Duration, bool) {
ret, err := p.GetGDuration("user-cache-maxage")
if err != nil {
return 0, false
}
return ret, true
}
func (p CommandLine) GetProofCacheSize() (int, bool) {
ret := p.GetGInt("proof-cache-size")
if ret != 0 {
return ret, true
}
return 0, false
}
func (p CommandLine) GetLinkCacheSize() (int, bool) {
ret := p.GetGInt("link-cache-size")
if ret != 0 {
return ret, true
}
return 0, false
}
func (p CommandLine) GetLocalTrackMaxAge() (time.Duration, bool) {
ret, err := p.GetGDuration("local-track-maxage")
if err != nil {
return 0, false
}
return ret, true
}
func (p CommandLine) GetStandalone() (bool, bool) {
return p.GetBool("standalone", true)
}
func (p CommandLine) GetLocalRPCDebug() string {
return p.GetGString("local-rpc-debug-unsafe")
}
func (p CommandLine) GetTimers() string {
return p.GetGString("timers")
}
func (p CommandLine) GetTorMode() (ret libkb.TorMode, err error) {
if s := p.GetGString("tor-mode"); s != "" {
ret, err = libkb.StringToTorMode(s)
}
return ret, err
}
func (p CommandLine) GetTorHiddenAddress() string {
return p.GetGString("tor-hidden-address")
}
func (p CommandLine) GetTorProxy() string {
return p.GetGString("tor-proxy")
}
func (p CommandLine) GetBool(s string, glbl bool) (bool, bool) {
var v bool
if glbl {
v = p.ctx.GlobalBool(s)
} else {
v = p.ctx.Bool(s)
}
return v, v
}
type CmdBaseHelp struct {
ctx *cli.Context
}
func (c *CmdBaseHelp) GetUsage() libkb.Usage {
return libkb.Usage{}
}
func (c *CmdBaseHelp) ParseArgv(*cli.Context) error { return nil }
type CmdGeneralHelp struct {
CmdBaseHelp
}
func (c *CmdBaseHelp) RunClient() error { return c.Run() }
func (c *CmdBaseHelp) Run() error {
cli.ShowAppHelp(c.ctx)
return nil
}
type CmdSpecificHelp struct {
CmdBaseHelp
name string
}
func (c CmdSpecificHelp) Run() error {
cli.ShowCommandHelp(c.ctx, c.name)
return nil
}
func NewCommandLine(addHelp bool, extraFlags []cli.Flag) *CommandLine {
app := cli.NewApp()
ret := &CommandLine{app: app, fork: NormalFork}
ret.PopulateApp(addHelp, extraFlags)
return ret
}
func (p *CommandLine) PopulateApp(addHelp bool, extraFlags []cli.Flag) {
app := p.app
app.Name = "keybase"
app.Version = libkb.VersionString()
app.Usage = "Keybase command line client."
app.Flags = []cli.Flag{
cli.StringFlag{
Name: "home, H",
Usage: "Specify an (alternate) home directory.",
},
cli.StringFlag{
Name: "server, s",
Usage: "Specify server API.",
},
cli.StringFlag{
Name: "config-file, c",
Usage: "Specify an (alternate) master config file.",
},
cli.StringFlag{
Name: "session-file",
Usage: "Specify an alternate session data file.",
},
cli.StringFlag{
Name: "db",
Usage: "Specify an alternate local DB location.",
},
cli.StringFlag{
Name: "api-uri-path-prefix",
Usage: "Specify an alternate API URI path prefix.",
},
cli.StringFlag{
Name: "pinentry",
Usage: "Specify a path to find a pinentry program.",
},
cli.StringFlag{
Name: "secret-keyring",
Usage: "Location of the Keybase secret-keyring (P3SKB-encoded).",
},
cli.StringFlag{
Name: "socket-file",
Usage: "Location of the keybased socket-file.",
},
cli.StringFlag{
Name: "pid-file",
Usage: "Location of the keybased pid-file (to ensure only one running daemon).",
},
cli.StringFlag{
Name: "proxy",
Usage: "Specify an HTTP(s) proxy to ship all Web requests over.",
},
cli.BoolFlag{
Name: "debug, d",
Usage: "Enable debugging mode.",
},
cli.StringFlag{
Name: "vdebug",
Usage: "Verbose debugging; takes a comma-joined list of levels and tags",
},
cli.StringFlag{
Name: "run-mode",
Usage: "Run mode (devel, staging, prod).", // These are defined in libkb/constants.go
},
cli.StringFlag{
Name: "log-format",
Usage: "Log format (default, plain, file, fancy).",
},
cli.StringFlag{
Name: "pgpdir, gpgdir",
Usage: "Specify a PGP directory (default is ~/.gnupg).",
},
cli.BoolFlag{
Name: "api-dump-unsafe",
Usage: "Dump API call internals (may leak secrets).",
},
cli.StringFlag{
Name: "merkle-kids",
Usage: "Set of admissable Merkle Tree fingerprints (colon-separated).",
},
cli.StringFlag{
Name: "code-signing-kids",
Usage: "Set of code signing key IDs (colon-separated).",
},
cli.IntFlag{
Name: "user-cache-size",
Usage: "Number of User entries to cache.",
},
cli.IntFlag{
Name: "proof-cache-size",
Usage: "Number of proof entries to cache.",
},
cli.StringFlag{
Name: "gpg",
Usage: "Path to GPG client (optional for exporting keys).",
},
cli.StringFlag{
Name: "gpg-options",
Usage: "Options to use when calling GPG.",
},
cli.BoolFlag{
Name: "standalone",
Usage: "Use the client without any daemon support.",
},
cli.StringFlag{
Name: "local-rpc-debug-unsafe",
Usage: "Use to debug local RPC (may leak secrets).",
},
cli.StringFlag{
Name: "log-file",
Usage: "Specify a log file for the keybase service.",
},
cli.BoolFlag{
Name: "split-log-output",
Usage: "Output service log messages to current terminal.",
},
cli.StringFlag{
Name: "timers",
Usage: "Specify 'a' for API; 'r' for RPCs; and 'x' for eXternal API calls",
},
cli.StringFlag{
Name: "scraper-timeout",
Usage: "set the HTTP timeout for external proof scrapers",
},
cli.StringFlag{
Name: "api-timeout",
Usage: "set the HTTP timeout for API calls to the keybase API server",
},
cli.StringFlag{
Name: "tor-mode",
Usage: "set TOR mode to be 'leaky', 'none', or 'strict'. 'none' by default. See 'help tor' for more details.",
},
cli.StringFlag{
Name: "tor-proxy",
Usage: fmt.Sprintf("set TOR proxy; when Tor mode is on; defaults to %s when TOR is enabled", libkb.TorProxy),
},
cli.StringFlag{
Name: "tor-hidden-address",
Usage: fmt.Sprintf("set TOR address of keybase server; defaults to %s", libkb.TorServerURI),
},
}
if extraFlags != nil {
app.Flags = append(app.Flags, extraFlags...)
}
app.Commands = []cli.Command{}
}
func filter(cmds []cli.Command, fn func(cli.Command) bool) []cli.Command {
var filter []cli.Command
for _, cmd := range cmds {
if fn(cmd) {
filter = append(filter, cmd)
}
}
return filter
}
func (p *CommandLine) AddCommands(cmds []cli.Command) {
cmds = filter(cmds, func(c cli.Command) bool {
return c.Name != ""
})
p.app.Commands = append(p.app.Commands, cmds...)
}
func (p *CommandLine) SetDefaultCommand(name string, cmd Command) {
p.defaultCmd = name
p.app.Action = func(c *cli.Context) {
p.cmd = cmd
p.ctx = c
p.name = name
}
}
// Called back from inside our subcommands, when they're picked...
func (p *CommandLine) ChooseCommand(cmd Command, name string, ctx *cli.Context) {
p.cmd = cmd
p.name = name
p.ctx = ctx
}
func (p *CommandLine) Parse(args []string) (cmd Command, err error) {
// This is suboptimal, but the default help action when there are
// no args crashes.
// (cli sets HelpPrinter to nil when p.app.Run(...) returns.)
if len(args) == 1 && p.defaultCmd == "help" {
args = append(args, p.defaultCmd)
}
// Actually pick a command
err = p.app.Run(args)
// Should not be populated
cmd = p.cmd
if err != nil || cmd == nil {
return
}
// cli.HelpPrinter is nil here...anything that needs it will panic.
// If we failed to parse arguments properly, switch to the help command
if err = p.cmd.ParseArgv(p.ctx); err == nil {
_, err = p.GetRunMode()
}
if err != nil {
cmd = &CmdSpecificHelp{CmdBaseHelp{p.ctx}, p.name}
}
return
}
func (p *CommandLine) SetOutputWriter(w io.Writer) {
p.app.Writer = w
}
// AddHelpTopics appends topics to the list of help topics for
// this app.
func (p *CommandLine) AddHelpTopics(topics []cli.HelpTopic) {
p.app.HelpTopics = append(p.app.HelpTopics, topics...)
}