Lite::Encryption

Lite::Encryption is a ActiveSupport::MessageEncryptor and OpenSSL::Cipher::Cipher wrapper libraries for encrypting and decrypting PORO object values and model attributes.

Installation

Add this line to your application’s Gemfile:

gem 'lite-encryption'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lite-encryption

Configurations
Key
Schemes
Message
Attribute

Configurations

rails g lite:encryption:install will generate the following file: ../config/initalizers/lite_encryption.rb

Lite::Encryption.configure do |config|
  config.encryption_iv = ENV['ENCRYPTION_IV']
  config.encryption_key = ENV['ENCRYPTION_KEY']
  config.encryption_salt = ENV['ENCRYPTION_SALT']
end

Key

Use the following to generate encryption values that you can then add to your credentials or ENV variables.

Lite::Encryption::Key.generate_iv       #=> "\x9C\x9F5<\xA5\x9B\x97\x97\xE2\x1DQ\x05"
Lite::Encryption::Key.generate_key      #=> "y\x0Eo\xC1Gll\x05Qv\x11[\xE1vN8<\xAFxU_\xCB\xD7\x02)0\xC1#\x99\xDD4N"
Lite::Encryption::Key.generate_password #=> "289b4997f758b31693d3315679d9fa7c"
Lite::Encryption::Key.generate_salt     #=> "\xD2\xBA\x9B\x81@e\x99\x8BN\a7\xC2\x95)f\x97k\xC9EM\xE0x\xFBO\x9BERBD\x85%n"

Schemes

The non-deterministic message class is the wrapper class for ActiveSupport::MessageEncryptor so you can pass it accepted options.

The deterministic message class is the wrapper class for OpenSSL::Cipher::Cipher so you can pass it accepted options.

Lite::Encryption::Schemes::NonDeterministic.encrypt('decrypted_text', purpose: 'sec-pur')
Lite::Encryption::Schemes::NonDeterministic.decrypt('==encrypted_text')

# - or -

service = Lite::Encryption::Deterministic.new

service.encrypt('decrypted_text')
service.decrypt('==encrypted_text')

Message

The message class is the wrapper class for both schemes so you can pass it accepted options.

Lite::Encryption::Message.encrypt('decrypted_text', purpose: 'sec-pur')
Lite::Encryption::Message.decrypt('==encrypted_text')

# - or -

service = Lite::Encryption::Message.new

service.encrypt('decrypted_text', expires_in: 2.hours)
service.decrypt('==encrypted_text')

# - or -

Lite::Encryption::Message.encrypt('decrypted_text', deterministic: true)
Lite::Encryption::Message.decrypt('==encrypted_text', deterministic: true)

# - or -

service = Lite::Encryption::Message.new

service.encrypt('decrypted_text', deterministic: true)
service.decrypt('==encrypted_text', deterministic: true)

Attribute

The attribute module provides a handy method for encrypting and decrypting attributes. You must add an encrypted_*[column_name] attribute to your database table like encrypted_number. You can then add code like the following for it to automatically encrypt and decrypt your values.

class CreditCard < ActiveRecord::Base
  extend Lite::Encryption::Attribute

  attr_encrypt :name, deterministic: true
  attr_encrypt :number, :cvv, purpose: 'payment-menthod'

end

You can then access attributes using the following:

credit_card = CreditCard.create(number: '1234')

credit_card.encrypted_number #=> '==encrypted_text'
credit_card.decrypted_number #=> '1234'
credit_card.number           #=> '1234'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lite-encryption. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Lite::Encryption project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.