lockness 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ced30afb2d1a4d26bb196185016fd0913b8060f521c3649e42b141ca1661455d
-  data.tar.gz: 76087b974b7b737a97f16d104aa8c8ad36c04c041051023acd4adf30339f5ddd
+  metadata.gz: b98cede040b3978d3e632eed0ef4c419705aa575830f89a0f833924d335dc9aa
+  data.tar.gz: a9f960a5295d0616f78a31652514043d34cffa4bdcc84d645bc7e7e81735c023
 SHA512:
-  metadata.gz: 298e8af1e29199c2ad2b10c7d57f3fd579b978de8d49daf503e6b2103c41b29c59c10b33d1bf2c6a18ff53190d8b14c443c2d25cdeffce83c711985fbeeefac1
-  data.tar.gz: 98672ecc736d01b2ed521b3e57cc83180789531e5c6f142c3372fd7565c58dcbdbe212811ecb436e4d18d68f834e2b6f7a785e76733c2ebc90f96bd1bd19f99d
+  metadata.gz: 15b2444f0d0751ac5c027cd652e75d49f63e3219dfc651079a135d6253984d8a19f8c7eb6f97ae0f2608278002b18723663917c203322a58023e7d1d2c51c1c6
+  data.tar.gz: ac6de43d94d50c0d053d772ce5c283aaadba92b07f0bbda97a6dbafba2b51c36656118a475c4a127cfabc4a8a4b34ad79ec4ddbf56eac3edeff42f211e468a41

data/README.md

@@ -1,3 +1,20 @@
 # Lockness
 
-TODO
+Lockness manages encrypted files from the command line and from within your program.
+
+It provides similar functionality to the `rails credentials:show` and `rails credentials:edit` tasks but can be used for any file in a plain old ruby app.
+
+# Usage -- Command Line
+
+```
+lockness init                 # generates a master.key
+lockness edit  <filename>     # create or edit a new file
+lockness show  <filename>     # view an encrypted file
+lockness                      # show this help
+```
+
+# Usage -- Within application
+
+```ruby
+Lockness.decrypt('<path to encrypted file>')
+```

data/bin/lockness

@@ -1,16 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'active_support/all'
-require 'base64'
-require 'digest/sha2'
-require 'openssl'
-require 'securerandom'
-require 'tempfile'
-
-lib_file_glob = "#{__dir__}/../lib/**/*.rb"
-
-Dir.glob(lib_file_glob).each do |file|
-  require_relative file
-end
+require_relative '../lib/lockness'
 
 Lockness.start

data/lib/lockness/content.rb

@@ -1,18 +1,25 @@
 module Lockness
   class Content
 
-    attr_reader :secret_file,
+    attr_reader :encrypted_file,
                 :message_encryptor,
                 :encrypted
 
-    def initialize
-      @secret_file       = SecretFile.new
+    def initialize(encrypted_file:)
+      @encrypted_file    = encrypted_file
       @message_encryptor = ActiveSupport::MessageEncryptor.new(MasterKey.new.read)
-      @encrypted         = secret_file.read
+      @encrypted         = encrypted_file.read
     end
 
     def plain
       message_encryptor.decrypt_and_verify(encrypted)
+
+    rescue ActiveSupport::MessageVerifier::InvalidSignature => exception
+      puts "Unable to decrypt using the master.key."
+      puts
+      puts "Please double check that the master.key is correct."
+
+      exit 1
     end
 
     def update(new_plain_content)
@@ -20,7 +27,7 @@ module Lockness
 
       encrypted_content = message_encryptor.encrypt_and_sign(new_plain_content)
 
-      secret_file.save(encrypted_content)
+      encrypted_file.save(encrypted_content)
     end
 
     private

data/lib/lockness/decrypt.rb

@@ -0,0 +1,23 @@
+module Lockness
+  class Decrypt
+
+    attr_reader :encrypted_file
+
+    def initialize(path:)
+      @encrypted_file = EncryptedFile.new(path: path)
+
+      file_not_found unless encrypted_file.exist?
+    end
+
+    def decrypt
+      Content.new(encrypted_file: encrypted_file).plain
+    end
+
+    private
+
+    def file_not_found
+      raise "Could not find the file '#{encrypted_file.path}'"
+    end
+
+  end
+end

data/lib/lockness/edit.rb

@@ -1,26 +1,26 @@
 module Lockness
   class Edit
 
