README.md in rapid-vaults-1.1.2 vs README.md in rapid-vaults-1.2.0

- old
+ new

@@ -1,15 +1,17 @@ # Rapid Vaults [![Build Status](https://travis-ci.org/mschuchard/rapid-vaults.svg?branch=master)](https://travis-ci.org/mschuchard/rapid-vaults) +[![CircleCI](https://circleci.com/gh/mschuchard/rapid-vaults.svg?style=svg)](https://circleci.com/gh/mschuchard/rapid-vaults) - [Description](#description) - [Usage](#usage) - [CLI](#cli) - [API](#api) + - [gRPC](#grpc) + - [Docker](#docker) - [Ansible](#ansible) - [Puppet](#puppet) - - [Hiera](#hiera) - [Chef](#chef) - [Contributing](#contributing) ## Description @@ -19,11 +21,11 @@ Ansible-Vault is very similar to Rapid Vaults. Both are streamlined and easy to use ad-hoc encryption and decryption tools. The two primary differences are that Rapid Vaults has a Ruby API instead of a Python API and that Rapid Vaults offers additional verification and defense layers. The API can also be considered similar to the high level recipes provided by PyCA's Cryptography. ### Non-Comparative Software -Rapid Vaults is not similar to tools like RbNaCl or Hashicorp's Vault. RbNaCl offers advanced encryption techniques by providing bindings to libsodium. Rapid Vaults relies upon AES-256-GCM (OpenSSL) or GPG's algorithms (RSA, SHA-512, etc.). Hashicorp's Vault is Enterprise level software with many powerful features and conveniences. Rapid Vaults is a lightweight and narrowly focused tool. +Rapid Vaults is not similar to tools like RbNaCl or Hashicorp's Vault. RbNaCl offers advanced encryption techniques by providing bindings to libsodium. Rapid Vaults relies upon AES-256-GCM (OpenSSL) or GPG's algorithms (RSA, SHA-512, etc.). Hashicorp's Vault is Enterprise level software with many powerful features and conveniences. Rapid Vaults is a lightweight and narrowly focused tool. However, Rapid Vaults can be considered algorithmically very similar to Vault's Transit secret engine. ## Usage ### CLI @@ -48,15 +50,15 @@ #### Generate Key and Nonce with SSL `rapid-vaults -g` #### Encrypt File with SSL -`rapid-vaults -e -k cert.key -n nonce.txt -p secret -o /output/dir unencrypted.txt` +`rapid-vaults -e -k key.txt -n nonce.txt -p secret -o /output/dir unencrypted.txt` #### Decrypt a File with SSL -`rapid-vaults -d -k cert.key -n nonce.txt -t tag.txt -p secret -o /output/dir encrypted.txt` +`rapid-vaults -d -k key.txt -n nonce.txt -t tag.txt -p secret -o /output/dir encrypted.txt` #### Generate Keys with GPG This is the only situation where a `--gpgparams` flag and argument is required or utilized. The file provided as the argument should look like the following: ``` @@ -110,11 +112,11 @@ require 'rapid-vaults' options = {} options[:action] = :encrypt options[:file] = '/path/to/data.txt' -options[:key] = '/path/to/cert.key' +options[:key] = '/path/to/key.txt' options[:nonce] = '/path/to/nonce.txt' options[:pw] = File.read('/path/to/password.txt') # optional encrypted_contents, tag = RapidVaults::API.main(options) ``` @@ -124,11 +126,11 @@ require 'rapid-vaults' options = {} options[:action] = :decrypt options[:file] = '/path/to/encrypted_data.txt' -options[:key] = '/path/to/cert.key' +options[:key] = '/path/to/key.txt' options[:nonce] = '/path/to/nonce.txt' options[:tag] = '/path/to/tag.txt' options[:pw] = File.read('/path/to/password.txt') # optional decrypted_contents = RapidVaults::API.main(options) ``` @@ -189,9 +191,17 @@ options[:algorithm] = :gpgme options[:file] = '/path/to/encrypted_data.txt' options[:pw] = File.read('/path/to/password.txt') decrypted_contents = RapidVaults::API.main(options) ``` + +### Docker + +A supported [Docker image](https://hub.docker.com/r/matthewschuchard/rapid-vaults) of Rapid-Vaults is now available from the public Docker Hub registry. Please consult the repository documentation for further usage information. + +### gRPC + +forthcoming ### Ansible forthcoming