shuber-encryptor 1.0.0

data/CHANGELOG

@@ -0,0 +1,6 @@
+2009-01-06 - Sean Huber (shuber@huberry.com)
+  * Initial commit
+  * Add tests
+  * Update README
+  * Add gemspec
+  * Modify gemspec so github will rebuild the gem

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sean Huber - shuber@huberry.com
+
+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.markdown

@@ -0,0 +1,32 @@
+Encryptor
+=========
+
+A simple wrapper for the standard ruby OpenSSL library
+
+
+Installation
+------------
+
+	gem install shuber-encryptor --source http://gems.github.com
+
+
+Usage
+-----
+
+	secret_key = Digest::SHA256.hexdigest('a secret key')
+	encrypted_value = Huberry::Encryptor.encrypt(:value => 'some string to encrypt', :key => secret_key) # '������{)��q�ށ�ܣ��q���Au/�ޜP'
+	decrypted_value = Huberry::Encryptor.decrypt(:value => encrypted_value, :key => secret_key) # 'some string to encrypt'
+
+You may also pass the `:iv` and `:algorithm` options but they are not required. If an algorithm is not specified, the Encryptor uses
+the algorithm found at `Huberry::Encryptor.default_algorithm` which is `aes-256-cbc` by default. You can change the default algorithm 
+by overwriting this attribute:
+
+	Huberry::Encryptor.default_algorithm = 'bf'
+
+Run `openssl list-cipher-commands` in your terminal to view a list all cipher algorithms that are supported on your platform.
+
+
+Contact
+-------
+
+Problems, comments, and suggestions all welcome: [shuber@huberry.com](mailto:shuber@huberry.com)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the encryptor gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the encryptor gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Encryptor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/encryptor.rb

@@ -0,0 +1,50 @@
+require 'openssl'
+
+module Huberry
+  module Encryptor
+    # The default algorithm to use if one is not explicitly passed as an option to the <tt>encrypt</tt> or <tt>decrypt</tt> methods
+    #
+    # Defaults to 'aes-256-cbc'
+    #
+    # Run 'openssl list-cipher-commands' in your terminal to view a list all cipher algorithms that are supported on your platform
+    class << self; attr_accessor :default_algorithm; end
+    self.default_algorithm = 'aes-256-cbc'
+    
+    # Encrypts a <tt>:value</tt> with a specified <tt>:key</tt>
+    #
+    # Optionally accepts <tt>:iv</tt> and <tt>:algorithm</tt> options
+    #
+    # Example
+    #
+    #   encrypted_value = Huberry::Encryptor.encrypt(:value => 'some string to encrypt', :key => 'some secret key')
+    def self.encrypt(options)
+      crypt :encrypt, options
+    end
+    
+    # Decrypts a <tt>:value</tt> with a specified <tt>:key</tt>
+    #
+    # Optionally accepts <tt>:iv</tt> and <tt>:algorithm</tt> options
+    #
+    # Example
+    #
+    #   decrypted_value = Huberry::Encryptor.decrypt(:value => 'some encrypted string', :key => 'some secret key')
+    def self.decrypt(options)
+      crypt :decrypt, options
+    end
+    
+    protected
+    
+      def self.crypt(cipher_method, options = {})
+        cipher = OpenSSL::Cipher::Cipher.new(options[:algorithm] || default_algorithm)
+        cipher.send(cipher_method)
+        if options[:iv]
+          cipher.key = options[:key]
+          cipher.iv = options[:iv]
+        else
+          cipher.pkcs5_keyivgen(options[:key])
+        end
+        result = cipher.update(options[:value])
+        result << cipher.final
+      end
+  end
+end

data/test/encryptor_test.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+require 'digest/sha2'
+require File.dirname(__FILE__) + '/../lib/encryptor'
+
+class EncryptorTest < Test::Unit::TestCase
+  
+  algorithms = %x(openssl list-cipher-commands).split  
+  original_value = Digest::SHA256.hexdigest(([Time.now.to_s] * rand(3)).join)
+  key = Digest::SHA256.hexdigest(([Time.now.to_s] * rand(3)).join)
+  iv = Digest::SHA256.hexdigest(([Time.now.to_s] * rand(3)).join)
+  
+  algorithms.each do |algorithm|
+    define_method "test_should_crypt_with_#{algorithm}_algorithm_with_iv" do
+      encrypted_value = Huberry::Encryptor.encrypt(:value => original_value, :key => key, :iv => iv, :algorithm => algorithm)
+      assert_not_equal original_value, encrypted_value
+      assert_not_equal Huberry::Encryptor.encrypt(:value => original_value, :key => key, :algorithm => algorithm), encrypted_value
+      assert_equal original_value, Huberry::Encryptor.decrypt(:value => encrypted_value, :key => key, :iv => iv, :algorithm => algorithm)
+    end
+    
+    define_method "test_should_crypt_with_#{algorithm}_algorithm_without_iv" do
+      encrypted_value = Huberry::Encryptor.encrypt(:value => original_value, :key => key, :algorithm => algorithm)
+      assert_not_equal original_value, encrypted_value
+      assert_equal original_value, Huberry::Encryptor.decrypt(:value => encrypted_value, :key => key, :algorithm => algorithm)
+    end
+  end
+  
+  define_method 'test_should_have_a_default_algorithm' do
+    assert algorithms.include?(Huberry::Encryptor.default_algorithm)
+  end
+  
+  define_method 'test_should_use_the_default_algorithm_if_one_is_not_specified' do
+    assert_equal Huberry::Encryptor.encrypt(:value => original_value, :key => key, :algorithm => Huberry::Encryptor.default_algorithm), Huberry::Encryptor.encrypt(:value => original_value, :key => key)
+  end
+  
+  def test_should_be_able_to_change_the_default_algorithm
+    original_algorithm = Huberry::Encryptor.default_algorithm
+    assert_not_equal 'test', original_algorithm
+    Huberry::Encryptor.default_algorithm = 'test'
+    assert_equal 'test', Huberry::Encryptor.default_algorithm
+    Huberry::Encryptor.default_algorithm = original_algorithm
+  end
+  
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: shuber-encryptor
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-07 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A simple wrapper for the standard ruby OpenSSL library
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- lib/encryptor.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+has_rdoc: false
+homepage: http://github.com/shuber/encryptor
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple wrapper for the standard ruby OpenSSL library
+test_files: 
+- test/encryptor_test.rb