diffcrypt 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6d985bd619146b0cede42746b62e00f7e52a01a92a8e7a79718ab0f9b80391a
-  data.tar.gz: d0fb2659741c498608421b741b4fa1acfbdec8f74bc7ac65425a9c97017a9342
+  metadata.gz: dacd30e3ddee50fd84847385d2cd4161645b71b1cda79566557dff60e1f15108
+  data.tar.gz: 648e5cf57c6b909cf84196ded1643aa41baf776b8428862d57804d6465ebb3f0
 SHA512:
-  metadata.gz: 2ba3e972200d1a4d785a9f4bdc67defc04e26d94d35421f9cc2b8a9e956b56f693e452acf0fbbb98ea7f96eb3fc6454e92dbb7d3fa825a6dc16f2882f86b12c6
-  data.tar.gz: d1e7c88b0a323ecb366e2a9642b45c8b60701c1492d97615773d7c12e5fe5753086b440d9bd1ccc19662ca3cb9f67de6c64e90000229ee64df73d619cc0f70f4
+  metadata.gz: 8c20572e67d7416fd2fac81556eadba73555959273f7ac900a2d05c82c4799135edb9940a69659eca121cddfee4dd99b3a1b94e7b5effeeea491677ae638b2b7
+  data.tar.gz: 7e8fe375714cdfcb730792285f648a8a7f1164fe9015b42ee06a0a592b065a576a4059ba0d338f9ec79a0749b087d186c73e1d5ba89c6cecaebb4123490eabdf

data/.circleci/config.yml

@@ -1,13 +1,39 @@
 version: 2.1
 
 jobs:
-  build:
+  bundle:
     docker:
-      - image: circleci/ruby:2.6.6
+      - image: circleci/ruby:2.7.1
     working_directory: /mnt/ramdisk
     steps:
       - checkout
-      - run: bundle install
+      - restore_cache:
+          keys:
+            - bundler-{{ checksum "diffcrypt.gemspec" }}-{{ .Environment.CACHE_VERSION }}
+      - run:
+          name: bundle install
+          command: |
+            gem install bundler -v '2.1.4'
+            bundle install --path=vendor/bundle --jobs=4 --retry=3
+      - save_cache:
+          key: bundler-{{ checksum "diffcrypt.gemspec" }}-{{ .Environment.CACHE_VERSION }}
+          paths:
+            - vendor/bundle
+
+  test:
+    docker:
+      - image: circleci/ruby:2.7.1
+    working_directory: /mnt/ramdisk
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - bundler-{{ checksum "diffcrypt.gemspec" }}-{{ .Environment.CACHE_VERSION }}
+      - run:
+          name: bundle install
+          command: |
+            gem install bundler -v '2.1.4'
+            bundle install --path=vendor/bundle --jobs=4 --retry=3
       - run:
           name: Setup Code Climate test-reporter
           command: |
@@ -20,7 +46,33 @@ jobs:
             ./cc-test-reporter before-build
             bundle exec rake test
             ./cc-test-reporter after-build --coverage-input-type lcov --exit-code $?
+  rubocop:
+    docker:
+      - image: circleci/ruby:2.7.1
+    working_directory: /mnt/ramdisk
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - bundler-{{ checksum "diffcrypt.gemspec" }}-{{ .Environment.CACHE_VERSION }}
+      - run:
+          name: bundle install
+          command: |
+            gem install bundler -v '2.1.4'
+            bundle install --path=vendor/bundle --jobs=4 --retry=3
       - run:
           name: rubocop
           command: bundle exec rubocop
           when: always
+
+workflows:
+  version: 2
+  all:
+    jobs:
+      - bundle
+      - test:
+          requires:
+            - bundle
+      - rubocop:
+          requires:
+            - bundle

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.6
 
 Style/ClassAndModuleChildren:
   Exclude:
@@ -9,10 +10,12 @@ Style/Documentation:
 Metrics/MethodLength:
   Exclude:
     - test/**/*_test.rb
-TrailingCommaInArrayLiteral:
+Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
 Style/AccessorGrouping:
   EnforcedStyle: separated
 

data/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+## [0.5.0] - 2020-12-06
+
+### Added
+
+- `Diffcrypt::Rails::ApplicationHelper` to simplify integration
+- `rake diffcrypt:init` command to help setup credentials
+
+### Changed
+
+- Default cipher is now `aes-265-gcm`
+- YAML keys are now sorted
+- Improved support for rails native `aes-128-gcm` cipher
+- Improved test coverage for differing ciphers
+
+
+
 ## [0.4.1] - 2020-10-06
 
 ### Fixed

