diffcrypt 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e77d7111ad066e219da5f2c20dd2930bdda46641aa477bd3ab03e6194e19695
-  data.tar.gz: 6af61a30f44c3c18ff92e7dac0564fbbb8ea6384740835d15f84c88eb200c9e5
+  metadata.gz: e40a357c62cf93d9c49f336c7ad456d4f7510bd8389f3fb20c4913b91f4ef5f2
+  data.tar.gz: 4fb0296c2eaf901c59bdec117f974203500596f6347a9b8c12632b7dbe39ab77
 SHA512:
-  metadata.gz: 2c28fd4f218a5dafc07074b38f0b7b772b1cbd0eec06fee19a51e3b1f65ef048c8df0fa43ada8a785c166f03e0db21cf0534ff6586c010f916e2f7814a1dec5f
-  data.tar.gz: a8e8130402e6a7aff0eb169a3498a33bc64fe383cd1a85742f4efb18ed2861fbaa335ae30109c9ba30fc298df55fd937f118370a8d58ce41d4c46fcb9ad75b75
+  metadata.gz: d368c674a915b706b876a5a022c7003e3f7ecf30b38b581f2e7debf261d47102d759c27d317b85a71904bace22fd1a0306d9175b2c9496592375d786d3fe4fc1
+  data.tar.gz: 9e24c98075aab9c2f8e0550e757adea3df5b7f1e341f7d93d5644ee21e6a9ee9a352f7450a1a63afd609d876406c6efbe4aaff56e6c978c413259588625eedf5

