cryptology 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22580eefd3a2222b7f68ac139bbc4e4e6ef2b1f8
-  data.tar.gz: 514c5cae153148249950f52a5b8cad69cb9f7d8b
+  metadata.gz: 3b487542337e1013f886ac420c0e2a53b0ec22e3
+  data.tar.gz: 9c1e6d5ace17fa5fbedcfd6c6d870e27e7f076f0
 SHA512:
-  metadata.gz: c565bdf3263f22f22223bacec3390c459d426302b632c8f42765e33c0afcdfdd45899a8cdcd40fbd2ca60b984343414c6e989352c67e4a6f74c9f74377106f9a
-  data.tar.gz: 2d7cb662f8a8718080e3d2f1bc0c7b5c2174ab9e73e3c82789079d8ed406946c943e8203fb7ae73d6534042f66617fb310dadf6841b43c63b2555d1ea014405d
+  metadata.gz: eac2db8af311b962af96c6e83f02591e181b65dd147268cf7272b4040557c8e8b9a0cc85b3851fe0c923f8bda14e7f4e140554f620a7f52fda140bf402355611
+  data.tar.gz: 0c39c3408209210ff0f05337ae94196a638a3fdd831d83e2ada51262a6d2d5887016ac6beff5c22a62c27938b61f0397b6b73c70c80a389f97e07b6e925dd2d6

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Metrics/BlockLength:
+  ExcludedMethods: RSpec.describe, context
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/ParameterLists:
+  Max: 6
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -1,7 +1,7 @@
+sudo: false
 language: ruby
-
 rvm:
-  - 2.1.7
-  - 2.2.3
-
-sudo: false
+  - 2.1.10
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1

data/CHANGELOG.md

@@ -1,16 +1,24 @@
+## 2.0.0 (2017-06-27)
+
+- New: `encrypt` method returns a hash
+- Improvement: `key` hashing method updated
+- Improvement: `iv` is always set if algorithm supports it
+- Improvement: Optional `salt` and `iter` arguments 
+- Ruby versioning: Support for Ruby 2.4
+
 ## 1.2.0 (2015-12-10)
 
-- Improvement: Add decryptable? helper method
+- Improvement: Add `decryptable?` helper method
 
 ## 1.1.0 (2015-12-08)
 
 - Improvement: Switch to keyword arguments
-- Ruby Versioning: Drop support for Ruby 2.0
+- Ruby versioning: Drop support for Ruby 2.0
 
 ## 1.0.1 (2015-12-08)
 
-- Bug Fix: Allow iv to be nil
+- Bug fix: Allow iv to be nil
 
 ## 1.0.0 (2015-12-07)
 
-- Initial release
+- Initial release

data/Rakefile

@@ -1,4 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
 task default: :spec
-RSpec::Core::RakeTask.new

data/cryptology.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cryptology/version'
@@ -9,18 +10,18 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dmitriy Tarasov']
   spec.email         = ['info@rubysamurai.com']
 
-  spec.summary       = 'Wrapper for symmetric encryption and decryption using any algorithm supported by OpenSSL'
-  spec.description   = 'Wrapper for symmetric encryption and decryption using any algorithm supported by OpenSSL'
+  spec.summary       = 'Symmetric encryption and decryption with OpenSSL'
+  spec.description   = 'Symmetric encryption and decryption with OpenSSL'
   spec.homepage      = 'https://github.com/rubysamurai/cryptology'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_development_dependency 'rake',  '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'rake',  '>= 12.0'
+  spec.add_development_dependency 'rspec', '>= 3.6'
 end

data/lib/cryptology.rb

@@ -3,42 +3,50 @@ require 'openssl'
 require 'base64'
 
 module Cryptology
-  def self.encrypt(data:, key:, cipher: 'AES-256-CBC', iv: nil)
-    encrypted = encrypt_data(data.to_s, digest(key), cipher, iv)
-    ::Base64.encode64(encrypted)
+  def self.encrypt(data:, key:, salt: nil, iter: 10_000, cipher: 'AES-256-CBC', iv: nil)
+    salt ||= OpenSSL::Random.random_bytes(16)
+    iv ||= OpenSSL::Cipher.new(cipher).random_iv
+    encrypted = encrypt_data(data.to_s, digest_key(key, salt, iter), cipher, iv)
+    { 'cipher' => cipher,
+      'salt' => salt,
+      'iter' => iter,
+      'iv' => iv,
+      'data' => ::Base64.encode64(encrypted) }
   end
 
-  def self.decrypt(data:, key:, cipher: 'AES-256-CBC', iv: nil)
+  def self.decrypt(data:, key:, salt:, iter: 10_000, cipher: 'AES-256-CBC', iv:)
     base64_decoded = ::Base64.decode64(data.to_s)
-    decrypt_data(base64_decoded, digest(key), cipher, iv)
+    decrypt_data(base64_decoded, digest_key(key, salt, iter), cipher, iv)
       .force_encoding('UTF-8').encode
   end
 
-  def self.decryptable?(data:, key:, cipher: 'AES-256-CBC', iv: nil)
-    return true if decrypt(data: data, key: key, cipher: cipher, iv: iv)
+  def self.decryptable?(data:, key:, salt:, iter: 10_000, cipher: 'AES-256-CBC', iv:)
+    return true if decrypt(data: data, key: key, salt: salt, iter: iter, cipher: cipher, iv: iv)
   rescue OpenSSL::Cipher::CipherError
     return false
   end
 
-  private
+  def self.encrypt_data(data, key, cipher, iv)
+    c = OpenSSL::Cipher.new(cipher)
+    c.encrypt
+    c.key = key
+    c.iv  = iv unless iv.length != c.random_iv.length
+    c.update(data) + c.final
+  end
 
-    def self.encrypt_data(data, key, cipher, iv)
-      cipher = ::OpenSSL::Cipher::Cipher.new(cipher)
-      cipher.encrypt
-      cipher.key = key
-      cipher.iv  = iv unless iv.nil?
-      cipher.update(data) + cipher.final
-    end
+  def self.decrypt_data(data, key, cipher, iv)
+    decipher = OpenSSL::Cipher.new(cipher)
+    decipher.decrypt
+    decipher.key = key
+    decipher.iv  = iv unless iv.length != decipher.random_iv.length
+    decipher.update(data) + decipher.final
+  end
 
-    def self.decrypt_data(data, key, cipher, iv)
-      decipher = ::OpenSSL::Cipher::Cipher.new(cipher)
-      decipher.decrypt
-      decipher.key = key
-      decipher.iv  = iv unless iv.nil?
-      decipher.update(data) + decipher.final
-    end
+  def self.digest_key(key, salt, iter)
+    digest = OpenSSL::Digest::SHA256.new
+    len = digest.digest_length
+    OpenSSL::PKCS5.pbkdf2_hmac(key, salt, iter, len, digest)
+  end
 
-    def self.digest(key)
-      ::OpenSSL::Digest::SHA256.digest(key)
-    end
+  private_class_method :encrypt_data, :decrypt_data, :digest_key
 end

data/lib/cryptology/version.rb

@@ -1,3 +1,3 @@
 module Cryptology
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,45 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: cryptology
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Dmitriy Tarasov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
-description: Wrapper for symmetric encryption and decryption using any algorithm supported
-  by OpenSSL
+        version: '3.6'
+description: Symmetric encryption and decryption with OpenSSL
 email:
 - info@rubysamurai.com
 executables: []
@@ -48,6 +47,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -79,9 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Wrapper for symmetric encryption and decryption using any algorithm supported
-  by OpenSSL
+summary: Symmetric encryption and decryption with OpenSSL
 test_files: []