data/Gemfile

@@ -7,6 +7,6 @@ gemspec
 
 gem 'minitest', '~> 5.0'
 gem 'rake', '~> 13.0'
-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 'rubocop', '~> 1.5.2'
+gem 'simplecov', '~> 0.20.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

@@ -66,17 +66,10 @@ Currently there is not native support for rails, but ActiveSupport can be monkey
 the built in encrypter. All existing `rails credentials:edit` also work with this method.
 
 ```ruby
-require 'diffcrypt/rails/encrypted_configuration'
+# config/application.rb
 module Rails
   class Application
-    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),
-        env_key: env_key,
-        raise_if_missing_key: config.require_master_key,
-      )
-    end
+    include Diffcrypt::Rails::ApplicationHelper
   end
 end
 ```

data/Rakefile

@@ -8,5 +8,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
-
 task default: :test
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/lib/diffcrypt/tasks/**/*.rake").sort.each { |f| load f }

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.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 

data/lib/diffcrypt.rb

@@ -2,6 +2,7 @@
 
 require 'diffcrypt/encryptor'
 require 'diffcrypt/version'
+require 'diffcrypt/railtie' if defined?(Rails)
 
 module Diffcrypt
   class Error < StandardError; end

data/lib/diffcrypt/encryptor.rb

@@ -12,7 +12,7 @@ require_relative './version'
 
 module Diffcrypt
   class Encryptor
-    DEFAULT_CIPHER = 'aes-128-gcm'
+    DEFAULT_CIPHER = 'aes-256-gcm'
 
     def self.generate_key(cipher = DEFAULT_CIPHER)
       SecureRandom.hex(ActiveSupport::MessageEncryptor.key_len(cipher))
@@ -47,11 +47,11 @@ module Diffcrypt
     # @param [String] contents The raw YAML string to be encrypted
     # @param [String, nil] original_encrypted_contents The original (encrypted) content to determine which keys have changed
     # @return [String]
-    def encrypt(contents, original_encrypted_contents = nil)
+    def encrypt(contents, original_encrypted_contents = nil, cipher: nil)
       data = encrypt_data contents, original_encrypted_contents
       YAML.dump(
         'client' => "diffcrypt-#{Diffcrypt::VERSION}",
-        'cipher' => @cipher,
+        'cipher' => cipher || @cipher,
         'data' => data,
       )
     end
@@ -86,7 +86,7 @@ module Diffcrypt
                       key_changed ? encrypt_string(value) : original_encrypted_value
                     end
       end
-      data
+      data.sort.to_h
     end
     # rubocop:enable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity
 

data/lib/diffcrypt/file.rb

@@ -14,7 +14,10 @@ module Diffcrypt
       to_yaml['cipher']
     end
 
+    # Determines the cipher to use for encryption/decryption
     def cipher
+      return 'aes-128-gcm' if format == 'activesupport'
+
       to_yaml['cipher'] || Encryptor::DEFAULT_CIPHER
     end
 
@@ -23,11 +26,33 @@ module Diffcrypt
       ::File.exist?(@path)
     end
 
+    # Determines the format to be used for encryption
+    # @return [String] diffcrypt|activesupport
+    def format
+      return 'diffcrypt' if read == ''
+      return 'diffcrypt' if read.index('---')&.zero?
+
+      'activesupport'
+    end
+
     # @return [String] Raw contents of the file
     def read
+      return '' unless ::File.exist?(@path)
+
       @read ||= ::File.read(@path)
+      @read
+    end
+
+    # Save the encrypted contents back to disk
+    # @return [Boolean] True is file save was successful
+    def write(key, data, cipher: nil)
+      cipher ||= self.cipher
+      yaml = ::YAML.dump(data)
+      contents = Encryptor.new(key, cipher: cipher).encrypt(yaml)
+      ::File.write(@path, contents)
     end
 
+    # TODO: This seems useless, figure out what's up
     def encrypt(key, cipher: DEFAULT_CIPHER)
       return read if encrypted?
 
@@ -42,7 +67,7 @@ module Diffcrypt
     end
 
     def to_yaml
-      @to_yaml ||= YAML.safe_load(read)
+      @to_yaml ||= YAML.safe_load(read) || {}
     end
   end
 end

