-
-
Notifications
You must be signed in to change notification settings - Fork 479
/
commands.go
1063 lines (1051 loc) · 31.9 KB
/
commands.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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package action
import (
"fmt"
"github.com/gopasspw/gopass/internal/backend"
"github.com/gopasspw/gopass/internal/set"
"github.com/gopasspw/gopass/pkg/debug"
"github.com/urfave/cli/v2"
)
// ShowFlags returns the flags for the show command. Exported to re-use in main
// for the default command.
func ShowFlags() []cli.Flag {
return []cli.Flag{
&cli.BoolFlag{
Name: "yes",
Aliases: []string{"y"},
Usage: "Always answer yes to yes/no questions",
},
&cli.BoolFlag{
Name: "clip",
Aliases: []string{"c"},
Usage: "Copy the password value into the clipboard",
},
&cli.BoolFlag{
Name: "alsoclip",
Aliases: []string{"C"},
Usage: "Copy the password and show everything",
},
&cli.BoolFlag{
Name: "qr",
Usage: "Print the password as a QR Code",
},
&cli.BoolFlag{
Name: "unsafe",
Aliases: []string{"u", "force", "f"},
Usage: "Display unsafe content (e.g. the password) even if safecontent is enabled",
},
&cli.BoolFlag{
Name: "password",
Aliases: []string{"o"},
Usage: "Display only the password. Takes precedence over all other flags.",
},
&cli.StringFlag{
Name: "revision",
Aliases: []string{"r"},
Usage: "Show a past revision. Does NOT support RCS specific shortcuts. Use exact revision or -<N> to select the Nth oldest revision of this entry.",
},
&cli.BoolFlag{
Name: "noparsing",
Aliases: []string{"n"},
Usage: "Do not parse the output.",
},
&cli.BoolFlag{
Name: "nosync",
Usage: "Disable auto-sync",
},
&cli.StringFlag{
Name: "chars",
Usage: "Print specific characters from the secret",
},
}
}
// GetCommands returns the cli commands exported by this module.
func (s *Action) GetCommands() []*cli.Command {
cmds := []*cli.Command{
{
Name: "alias",
Usage: "Print domain aliases",
Description: "Print defined domain aliases.",
Action: s.AliasesPrint,
},
{
Name: "audit",
Usage: "Decrypt all secrets and scan for weak or leaked passwords",
ArgsUsage: "[filter]",
Description: "" +
"This command decrypts all secrets and checks for common flaws and (optionally) " +
"against a list of previously leaked passwords.",
Before: s.IsInitialized,
Action: s.Audit,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "format",
Usage: "Output format. text, csv or html. Default: text",
Value: "text",
},
&cli.StringFlag{
Name: "output-file",
Aliases: []string{"o"},
Usage: "Output filename. Used for csv and html",
},
&cli.StringFlag{
Name: "template",
Usage: "HTML template. If not set use the built-in default.",
},
&cli.BoolFlag{
Name: "failed",
Usage: "Report only entries that failed validation. Default: false (reports all)",
},
},
},
{
Name: "cat",
Usage: "Decode and print content of a binary secret to stdout, or encode and insert from stdin",
ArgsUsage: "[secret]",
Description: "" +
"This command is similar to the way cat works on the command line. " +
"It can either be used to retrieve the decoded content of a secret " +
"similar to 'cat file' or vice versa to encode the content from STDIN " +
"to a secret.",
Before: s.IsInitialized,
Action: s.Cat,
BashComplete: s.Complete,
},
{
Name: "clone",
Usage: "Clone a password store from a git repository",
ArgsUsage: "[git-repo] [mount-point]",
Description: "" +
"This command clones an existing password store from a git remote to " +
"a local password store. Can be either used to initialize a new root store " +
"or to add a new mounted sub-store. " +
"" +
"Needs at least one argument (git URL) to clone from. " +
"Accepts a second argument (mount location) to clone and mount a sub-store, e.g. " +
"'gopass clone git@example.com/store.git foo/bar'",
Action: s.Clone,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "path",
Usage: "Path to clone the repo to",
},
&cli.StringFlag{
Name: "crypto",
Usage: fmt.Sprintf("Select crypto backend %v", backend.CryptoRegistry.BackendNames()),
},
&cli.StringFlag{
Name: "storage",
Usage: fmt.Sprintf("Select storage backend %v", set.Filter(backend.StorageRegistry.BackendNames(), "fs")),
},
&cli.BoolFlag{
Name: "check-keys",
Usage: "Check for valid decryption keys. Generate new keys if none are found.",
Value: true,
},
},
},
{
Name: "config",
Usage: "Display and edit the configuration file",
ArgsUsage: "[key [value]]",
Description: "" +
"This command allows for easy printing and editing of the configuration. " +
"Without argument, the entire config is printed. " +
"With a single argument, a single key can be printed. " +
"With two arguments a setting specified by key can be set to value.",
Action: s.Config,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Usage: "Set options to a specific store",
},
},
BashComplete: s.ConfigComplete,
},
{
Name: "convert",
Usage: "Convert a store to different backends",
Description: "Convert a store to a different set of backends",
Action: s.Convert,
Before: s.IsInitialized,
Hidden: true,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Usage: "Specify which store to convert",
},
&cli.BoolFlag{
Name: "move",
Value: true,
Usage: "Replace store?",
},
&cli.StringFlag{
Name: "crypto",
Usage: fmt.Sprintf("Which crypto backend? %v", backend.CryptoRegistry.BackendNames()),
},
&cli.StringFlag{
Name: "storage",
Usage: fmt.Sprintf("Which storage backend? %v", backend.StorageRegistry.BackendNames()),
},
},
},
{
Name: "copy",
Aliases: []string{"cp"},
Usage: "Copy secrets from one location to another",
ArgsUsage: "[from] [to]",
Description: "" +
"This command copies an existing secret in the store to another location. " +
"This also works across different sub-stores. If the source is a directory it will " +
"automatically copy recursively. In that case, the source directory is re-created " +
"at the destination if no trailing slash is found, otherwise the contents are " +
"flattened (similar to rsync).",
Before: s.IsInitialized,
Action: s.Copy,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "Force to copy the secret and overwrite existing one",
},
},
},
{
Name: "create",
Aliases: []string{"new"},
Usage: "Easy creation of new secrets",
ArgsUsage: "[secret]",
Description: "" +
"This command starts a wizard to aid in creation of new secrets.",
Before: s.IsInitialized,
Action: s.Create,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Aliases: []string{"s"},
Usage: "Which store to use",
},
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "Force path selection",
},
},
},
{
Name: "delete",
Usage: "Remove one or many secrets from the store",
ArgsUsage: "[secret [key]]",
Description: "" +
"This command removes secrets. It can work recursively on folders. " +
"Recursing across stores is purposefully not supported.",
Aliases: []string{"remove", "rm"},
Before: s.IsInitialized,
Action: s.Delete,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "recursive",
Aliases: []string{"r"},
Usage: "Recursive delete files and folders",
},
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "Force to delete the secret",
},
},
},
{
Name: "edit",
Usage: "Edit new or existing secrets",
ArgsUsage: "[secret]",
Description: "" +
"Use this command to insert a new secret or edit an existing one using " +
"your $EDITOR. It will attempt to create a secure temporary directory " +
"for storing your secret while the editor is accessing it. Please make " +
"sure your editor doesn't leak sensitive data to other locations while " +
"editing.\n" +
"Note: If $EDITOR is not set we will try 'editor'. If that's not available " +
"either we fall back to 'vi'. Consider using 'update-alternatives --config editor " +
"to change the defaults.",
Before: s.IsInitialized,
Action: s.Edit,
Aliases: []string{"set"},
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "editor",
Aliases: []string{"e"},
Usage: "Use this editor binary",
},
&cli.BoolFlag{
Name: "create",
Aliases: []string{"c"},
Usage: "Create a new secret if none found",
},
},
},
{
Name: "env",
Usage: "Run a subprocess with a pre-populated environment",
ArgsUsage: "[secret] [command and args...]",
Description: "This command runs a sub process with the environment populated from the keys of a secret.",
Before: s.IsInitialized,
Action: s.Env,
BashComplete: s.Complete,
Hidden: true,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "keep-case",
Aliases: []string{"kc"},
Value: false,
Usage: "Do not capitalize the environment variable and instead retain the original capitalization",
},
},
},
{
Name: "find",
Usage: "Search for secrets",
ArgsUsage: "<pattern>",
Description: "" +
"This command will first attempt a simple pattern match on the name of the " +
"secret. If there is an exact match it will be shown directly; if there are " +
"multiple matches, a selection will be shown.",
Before: s.IsInitialized,
Action: s.Find,
Aliases: []string{"search"},
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "unsafe",
Aliases: []string{"u", "force", "f"},
Usage: "In the case of an exact match, display the password even if safecontent is enabled",
},
},
},
{
Name: "fsck",
Usage: "Check store integrity, clean up artifacts and possibly re-write secrets",
ArgsUsage: "[filter]",
Description: "" +
"Check the integrity of the given sub-store or all stores if none are specified. " +
"Will automatically fix all issues found, i.e. it will change permissions, re-write secrets and remove outdated configs.",
Before: s.IsInitialized,
Action: s.Fsck,
BashComplete: s.MountsComplete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "decrypt",
Usage: "Decrypt and reencrypt during fsck.",
},
&cli.StringFlag{
Name: "store",
Usage: "Limit fsck to this mount point",
},
},
},
{
Name: "fscopy",
Usage: "Copy files from or to the password store",
ArgsUsage: "[from] [to]",
Description: "" +
"This command either reads a file from the filesystem and writes the " +
"encoded and encrypted version in the store or it decrypts and decodes " +
"a secret and writes the result to a file. Either source or destination " +
"must be a file and the other one a secret. If you want the source to " +
"be securely removed after copying, use 'gopass binary move'",
Before: s.IsInitialized,
Action: s.BinaryCopy,
BashComplete: s.Complete,
},
{
Name: "fsmove",
Usage: "Move files from or to the password store",
ArgsUsage: "[from] [to]",
Description: "" +
"This command either reads a file from the filesystem and writes the " +
"encoded and encrypted version in the store or it decrypts and decodes " +
"a secret and writes the result to a file. Either source or destination " +
"must be a file and the other one a secret. The source will be wiped " +
"from disk or from the store after it has been copied successfully " +
"and validated. If you don't want the source to be removed use " +
"'gopass binary copy'",
Before: s.IsInitialized,
Action: s.BinaryMove,
BashComplete: s.Complete,
},
{
Name: "generate",
Usage: "Generate a new password",
ArgsUsage: "[secret [key [length]|length]]",
Description: "" +
"Dialog to generate a new password and write it into a new or existing secret. " +
"By default, the new password will replace the first line of an existing secret (or create a new one).",
Before: s.IsInitialized,
Action: s.Generate,
BashComplete: s.CompleteGenerate,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "clip",
Aliases: []string{"c"},
Usage: "Copy the generated password to the clipboard",
},
&cli.BoolFlag{
Name: "print",
Aliases: []string{"p"},
Usage: "Print the generated password to the terminal",
},
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "Force to overwrite existing password",
},
&cli.BoolFlag{
Name: "edit",
Aliases: []string{"e"},
Usage: "Open secret for editing after generating a password",
},
&cli.BoolFlag{
Name: "symbols",
Aliases: []string{"s"},
Usage: "Use symbols in the password",
},
&cli.StringFlag{
Name: "generator",
Aliases: []string{"g"},
Usage: "Choose a password generator, use one of: cryptic, memorable, xkcd or external. Default: cryptic",
},
&cli.BoolFlag{
Name: "strict",
Usage: "Require strict character class rules",
},
&cli.BoolFlag{
Name: "force-regen",
Aliases: []string{"t"},
Usage: "Force full re-generation, incl. evaluation of templates. Will overwrite the entire secret!",
},
&cli.StringFlag{
Name: "sep",
Aliases: []string{"xkcdsep", "xs"},
Usage: "Word separator for generated passwords. If no separator is specified, the words are combined without spaces/separator and the first character of words is capitalised.",
Value: "",
},
&cli.StringFlag{
Name: "lang",
Aliases: []string{"xkcdlang", "xl"},
Usage: "Language to generate password from, currently only en (english, default) or de are supported",
Value: "en",
},
},
},
{
Name: "grep",
Usage: "Search for secrets files containing search-string when decrypted.",
ArgsUsage: "[needle]",
Description: "" +
"This command decrypts all secrets and performs a pattern matching on the " +
"content.",
Before: s.IsInitialized,
Action: s.Grep,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "regexp",
Aliases: []string{"r"},
Usage: "Interpret pattern as RE2 regular expression",
},
},
},
{
Name: "history",
Usage: "Show password history",
ArgsUsage: "[secret]",
Aliases: []string{"hist"},
Description: "" +
"Display the change history for a secret",
Before: s.IsInitialized,
Action: s.History,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "password",
Aliases: []string{"p"},
Usage: "Include passwords in output",
},
},
},
{
Name: "init",
Usage: "Initialize new password store.",
ArgsUsage: "[gpg-id]",
Description: "" +
"Initialize new password storage and use gpg-id for encryption.",
Action: s.Init,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "path",
Aliases: []string{"p"},
Usage: "Set the sub-store path to operate on",
},
&cli.StringFlag{
Name: "store",
Aliases: []string{"s"},
Usage: "Set the name of the sub-store",
},
&cli.StringFlag{
Name: "crypto",
Usage: fmt.Sprintf("Select crypto backend %v", backend.CryptoRegistry.BackendNames()),
Value: "gpgcli",
},
&cli.StringFlag{
Name: "storage",
Usage: fmt.Sprintf("Select storage backend %v", backend.StorageRegistry.BackendNames()),
Value: "gitfs",
},
},
},
{
Name: "insert",
Usage: "Insert a new secret",
ArgsUsage: "[secret]",
Description: "" +
"Insert a new secret. Optionally, echo the secret back to the console during entry. " +
"Or, optionally, the entry may be multiline. " +
"Prompt before overwriting existing secret unless forced.",
Before: s.IsInitialized,
Action: s.Insert,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "echo",
Aliases: []string{"e"},
Usage: "Display secret while typing",
},
&cli.BoolFlag{
Name: "multiline",
Aliases: []string{"m"},
Usage: "Insert using $EDITOR",
},
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "Overwrite any existing secret and do not prompt to confirm recipients",
},
&cli.BoolFlag{
Name: "append",
Aliases: []string{"a"},
Usage: "Append data read from STDIN to existing data",
},
},
},
{
Name: "link",
Usage: "Create a symlink",
ArgsUsage: "[from] [to]",
Description: "" +
"This command creates a symlink from one entry in a mounted store to another entry. " +
"Important: Does not cross mounts!",
Aliases: []string{"ln", "symlink"},
Hidden: true,
Before: s.IsInitialized,
Action: s.Link,
BashComplete: s.Complete,
},
{
Name: "list",
Usage: "List existing secrets",
ArgsUsage: "[prefix]",
Description: "" +
"This command will list all existing secrets. Provide a folder prefix to list " +
"only certain subfolders of the store.",
Aliases: []string{"ls"},
Before: s.IsInitialized,
Action: s.List,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.IntFlag{
Name: "limit",
Aliases: []string{"l"},
Usage: "Display no more than this many levels of the tree",
},
&cli.BoolFlag{
Name: "flat",
Aliases: []string{"f"},
Usage: "Print a flat list",
},
&cli.BoolFlag{
Name: "folders",
Aliases: []string{"d"},
Usage: "Print a flat list of folders",
},
&cli.BoolFlag{
Name: "strip-prefix",
Aliases: []string{"s"},
Usage: "Strip this prefix from filtered entries",
},
},
},
{
Name: "merge",
Usage: "Merge multiple secrets into one",
ArgsUsage: "[to] [from]...",
Description: "" +
"This command implements a merge workflow to help deduplicate " +
"secrets. It requires exactly one destination (may already exist) " +
"and at least one source (must exist, can be multiple). gopass will " +
"then merge all entries into one, drop into an editor, save the result " +
"and remove all merged entries.",
Before: s.IsInitialized,
Action: s.Merge,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "delete",
Aliases: []string{"d"},
Usage: "Remove merged entries",
Value: true,
},
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "Skip editor, merge entries unattended",
},
},
},
{
Name: "move",
Aliases: []string{"mv"},
Usage: "Move secrets from one location to another",
ArgsUsage: "[from] [to]",
Description: "" +
"This command moves a secret from one path to another. This also works " +
"across different sub-stores. If the source is a directory, the source directory " +
"is re-created at the destination if no trailing slash is found, otherwise the " +
"contents are flattened (similar to rsync).",
Before: s.IsInitialized,
Action: s.Move,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "Force to move the secret and overwrite existing one",
},
},
},
{
Name: "mounts",
Usage: "Edit mounted stores",
Description: "" +
"This command displays all mounted password stores. It offers several " +
"subcommands to create or remove mounts.",
Before: s.IsInitialized,
Action: s.MountsPrint,
Subcommands: []*cli.Command{
{
Name: "add",
Aliases: []string{"mount"},
Usage: "Mount a password store",
Description: "" +
"This command allows for mounting an existing or new password store " +
"at any path in an existing root store.",
Before: s.IsInitialized,
Action: s.MountAdd,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "create",
Aliases: []string{"c"},
Usage: "Create a new store at this location",
},
},
},
{
Name: "remove",
Aliases: []string{"rm", "unmount", "umount"},
Usage: "Umount an mounted password store",
Description: "" +
"This command allows to unmount an mounted password store. This will " +
"only updated the configuration and not delete the password store.",
Before: s.IsInitialized,
Action: s.MountRemove,
BashComplete: s.MountsComplete,
},
{
Name: "versions",
Aliases: []string{"version"},
Usage: "Display mount provider versions",
Description: "" +
"This command displays version information of important external " +
"commands used by the configured password store mounts.",
Before: s.IsInitialized,
Action: s.MountsVersions,
},
},
},
{
Name: "otp",
Usage: "Generate time- or hmac-based tokens",
ArgsUsage: "[secret]",
Aliases: []string{"totp", "hotp"},
Description: "" +
"Tries to parse an OTP URL (otpauth://). URL can be TOTP or HOTP. " +
"The URL can be provided on its own line or on a key value line with a key named 'totp'.",
Before: s.IsInitialized,
Action: s.OTP,
BashComplete: s.Complete,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "clip",
Aliases: []string{"c"},
Usage: "Copy the time-based token into the clipboard",
},
&cli.StringFlag{
Name: "qr",
Aliases: []string{"q"},
Usage: "Write QR code to FILE",
},
&cli.BoolFlag{
Name: "password",
Aliases: []string{"o"},
Usage: "Only display the token",
},
&cli.BoolFlag{
Name: "snip",
Aliases: []string{"s"},
Usage: "Scan screen content to insert a OTP QR code into provided entry",
},
},
},
{
Name: "process",
Usage: "Process a template file",
Description: "" +
"This command processes a template file. It will read the template file " +
"and replace all variables with their values.",
Before: s.IsInitialized,
Action: s.Process,
},
{
Name: "rcs",
Usage: "Run a RCS command inside a password store",
ArgsUsage: "[init|push|pull]",
Description: "" +
"If the password store is a git repository, execute a git command " +
"specified by git-command-args.",
Hidden: true,
Subcommands: []*cli.Command{
{
Name: "init",
Usage: "Init RCS repo",
Description: "Create and initialize a new RCS repo in the store",
Before: s.IsInitialized,
Action: s.RCSInit,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Usage: "Store to operate on",
},
&cli.StringFlag{
Name: "name",
Aliases: []string{"username"},
Usage: "Git Author Name",
},
&cli.StringFlag{
Name: "email",
Aliases: []string{"useremail"},
Usage: "Git Author Email",
},
&cli.StringFlag{
Name: "storage",
Usage: fmt.Sprintf("Select storage backend %v", set.Filter(backend.StorageRegistry.BackendNames(), "fs")),
Value: "gitfs",
},
},
},
{
Name: "status",
Usage: "RCS status",
Description: "Show the RCS status",
Before: s.IsInitialized,
Action: s.RCSStatus,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Usage: "Store to operate on",
},
},
},
},
},
{
Name: "recipients",
Usage: "Edit recipient permissions",
Description: "" +
"This command displays all existing recipients for all mounted stores. " +
"The subcommands allow adding or removing recipients.",
Before: s.IsInitialized,
Action: s.RecipientsPrint,
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "pretty",
Usage: "Pretty print recipients",
Value: true,
},
},
Subcommands: []*cli.Command{
{
Name: "ack",
Aliases: []string{"acknowledge"},
Usage: "Update recipients.hash",
Description: "" +
"This command updates the value of recipients.hash. " +
"This should only be run after manually validating any " +
"changes to the recipients list. ",
Before: s.IsInitialized,
Action: s.RecipientsAck,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Usage: "Store to operate on",
},
},
},
{
Name: "add",
Aliases: []string{"authorize"},
Usage: "Add any number of Recipients to any store",
Description: "" +
"This command adds any number of recipients to any existing store. " +
"If none are given it will display a list of usable public keys. " +
"After adding the recipient to the list it will re-encrypt the whole " +
"affected store to make sure the recipient has access to all existing " +
"secrets.",
Before: s.IsInitialized,
Action: s.RecipientsAdd,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Usage: "Store to operate on",
},
&cli.BoolFlag{
Name: "force",
Usage: "Force adding non-existing keys",
},
},
},
{
Name: "remove",
Aliases: []string{"rm", "deauthorize"},
Usage: "Remove any number of Recipients from any store",
Description: "" +
"This command removes any number of recipients from any existing store. " +
"If no recipients are provided, it will show a list of existing recipients " +
"to choose from. It will refuse to remove the current user's key from the " +
"store to avoid losing access. After removing the keys it will re-encrypt " +
"all existing secrets. Please note that the removed recipients will still " +
"be able to decrypt old revisions of the password store and any local " +
"copies they might have. The only way to reliably remove a recipient is to " +
"rotate all existing secrets.",
Before: s.IsInitialized,
Action: s.RecipientsRemove,
BashComplete: s.RecipientsComplete,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Usage: "Store to operate on",
},
&cli.BoolFlag{
Name: "force",
Usage: "Force adding non-existing keys",
},
},
},
},
},
{
Name: "setup",
Usage: "Initialize a new password store",
Description: "" +
"This command is automatically invoked if gopass is started without any " +
"existing password store. This command exists so users can be provided with " +
"simple one-command setup instructions.",
Action: s.Setup,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "remote",
Usage: "URL to a git remote, will attempt to join this team",
},
&cli.StringFlag{
Name: "alias",
Usage: "Local mount point for the given remote",
},
&cli.BoolFlag{
Name: "create",
Usage: "Create a new team (default: false, i.e. join an existing team)",
},
&cli.StringFlag{
Name: "name",
Usage: "Firstname and Lastname for unattended GPG key generation",
},
&cli.StringFlag{
Name: "email",
Usage: "EMail for unattended GPG key generation",
},
&cli.StringFlag{
Name: "crypto",
Usage: fmt.Sprintf("Select crypto backend %v", backend.CryptoRegistry.BackendNames()),
},
&cli.StringFlag{
Name: "storage",
Usage: fmt.Sprintf("Select storage backend %v", backend.StorageRegistry.BackendNames()),
},
},
},
{
Name: "show",
Usage: "Display the content of a secret",
ArgsUsage: "[secret]",
Description: "" +
"Show an existing secret and optionally put its first line on the clipboard. " +
"If put on the clipboard, it will be cleared after 45 seconds.",
Before: s.IsInitialized,
Action: s.Show,
BashComplete: s.Complete,
Flags: ShowFlags(),
},
{
Name: "sum",
Usage: "Compute the SHA256 checksum",
ArgsUsage: "[secret]",
Description: "" +
"This command decodes an Base64 encoded secret and computes the SHA256 checksum " +
"over the decoded data. This is useful to verify the integrity of an " +
"inserted secret.",
Aliases: []string{"sha", "sha256"},
Before: s.IsInitialized,
Action: s.Sum,
BashComplete: s.Complete,
},
{
Name: "sync",
Usage: "Sync all local stores with their remotes",
Description: "" +
"Sync all local stores with their git remotes, if any, and check " +
"any possibly affected gpg keys.",
Before: s.IsInitialized,
Action: s.Sync,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "store",
Aliases: []string{"s"},
Usage: "Select the store to sync",
},
},
},
{
Name: "templates",
Usage: "Edit templates",
Description: "" +
"List existing templates in the password store and allow for editing " +
"and creating them.",
Before: s.IsInitialized,
Action: s.TemplatesPrint,
Subcommands: []*cli.Command{
{
Name: "show",
Usage: "Show a secret template.",
Description: "Display an existing template",
Aliases: []string{"cat"},
Before: s.IsInitialized,
Action: s.TemplatePrint,
BashComplete: s.TemplatesComplete,
},
{
Name: "edit",
Usage: "Edit secret templates.",
Description: "Edit an existing or new template",
Aliases: []string{"create", "new"},
Before: s.IsInitialized,
Action: s.TemplateEdit,
BashComplete: s.TemplatesComplete,
},
{
Name: "remove",
Aliases: []string{"rm"},
Usage: "Remove secret templates.",
Description: "Remove an existing template",
Before: s.IsInitialized,
Action: s.TemplateRemove,
BashComplete: s.TemplatesComplete,
},
},
},
{
Name: "unclip",
Usage: "Internal command to clear clipboard",
Description: "Clear the clipboard if the content matches the checksum.",
Action: s.Unclip,
Hidden: true,
Flags: []cli.Flag{
&cli.IntFlag{
Name: "timeout",
Usage: "Time to wait",
},
&cli.BoolFlag{
Name: "force",