ssbx 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb3f97e7f7bcd6aced71f70fca0c43ebec72d0e4251b003e447a87d49eacb039
-  data.tar.gz: ecc265a10d0045c6f07944b7379432b7bf2452a77b2ca9893b1d6acb5f0d4424
+  metadata.gz: 8ac01c3e11dac6e4e8ef24b14e88dbb64164dd6fd81c34c7e0408c90b26838dd
+  data.tar.gz: 5c0bf89484444b8b72c1e5a07df573364f75b315f8abe099ef81236a0b277055
 SHA512:
-  metadata.gz: df6183075ea93db79bd41942085cfd45b18a807cf17f198d0c7071d92a79f7098288d5e08c9a2c2fed48f73ae995e986b85acecf6850a49b22fe7426b37b4022
-  data.tar.gz: 3e68060e935524cc38184c5e63c6e48ef19b909e86ba0fd2314d43e52e6c34b8dbaaebaf8c5cde76f1cd3c630f25394f4931d25079da365a33625c41a46426b5
+  metadata.gz: e28b74015ab982982ad09ab7c7e5f914acb249f8f61f3fa221d2e572ed2f52758d4622777c9000079f5e19a052ac45e1ae585f73feb4fe4e7559bf7d6d4cbdfb
+  data.tar.gz: ced2414f90e641209126b2205f49eb10d8d3f0822f75198e963739d5d0d2c57e5093c61c043e02dd83edbf4bd92de9b3fc835adf3f2f3e8438fc121ce954e4b5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ssbx (0.1.0)
+    ssbx (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -23,10 +23,30 @@ Edit `~/.ssbx.yaml` to contain...
 ```yaml
 user: You
 pass: A secret password
+# This is optional if you want to override $EDITOR.
+editor: vi
 ```
 
 Then use `ssbx` to view or edit a file.
 
+## Simple Recipes
+
+    # Add a user with a simple password.
+    sbx -f f1.enc -a user1:userpass 
+
+    # ... or
+    cat f1.enc | ssbx -f - -a user1:userpass > f2.enc
+
+    # Remove the user.
+    ssbx -f f1.enc -d user1:userpass
+
+    # File data to standard out.
+    ssbx -f f1.enc -o -
+
+    # Edit file data and re-encrypt the file.
+    ssbx -f f1.enc -e
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/ssbx

@@ -4,6 +4,7 @@ require "ssbx"
 require 'optparse'
 require 'yaml'
 require 'pp'
+require 'tempfile'
 
 CONFIG = {
     'file' => 'ssbx.enc',
@@ -29,6 +30,10 @@ OptionParser.new do |opts|
         CONFIG['list'] = true
     end
 
+    opts.on('-e', '--edit', "Edit the given file with EDITOR and exit.") do
+        CONFIG['edit'] = true
+    end
+
     opts.on('-d', '--delete=user', String, "Delete user. May be used multiple times.") do |u|
         CONFIG['delete_users'] << u
     end
@@ -60,24 +65,23 @@ if CONFIG['verbose']
 end
 
 CONFIG['delete_users'].each do |u|
-    f = Ssbx::File.new
-    File.open(CONFIG['file'], 'r') { |io| f.read(io) }
+    f = Ssbx::Util.read(CONFIG['file']) { |io| Ssbx::File.new(io) }
     bx = Ssbx::Box.new(f)
     bx.remove_user(u)
-    File.open(CONFIG['file'], 'wb') { |io| f.write(io) }
+    Ssbx::Util.write(CONFIG['file']) { |io| f.write(io) }
 end
 
-if CONFIG['add_users']
+if CONFIG['add_users'].length > 0
     f = Ssbx::File.new
     bx = Ssbx::Box.new(f)
-    data = File.open(CONFIG['file'], 'rb') do |io|
+    data = Ssbx::Util.read(CONFIG['file']) do |io|
         bx.read(io, CONFIG['user'], CONFIG['pass'])
     end
 
     CONFIG['add_users'].each do |u|
         u, p = u[0], u[1] || u[0]
         
-        File.open(CONFIG['file'], 'wb') do |io| 
+        Ssbx::Util.write(CONFIG['file']) do |io|
             bx.write(io, u, p, data)
         end 
     end
@@ -87,31 +91,57 @@ if CONFIG['set']
     f = Ssbx::File.new
     bx = Ssbx::Box.new(f)
     data = File.read(CONFIG['set'])
-    File.open(CONFIG['file'], 'wb') do |io|
-        bx.write(io, CONFIG['user'], CONFIG['pass'], data)
-    end
+    Ssbx::Util.write(CONFIG['file']) do |io|
+        bx.write(io, u, p, data)
+    end 
 end
 
 if CONFIG['out']
     f = Ssbx::File.new
     bx = Ssbx::Box.new(f)
-    data = File.open(CONFIG['file'], 'rb') do |io|
+    data = Ssbx::Util.read(CONFIG['file']) do |io|
         bx.read(io, CONFIG['user'], CONFIG['pass'])
     end
 
-    if CONFIG['out'] == '-'
-        STDOUT.write(data)
-    else 
-        File.open(CONFIG['out'], 'wb') do |io|
-            io.write(data)
+    Ssbx::Util.write(CONFIG['out']) { |io| io.write(data) }
+end
+
+if CONFIG['edit']
+    f = Ssbx::File.new
+    bx = Ssbx::Box.new(f)
+
+    data = if File.file? CONFIG['file']
+        Ssbx::Util.read(CONFIG['file']) do |io|
+            bx.read(io, CONFIG['user'], CONFIG['pass'])
+        end
+    else
+        ''
+    end
+
+    tmpfile = Tempfile.new("ssbx")
+    tmpfile.write(data)
+    tmpfile.flush
+
+    begin
+        editor = CONFIG['editor'] || ENV['EDITOR']
+
+        system("#{editor} #{tmpfile.path}")
+
+        tmpfile.rewind
+        data = File.read(tmpfile)
+        File.open(CONFIG['file'], 'wb') do |io|
+            bx.write(io, CONFIG['user'], CONFIG['pass'], data)
         end
+    ensure
+        tmpfile.unlink
     end
 end
 
 if CONFIG['list']
     f = Ssbx::File.new
     bx = Ssbx::Box.new(f)
-    File.open(CONFIG['file'], 'rb') do |io|
+
+    Ssbx::Util.read(CONFIG['file']) do |io|
         f.read(io)
     end
 

data/lib/ssbx/file.rb

@@ -16,9 +16,10 @@ module Ssbx
         # The file data.
         attr_accessor :data
 
-        def initialize
+        def initialize(optional_stream = nil)
             @keys = []
             @data = ''
+            read(optional_stream) if optional_stream            
         end
 
         def write(out)
@@ -38,7 +39,7 @@ module Ssbx
             out.write(@data)
         end
 
-        def read(istream)            
+        def read(istream)
             @keys = []
             # Read the key record length...
             istream.read(4).unpack('N')[0].times do

data/lib/ssbx/util.rb

@@ -0,0 +1,47 @@
+module Ssbx
+    module Util
+        def self.read(istream)
+            if istream.is_a? String
+                stream = if istream == '-'
+                    STDIN
+                else
+                    ::File.open(istream, 'rb')
+                end
+
+                if block_given?
+                    begin
+                        yield stream
+                    ensure
+                        stream.close
+                    end
+                else
+                    stream
+                end
+            else
+                raise Exception.new("Unsupported type #{istream.class}.")
+            end
+        end
+
+        def self.write(ostream)
+            if ostream.is_a? String
+                stream = if ostream == '-'
+                    STDOUT
+                else
+                    ::File.open(ostream, 'wb')
+                end
+
+                if block_given?
+                    begin
+                        yield stream
+                    ensure
+                        stream.close
+                    end
+                else
+                    stream
+                end
+            else
+                raise Exception.new("Unsupported type #{ostream.class}.")
+            end
+        end
+    end
+end

data/lib/ssbx/version.rb

@@ -1,3 +1,3 @@
 module Ssbx
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/ssbx.rb

@@ -1,6 +1,7 @@
 require "ssbx/version"
 require "ssbx/file"
 require "ssbx/box"
+require "ssbx/util"
 
 module Ssbx
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ssbx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sam
@@ -59,6 +59,7 @@ files:
 - lib/ssbx.rb
 - lib/ssbx/box.rb
 - lib/ssbx/file.rb
+- lib/ssbx/util.rb
 - lib/ssbx/version.rb
 - ssbx.gemspec
 homepage: https://gitlab.com/basking2/ssbx