aes_keeper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd63ef7d34c5f8f6cb4896b069bdd0edd149ec0a
+  data.tar.gz: 8bdef6588a29ca0648c67a252eef7ebeb202afb1
+SHA512:
+  metadata.gz: 023da16fb9fb354624724c0262400587194d1839286940862cfa6dd320198ba1d1bd622db7250ffc3eee9e8de3eb6fc58f8b2dbfcc6aa88cbb4ebde61eed9f29
+  data.tar.gz: 3ed04c398b32c92e3e04872cfbe68c735c605b78fa75ee56d5a7e112dadf8b06ef8ce3877a51452e39dc3b57eef31321f475e56f0250c682bbad47d32ff68cae

data/.gitignore

@@ -0,0 +1,16 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aes_keeper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Daniel P. Clark
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# AesKeeper
+
+A database safe encryption using AES 256 CBC.  Key required, Salt optional.  Returns encrypted String and IV,
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aes_keeper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aes_keeper
+
+## Usage
+
+With encryption and iv result separate:
+```ruby
+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)
+# => "apples" 
+```
+
+With encryption and iv result combined:
+```ruby
+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)
+# => "apples" 
+```
+
+You can specify a Salt as well:
+```ruby
+AesKeeper.new(
+  key: 'some really good 32 character long key for encryption! ^_^',
+  salt: 'asdfqwerty'
+)
+```
+
+## Contributing
+
+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 )
+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`)
+5. Create a new Pull Request
+
+## License
+
+Copyright (c) 2015 Daniel P. Clark
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/aes_keeper.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aes_keeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aes_keeper"
+  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.}
+  spec.description   = %q{Encrypt data to strings via AES 256bit encryption. Database string safe.}
+  spec.homepage      = "https://github.com/danielpclark/aes_keeper"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "armor", "~> 0.0"
+end

data/lib/aes_keeper/version.rb

@@ -0,0 +1,3 @@
+class AesKeeper
+  VERSION = "0.0.1"
+end

data/lib/aes_keeper.rb

@@ -0,0 +1,69 @@
+require "aes_keeper/version"
+require 'armor'
+require 'base64'
+
+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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: aes_keeper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel P. Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: armor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: Encrypt data to strings via AES 256bit encryption. Database string safe.
+email:
+- 6ftdan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aes_keeper.gemspec
+- lib/aes_keeper.rb
+- lib/aes_keeper/version.rb
+homepage: https://github.com/danielpclark/aes_keeper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Encrypt data via AES to database worthy strings.
+test_files: []