1 5cdf5adc 2022-05-08 op #!/usr/bin/env perl
3 5cdf5adc 2022-05-08 op # Copyright (c) 2022 Omar Polo <op@omarpolo.com>
5 5cdf5adc 2022-05-08 op # Permission to use, copy, modify, and distribute this software for any
6 5cdf5adc 2022-05-08 op # purpose with or without fee is hereby granted, provided that the above
7 5cdf5adc 2022-05-08 op # copyright notice and this permission notice appear in all copies.
9 5cdf5adc 2022-05-08 op # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 5cdf5adc 2022-05-08 op # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 5cdf5adc 2022-05-08 op # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 5cdf5adc 2022-05-08 op # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 5cdf5adc 2022-05-08 op # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 5cdf5adc 2022-05-08 op # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 5cdf5adc 2022-05-08 op # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 5cdf5adc 2022-05-08 op use open ":std", ":encoding(UTF-8)";
23 5cdf5adc 2022-05-08 op use Getopt::Long qw(:config bundling require_order);
24 5cdf5adc 2022-05-08 op use Pod::Usage;
25 5cdf5adc 2022-05-08 op use File::Basename;
26 5cdf5adc 2022-05-08 op use File::Find;
28 5cdf5adc 2022-05-08 op my $store = $ENV{'PLASS_STORE'} || $ENV{'HOME'}.'/.password-store';
30 5cdf5adc 2022-05-08 op my $got = $ENV{'PLASS_GOT'} || 'got';
31 5cdf5adc 2022-05-08 op my $tog = $ENV{'PLASS_TOG'} || 'tog';
33 5cdf5adc 2022-05-08 op my $gpg = $ENV{'PLASS_GPG'} || 'gpg2';
34 5cdf5adc 2022-05-08 op my @gpg_flags = qw(--quiet --compress-algo=none --no-encrypt-to);
36 5bbf948d 2022-05-15 op my $default_chars = $ENV{'PLASS_CHARS'} || '!-~';
37 5cdf5adc 2022-05-08 op my $default_length = $ENV{'PLASS_LENGTH'};
38 5cdf5adc 2022-05-08 op if (!defined($default_length) || $default_length lt 0) {
39 5cdf5adc 2022-05-08 op $default_length = 32;
43 5cdf5adc 2022-05-08 op "h|?" => sub { pod2usage(0) },
44 5cdf5adc 2022-05-08 op ) or pod2usage(1);
46 5cdf5adc 2022-05-08 op my $cmd = shift or pod2usage(1);
48 5cdf5adc 2022-05-08 op my %subcmd = (
49 5cdf5adc 2022-05-08 op cat => [\&cmd_cat, "entries..."],
50 5cdf5adc 2022-05-08 op find => [\&cmd_find, "[pattern]"],
51 5cdf5adc 2022-05-08 op gen => [\&cmd_gen, "[-c chars] [-l length] entry"],
52 5cdf5adc 2022-05-08 op got => [\&cmd_got, "arguments ..."],
53 5cdf5adc 2022-05-08 op mv => [\&cmd_mv, "from to"],
54 5cdf5adc 2022-05-08 op regen => [\&cmd_regen, "[-c chars] [-l length] entry"],
55 5cdf5adc 2022-05-08 op rm => [\&cmd_rm, "entry"],
56 afdbc7b0 2022-06-29 op tee => [\&cmd_tee, "[-q] entry"],
57 5cdf5adc 2022-05-08 op tog => [\&cmd_tog, "arguments ..."],
59 5cdf5adc 2022-05-08 op pod2usage(1) unless defined $subcmd{$cmd};
60 5cdf5adc 2022-05-08 op my ($fn, $usage) = @{$subcmd{$cmd}};
69 5cdf5adc 2022-05-08 op my $prog = basename $0;
70 5cdf5adc 2022-05-08 op say STDERR "Usage: $prog $cmd $usage";
74 5cdf5adc 2022-05-08 op sub name2file {
75 5cdf5adc 2022-05-08 op my $f = shift;
76 5cdf5adc 2022-05-08 op $f .= ".gpg" unless $f =~ m,\.gpg$,;
80 5cdf5adc 2022-05-08 op # tr -cd -- $chars < /dev/random | dd bs=$len count=1 status=none
82 5cdf5adc 2022-05-08 op my ($chars, $length) = @_;
83 5cdf5adc 2022-05-08 op my $pass = "";
85 5cdf5adc 2022-05-08 op open(my $fh, '<:raw', '/dev/random')
86 5cdf5adc 2022-05-08 op or die "can't open /dev/random: $!";
87 5cdf5adc 2022-05-08 op my $l = $length;
88 5cdf5adc 2022-05-08 op while ($l gt 0) {
89 5cdf5adc 2022-05-08 op read($fh, my $t, $length * 4)
90 5cdf5adc 2022-05-08 op or die "failed to read /dev/random: $!";
91 5cdf5adc 2022-05-08 op $t =~ s/[^$chars]//g;
92 5cdf5adc 2022-05-08 op $l -= length($t);
97 5cdf5adc 2022-05-08 op return substr($pass, 0, $length);
100 5cdf5adc 2022-05-08 op sub readpass {
101 5cdf5adc 2022-05-08 op # todo some stty black magic to avoid echo
102 5cdf5adc 2022-05-08 op print shift if -t;
103 5cdf5adc 2022-05-08 op my $pass = <>;
104 5cdf5adc 2022-05-08 op die "failed to read stdin: $!" unless defined($pass);
106 5cdf5adc 2022-05-08 op return $pass;
110 1f89d66a 2022-06-29 op my $dir = shift;
111 1f89d66a 2022-06-29 op my $parent = dirname $dir;
112 1f89d66a 2022-06-29 op mkdirs($parent) unless -d $parent || $parent eq '/';
113 1f89d66a 2022-06-29 op mkdir $dir or die "mkdir $dir: $!"
114 1f89d66a 2022-06-29 op unless -d $dir;
117 5cdf5adc 2022-05-08 op sub writepass {
118 5cdf5adc 2022-05-08 op my ($file, $pass) = @_;
120 1f89d66a 2022-06-29 op mkdirs(dirname $file);
122 5cdf5adc 2022-05-08 op my @args = ($gpg, @gpg_flags, '-e', '-r', recipient(),
123 5cdf5adc 2022-05-08 op '-o', $file);
124 5cdf5adc 2022-05-08 op open my $fh, '|-', @args;
125 5cdf5adc 2022-05-08 op say $fh "$pass";
129 5cdf5adc 2022-05-08 op sub recipient {
130 5cdf5adc 2022-05-08 op open my $fh, '<', "$store/.gpg-id"
131 5cdf5adc 2022-05-08 op or die "can't open recipient file";
132 5cdf5adc 2022-05-08 op my $r = <$fh>;
138 5cdf5adc 2022-05-08 op sub passfind {
139 5cdf5adc 2022-05-08 op my $pattern = shift;
143 5cdf5adc 2022-05-08 op wanted => sub {
144 5cdf5adc 2022-05-08 op if (m,/.git$, || m,/.got$,) {
145 5cdf5adc 2022-05-08 op $File::Find::prune = 1;
149 5cdf5adc 2022-05-08 op return if defined($pattern) && ! m/$pattern/;
150 5cdf5adc 2022-05-08 op return unless -f && m,.gpg$,;
152 5cdf5adc 2022-05-08 op s,^$store/*,,;
154 5cdf5adc 2022-05-08 op push @entries, $_;
156 5cdf5adc 2022-05-08 op no_chdir => 1,
157 5cdf5adc 2022-05-08 op follow_fast => 1,
158 5cdf5adc 2022-05-08 op }, ($store));
159 5cdf5adc 2022-05-08 op return sort(@entries);
163 87197963 2022-06-29 op # discard stdout
164 5cdf5adc 2022-05-08 op open my $fh, '-|', ($got, @_);
169 5cdf5adc 2022-05-08 op sub got_add {
170 f96edc25 2022-06-29 op return got 'add', '-I', shift;
174 f96edc25 2022-06-29 op got 'remove', '-f', shift
179 afdbc7b0 2022-06-29 op my $pid = fork;
180 afdbc7b0 2022-06-29 op die "failed to fork: $!" unless defined $pid;
182 afdbc7b0 2022-06-29 op if ($pid ne 0) {
184 afdbc7b0 2022-06-29 op die "failed to commit changes" if $?;
188 afdbc7b0 2022-06-29 op open (STDOUT, ">&", \*STDERR)
189 afdbc7b0 2022-06-29 op or die "can't redirect stdout to stderr";
190 afdbc7b0 2022-06-29 op exec ($got, 'commit', '-m', shift)
191 afdbc7b0 2022-06-29 op or die "failed to exec $got: $!";
197 5cdf5adc 2022-05-08 op sub cmd_cat {
198 5cdf5adc 2022-05-08 op GetOptions('h|?' => \&usage) or usage;
199 5cdf5adc 2022-05-08 op usage unless @ARGV;
201 5cdf5adc 2022-05-08 op while (@ARGV) {
202 5cdf5adc 2022-05-08 op my $file = name2file(shift @ARGV);
203 5cdf5adc 2022-05-08 op system ($gpg, @gpg_flags, '-d', $file);
204 5cdf5adc 2022-05-08 op die "failed to exec $gpg: $!" if $? == -1;
208 5cdf5adc 2022-05-08 op sub cmd_find {
209 5cdf5adc 2022-05-08 op GetOptions('h|?' => \&usage) or usage;
210 5cdf5adc 2022-05-08 op usage if @ARGV gt 1;
212 5cdf5adc 2022-05-08 op map { say $_ } passfind(shift @ARGV);
215 5cdf5adc 2022-05-08 op sub cmd_gen {
216 5cdf5adc 2022-05-08 op my $chars = $default_chars;
217 5cdf5adc 2022-05-08 op my $length = $default_length;
222 5cdf5adc 2022-05-08 op 'c=s' => sub { $chars = $_[1] },
223 5cdf5adc 2022-05-08 op 'h|?' => \&usage,
224 5cdf5adc 2022-05-08 op 'l=i' => sub { $length = $_[1] },
225 9d75d6d8 2022-06-29 op 'n' => \$nop,
228 5cdf5adc 2022-05-08 op usage if @ARGV ne 1;
230 5cdf5adc 2022-05-08 op my $name = shift @ARGV;
231 5cdf5adc 2022-05-08 op my $file = name2file $name;
232 5cdf5adc 2022-05-08 op die "password already exists: $file\n" if -e $file;
234 5cdf5adc 2022-05-08 op my $pass = gen($chars, $length);
236 9d75d6d8 2022-06-29 op unless ($nop) {
237 9d75d6d8 2022-06-29 op writepass($file, $pass);
238 9d75d6d8 2022-06-29 op got_add $file;
239 9d75d6d8 2022-06-29 op got_ci "+$name";
241 9d75d6d8 2022-06-29 op say $pass unless $q;
244 5cdf5adc 2022-05-08 op sub cmd_got {
245 5cdf5adc 2022-05-08 op chdir $store;
246 5cdf5adc 2022-05-08 op exec $got, @ARGV;
249 5cdf5adc 2022-05-08 op # TODO: handle moving directories?
251 5cdf5adc 2022-05-08 op GetOptions('h|?' => \&usage) or usage;
252 5cdf5adc 2022-05-08 op usage if @ARGV ne 2;
254 5cdf5adc 2022-05-08 op my $a = shift @ARGV;
255 5cdf5adc 2022-05-08 op my $b = shift @ARGV;
257 5cdf5adc 2022-05-08 op my $pa = name2file $a;
258 5cdf5adc 2022-05-08 op my $pb = name2file $b;
260 5cdf5adc 2022-05-08 op die "source password doesn't exist" unless -f $pa;
261 5cdf5adc 2022-05-08 op die "target password exists" if -f $pb;
263 5cdf5adc 2022-05-08 op rename $pa, $pb or die "can't rename $a to $b: $!";
267 5cdf5adc 2022-05-08 op got_ci "mv $a $b";
270 5cdf5adc 2022-05-08 op sub cmd_regen {
271 5cdf5adc 2022-05-08 op my $chars = $default_chars;
272 5cdf5adc 2022-05-08 op my $length = $default_length;
275 5cdf5adc 2022-05-08 op 'c=s' => sub { $chars = $_[1] },
276 5cdf5adc 2022-05-08 op 'h|?' => \&usage,
277 5cdf5adc 2022-05-08 op 'l=i' => sub { $length = $_[1] },
279 5cdf5adc 2022-05-08 op usage if @ARGV ne 1;
281 5cdf5adc 2022-05-08 op my $name = shift @ARGV;
282 5cdf5adc 2022-05-08 op my $file = name2file $name;
283 5cdf5adc 2022-05-08 op die "password doesn't exist" unless -f $file;
285 5cdf5adc 2022-05-08 op my $pass = gen($chars, $length);
286 5cdf5adc 2022-05-08 op writepass($file, $pass);
288 5cdf5adc 2022-05-08 op got_add $file;
289 5cdf5adc 2022-05-08 op got_ci "regen $name";
293 5cdf5adc 2022-05-08 op GetOptions('h|?' => \&usage) or usage;
294 5cdf5adc 2022-05-08 op usage if @ARGV ne 1;
296 5cdf5adc 2022-05-08 op my $name = shift @ARGV;
297 5cdf5adc 2022-05-08 op my $file = name2file $name;
299 5cdf5adc 2022-05-08 op got_rm $file;
300 5cdf5adc 2022-05-08 op got_ci "-$name";
303 afdbc7b0 2022-06-29 op sub cmd_tee {
306 afdbc7b0 2022-06-29 op 'h|?' => \&usage,
309 5cdf5adc 2022-05-08 op usage if @ARGV ne 1;
311 5cdf5adc 2022-05-08 op my $name = shift @ARGV;
312 5cdf5adc 2022-05-08 op my $file = name2file $name;
314 d69b7902 2022-05-15 op my $pass = readpass "Enter the password: ";
315 d69b7902 2022-05-15 op writepass($file, $pass);
316 afdbc7b0 2022-06-29 op say $pass unless $q;
318 5cdf5adc 2022-05-08 op got_add $file;
319 afdbc7b0 2022-06-29 op got_ci (-f $file ? "update $name" : "+$name");
322 afdbc7b0 2022-06-29 op sub cmd_tog {
323 afdbc7b0 2022-06-29 op chdir $store;
324 afdbc7b0 2022-06-29 op exec $tog, @ARGV;
331 5cdf5adc 2022-05-08 op B<plass> - manage passwords
333 5cdf5adc 2022-05-08 op =head1 SYNOPSIS
335 5cdf5adc 2022-05-08 op B<plass> I<command> [-h] [arg ...]
337 9d75d6d8 2022-06-29 op Valid subcommands are: cat, find, gen, got, mv, regen, rm, tee, tog.
339 5cdf5adc 2022-05-08 op =head1 DESCRIPTION
341 5cdf5adc 2022-05-08 op B<plass> is a simple password manager. It manages passwords stored in
342 5cdf5adc 2022-05-08 op a directory tree rooted at I<~/.password-store> (or I<$PLASS_STORE>),
343 5cdf5adc 2022-05-08 op where every password is a single file encrypted with gpg2(1).
345 5cdf5adc 2022-05-08 op Passwords entries can be referenced using the path relative to the
346 5cdf5adc 2022-05-08 op store directory. The extension ".gpg" is optional.
348 5cdf5adc 2022-05-08 op The whole store is supposed to be managed by the got(1) version
349 5cdf5adc 2022-05-08 op control system.
351 5cdf5adc 2022-05-08 op The commands for B<plass> are as follows:
355 5cdf5adc 2022-05-08 op =item B<cat> I<entries ...>
357 5cdf5adc 2022-05-08 op Decrypt and print the passwords of the given I<entries>.
359 5cdf5adc 2022-05-08 op =item B<find> [I<pattern>]
361 5cdf5adc 2022-05-08 op Print one per line all the entries of the store, optionally filtered
362 5cdf5adc 2022-05-08 op by the given I<pattern>.
364 9d75d6d8 2022-06-29 op =item B<gen> [B<-nq>] [B<-c> I<chars>] [B<-l> I<length>] I<entry>
366 5cdf5adc 2022-05-08 op Generate and persist a password for the given I<entry> in the store.
367 5cdf5adc 2022-05-08 op B<-c> can be used to control the characters allowed in the password
368 5bbf948d 2022-05-15 op (by default I<!-~> i.e. all the printable ASCII character) and B<-l>
369 5bbf948d 2022-05-15 op the length (32 by default.)
371 9d75d6d8 2022-06-29 op Unless B<-q> is provided, plass prints the generated password.
373 9d75d6d8 2022-06-29 op If the B<-n> option is given, plass won't persist the password.
375 5cdf5adc 2022-05-08 op =item B<got> I<arguments ...>
377 5cdf5adc 2022-05-08 op Execute got(1) in the password store directory with the given
378 5cdf5adc 2022-05-08 op I<arguments>.
380 5cdf5adc 2022-05-08 op =item B<mv> I<from> I<to>
382 5cdf5adc 2022-05-08 op Rename a password entry, doesn't work with directories. I<from> must
383 5cdf5adc 2022-05-08 op exist and I<to> mustn't.
385 5cdf5adc 2022-05-08 op =item B<regen> [B<-c> I<chars>] [B<-l> I<length>] I<entry>
387 5cdf5adc 2022-05-08 op Like B<gen> but re-generates a password in-place.
389 5cdf5adc 2022-05-08 op =item B<rm> I<entry>
391 5cdf5adc 2022-05-08 op Remove the password I<entry> from the store.
393 afdbc7b0 2022-06-29 op =item B<tee> [B<-q>] I<entry>
395 afdbc7b0 2022-06-29 op Prompt for a password, persist it in the store under the given
396 afdbc7b0 2022-06-29 op I<entry> name and then print it again to standard output.
398 5cdf5adc 2022-05-08 op =item B<tog> I<arguments ...>
400 5cdf5adc 2022-05-08 op Execute tog(1) in the password store directory with the given
401 5cdf5adc 2022-05-08 op I<arguments>.
405 5cdf5adc 2022-05-08 op =head1 CREATING A PASSWORD STORE
407 5cdf5adc 2022-05-08 op A password store is just a normal got(1) repository with a worktree
408 5cdf5adc 2022-05-08 op checked out in I<~/.password-store> (or I<$PLASS_STORE>). The only
409 5cdf5adc 2022-05-08 op restriction is that a file called I<.gpg-id> must exist in the root of
410 5cdf5adc 2022-05-08 op the work tree for most B<plass> commands to work.
412 5cdf5adc 2022-05-08 op For example, a got repository and password store can be created as
415 5cdf5adc 2022-05-08 op $ mkdir .password-store
416 5cdf5adc 2022-05-08 op $ cd .password-store
417 5cdf5adc 2022-05-08 op $ echo foo@example.com > .gpg-id
419 5cdf5adc 2022-05-08 op $ got init pass.git
420 5cdf5adc 2022-05-08 op $ cd pass.git
421 5cdf5adc 2022-05-08 op $ got import -m 'initial import' ~/.password-store
422 5cdf5adc 2022-05-08 op $ cd ~/.password-store
423 5cdf5adc 2022-05-08 op $ got checkout -E ~/git/pass.git
425 5cdf5adc 2022-05-08 op See got(1) for more information.
427 5cdf5adc 2022-05-08 op Otherwise, if a repository already exists, a password-store can be
428 5cdf5adc 2022-05-08 op checked out more simply as:
430 5cdf5adc 2022-05-08 op $ got checkout ~/git/pass.git ~/.password-store
432 5cdf5adc 2022-05-08 op To migrate from pass(1), just delete I<~/.password-store> and checkout
433 5cdf5adc 2022-05-08 op it again usign got(1).
435 9944b08b 2022-05-08 op =head1 ENVIRONMENT
439 9944b08b 2022-05-08 op =item PLASS_CHARS
441 9944b08b 2022-05-08 op Default range of characters to use to generate passwords.
443 9944b08b 2022-05-08 op =item PLASS_GOT
445 9944b08b 2022-05-08 op Path to the got(1) executable.
447 9944b08b 2022-05-08 op =item PLASS_GPG
449 9944b08b 2022-05-08 op Path to the gpg2(1) executable.
451 9944b08b 2022-05-08 op =item PLASS_LENGTH
453 9944b08b 2022-05-08 op Default length for the passwords generated.
455 9944b08b 2022-05-08 op =item PLASS_STORE
457 9944b08b 2022-05-08 op Path to the password-store directory tree. I<~/.password-store> by
460 9944b08b 2022-05-08 op =item PLASS_TOG
462 9944b08b 2022-05-08 op Path to the tog(1) executable.
470 9944b08b 2022-05-08 op =item I<~/.password-store>
472 9944b08b 2022-05-08 op Password store used by default.
474 9944b08b 2022-05-08 op =item I<~/.password-store/.gpg-id>
476 9944b08b 2022-05-08 op File containing the gpg recipient used to encrypt the passwords.
480 5cdf5adc 2022-05-08 op =head1 ACKNOWLEDGEMENTS
482 5cdf5adc 2022-05-08 op B<plass> was heavily influenced by pass(1) in the design, but it's a
483 5cdf5adc 2022-05-08 op complete different implementation with different tools involved.
485 5cdf5adc 2022-05-08 op =head1 AUTHORS
487 5cdf5adc 2022-05-08 op The B<plass> utility was written by Omar Polo <I<op@omarpolo.com>>.
489 5cdf5adc 2022-05-08 op =head1 CAVEATS
491 5cdf5adc 2022-05-08 op B<plass> B<find> output format isn't designed to handle files with
492 5cdf5adc 2022-05-08 op newlines in them. Use find(1) B<-print0> or similar if it's a
495 5cdf5adc 2022-05-08 op There isn't a B<init> sub-command, the store initialisation must be
496 5cdf5adc 2022-05-08 op performed manually.
