Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.92 KB

README.md

File metadata and controls

66 lines (45 loc) · 2.92 KB
Raw

s3s2

Safe and secure (s2) file sharing with S3 (Amazon's Simple sharing service).

Simple Secure S3 Share - Share files securely with S3.

The purpose of s3s2 is to make it easy for end users that may not be familiar with S3 or GPG to do the right thing when they share files. The tool makes some simplifying assumptions that help to make it easy and provides just enough control to prevent bad things from happening.

Anything that can be done in this tool could be done by hand with tools like keybase + the S3 CLI. The value this project intends to bring is to have a single small distributable binary (for any mainstream platform) that just does the work.

Running s3s2

s3s2 share --debug true --bucket <your-bucket> --region <your-region> --directory test/s3s2/s3s2-up/ --org YourOrg --prefix <optional-prefix> --receiver-public-key test/s3s2/s3s2-keys/test.pubkey

This will take the current working directory, list the files to build a manifest.json file, compress each one, then encrypt each with the public key of the receiving party (so that only they, with the private key can read it) and upload the file in an S3 bucket.

An Example of Using S3 as an Organization that Wants to Receive Incoming Data Securely

  1. Set up your AWS KMS key, S3 bucket and GPG key (if desired).
  2. Run s3s2 genkey
  3. Run s3s2 config to build your reference config.
  4. Have your partner run s3s2 share --directory /dir/to/share --org OrgName
  5. Run s3s2 decrypt

Setting Up AWS

Other references:

Building a Configuration

s3s2 makes it easy to build a default configuration for clients to use. By using this, you can distribute a JSON file with your organization's default information so that using the tool is very easy.

om:s3s2 mk$ ./s3s2 config --file ~/s3s2-demo.json
Using config file: /Users/mk/.s3s2.json
Please specify a bucket.
> demo-incoming
Please specify a region.
> us-east-1
Please specify an org.
> Jemurai
Please specify a working directory.
> ~/Desktop/s3s2/
Please specify a file prefix (nothing sensitive).
> jemurai_
Please specify a public key to use (file path or url).
> https://s3s2.jemurai.com/.well_known/s3s2-pub.asc
Your config was written to /Users/mk/s3s2-demo.json . You can invoke with s3s2 --config /Users/mk/s3s2-demo.json

Building S3S2

Since Go provides the ability to cross compile, here are some of the common commands: GOOS=linux GOARCH=amd64 go build -v github.com/jemurai/s3s2

go build

Documentation

You can see the code level documentation by running: godoc -http=:6060 and visiting localhost:6060 in a browser.

Get Help

Feel free to create issues on the project to ask questions or come find us on Gitter to have a chat.