Project

s3encrypt

0.01
No commit activity in last 3 years
No release in over 3 years
This Gem encrypts and uploads a file to s3 with a KMS generated key, or the reverse.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 10.0

Runtime

 Project Readme

Gem Version Code Climate Inline docs

S3encrypt

This Gem allows the encrypted upload or download of files from S3 using KMS generated encryption keys. It's the gemified version of https://github.com/DonMills/ruby-KMS-S3.

There's an in-depth blog post describing what this does and how it does it at http://www.singlestoneconsulting.com/blog/2016/september/secrets-management.

####New: Now with a matching golang tool that is 100% compatible! https://github.com/DonMills/s3encrypt

Installation

Add this line to your application's Gemfile:

gem 's3encrypt'

And then execute:

$ bundle

Or install it yourself as:

$ gem install s3encrypt

Usage

require 's3encrypt'
S3encrypt.putfile("local_filename", "remote_filename", "bucket", "context", "masterkmskey")
S3encrypt.getfile("local_filename", "remote_filename", "bucket", "context")
S3encrypt.getfile_as_json("remote_filename", "bucket", "context")
S3encrypt.getfile_as_string("remote_filename", "bucket", "context")

To do kms managed SSE:

S3encrypt.putfile_ssekms("local_filename", "remote_filename", "bucket", "context", "masterkmskey")

To do S3 managed SSE:

S3encrypt.putfile_sses3("local_filename", "remote_filename", "bucket", "context", "masterkmskey")

When Using EC2 roles:

Don't forget to set the region (usually as an environment variable) as the SDK will not extrapolate it from the metadata...

Development

After checking out the repo, run bin/setup to install dependencies. 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/DonMills/s3encrypt.

License

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