attr_encryptor

attr_encryptor

Generates attr_accessors that encrypt and decrypt attributes transparently

It works with ANY class, however, you get a few extra features when you're using it with ActiveRecord, DataMapper, or Sequel

Installation

gem install attr_encryptor

Usage

Basic

Encrypting attributes has never been easier:

Your database

add a encrypted_ssn, encrypted_ssn_salt, encrypted_ssn_iv. All of them will be populated automatically

create_table :google_apps_admins do |t|
  t.string :username
  t.string :encrypted_password
  t.string :encrypted_password_salt
  t.string :encrypted_password_iv
  t.string :domain
  t.timestamps
end

Your model

class User
  attr_accessor :name
  attr_encrypted :ssn, :key => 'a secret key'
  
end

Controllers/views

@user = User.new
@user.ssn = '123-45-6789'
@user.ssn # returns the unencrypted version of :ssn
@user.save

@user = User.load
@user.ssn # decrypts :encrypted_ssn and returns '123-45-6789'

The attr_encrypted method is also aliased as attr_encryptor to conform to Ruby's attr_ naming conventions.

Specifying the encrypted attribute name

By default, the encrypted attribute name is encrypted_#{attribute} (e.g. attr_encrypted :email would create an attribute named encrypted_email). So, if you're storing the encrypted attribute in the database, you need to make sure the encrypted_#{attribute} field exists in your table(as well as encrypted_#{attribute}_iv and encrypted_#{attribute}_salt). You have a couple of options if you want to name your attribute something else.

The :attribute option

You can simply pass the name of the encrypted attribute as the :attribute option:

class User
  attr_encrypted :email, :key => 'a secret key', :attribute => 'email_encrypted'
end

This would generate an attribute named email_encrypted

The :prefix and :suffix options

If you're planning on encrypting a few different attributes and you don't like the encrypted_#{attribute} naming convention then you can specify your own:

class User
  attr_encrypted :email, :credit_card, :ssn, :key => 'a secret key', :prefix => 'secret_', :suffix => '_crypted'
end

This would generate the following attributes: secret_email_crypted, secret_credit_card_crypted, and secret_ssn_crypted.

Encryption keys

Although a :key option may not be required (see custom encryptor below), it has a few special features

Unique keys for each attribute

You can specify unique keys for each attribute if you'd like:

class User
  attr_encrypted :email, :key => 'a secret key'
  attr_encrypted :ssn, :key => 'a different secret key'
end

Symbols representing instance methods as keys

If your class has an instance method that determines the encryption key to use, simply pass a symbol representing it like so:

class User
  attr_encrypted :email, :key => :encryption_key

  def encryption_key
    # does some fancy logic and returns an encryption key
  end
end

Procs as keys

You can pass a proc/lambda object as the :key option as well:

class User
  attr_accessor :key
  attr_encrypted :email, :key => proc { |user| user.key }
end

However when calling User.new, User.create, User.update_attributes the :key attribute has to precede the :email or key will be nil and you'll get an Exception,

Conditional encrypting

There may be times that you want to only encrypt when certain conditions are met. For example maybe you're using rails and you don't want to encrypt attributes when you're in development mode. You can specify conditions like this:

class User < ActiveRecord::Base
  attr_encrypted :email, :key => 'a secret key', :unless => Rails.env.development?
end

You can specify both :if and :unless options. If you pass a symbol representing an instance method then the result of the method will be evaluated. Any objects that respond to :call are evaluated as well.

Custom encryptor

