symmetric-encryption 4.1.0.beta1 → 4.1.0

data/test/cipher_test.rb

@@ -93,7 +93,7 @@ class CipherTest < Minitest::Test
                 always_add_header: always_add_header
               )
 
-              h         = @encrypted_values[cipher_name][encoding] if @encrypted_values[cipher_name]
+              h = @encrypted_values[cipher_name][encoding] if @encrypted_values[cipher_name]
               skip "Add @encrypted_values for cipher_name: #{cipher_name} and encoding: #{encoding}, value: #{@cipher.encrypt(@social_security_number).inspect}" unless h
               @social_security_number_encrypted = h[always_add_header ? :header : :no_header]
 
@@ -150,7 +150,7 @@ class CipherTest < Minitest::Test
 
       describe 'with configuration' do
         before do
-          @cipher                 = SymmetricEncryption::Cipher.new(
+          @cipher = SymmetricEncryption::Cipher.new(
             key:         '1234567890ABCDEF',
             iv:          '1234567890ABCDEF',
             cipher_name: 'aes-128-cbc',
@@ -181,7 +181,7 @@ class CipherTest < Minitest::Test
               key.key,
               key.cipher_name
             )
-            header        = SymmetricEncryption::Header.new
+            header = SymmetricEncryption::Header.new
             header.parse(binary_header)
             assert_equal true, header.compressed?
             assert random_cipher = SymmetricEncryption::Cipher.new(iv: key.iv, key: key.key, cipher_name: key.cipher_name)

data/test/header_test.rb

@@ -179,7 +179,7 @@ class CipherTest < Minitest::Test
         end
 
         it 'encrypted string' do
-          header = SymmetricEncryption::Header.new
+          header           = SymmetricEncryption::Header.new
           assert remainder = header.parse!(binary_encrypted_value)
           assert_equal SymmetricEncryption.cipher.version, header.version
           refute header.compressed?

data/test/keystore/aws_test.rb

@@ -13,7 +13,7 @@ module SymmetricEncryption
         end
 
         let :the_test_path do
-          path = "tmp/keystore/aws_test"
+          path = 'tmp/keystore/aws_test'
           FileUtils.makedirs(path) unless ::File.exist?(path)
           path
         end
@@ -72,24 +72,24 @@ module SymmetricEncryption
           end
 
           it 'creates encrypted key file for every region' do
-            assert key_files = key_config[:key_files]
+            assert key_files         = key_config[:key_files]
             common_data_key          = nil
             first_encrypted_data_key = nil
 
-            master_key_alias = "alias/symmetric-encryption/tester/test"
+            master_key_alias = 'alias/symmetric-encryption/tester/test'
 
             key_files.each do |key_file|
-              assert region = key_file[:region]
-              assert file_name = key_file[:file_name]
+              assert region      = key_file[:region]
+              assert file_name   = key_file[:file_name]
               expected_file_name = "#{the_test_path}/tester_test_#{region}_v11.encrypted_key"
 
               assert_equal expected_file_name, file_name
               assert ::File.exist?(file_name)
 
               assert encoded_data_key = ::File.read(file_name)
-              encrypted_data_key = Base64.strict_decode64(encoded_data_key)
+              encrypted_data_key      = Base64.strict_decode64(encoded_data_key)
 
-              aws = SymmetricEncryption::Utils::Aws.new(region: region, master_key_alias: master_key_alias)
+              aws             = SymmetricEncryption::Utils::Aws.new(region: region, master_key_alias: master_key_alias)
               assert data_key = aws.decrypt(encrypted_data_key)
 
               # Verify that the dek is the same in every region, but encrypted with the CMK for that region.

data/test/keystore/file_test.rb

@@ -5,7 +5,7 @@ module SymmetricEncryption
   class FileTest < Minitest::Test
     describe SymmetricEncryption::Keystore::File do
       let :the_test_path do
-        path = "tmp/keystore/file_test"
+        path = 'tmp/keystore/file_test'
         FileUtils.makedirs(path) unless ::File.exist?(path)
         path
       end

data/test/keystore_test.rb

@@ -8,7 +8,7 @@ module SymmetricEncryption
       end
 
       let :the_test_path do
-        path = "tmp/keystore_test"
+        path = 'tmp/keystore_test'
         FileUtils.makedirs(path) unless ::File.exist?(path)
         path
       end
@@ -119,7 +119,7 @@ module SymmetricEncryption
             assert ciphers = key_rotation[env.to_sym][:ciphers], "Environment #{env} is missing ciphers: #{key_rotation[env.to_sym].inspect}"
             assert_equal 2, ciphers.size, "Environment #{env}: #{ciphers.inspect}"
             assert new_config = ciphers.first
-            assert file_name = new_config[:key_filename], "Environment #{env} is missing key_filename: #{ciphers.inspect}"
+            assert file_name  = new_config[:key_filename], "Environment #{env} is missing key_filename: #{ciphers.inspect}"
             assert File.exist?(file_name)
             assert_equal 2, new_config[:version]
           end

data/test/mongoid_test.rb

@@ -85,17 +85,17 @@ begin
           encrypted_social_security_number: @social_security_number_encrypted,
           name:                             'Joe Bloggs',
           # data type specific fields
-          integer_value:         @integer_value,
-          aliased_integer_value: @integer_value,
-          float_value:           @float_value,
-          decimal_value:         @decimal_value,
-          datetime_value:        @datetime_value,
-          time_value:            @time_value,
-          date_value:            @date_value,
-          true_value:            true,
-          false_value:           false,
-          data_yaml:             @h.dup,
-          data_json:             @h.dup
+          integer_value:                    @integer_value,
+          aliased_integer_value:            @integer_value,
+          float_value:                      @float_value,
+          decimal_value:                    @decimal_value,
+          datetime_value:                   @datetime_value,
+          time_value:                       @time_value,
+          date_value:                       @date_value,
+          true_value:                       true,
+          false_value:                      false,
+          data_yaml:                        @h.dup,
+          data_json:                        @h.dup
         )
       end
 
