fernet-cli 0.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bc1ba7e595b73d8bf6e87bbe0b6cfa458da9822
-  data.tar.gz: eeb6d5e25640ddcbe6a393a13afac0cc7101ced4
+  metadata.gz: 5a654c836525e88646cbb7142cafaa905aab09a7
+  data.tar.gz: e2d9ab9a0450fb6e4127289b34836ea4cad8ab2f
 SHA512:
-  metadata.gz: 6f9ab85bdca745f3a57119303e2341287eb534bf058e37820a402412b3a831babb846c9a4be18d9d9c135c79acadcf7dada2f737d660191ef5102b411f34cd9e
-  data.tar.gz: 53c3d8341c19c1ffb707ef6f7c27e915ad3e9223452be71257f523bc7330f92f92d5ca2b9a6cfbc03ce724d4f1deefc2254a65f79a2dee8c8b2329937ad2e097
+  metadata.gz: 7b36d9e0360d9158ac682d4abf8e87d0a19c3b7bc742a50d78867b73fd8fc1ec876835477fce8a22e5b0d2f1176a79320d14a685ec5f09a73cee0f95017056b5
+  data.tar.gz: f011d30cb64e6898d97c2dd994c30de6e93b1de8e0a88559e29d7f40bc259d11a2f39087953149bc228e5b050f5d92078b2cf001327e04e26f3293f5838bd5da

data/README.md

