3 # password store management tool
5 # Copyright (c) 2008, 2009 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
94 exec(GNUPG, "--status-fd=#{statW.fileno}", *args)
96 outW.puts("[PWSEXECERROR]: #{e}")
99 raise ("Calling gnupg failed")
105 (outtxt, stderrtxt, statustxt) = readwrite3(intxt, inW, outR, errR, statR);
106 wpid, status = Process.waitpid2 pid
107 throw "Unexpected pid: #{pid} vs #{wpid}" unless pid == wpid
108 throw "Process has not exited!?" unless status.exited?
109 throw "gpg call did not exit sucessfully" if (require_success and status.exitstatus != 0)
110 if m=/^\[PWSEXECERROR\]: (.*)/.match(outtxt) then
111 STDERR.puts "Could not run GnuPG: #{m[1]}"
114 return outtxt, stderrtxt, statustxt, status.exitstatus
117 def GnuPG.init_keys()
119 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall('', %w{--fast-list-mode --with-colons --with-fingerprint --list-secret-keys}, true)
122 outtxt.split("\n").each do |line|
123 parts = line.split(':')
124 if (parts[0] == "ssb" or parts[0] == "sec")
125 @@my_keys.push parts[4]
126 elsif (parts[0] == "fpr")
127 @@my_fprs.push parts[9]
131 # This is for my private keys, so we can tell if a file is encrypted to us
132 def GnuPG.get_my_keys()
136 # And this is for my private keys also, so we can tell if we are encrypting to ourselves
137 def GnuPG.get_my_fprs()
142 # This maps public keyids to fingerprints, so we can figure
143 # out if a file that is encrypted to a bunch of keys is
144 # encrypted to the fingerprints it should be encrypted to
145 def GnuPG.get_fpr_from_keyid(keyid)
146 fpr = @@keyid_fpr_mapping[keyid]
147 # this can be null, if we tried to find the fpr but failed to find the key in our keyring
149 STDERR.puts "Warning: No key found for keyid #{keyid}"
153 def GnuPG.get_fprs_from_keyids(keyids)
154 learn_fingerprints_from_keyids(keyids)
155 return keyids.collect{ |k| get_fpr_from_keyid(k) or "unknown" }
158 # this is to load the keys we will soon be asking about into
159 # our keyid-fpr-mapping hash
160 def GnuPG.learn_fingerprints_from_keyids(keyids)
161 need_to_learn = keyids.reject{ |k| @@keyid_fpr_mapping.has_key?(k) }
162 if need_to_learn.size > 0
163 # we can't use --fast-list-mode here because GnuPG is broken
164 # and does not show elmo's fingerprint in a call like
165 # gpg --with-colons --fast-list-mode --with-fingerprint --list-key D7C3F131AB2A91F5
166 args = %w{--with-colons --with-fingerprint --list-keys}
167 args.concat need_to_learn
168 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall('', args, true)
172 outtxt.split("\n").each do |line|
173 parts = line.split(':')
174 if (parts[0] == "pub")
176 elsif (parts[0] == "fpr")
178 @@keyid_fpr_mapping[pub] = fpr
179 elsif (parts[0] == "sub")
180 @@keyid_fpr_mapping[parts[4]] = fpr
184 need_to_learn.reject{ |k| @@keyid_fpr_mapping.has_key?(k) }.each { |k| @@keyid_fpr_mapping[k] = nil }
188 def read_input(query, default_yes=true)
196 print "#{query} #{append} "
198 i = STDIN.readline.chomp.downcase
220 f = File.open(ENV['HOME']+'/.pws-trusted-users')
221 rescue Exception => e
227 f.readlines.each do |line|
235 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(content, %w{})
238 statustxt.split("\n").each do |line|
239 if m = /^\[GNUPG:\] GOODSIG/.match(line)
241 elsif m = /^\[GNUPG:\] VALIDSIG \S+ \S+ \S+ \S+ \S+ \S+ \S+ \S+ \S+ ([0-9A-F]+)/.match(line)
247 STDERR.puts ".users file is not signed properly. GnuPG said on stdout:"
249 STDERR.puts "and on stderr:"
250 STDERR.puts stderrtxt
251 STDERR.puts "and via statusfd:"
252 STDERR.puts statustxt
256 if not trusted.include?(validsig)
257 STDERR.puts ".users file is signed by #{validsig} which is not in ~/.pws-trusted-users"
262 STDERR.puts "gpg verify failed for .users file"
271 f = File.open('.users')
272 rescue Exception => e
280 users = verify(users)
286 users.split("\n").each do |line|
290 if (m = /^([a-zA-Z0-9-]+)\s*=\s*([0-9A-Fa-f]{40})\s*$/.match line)
293 if @users.has_key?(user)
294 STDERR.puts "User #{user} redefined at line #{lno}!"
298 elsif (m = /^(@[a-zA-Z0-9-]+)\s*=\s*(.*)$/.match line)
301 if @groups.has_key?(group)
302 STDERR.puts "Group #{group} redefined at line #{lno}!"
305 members = members.split(/[\t ,]+/)
306 @groups[group] = { "members" => members }
312 return (name =~ /^@/)
314 def check_exists(x, whence, fatal=true)
317 ok=false unless (@groups.has_key?(x))
319 ok=false unless @users.has_key?(x)
322 STDERR.puts( (fatal ? "Error: " : "Warning: ") + "#{whence} contains unknown member #{x}")
328 @groups.each_pair do |groupname, group|
329 group['members'].each do |member|
330 check_exists(member, "Group #{groupname}")
332 group['members_to_do'] = group['members'].clone
338 @groups.each_pair do |groupname, group|
339 group['keys'] = [] unless group['keys']
341 still_contains_groups = false
342 group['members_to_do'].clone.each do |member|
344 if @groups[member]['members_to_do'].size == 0
345 group['keys'].concat @groups[member]['keys']
346 group['members_to_do'].delete(member)
349 still_contains_groups = true
352 group['keys'].push @users[member]
353 group['members_to_do'].delete(member)
357 all_expanded = false if still_contains_groups
359 break if all_expanded
361 cyclic_groups = @groups.keys.reject{|name| @groups[name]['members_to_do'].size == 0}.join(", ")
362 STDERR.puts "Cyclic group memberships in #{cyclic_groups}?"
368 def expand_targets(targets)
372 unless check_exists(t, "access line", false)
377 fprs.concat @groups[t]['keys']
391 attr_reader :accessible, :encrypted, :readable, :readers
393 def EncryptedFile.determine_readable(readers)
394 GnuPG.get_my_keys.each do |keyid|
395 return true if readers.include?(keyid)
400 def EncryptedFile.list_readers(statustxt)
402 statustxt.split("\n").each do |line|
403 m = /^\[GNUPG:\] ENC_TO ([0-9A-F]+)/.match line
410 def EncryptedFile.targets(text)
411 metaline = text.split("\n").first
412 m = /^access: (.*)/.match metaline
414 return m[1].strip.split(/[\t ,]+/)
418 def initialize(filename, new=false)
419 @groupconfig = GroupConfig.new
426 unless FileTest.readable?(filename)
431 @encrypted_content = File.read(filename)
432 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall(@encrypted_content, %w{--with-colons --no-options --no-default-keyring --secret-keyring=/dev/null --keyring=/dev/null})
433 @encrypted = !(statustxt =~ /\[GNUPG:\] NODATA/)
435 @readers = EncryptedFile.list_readers(statustxt)
436 @readable = EncryptedFile.determine_readable(@readers)
441 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(@encrypted_content, %w{--decrypt})
442 if !@new and exitstatus != 0
443 proceed = read_input("Warning: gpg returned non-zero exit status #{exitstatus} when decrypting #{@filename}. Proceed?", false)
444 exit(0) unless proceed
445 elsif !@new and outtxt.length == 0
446 proceed = read_input("Warning: #{@filename} decrypted to an empty file. Proceed?")
447 exit(0) unless proceed
453 def encrypt(content, recipients)
454 args = recipients.collect{ |r| "--recipient=#{r}"}
455 args.push "--trust-model=always"
456 args.push "--keyring=./.keyring" if FileTest.exists?(".keyring")
458 args.push "--encrypt"
459 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(content, args)
462 statustxt.split("\n").each do |line|
463 m = /^\[GNUPG:\] INV_RECP \S+ ([0-9A-F]+)/.match line
468 again = read_input("Warning: the following recipients are invalid: #{invalid.join(", ")}. Try again (or proceed)?")
469 return false if again
471 if outtxt.length == 0
472 tryagain = read_input("Error: #{@filename} encrypted to an empty file. Edit again (or exit)?")
473 return false if tryagain
477 proceed = read_input("Warning: gpg returned non-zero exit status #{exitstatus} when encrypting #{@filename}. Said:\n#{stderrtxt}\n#{statustxt}\n\nProceed (or try again)?")
478 return false unless proceed
485 def determine_encryption_targets(content)
486 targets = EncryptedFile.targets(content)
488 tryagain = read_input("Warning: Did not find targets to encrypt to in header. Try again (or exit)?", true)
489 return false if tryagain
493 ok, expanded = @groupconfig.expand_targets(targets)
494 if (expanded.size == 0)
495 tryagain = read_input("Errors in access header. Edit again (or exit)?", true)
496 return false if tryagain
499 tryagain = read_input("Warnings in access header. Edit again (or continue)?", true)
500 return false if tryagain
504 GnuPG.get_my_fprs.each do |fpr|
505 if expanded.include?(fpr)
511 tryagain = read_input("File is not being encrypted to you. Edit again (or continue)?", true)
512 return false if tryagain
515 return true, expanded
518 def write_back(content, targets)
519 ok, encrypted = encrypt(content, targets)
520 return false unless ok
522 File.open(@filename,"w").write(encrypted)
528 def help(parser, code=0, io=STDOUT)
529 io.puts "Usage: #{$program_name} ls [<directory> ...]"
530 io.puts parser.summarize
531 io.puts "Lists the contents of the given directory/directories, or the current"
532 io.puts "directory if none is given. For each file show whether it is PGP-encrypted"
533 io.puts "file, and if yes whether we can read it."
539 dir = Dir.open(dirname)
540 rescue Exception => e
545 Dir.chdir(dirname) do
546 unless FileTest.exists?(".users")
547 STDERR.puts "The .users file does not exists here. This is not a password store, is it?"
550 dir.sort.each do |filename|
551 next if (filename =~ /^\./) and not (@all >= 3)
552 stat = File::Stat.new(filename)
554 puts "(sym) #{filename}" if (@all >= 2)
555 elsif stat.directory?
556 puts "(dir) #{filename}" if (@all >= 2)
558 puts "(other) #{filename}" if (@all >= 2)
560 f = EncryptedFile.new(filename)
562 puts "(!perm) #{filename}"
564 puts "(file) #{filename}" if (@all >= 2)
566 puts "(ok) #{filename}"
568 puts "(locked) #{filename}" if (@all >= 1)
577 ARGV.options do |opts|
578 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
579 opts.on_tail("-a", "--all" , "Show all files (use up to 3 times to show even more than all)") { @all = @all+1 }
584 dirs.push('.') unless dirs.size > 0
585 dirs.each { |dir| ls_dir(dir) }
590 def help(parser, code=0, io=STDOUT)
591 io.puts "Usage: #{$program_name} ed <filename>"
592 io.puts parser.summarize
593 io.puts "Decrypts the file, spawns an editor, and encrypts it again"
598 encrypted_file = EncryptedFile.new(filename, @new)
599 if !@new and !encrypted_file.readable && !@force
600 STDERR.puts "#{filename} is probably not readable"
604 encrypted_to = GnuPG.get_fprs_from_keyids(encrypted_file.readers).sort
606 content = encrypted_file.decrypt
607 original_content = content
609 oldsize = content.length
610 tempfile = Tempfile.open('pws')
611 tempfile.puts content
613 system($editor, tempfile.path)
615 throw "Process has not exited!?" unless status.exited?
616 unless status.exitstatus == 0
617 proceed = read_input("Warning: Editor did not exit successfully (exit code #{status.exitstatus}. Proceed?")
618 exit(0) unless proceed
621 # some editors do not write new content in place, but instead
622 # make a new file and more it in the old file's place.
624 reopened = File.open(tempfile.path, "r+")
625 rescue Exception => e
629 content = reopened.read
631 # zero the file, well, both of them.
632 newsize = content.length
633 clearsize = (newsize > oldsize) ? newsize : oldsize
635 [tempfile, reopened].each do |f|
636 f.seek(0, IO::SEEK_SET)
637 f.print "\0"*clearsize
643 if content.length == 0
644 proceed = read_input("Warning: Content is now empty. Proceed?")
645 exit(0) unless proceed
648 ok, targets = encrypted_file.determine_encryption_targets(content)
651 if (original_content == content)
652 if (targets.sort == encrypted_to)
653 proceed = read_input("Nothing changed. Re-encrypt anyway?", false)
654 exit(0) unless proceed
656 STDERR.puts("Info: Content not changed but re-encrypting anyway because the list of keys changed")
660 success = encrypted_file.write_back(content, targets)
666 ARGV.options do |opts|
667 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
668 opts.on_tail("-n", "--new" , "Edit new file") { |new| @new=new }
669 opts.on_tail("-f", "--force" , "Spawn an editor even if the file is probably not readable") { |force| @force=force }
672 help(ARGV.options, 1, STDERR) if ARGV.length != 1
673 filename = ARGV.shift
676 if FileTest.exists?(filename)
677 STDERR.puts "#{filename} does exist"
681 if !FileTest.exists?(filename)
682 STDERR.puts "#{filename} does not exist"
684 elsif !FileTest.file?(filename)
685 STDERR.puts "#{filename} is not a regular file"
687 elsif !FileTest.readable?(filename)
688 STDERR.puts "#{filename} is not accessible (unix perms)"
693 dirname = File.dirname(filename)
694 basename = File.basename(filename)
702 def help(parser, code=0, io=STDOUT)
703 io.puts "Usage: #{$program_name} update-keyring [<keyserver>]"
704 io.puts parser.summarize
705 io.puts "Updates the local .keyring file"
710 ARGV.options do |opts|
711 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
714 help(ARGV.options, 1, STDERR) if ARGV.length > 1
715 keyserver = ARGV.shift
716 keyserver = 'keys.gnupg.net' unless keyserver
718 groupconfig = GroupConfig.new
719 users = groupconfig.get_users()
720 args = %w{--with-colons --no-options --no-default-keyring --keyring=./.keyring}
722 system('touch', '.keyring')
723 users.each_pair() do |uid, keyid|
725 cmd << "--keyserver=#{keyserver}"
728 puts "Fetching key for #{uid}"
729 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall('', cmd)
730 unless (statustxt =~ /^\[GNUPG:\] IMPORT_OK /)
731 STDERR.puts "Warning: did not find IMPORT_OK token in status output"
732 STDERR.puts "gpg exited with exit code #{ecode})"
733 STDERR.puts "Command was gpg #{cmd.join(' ')}"
734 STDERR.puts "stdout was #{outtxt}"
735 STDERR.puts "stderr was #{stderrtxt}"
736 STDERR.puts "statustxt was #{statustxt}"
740 cmd << '--batch' << '--edit' << keyid << 'minimize' << 'save'
741 (outtxt, stderrtxt, statustxt, ecode) = GnuPG.gpgcall('', cmd)
748 def help(code=0, io=STDOUT)
749 io.puts "Usage: #{$program_name} ed"
750 io.puts " #{$program_name} ls"
751 io.puts " #{$program_name} update-keyring"
752 io.puts " #{$program_name} help"
753 io.puts "Call #{$program_name} <command> --help for additional options/parameters"
760 when 'ls' then Ls.new
761 when 'ed' then Ed.new
762 when 'update-keyring' then KeyringUpdater.new
778 # vim:set shiftwidth=2: