aes_keeper 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd63ef7d34c5f8f6cb4896b069bdd0edd149ec0a
-  data.tar.gz: 8bdef6588a29ca0648c67a252eef7ebeb202afb1
+  metadata.gz: e21e5cca9b69f4f7c2b8b4293c9dccb94b5424b6
+  data.tar.gz: 5dbbb5ffb17a53f95911c39033ba98418b66cbbd
 SHA512:
-  metadata.gz: 023da16fb9fb354624724c0262400587194d1839286940862cfa6dd320198ba1d1bd622db7250ffc3eee9e8de3eb6fc58f8b2dbfcc6aa88cbb4ebde61eed9f29
-  data.tar.gz: 3ed04c398b32c92e3e04872cfbe68c735c605b78fa75ee56d5a7e112dadf8b06ef8ce3877a51452e39dc3b57eef31321f475e56f0250c682bbad47d32ff68cae
+  metadata.gz: b5966c1289e8340d51ff1931a34190804f0066427c6b583d1d502488924c41d150412bc52cff7e60148fd694307ea1636b8546c29a25ff1c80e3542893ef5757
+  data.tar.gz: fbd85365c8ae110a1c85c2eee8120dc9a093bec804558217548fa2cec67644777d05c545c3bec8f4479609daeb47eca431f9e2dbfa0a773d7bd6e9bdc8404f2d

data/.gitignore

@@ -13,4 +13,5 @@
 *.o
 *.a
 *.gem
+*.swp
 mkmf.log

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Daniel P. Clark
+Copyright (c) 2015-2016 Daniel P. Clark
 
 MIT License
 

data/README.md

@@ -4,6 +4,10 @@ A database safe encryption using AES 256 CBC.  Key required, Salt optional.  Ret
 or you can call **.to_s** to receive the encrypted data as one String. Decrypt will accept either form of the
  { encrypted: '', iv: '' } pair or the String result.
 
+**NOTE:**
+ * Class object AesKeeper uses marshal which may be incompatible across platforms and Ruby versions. A benefit from this is the ability to place entire Ruby Objects in encrypted format.
+ * Please use AESKeeper::AesKeeperPure for any compatibility reasons.  It needs String input.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,7 +28,7 @@ Or install it yourself as:
 
 With encryption and iv result separate:
 ```ruby
-cipher = AesKeeper.new(key: 'some really good 32 character long key for encryption! ^_^')
+cipher = AesKeeper.new(key: 'some really good 32+ character long key for encryption! ^_^')
 result = cipher.encrypt("apples")
 # => {:encrypted=>"K1E/a75/3zxNKCTXJFJZaVe8jjeHFQG+Cv1Lxntz3oM=\n", :iv=>"uQozeVXYhaeK7Rvh1na6kA==\n"}
 cipher.decrypt(result)
@@ -33,7 +37,7 @@ cipher.decrypt(result)
 
 With encryption and iv result combined:
 ```ruby
-cipher = AesKeeper.new(key: 'some really good 32 character long key for encryption! ^_^')
+cipher = AesKeeper.new(key: 'some really good 32+ character long key for encryption! ^_^')
 result = cipher.encrypt("apples").to_s
 # => "xPbb+kVIROlA5YHvSaKsYcCobgBz/TQHpJ5wP9lAuBQ=\n:WIaGiOhjFBRBVJReiA2aTA==\n"
 cipher.decrypt(result)
@@ -43,7 +47,7 @@ cipher.decrypt(result)
 You can specify a Salt as well:
 ```ruby
 AesKeeper.new(
-  key: 'some really good 32 character long key for encryption! ^_^',
+  key: 'some really good 32+ character long key for encryption! ^_^',
   salt: 'asdfqwerty'
 )
 ```
@@ -53,7 +57,7 @@ AesKeeper.new(
 This code can be refactored and tested.  Otherwise I consider this project feature complete.  It's designed
 with assumptions for its implementation and it's met those requirements.
 
-1. Fork it ( https://github.com/[my-github-username]/aes_keeper/fork )
+1. Fork it ( https://github.com/danielpclark/aes_keeper/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -61,7 +65,7 @@ with assumptions for its implementation and it's met those requirements.
 
 ## License
 
-Copyright (c) 2015 Daniel P. Clark
+Copyright (c) 2015-2016 Daniel P. Clark
 
 MIT License
 

data/Rakefile

@@ -1,2 +1,31 @@
 require "bundler/gem_tasks"
 
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+#require 'rdoc/task'
+#
+#RDoc::Task.new(:rdoc) do |rdoc|
+#  rdoc.rdoc_dir = 'rdoc'
+#  rdoc.title    = 'MightyString'
+#  rdoc.options << '--line-numbers'
+#  rdoc.rdoc_files.include('README.rdoc')
+#  rdoc.rdoc_files.include('lib/**/*.rb')
+#end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/aes_keeper.gemspec

@@ -5,7 +5,7 @@ require 'aes_keeper/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "aes_keeper"
-  spec.version       = AesKeeper::VERSION
+  spec.version       = AESKeeper::VERSION
   spec.authors       = ["Daniel P. Clark"]
   spec.email         = ["6ftdan@gmail.com"]
   spec.summary       = %q{Encrypt data via AES to database worthy strings.}
@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1.7"
+  spec.add_development_dependency "color_pound_spec_reporter", "~> 0.0.5"
   spec.add_runtime_dependency "armor", "~> 0.0"
 end

data/lib/aes_keeper/aes_keeper_marshal.rb

@@ -0,0 +1,68 @@
+module AESKeeper
+  class AESKeeperMarshal
+    VERSION = VERSION
+    def initialize(options = {})
+      raise ":key required!" unless options.has_key? :key
+      raise ":key needs to be at-least 32 characters!" unless options[:key].length >= 32
+      @key = key(options)
+      @cipher = OpenSSL::Cipher::AES256.new(:CBC)
+    end
+
+    def encrypt(content, options = {})
+      if (content != nil) and (content != "")
+        @cipher.encrypt
+        @cipher.key = key(options) || @key
+        iv = @cipher.random_iv
+        @cipher.iv = iv
+        encrypted = @cipher.update Marshal.dump(content)
+        encrypted << @cipher.final
+        {
+          encrypted: Base64.encode64(encrypted).encode('utf-8'), iv: Base64.encode64(iv).encode('utf-8')
+        }.tap { |i|
+          i.define_singleton_method(:to_s) { [self[:encrypted], self[:iv]].join(":") }
+          i.define_singleton_method(:to_string) { [self[:encrypted], self[:iv]].join(":") }
+        }
+      else
+        { encrypted: '', iv: ''}.tap {|i|
+          i.define_singleton_method(:to_s){''}
+          i.define_singleton_method(:blank?){true}
+          i.define_singleton_method(:empty?){true}
+          i.define_singleton_method(:presence){''}
+          i.define_singleton_method(:present?){false}
+        }
+      end
+    end
+
+    def decrypt(options = {})
+      if options.is_a? String
+        text = options.dup
+        options = {}
+        if text.scan(/:/).one?
+          options[:encrypted], options[:iv] = text.split(':')
+        else
+          raise 'Invalid String input!'
+        end
+      end
+      raise ':encrypted required!' unless options.has_key?(:encrypted)
+      raise ':iv required!' unless options.has_key?(:iv)
+      raise ':encrypted invalid type!' unless options[:encrypted].is_a? String
+      raise ':iv invalid type!' unless options[:iv].is_a? String
+      return '' if options[:encrypted].strip.empty? and options[:iv].strip.empty?
+      @cipher.decrypt
+      @cipher.key =  key(options) || @key
+      @cipher.iv = Base64.decode64(options[:iv].encode('ascii-8bit'))
+      decrypted = @cipher.update Base64.decode64(options[:encrypted].encode('ascii-8bit'))
+      begin
+        decrypted << @cipher.final
+        Marshal.load(decrypted)
+      rescue
+        raise 'Decryption failed.'
+      end
+    end
+
+    def key(options = {})
+      return nil unless options.has_key? :key
+      options.has_key?(:salt) ? Armor.digest(options[:key], options[:salt]) : options[:key]
+    end
+  end
+end

data/lib/aes_keeper/aes_keeper_pure.rb

@@ -0,0 +1,67 @@
+module AESKeeper
+  class AESKeeperPure
+    def initialize(options = {})
+      raise ":key required!" unless options.has_key? :key
+      raise ":key needs to be at-least 32 characters!" unless options[:key].length >= 32
+      @key = key(options)
+      @cipher = OpenSSL::Cipher::AES256.new(:CBC)
+    end
+
+    def encrypt(content, options = {})
+      if (content != nil) and (content != "")
+        @cipher.encrypt
+        @cipher.key = key(options) || @key
+        @iv ||= @cipher.random_iv
+        @cipher.iv = @iv
+        encrypted = @cipher.update content
+        encrypted << @cipher.final
+        {
+          encrypted: Base64.encode64(encrypted).encode('utf-8'), iv: Base64.encode64(@iv).encode('utf-8')
+        }.tap { |i|
+          i.define_singleton_method(:to_s) { [self[:encrypted], self[:iv]].join(":") }
+          i.define_singleton_method(:to_string) { [self[:encrypted], self[:iv]].join(":") }
+        }
+      else
+        { encrypted: '', iv: ''}.tap {|i|
+          i.define_singleton_method(:to_s){''}
+          i.define_singleton_method(:blank?){true}
+          i.define_singleton_method(:empty?){true}
+          i.define_singleton_method(:presence){''}
+          i.define_singleton_method(:present?){false}
+        }
+      end
+    end
+
+    def decrypt(options = {})
+      if options.is_a? String
+        text = options.dup
+        options = {}
+        if text.scan(/:/).one?
+          options[:encrypted], options[:iv] = text.split(':')
+        else
+          raise 'Invalid String input!'
+        end
+      end
+      raise ':encrypted required!' unless options.has_key?(:encrypted)
+      raise ':iv required!' unless options.has_key?(:iv)
+      raise ':encrypted invalid type!' unless options[:encrypted].is_a? String
+      raise ':iv invalid type!' unless options[:iv].is_a? String
+      return '' if options[:encrypted].strip.empty? and options[:iv].strip.empty?
+      @cipher.decrypt
+      @cipher.key =  key(options) || @key
+      @cipher.iv = Base64.decode64(options[:iv].encode('ascii-8bit'))
+      decrypted = @cipher.update Base64.decode64(options[:encrypted].encode('ascii-8bit'))
+      begin
+        decrypted << @cipher.final
+        decrypted
+      rescue
+        raise 'Decryption failed.'
+      end
+    end
+
+    def key(options = {})
+      return nil unless options.has_key? :key
+      options.has_key?(:salt) ? Armor.digest(options[:key], options[:salt]) : options[:key]
+    end
+  end
+end

data/lib/aes_keeper/version.rb

@@ -1,3 +1,3 @@
-class AesKeeper
-  VERSION = "0.0.1"
+module AESKeeper
+  VERSION = "0.1.0"
 end

data/lib/aes_keeper.rb

@@ -1,69 +1,9 @@
 require "aes_keeper/version"
 require 'armor'
 require 'base64'
+require 'aes_keeper/aes_keeper_pure.rb'
+require 'aes_keeper/aes_keeper_marshal.rb'
 
-class AesKeeper
-  def initialize(options = {})
-    raise ":key required!" unless options.has_key? :key
-    raise ":key needs to be at-least 32 characters!" unless options[:key].length >= 32
-    @key = key(options)
-    @cipher = OpenSSL::Cipher::AES256.new(:CBC)
-  end
-
-  def encrypt(content, options = {})
-    if (content != nil) and (content != "")
-      @cipher.encrypt
-      @cipher.key = key(options) || @key
-      iv = @cipher.random_iv
-      @cipher.iv = iv
-      encrypted = @cipher.update Marshal.dump(content)
-      encrypted << @cipher.final
-      {
-        encrypted: Base64.encode64(encrypted).encode('utf-8'), iv: Base64.encode64(iv).encode('utf-8')
-      }.tap { |i|
-        i.define_singleton_method(:to_s) { [self[:encrypted], self[:iv]].join(":") }
-        i.define_singleton_method(:to_string) { [self[:encrypted], self[:iv]].join(":") }
-      }
-    else
-      { encrypted: '', iv: ''}.tap {|i|
-        i.define_singleton_method(:to_s){''}
-        i.define_singleton_method(:blank?){true}
-        i.define_singleton_method(:empty?){true}
-        i.define_singleton_method(:presence){''}
-        i.define_singleton_method(:present?){false}
-      }
-    end
-  end
-
-  def decrypt(options = {})
-    if options.is_a? String
-      text = options.dup
-      options = {}
-      if text.scan(/:/).one?
-        options[:encrypted], options[:iv] = text.split(':')
-      else
-        raise 'Invalid String input!'
-      end
-    end
-    raise ':encrypted required!' unless options.has_key?(:encrypted)
-    raise ':iv required!' unless options.has_key?(:iv)
-    raise ':encrypted invalid type!' unless options[:encrypted].is_a? String
-    raise ':iv invalid type!' unless options[:iv].is_a? String
-    return '' if options[:encrypted].strip.empty? and options[:iv].strip.empty?
-    @cipher.decrypt
-    @cipher.key =  key(options) || @key
-    @cipher.iv = Base64.decode64(options[:iv].encode('ascii-8bit'))
-    decrypted = @cipher.update Base64.decode64(options[:encrypted].encode('ascii-8bit'))
-    begin
-      decrypted << @cipher.final
-      Marshal.load(decrypted)
-    rescue
-      raise 'Decryption failed.'
-    end
-  end
-
-  def key(options = {})
-    return nil unless options.has_key? :key
-    options.has_key?(:salt) ? Armor.digest(options[:key], options[:salt]) : options[:key]
-  end
-end
+module AESKeeper
+  ::AesKeeper = AESKeeperMarshal
+end

data/test/aes_keeper_marshal_test.rb

@@ -0,0 +1,52 @@
+require 'minitest_helper'
+
+describe AESKeeper::AESKeeperMarshal do
+  let(:uuid)    { SecureRandom.uuid }
+  let(:encrypt1){AesKeeper.new key: "asdfghjklqwertyuiopzxcvbnm1234567890"}
+  let(:encrypt2){AesKeeper.new key: "asdfghjklqwertyuiopzxcvbnm1234567890", salt: "shaker"}
+  let(:encrypt3){AesKeeper.new key: uuid, salt: "Example.com"}
+
+  it "shows version for old implementation" do
+    _(AesKeeper::VERSION.class).must_be_same_as String
+  end
+
+  it "produces a hash of size 2" do
+    hsh = encrypt1.encrypt("moo")
+    _(hsh).must_be_kind_of Hash
+    _(hsh.size).must_be_same_as 2
+    _(hsh).must_include :iv
+    _(hsh).must_include :encrypted
+  end
+
+  it "can be as a string as well" do
+    str = encrypt2.encrypt("moo").to_s
+    _(str).must_be_kind_of String
+    _(str.count(":")).must_be_same_as 1
+  end
+
+  it "encrypts and decrypts #1" do
+    a = encrypt1.encrypt("moo")
+    _(encrypt1.decrypt(a)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #2" do
+    b = encrypt2.encrypt("moo")
+    _(encrypt2.decrypt(b)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #3" do
+    c = encrypt1.encrypt("moo").to_s
+    _(encrypt1.decrypt(c)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #4" do
+    d = encrypt2.encrypt("moo").to_s
+    _(encrypt2.decrypt(d)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #5" do
+    e = encrypt3.encrypt(uuid).to_s
+    _(encrypt3.decrypt(e)).must_equal uuid    
+  end
+end
+

data/test/aes_keeper_pure_test.rb

@@ -0,0 +1,55 @@
+require 'minitest_helper'
+
+describe AESKeeper::AESKeeperPure do
+  let(:uuid)    { SecureRandom.uuid }
+  let(:encrypt1){AESKeeper::AESKeeperPure.new key: "asdfghjklqwertyuiopzxcvbnm1234567890"}
+  let(:encrypt2){AESKeeper::AESKeeperPure.new key: "asdfghjklqwertyuiopzxcvbnm1234567890", salt: "shaker"}
+  let(:encrypt3){AESKeeper::AESKeeperPure.new key: uuid, salt: "Example.com"}
+
+  it "produces a hash of size 2" do
+    hsh = encrypt1.encrypt("moo")
+    _(hsh).must_be_kind_of Hash
+    _(hsh.size).must_be_same_as 2
+    _(hsh).must_include :iv
+    _(hsh).must_include :encrypted
+  end
+
+  it "pure aes results with injected iv will be consistent" do
+    encrypt2.instance_exec {@iv = "\xF6s\x93<\xCB\x8DX\x88\x84\xB9J\x04\x93l^\x8F"}
+    a = encrypt2.encrypt("asdf@moo.com").to_s
+    b = encrypt2.encrypt("asdf@moo.com").to_s
+    _(a).must_equal b 
+  end
+
+  it "can be as a string as well" do
+    str = encrypt2.encrypt("moo").to_s
+    _(str).must_be_kind_of String
+    _(str.count(":")).must_be_same_as 1
+  end
+
+  it "encrypts and decrypts #1" do
+    a = encrypt1.encrypt("moo")
+    _(encrypt1.decrypt(a)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #2" do
+    b = encrypt2.encrypt("moo")
+    _(encrypt2.decrypt(b)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #3" do
+    c = encrypt1.encrypt("moo").to_s
+    _(encrypt1.decrypt(c)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #4" do
+    d = encrypt2.encrypt("moo").to_s
+    _(encrypt2.decrypt(d)).must_equal "moo"
+  end
+
+  it "encrypts and decrypts #5" do
+    e = encrypt3.encrypt(uuid).to_s
+    _(encrypt3.decrypt(e)).must_equal uuid    
+  end
+end
+

data/test/minitest_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'aes_keeper'
+
+require 'minitest/autorun'
+require 'color_pound_spec_reporter'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+Minitest::Reporters.use! [ColorPoundSpecReporter.new]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aes_keeper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+- !ruby/object:Gem::Dependency
+  name: color_pound_spec_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: armor
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +108,12 @@ files:
 - Rakefile
 - aes_keeper.gemspec
 - lib/aes_keeper.rb
+- lib/aes_keeper/aes_keeper_marshal.rb
+- lib/aes_keeper/aes_keeper_pure.rb
 - lib/aes_keeper/version.rb
+- test/aes_keeper_marshal_test.rb
+- test/aes_keeper_pure_test.rb
+- test/minitest_helper.rb
 homepage: https://github.com/danielpclark/aes_keeper
 licenses:
 - MIT
@@ -87,8 +134,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Encrypt data via AES to database worthy strings.
-test_files: []
+test_files:
+- test/aes_keeper_marshal_test.rb
+- test/aes_keeper_pure_test.rb
+- test/minitest_helper.rb