diffcrypt 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edd41bfcd4f86767e1d8b98d4c161c38983962e273a6e5b486c0f6465f159d80
-  data.tar.gz: fecb2bda4f1f7cbd53fea2fd333f723bd3c1ac9e8c206930c6783795a6260d10
+  metadata.gz: e40a357c62cf93d9c49f336c7ad456d4f7510bd8389f3fb20c4913b91f4ef5f2
+  data.tar.gz: 4fb0296c2eaf901c59bdec117f974203500596f6347a9b8c12632b7dbe39ab77
 SHA512:
-  metadata.gz: 7fe1aedc3eec0f98370479a8a813e15a9458213e70d49345ae90234cead04e47b880a602af54ff8d43a1a6e4d54e7bef4a2955eb3f88fde68762bb08de16a555
-  data.tar.gz: 6a020043e24b13d22414de6f810bde69bb578adc0041d34e33c8f3d220d68903ed8b3726bc7302138fbdc00ebfe8c2e7a59bca4e776519a3d898fc4cd4d51845
+  metadata.gz: d368c674a915b706b876a5a022c7003e3f7ecf30b38b581f2e7debf261d47102d759c27d317b85a71904bace22fd1a0306d9175b2c9496592375d786d3fe4fc1
+  data.tar.gz: 9e24c98075aab9c2f8e0550e757adea3df5b7f1e341f7d93d5644ee21e6a9ee9a352f7450a1a63afd609d876406c6efbe4aaff56e6c978c413259588625eedf5

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

@@ -0,0 +1,95 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+
+## [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
+
+- CLI: Use diffcrypt from command line of any project without requiring ruby integration
+- CLI: `diffcrypt encrypt` Directly encrypt any file and output the contents
+- CLI: `diffcrypt decrypt` Directly decrypt any file and output the contents
+
+
+
+## [0.2.0] - 2020-06-28
+
+### Added
+
+- Store client, cipher and checksum in file metadata
+
+### Fixed
+
+- Only attenpt to decrypt original content if it exists
+
+
+
+## [0.1.1] - 2020-06-28
+
+### Fixed
+
+- Converting rails native credentials files would fail on first run
+
+
+
+## [0.1.0] - 2020-06-28
+
+### Added
+
+- First release!
+- Rails support via monkey patch

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

@@ -1,5 +1,9 @@
 # Diffcrypt
 
+[![Gem Version](https://badge.fury.io/rb/diffcrypt.svg)](https://rubygems.org/gems/diffcrypt)
+[![CircleCI](https://circleci.com/gh/marcqualie/diffcrypt.svg?style=svg)](https://circleci.com/gh/marcqualie/diffcrypt)
+
+
 Diffable encrypted files that you can safely commit into your repo.
 
 
@@ -16,7 +20,7 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+Or install it globally (to use the CLI from any project):
 
     $ gem install diffcrypt
 
@@ -24,8 +28,24 @@ Or install it yourself as:
 
 ## Usage
 
+There are a few ways to use the library, depending on how advanced your use case is.
+
+
+### CLI
+
+The easiest way to get started is to use the CLI.
+
+```shell
+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
+```
+
+
+### Ruby
 
-### Encrypt existing file
+A direct API is exposed so `Diffcrypt::Encryptor` can be used in any ruby project.
+
+**NOTE:** This API may change any time until v1.0
 
 ```ruby
 encryptor = Diffcrypt::Encryptor.new('99e1f86b9e61f24c56ff4108dd415091')
@@ -34,24 +54,22 @@ encrypted = encryptor.encrypt(yaml)
 File.write('tmp/example.yml.enc', encrypted)
 ```
 
-### Decrypt a file
-
 ```ruby
 encryptor = Diffcrypt::Encryptor.new('99e1f86b9e61f24c56ff4108dd415091')
 yaml = File.read('test/fixtures/example.yml.enc')
 config = YAML.safe_load(encryptor.decrypt(yaml))
 ```
 
-### Rails
+### Ruby on Rails
 
 Currently there is not native support for rails, but ActiveSupport can be monkeypatched to override
-the built in encrypter.
+the built in encrypter. All existing `rails credentials:edit` also work with this method.
 
 ```ruby
 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),
@@ -65,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/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/bin/diffcrypt

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'thor'
+
+require_relative '../lib/diffcrypt/cli'
+
+Diffcrypt::CLI.start(ARGV)

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,12 +22,13 @@ 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 = 'exe'
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'bin'
+  spec.executables = %w[diffcrypt]
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activesupport', '~> 6.0.0'
+  spec.add_runtime_dependency 'thor', '>= 0.20', '< 2'
 end

data/lib/diffcrypt/cli.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative './encryptor'
+require_relative './file'
+require_relative './version'
+
+module Diffcrypt
+  class CLI < Thor
+    desc 'decrypt <path>', 'Decrypt a file'
+    method_option :key, aliases: %i[k], required: true
+    def decrypt(path)
+      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)
+      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'
+    def version
+      say Diffcrypt::VERSION
+    end
+
+    no_commands do
+      def key
+        options[:key]
+      end
+
+      def encryptor
+        @encryptor ||= Encryptor.new(key)
+      end
+
+      # @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
+end

data/lib/diffcrypt/encryptor.rb

@@ -8,17 +8,20 @@ require 'yaml'
 
 require 'active_support/message_encryptor'
 
+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
@@ -48,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
 
@@ -102,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.2.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffcrypt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marc Qualie
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,11 +24,32 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        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: '2'
 description: Diffable encrypted configuration files that can be safely committed into
   a git repository
 email:
 - marc@marcqualie.com
-executables: []
+executables:
+- diffcrypt
 extensions: []
 extra_rdoc_files: []
 files:
@@ -36,17 +57,23 @@ files:
 - ".github/dependabot.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - bin/console
+- bin/diffcrypt
 - bin/setup
 - diffcrypt.gemspec
 - 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
@@ -61,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:
   - - ">="