Skip to content
This repository has been archived by the owner on Oct 29, 2019. It is now read-only.

Commit

Permalink
Update README (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelajr authored and austinmoore- committed Oct 13, 2017
1 parent b9c009f commit 1f9808f
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,9 @@ mrcrypt: Multi-Region Encryption
.. image:: https://codecov.io/gh/aol/mrcrypt/branch/master/graph/badge.svg
:target: https://codecov.io/gh/aol/mrcrypt

mrcrypt is a command-line tool that allows you to encrypt secrets in
multiple AWS regions using KMS keys using a technique called `Envelope
Encryption <http://docs.aws.amazon.com/kms/latest/developerguide/workflow.html>`__.
It is intended to be used with the `AWS Encryption SDK for
Java <https://github.com/awslabs/aws-encryption-sdk-java>`__, but could
be used on its own.
mrcrypt is a command-line tool which encrypts secrets that conform to the AWS Encryption SDK's `message format <http://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/message-format.html>`__ for envelope encryption. Envelope encryption is used to encrypt a file using a KMS data key. That data key is then encrypted with regional KMS Customer Master Keys. Each regionally encrypted data key is then stored in the encrypted message. When decrypting, the appropriate regional CMK is used to decrypt the data key, and the data key is then used to decrypt the file. In other words, encrypt once - decrypt from anywhere.

Because mrcrypt follows the AWS Encryption SDK's message format, files encrypted by mrcrypt can also be decrypted by the AWS Encryption SDKs for Python and Java. This allows application developers to build robust in-app decryption solutions.

Installation
============
Expand Down Expand Up @@ -186,6 +183,11 @@ Compatability with the AWS Encryption SDK
Encryption SDK.** But not all files encrypted with the AWS Encryption
SDK can be decrypted by mrcrypt.

mrcrypt itself does not use the
`AWS Encryption SDK for Python <https://github.com/awslabs/aws-encryption-sdk-python>`__,
as it was written prior to its release. However, future releases may
decide to do so.

Currently, mrcrypt only supports the AWS Encryption SDK's default (and
most secure) cryptographic algorithm:

Expand Down

0 comments on commit 1f9808f

Please sign in to comment.