The Encryptor (see http://github.com/shuber/encryptor) class is used by default. You may use your own custom encryptor by specifying the :encryptor, :encrypt_method, and :decrypt_method options

Lets suppose you'd like to use this custom encryptor class:

class SillyEncryptor
  def self.silly_encrypt(options)
      (options[:value] + options[:secret_key]).reverse
  end

  def self.silly_decrypt(options)
     options[:value].reverse.gsub(/#{options[:secret_key]}$/, '')
  end
end

Simply set up your class like so:

class User
  attr_encrypted :email, :secret_key => 'a secret key', :encryptor => SillyEncryptor, :encrypt_method => :silly_encrypt, :decrypt_method => :silly_decrypt
end

Any options that you pass to attr_encrypted will be passed to the encryptor along with the :value option which contains the string to encrypt/decrypt. Notice it uses :secret_key instead of :key.

Custom algorithms

The default Encryptor uses the standard ruby OpenSSL library. It's default algorithm is aes-256-cbc. You can modify this by passing the :algorithm option to the attr_encrypted call like so:

class User
  attr_encrypted :email, :key => 'a secret key', :algorithm => 'bf'
end

Run openssl list-cipher-commands to view a list of algorithms supported on your platform. See http://github.com/danpal/encryptor for more information.

aes-128-cbc
aes-128-ecb
aes-192-cbc
aes-192-ecb
aes-256-cbc
aes-256-ecb
base64
bf
bf-cbc
bf-cfb
bf-ecb
bf-ofb
cast
cast-cbc
cast5-cbc
cast5-cfb
cast5-ecb
cast5-ofb
des
des-cbc
des-cfb
des-ecb
des-ede
des-ede-cbc
des-ede-cfb
des-ede-ofb
des-ede3
des-ede3-cbc
des-ede3-cfb
des-ede3-ofb
des-ofb
des3
desx
idea
idea-cbc
idea-cfb
idea-ecb
idea-ofb
rc2
rc2-40-cbc
rc2-64-cbc
rc2-cbc
rc2-cfb
rc2-ecb
rc2-ofb
rc4
rc4-40

Default options

Let's imagine that you have a few attributes that you want to encrypt with different keys, but you don't like the encrypted_#{attribute} naming convention. Instead of having to define your class like this:

class User
  attr_encrypted :email, :key => 'a secret key', :prefix => '', :suffix => '_crypted'
  attr_encrypted :ssn, :key => 'a different secret key', :prefix => '', :suffix => '_crypted'
  attr_encrypted :credit_card, :key => 'another secret key', :prefix => '', :suffix => '_crypted'
end

You can simply define some default options like so:

class User
  attr_encrypted_options.merge!(:prefix => '', :suffix => '_crypted')
  attr_encrypted :email, :key => 'a secret key'
  attr_encrypted :ssn, :key => 'a different secret key'
  attr_encrypted :credit_card, :key => 'another secret key'
end

This should help keep your classes clean and DRY.

Encoding

You're probably going to be storing your encrypted attributes somehow (e.g. filesystem, database, etc) and may run into some issues trying to store a weird encrypted string. I've had this problem myself using MySQL. You can simply pass the :encode option to automatically encode/decode when encrypting/decrypting.

class User
  attr_encrypted :email, :key => 'some secret key', :encode => true
end

The default encoding is m* (base64). You can change this by setting :encode => 'some encoding'. See the Array#pack method at http://www.ruby-doc.org/core/classes/Array.html#M002245 for more encoding options.

String Encoding/Charset

If you are trying to store UTF-8 (or other non-english charsets) strings in your encrypted parameters, you may get the decrypted string back as a US-ASCII or ASCII-8BIT string.

To fix this, add the :charset => 'UTF-8' option to your encrypted attribute definitions. This option defaults to whatever your Encoding.default_internal is set to. :charset => :default will force it to use the default value.

This option only applies to encrypted strings and will be ignored when encrypting marshalled objects.

Marshaling

You may want to encrypt objects other than strings (e.g. hashes, arrays, etc). If this is the case, simply pass the :marshal option to automatically marshal when encrypting/decrypting.

class User
  attr_encrypted :credentials, :key => 'some secret key', :marshal => true
end

You may also optionally specify :marshaler, :dump_method, and :load_method if you want to use something other than the default Marshal object.

Encrypt/decrypt attribute methods

If you use the same key to encrypt every record (per attribute) like this:

class User
  attr_encrypted :email, :key => 'a secret key'
end

Then you'll have these two class methods available for each attribute: User.encrypt_email(email_to_encrypt) and User.decrypt_email(email_to_decrypt). This can be useful when you're using ActiveRecord (see below).

ActiveRecord

If you're using this gem with ActiveRecord, you get a few extra features:

Default options

For your convenience, the :encode option is set to true by default since you'll be storing everything in a database.

DataMapper and Sequel

Just like the default options for ActiveRecord, the :encode option is set to true by default since you'll be storing everything in a database.

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.