= 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.