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"
34 GROUP_PATTERN = "@[a-zA-Z0-9-]+"
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|
236 args.push "--keyring=./.keyring" if FileTest.exists?(".keyring")
237 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(content, args)
240 statustxt.split("\n").each do |line|
241 if m = /^\[GNUPG:\] GOODSIG/.match(line)
243 elsif m = /^\[GNUPG:\] VALIDSIG \S+ \S+ \S+ \S+ \S+ \S+ \S+ \S+ \S+ ([0-9A-F]+)/.match(line)
249 STDERR.puts ".users file is not signed properly. GnuPG said on stdout:"
251 STDERR.puts "and on stderr:"
252 STDERR.puts stderrtxt
253 STDERR.puts "and via statusfd:"
254 STDERR.puts statustxt
258 if not trusted.include?(validsig)
259 STDERR.puts ".users file is signed by #{validsig} which is not in ~/.pws-trusted-users"
264 STDERR.puts "gpg verify failed for .users file"
273 f = File.open('.users')
274 rescue Exception => e
282 users = verify(users)
288 users.split("\n").each do |line|
292 if (m = /^([a-zA-Z0-9:-]+)\s*=\s*([0-9A-Fa-f]{40})\s*$/.match line)
295 if @users.has_key?(user)
296 STDERR.puts "User #{user} redefined at line #{lno}!"
300 elsif (m = /^(#{GROUP_PATTERN})\s*=\s*(.*)$/.match line)
303 if @groups.has_key?(group)
304 STDERR.puts "Group #{group} redefined at line #{lno}!"
307 members = members.split(/[\t ,]+/)
308 @groups[group] = { "members" => members }
314 return (name =~ /^@/)
316 def check_exists(x, whence, fatal=true)
319 ok=false unless (@groups.has_key?(x))
321 ok=false unless @users.has_key?(x)
324 STDERR.puts( (fatal ? "Error: " : "Warning: ") + "#{whence} contains unknown member #{x}")
330 @groups.each_pair do |groupname, group|
331 group['members'].each do |member|
332 check_exists(member, "Group #{groupname}")
334 group['members_to_do'] = group['members'].clone
340 @groups.each_pair do |groupname, group|
341 group['keys'] = [] unless group['keys']
343 still_contains_groups = false
344 group['members_to_do'].clone.each do |member|
346 if @groups[member]['members_to_do'].size == 0
347 group['keys'].concat @groups[member]['keys']
348 group['members_to_do'].delete(member)
351 still_contains_groups = true
354 group['keys'].push @users[member]
355 group['members_to_do'].delete(member)
359 all_expanded = false if still_contains_groups
361 break if all_expanded
363 cyclic_groups = @groups.keys.reject{|name| @groups[name]['members_to_do'].size == 0}.join(", ")
364 STDERR.puts "Cyclic group memberships in #{cyclic_groups}?"
370 def expand_targets(targets)
374 unless check_exists(t, "access line", false)
379 fprs.concat @groups[t]['keys']
393 attr_reader :accessible, :encrypted, :readable, :readers
395 def EncryptedFile.determine_readable(readers)
396 GnuPG.get_my_keys.each do |keyid|
397 return true if readers.include?(keyid)
402 def EncryptedFile.list_readers(statustxt)
404 statustxt.split("\n").each do |line|
405 m = /^\[GNUPG:\] ENC_TO ([0-9A-F]+)/.match line
412 def EncryptedFile.targets(text)
413 text.split("\n").each do |line|
417 m = /^access: "?(#{GROUP_PATTERN})"?/.match line
419 return m[1].strip.split(/[\t ,]+/)
424 def initialize(filename, new=false)
425 @groupconfig = GroupConfig.new
432 unless FileTest.readable?(filename)
437 @encrypted_content = File.read(filename)
438 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall(@encrypted_content, %w{--with-colons --no-options --no-default-keyring --secret-keyring=/dev/null --keyring=/dev/null})
439 @encrypted = !(statustxt =~ /\[GNUPG:\] NODATA/)
441 @readers = EncryptedFile.list_readers(statustxt)
442 @readable = EncryptedFile.determine_readable(@readers)
447 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(@encrypted_content, %w{--decrypt})
448 if !@new and exitstatus != 0
449 proceed = read_input("Warning: gpg returned non-zero exit status #{exitstatus} when decrypting #{@filename}. Proceed?", false)
450 exit(0) unless proceed
451 elsif !@new and outtxt.length == 0
452 proceed = read_input("Warning: #{@filename} decrypted to an empty file. Proceed?")
453 exit(0) unless proceed
459 def encrypt(content, recipients)
460 args = recipients.collect{ |r| "--recipient=#{r}"}
461 args.push "--trust-model=always"
462 args.push "--keyring=./.keyring" if FileTest.exists?(".keyring")
464 args.push "--encrypt"
465 (outtxt, stderrtxt, statustxt, exitstatus) = GnuPG.gpgcall(content, args)
468 statustxt.split("\n").each do |line|
469 m = /^\[GNUPG:\] INV_RECP \S+ ([0-9A-F]+)/.match line
474 again = read_input("Warning: the following recipients are invalid: #{invalid.join(", ")}. Try again (or proceed)?")
475 return false if again
477 if outtxt.length == 0
478 tryagain = read_input("Error: #{@filename} encrypted to an empty file. Edit again (or exit)?")
479 return false if tryagain
483 proceed = read_input("Warning: gpg returned non-zero exit status #{exitstatus} when encrypting #{@filename}. Said:\n#{stderrtxt}\n#{statustxt}\n\nProceed (or try again)?")
484 return false unless proceed
491 def determine_encryption_targets(content)
492 targets = EncryptedFile.targets(content)
494 tryagain = read_input("Warning: Did not find targets to encrypt to in header. Try again (or exit)?", true)
495 return false if tryagain
499 ok, expanded = @groupconfig.expand_targets(targets)
500 if (expanded.size == 0)
501 tryagain = read_input("Errors in access header. Edit again (or exit)?", true)
502 return false if tryagain
505 tryagain = read_input("Warnings in access header. Edit again (or continue)?", true)
506 return false if tryagain
510 GnuPG.get_my_fprs.each do |fpr|
511 if expanded.include?(fpr)
517 tryagain = read_input("File is not being encrypted to you. Edit again (or continue)?", true)
518 return false if tryagain
521 return true, expanded
524 def write_back(content, targets)
525 ok, encrypted = encrypt(content, targets)
526 return false unless ok
528 File.open(@filename,"w").write(encrypted)
534 def help(parser, code=0, io=STDOUT)
535 io.puts "Usage: #{$program_name} ls [<directory> ...]"
536 io.puts parser.summarize
537 io.puts "Lists the contents of the given directory/directories, or the current"
538 io.puts "directory if none is given. For each file show whether it is PGP-encrypted"
539 io.puts "file, and if yes whether we can read it."
545 dir = Dir.open(dirname)
546 rescue Exception => e
551 Dir.chdir(dirname) do
552 unless FileTest.exists?(".users")
553 STDERR.puts "The .users file does not exists here. This is not a password store, is it?"
556 dir.sort.each do |filename|
557 next if (filename =~ /^\./) and not (@all >= 3)
558 stat = File::Stat.new(filename)
560 puts "(sym) #{filename}" if (@all >= 2)
561 elsif stat.directory?
562 puts "(dir) #{filename}" if (@all >= 2)
564 puts "(other) #{filename}" if (@all >= 2)
566 f = EncryptedFile.new(filename)
568 puts "(!perm) #{filename}"
570 puts "(file) #{filename}" if (@all >= 2)
572 puts "(ok) #{filename}"
574 puts "(locked) #{filename}" if (@all >= 1)
583 ARGV.options do |opts|
584 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
585 opts.on_tail("-a", "--all" , "Show all files (use up to 3 times to show even more than all)") { @all = @all+1 }
590 dirs.push('.') unless dirs.size > 0
591 dirs.each { |dir| ls_dir(dir) }
596 def help(parser, code=0, io=STDOUT)
597 io.puts "Usage: #{$program_name} ed <filename>"
598 io.puts parser.summarize
599 io.puts "Decrypts the file, spawns an editor, and encrypts it again"
604 encrypted_file = EncryptedFile.new(filename, @new)
605 if !@new and !encrypted_file.readable && !@force
606 STDERR.puts "#{filename} is probably not readable"
610 encrypted_to = GnuPG.get_fprs_from_keyids(encrypted_file.readers).sort
612 content = encrypted_file.decrypt
613 original_content = content
615 oldsize = content.length
616 tempfile = Tempfile.open('pws')
617 tempfile.puts content
619 system($editor, tempfile.path)
621 throw "Process has not exited!?" unless status.exited?
622 unless status.exitstatus == 0
623 proceed = read_input("Warning: Editor did not exit successfully (exit code #{status.exitstatus}. Proceed?")
624 exit(0) unless proceed
627 # some editors do not write new content in place, but instead
628 # make a new file and more it in the old file's place.
630 reopened = File.open(tempfile.path, "r+")
631 rescue Exception => e
635 content = reopened.read
637 # zero the file, well, both of them.
638 newsize = content.length
639 clearsize = (newsize > oldsize) ? newsize : oldsize
641 [tempfile, reopened].each do |f|
642 f.seek(0, IO::SEEK_SET)
643 f.print "\0"*clearsize
649 if content.length == 0
650 proceed = read_input("Warning: Content is now empty. Proceed?")
651 exit(0) unless proceed
654 ok, targets = encrypted_file.determine_encryption_targets(content)
657 if (original_content == content)
658 if (targets.sort == encrypted_to)
659 proceed = read_input("Nothing changed. Re-encrypt anyway?", false)
660 exit(0) unless proceed
662 STDERR.puts("Info: Content not changed but re-encrypting anyway because the list of keys changed")
666 success = encrypted_file.write_back(content, targets)
672 ARGV.options do |opts|
673 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
674 opts.on_tail("-n", "--new" , "Edit new file") { |new| @new=new }
675 opts.on_tail("-f", "--force" , "Spawn an editor even if the file is probably not readable") { |force| @force=force }
678 help(ARGV.options, 1, STDERR) if ARGV.length != 1
679 filename = ARGV.shift
682 if FileTest.exists?(filename)
683 STDERR.puts "#{filename} does exist"
687 if !FileTest.exists?(filename)
688 STDERR.puts "#{filename} does not exist"
690 elsif !FileTest.file?(filename)
691 STDERR.puts "#{filename} is not a regular file"
693 elsif !FileTest.readable?(filename)
694 STDERR.puts "#{filename} is not accessible (unix perms)"
699 dirname = File.dirname(filename)
700 basename = File.basename(filename)
708 def help(parser, code=0, io=STDOUT)
709 io.puts "Usage: #{$program_name} get <filename> <query>"
710 io.puts parser.summarize
711 io.puts "Decrypts the file, fetches a key and outputs it to stdout."
712 io.puts "The file must be in YAML format."
713 io.puts "query is a query, formatted like host/users/root"
717 def get(filename, what)
718 encrypted_file = EncryptedFile.new(filename, @new)
719 if !encrypted_file.readable
720 STDERR.puts "#{filename} is probably not readable"
725 yaml = YAML::load(encrypted_file.decrypt)
726 rescue Psych::SyntaxError, ArgumentError => e
727 STDERR.puts "Could not parse YAML: #{e.message}"
739 STDERR.puts("No such key or invalid lookup expression")
740 elsif hit.respond_to?(:keys)
742 puts hit.keys.join("\n")
749 ARGV.options do |opts|
750 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
753 help(ARGV.options, 1, STDERR) if ARGV.length != 2
754 filename = ARGV.shift
757 if !FileTest.exists?(filename)
758 STDERR.puts "#{filename} does not exist"
760 elsif !FileTest.file?(filename)
761 STDERR.puts "#{filename} is not a regular file"
763 elsif !FileTest.readable?(filename)
764 STDERR.puts "#{filename} is not accessible (unix perms)"
768 dirname = File.dirname(filename)
769 basename = File.basename(filename)
777 def help(parser, code=0, io=STDOUT)
778 io.puts "Usage: #{$program_name} update-keyring [<keyserver>]"
779 io.puts parser.summarize
780 io.puts "Updates the local .keyring file"
785 ARGV.options do |opts|
786 opts.on_tail("-h", "--help" , "Display this help screen") { help(opts) }
789 help(ARGV.options, 1, STDERR) if ARGV.length > 1
790 keyserver = ARGV.shift
791 keyserver = 'keys.gnupg.net' unless keyserver
793 groupconfig = GroupConfig.new
794 users = groupconfig.get_users()
795 args = %w{--with-colons --no-options --no-default-keyring --keyring=./.keyring}
797 system('touch', '.keyring')
798 users.each_pair() do |uid, keyid|
800 cmd << "--keyserver=#{keyserver}"
803 puts "Fetching key for #{uid}"
804 (outtxt, stderrtxt, statustxt) = GnuPG.gpgcall('', cmd)
805 unless (statustxt =~ /^\[GNUPG:\] IMPORT_OK /)
806 STDERR.puts "Warning: did not find IMPORT_OK token in status output"
807 STDERR.puts "gpg exited with exit code #{ecode})"
808 STDERR.puts "Command was gpg #{cmd.join(' ')}"
809 STDERR.puts "stdout was #{outtxt}"
810 STDERR.puts "stderr was #{stderrtxt}"
811 STDERR.puts "statustxt was #{statustxt}"
815 cmd << '--batch' << '--edit' << keyid << 'minimize' << 'save'
816 (outtxt, stderrtxt, statustxt, ecode) = GnuPG.gpgcall('', cmd)
823 def help(code=0, io=STDOUT)
824 io.puts "Usage: #{$program_name} ed"
825 io.puts " #{$program_name} ls"
826 io.puts " #{$program_name} update-keyring"
827 io.puts " #{$program_name} help"
828 io.puts "Call #{$program_name} <command> --help for additional options/parameters"
835 when 'ls' then Ls.new
836 when 'ed' then Ed.new
837 when 'get' then Get.new
838 when 'update-keyring' then KeyringUpdater.new
854 # vim:set shiftwidth=2: