aes 0.3.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Carl Hicks
+
+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.rdoc

@@ -0,0 +1,41 @@
+= aes
+
+An AES encrypt/decrypt gem built ontop of OpenSSL.  Not as quick as FastAES, but it doesn't require building native extensions and supports Base64 encoded input and output.
+
+Usage:
+
+require 'aes'
+
+# Generate a random key
+key = AES.key(32)  
+ => "290c3c5d812a4ba7ce33adf09598a462"
+
+# Encrypt something, default output is base_64 encoded.  init_vector and cipher_text are joined with "$"
+b64 = AES.encrypt(key, "A super secret message")
+ => "IJjbgbv/OvPIAf4R5qAWyg==$fy0v7JwRX4kyAWflgouQlt9XGmiDKvbQMRHmQ+vy1fA="
+
+# Same as above but minus the base64 encoding, initialization vector and cipher_text are shoved into an array
+plain = AES.encrypt(key, "A super secret message", {:format => :plain}) #
+ => [";\202\222\306\376<\206\343\023\245\312\225\214KAm", "C\343\023\323U~W>\023y\217\341\201\371\352\334\311^\307\352{\020 H(DVw\3224N\223"]
+ 
+AES.decrypt(key, b64)
+ => "A super secret message"
+ 
+AES.decrypt(key, plain, {:format => :plain})
+=> "A super secret message" 
+
+== Contributing to aes
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Carl Hicks. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "aes"
+  gem.homepage = "http://github.com/chicks/aes"
+  gem.license = "MIT"
+  gem.summary = %Q{AES#encrypt(key, data), AES#decrypt(key, data). Capiche?}
+  gem.description = %Q{An AES encrypt/decrypt gem built ontop of OpenSSL.  Not as quick as FastAES, but it doesn't require building
+    native extensions and supports Base64 encoded input and output.}
+  gem.email = "carl.hicks@gmail.com"
+  gem.authors = ["Carl Hicks"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "aes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/aes.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{aes}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Carl Hicks"]
+  s.date = %q{2010-12-05}
+  s.description = %q{An AES encrypt/decrypt gem built ontop of OpenSSL.  Not as quick as FastAES, but it doesn't require building
+    native extensions and supports Base64 encoded input and output.}
+  s.email = %q{carl.hicks@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "aes.gemspec",
+    "lib/aes.rb",
+    "test/helper.rb",
+    "test/test_aes.rb"
+  ]
+  s.homepage = %q{http://github.com/chicks/aes}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{AES#encrypt(key, data), AES#decrypt(key, data). Capiche?}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_aes.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/aes.rb

@@ -0,0 +1,130 @@
+require 'openssl'
+require 'base64'
+
+class AES
+  class << self
+    # Encrypts the plain_text with the provided key
+    def encrypt(key, plain_text, opts={})
+      AES.new(key,opts).encrypt(plain_text)
+    end
+    # Decrypts the cipher_text with the provided key
+    def decrypt(key, cipher_text, opts={})
+      AES.new(key,opts).decrypt(cipher_text)
+    end
+    # Generates a random key of the specified length in bits
+    # Default output is 
+    def key(length=256,format=:plain)
+      key = AES.new("").random_key(256)
+      case format
+      when :base_64
+        Base64.encode64(key)
+      else
+        key
+      end
+    end
+  end
+
+  attr :options
+  attr :key
+  attr :cipher
+  attr :cipher_text
+  attr :plain_text
+  
+  def initialize(key, opts={})
+    merge_options opts
+    @key = key
+    self
+  end
+  
+  # Encrypts
+  def encrypt(plain_text)
+    @plain_text = plain_text
+    _setup(:encrypt)
+    case @options[:format]
+    when :base_64
+      @cipher_text = b64_e(_iv) << "$" << b64_e(_encrypt)
+    else
+      @cipher_text = [_iv, _encrypt]
+    end
+    @cipher_text
+  end
+
+  # Decrypts  
+  def decrypt(cipher_text)
+    @cipher_text = cipher_text
+    _setup(:decrypt)
+    case @options[:format]
+    when :base_64
+      ctext = b64_d(@cipher_text)
+    else
+      ctext = @cipher_text
+    end
+    @cipher.iv  = ctext[0]
+    @plain_text = @cipher.update(ctext[1]) + @cipher.final 
+  end
+
+  # Generate a random initialization vector
+  def random_iv
+    _setup(:encrypt)
+    _iv
+  end
+  
+  # Generate a random key
+  def random_key(length=256)
+    _random_seed.unpack('H*')[0][0..((length/8)-1)]
+    #Digest::SHA256.digest(_random_seed)[0..(length / 8)]
+  end
+  
+  private
+    
+    # Generates a random seed value
+    def _random_seed(size=32)
+      if defined? OpenSSL::Random
+        return OpenSSL::Random.random_bytes(size)
+      else
+        chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
+        (1..size).collect{|a| chars[rand(chars.size)] }.join        
+      end
+    end
+    
+    # Un-Base64's the IV and CipherText
+    # Returns an array containing the IV, and CipherText
+    def b64_d(data)
+      iv_ctext = []
+      data.split('$').each do |part|
+        iv_ctext << Base64.decode64(part)
+      end
+      iv_ctext
+    end
+  
+    # Base64 Encodes a string
+    def b64_e(data)
+      Base64.encode64(data).chomp
+    end
+  
+    # Generates and returns a random initialization vector
+    def _iv
+      @cipher.random_iv
+    end
+    
+    # Encrypts @plain_text
+    def _encrypt
+      @cipher.update(@plain_text) + @cipher.final
+    end
+
+    # Merge init options with defaults
+    def merge_options(opts)
+      @options = {
+        :format => :base_64,
+        :cipher => "AES-256-CBC"
+      }.merge! opts
+    end
+      
+    # Create a new cipher using the cipher type specified
+    def _setup(action)
+      @cipher = OpenSSL::Cipher::Cipher.new(@options[:cipher]) 
+      # Toggles encryption mode
+      @cipher.send(action)
+      @cipher.key = @key.unpack('a2'*32).map{|x| x.hex}.pack('c'*32)  
+    end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'aes'
+
+class Test::Unit::TestCase
+end

data/test/test_aes.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestAES < Test::Unit::TestCase
+    
+  should "encrypt and decrypt a string" do
+    key = "01234567890123456789012345678901"
+    msg = "This is a message that nobody should ever see"
+    enc = AES.encrypt(key, msg)
+    assert_equal msg, AES.decrypt(key, enc)
+    enc = AES.encrypt(key, msg, {:format => :plain})
+    assert_equal msg, AES.decrypt(key, enc, {:format => :plain})
+  end
+  
+  should "generate a new key when AES#key" do
+    assert_equal 32, AES.key.length
+    assert_equal 45, AES.key(256, :base_64).length
+  end
+    
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: aes
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Carl Hicks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: |-
+  An AES encrypt/decrypt gem built ontop of OpenSSL.  Not as quick as FastAES, but it doesn't require building
+      native extensions and supports Base64 encoded input and output.
+email: carl.hicks@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- aes.gemspec
+- lib/aes.rb
+- test/helper.rb
+- test/test_aes.rb
+has_rdoc: true
+homepage: http://github.com/chicks/aes
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: AES#encrypt(key, data), AES#decrypt(key, data). Capiche?
+test_files: 
+- test/helper.rb
+- test/test_aes.rb