1 79b24d5e 2017-07-03 xhr .\"
  2 79b24d5e 2017-07-03 xhr .\" Copyright (c) 2017 Matthias Schmidt
  3 79b24d5e 2017-07-03 xhr .\"
  4 79b24d5e 2017-07-03 xhr .\" Permission to use, copy, modify, and distribute this software for any
  5 79b24d5e 2017-07-03 xhr .\" purpose with or without fee is hereby granted, provided that the above
  6 79b24d5e 2017-07-03 xhr .\" copyright notice and this permission notice appear in all copies.
  7 79b24d5e 2017-07-03 xhr .\"
  8 79b24d5e 2017-07-03 xhr .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  9 79b24d5e 2017-07-03 xhr .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 10 79b24d5e 2017-07-03 xhr .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 11 79b24d5e 2017-07-03 xhr .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 12 79b24d5e 2017-07-03 xhr .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 13 79b24d5e 2017-07-03 xhr .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 14 79b24d5e 2017-07-03 xhr .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 15 79b24d5e 2017-07-03 xhr .\"
 16 79b24d5e 2017-07-03 xhr .\"
 17 0bb04f0b 2020-10-05 noreply .Dd October 04, 2020
 18 2e2d9eae 2017-07-06 xhr .Dt TPM 1
 19 d1365685 2017-07-04 xhr .Os
 20 d1365685 2017-07-04 xhr .Sh NAME
 21 79b24d5e 2017-07-03 xhr .Nm tpm
 22 79b24d5e 2017-07-03 xhr .Nd Simple command line password manager
 23 d1365685 2017-07-04 xhr .Sh SYNOPSIS
 24 79b24d5e 2017-07-03 xhr .Nm tpm
 25 79b24d5e 2017-07-03 xhr .Op Cm edit | find | insert | rm | show Ar entry
 26 79b24d5e 2017-07-03 xhr .Op Cm help
 27 d1365685 2017-07-04 xhr .Sh DESCRIPTION
 28 79b24d5e 2017-07-03 xhr The
 29 79b24d5e 2017-07-03 xhr .Nm
 30 2e2d9eae 2017-07-06 xhr utility is a simple password manager for the command line.
 31 2e2d9eae 2017-07-06 xhr It uses
 32 79b24d5e 2017-07-03 xhr .Xr gpg 1
 33 79b24d5e 2017-07-03 xhr to de- and encrypt passwords and stores the password in a tree-like
 34 2e2d9eae 2017-07-06 xhr hierarchy.
 35 2e2d9eae 2017-07-06 xhr It is modelled and somewhat compatible with
 36 fcdb1eed 2017-07-03 xhr .Xr pass 1 .
 37 79b24d5e 2017-07-03 xhr .Pp
 38 d1365685 2017-07-04 xhr The options are as follows:
 39 d1365685 2017-07-04 xhr .Bl -tag -width Ds
 40 d1365685 2017-07-04 xhr .It Cm edit Ar entry
 41 2e2d9eae 2017-07-06 xhr Allows the user to edit an existing password entry.
 42 2e2d9eae 2017-07-06 xhr The password named
 43 79b24d5e 2017-07-03 xhr .Ar entry
 44 2e2d9eae 2017-07-06 xhr is opened in a text editor.
 45 2e2d9eae 2017-07-06 xhr If
 46 79b24d5e 2017-07-03 xhr .Ev EDITOR
 47 79b24d5e 2017-07-03 xhr is set this will be used, otherwise
 48 79b24d5e 2017-07-03 xhr .Nm
 49 79b24d5e 2017-07-03 xhr tries to use
 50 79b24d5e 2017-07-03 xhr .Xr vi 1 .
 51 d1365685 2017-07-04 xhr .It Cm find Ar entry
 52 79b24d5e 2017-07-03 xhr Searches for all passwords named
 53 79b24d5e 2017-07-03 xhr .Ar entry
 54 2e2d9eae 2017-07-06 xhr and displays them.
 55 2e2d9eae 2017-07-06 xhr This will display password entries as well
 56 79b24d5e 2017-07-03 xhr as directories with the same name.
 57 d1365685 2017-07-04 xhr .It Cm insert Ar entry
 58 fcdb1eed 2017-07-03 xhr Asks the user for a password and creates a new encrypted
 59 79b24d5e 2017-07-03 xhr entry named
 60 79b24d5e 2017-07-03 xhr .Ar entry .
 61 79b24d5e 2017-07-03 xhr .It Cm rm Ar entry
 62 79b24d5e 2017-07-03 xhr Removes the password called
 63 79b24d5e 2017-07-03 xhr .Ar entry .
 64 79b24d5e 2017-07-03 xhr If the password does not exist an error will be shown.
 65 d1365685 2017-07-04 xhr .It Cm show Ar entry
 66 79b24d5e 2017-07-03 xhr Shows the password called
 67 79b24d5e 2017-07-03 xhr .Ar entry .
 68 79b24d5e 2017-07-03 xhr .It Cm help
 69 79b24d5e 2017-07-03 xhr Display usage instructions.
 70 79b24d5e 2017-07-03 xhr .El
 71 79b24d5e 2017-07-03 xhr .Pp
 72 79b24d5e 2017-07-03 xhr If no option is given
 73 79b24d5e 2017-07-03 xhr .Nm
 74 fcdb1eed 2017-07-03 xhr displays the existing password hierarchy.
 75 79b24d5e 2017-07-03 xhr .Sh ENVIRONMENT
 76 79b24d5e 2017-07-03 xhr .Nm
 77 79b24d5e 2017-07-03 xhr can use the following environment variables:
 78 79b24d5e 2017-07-03 xhr .Bl -tag -width "PASSWORD_STORE_KEY"
 79 79b24d5e 2017-07-03 xhr .It Ev EDITOR
 80 79b24d5e 2017-07-03 xhr .Nm
 81 79b24d5e 2017-07-03 xhr will use the editor specified in
 82 79b24d5e 2017-07-03 xhr .Ev EDITOR
 83 79b24d5e 2017-07-03 xhr if the
 84 79b24d5e 2017-07-03 xhr .Cm edit
 85 2e2d9eae 2017-07-06 xhr option is used.
 86 2e2d9eae 2017-07-06 xhr Otherwise,
 87 79b24d5e 2017-07-03 xhr .Xr vi 1
 88 79b24d5e 2017-07-03 xhr will be used.
 89 c6e44ed2 2020-10-05 noreply .It Ev NO_COLOR
 90 c6e44ed2 2020-10-05 noreply If set to any value
 91 c6e44ed2 2020-10-05 noreply .Nm
 92 c6e44ed2 2020-10-05 noreply doesn't display colors.
 93 c6e44ed2 2020-10-05 noreply The default is to display colors.
 94 79b24d5e 2017-07-03 xhr .It Ev PASSWORD_STORE_KEY
 95 79b24d5e 2017-07-03 xhr .Nm
 96 79b24d5e 2017-07-03 xhr can read the
 97 79b24d5e 2017-07-03 xhr .Xr gpg 1
 98 79b24d5e 2017-07-03 xhr identity used for encryption and decryption from this
 99 2e2d9eae 2017-07-06 xhr variable.