-    attr_reader :secret_file,
+    attr_reader :encrypted_file,
                 :content,
                 :temp_file
 
     def initialize
-      @secret_file = SecretFile.new
-      @content     = Content.new
+      @encrypted_file = EncryptedFile.new(path: PathBuilder.path)
+      @content     = Content.new(encrypted_file: encrypted_file)
       @temp_file   = Tempfile.new
     end
 
     def edit
       ensure_temp_file_deleted
 
-      if secret_file.exist?
+      if encrypted_file.exist?
         edit_existing
       else
         edit_new
       end
 
-      puts "File saved: #{secret_file.encrypted_path}"
+      puts "File saved: #{encrypted_file.encrypted_path}"
     end
 
     private

data/lib/lockness/{secret_file.rb → encrypted_file.rb}

@@ -1,10 +1,10 @@
 module Lockness
-  class SecretFile
+  class EncryptedFile
 
     attr_reader :path
 
-    def initialize
-      @path = build_path
+    def initialize(path:)
+      @path = path
     end
 
     def exist?
@@ -33,17 +33,5 @@ module Lockness
       File.write(encrypted_path, encrypted_content)
     end
 
-    private
-
-    def build_path
-      path_arg = ARGV.last
-
-      if path_arg.starts_with?('/')
-        path_arg
-      else
-        File.join(Dir.pwd, path_arg)
-      end
-    end
-
   end
 end

data/lib/lockness/master_key.rb

@@ -4,7 +4,7 @@ module Lockness
     def read
       ensure_exists
 
-      File.read(path)
+      File.read(path).strip
     end
 
     def generate

data/lib/lockness/path_builder.rb

@@ -0,0 +1,15 @@
+module Lockness
+  module PathBuilder
+
+    def self.path
+      path_arg = ARGV.last
+
+      if path_arg.starts_with?('/')
+        path_arg
+      else
+        File.join(Dir.pwd, path_arg)
+      end
+    end
+
+  end
+end

data/lib/lockness/setup.rb

@@ -0,0 +1,20 @@
+module Lockness
+  module Setup
+
+    def self.setup
+      require 'active_support/all'
+      require 'base64'
+      require 'digest/sha2'
+      require 'openssl'
+      require 'securerandom'
+      require 'tempfile'
+
+      require_relative '../lockness'
+
+      Dir.glob("#{__dir__}/*.rb").each do |file|
+        require_relative file
+      end
+    end
+
+  end
+end

data/lib/lockness/show.rb

@@ -1,21 +1,33 @@
 module Lockness
   class Show
 
-    attr_reader :secret_file
+    attr_reader :encrypted_file
 
     def initialize
-      @secret_file = SecretFile.new
+      @encrypted_file = EncryptedFile.new(path: PathBuilder.path)
     end
 
     def show
-      if secret_file.exist?
-        puts Content.new.plain
+      if encrypted_file.exist?
+        puts Content.new(encrypted_file: encrypted_file).plain
       else
-        puts "No file at #{secret_file.encrypted_path}"
+        puts "No file at #{encrypted_file.encrypted_path}"
 
         exit 1
       end
     end
 
+    private
+
+    def build_path
+      path_arg = ARGV.last
+
+      if path_arg.starts_with?('/')
+        path_arg
+      else
+        File.join(Dir.pwd, path_arg)
+      end
+    end
+
   end
 end

data/lib/lockness/version.rb

@@ -1,5 +1,5 @@
 module Lockness
 
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
 end

data/lib/lockness.rb

@@ -17,4 +17,12 @@ module Lockness
     end
   end
 
+  def self.decrypt(path)
+    Decrypt.new(path: path).decrypt
+  end
+
 end
+
+require "lockness/setup"
+
+Lockness::Setup.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockness
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sean Lerner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-30 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -153,11 +153,14 @@ files:
 - bin/lockness
 - lib/lockness.rb
 - lib/lockness/content.rb
+- lib/lockness/decrypt.rb
 - lib/lockness/edit.rb
+- lib/lockness/encrypted_file.rb
 - lib/lockness/ensure_master_key_git_ignored.rb
 - lib/lockness/help.rb
 - lib/lockness/master_key.rb
-- lib/lockness/secret_file.rb
+- lib/lockness/path_builder.rb
+- lib/lockness/setup.rb
 - lib/lockness/show.rb
 - lib/lockness/version.rb
 - lockness.gemspec
@@ -181,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Manage encrypted secrets