easy_encryption 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac2fbe9a8457a71f2955129f7340e3626e14671f
-  data.tar.gz: 43ff4121b620f2c7aa0edc1d29ce1b5cdf7dd8f9
+  metadata.gz: 46800c74fe61e6860297f1b472052ce3e59d6674
+  data.tar.gz: b0f0b5ae1852a99303661812061d66b150c1a547
 SHA512:
-  metadata.gz: d041642df1d41ac570a38a4b368c76bcb8687638f59d92f3831ac56a7d3e8bd1469ef3ef44ffe3a578850015e774807535a44d670c26b1591a50d8d39b1076d9
-  data.tar.gz: 41c9111ed4f97a9476e55d0ba28b629a6ae583cff5706957b8d337059f477a827d81d8e78346d5f7b8ba8e03b2cc8bc3040c2a4ba666e1dc1451bdb0d8b9e554
+  metadata.gz: f1fb294c61bf6f67cf55e1681f81319d72859408167ce17fba76006fe87bc71f8c2477de23a4876a15e64c3176f56dc8c96ad6b69da521aa976e41dfe3b6a4ca
+  data.tar.gz: 7c294485ea9181fcfffbf927f691be30e43509b4e824197fb75587b6e8e1c85b2838516f2c145797a2dd6b5db07bddb4a85759c8d08dbd3a658ecb356a93cc30

data/README.md

@@ -1,6 +1,10 @@
 # EasyEncryption
 