100 2e2d9eae 2017-07-06 xhr See
101 79b24d5e 2017-07-03 xhr .Sx FILES ,
102 79b24d5e 2017-07-03 xhr below.
103 79b24d5e 2017-07-03 xhr .El
104 d1365685 2017-07-04 xhr .Sh FILES
105 79b24d5e 2017-07-03 xhr .Bl -tag -width Ds -compact
106 79b24d5e 2017-07-03 xhr .It Pa ~/.password-store
107 79b24d5e 2017-07-03 xhr All passwords will be encrypted using
108 79b24d5e 2017-07-03 xhr .Xr gpg 1
109 79b24d5e 2017-07-03 xhr and stored under this directory.
110 79b24d5e 2017-07-03 xhr .Pp
111 79b24d5e 2017-07-03 xhr .It Pa ~/.password-store/.gpg-id
112 79b24d5e 2017-07-03 xhr Contains one line with the
113 79b24d5e 2017-07-03 xhr .Xr gpg 1
114 2e2d9eae 2017-07-06 xhr key used to en- and decrypt the password.
115 2e2d9eae 2017-07-06 xhr This could be something
116 79b24d5e 2017-07-03 xhr like
117 79b24d5e 2017-07-03 xhr .Aq user@example.com .
118 79b24d5e 2017-07-03 xhr .El
119 d1365685 2017-07-04 xhr .Sh EXIT STATUS
120 79b24d5e 2017-07-03 xhr .Nm
121 fcdb1eed 2017-07-03 xhr normally exists with 0 or with 1 if an error occurred.
122 79b24d5e 2017-07-03 xhr .Sh EXAMPLES
123 79b24d5e 2017-07-03 xhr The following examples shows the basic usage of
124 79b24d5e 2017-07-03 xhr .Nm .
125 79b24d5e 2017-07-03 xhr To list all existing passwords in a tree just call
126 79b24d5e 2017-07-03 xhr .Nm
127 79b24d5e 2017-07-03 xhr without any arguments:
128 79b24d5e 2017-07-03 xhr .Bd -literal -offset indent
129 79b24d5e 2017-07-03 xhr $ tpm
130 79b24d5e 2017-07-03 xhr /home/matthias/.password-store
131 4296d026 2017-07-03 xhr |-- email
132 4296d026 2017-07-03 xhr |   |-- gmail
133 4296d026 2017-07-03 xhr |   |-- gmx
134 4296d026 2017-07-03 xhr |   `-- home
135 79b24d5e 2017-07-03 xhr [...]
136 79b24d5e 2017-07-03 xhr .Ed
137 79b24d5e 2017-07-03 xhr .Pp
138 79b24d5e 2017-07-03 xhr If you want to save the password for one of your servers you
139 79b24d5e 2017-07-03 xhr can create a new entry called
140 79b24d5e 2017-07-03 xhr .Ar server
141 79b24d5e 2017-07-03 xhr under the parent-directory called
142 79b24d5e 2017-07-03 xhr .Ar logins
143 79b24d5e 2017-07-03 xhr call
144 79b24d5e 2017-07-03 xhr .Nm
145 79b24d5e 2017-07-03 xhr as follows:
146 79b24d5e 2017-07-03 xhr .Bd -literal -offset indent
147 79b24d5e 2017-07-03 xhr $ tpm insert logins/server
148 79b24d5e 2017-07-03 xhr Password for 'logins/server':
149 79b24d5e 2017-07-03 xhr .Ed
150 79b24d5e 2017-07-03 xhr .Pp
151 79b24d5e 2017-07-03 xhr Enter the password - that will not be displayed - and it will be saved
152 79b24d5e 2017-07-03 xhr encrypted in your password store directory.
153 7278fefb 2017-07-04 xhr .Pp
154 7278fefb 2017-07-04 xhr If you have multiple
155 7278fefb 2017-07-04 xhr .Xr gpg 1
156 7278fefb 2017-07-04 xhr keys you can set which key should be used by
157 7278fefb 2017-07-04 xhr .Nm
158 2e2d9eae 2017-07-06 xhr for all cryptographic operations.
159 2e2d9eae 2017-07-06 xhr Also see Section
160 7278fefb 2017-07-04 xhr .Sx FILES .
161 7278fefb 2017-07-04 xhr .Bd -literal -offset indent
162 7278fefb 2017-07-04 xhr $ echo "user@example.com" > ~/.password-store/.gpg-id
163 7278fefb 2017-07-04 xhr .Ed
164 d1365685 2017-07-04 xhr .Sh SEE ALSO
165 2e2d9eae 2017-07-06 xhr .Xr colortree 1 ,
166 79b24d5e 2017-07-03 xhr .Xr gpg 1 ,
167 2e2d9eae 2017-07-06 xhr .Xr tree 1
168 79b24d5e 2017-07-03 xhr .Sh AUTHORS
169 79b24d5e 2017-07-03 xhr .Nm
170 79b24d5e 2017-07-03 xhr was originally written by
171 79b24d5e 2017-07-03 xhr .An Sören Tempel Aq Mt soeren+git@soeren-tempel.net .
172 2e2d9eae 2017-07-06 xhr .Pp
173 79b24d5e 2017-07-03 xhr This version was enhanced and mostly rewritten by
174 79b24d5e 2017-07-03 xhr .An Matthias Schmidt Aq Mt matthias@dragonflybsd.org .