data/lib/diffcrypt/rails/application_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative './encrypted_configuration'
+
+module Diffcrypt
+  module Rails
+    module ApplicationHelper
+      def encrypted(path, key_path: 'config/master.key', env_key: 'RAILS_MASTER_KEY')
+        config_path, key_path = resolve_encrypted_paths(path, key_path)
+
+        Diffcrypt::Rails::EncryptedConfiguration.new(
+          config_path: config_path,
+          key_path: key_path,
+          env_key: env_key,
+          raise_if_missing_key: config.require_master_key,
+        )
+      end
+
+      protected
+
+      def resolve_encrypted_paths(config_path, key_path)
+        config_path_abs = ::Rails.root.join(config_path)
+        key_path_abs = ::Rails.root.join(key_path)
+
+        # We always want to use `config/credentials/[environment]` for consistency
+        # If the master credentials do not exist, and a user has not specificed an environment, default to development
+        if config_path == 'config/credentials.yml.enc' && ::File.exist?(config_path_abs.to_s) == false
+          config_path_abs = ::Rails.root.join('config/credentials/development.yml.enc')
+          key_path_abs = ::Rails.root.join('config/credentials/development.key')
+        end
+
+        [
+          config_path_abs,
+          key_path_abs,
+        ]
+      end
+    end
+  end
+end

data/lib/diffcrypt/rails/encrypted_configuration.rb

@@ -88,6 +88,13 @@ module Diffcrypt
       end
       # rubocop:enable Metrics/AbcSize
 
+      # Standard rails credentials encrypt the entire file. We need to detect this to use the correct
+      # data interface
+      # @return [Boolean]
+      def rails_native_credentials?(contents)
+        contents.index('---').nil?
+      end
+
       # @param [String] contents The new content to be encrypted
       # @param [String] diff_against The original (encrypted) content to determine which keys have changed
       # @return [String] Encrypted content to commit
@@ -98,7 +105,7 @@ module Diffcrypt
       # @param [String] contents
       # @return [String]
       def decrypt(contents)
-        if contents.index('---').nil?
+        if rails_native_credentials?(contents)
           active_support_encryptor.decrypt_and_verify contents
         else
           encryptor.decrypt contents
@@ -110,7 +117,7 @@ module Diffcrypt
       def active_support_encryptor
         @active_support_encryptor ||= ActiveSupport::MessageEncryptor.new(
           [key].pack('H*'),
-          cipher: @diffcrypt_file.cipher,
+          cipher: 'aes-128-gcm',
         )
       end
 

data/lib/diffcrypt/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'diffcrypt/rails/application_helper'
+
+module Diffcrypt
+  class Railtie < ::Rails::Railtie
+    railtie_name :diffcrypt
+
+    rake_tasks do
+      path = ::File.expand_path(__dir__)
+      ::Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/diffcrypt/tasks/rails.rake

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+namespace :diffcrypt do
+  desc 'Initialize credentials for all environments'
+  task :init, %i[environments] do |_t, args|
+    args.with_defaults(
+      environments: 'development,test,staging,production',
+    )
+    environments = args.environments.split(',')
+
+    environments.each do |environment|
+      key_path = Rails.root.join('config', 'credentials', "#{environment}.key")
+      file_path = Rails.root.join('config', 'credentials', "#{environment}.yml.enc")
+      gitignore_path = Rails.root.join('.gitignore')
+      next if File.exist?(file_path) || File.exist?(key_path)
+
+      # Generate a new key
+      key = Diffcrypt::Encryptor.generate_key
+      key_dir = File.dirname(key_path)
+      Dir.mkdir(key_dir) unless Dir.exist?(key_dir)
+      ::File.write(key_path, key)
+
+      # Encrypt default contents
+      file = Diffcrypt::File.new(file_path)
+      data = {
+        'secret_key_base' => SecureRandom.hex(32),
+      }
+      file.write(key, data)
+
+      # Ensure .key files are always ignored
+      ::File.open(gitignore_path, 'a') do |f|
+        f.write("\nconfig/credentials/*.key")
+      end
+    end
+  end
+end

data/lib/diffcrypt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffcrypt
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Marc Qualie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -71,7 +71,10 @@ files:
 - lib/diffcrypt/cli.rb
 - lib/diffcrypt/encryptor.rb
 - lib/diffcrypt/file.rb
+- lib/diffcrypt/rails/application_helper.rb
 - lib/diffcrypt/rails/encrypted_configuration.rb
+- lib/diffcrypt/railtie.rb
+- lib/diffcrypt/tasks/rails.rake
 - lib/diffcrypt/version.rb
 - tmp/.keep
 homepage: https://github.com/marcqualie/diffcrypt
@@ -88,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="