3 # password store management tool
5 # Copyright (c) 2008 Peter Palfrader <peter@palfrader.org>
7 # Permission is hereby granted, free of charge, to any person obtaining
8 # a copy of this software and associated documentation files (the
9 # "Software"), to deal in the Software without restriction, including
10 # without limitation the rights to use, copy, modify, merge, publish,
11 # distribute, sublicense, and/or sell copies of the Software, and to
12 # permit persons to whom the Software is furnished to do so, subject to
13 # the following conditions:
15 # The above copyright notice and this permission notice shall be
16 # included in all copies or substantial portions of the Software.
18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 Thread.abort_on_exception = true
33 GNUPG = "/usr/bin/gpg"
35 $program_name = File.basename($0, '.*')
37 $editor = ENV['EDITOR']
39 %w{/usr/bin/sensible-editor /usr/bin/editor /usr/bin/vi}.each do |editor|
40 if FileTest.executable?(editor)
50 @@keyid_fpr_mapping = {}
52 def GnuPG.readwrite3(intxt, infd, stdoutfd, stderrfd, statusfd)
53 outtxt, stderrtxt, statustxt = ''
54 thread_in = Thread.new {
58 thread_out = Thread.new {
59 outtxt = stdoutfd.read
62 thread_err = Thread.new {
63 errtxt = stderrfd.read
66 thread_status = Thread.new {
67 statustxt = statusfd.read
74 thread_status.join if thread_status
76 return outtxt, stderrtxt, statustxt
79 def GnuPG.gpgcall(intxt, args, require_success = false)
83 statR, statW = IO.pipe
93 exec(GNUPG, "--status-fd=#{statW.fileno}", *args)
94 raise ("Calling gnupg failed")
100 (outtxt, stderrtxt, statustxt) = readwrite3(intxt, inW, outR, errR, statR);
101 wpid, status = Process.waitpid2 pid
102 throw "Unexpected pid: #{pid} vs #{wpid}" unless pid == wpid
103 throw "Process has not exited!?" unless status.exited?
104 throw "gpg call did not exit sucessfully" if (require_success and status.exitstatus != 0)
105 return outtxt, stderrtxt, statustxt, status.exitstatus
108 def GnuPG.init_keys()
110 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall('', %w{--fast-list-mode --with-colons --with-fingerprint --list-secret-keys}, true)
113 outtxt.split("\n").each do |line|
114 parts = line.split(':')
115 if (parts[0] == "ssb" or parts[0] == "sec")
116 @@my_keys.push parts[4]
117 elsif (parts[0] == "fpr")
118 @@my_fprs.push parts[9]
122 # This is for my private keys, so we can tell if a file is encrypted to us
123 def GnuPG.get_my_keys()
127 # And this is for my private keys also, so we can tell if we are encrypting to ourselves
128 def GnuPG.get_my_fprs()
133 # This maps public keyids to fingerprints, so we can figure
134 # out if a file that is encrypted to a bunch of keys is
135 # encrypted to the fingerprints it should be encrypted to
136 def GnuPG.get_fpr_from_keyid(keyid)
137 fpr = @@keyid_fpr_mapping[keyid]
138 # this can be null, if we tried to find the fpr but failed to find the key in our keyring
140 STDERR.puts "Warning: No key found for keyid #{keyid}"
144 def GnuPG.get_fprs_from_keyids(keyids)
145 learn_fingerprints_from_keyids(keyids)
146 return keyids.collect{ |k| get_fpr_from_keyid(k) }
149 # this is to load the keys we will soon be asking about into
150 # our keyid-fpr-mapping hash
151 def GnuPG.learn_fingerprints_from_keyids(keyids)
152 need_to_learn = keyids.reject{ |k| @@keyid_fpr_mapping.has_key?(k) }
153 if need_to_learn.size > 0
154 args = %w{--fast-list-mode --with-colons --with-fingerprint --list-keys}
155 args.concat need_to_learn
156 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall('', args, true)
160 outtxt.split("\n").each do |line|
161 parts = line.split(':')
162 if (parts[0] == "pub")
164 elsif (parts[0] == "fpr")
166 @@keyid_fpr_mapping[pub] = fpr
167 elsif (parts[0] == "sub")
168 @@keyid_fpr_mapping[parts[4]] = fpr
172 need_to_learn.reject{ |k| @@keyid_fpr_mapping.has_key?(k) }.each { |k| @@keyid_fpr_mapping[k] = nil }
176 def read_input(query, default_yes=true)
184 print "#{query} #{append} "
185 i = STDIN.readline.chomp.downcase
204 f = File.open(ENV['HOME']+'/.pws-trusted-users')
205 rescue Exception => e
211 f.readlines.each do |line|
219 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(content, %w{}, true)
222 statustxt.split("\n").each do |line|
223 if m = /^\[GNUPG:\] GOODSIG/.match(line)
225 elsif m = /^\[GNUPG:\] VALIDSIG \S+ \S+ \S+ \S+ \S+ \S+ \S+ \S+ \S+ ([0-9A-F]+)/.match(line)
231 STDERR.puts ".users file is not signed properly"
235 if not trusted.include?(validsig)
236 STDERR.puts ".users file is signed by #{validsig} which is not in ~/.pws-trusted-users"
245 f = File.open('.users')
246 rescue Exception => e
254 users = verify(users)
260 users.split("\n").each do |line|
264 if (m = /^([a-zA-Z0-9-]+)\s*=\s*([0-9A-Fa-f]{40})\s*$/.match line)
267 if @users.has_key?(user)
268 STDERR.puts "User #{user} redefined at line #{lno}!"
272 elsif (m = /^(@[a-zA-Z0-9-]+)\s*=\s*(.*)$/.match line)
275 if @groups.has_key?(group)
276 STDERR.puts "Group #{group} redefined at line #{lno}!"
279 members = members.split(/[\t ,]+/)
280 @groups[group] = { "members" => members }
286 return (name =~ /^@/)
288 def check_exists(x, whence, fatal=true)
291 ok=false unless (@groups.has_key?(x))
293 ok=false unless @users.has_key?(x)
296 STDERR.puts( (fatal ? "Error: " : "Warning: ") + "#{whence} contains unknown member #{x}")
302 @groups.each_pair do |groupname, group|
303 group['members'].each do |member|
304 check_exists(member, "Group #{groupname}")
306 group['members_to_do'] = group['members'].clone
312 @groups.each_pair do |groupname, group|
313 group['keys'] = [] unless group['keys']
315 still_contains_groups = false
316 group['members_to_do'].each do |member|
318 if @groups[member]['members_to_do'].size == 0
319 group['keys'].concat @groups[member]['keys']
320 group['members_to_do'].delete(member)
323 still_contains_groups = true
326 group['keys'].push @users[member]
327 group['members_to_do'].delete(member)
331 all_expanded = false if still_contains_groups
333 break if all_expanded
335 cyclic_groups = @groups.keys.reject{|name| @groups[name]['members_to_do'].size == 0}.join(", ")
336 STDERR.puts "Cyclic group memberships in #{cyclic_groups}?"
342 def expand_targets(targets)
346 unless check_exists(t, "access line", false)
351 fprs.concat @groups[t]['keys']
361 attr_reader :accessible, :encrypted, :readable, :readers
363 def EncryptedFile.determine_readable(readers)
364 GnuPG.get_my_keys.each do |keyid|
365 return true if readers.include?(keyid)
370 def EncryptedFile.list_readers(statustxt)
372 statustxt.split("\n").each do |line|
373 m = /^\[GNUPG:\] ENC_TO ([0-9A-F]+)/.match line
380 def EncryptedFile.targets(text)
381 metaline = text.split("\n").first
382 m = /^access: (.*)/.match metaline
384 return m[1].strip.split(/[\t ,]+/)
388 def initialize(filename, new=false)
389 @groupconfig = GroupConfig.new
396 unless FileTest.readable?(filename)
401 @encrypted_content = File.read(filename)
402 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall(@encrypted_content, %w{--with-colons --no-default-keyring --secret-keyring=/dev/null --keyring=/dev/null})
403 @encrypted = !(statustxt =~ /\[GNUPG:\] NODATA/)
405 @readers = EncryptedFile.list_readers(statustxt)
406 @readable = EncryptedFile.determine_readable(@readers)
411 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(@encrypted_content, %w{--decrypt})
412 if !@new and exitstatus != 0
413 proceed = read_input("Warning: gpg returned non-zero exit status #{exitstatus} when decrypting #{@filename}. Proceed?", false)
414 exit(0) unless proceed
415 elsif !@new and outtxt.length == 0
416 proceed = read_input("Warning: #{@filename} decrypted to an empty file. Proceed?")
417 exit(0) unless proceed
423 def encrypt(content, recipients)
424 args = recipients.collect{ |r| "--recipient=#{r}"}
425 args.push "--trust-model=always"
426 args.push "--encrypt"
427 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(content, args)
430 statustxt.split("\n").each do |line|
431 m = /^\[GNUPG:\] INV_RECP \S+ ([0-9A-F]+)/.match line
436 again = read_input("Warning: the following recipients are invalid: #{invalid.join(", ")}. Try again (or proceed)?")
437 return false if again
439 if outtxt.length == 0
440 tryagain = read_input("Error: #{@filename} encrypted to an empty file. Edit again (or exit)?")
441 return false if tryagain
445 proceed = read_input("Warning: gpg returned non-zero exit status #{exitstatus} when encrypting #{@filename}. Said:\n#{stderrtxt}\n#{statustxt}\n\nProceed (or try again)?")
446 return false unless proceed
453 def determine_encryption_targets(content)
454 targets = EncryptedFile.targets(content)
456 tryagain = read_input("Warning: Did not find targets to encrypt to in header. Try again (or exit)?", true)
457 return false if tryagain
461 ok, expanded = @groupconfig.expand_targets(targets)
462 if (expanded.size == 0)
463 tryagain = read_input("Errors in access header. Edit again (or exit)?", true)
464 return false if tryagain
467 tryagain = read_input("Warnings in access header. Edit again (or continue)?", true)
468 return false if tryagain
472 GnuPG.get_my_fprs.each do |fpr|
473 if expanded.include?(fpr)
479 tryagain = read_input("File is not being encrypted to you. Edit again (or continue)?", true)
480 return false if tryagain
483 return true, expanded
486 def write_back(content, targets)
487 ok, encrypted = encrypt(content, targets)
488 return false unless ok
490 File.open(@filename,"w").write(encrypted)
496 def help(parser, code=0, io=STDOUT)
497 io.puts "Usage: #{$program_name} ls [<directory> ...]"
498 io.puts parser.summarize
499 io.puts "Lists the contents of the given directory/directories, or the current"
500 io.puts "directory if none is given. For each file show whether it is PGP-encrypted"
501 io.puts "file, and if yes whether we can read it."
507 dir = Dir.open(dirname)
508 rescue Exception => e
513 Dir.chdir(dirname) do
514 unless FileTest.exists?(".users")
515 STDERR.puts "The .users file does not exists here. This is not a password store, is it?"
518 dir.sort.each do |filename|
519 next if (filename =~ /^\./) and not (@all >= 3)
520 stat = File::Stat.new(filename)
522 puts "(sym) #{filename}" if (@all >= 2)
523 elsif stat.directory?
524 puts "(dir) #{filename}" if (@all >= 2)
526 puts "(other) #{filename}" if (@all >= 2)
528 f = EncryptedFile.new(filename)
530 puts "(!perm) #{filename}"
532 puts "(file) #{filename}" if (@all >= 2)
534 puts "(ok) #{filename}"
536 puts "(locked) #{filename}" if (@all >= 1)
545 ARGV.options do |opts|
546 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
547 opts.on_tail("-a", "--all" , "Show all files (use up to 3 times to show even more than all)") { @all = @all+1 }
552 dirs.push('.') unless dirs.size > 0
553 dirs.each { |dir| ls_dir(dir) }
558 def help(parser, code=0, io=STDOUT)
559 io.puts "Usage: #{$program_name} ed <filename>"
560 io.puts parser.summarize
561 io.puts "Decrypts the file, spawns an editor, and encrypts it again"
566 encrypted_file = EncryptedFile.new(filename, @new)
567 if !@new and !encrypted_file.readable && !@force
568 STDERR.puts "#{filename} is probably not readable"
572 encrypted_to = GnuPG.get_fprs_from_keyids(encrypted_file.readers).sort
574 content = encrypted_file.decrypt
575 original_content = content
577 oldsize = content.length
578 tempfile = Tempfile.open('pws')
579 tempfile.puts content
581 system($editor, tempfile.path)
583 throw "Process has not exited!?" unless status.exited?
584 unless status.exitstatus == 0
585 proceed = read_input("Warning: Editor did not exit successfully (exit code #{status.exitstatus}. Proceed?")
586 exit(0) unless proceed
588 tempfile.seek(0, IO::SEEK_SET)
589 content = tempfile.read
592 newsize = content.length
593 tempfile.seek(0, IO::SEEK_SET)
594 clearsize = (newsize > oldsize) ? newsize : oldsize
595 tempfile.print "\0"*clearsize
599 if content.length == 0
600 proceed = read_input("Warning: Content is now empty. Proceed?")
601 exit(0) unless proceed
604 ok, targets = encrypted_file.determine_encryption_targets(content)
607 if (original_content == content)
608 if (targets.sort == encrypted_to)
609 proceed = read_input("Nothing changed. Re-encrypt anyway?", false)
610 exit(0) unless proceed
612 STDERR.puts("Info: Content not changed but re-encrypting anyway because the list of keys changed")
616 success = encrypted_file.write_back(content, targets)
622 ARGV.options do |opts|
623 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
624 opts.on_tail("-n", "--new" , "Edit new file") { |@new| }
625 opts.on_tail("-f", "--force" , "Spawn an editor even if the file is probably not readable") { |@force| }
628 help(ARGV.options, 1, STDERR) if ARGV.length != 1
629 filename = ARGV.shift
632 if FileTest.exists?(filename)
633 STDERR.puts "#{filename} does exist"
637 if !FileTest.exists?(filename)
638 STDERR.puts "#{filename} does not exist"
640 elsif !FileTest.file?(filename)
641 STDERR.puts "#{filename} is not a regular file"
643 elsif !FileTest.readable?(filename)
644 STDERR.puts "#{filename} is not accessible (unix perms)"
649 dirname = File.dirname(filename)
650 basename = File.basename(filename)
658 def help(code=0, io=STDOUT)
659 io.puts "Usage: #{$program_name} ed"
660 io.puts " #{$program_name} ls"
661 io.puts " #{$program_name} help"
662 io.puts "Call #{$program_name} <command> --help for additional options/parameters"
686 # vim:set shiftwidth=2: