Skip to content
Simple encryption of secrets using RbNaCl.
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
exe
lib
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
README.md
Rakefile
elabs-logo.png
safebox.gemspec

README.md

Safebox

Build Status Dependency Status Code Climate Gem Version Inline docs

Psst, full documentation can be found at rubydoc.info/gems/safebox

Simple encrypted storage of application secrets using libsodium.

Safebox is sponsored by Elabs.

elabs logo

Installation

Add this line to your application's Gemfile:

gem 'safebox'

And then execute:

$ bundle

Or install it yourself as:

$ gem install safebox

Usage

Using the CLI

TODO.

safebox -h

Using the API

require "safebox"

password = "this is a super-secret password"
message = "Elvis lives!"

encrypted_message = Safebox.encrypt(password, message)
decrypted_message = Safebox.decrypt(password, encrypted_message)

Using econfig

First, add safebox to your Gemfile:

gem "econfig", require: "econfig/rails"
gem "safebox", require: "safebox/econfig"

Safebox will automatically configure econfig for you.

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/elabs/safebox. 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.

You can’t perform that action at this time.