parsel 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df92c45b60b8051c992490f2289b2511a5643226
-  data.tar.gz: a6dcb4e514c4ab76ac754416b43c01f3ea254582
+  metadata.gz: 80d50c158df4722786b31e9f644699453e4f8dfb
+  data.tar.gz: 12e6dac5ec2e15b3a8970235fc806d1e996c9a5a
 SHA512:
-  metadata.gz: 2df8d1021815040d88521e5549d2e1cc87f3429f31e751784816d23ada0dcb96f231b734b48cfe92fee4ad2ef534bc4b5924a0bfaaca8b395283a1a0a2e32488
-  data.tar.gz: 196722bab46f11745db385cf8c6977a7a9bbbbb65e099c6cbddf46e8fb01d8eba36dab6d5edb556fe906c47d0e89cdd04e3a42f409f902f491bfa3aee951c253
+  metadata.gz: 6c6cf7a7cc8bb1e1373fe45d6a0473c16b31492d319363210b7206585feead5ec9db5cb163401e4ef6cc203a525e03e0b92be5e921beceaf2190f53166162237
+  data.tar.gz: b0df1372c7a6682191f1ad4fea0c779720b86b571228fd07d97af3c626b7b3cc61139ef64c3a980baf4ab17f575af687b291f52b57f79241c2f834ac5a2ffdb8

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 pkg
 tmp
+Gemfile.lock

data/README.md

@@ -49,6 +49,23 @@ decrypted = Parsel::JSON.decrypt(secret_key, encrypted)
 #=> {"user_id" => 1234}
 ```
 
+### Custom Cipher IV
+
+By default, this library uses a built-in IV. You may want to change that.
+
+You can globally change the IV like the following:
+
+```ruby
+Parsel.default_iv = SecureRandom.hex(100)
+```
+
+You can also pass the IV to encrypt/decrypt methods.
+
+```ruby
+Parsel.encrypt(secret_key, iv, data)
+Parsel.decrypt(secret_key, iv, data)
+```
+
 ## Maintainer
 
 - Nando Vieira (<http://nandovieira.com.br>)

data/lib/parsel.rb

@@ -6,21 +6,46 @@ require 'parsel/json'
 require 'parsel/version'
 
 module Parsel
-  def self.encrypt(key, data)
-    encode cipher(:encrypt, key, data)
+  DEFAULT_IV = 'f89209ffcdd1a225'.freeze
+  CIPHER = 'AES-256-CBC'.freeze
+
+  def self.default_iv=(iv)
+    @default_iv = iv
+  end
+
+  def self.default_iv
+    @default_iv
   end
 
-  def self.decrypt(key, data)
-    cipher(:decrypt, key, decode(data))
+  self.default_iv = DEFAULT_IV
+
+  def self.encrypt(*args)
+    encode cipher(:encrypt, *expand_args(args))
+  end
+
+  def self.decrypt(*args)
+    key, iv, data = expand_args(args)
+    cipher(:decrypt, key, iv, decode(data))
   rescue Exception
     false
   end
 
+  def self.expand_args(args)
+    if args.size == 2
+      iv = default_iv
+      key, data = args
+    else
+      key, iv, data = args
+    end
+
+    [key, iv, data]
+  end
+
   private
-  def self.cipher(mode, key, data)
-    cipher = OpenSSL::Cipher.new('AES-256-CBC').public_send(mode)
+  def self.cipher(mode, key, iv, data)
+    cipher = OpenSSL::Cipher.new(CIPHER).public_send(mode)
     cipher.key = Digest::SHA256.digest(key)
-    cipher.iv = 'f89209ffcdd1a225'
+    cipher.iv = iv
     cipher.update(data) + cipher.final
   end
 

data/lib/parsel/json.rb

@@ -1,11 +1,13 @@
 module Parsel
   module JSON
-    def self.encrypt(key, data)
-      Parsel.encrypt(key, ::JSON.dump(data))
+    def self.encrypt(*args)
+      key, iv, data = Parsel.expand_args(args)
+      Parsel.encrypt(key, iv, ::JSON.dump(data))
     end
 
-    def self.decrypt(key, data)
-      ::JSON.load Parsel.decrypt(key, data)
+    def self.decrypt(*args)
+      key, iv, data = Parsel.expand_args(args)
+      ::JSON.load Parsel.decrypt(key, iv, data)
     rescue Exception
       false
     end

data/lib/parsel/marshal.rb

@@ -1,11 +1,13 @@
 module Parsel
   module Marshal
-    def self.encrypt(key, data)
-      Parsel.encrypt(key, ::Marshal.dump(data))
+    def self.encrypt(*args)
+      key, iv, data = Parsel.expand_args(args)
+      Parsel.encrypt(key, iv, ::Marshal.dump(data))
     end
 
-    def self.decrypt(key, data)
-      ::Marshal.load Parsel.decrypt(key, data)
+    def self.decrypt(*args)
+      key, iv, data = Parsel.expand_args(args)
+      ::Marshal.load Parsel.decrypt(key, iv, data)
     rescue Exception
       false
     end

data/lib/parsel/version.rb

@@ -1,7 +1,7 @@
 module Parsel
   module Version
     MAJOR = 0
-    MINOR = 2
+    MINOR = 3
     PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end

data/spec/parsel_spec.rb

@@ -15,4 +15,26 @@ describe Parsel do
   it 'returns false when decryption fails' do
     expect(Parsel.decrypt('abc', '123')).to be_falsy
   end
+
+  it 'uses custom iv' do
+    iv = SecureRandom.hex(100)
+    encrypted = Parsel.encrypt(key, iv, 'hello')
+
+    expect(Parsel.decrypt(key, iv, encrypted)).to eq('hello')
+  end
+
+  it 'return false when decryption for custom iv fails' do
+    iv = SecureRandom.hex(100)
+    encrypted = Parsel.encrypt(key, iv, 'hello')
+
+    expect(Parsel.decrypt(key, encrypted)).to be_falsy
+  end
+
+  it 'changes global iv' do
+    iv = SecureRandom.hex(100)
+    Parsel.default_iv = iv
+    encrypted = Parsel.encrypt(key, 'hello')
+
+    expect(Parsel.decrypt(key, iv, encrypted)).to eq('hello')
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
 require 'bundler/setup'
 require 'parsel'
 
+RSpec.configure do |config|
+  config.before do
+    Parsel.default_iv = Parsel::DEFAULT_IV
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parsel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,7 +48,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/parsel.rb
@@ -79,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Encrypt and decrypt data with a given key.
@@ -88,4 +87,3 @@ test_files:
 - spec/parsel/marshal_spec.rb
 - spec/parsel_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/Gemfile.lock

@@ -1,30 +0,0 @@
-PATH
-  remote: .
-  specs:
-    parsel (0.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  parsel!
-  rake
-  rspec