acts_as_encrypted 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-07-28
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+rails/init.rb
+rails/install.rb
+lib/acts_as_encrypted.rb
+uninstall.rb
+bin/acts_as_encrypted
+

data/README.txt

@@ -0,0 +1,66 @@
+= ActsAsEncrypted
+
+* actsasencrypted.rubyforge.org
+
+== DESCRIPTION:
+
+A quick and easy encryption wrapper. using the built in openssl functions.
+
+Usable in String, Text, or Binary fields. (Encodes in Base 64 before saving)
+
+== SYNOPSIS:
+
+  SecretAgent << ActiveRecord::Base
+   acts_as_encrypted
+   encrypt_fields :firstname, :lastname, :secret_agent_number
+  end
+  
+  SuperWeapon << ActiveRecord::Base
+    acts_as_encrypted
+    encrypt_field :obvious_weakness
+  end
+
+== REQUIREMENTS:
+
+* Ruby Compiled --with-openssl
+
+== INSTALL:
+
+* sudo gem install acts_as_encrypted
+
+In your application's config/environment:
+
+  config.gem "acts_as_encrypted"
+
+Then, if you want to change the encryption password or type (and you should!):
+
+  config.after_initialize do
+    ActsAsEncrypted::DBCipherKey = 'Sha1 Some password here'
+    ActsAsEncrypted::DBCipherType = "One of the Ciphers from OpenSSL::Cipher.ciphers"
+    # The default cipher is aes-256-cbc
+  end
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Alexander Bartlow
+
+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,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/acts_as_encrypted.rb'
+
+Hoe.new('acts_as_encrypted', ActsAsEncrypted::VERSION) do |p|
+  p.rubyforge_name = 'acts_as_encrypted'
+  p.developer 'Alexander Bartlow', 'bartlow.3@osu.edu'
+  
+end
+
+# vim: syntax=Ruby

data/bin/acts_as_encrypted

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+gem unpack acts_as_encrypted --target ./vendor/plugins/acts_as_encrypted
+echo "acts_as_encrypted installed, be sure to define a password and a cipher
+in vendor/plugins/acts_as_encrypted/config.rb"

data/lib/acts_as_encrypted.rb

@@ -0,0 +1,139 @@
+require 'openssl'
+require 'ostruct'
+# ActsAsEncrypted
+module ActsAsEncrypted
+  VERSION = '1.0.0'
+  DBCipherType='aes-256-cbc'
+  DBCipherKey='965f79fc27052324879b138b46df31e6f66c4d00'
+module Acts
+   module Encrypted
+     # included is called from the ActiveRecord::Base
+     # when you inject this module
+
+     def self.included(base)
+       base.extend AddActsAsMethod
+     end 
+
+     # this module stores the main function and the two modules for
+     # the instance and class functions
+     module AddActsAsMethod
+       def acts_as_encrypted(options = {})
+        # Here you can put additional association for the
+        # target class.
+        # belongs_to :role
+        # add class and instance methods
+         class_eval "include ActsAsEncrypted::Acts::Encrypted::InstanceMethods"
+       end
+     end
+
+     # Istance methods
+     module InstanceMethods 
+      # doing this our target class
+      # acquires all the methods inside ClassMethods module
+      # as class methods.
+
+       def self.included(aClass)
+         aClass.extend ClassMethods
+       end 
+
+       def field_is_encrypted?(field)
+         @encryption_initializer ||= OpenStruct.new
+         @encryption_initializer.send(field).nil?
+       end
+
+       def mark_as_encrypted(field)
+         @encryption_initializer.send(field + '=', nil)
+       end
+       
+       def mark_as_decrypted(field)
+          @encryption_initializer.send(field + '=', true)
+       end
+       
+       def decrypt_field(field)
+           mark_as_decrypted(field)
+           EncryptionWrapper.new(field).decrypt_field(self)
+       end
+       
+       module ClassMethods
+         # Class methods  
+         # Our encrypt_field function - when called sets up the callback hooks and the lazy decryption
+         def encrypt_fields(*args)
+           args.each do |fn|
+             before_save(EncryptionWrapper.new(fn))
+             after_save(EncryptionWrapper.new(fn))
+             fn = fn.to_s
+             # if the initializer says 'nil', then it's encrypted - since that's the default value
+             class_eval <<-HERE
+             # This is a custom accessor that
+             def #{fn}
+               if field_is_encrypted?(\"#{fn}\")
+                 decrypt_field(\"#{fn}\")
+               else
+                 #{fn}_safe
+               end
+             end
+             HERE
+             
+             class_eval <<-THERE
+             def #{fn}_safe
+               read_attribute \"#{fn}\" 
+             end
+             THERE
+           end
+         end # encrypt_fields
+         
+         alias_method :encrypt_field, :encrypt_fields
+       end 
+
+     end 
+   end
+end
+end
+
+# == Encryption Wrapper
+# Use +EncryptionWrapper+ as a callback in a model to encrypt database fields.
+# It is recomended that you don't use it directly, but instead use:
+#   acts_as_encrypted
+#   encrypt_field :field_one, :field_two, :field_three
+class EncryptionWrapper
+  def initialize(attribute)
+    @attribute = attribute.to_sym
+    @attribute_safe = (attribute.to_s + '_safe').to_sym
+    @attr_setter = (attribute.to_s + '=').to_sym
+  end
+  
+  def encrypt_field(record)
+    record.send(@attr_setter, encrypt(record.send(@attribute_safe)))
+  end
+  
+  def decrypt_field(record)
+    record.send(@attr_setter, decrypt(record.send(@attribute_safe)))
+  end
+  
+  alias_method :before_save, :encrypt_field
+  alias_method :after_save, :decrypt_field
+  
+  private
+  
+  def encrypt(value)
+    unless value.nil?
+      c = OpenSSL::Cipher.new(ActsAsEncrypted::DBCipherType).encrypt
+      c.pkcs5_keyivgen ActsAsEncrypted::DBCipherKey
+      c.update value
+      return ActiveSupport::Base64.encode64(c.final)
+    else
+      return nil
+    end
+  end
+  
+  def decrypt(value)
+    unless value.nil?
+      c = OpenSSL::Cipher.new(ActsAsEncrypted::DBCipherType).decrypt
+      c.pkcs5_keyivgen ActsAsEncrypted::DBCipherKey
+      c.update(ActiveSupport::Base64.decode64(value))
+      return c.final
+    else
+      return nil
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'acts_as_encrypted'
+ActiveRecord::Base.send(:include, ActsAsEncrypted::Acts::Encrypted)

data/rails/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_encrypted
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Alexander Bartlow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: A quick and easy encryption wrapper. using the built in openssl functions.  Usable in String, Text, or Binary fields. (Encodes in Base 64 before saving)
+email: 
+- bartlow.3@osu.edu
+executables: 
+- acts_as_encrypted
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- rails/init.rb
+- rails/install.rb
+- lib/acts_as_encrypted.rb
+- uninstall.rb
+- bin/acts_as_encrypted
+has_rdoc: true
+homepage: actsasencrypted.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: acts_as_encrypted
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A quick and easy encryption wrapper
+test_files: []
+