hash_redactor 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1475a0799bf0c7185a9c8e00d68258518bfe98af
-  data.tar.gz: 3f15bda52a73b7ef212dcc9b47196ca86adf0979
+  metadata.gz: eca69bf2b5f130a0afe3ef33193d4ed55c98ca48
+  data.tar.gz: f7e4edb6b92df00dda255708107ee0de3a0de30d
 SHA512:
-  metadata.gz: c632a1359f36fe0e9595397c7cd4e00210ecd9bb860e6ece61b7ceb6b2a39759d48add5c0ce7a1b67d00565305bc2f28ecb49ff1d5e62092e4f6b2b716e3a38c
-  data.tar.gz: ac247318fd969ac4fddeb6d1993590847c2d6a83aec9e980a9d1326d4a84e6bb4aa5ad5e923f62353f89a749d68c670db2c7b14bcd4a4341c8b8d7f25321b227
+  metadata.gz: 0893ea5ff0f2b8baa7d5e3d68a46ef5c526a21e696d0c57efd99fda7087e68235f7b5a801ca096c1ed1e3703d870d82b8706d8c22af9f5774596dd7c75f02ccd
+  data.tar.gz: c713797930216d03b2a137f021782194a42b19cb34c3d60e37eaf125795b9da4753831d8e4b44f22cb59adc56408a4036b87b2383f317607572a2ad86ffe4d35

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # hash_redactor #
 
+## 0.3.1 ##
+* Fixed: nil values caused encryption to fail
+* Added: digest_empty to improve performance on empty strings
+* Changed: Improved performance when encrypt is passed an empty string
+
 ##0.3.0 ##
 * Added: Whitelist mode (@chrisjensen)
 * Fixed: redact + decrypt loop specs should check result is not empty (@chrisjensen)

data/README.md

@@ -123,7 +123,8 @@ Default options are:
 		  encode:            true,
 		  encode_iv:         true,
 		  default_encoding:  'm',
-		  filter_mode:		 :blacklist
+		  filter_mode:		 :blacklist,
+		  digest_empty:		 true
 ```
 
 ### :digest_salt
@@ -185,6 +186,25 @@ result[:age]				# nil (because it wasn't explicitly whitelisted)
 *Note:* To prevent accidental deletion of digest information during repeated loading and unloading data, the digest of all values is implicitly assumed to be :keep.
 eg If your redact hash includes `:email => :digest`, it is assumed to also contain `:email_digest => :keep`
 
+### digest_empty
+Determines if the empty string or nil should be digested, defaults to true for backwards compatibility.
+
+```
+data = { empty: '', not_a_thing: nil }
+
+redactor = HashRedactor::HashRedactor.new({
+	:empty => :digest, :not_a_thing => :digest
+})
+
+result = redactor.redact(data)
+result[:empty_digest] 			# some digest
+result[:not_a_thing_digest] 	# some digest
+
+redactor.redact(data, digest_empty: false)
+result[:empty_digest] 			# ''
+result[:not_a_thing_digest] 	# nil
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/hash_redactor/hash_redactor.rb

@@ -18,7 +18,8 @@ module HashRedactor
 		  encode:            true,
 		  encode_iv:         true,
 		  default_encoding:  'm',
-		  filter_mode:		 :blacklist
+		  filter_mode:		 :blacklist,
+		  digest_empty:		 true
   	  	}
   	  end
   	  
@@ -78,8 +79,13 @@ module HashRedactor
 	  def digest(hash, hash_key, options)
 	    dig_key = digest_key hash_key
 	  
-		hash[dig_key] = Digest::SHA256.base64digest(
-									hash[hash_key].to_s + options[:digest_salt])
+	  	# Don't digest the value if the user wants empty values to be untouched
+	  	if ((hash[hash_key].to_s != '') || options[:digest_empty]) 
+			hash[dig_key] = Digest::SHA256.base64digest(
+										hash[hash_key].to_s + options[:digest_salt])
+		else
+			hash[dig_key] = hash[hash_key]
+		end
 	  end
 	  
 	  def encrypt(hash, hash_key, options)
@@ -92,15 +98,21 @@ module HashRedactor
 			data_key = data_key.to_sym
 			iv_key = iv_key.to_sym
 		end
-	
-		crypt_key = options[:encryption_key]
-		iv = SecureRandom.random_bytes(12)
+
+		# Don't try to encrypt nil
+		if hash[hash_key].nil?
+		    encrypted_value = nil
+		    iv = nil
+		else
+			crypt_key = options[:encryption_key]
+			iv = SecureRandom.random_bytes(12)
 		
-		encrypted_value = EncryptorInterface.encrypt(:data,
-							 hash[hash_key], iv: iv, key: crypt_key)
+			encrypted_value = EncryptorInterface.encrypt(:data,
+								 hash[hash_key], iv: iv, key: crypt_key)
 		
-		encrypted_value = [encrypted_value].pack(options[:encode]) if options[:encode]
-		iv = [iv].pack(options[:encode_iv]) if options[:encode_iv]
+			encrypted_value = [encrypted_value].pack(options[:encode]) if options[:encode]
+			iv = [iv].pack(options[:encode_iv]) if options[:encode_iv]
+		end
 	
 		hash[data_key] = encrypted_value
 		hash[iv_key] = iv
@@ -136,21 +148,26 @@ module HashRedactor
 		end
 
 		if (result.has_key? data_key)
-		  iv = result[iv_key]
-		  crypt_key = options[:encryption_key]
+		  if result[data_key].nil?
+		  	decrypted_value = nil
+		  else
+			  iv = result[iv_key]
+			  crypt_key = options[:encryption_key]
 
-		  encrypted_value = result[data_key]
+			  encrypted_value = result[data_key]
 
-		  # Decode if necessary
-		  iv = iv.unpack(options[:encode_iv]).first if options[:encode_iv]
-		  encrypted_value = encrypted_value.unpack(options[:encode]).first if options[:encode]
+			  # Decode if necessary
+			  iv = iv.unpack(options[:encode_iv]).first if options[:encode_iv]
+			  encrypted_value = encrypted_value.unpack(options[:encode]).first if options[:encode]
 
-		  decrypted_value = EncryptorInterface.decrypt(:data, encrypted_value,
-			   iv: iv, key: crypt_key)
+			  decrypted_value = EncryptorInterface.decrypt(:data, encrypted_value,
+				   iv: iv, key: crypt_key)
+				   
+			  result.delete data_key
+			  result.delete iv_key
+		  end
 	
 		  result[hash_key] = decrypted_value
-		  result.delete data_key
-		  result.delete iv_key
 		end
 	  end
 	  

data/lib/hash_redactor/version.rb

@@ -1,3 +1,3 @@
 module HashRedactor
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: hash_redactor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Chris Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_encrypted
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Removes, digests or encrypts selected values in a ruby hash
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -98,17 +98,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Redact specified values in a hash