data/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+## [0.4.0] - 2020-10-01
+
+### Changed
+
+- Encryptor can now use other ciphers than the default
+
+### Dependencies
+
+- simplecov: 0.17.0 -> 0.18.0 (#20)
+- rubocop: 0.88.0 -> 0.92.0 (#24)
+
+
+
 ## [0.3.3] - 2020-07-25
 
 ### Fixed

data/Gemfile

@@ -7,6 +7,6 @@ gemspec
 
 gem 'minitest', '~> 5.0'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 0.88.0'
-gem 'simplecov', '~> 0.17.0', require: false # CodeClimate not compatible with 0.18+ yet - https://github.com/codeclimate/test-reporter/issues/413
+gem 'rubocop', '~> 0.92.0'
+gem 'simplecov', '~> 0.19.0', require: false # CodeClimate not compatible with 0.18+ yet - https://github.com/codeclimate/test-reporter/issues/413
 gem 'simplecov-lcov', '< 0.8'

data/README.md

@@ -36,8 +36,8 @@ There are a few ways to use the library, depending on how advanced your use case
 The easiest way to get started is to use the CLI.
 
 ```shell
-diffcrypt decrypt -k $(cat test/fixtures/master.key) test/fixtures/example.yml.enc
-diffcrypt encrypt -k $(cat test/fixtures/master.key) test/fixtures/example.yml
+diffcrypt decrypt -k $(cat test/fixtures/aes-128-gcm.key) test/fixtures/example.yml.enc
+diffcrypt encrypt -k $(cat test/fixtures/aes-128-gcm.key) test/fixtures/example.yml
 ```
 
 
@@ -69,7 +69,7 @@ the built in encrypter. All existing `rails credentials:edit` also work with thi
 require 'diffcrypt/rails/encrypted_configuration'
 module Rails
   class Application
-    def encrypted(path, key_path: 'config/master.key', env_key: 'RAILS_MASTER_KEY')
+    def encrypted(path, key_path: 'config/aes-128-gcm.key', env_key: 'RAILS_MASTER_KEY')
       Diffcrypt::Rails::EncryptedConfiguration.new(
         config_path: Rails.root.join(path),
         key_path: Rails.root.join(key_path),
@@ -83,6 +83,17 @@ end
 
 
 
+## Converting between ciphers
+
+Sometimes you may want to rotate the cipher used on a file. You cab do this rogramtically using the ruby code above, or you can also chain the CLI commands like so:
+
+```shell
+diffcrypt decrypt -k $(cat test/fixtures/aes-128-gcm.key) test/fixtures/example.yml.enc > test/fixtures/example.128.yml \
+&& diffcrypt encrypt --cipher aes-256-gcm -k $(cat test/fixtures/aes-256-gcm.key) test/fixtures/example.128.yml > test/fixtures/example.256.yml.enc && rm test/fixtures/example.128.yml
+```
+
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/diffcrypt.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(::File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir = 'bin'

data/lib/diffcrypt/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative './encryptor'
+require_relative './file'
 require_relative './version'
 
 module Diffcrypt
@@ -8,21 +9,22 @@ module Diffcrypt
     desc 'decrypt <path>', 'Decrypt a file'
     method_option :key, aliases: %i[k], required: true
     def decrypt(path)
-      ensure_file_exists(path)
-      contents = File.read(path)
-      puts encryptor.decrypt(contents)
+      file = File.new(path)
+      ensure_file_exists(file)
+      say file.decrypt(key)
     end
 
     desc 'encrypt <path>', 'Encrypt a file'
     method_option :key, aliases: %i[k], required: true
+    method_option :cipher, default: Encryptor::DEFAULT_CIPHER
     def encrypt(path)
-      ensure_file_exists(path)
-      contents = File.read(path)
-      puts encryptor.encrypt(contents)
+      file = File.new(path)
+      ensure_file_exists(file)
+      say file.encrypt(key, cipher: options[:cipher])
     end
 
     desc 'generate-key', 'Generate a 32 bit key'
-    method_option :cipher, default: Encryptor::CIPHER
+    method_option :cipher, default: Encryptor::DEFAULT_CIPHER
     def generate_key
       say Encryptor.generate_key(options[:cipher])
     end
@@ -41,8 +43,9 @@ module Diffcrypt
         @encryptor ||= Encryptor.new(key)
       end
 
-      def ensure_file_exists(path)
-        abort('[ERROR] File does not exist') unless File.exist?(path)
+      # @param [Diffcrypt::File] path
+      def ensure_file_exists(file)
+        abort('[ERROR] File does not exist') unless file.exists?
       end
 
       def self.exit_on_failure?

data/lib/diffcrypt/encryptor.rb

@@ -12,15 +12,16 @@ require_relative './version'
 
 module Diffcrypt
   class Encryptor
-    CIPHER = 'aes-128-gcm'
+    DEFAULT_CIPHER = 'aes-128-gcm'
 
-    def self.generate_key(cipher = CIPHER)
+    def self.generate_key(cipher = DEFAULT_CIPHER)
       SecureRandom.hex(ActiveSupport::MessageEncryptor.key_len(cipher))
     end
 
-    def initialize(key)
+    def initialize(key, cipher: DEFAULT_CIPHER)
       @key = key
-      @encryptor ||= ActiveSupport::MessageEncryptor.new([key].pack('H*'), cipher: CIPHER)
+      @cipher = cipher
+      @encryptor ||= ActiveSupport::MessageEncryptor.new([key].pack('H*'), cipher: cipher)
     end
 
     # @param [String] contents The raw YAML string to be encrypted
@@ -50,7 +51,7 @@ module Diffcrypt
       data = encrypt_data contents, original_encrypted_contents
       YAML.dump(
         'client' => "diffcrypt-#{Diffcrypt::VERSION}",
-        'cipher' => CIPHER,
+        'cipher' => @cipher,
         'data' => data,
       )
     end

data/lib/diffcrypt/file.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative './encryptor'
+
+module Diffcrypt
+  class File
+    attr_reader :file
+
+    def initialize(path)
+      @path = ::File.absolute_path path
+    end
+
+    def encrypted?
+      to_yaml['cipher']
+    end
+
+    def cipher
+      to_yaml['cipher'] || Encryptor::DEFAULT_CIPHER
+    end
+
+    # @return [Boolean]
+    def exists?
+      ::File.exist?(@path)
+    end
+
+    # @return [String] Raw contents of the file
+    def read
+      @read ||= ::File.read(@path)
+    end
+
+    def encrypt(key, cipher: DEFAULT_CIPHER)
+      return read if encrypted?
+
+      Encryptor.new(key, cipher: cipher).encrypt(read)
+    end
+
+    # TODO: Add a test to verify this does descrypt properly
+    def decrypt(key)
+      return read unless encrypted?
+
+      Encryptor.new(key, cipher: cipher).decrypt(read)
+    end
+
+    def to_yaml
+      @to_yaml ||= YAML.safe_load(read)
+    end
+  end
+end

data/lib/diffcrypt/rails/encrypted_configuration.rb

@@ -9,6 +9,8 @@ require 'active_support/core_ext/hash'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/inclusion'
 
+require 'diffcrypt/file'
+
 module Diffcrypt
   module Rails
     class EncryptedConfiguration
@@ -21,13 +23,13 @@ module Diffcrypt
       delegate_missing_to :options
 
       def initialize(config_path:, key_path:, env_key:, raise_if_missing_key:)
-        @content_path = Pathname.new(File.absolute_path(config_path)).yield_self do |path|
+        @content_path = Pathname.new(::File.absolute_path(config_path)).yield_self do |path|
           path.symlink? ? path.realpath : path
         end
+        @diffcrypt_file = Diffcrypt::File.new(@content_path)
         @key_path = Pathname.new(key_path)
         @env_key = env_key
         @raise_if_missing_key = raise_if_missing_key
-        @active_support_encryptor = ActiveSupport::MessageEncryptor.new([key].pack('H*'), cipher: Encryptor::CIPHER)
       end
 
       # Determines if file is using the diffable format, or still
@@ -73,7 +75,7 @@ module Diffcrypt
       # rubocop:disable Metrics/AbcSize
       def writing(contents)
         tmp_file = "#{Process.pid}.#{content_path.basename.to_s.chomp('.enc')}"
-        tmp_path = Pathname.new File.join(Dir.tmpdir, tmp_file)
+        tmp_path = Pathname.new ::File.join(Dir.tmpdir, tmp_file)
         tmp_path.binwrite contents
 
         yield tmp_path
@@ -103,9 +105,18 @@ module Diffcrypt
         end
       end
 
+      # Rails applications with an existing credentials file, the inbuilt active support encryptor should be used
+      # @return [ActiveSupport::MessageEncryptor]
+      def active_support_encryptor
+        @active_support_encryptor = ActiveSupport::MessageEncryptor.new(
+          [key].pack('H*'),
+          cipher: @diffcrypt_file.cipher,
+        )
+      end
+
       # @return [Encryptor]
       def encryptor
-        @encryptor ||= Encryptor.new key
+        @encryptor ||= Encryptor.new key, cipher: @diffcrypt_file.cipher
       end
 
       def read_env_key

data/lib/diffcrypt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diffcrypt
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffcrypt
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Marc Qualie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,8 +70,10 @@ files:
 - lib/diffcrypt.rb
 - lib/diffcrypt/cli.rb
 - lib/diffcrypt/encryptor.rb
+- lib/diffcrypt/file.rb
 - lib/diffcrypt/rails/encrypted_configuration.rb
 - lib/diffcrypt/version.rb
+- tmp/.keep
 homepage: https://github.com/marcqualie/diffcrypt
 licenses:
 - MIT
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Diffable encrypted configuration files