chintala-strongbox 0.6.1

data/.gitignore

@@ -0,0 +1,5 @@
+test/debug.log
+doc
+/strongbox-*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in x.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Joseph A. Ilacqua, Jr
+
+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.textile

@@ -0,0 +1,182 @@
+h1. Strongbox
+
+Strongbox provides Public Key Encryption for ActiveRecord. By using a public key sensitive information can be encrypted and stored automatically. Once stored a password is required to access the information.
+
+Because the largest amount of data that can practically be encrypted with a public key is 245 byte, by default Strongbox uses a two layer approach. First it encrypts the attribute using symmetric encryption with a randomly generated key and initialization vector (IV) (which can just be thought of as a second key), then it encrypts those with the public key.
+
+Strongbox stores the encrypted attribute in a database column by the same name, i.e. if you tell Strongbox to encrypt "secret" then it will be store in "secret" in the database, just as the unencrypted attribute would be. If symmetric encryption is used (the default) two additional columns "secret_key" and "secret_iv" are needed as well.
+
+The attribute is automatically encrypted simply by setting it:
+
+  user.secret = "Shhhhhhh..."
+
+and decrypted by calling the "decrypt" method with the private key password.
+
+  plain_text = user.secret.decrypt 'letmein'
+
+h2. Quick Start
+
+In your model:
+
+bc. class User < ActiveRecord::Base
+  encrypt_with_public_key :secret,
+    :key_pair => File.join(RAILS_ROOT,'config','keypair.pem')
+end
+  
+In your migrations:
+
+bc. class AddSecretColumnsToUser < ActiveRecord::Migration
+  def self.up
+    add_column :users, :secret, :binary
+    add_column :users, :secret_key, :binary
+    add_column :users, :secret_iv, :binary
+  end
+  def self.down
+    remove_column :users, :secret
+    remove_column :users, :secret_key
+    remove_column :users, :secret_iv
+  end  
+end
+  
+Generate a key pair:
+
+(Choose a strong password.)
+
+bc. openssl genrsa -des3 -out config/private.pem 2048
+openssl rsa -in config/private.pem -out config/public.pem -outform PEM -pubout
+cat config/private.pem  config/public.pem >> config/keypair.pem
+
+In your views and forms you don't need to do anything special to encrypt data. To decrypt call:
+
+bc. user.secret.decrypt 'password'
+
+h2. Gem installation (Rails 2.1+)
+
+In config/environment.rb:
+
+bc. config.gem "strongbox"
+
+h2. Usage
+
+_encrypt_with_public_key_ sets up the attribute it's called on for automatic encryption.  It's simplest form is:
+
+bc. class User < ActiveRecord::Base
+  encrypt_with_public_key :secret,
+    :key_pair => File.join(RAILS_ROOT,'config','keypair.pem')
+end
+
+Which will encrypt the attribute "secret". The attribute will be encrypted using symmetric encryption with an automatically generated key and IV encrypted using the public key. This requires three columns in the database "secret", "secret_key", and "secret_iv" (see below).
+
+Options to encrypt_with_public_key are:
+
+:public_key -  Public key.  Overrides :key_pair. See Key Formats below.
+
+:private_key - Private key.  Overrides :key_pair.
+
+:key_pair - Key pair, containing both the public and private keys.
+
+:symmetric :always/:never - Encrypt the date using symmetric encryption. The public key is used to encrypt an automatically generated key and IV. This allows for large amounts of data to be encrypted. The size of data that can be encrypted directly with the public is limit to key size (in bytes) - 11. So a 2048 key can encrypt *245 bytes*. Defaults to *:always*.
+
+:symmetric_cipher - Cipher to use for symmetric encryption.  Defaults to *'aes-256-cbc'*.  Other ciphers support by OpenSSL may be used.
+
+:base64 true/false - Use Base64 encoding to convert encrypted data to text. Use when binary save data storage is not available.  Defaults to *false*.
+
+:padding - Method used to pad data encrypted with the public key. Defaults to *RSA_PKCS1_PADDING*. The default should be fine unless you are dealing with legacy data.
+
+:ensure_required_columns - Make sure the required database column(s) exist.  Defaults to *true*, set to false if you want to encrypt/decrypt data stored outside of the database.
+
+For example, encrypting a small attribute, providing only the public key for extra security, and Base64 encoding the encrypted data:
+
+bc. class User < ActiveRecord::Base
+  validates_length_of :pin_code, :is => 4
+  encrypt_with_public_key :pin_code, 
+    :symmetric => :never,
+    :base64 => true,
+    :public_key => File.join(RAILS_ROOT,'config','public.pem')
+end
+
+Strongbox can encrypt muliple attributes. _encrypt_with_public_key_ accepts a list of attributes, assuming they will use the same options:
+
+bc. class User < ActiveRecord::Base
+  encrypt_with_public_key :secret, :double_secret,
+    :key_pair => File.join(RAILS_ROOT,'config','keypair.pem')
+end
+
+If you need different options, call _encrypt_with_public_key_ for each attribute:
+
+bc. class User < ActiveRecord::Base
+  encrypt_with_public_key :secret,
+    :key_pair => File.join(RAILS_ROOT,'config','keypair.pem')
+  encrypt_with_public_key :double_secret,
+    :key_pair => File.join(RAILS_ROOT,'config','another_key.pem')
+end
+
+h2 Key Formats
+
+_:public_key_, _:private_key_, and _:key_pair_ can be in one of the following formats:
+
+* A string containing path to a file. This is the default interpretation of a string.
+* A string contanting a key in PEM format, needs to match this the regex /^-+BEGIN .* KEY-+$/
+* A symbol naming a method to call. Can return any of the other valid key formats.
+* A instance of OpenSSL::PKey::RSA. Must be unlocked to be used as the private key.
+
+h2. Key Generation
+
+h3. In the shell
+
+Generate a key pair:
+
+bc. openssl genrsa -des3 -out config/private.pem 2048
+Generating RSA private key, 2048 bit long modulus
+......+++
+.+++
+e is 65537 (0x10001)
+Enter pass phrase for config/private.pem:
+Verifying - Enter pass phrase for config/private.pem:
+
+and extract the the public key:
+
+bc. openssl rsa -in config/private.pem -out config/public.pem -outform PEM -pubout
+Enter pass phrase for config/private.pem:
+writing RSA key
+
+If you are going to leave the private key installed it's easiest to create a single key pair file:
+
+bc. cat config/private.pem  config/public.pem >> config/keypair.pem
+
+Or, for added security, store the private key file else where, leaving only the public key.
+
+h3. In code
+
+bc. require 'openssl'
+rsa_key = OpenSSL::PKey::RSA.new(2048)
+cipher =  OpenSSL::Cipher::Cipher.new('des3')
+private_key = rsa_key.to_pem(cipher,'password')
+public_key = rsa_key.public_key.to_pem
+key_pair = private_key + public_key
+
+_private_key_, _public_key_, and _key_pair_ are strings, store as you see fit.
+
+h2. Table Creation
+
+In it's default configuration Strongbox requires three columns, one the encrypted data, one for the encrypted symmetric key, and one for the encrypted symmetric IV. If symmetric encryption is disabled then only the columns for the data being encrypted is needed.
+
+If your underlying database allows, use the *binary* column type. If you must store your data in text format be sure to enable Base64 encoding and to use the *text* column type. If you use a _string_ column and encrypt anything greater than 186 bytes (245 bytes if you don't enable Base64 encoding) *your data will be lost*.
+
+
+h2. Security Caveats
+
+If you don't encrypt your data, then an attacker only needs to steal that data to get your secrets.
+
+If encrypt your data using symmetric encrypts and a stored key, then the attacker needs the data and the key stored on the server.
+
+If you use public key encryption, the attacker needs the data, the private key, and the password. This means the attacker has to sniff the password somehow, so that's what you need to protect against.
+
+h2. Authors
+
+Spike Ilacqua
+
+h2. Thanks
+
+Strongbox's implementation drew inspiration from Thoughtbot's Paperclip gem http://www.thoughtbot.com/projects/paperclip
+

data/Rakefile

@@ -0,0 +1,39 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'strongbox'
+
+desc 'Default: run tests.'
+task :default => :test
+
+desc 'Test the strongbox gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << '.'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the strongbox gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = 'Strongbox'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Generate a gemspec file for GitHub"
+task :gemspec do
+  $spec = eval(File.read('strongbox.gemspec'))
+  $spec.validate
+end
+
+desc "Build the gem"
+task :build  => :gemspec do
+  Gem::Builder.new($spec).build
+end

data/init.rb

@@ -0,0 +1 @@
+require 'strongbox'

data/lib/strongbox.rb

@@ -0,0 +1,97 @@
+require 'openssl'
+require 'base64'
+
+require 'strongbox/lock'
+
+module Strongbox
+
+  VERSION = "0.6.1"
+
+  RSA_PKCS1_PADDING	= OpenSSL::PKey::RSA::PKCS1_PADDING
+  RSA_SSLV23_PADDING	= OpenSSL::PKey::RSA::SSLV23_PADDING
+  RSA_NO_PADDING		= OpenSSL::PKey::RSA::NO_PADDING
+  RSA_PKCS1_OAEP_PADDING	= OpenSSL::PKey::RSA::PKCS1_OAEP_PADDING
+
+  class << self
+    # Provides for setting the default options for Strongbox
+    def options
+      @options ||= {
+        :base64 => false,
+        :symmetric => :always,
+        :padding => RSA_PKCS1_PADDING,
+        :symmetric_cipher => 'aes-256-cbc',
+        :ensure_required_columns => true
+      }
+    end
+
+    def included base #:nodoc:
+      base.extend ClassMethods
+      if base.respond_to?(:class_attribute)
+        base.class_attribute :lock_options
+      end
+    end
+  end
+
+  class StrongboxError < StandardError #:nodoc:
+  end
+
+  module ClassMethods
+    # +encrypt_with_public_key+ gives the class it is called on an attribute that
+    # when assigned is automatically encrypted using a public key.  This allows the
+    # unattended encryption of data, without exposing the information need to decrypt
+    # it (as would be the case when using symmetric key encryption alone).  Small
+    # amounts of data may be encrypted directly with the public key.  Larger data is
+    # encrypted using symmetric encryption. The encrypted data is stored in the
+    # database column of the same name as the attibute.  If symmetric encryption is
+    # used (the default) additional column are need to store the generated password
+    # and IV.
+    #
+    # Last argument should be the options hash
+    # Argument 0..-2 contains columns to be encrypted
+    def encrypt_with_public_key(*args)
+      include InstanceMethods
+      
+      options = args.delete_at(-1) || {}
+      
+      unless options.is_a?(Hash)
+        args.push(options)
+        options = {}
+      end
+      
+      if args.one?
+        name = args.first
+      else
+        return args.each { |name| encrypt_with_public_key(name, options) }
+      end
+      
+      if respond_to?(:class_attribute)
+        self.lock_options = {} if lock_options.nil?
+      else
+        class_inheritable_reader :lock_options
+        write_inheritable_attribute(:lock_options, {}) if lock_options.nil?
+      end
+
+      lock_options[name] = options.symbolize_keys.reverse_merge Strongbox.options
+      define_method name do
+        lock_for(name)
+      end
+
+      define_method "#{name}=" do | plaintext |
+        lock_for(name).encrypt plaintext
+      end
+
+    end
+  end
+
+  module InstanceMethods
+    def lock_for name
+      @_locks ||= {}
+      @_locks[name] ||= Lock.new(name, self, self.class.lock_options[name])
+    end
+  end
+end
+
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Base.send(:include, Strongbox)
+end
+

data/lib/strongbox/lock.rb

@@ -0,0 +1,152 @@
+module Strongbox
+  # The Lock class encrypts and decrypts the protected attribute.  It
+  # automatically encrypts the data when set and decrypts it when the private
+  # key password is provided.
+  class Lock
+
+    def initialize name, instance, options = {}
+      @name              = name
+      @instance          = instance
+
+      @size = 0
+
+      options = Strongbox.options.merge(options)
+
+      @base64 = options[:base64]
+      @public_key = options[:public_key] || options[:key_pair]
+      @private_key = options[:private_key] || options[:key_pair]
+      @padding = options[:padding]
+      @symmetric = options[:symmetric]
+      @symmetric_cipher = options[:symmetric_cipher]
+      @symmetric_key = options[:symmetric_key] || "#{name}_key"
+      @symmetric_iv = options[:symmetric_iv] || "#{name}_iv"
+      @ensure_required_columns = options[:ensure_required_columns]
+    end
+
+    def encrypt plaintext
+      ensure_required_columns  if @ensure_required_columns
+      unless @public_key
+        raise StrongboxError.new("#{@instance.class} model does not have public key_file")
+      end
+      if !plaintext.nil?
+        @size = plaintext.size # For validations
+        # Using a blank password in OpenSSL::PKey::RSA.new prevents reading
+        # the private key if the file is a key pair
+        public_key = get_rsa_key(@public_key,"")
+        if @symmetric == :always
+          cipher = OpenSSL::Cipher::Cipher.new(@symmetric_cipher)
+          cipher.encrypt
+          cipher.key = random_key = cipher.random_key
+          cipher.iv = random_iv = cipher.random_iv
+
+          ciphertext = cipher.update(plaintext)
+          ciphertext << cipher.final
+          encrypted_key = public_key.public_encrypt(random_key,@padding)
+          encrypted_iv = public_key.public_encrypt(random_iv,@padding)
+          if @base64
+            encrypted_key = Base64.encode64(encrypted_key)
+            encrypted_iv = Base64.encode64(encrypted_iv)
+          end
+          @instance[@symmetric_key] = encrypted_key
+          @instance[@symmetric_iv] = encrypted_iv
+        else
+          ciphertext = public_key.public_encrypt(plaintext,@padding)
+        end
+        ciphertext =  Base64.encode64(ciphertext) if @base64
+        @instance[@name] = ciphertext
+      end
+    end
+
+    # Given the private key password decrypts the attribute.  Will raise
+    # OpenSSL::PKey::RSAError if the password is wrong.
+
+    def decrypt password = nil, ciphertext = nil
+      # Given a private key and a nil password OpenSSL::PKey::RSA.new() will
+      # *prompt* for a password, we default to an empty string to avoid that.
+      ciphertext ||= @instance[@name]
+      return nil if ciphertext.nil?
+      return "" if ciphertext.empty?
+
+      return "*encrypted*" if password.nil?
+      unless @private_key
+        raise StrongboxError.new("#{@instance.class} model does not have private key_file")
+      end
+
+      if ciphertext
+        ciphertext = Base64.decode64(ciphertext) if @base64
+        private_key = get_rsa_key(@private_key,password)
+        if @symmetric == :always
+          random_key = @instance[@symmetric_key]
+          random_iv = @instance[@symmetric_iv]
+          if @base64
+            random_key = Base64.decode64(random_key)
+            random_iv = Base64.decode64(random_iv)
+          end
+          cipher = OpenSSL::Cipher::Cipher.new(@symmetric_cipher)
+          cipher.decrypt
+          cipher.key = private_key.private_decrypt(random_key,@padding)
+          cipher.iv = private_key.private_decrypt(random_iv,@padding)
+          plaintext = cipher.update(ciphertext)
+          plaintext << cipher.final
+        else
+          plaintext = private_key.private_decrypt(ciphertext,@padding)
+        end
+      else
+        nil
+      end
+    end
+
+    def to_s
+      decrypt
+    end
+
+    def to_json(options = nil)
+      to_s
+    end
+
+    # Needed for validations
+    def blank?
+      @instance[@name].blank?
+    end
+
+    def nil?
+      @instance[@name].nil?
+    end
+
+    def size
+      @size
+    end
+
+    def length
+      @size
+    end
+
+  def ensure_required_columns
+    columns = [@name.to_s]
+    columns += [@symmetric_key, @symmetric_iv] if @symmetric == :always
+    columns.each do |column|
+      unless @instance.class.column_names.include? column
+        raise StrongboxError.new("#{@instance.class} model does not have database column \"#{column}\"")
+      end
+    end
+  end
+
+private
+    def get_rsa_key(key,password = '')
+      if key.is_a?(Proc)
+        key = key.call
+      end
+
+      if key.is_a?(Symbol)
+        key = @instance.send(key)
+      end
+
+      return key if key.is_a?(OpenSSL::PKey::RSA)
+
+      if key !~ /^-+BEGIN .* KEY-+$/
+        key = File.read(key)
+      end
+      return OpenSSL::PKey::RSA.new(key,password)
+    end
+  end
+end