No commit activity in last 3 years
No release in over 3 years
An AES Crypter for Sekrat
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0
~> 0.16

Runtime

~> 1.0.0
 Project Readme

Sekrat::Crypter::Aes

This is a Sekrat::Crypter implementation that uses the AES-256-GCM algorithm to encrypt/decrypt the data handed to it.

Installation

Add this line to your application's Gemfile:

gem 'sekrat-crypter-aes'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sekrat-crypter-aes

Usage

To use this Crypter with a Sekrat::Manager, you do something like this:

require 'sekrat'
require 'sekrat/crypter/aes'

confidant = Sekrat.manager(crypter: Sekrat::Crypter::Aes)

Now, when you confidant.put secrets, they will be encrypted pretty strongly.

NOTE: The encrypted payloads that result from this algorithm are basically made of binary data, so if you're using a storage mechanism that doesn't do well with that sort of thing (like plain old filesystem files), it might not be a bad idea to make sure that said storage mechanism either uses the proper encoding or transforms to a non-binary format.

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/sekrat/sekrat-crypter-aes-ruby. 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 Sekrat::Crypter::Aes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.