op public repos

Blame

Date:: Wed Jun 29 11:15:00 2022 UTC
Message:: remove the 'oneshot' command and augment 'gen' gen now has a -n option for no-op that avoids persisting the password and now prints the generated password by default. This comes in handy in various cases, for example now it's possible to: $ plass gen foobar | clip A foobar2.gpg Created commit c1d55a274bd28103271a7e4d0c4f83266fc14926 Like the 'tee' subcommand, add -q to suppress printing the password if desired.
Actions:: History | Blob | Raw File
  1 5cdf5adc 2022-05-08 op #!/usr/bin/env perl
  2 5cdf5adc 2022-05-08 op #
  3 5cdf5adc 2022-05-08 op # Copyright (c) 2022 Omar Polo <op@omarpolo.com>
  4 5cdf5adc 2022-05-08 op #
  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.
  8 5cdf5adc 2022-05-08 op #
  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.
 16 5cdf5adc 2022-05-08 op 
 17 5cdf5adc 2022-05-08 op use strict;
 18 5cdf5adc 2022-05-08 op use warnings;
 19 5cdf5adc 2022-05-08 op use v5.32;
 20 5cdf5adc 2022-05-08 op 
 21 5cdf5adc 2022-05-08 op use open ":std", ":encoding(UTF-8)";
 22 5cdf5adc 2022-05-08 op 
 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;
 27 5cdf5adc 2022-05-08 op 
 28 5cdf5adc 2022-05-08 op my $store = $ENV{'PLASS_STORE'} || $ENV{'HOME'}.'/.password-store';
 29 5cdf5adc 2022-05-08 op 
 30 5cdf5adc 2022-05-08 op my $got = $ENV{'PLASS_GOT'} || 'got';
 31 5cdf5adc 2022-05-08 op my $tog = $ENV{'PLASS_TOG'} || 'tog';
 32 5cdf5adc 2022-05-08 op 
 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);
 35 5cdf5adc 2022-05-08 op 
 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;
 40 5cdf5adc 2022-05-08 op }
 41 5cdf5adc 2022-05-08 op 
 42 5cdf5adc 2022-05-08 op GetOptions(
 43 5cdf5adc 2022-05-08 op 	"h|?" => sub { pod2usage(0) },
 44 5cdf5adc 2022-05-08 op     ) or pod2usage(1);
 45 5cdf5adc 2022-05-08 op 
 46 5cdf5adc 2022-05-08 op my $cmd = shift or pod2usage(1);
 47 5cdf5adc 2022-05-08 op 
 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 ..."],
 58 5cdf5adc 2022-05-08 op     );
 59 5cdf5adc 2022-05-08 op pod2usage(1) unless defined $subcmd{$cmd};
 60 5cdf5adc 2022-05-08 op my ($fn, $usage) = @{$subcmd{$cmd}};
 61 5cdf5adc 2022-05-08 op chdir $store;
 62 5cdf5adc 2022-05-08 op $fn->();
 63 5cdf5adc 2022-05-08 op exit 0;
 64 5cdf5adc 2022-05-08 op 
 65 5cdf5adc 2022-05-08 op 
 66 5cdf5adc 2022-05-08 op # utils
 67 5cdf5adc 2022-05-08 op 
 68 5cdf5adc 2022-05-08 op sub usage {
 69 5cdf5adc 2022-05-08 op 	my $prog = basename $0;
 70 5cdf5adc 2022-05-08 op 	say STDERR "Usage: $prog $cmd $usage";
 71 5cdf5adc 2022-05-08 op 	exit 1;
 72 5cdf5adc 2022-05-08 op }
 73 5cdf5adc 2022-05-08 op 
 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$,;
 77 5cdf5adc 2022-05-08 op 	return $f;
 78 5cdf5adc 2022-05-08 op }
 79 5cdf5adc 2022-05-08 op 
 80 5cdf5adc 2022-05-08 op # tr -cd -- $chars < /dev/random | dd bs=$len count=1 status=none
 81 5cdf5adc 2022-05-08 op sub gen {
 82 5cdf5adc 2022-05-08 op 	my ($chars, $length) = @_;
 83 5cdf5adc 2022-05-08 op 	my $pass = "";
 84 5cdf5adc 2022-05-08 op 
 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);
 93 5cdf5adc 2022-05-08 op 		$pass .= $t;
 94 5cdf5adc 2022-05-08 op 	}
 95 5cdf5adc 2022-05-08 op 	close($fh);
 96 5cdf5adc 2022-05-08 op 
 97 5cdf5adc 2022-05-08 op 	return substr($pass, 0, $length);
 98 5cdf5adc 2022-05-08 op }
 99 5cdf5adc 2022-05-08 op 
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);
105 5cdf5adc 2022-05-08 op 	chomp $pass;
106 5cdf5adc 2022-05-08 op 	return $pass;
107 1f89d66a 2022-06-29 op }
108 1f89d66a 2022-06-29 op 
109 1f89d66a 2022-06-29 op sub mkdirs {
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;
115 5cdf5adc 2022-05-08 op }
116 5cdf5adc 2022-05-08 op 
117 5cdf5adc 2022-05-08 op sub writepass {
118 5cdf5adc 2022-05-08 op 	my ($file, $pass) = @_;
119 1f89d66a 2022-06-29 op 
120 1f89d66a 2022-06-29 op 	mkdirs(dirname $file);
121 5cdf5adc 2022-05-08 op 
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";
126 5cdf5adc 2022-05-08 op 	close($fh);
127 5cdf5adc 2022-05-08 op }
128 5cdf5adc 2022-05-08 op 
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>;
133 5cdf5adc 2022-05-08 op 	chomp $r;
134 5cdf5adc 2022-05-08 op 	close($fh);
135 5cdf5adc 2022-05-08 op 	return $r;
136 5cdf5adc 2022-05-08 op }
137 5cdf5adc 2022-05-08 op 
138 5cdf5adc 2022-05-08 op sub passfind {
139 5cdf5adc 2022-05-08 op 	my $pattern = shift;
140 5cdf5adc 2022-05-08 op 	my @entries;
141 5cdf5adc 2022-05-08 op 
142 5cdf5adc 2022-05-08 op 	find({
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;
146 5cdf5adc 2022-05-08 op 				return;
147 5cdf5adc 2022-05-08 op 			}
148 5cdf5adc 2022-05-08 op 
149 5cdf5adc 2022-05-08 op 			return if defined($pattern) && ! m/$pattern/;
150 5cdf5adc 2022-05-08 op 			return unless -f && m,.gpg$,;
151 5cdf5adc 2022-05-08 op 
152 5cdf5adc 2022-05-08 op 			s,^$store/*,,;
153 5cdf5adc 2022-05-08 op 			s,.gpg$,,;
154 5cdf5adc 2022-05-08 op 			push @entries, $_;
155 5cdf5adc 2022-05-08 op 		},
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);
160 5cdf5adc 2022-05-08 op }
161 5cdf5adc 2022-05-08 op 
162 5cdf5adc 2022-05-08 op sub got {
163 87197963 2022-06-29 op 	# discard stdout
164 5cdf5adc 2022-05-08 op 	open my $fh, '-|', ($got, @_);
165 5cdf5adc 2022-05-08 op 	close($fh);
166 87197963 2022-06-29 op 	exit 1 if $?;
167 5cdf5adc 2022-05-08 op }
168 5cdf5adc 2022-05-08 op 
169 5cdf5adc 2022-05-08 op sub got_add {
170 87197963 2022-06-29 op 	got 'add', '-I', shift;
171 5cdf5adc 2022-05-08 op }
172 5cdf5adc 2022-05-08 op 
173 5cdf5adc 2022-05-08 op sub got_rm {
174 87197963 2022-06-29 op 	got 'remove', '-f', shift;
175 5cdf5adc 2022-05-08 op }
176 5cdf5adc 2022-05-08 op 
177 5cdf5adc 2022-05-08 op sub got_ci {
178 afdbc7b0 2022-06-29 op 	my $pid = fork;
179 afdbc7b0 2022-06-29 op 	die "failed to fork: $!" unless defined $pid;
180 afdbc7b0 2022-06-29 op 
181 afdbc7b0 2022-06-29 op 	if ($pid ne 0) {
182 afdbc7b0 2022-06-29 op 		wait;
183 afdbc7b0 2022-06-29 op 		die "failed to commit changes" if $?;
184 afdbc7b0 2022-06-29 op 		return;
185 afdbc7b0 2022-06-29 op 	}
186 afdbc7b0 2022-06-29 op 
187 afdbc7b0 2022-06-29 op 	open (STDOUT, ">&", \*STDERR)
188 afdbc7b0 2022-06-29 op 	    or die "can't redirect stdout to stderr";
189 afdbc7b0 2022-06-29 op 	exec ($got, 'commit', '-m', shift)
190 afdbc7b0 2022-06-29 op 	    or die "failed to exec $got: $!";
191 5cdf5adc 2022-05-08 op }
192 5cdf5adc 2022-05-08 op 
193 5cdf5adc 2022-05-08 op 
194 5cdf5adc 2022-05-08 op # cmds
195 5cdf5adc 2022-05-08 op 
196 5cdf5adc 2022-05-08 op sub cmd_cat {
197 5cdf5adc 2022-05-08 op 	GetOptions('h|?' => \&usage) or usage;
198 5cdf5adc 2022-05-08 op 	usage unless @ARGV;
199 5cdf5adc 2022-05-08 op 
200 5cdf5adc 2022-05-08 op 	while (@ARGV) {
201 5cdf5adc 2022-05-08 op 		my $file = name2file(shift @ARGV);
202 5cdf5adc 2022-05-08 op 		system ($gpg, @gpg_flags, '-d', $file);
203 5cdf5adc 2022-05-08 op 		die "failed to exec $gpg: $!" if $? == -1;
204 5cdf5adc 2022-05-08 op 	}
205 5cdf5adc 2022-05-08 op }
206 5cdf5adc 2022-05-08 op 
207 5cdf5adc 2022-05-08 op sub cmd_find {
208 5cdf5adc 2022-05-08 op 	GetOptions('h|?' => \&usage) or usage;
209 5cdf5adc 2022-05-08 op 	usage if @ARGV gt 1;
210 5cdf5adc 2022-05-08 op 
211 5cdf5adc 2022-05-08 op 	map { say $_ } passfind(shift @ARGV);
212 5cdf5adc 2022-05-08 op }
213 5cdf5adc 2022-05-08 op 
214 5cdf5adc 2022-05-08 op sub cmd_gen {
215 5cdf5adc 2022-05-08 op 	my $chars = $default_chars;
216 5cdf5adc 2022-05-08 op 	my $length = $default_length;
217 9d75d6d8 2022-06-29 op 	my $nop;
218 9d75d6d8 2022-06-29 op 	my $q;
219 5cdf5adc 2022-05-08 op 
220 5cdf5adc 2022-05-08 op 	GetOptions(
221 5cdf5adc 2022-05-08 op 		'c=s' => sub { $chars = $_[1] },
222 5cdf5adc 2022-05-08 op 		'h|?' => \&usage,
223 5cdf5adc 2022-05-08 op 		'l=i' => sub { $length = $_[1] },
224 9d75d6d8 2022-06-29 op 		'n'   => \$nop,
225 9d75d6d8 2022-06-29 op 		'q'   => \$q,
226 5cdf5adc 2022-05-08 op 	    ) or usage;
227 5cdf5adc 2022-05-08 op 	usage if @ARGV ne 1;
228 5cdf5adc 2022-05-08 op 
229 5cdf5adc 2022-05-08 op 	my $name = shift @ARGV;
230 5cdf5adc 2022-05-08 op 	my $file = name2file $name;
231 5cdf5adc 2022-05-08 op 	die "password already exists: $file\n" if -e $file;
232 5cdf5adc 2022-05-08 op 
233 5cdf5adc 2022-05-08 op 	my $pass = gen($chars, $length);
234 5cdf5adc 2022-05-08 op 
235 9d75d6d8 2022-06-29 op 	unless ($nop) {
236 9d75d6d8 2022-06-29 op 		writepass($file, $pass);
237 9d75d6d8 2022-06-29 op 		got_add $file;
238 9d75d6d8 2022-06-29 op 		got_ci "+$name";
239 9d75d6d8 2022-06-29 op 	}
240 9d75d6d8 2022-06-29 op 	say $pass unless $q;
241 5cdf5adc 2022-05-08 op }
242 5cdf5adc 2022-05-08 op 
243 5cdf5adc 2022-05-08 op sub cmd_got {
244 5cdf5adc 2022-05-08 op 	chdir $store;
245 5cdf5adc 2022-05-08 op 	exec $got, @ARGV;
246 5cdf5adc 2022-05-08 op }
247 5cdf5adc 2022-05-08 op 
248 5cdf5adc 2022-05-08 op # TODO: handle moving directories?
249 5cdf5adc 2022-05-08 op sub cmd_mv {
250 5cdf5adc 2022-05-08 op 	GetOptions('h|?' => \&usage) or usage;
251 5cdf5adc 2022-05-08 op 	usage if @ARGV ne 2;
252 5cdf5adc 2022-05-08 op 
253 5cdf5adc 2022-05-08 op 	my $a = shift @ARGV;
254 5cdf5adc 2022-05-08 op 	my $b = shift @ARGV;
255 5cdf5adc 2022-05-08 op 
256 5cdf5adc 2022-05-08 op 	my $pa = name2file $a;
257 5cdf5adc 2022-05-08 op 	my $pb = name2file $b;
258 5cdf5adc 2022-05-08 op 
259 5cdf5adc 2022-05-08 op 	die "source password doesn't exist" unless -f $pa;
260 5cdf5adc 2022-05-08 op 	die "target password exists" if -f $pb;
261 5cdf5adc 2022-05-08 op 
262 5cdf5adc 2022-05-08 op 	rename $pa, $pb or die "can't rename $a to $b: $!";
263 5cdf5adc 2022-05-08 op 
264 5cdf5adc 2022-05-08 op 	got_rm $pa;
265 5cdf5adc 2022-05-08 op 	got_add $pb;
266 5cdf5adc 2022-05-08 op 	got_ci "mv $a $b";
267 5cdf5adc 2022-05-08 op }
268 5cdf5adc 2022-05-08 op 
269 5cdf5adc 2022-05-08 op sub cmd_regen {
270 5cdf5adc 2022-05-08 op 	my $chars = $default_chars;
271 5cdf5adc 2022-05-08 op 	my $length = $default_length;
272 5cdf5adc 2022-05-08 op 
273 5cdf5adc 2022-05-08 op 	GetOptions(
274 5cdf5adc 2022-05-08 op 		'c=s' => sub { $chars = $_[1] },
275 5cdf5adc 2022-05-08 op 		'h|?' => \&usage,
276 5cdf5adc 2022-05-08 op 		'l=i' => sub { $length = $_[1] },
277 5cdf5adc 2022-05-08 op 	    ) or usage;
278 5cdf5adc 2022-05-08 op 	usage if @ARGV ne 1;
279 5cdf5adc 2022-05-08 op 
280 5cdf5adc 2022-05-08 op 	my $name = shift @ARGV;
281 5cdf5adc 2022-05-08 op 	my $file = name2file $name;
282 5cdf5adc 2022-05-08 op 	die "password doesn't exist" unless -f $file;
283 5cdf5adc 2022-05-08 op 
284 5cdf5adc 2022-05-08 op 	my $pass = gen($chars, $length);
285 5cdf5adc 2022-05-08 op 	writepass($file, $pass);
286 5cdf5adc 2022-05-08 op 
287 5cdf5adc 2022-05-08 op 	got_add $file;
288 5cdf5adc 2022-05-08 op 	got_ci "regen $name";
289 5cdf5adc 2022-05-08 op }
290 5cdf5adc 2022-05-08 op 
291 5cdf5adc 2022-05-08 op sub cmd_rm {
292 5cdf5adc 2022-05-08 op 	GetOptions('h|?' => \&usage) or usage;
293 5cdf5adc 2022-05-08 op 	usage if @ARGV ne 1;
294 5cdf5adc 2022-05-08 op 
295 5cdf5adc 2022-05-08 op 	my $name = shift @ARGV;
296 5cdf5adc 2022-05-08 op 	my $file = name2file $name;
297 5cdf5adc 2022-05-08 op 
298 5cdf5adc 2022-05-08 op 	got_rm $file;
299 5cdf5adc 2022-05-08 op 	got_ci "-$name";
300 5cdf5adc 2022-05-08 op }
301 5cdf5adc 2022-05-08 op 
302 afdbc7b0 2022-06-29 op sub cmd_tee {
303 afdbc7b0 2022-06-29 op 	my $q;
304 afdbc7b0 2022-06-29 op 	GetOptions(
305 afdbc7b0 2022-06-29 op 		'h|?' => \&usage,
306 afdbc7b0 2022-06-29 op 		'q'   => \$q,
307 afdbc7b0 2022-06-29 op 	    ) or usage;
308 5cdf5adc 2022-05-08 op 	usage if @ARGV ne 1;
309 5cdf5adc 2022-05-08 op 
310 5cdf5adc 2022-05-08 op 	my $name = shift @ARGV;
311 5cdf5adc 2022-05-08 op 	my $file = name2file $name;
312 5cdf5adc 2022-05-08 op 
313 d69b7902 2022-05-15 op 	my $pass = readpass "Enter the password: ";
314 d69b7902 2022-05-15 op 	writepass($file, $pass);
315 afdbc7b0 2022-06-29 op 	say $pass unless $q;
316 5cdf5adc 2022-05-08 op 
317 5cdf5adc 2022-05-08 op 	got_add $file;
318 afdbc7b0 2022-06-29 op 	got_ci (-f $file ? "update $name" : "+$name");
319 5cdf5adc 2022-05-08 op }
320 5cdf5adc 2022-05-08 op 
321 afdbc7b0 2022-06-29 op sub cmd_tog {
322 afdbc7b0 2022-06-29 op 	chdir $store;
323 afdbc7b0 2022-06-29 op 	exec $tog, @ARGV;
324 afdbc7b0 2022-06-29 op }
325 afdbc7b0 2022-06-29 op 
326 5cdf5adc 2022-05-08 op __END__
327 5cdf5adc 2022-05-08 op 
328 5cdf5adc 2022-05-08 op =head1 NAME
329 5cdf5adc 2022-05-08 op 
330 5cdf5adc 2022-05-08 op B<plass> - manage passwords
331 5cdf5adc 2022-05-08 op 
332 5cdf5adc 2022-05-08 op =head1 SYNOPSIS
333 5cdf5adc 2022-05-08 op 
334 5cdf5adc 2022-05-08 op B<plass> I<command> [-h] [arg ...]
335 5cdf5adc 2022-05-08 op 
336 9d75d6d8 2022-06-29 op Valid subcommands are: cat, find, gen, got, mv, regen, rm, tee, tog.
337 5cdf5adc 2022-05-08 op 
338 5cdf5adc 2022-05-08 op =head1 DESCRIPTION
339 5cdf5adc 2022-05-08 op 
340 5cdf5adc 2022-05-08 op B<plass> is a simple password manager.  It manages passwords stored in
341 5cdf5adc 2022-05-08 op a directory tree rooted at I<~/.password-store> (or I<$PLASS_STORE>),
342 5cdf5adc 2022-05-08 op where every password is a single file encrypted with gpg2(1).
343 5cdf5adc 2022-05-08 op 
344 5cdf5adc 2022-05-08 op Passwords entries can be referenced using the path relative to the
345 5cdf5adc 2022-05-08 op store directory.  The extension ".gpg" is optional.
346 5cdf5adc 2022-05-08 op 
347 5cdf5adc 2022-05-08 op The whole store is supposed to be managed by the got(1) version
348 5cdf5adc 2022-05-08 op control system.
349 5cdf5adc 2022-05-08 op 
350 5cdf5adc 2022-05-08 op The commands for B<plass> are as follows:
351 5cdf5adc 2022-05-08 op 
352 5cdf5adc 2022-05-08 op =over
353 5cdf5adc 2022-05-08 op 
354 5cdf5adc 2022-05-08 op =item B<cat> I<entries ...>
355 5cdf5adc 2022-05-08 op 
356 5cdf5adc 2022-05-08 op Decrypt and print the passwords of the given I<entries>.
357 5cdf5adc 2022-05-08 op 
358 5cdf5adc 2022-05-08 op =item B<find> [I<pattern>]
359 5cdf5adc 2022-05-08 op 
360 5cdf5adc 2022-05-08 op Print one per line all the entries of the store, optionally filtered
361 5cdf5adc 2022-05-08 op by the given I<pattern>.
362 5cdf5adc 2022-05-08 op 
363 9d75d6d8 2022-06-29 op =item B<gen> [B<-nq>] [B<-c> I<chars>] [B<-l> I<length>] I<entry>
364 5cdf5adc 2022-05-08 op 
365 5cdf5adc 2022-05-08 op Generate and persist a password for the given I<entry> in the store.
366 5cdf5adc 2022-05-08 op B<-c> can be used to control the characters allowed in the password
367 5bbf948d 2022-05-15 op (by default I<!-~> i.e. all the printable ASCII character) and B<-l>
368 5bbf948d 2022-05-15 op the length (32 by default.)
369 5cdf5adc 2022-05-08 op 
370 9d75d6d8 2022-06-29 op Unless B<-q> is provided, plass prints the generated password.
371 9d75d6d8 2022-06-29 op 
372 9d75d6d8 2022-06-29 op If the B<-n> option is given, plass won't persist the password.
373 9d75d6d8 2022-06-29 op 
374 5cdf5adc 2022-05-08 op =item B<got> I<arguments ...>
375 5cdf5adc 2022-05-08 op 
376 5cdf5adc 2022-05-08 op Execute got(1) in the password store directory with the given
377 5cdf5adc 2022-05-08 op I<arguments>.
378 5cdf5adc 2022-05-08 op 
379 5cdf5adc 2022-05-08 op =item B<mv> I<from> I<to>
380 5cdf5adc 2022-05-08 op 
381 5cdf5adc 2022-05-08 op Rename a password entry, doesn't work with directories.  I<from> must
382 5cdf5adc 2022-05-08 op exist and I<to> mustn't.
383 5cdf5adc 2022-05-08 op 
384 5cdf5adc 2022-05-08 op =item B<regen> [B<-c> I<chars>] [B<-l> I<length>] I<entry>
385 5cdf5adc 2022-05-08 op 
386 5cdf5adc 2022-05-08 op Like B<gen> but re-generates a password in-place.
387 5cdf5adc 2022-05-08 op 
388 5cdf5adc 2022-05-08 op =item B<rm> I<entry>
389 5cdf5adc 2022-05-08 op 
390 5cdf5adc 2022-05-08 op Remove the password I<entry> from the store.
391 5cdf5adc 2022-05-08 op 
392 afdbc7b0 2022-06-29 op =item B<tee> [B<-q>] I<entry>
393 afdbc7b0 2022-06-29 op 
394 afdbc7b0 2022-06-29 op Prompt for a password, persist it in the store under the given
395 afdbc7b0 2022-06-29 op I<entry> name and then print it again to standard output.
396 afdbc7b0 2022-06-29 op 
397 5cdf5adc 2022-05-08 op =item B<tog> I<arguments ...>
398 5cdf5adc 2022-05-08 op 
399 5cdf5adc 2022-05-08 op Execute tog(1) in the password store directory with the given
400 5cdf5adc 2022-05-08 op I<arguments>.
401 5cdf5adc 2022-05-08 op 
402 5cdf5adc 2022-05-08 op =back
403 5cdf5adc 2022-05-08 op 
404 5cdf5adc 2022-05-08 op =head1 CREATING A PASSWORD STORE
405 5cdf5adc 2022-05-08 op 
406 5cdf5adc 2022-05-08 op A password store is just a normal got(1) repository with a worktree
407 5cdf5adc 2022-05-08 op checked out in I<~/.password-store> (or I<$PLASS_STORE>).  The only
408 5cdf5adc 2022-05-08 op restriction is that a file called I<.gpg-id> must exist in the root of
409 5cdf5adc 2022-05-08 op the work tree for most B<plass> commands to work.
410 5cdf5adc 2022-05-08 op 
411 5cdf5adc 2022-05-08 op For example, a got repository and password store can be created as
412 5cdf5adc 2022-05-08 op follows:
413 5cdf5adc 2022-05-08 op 
414 5cdf5adc 2022-05-08 op 	$ mkdir .password-store
415 5cdf5adc 2022-05-08 op 	$ cd .password-store
416 5cdf5adc 2022-05-08 op 	$ echo foo@example.com > .gpg-id
417 5cdf5adc 2022-05-08 op 	$ cd ~/git
418 5cdf5adc 2022-05-08 op 	$ got init pass.git
419 5cdf5adc 2022-05-08 op 	$ cd pass.git
420 5cdf5adc 2022-05-08 op 	$ got import -m 'initial import' ~/.password-store
421 5cdf5adc 2022-05-08 op 	$ cd ~/.password-store
422 5cdf5adc 2022-05-08 op 	$ got checkout -E ~/git/pass.git
423 5cdf5adc 2022-05-08 op 
424 5cdf5adc 2022-05-08 op See got(1) for more information.
425 5cdf5adc 2022-05-08 op 
426 5cdf5adc 2022-05-08 op Otherwise, if a repository already exists, a password-store can be
427 5cdf5adc 2022-05-08 op checked out more simply as:
428 5cdf5adc 2022-05-08 op 
429 5cdf5adc 2022-05-08 op 	$ got checkout ~/git/pass.git ~/.password-store
430 5cdf5adc 2022-05-08 op 
431 5cdf5adc 2022-05-08 op To migrate from pass(1), just delete I<~/.password-store> and checkout
432 5cdf5adc 2022-05-08 op it again usign got(1).
433 9944b08b 2022-05-08 op 
434 9944b08b 2022-05-08 op =head1 ENVIRONMENT
435 9944b08b 2022-05-08 op 
436 9944b08b 2022-05-08 op =over
437 9944b08b 2022-05-08 op 
438 9944b08b 2022-05-08 op =item PLASS_CHARS
439 9944b08b 2022-05-08 op 
440 9944b08b 2022-05-08 op Default range of characters to use to generate passwords.
441 9944b08b 2022-05-08 op 
442 9944b08b 2022-05-08 op =item PLASS_GOT
443 9944b08b 2022-05-08 op 
444 9944b08b 2022-05-08 op Path to the got(1) executable.
445 5cdf5adc 2022-05-08 op 
446 9944b08b 2022-05-08 op =item PLASS_GPG
447 9944b08b 2022-05-08 op 
448 9944b08b 2022-05-08 op Path to the gpg2(1) executable.
449 9944b08b 2022-05-08 op 
450 9944b08b 2022-05-08 op =item PLASS_LENGTH
451 9944b08b 2022-05-08 op 
452 9944b08b 2022-05-08 op Default length for the passwords generated.
453 9944b08b 2022-05-08 op 
454 9944b08b 2022-05-08 op =item PLASS_STORE
455 9944b08b 2022-05-08 op 
456 9944b08b 2022-05-08 op Path to the password-store directory tree.  I<~/.password-store> by
457 9944b08b 2022-05-08 op default.
458 9944b08b 2022-05-08 op 
459 9944b08b 2022-05-08 op =item PLASS_TOG
460 9944b08b 2022-05-08 op 
461 9944b08b 2022-05-08 op Path to the tog(1) executable.
462 9944b08b 2022-05-08 op 
463 9944b08b 2022-05-08 op =back
464 9944b08b 2022-05-08 op 
465 9944b08b 2022-05-08 op =head1 FILES
466 9944b08b 2022-05-08 op 
467 9944b08b 2022-05-08 op =over
468 9944b08b 2022-05-08 op 
469 9944b08b 2022-05-08 op =item I<~/.password-store>
470 9944b08b 2022-05-08 op 
471 9944b08b 2022-05-08 op Password store used by default.
472 9944b08b 2022-05-08 op 
473 9944b08b 2022-05-08 op =item I<~/.password-store/.gpg-id>
474 9944b08b 2022-05-08 op 
475 9944b08b 2022-05-08 op File containing the gpg recipient used to encrypt the passwords.
476 9944b08b 2022-05-08 op 
477 9944b08b 2022-05-08 op =back
478 9944b08b 2022-05-08 op 
479 5cdf5adc 2022-05-08 op =head1 ACKNOWLEDGEMENTS
480 5cdf5adc 2022-05-08 op 
481 5cdf5adc 2022-05-08 op B<plass> was heavily influenced by pass(1) in the design, but it's a
482 5cdf5adc 2022-05-08 op complete different implementation with different tools involved.
483 5cdf5adc 2022-05-08 op 
484 5cdf5adc 2022-05-08 op =head1 AUTHORS
485 5cdf5adc 2022-05-08 op 
486 5cdf5adc 2022-05-08 op The B<plass> utility was written by Omar Polo <I<op@omarpolo.com>>.
487 5cdf5adc 2022-05-08 op 
488 5cdf5adc 2022-05-08 op =head1 CAVEATS
489 5cdf5adc 2022-05-08 op 
490 5cdf5adc 2022-05-08 op B<plass> B<find> output format isn't designed to handle files with
491 5cdf5adc 2022-05-08 op newlines in them.  Use find(1) B<-print0> or similar if it's a
492 5cdf5adc 2022-05-08 op concern.
493 5cdf5adc 2022-05-08 op 
494 5cdf5adc 2022-05-08 op There isn't a B<init> sub-command, the store initialisation must be
495 5cdf5adc 2022-05-08 op performed manually.
496 5cdf5adc 2022-05-08 op 
497 5cdf5adc 2022-05-08 op =cut