@@ -144,17 +144,17 @@ begin
 
       it 'support same iv' do
         @user.social_security_number = @social_security_number
-        assert first_value = @user.social_security_number
+        assert first_value           = @user.social_security_number
         # Assign the same value
         @user.social_security_number = @social_security_number
         assert_equal first_value, @user.social_security_number
       end
 
       it 'support a random iv' do
-        @user.string = @string
+        @user.string       = @string
         assert first_value = @user.encrypted_string
-        @user.string = 'blah'
-        @user.string = @string.dup
+        @user.string       = 'blah'
+        @user.string       = @string.dup
         refute_equal first_value, @user.encrypted_string
       end
 

data/test/reader_test.rb

@@ -6,7 +6,7 @@ require 'stringio'
 class ReaderTest < Minitest::Test
   describe SymmetricEncryption::Reader do
     before do
-      @data     = [
+      @data = [
         "Hello World\n",
         "Keep this secret\n",
         'And keep going even further and further...'
@@ -17,7 +17,7 @@ class ReaderTest < Minitest::Test
       @cipher                        = SymmetricEncryption.cipher(0)
       @data_encrypted_without_header = @cipher.binary_encrypt(@data_str, header: false)
 
-      header                      = SymmetricEncryption::Header.new(
+      header = SymmetricEncryption::Header.new(
         version:     @cipher.version,
         iv:          @cipher.iv,
         key:         @cipher.send(:key),
@@ -87,7 +87,7 @@ class ReaderTest < Minitest::Test
 
     [
       # No Header
-      {header: false, random_key: false, random_iv: false},
+      {header: false, random_key: false, random_iv: false, compress: false},
       # Default Header with random key and iv
       {},
       # Header with no compression ( default anyway )
@@ -184,6 +184,26 @@ class ReaderTest < Minitest::Test
             end
           end
 
+          it '#read(size, outbuf)' do
+            file = SymmetricEncryption::Reader.open(@file_name)
+            # Not supported with compressed files
+            if file.is_a?(SymmetricEncryption::Reader)
+              eof           = file.eof?
+              output_buffer = 'buffer'
+              data          = file.read(4096, output_buffer)
+              file.close
+
+              assert_equal @eof, eof
+              if @data_size.positive?
+                assert_equal @data_str, data
+                assert_equal data.object_id, output_buffer.object_id
+              else
+                assert_nil data
+                assert_empty output_buffer
+              end
+            end
+          end
+
           it '#each_line' do
             SymmetricEncryption::Reader.open(@file_name) do |file|
               i = 0
@@ -212,9 +232,9 @@ class ReaderTest < Minitest::Test
             assert_equal @eof, eof
             if @data_size.positive?
               assert_equal @data_str, data
+            elsif defined?(JRuby)
               # On JRuby Zlib::GzipReader.new(file) returns '' instead of nil on an empty file
-            elsif defined?(JRuby) && options[:compress] && (usecase == :empty)
-              assert_equal '', data
+              assert data.blank?
             else
               assert_nil data
             end
@@ -222,7 +242,7 @@ class ReaderTest < Minitest::Test
 
           it '#gets(delim)' do
             SymmetricEncryption::Reader.open(@file_name) do |file|
-              i = 0
+              i           = 0
               while (line = file.gets("\n"))
                 assert_equal @data[i], line
                 i += 1
@@ -233,7 +253,7 @@ class ReaderTest < Minitest::Test
 
           it '#gets(delim,size)' do
             SymmetricEncryption::Reader.open(@file_name) do |file|
-              i = 0
+              i  = 0
               i += 1 while file.gets("\n", 128)
               assert_equal (@data_size.positive? ? 3 : 0), i
             end
@@ -284,7 +304,7 @@ class ReaderTest < Minitest::Test
       before do
         @file_name = '_test'
         # Create encrypted file with old encryption key
-        SymmetricEncryption::Writer.open(@file_name, version: 0, header: false, random_key: false, random_iv: false) do |file|
+        SymmetricEncryption::Writer.open(@file_name, version: 0, header: false, random_key: false, random_iv: false, compress: false) do |file|
           @data.inject(0) { |sum, str| sum + file.write(str) }
         end
       end

data/test/symmetric_encryption_test.rb

@@ -6,7 +6,7 @@ class SymmetricEncryptionTest < Minitest::Test
   describe 'SymmetricEncryption' do
     describe 'configuration' do
       before do
-        config   = SymmetricEncryption::Config.new(
+        config = SymmetricEncryption::Config.new(
           file_name: File.join(File.dirname(__FILE__), 'config', 'symmetric-encryption.yml'),
           env:       'test'
         )
@@ -146,7 +146,7 @@ class SymmetricEncryptionTest < Minitest::Test
       before do
         @social_security_number = '987654321'
         # Encrypt data without a header and encode with base64 which has a trailing '\n'
-        no_header = SymmetricEncryption.cipher(0).binary_encrypt(@social_security_number, header: false)
+        no_header               = SymmetricEncryption.cipher(0).binary_encrypt(@social_security_number, header: false)
         assert @encrypted_0_ssn = SymmetricEncryption.cipher(0).encode(no_header)
       end
 

data/test/utils/aws_test.rb

@@ -36,7 +36,7 @@ module SymmetricEncryption
 
         describe '#create_master_key' do
           it 'creates a new master key' do
-            skip "Only run if really needed, gets tested once as part of the CMK auto-create"
+            skip 'Only run if really needed, gets tested once as part of the CMK auto-create'
             aws.delete_master_key(retention_days: 7)
             aws.create_master_key
           end
@@ -68,7 +68,6 @@ module SymmetricEncryption
             assert_equal message, decrypted
           end
         end
-
       end
     end
   end

data/test/writer_test.rb

@@ -6,7 +6,7 @@ require 'stringio'
 class WriterTest < Minitest::Test
   describe SymmetricEncryption::Writer do
     before do
-      @data             = [
+      @data = [
         "Hello World\n",
         "Keep this secret\n",
         'And keep going even further and further...'
@@ -22,55 +22,57 @@ class WriterTest < Minitest::Test
       File.delete(@source_file_name) if File.exist?(@source_file_name)
     end
 
-    describe '#write' do
-      it 'encrypt to string stream' do
-        stream      = StringIO.new
-        file        = SymmetricEncryption::Writer.new(stream)
-        written_len = @data.inject(0) { |sum, str| sum + file.write(str) }
-        assert_equal @data_len, file.size
-        file.close
+    [true, false, nil].each do |compress|
+      describe "compress: #{compress.inspect}" do
+        describe '.open' do
+          it 'encrypt to stream' do
+            written_len = 0
+            stream      = StringIO.new
+            SymmetricEncryption::Writer.open(stream, compress: compress) do |file|
+              written_len = @data.inject(0) { |sum, str| sum + file.write(str) }
+            end
+            size = stream.string.size
+            if compress == false
+              assert @data_len, size
+            else
+              # With small files the compressed file is larger
+              assert size >= @data_len
+            end
+            assert_equal @data_len, written_len
+          end
 
-        assert_equal @data_len, written_len
-        assert_equal @data_str, SymmetricEncryption::Reader.read(StringIO.new(stream.string))
-      end
-    end
-
-    describe '.open' do
-      it 'encrypt to stream' do
-        written_len = 0
-        stream      = StringIO.new
-        SymmetricEncryption::Writer.open(stream) do |file|
-          written_len = @data.inject(0) { |sum, str| sum + file.write(str) }
-          assert_equal @data_len, file.size
-        end
-        assert_equal @data_len, written_len
-      end
-
-      it 'encrypt to file' do
-        written_len = nil
-        SymmetricEncryption::Writer.open(@file_name) do |file|
-          written_len = @data.inject(0) { |sum, str| sum + file.write(str) }
-          assert_equal @data_len, file.size
+          it 'encrypt to file' do
+            written_len = SymmetricEncryption::Writer.open(@file_name, compress: compress) do |file|
+              @data.inject(0) { |sum, str| sum + file.write(str) }
+            end
+            assert_equal @data_len, written_len
+            size = File.size(@file_name)
+            if compress == false
+              assert @data_len, size
+            else
+              # With small files the compressed file is larger
+              assert size >= @data_len
+            end
+            assert_equal @data_str, SymmetricEncryption::Reader.read(@file_name)
+          end
         end
-        assert_equal @data_len, written_len
-        assert_equal @data_str, SymmetricEncryption::Reader.read(@file_name)
-      end
-    end
 
-    describe '.encrypt' do
-      it 'stream' do
-        target_stream = StringIO.new
-        source_stream = StringIO.new(@data_str)
-        source_bytes  = SymmetricEncryption::Writer.encrypt(source: source_stream, target: target_stream)
-        assert_equal @data_len, source_bytes
-        assert_equal @data_str, SymmetricEncryption::Reader.read(StringIO.new(target_stream.string))
-      end
+        describe '.encrypt' do
+          it 'stream' do
+            target_stream = StringIO.new
+            source_stream = StringIO.new(@data_str)
+            source_bytes  = SymmetricEncryption::Writer.encrypt(source: source_stream, target: target_stream, compress: compress)
+            assert_equal @data_len, source_bytes
+            assert_equal @data_str, SymmetricEncryption::Reader.read(StringIO.new(target_stream.string))
+          end
 
-      it 'file' do
-        File.open(@source_file_name, 'wb') { |f| f.write(@data_str) }
-        source_bytes = SymmetricEncryption::Writer.encrypt(source: @source_file_name, target: @file_name)
-        assert_equal @data_len, source_bytes
-        assert_equal @data_str, SymmetricEncryption::Reader.read(@file_name)
+          it 'file' do
+            File.open(@source_file_name, 'wb') { |f| f.write(@data_str) }
+            source_bytes = SymmetricEncryption::Writer.encrypt(source: @source_file_name, target: @file_name, compress: compress)
+            assert_equal @data_len, source_bytes
+            assert_equal @data_str, SymmetricEncryption::Reader.read(@file_name)
+          end
+        end
       end
     end
   end

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: symmetric-encryption
 version: !ruby/object:Gem::Version
-  version: 4.1.0.beta1
+  version: 4.1.0
 platform: ruby
 authors:
 - Reid Morrison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-13 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coercible
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-  type: :runtime
+  name: coercible
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
 - reidmo@gmail.com
 executables:
@@ -95,7 +95,7 @@ homepage: http://rocketjob.github.io/symmetric-encryption/
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,22 +106,33 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Encrypt ActiveRecord and Mongoid attributes, files and passwords in configuration
   files.
 test_files:
+- test/symmetric_encryption_test.rb
+- test/test_db.sqlite3
+- test/mongoid_test.rb
+- test/active_record_test.rb
+- test/keystore_test.rb
+- test/reader_test.rb
+- test/encoder_test.rb
+- test/key_test.rb
+- test/header_test.rb
+- test/test_helper.rb
+- test/writer_test.rb
+- test/cipher_test.rb
 - test/keystore/environment_test.rb
 - test/keystore/file_test.rb
 - test/keystore/heroku_test.rb
 - test/keystore/aws_test.rb
-- test/symmetric_encryption_test.rb
 - test/config/test_secondary_1.key
 - test/config/mongoid.yml
 - test/config/test_new.iv
@@ -131,15 +142,4 @@ test_files:
 - test/config/symmetric-encryption.yml
 - test/config/empty.csv
 - test/config/mongo_mapper.yml
-- test/test_db.sqlite3
-- test/mongoid_test.rb
-- test/active_record_test.rb
-- test/keystore_test.rb
-- test/reader_test.rb
-- test/encoder_test.rb
 - test/utils/aws_test.rb
-- test/key_test.rb
-- test/header_test.rb
-- test/test_helper.rb
-- test/writer_test.rb
-- test/cipher_test.rb