Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Rails gem for obscuring database fields
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
.document
.gitignore
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
VERSION
hot_like_sauce.gemspec

README.md

HotLikeSauce

For when your data is too hot to view

This is some sweet code for ActiveRecord (rails) that will allow you to obscure database fields. The data will always be obscured in the database, but can be read as plaintext or obscured. This is useful for admin views where you can display obscured data for people who shouldn't be seeing it.

Usage

gem 'hot_like_sauce'
class Post < ActiveRecord::Base
  attr_obscurable :body
end

By default, when you read the value you get the original plain text.

p = Post.create(:body => "readable text")
p.body
#=> "readable text"

Post.obscure_read_on_fields!(:body)
p.body
#=> "fE4KSGqOoOej6BNsow0nTg=="

You can configure this on a per field basis by default

class Post < ActiveRecord::Base
  attr_obscurable :body, :obscure_on_read => true
end

p = Post.create(:body => "readable text")
p.body
#=> "fE4KSGqOoOej6BNsow0nTg=="

Post.obscure_read_on_fields! can be called with no arguments to set all attr_obscurable fields. The inverse method is Post.unobscure_read_on_fields!

You can also create an accessor method to get the unobscured field(s).

class Post < ActiveRecord::Base
  attr_obscurable :body, :obscure_on_read => true, :unobscured_accessor => true
end

p = Post.create(:body => "readable text")
p.body
#=> "fE4KSGqOoOej6BNsow0nTg=="

p.unobscured_body
#=> "readable text"

Configuration

HotLikeSauce.secret_key = "this-should-be-long-and-random"

HotLikeSauce.crypto_method = "aes-256-cbc" # default's to aes-256-cbc

Contributing to hot-like-sauce

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 Justin Derrek Van Eaton. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.