@@ -0,0 +1,25 @@
+fernet-cli
+==========
+
+Now, the power of [Fernet](https://github.com/fernet/spec) is
+available from the shell!
+
+```
+tmaher@og-kush:~$ fernet-encrypt --help
+Usage: fernet-encrypt [-p | -k <keyfile>] -i <infile> -o <outfile>
+    -p, --prompt                     Prompt for keys
+    -k, --keyfile KEYFILE
+    -i, --infile INPUTFILE
+    -o, --outfile OUTPUTFILE
+```
+
+And there's a corresponding `fernet-decrypt` too.  The key should be a
+base64-encoded blob of 256-bits.  If you'd rather not write it out to
+a file or get promted for it, you can save it to shell environment
+variable `FERNET_CLI_KEY`.
+
+For `fernet-encrypt`, the infile is plaintext and the outfile is
+ciphertext.  For `fernet-decrypt`, the infile is ciphertext and the
+outfile is plaintext.  
+
+For more information, see https://github.com/fernet/spec

data/bin/fernet-decrypt

@@ -1,60 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'fernet'
-require 'optparse'
-require 'highline/import'
+require 'fernet/cli'
 
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: fernet-decrypt [-p | -k <keyfile>] -i <ciphertext> -o <plaintext>"
-
-  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    options[:verbose] = v
-  end
-  opts.on("-p", "--prompt", "Prompt for keys") do |prompt|
-    options[:prompt] = prompt
-  end
-  opts.on("-k", "--keyfile KEYFILE") do |keyfile|
-    options[:keyfile] = keyfile
-  end
-  opts.on("-i", "--infile CIPHERFILE") do |cipherfile|
-    options[:cipherfile] = cipherfile
-  end
-  opts.on("-o", "--outfile PLAINFILE") do |plainfile|
-    options[:plainfile] = plainfile
-  end
-  opts.on("--enforce-ttl") do |ttl|
-    options[:ttl] = true
-  end
-end.parse!
-
-if ENV["FERNET_CLI_KEY"].nil?
-  if options[:prompt]
-    KEY = ask("Enter Key: ") {|q| q.echo = false}
-  elsif options[:keyfile]
-    KEY = File.read(options[:keyfile]).chomp
-  end
-else
-  KEY=ENV["FERNET_CLI_KEY"]
-end
-
-if KEY.nil?
-  puts "i have no key"
-  exit(1)
-end
-
-if options[:cipherfile].nil? or (! File.readable?(options[:cipherfile]))
-  puts "can't read ciphertext file"
-  exit(1)
-end
-
-plaintext = Fernet.verifier(KEY.chomp, File.read(options[:cipherfile]),
-                            enforce_ttl: options[:ttl])
-if ! plaintext.valid?
-  puts "ciphertext corrupt"
-  exit(1)
-end
-
-File.open(options[:plainfile], "w+") do |f|
-  f.write(plaintext.message)
-end
+Fernet::CLI.new().decrypt

data/bin/fernet-encrypt

@@ -1,50 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'fernet'
-require 'optparse'
-require 'highline/import'
+require 'fernet/cli'
 
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: fernet-encrypt [-p | -k <keyfile>] -i <plaintext> -o <ciphertext>"
-
-  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    options[:verbose] = v
-  end
-  opts.on("-p", "--prompt", "Prompt for keys") do |prompt|
-    options[:prompt] = prompt
-  end
-  opts.on("-k", "--keyfile KEYFILE") do |keyfile|
-    options[:keyfile] = keyfile
-  end
-  opts.on("-i", "--infile PLAINFILE") do |plainfile|
-    options[:plainfile] = plainfile
-  end
-  opts.on("-o", "--outfile CIPHERFILE") do |cipherfile|
-    options[:cipherfile] = cipherfile
-  end
-end.parse!
-
-if ENV["FERNET_CLI_KEY"].nil?
-  if options[:prompt]
-    KEY = ask("Enter Key: ") {|q| q.echo = false}
-  elsif options[:keyfile]
-    KEY = File.read(options[:keyfile]).chomp
-  end
-else
-  KEY=ENV["FERNET_CLI_KEY"]
-end
-
-if KEY.nil?
-  puts "i have no key"
-  exit(1)
-end
-
-if options[:plainfile].nil? or (! File.readable?(options[:plainfile]))
-  puts "can't read plaintext file"
-  exit(1)
-end
-
-File.open(options[:cipherfile], "w+") do |f|
-  f.write(Fernet.generate(KEY.chomp, File.read(options[:plainfile])))
-end
+Fernet::CLI.new().encrypt

data/fernet-cli.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |gem|
   gem.license       = "Apache-2.0"
 
   gem.add_runtime_dependency "fernet", "~> 2.0"
+  gem.add_runtime_dependency "highline", "~> 1.6"
   gem.add_development_dependency "rspec", "~> 2.14"
 end

data/lib/fernet/cli/version.rb

@@ -1,5 +1,5 @@
 module Fernet
   module CLI
-    VERSION = "0.1"
+    VERSION = "0.3"
   end
 end

data/lib/fernet/cli.rb

@@ -0,0 +1,92 @@
+require 'fernet'
+require 'optparse'
+require 'highline/import'
+
+module Fernet
+  class CLI
+    def initialize
+      @options = {}
+      @op_obj = parse_args
+      @key = get_key
+      (@in_fd, @out_fd) = set_file_descriptors
+    end
+
+    def abort msg="unspecified error"
+      $stderr.puts "FAIL: #{msg}", @op_obj.banner, @op_obj.summarize
+      exit(1)
+    end
+    
+    def parse_args
+      op = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0} [-p | -k <keyfile>] -i <infile> -o <outfile>"
+
+        opts.on("-p", "--prompt", "Prompt for keys") do |prompt|
+          @options[:prompt] = prompt
+        end
+        opts.on("-k", "--keyfile KEYFILE") do |keyfile|
+          @options[:keyfile] = keyfile
+        end
+        opts.on("-i", "--infile INPUTFILE") do |infile|
+          @options[:infile] = infile
+        end
+        opts.on("-o", "--outfile OUTPUTFILE") do |outfile|
+          @options[:outfile] = outfile
+        end
+      end
+      op.parse!
+      op
+    end
+
+    def get_key
+      if ENV["FERNET_CLI_KEY"].nil?
+        if @options[:prompt]
+          key = ask("Enter Key: ") {|q| q.echo = false}
+        elsif @options[:keyfile]
+          key = File.read(@options[:keyfile])
+        end
+      else
+        key=ENV["FERNET_CLI_KEY"]
+      end
+
+      abort("please specify a key") if key.nil?
+
+      key.chomp
+    end
+
+    def set_file_descriptors
+      if @options[:infile].nil? or @options[:outfile].nil?
+        abort "must specify input & output files. Use '-' for stdin/stdout"
+      end
+
+      if @options[:infile] == "-"
+        in_fd = $stdin
+      else
+        abort("can't read input file") unless File.readable?(@options[:infile])
+        in_fd = File.open(@options[:infile])
+      end
+
+      if @options[:outfile] == "-"
+        out_fd = $stdout
+      else
+        out_fd = File.open(@options[:outfile], "w+")
+      end
+
+      [in_fd, out_fd]
+    end
+    
+    def encrypt
+      @out_fd.write(Fernet.generate(@key, @in_fd.read))
+      @out_fd.close
+    end
+
+    def decrypt
+      plaintext = Fernet.verifier(@key, @in_fd.read,
+                                  enforce_ttl: false)
+      abort("ciphertext corrupt") unless plaintext.valid?
+      
+      @out_fd.write(plaintext.message)
+      @out_fd.close
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fernet-cli
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.3'
 platform: ruby
 authors:
 - Tom Maher
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -49,10 +63,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- README.md
 - Rakefile
 - bin/fernet-decrypt
 - bin/fernet-encrypt
 - fernet-cli.gemspec
+- lib/fernet/cli.rb
 - lib/fernet/cli/version.rb
 - version
 homepage: https://github.com/tmaher/fernet-cli