pass-otp(1)

1PASS-OTP(1)                 General Commands Manual                PASS-OTP(1)
2
3
4

NAME

6       pass-otp  -  A  pass(1)  extension for managing one-time-password (OTP)
7       tokens.
8
9

SYNOPSIS

11       pass otp [ COMMAND ] [ OPTIONS ]... [ ARGS ]...
12
13

DESCRIPTION

15       pass-otp extends the pass(1) utility with the otp  command  for  adding
16       OTP secrets, generating OTP codes, and displaying secret key URIs using
17       the standard otpauth:// scheme.
18
19       If no COMMAND is specified, COMMAND defaults to code.
20
21

COMMANDS

23       otp code [ --clip, -c ] pass-name
24
25              Generate and print an OTP code from the  secret  key  stored  in
26              pass-name  using  oathtool(1).  If --clip or -c is specified, do
27              not print the code but instead copy it to  the  clipboard  using
28              xclip(1)  and  then  restore  the  clipboard  after 45 (or PASS‐
29              WORD_STORE_CLIP_TIME) seconds.  This  command  is  alternatively
30              named show.
31
32
33       otp  insert  [  --force,  -f  ]  [  --echo,  -e  ] [ [ --secret, -s ] [
34       --issuer, -i issuer ] [ --account, -a account ] ] [ pass-name ]
35
36              Prompt for and insert a new OTP secret into the  password  store
37              at pass-name.
38
39              If  --secret is specified, prompt for the secret value, assuming
40              SHA1 algorithm, 30-second period, and 6 OTP digits. One or  both
41              of issuer and account must also be specified.
42
43              If --secret is not specified, prompt for a key URI; see the doc‐
44              umentation  at  ⟨https://github.com/google/google-authenticator/
45              wiki/Key-Uri-Format⟩ for the key URI specification.
46
47              The  secret is consumed from stdin; specify --echo or -e to echo
48              input when running this command interactively. If  pass-name  is
49              not  specified,  convert  the  issuer:accountname URI label to a
50              path in the form of isser/accountname. Prompt before overwriting
51              an existing secret, unless --force or -f is specified. This com‐
52              mand is alternatively named add.
53
54
55       otp append [ --force, -f ] [  --echo,  -e  ]  [  [  --secret,  -s  ]  [
56       --issuer, -i issuer ] [ --account, -a account ] ] pass-name
57
58              Append  an  OTP secret to the password stored in pass-name, pre‐
59              serving any existing lines.
60
61              If --secret is specified, prompt for the secret value,  assuming
62              SHA1  algorithm, 30-second period, and 6 OTP digits. One or both
63              of issuer and account must also be specified.
64
65              If --secret is not specified, prompt for a key URI; see the doc‐
66              umentation  at  ⟨https://github.com/google/google-authenticator/
67              wiki/Key-Uri-Format⟩ for the key URI specification.
68
69              The URI is consumed from stdin; specify --echo  or  -e  to  echo
70              input  when  running  this  command interactively. Prompt before
71              overwriting an existing secret, unless --force or -f  is  speci‐
72              fied.
73
74
75       otp uri [ --clip, -c | --qrcode, -q ] pass-name
76
77              Print the key URI stored in pass-name to stdout. If --clip or -c
78              is specified, do not print the URI but instead copy  it  to  the
79              clipboard using xclip(1) and then restore the clipboard after 45
80              (or PASSWORD_STORE_CLIP_TIME) seconds.  If  --qrcode  or  -q  is
81              specified,  do  not  print the URI but instead display a QR code
82              using qrencode(1) either to the terminal or graphically if  sup‐
83              ported.
84
85
86       otp validate uri
87
88              Test  a URI string for validity according to the Key Uri Format.
89              For more information about this format, see the documentation at
90              ⟨https://github.com/google/google-authenticator/wiki/Key-Uri-
91              Format⟩.
92
93

OPTIONS

95       help, -h, --help
96              Show usage message.
97
98

AUTHORS

104       pass-otp was written by Tad Fisher ⟨tadfisher@gmail.com⟩.
105
106

COPYING

108       This program is free software: you can redistribute it and/or modify it
109       under  the  terms of the GNU General Public License as published by the
110       Free Software Foundation, either version 3 of the License, or (at  your
111       option) any later version.
112
113       This  program  is  distributed  in the hope that it will be useful, but
114       WITHOUT ANY  WARRANTY;  without  even  the  implied  warranty  of  MER‐
115       CHANTABILITY  or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
116       Public License for more details.
117
118       You should have received a copy of the GNU General Public License along
119       with this program.  If not, see <http://www.gnu.org/licenses/>.
120
121
122
123Password store OTP extension     2017 March 19                     PASS-OTP(1)