dm-encrypted 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+*~
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Quin Hoxie
+
+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,45 @@
+dm-encrypted
+======
+A [DataMapper](http://github.com/datamapper/data_mapper)
+[type](http://github.com/datamapper/dm-more/tree/master/dm-types) that supports
+RSA encrypted columns.
+
+Installation
+------------
+    gem install qhoxie-rcrypt qhoxie-dm-encrypted --source http://gems.github.com
+
+Usage
+-----
+Private and public key constants need to be set:
+
+    PRIVATE_KEY = "-----BEGIN RSA PRIVATE KEY-----\nMIIEpgI..."
+    PUBLIC_KEY = "-----BEGIN RSA PUBLIC KEY-----\nXLPBCgK..."
+
+In your models, you simply specify the column type as Encrypted:
+
+    class Account
+      include DataMapper::Resource
+
+      property :id,         Serial
+      property :username,   String
+      property :password,   Encrypted
+    end
+
+Saving and loading those fields will transparently work with plaintext:
+
+    >> Account.create :username => "me", :password => "secret"
+    >> Account.first.password
+    => "secret"
+
+However it is ciphertext in the database:
+
+    >> select password from accounts;
+    => qxZjz37mt2PU...tcHPf5Un3RGAyxaT==
+
+Comments/Suggestions/Requests
+----------------------------
+Email me: qhoxie on gmail.com
+
+Copyright
+---------
+Copyright (c) 2009 Quin Hoxie. See LICENSE for details.

data/README.rdoc

@@ -0,0 +1,18 @@
+= dm-encrypted
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Quin Hoxie. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-encrypted"
+    gem.summary = %Q{Encrypted column type for DataMapper.}
+    gem.description = %Q{Transparently add RSA encryption to DataMapper models.}
+    gem.email = "qhoxie@gmail.com"
+    gem.homepage = "http://github.com/qhoxie/dm-encrypted"
+    gem.authors = ["Quin Hoxie"]
+    gem.add_dependency "rcrypt"
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-encrypted #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/dm-encrypted.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-encrypted}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Quin Hoxie"]
+  s.date = %q{2009-10-13}
+  s.description = %q{Transparently add RSA encryption to DataMapper models.}
+  s.email = %q{qhoxie@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dm-encrypted.gemspec",
+     "lib/dm-encrypted.rb",
+     "lib/dm-encrypted/encrypted.rb",
+     "test/dm-encrypted_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/qhoxie/dm-encrypted}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Encrypted column type for DataMapper.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/dm-encrypted_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rcrypt>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<rcrypt>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rcrypt>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/lib/dm-encrypted.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+
+require 'rubygems'
+require 'rcrypt'
+
+module DataMapper
+  module Types
+    dir = File.join(Pathname(__FILE__).dirname.expand_path, 'dm-encrypted').to_s
+
+    autoload :Encrypted, File.join(dir, 'encrypted')
+  end
+end
+

data/lib/dm-encrypted/encrypted.rb

@@ -0,0 +1,24 @@
+module DataMapper
+  module Types
+    class Encrypted < DataMapper::Type
+      primitive String
+
+      def self.load(value, property)
+        return unless value
+        RCrypt.decrypt(value, ::PRIVATE_KEY)
+      end
+
+      def self.dump(value, property)
+        return unless value
+        RCrypt.encrypt(value, ::PUBLIC_KEY)
+      end
+
+      def self.typecast(value, property)
+        return value if value.is_a?(String)
+        return value.to_s if value.respond_to? :to_s
+        value
+      end
+    end
+  end
+end
+

data/test/dm-encrypted_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class DmEncryptedTest < Test::Unit::TestCase
+  context "A column of type Encrypted" do
+    context "when passed a String" do
+      setup do
+        @raw = "secret"
+        @result = DataMapper::Types::Encrypted.dump(@raw, :property)
+      end
+
+      should "encrypt the plaintext" do
+        assert_not_equal @result, @raw
+        assert_equal @result.length, 350
+      end
+
+      should "decrypt to the plaintext" do
+        assert_equal DataMapper::Types::Encrypted.load(@result, :property), @raw
+      end
+    end
+
+    context "when passed nil" do
+      should "have nil ciphertext" do
+        assert_nil DataMapper::Types::Encrypted.dump(nil, :property)
+      end
+    end
+
+    context "when passed non-String values" do
+      should "coerce numbers" do
+        value = 1234
+        assert_equal DataMapper::Types::Encrypted.typecast(value, :property), value.to_s
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'dm-core'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dm-encrypted'
+
+PUBLIC_KEY, PRIVATE_KEY = RCrypt.generate_key_pair.values
+

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: dm-encrypted
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Quin Hoxie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rcrypt
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Transparently add RSA encryption to DataMapper models.
+email: qhoxie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- dm-encrypted.gemspec
+- lib/dm-encrypted.rb
+- lib/dm-encrypted/encrypted.rb
+- test/dm-encrypted_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/qhoxie/dm-encrypted
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Encrypted column type for DataMapper.
+test_files: 
+- test/test_helper.rb
+- test/dm-encrypted_test.rb