https://github.com/danielpclark/aes_keeper
Encrypt data to database savable strings with AES 256 encryption.
https://github.com/danielpclark/aes_keeper
Last synced: about 2 months ago
JSON representation
Encrypt data to database savable strings with AES 256 encryption.
- Host: GitHub
- URL: https://github.com/danielpclark/aes_keeper
- Owner: danielpclark
- License: mit
- Created: 2015-01-09T06:33:50.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-04-15T21:41:36.000Z (about 9 years ago)
- Last Synced: 2025-11-29T16:13:13.372Z (7 months ago)
- Language: Ruby
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# AesKeeper
A database safe encryption using AES 256 CBC. Key required, Salt optional. Returns encrypted String and IV,
or you can call **.to_s** to receive the encrypted data as one String. Decrypt will accept either form of the
{ encrypted: '', iv: '' } pair or the String result.
**NOTE:**
* Class object AesKeeper uses marshal which may be incompatible across platforms and Ruby versions. A benefit from this is the ability to place entire Ruby Objects in encrypted format.
* Please use AESKeeper::AesKeeperPure for any compatibility reasons. It needs String input.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'aes_keeper'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install aes_keeper
## Implementation
##### AESKeeper::AESKeeperMarshal && AesKeeper
- Marshalling Object implementation
##### AESKeeper::AESKeeperPure
- Pure String implementation. Backwards compatible and crossplatform compatible.
If you are using the the AesKeeper from previous versions and would like to switch
without changing throughout all of your code you can add an initializer in your software
to change the AesKeeper from point at AESKeeper::AESKeeperMarshal to AESKeeper::AESKeeperPure
```ruby
require 'aes_keeper'
Object.send(:remove_const, 'AesKeeper')
AesKeeper = AESKeeper::AESKeeperPure
```
## Usage
With encryption and iv result separate:
```ruby
cipher = AesKeeper.new(key: 'some really good 32+ character long key for encryption! ^_^')
result = cipher.encrypt("apples")
# => {:encrypted=>"K1E/a75/3zxNKCTXJFJZaVe8jjeHFQG+Cv1Lxntz3oM=\n", :iv=>"uQozeVXYhaeK7Rvh1na6kA==\n"}
cipher.decrypt(result)
# => "apples"
```
With encryption and iv result combined:
```ruby
cipher = AesKeeper.new(key: 'some really good 32+ character long key for encryption! ^_^')
result = cipher.encrypt("apples").to_s
# => "xPbb+kVIROlA5YHvSaKsYcCobgBz/TQHpJ5wP9lAuBQ=\n:WIaGiOhjFBRBVJReiA2aTA==\n"
cipher.decrypt(result)
# => "apples"
```
You can specify a Salt as well:
```ruby
AesKeeper.new(
key: 'some really good 32+ character long key for encryption! ^_^',
salt: 'asdfqwerty'
)
```
More advanced usages are visible in the test suite.
## Contributing
This code can be refactored and tested. Otherwise I consider this project feature complete. It's designed
with assumptions for its implementation and it's met those requirements.
1. Fork it ( https://github.com/danielpclark/aes_keeper/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License
Copyright (c) 2015-2016 Daniel P. Clark
MIT License
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.