diffcrypt 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6055430f063cb4f1c161ca44b65e2d3a0a15d134546152c2e9e0b39486737f08
-  data.tar.gz: 4332842bbef701c1b775e1de410391f07e5bf477318727e0412afb29d0ba00a5
+  metadata.gz: e6d985bd619146b0cede42746b62e00f7e52a01a92a8e7a79718ab0f9b80391a
+  data.tar.gz: d0fb2659741c498608421b741b4fa1acfbdec8f74bc7ac65425a9c97017a9342
 SHA512:
-  metadata.gz: 5d9b0a443e3d2521ba45385a57522d289fad5c9fa88707e5d6272ac0b23dcc4ee8dee9fc6c1831794468399917dccf95747ab0ac5c391c40ebcb991bbc7ebb22
-  data.tar.gz: '038974890091043cec270fb775b94705522445c1185fe07856d5558cbb970d96cfc86dfedfba8081f83a6ccc593e863b32df08f59a3916dc0a1c6e1fa4ceaf45'
+  metadata.gz: 2ba3e972200d1a4d785a9f4bdc67defc04e26d94d35421f9cc2b8a9e956b56f693e452acf0fbbb98ea7f96eb3fc6454e92dbb7d3fa825a6dc16f2882f86b12c6
+  data.tar.gz: d1e7c88b0a323ecb366e2a9642b45c8b60701c1492d97615773d7c12e5fe5753086b440d9bd1ccc19662ca3cb9f67de6c64e90000229ee64df73d619cc0f70f4

data/.circleci/config.yml

@@ -4,8 +4,23 @@ jobs:
   build:
     docker:
       - image: circleci/ruby:2.6.6
+    working_directory: /mnt/ramdisk
     steps:
       - checkout
       - run: bundle install
-      - run: bundle exec rake test
-      - run: bundle exec rubocop
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            # download test reporter as a static binary
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+      - run:
+          name: rake test
+          command: |
+            ./cc-test-reporter before-build
+            bundle exec rake test
+            ./cc-test-reporter after-build --coverage-input-type lcov --exit-code $?
+      - run:
+          name: rubocop
+          command: bundle exec rubocop
+          when: always

data/.rubocop.yml

@@ -9,8 +9,12 @@ Style/Documentation:
 Metrics/MethodLength:
   Exclude:
     - test/**/*_test.rb
+TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: consistent_comma
+Style/AccessorGrouping:
+  EnforcedStyle: separated
 
 Layout/LineLength:
   Exclude:

data/CHANGELOG.md

@@ -7,6 +7,64 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+## [0.4.1] - 2020-10-06
+
+### Fixed
+
+- Could not initialize a new file or modify existing rails format file (Thanks @swiknaba #31)
+
+
+
+## [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
+
+- Explicit FileUtils require to avoid potentially warning logs
+
+
+
+## [0.3.2] - 2020-07-20
+
+### Added
+
+- CLI: `diffcrypt generate-key` command to generate a new key for a cipher
+- Internal: Library now generates and publishes code coverage publically on Code Climate
+
+### Changed
+
+- Only support ruby 2.5+ since 2.4 is no longer maintained
+
+### Removed
+
+- No longer generate and store a checksum. Backwards compatible since it wasn't used
+
+
+
+## [0.3.1] - 2020-07-08
+
+### Fixed
+
+- Thor deprecation error no longer shows on CLI failure
+
+### Changed
+
+- Thor 0.20+ can now be used alongside this gem
+
+
+
 ## [0.3.0] - 2020-06-30
 
 ## Added

data/Gemfile

@@ -7,4 +7,6 @@ gemspec
 
 gem 'minitest', '~> 5.0'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 0.86'
+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 can do this programmatically 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/SECURITY.md

@@ -0,0 +1,17 @@
+# Security Policy
+
+
+
+## Supported Versions
+
+Since the internal APIs may change dramatically until v1.0, here is a list of the versions that are supported.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.3.x   | :white_check_mark: |
+
+
+
+## Reporting a Vulnerability
+
+Please email security@marcqualie.com to report any security issues.

data/diffcrypt.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Diffable encrypted configuration files that can be safely committed into a git repository'
   spec.homepage      = 'https://github.com/marcqualie/diffcrypt'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
@@ -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'
@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activesupport', '~> 6.0.0'
-  spec.add_runtime_dependency 'thor', '~> 1.0.1'
+  spec.add_runtime_dependency 'thor', '>= 0.20', '< 2'
 end

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,17 +9,24 @@ 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::DEFAULT_CIPHER
+    def generate_key
+      say Encryptor.generate_key(options[:cipher])
     end
 
     desc 'version', 'Show client version'
@@ -35,8 +43,13 @@ 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?
+        true
       end
     end
   end

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
-      SecureRandom.hex(ActiveSupport::MessageEncryptor.key_len(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,8 +51,7 @@ module Diffcrypt
       data = encrypt_data contents, original_encrypted_contents
       YAML.dump(
         'client' => "diffcrypt-#{Diffcrypt::VERSION}",
-        'cipher' => CIPHER,
-        'checksum' => Digest::MD5.hexdigest(Marshal.dump(data)),
+        '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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'fileutils'
 require 'pathname'
 require 'tmpdir'
 
@@ -8,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
@@ -20,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
@@ -50,7 +53,7 @@ module Diffcrypt
         deserialize(contents)
 
         IO.binwrite "#{content_path}.tmp", encrypt(contents, original_encrypted_contents)
-        FileUtils.mv "#{content_path}.tmp", content_path
+        ::FileUtils.mv "#{content_path}.tmp", content_path
       end
 
       def config
@@ -72,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
@@ -81,7 +84,7 @@ module Diffcrypt
 
         write(updated_contents, content_path_diffable? && content_path.binread)
       ensure
-        FileUtils.rm(tmp_path) if tmp_path&.exist?
+        ::FileUtils.rm(tmp_path) if tmp_path&.exist?
       end
       # rubocop:enable Metrics/AbcSize
 
@@ -96,15 +99,24 @@ module Diffcrypt
       # @return [String]
       def decrypt(contents)
         if contents.index('---').nil?
-          @active_support_encryptor.decrypt_and_verify contents
+          active_support_encryptor.decrypt_and_verify contents
         else
           encryptor.decrypt contents
         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.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffcrypt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Marc Qualie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,22 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2'
 description: Diffable encrypted configuration files that can be safely committed into
   a git repository
 email:
@@ -56,6 +62,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/diffcrypt
 - bin/setup
@@ -63,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
@@ -79,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="