-Easy Encryption provides a simple means for encrypting and decrypting strings. Uses the Gibberish gem (https://github.com/mdp/gibberish) under the hood to do the actual encryption work.
+Easy Encryption provides a simple means for encrypting and decrypting strings. It utilizes the RbNaCl gem's simple box under the hood to do the actual encryption work (https://github.com/cryptosphere/rbnacl).
+
+## Important
+
+libsodium is required for the EasyEncryption gem to function. To install libsodium please refer to https://github.com/jedisct1/libsodium.
 
 ## Installation
 
@@ -16,20 +20,18 @@ Or install it yourself as:
 
     $ gem install easy_encryption
 
-Finally, call setup on EasyEncryption passing your cipher key:
+Finally, call setup on EasyEncryption with a password:
 ```ruby
-EasyEncryption.setup 'secret'
+EasyEncryption.setup('secret')
 ```
 
-In a Rails app you will need to set the default cipher key inside of your app's ::Application.configure block:
+In a Rails app you will need to set the default password inside of your app's ::Application.configure block:
 ```ruby
 config.after_initialize do
-  EasyEncryption.setup 'secret'
+  EasyEncryption.setup('secret')
 end
 ```
 
-To enable the gem for your Rails tests, set the default cipher key inside of `test_helper.rb` as in the first example.
-
 ## Usage
 
 EasyEncryption provides two additional methods that can be called on any string.
@@ -43,27 +45,3 @@ encrypted_data = 'foo'.encrypt
 ```ruby
 decrypted_data = encrypted_data.decrypt
 ```
-
-For special cases where a different cipher key needs to be used, it can be passed directly:
-```ruby
-encrypted_data = 'foo'.encrypt 'secret'
-decrypted_data = 'encrypted data'.decrypt 'secret'
-```
-
-Alternatively:
-```ruby
-string = 'foo'
-string.cipher_key = 'secret'
-encrypted_data = string.encrypt
-
-encrypted_data.cipher_key = 'secret'
-decrypted_data = encrypted_data.decrypt
-```
-
-## Contributing
-
-1. Fork it
-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 new Pull Request

data/easy_encryption.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Adam Ervans"]
   spec.email         = ["aervans@gmail.com"]
   spec.description   = %q{Check the github page for a detailed description}
-  spec.summary       = %q{Adds easy to use encrypt and decrypt methods to strings.}
-  spec.homepage      = "https://github.com/arthrex/easy-encryption"
+  spec.summary       = %q{Adds easy to use encrypt and decrypt methods to string instances.}
+  spec.homepage      = "https://github.com/aervans/easyencryption"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,8 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
-  spec.add_dependency "gibberish"
+  spec.add_development_dependency "rake", "~> 10.1.0"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_dependency "rbnacl", "~> 3.0.0"
 end

data/lib/easy_encryption.rb

@@ -1,43 +1,16 @@
 require "easy_encryption/version"
 require "easy_encryption/instance_methods"
 require "easy_encryption/class_methods"
-require "gibberish"
+require "rbnacl"
 
 module EasyEncryption
 
-  # sets up EasyEncryption
-  def self.setup(cipher_key)
-    @cipher_key = cipher_key
+  # sets up EasyEncryption. 
+  #
+  #   EasyEncryption.setup('secret')
+  def self.setup(key)
     String.send :include, InstanceMethods
     String.send :extend, ClassMethods
-    true
-  end
-
-  # getter for the default cipher key
-  def self.cipher_key
-    @cipher_key
-  end
-
-  # setter to change the default cipher key
-  def self.cipher_key=(cipher_key)
-    @cipher_key = cipher_key
-  end
-
-  # lambda for creating Gibberish ciphers
-  CREATE_CIPHER = lambda do |cipher_key|
-
-    if cipher_key == @last_cipher_key
-      # no cipher has been created or cipher_key is the same
-      @cipher = Gibberish::AES.new cipher_key
-    else
-      # cipher_key was changed
-      @cipher = Gibberish::AES.new cipher_key
-    end
-    
-    # remember the cipher key to determine if a new cipher
-    # needs to be created on the next call
-    @last_cipher_key = cipher_key
-    # return the cipher
-    @cipher
+    String.create_simple_box key
   end
 end

data/lib/easy_encryption/class_methods.rb

@@ -2,10 +2,13 @@ module EasyEncryption
 
   module ClassMethods
 
-    # returns a Gibberish cipher
-    def cipher
-      # create/use a cipher in the context of the String singleton
-      instance_exec EasyEncryption.cipher_key, &EasyEncryption::CREATE_CIPHER
+    attr_reader :simple_box
+
+    # creates a simple_box using the passed key
+    #
+    #   created_simple_box('secret')
+    def create_simple_box(key)
+      @simple_box ||= RbNaCl::SimpleBox.from_secret_key(RbNaCl::Hash.sha256(key))
     end
   end
 end

data/lib/easy_encryption/instance_methods.rb

@@ -2,35 +2,19 @@ module EasyEncryption
 
   module InstanceMethods
 
-    # encrypts a string. ex: "string".encrypt
-    def encrypt(cipher_key=nil)
-      @cipher_key = cipher_key if cipher_key
-      cipher.encrypt self
+    # encrypts a string
+    def encrypt
+      simple_box.encrypt self
     end
 
-    # decrypts a string. ex: "string".decrypt
-    def decrypt(cipher_key=nil)
-      @cipher_key = cipher_key if cipher_key
-      cipher.decrypt self
+    # decrypts a string
+    def decrypt
+      simple_box.decrypt self
     end
 
-    # setter to change the cipher key on an instance of String
-    def cipher_key=(cipher_key)
-      @cipher_key = cipher_key
-    end
-
-  private
-
-    # returns a Gibberish cipher
-    def cipher
-
-      if @cipher_key
-        # create/use a cipher in the context of a String instance
-        instance_exec @cipher_key, &EasyEncryption::CREATE_CIPHER
-      else
-        # use the singleton class's cipher
-        self.class.cipher
-      end
+    # references simple_box on the singleton class
+    def simple_box
+      self.class.simple_box
     end
   end
 end

data/lib/easy_encryption/version.rb

@@ -1,3 +1,3 @@
 module EasyEncryption
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/spec/easy_encryption_spec.rb

@@ -2,26 +2,14 @@
 require 'spec_helper'
 
 describe EasyEncryption do
-  
-  before(:all) do 
-    EasyEncryption.setup 'default_password'
-  end
 
-  let(:default_password) { EasyEncryption.cipher_key }
+  let(:key) { 'test' }
 
   describe '.create_cipher' do
-    after { remove_instance_variable :@cipher }
-
-    it 'should create a cipher in the context of the caller' do 
-      instance_exec default_password, &EasyEncryption::CREATE_CIPHER
-      @cipher.should be_an_instance_of(Gibberish::AES)
-    end
-  end
-
-  describe '.cipher_key=' do
 
-    it 'should set the cipher key' do 
-      expect(EasyEncryption.cipher_key=('password')).to eql('password')
+    it 'should create a simple box on String' do 
+      EasyEncryption.setup key
+      String.simple_box.should be_an_instance_of(RbNaCl::SimpleBox)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1 @@
 require 'easy_encryption'
-require 'pry'

data/spec/string_spec.rb

@@ -4,70 +4,31 @@ require 'spec_helper'
 describe String do
 
   before(:all) do 
-    EasyEncryption.setup 'default_password'
+    EasyEncryption.setup 'test'
   end
 
-  let(:default_password) { EasyEncryption.cipher_key }
-  let(:password) { 'password' }
   let(:text) { 'foo' }
-  let(:console_text) { `echo "foo"` }
+  let(:encrypted_text) {
+    simple_box = RbNaCl::SimpleBox.from_secret_key(RbNaCl::Hash.sha256('test'))
+    simple_box.encrypt text
+  }
 
   describe '#encrypt' do
 
-    context 'with cipher key set on String' do
+    context 'with a string instance' do
 
-      it 'encrypts a string' do
-        encrypted = text.encrypt 
-        decrypted = `echo "#{encrypted}" | openssl enc -d -aes-256-cbc -a -k "#{default_password}"`
-        decrypted.should eql(text)
-      end
-    end
-
-    context 'with cipher key set on a String instance' do
-
-      it 'encrypts a string' do
-        text.cipher_key = password
-        encrypted = text.encrypt
-        decrypted = `echo "#{encrypted}" | openssl enc -d -aes-256-cbc -a -k "#{password}"`
-        decrypted.should eql(text)
-      end
-    end
-    
-    context 'with cipher key passed to a String instance' do
-
-      it 'encrypts a string' do
-        encrypted = text.encrypt password
-        decrypted = `echo "#{encrypted}" | openssl enc -d -aes-256-cbc -a -k "#{password}"`
-        decrypted.should eql(text)
+      it 'encrypts a string instance' do
+        text.encrypt.encoding.should eql(Encoding::BINARY)
       end
     end
   end
 
   describe '#decrypt' do
 
-    context 'with cipher key set on String' do
-
-      it 'decrypts a string' do 
-        encrypted = `echo "foo" | openssl enc -aes-256-cbc -a -k "#{default_password}"`
-        decrypted = encrypted.decrypt.chomp
-        decrypted.should eql('foo')
-      end
-    end
-
-    context 'with cipher key set on a String instance' do
-
-      it 'decrypts a string' do
-        encrypted = `echo "foo" | openssl enc -aes-256-cbc -a -k "#{password}"`
-        encrypted.cipher_key = password
-        encrypted.decrypt.should eql(console_text)
-      end
-    end
-
-    context 'with cipher key passed to a String instance' do
+    context 'with a string instance' do
 
-      it 'decrypts a string' do
-        encrypted = `echo "foo" | openssl enc -aes-256-cbc -a -k "#{password}"`
-        encrypted.decrypt(password).should eql(console_text)
+      it 'decrypts a string instance' do
+        encrypted_text.decrypt.should eql(text)
       end
     end
   end

metadata

@@ -1,85 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: easy_encryption
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Ervans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rbnacl
   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'
-- !ruby/object:Gem::Dependency
-  name: gibberish
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 description: Check the github page for a detailed description
 email:
 - aervans@gmail.com
@@ -87,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -101,7 +87,7 @@ files:
 - spec/easy_encryption_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb
-homepage: https://github.com/arthrex/easy-encryption
+homepage: https://github.com/aervans/easyencryption
 licenses:
 - MIT
 metadata: {}
@@ -111,20 +97,20 @@ 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.0.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Adds easy to use encrypt and decrypt methods to strings.
+summary: Adds easy to use encrypt and decrypt methods to string instances.
 test_files:
 - spec/easy_encryption_spec.rb
 - spec/spec_helper.rb