Skip to content
ansible-vault CLI reimplemented in go
HTML Go Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark Support encrypt_string method (#2) Oct 30, 2018
cmd/gwvault Support check for TTY terminal when using `view` (#7) Aug 19, 2019
.gitignore update README Aug 17, 2018
CHANGELOG.md
CONTRIBUTING.md build out of cli tool Aug 17, 2018
LICENSE
Makefile
README.md Support rekey method (#4) Mar 25, 2019
release.sh Added release script Aug 17, 2018

README.md

gwvault - GoodwayGroup Ansible Vault

ansible-vault CLI reimplemented in go

ansible-vault is a very powerful tool and we wanted to simplifying the install and management of the tool as a standalone, cross platform tool.

Basic Usage

Use in place of ansible-vault. All commands are reimplemented. The tool will default to asking for your Vault password.

$ gwvault -h
NAME:
   gwvault - encryption/decryption utility for Ansible data files

USAGE:
   gwvault [global options] command [command options] [arguments...]

VERSION:
   1.2.0

COMMANDS:
     encrypt         encrypt file
     decrypt         decrypt file
     edit            edit file and re-encrypt
     rekey           alter encryption password and re-encrypt
     create          create a new encrypted file
     view            view contents of encrypted file
     encrypt_string  encrypt provided string
     help, h         Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --vault-password-file VAULT_PASSWORD_FILE  vault password file VAULT_PASSWORD_FILE
   --help, -h                                 show help
   --version, -v                              print the version

Installation

$ curl https://i.jpillora.com/GoodwayGroup/gwvault! | bash

Benchmarks

Benchmarking done using bench. Execute the benchmark/run.sh script to generate a new benchmark.

As compared to ansible-vault, typical actions take a 1/10th the time to complete.

Action ansible-vault gwvault
encrypt 633 ms 76 ms
decrypt 639 ms 72 ms
encrypt_string 536 ms 42 ms
encrypt + decrypt 1,160 ms 105 ms

See ./benchmark/results.html for a detailed breakdown of the results.

Built With

Deployment

Run ./release.sh $VERSION

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We employ auto-changelog to manage the CHANGELOG.md. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

Sponsors

goodwaygroup

You can’t perform that action at this time.