Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goodwaygroup/gwvault
ansible-vault CLI reimplemented in go
https://github.com/goodwaygroup/gwvault
ansible ansible-vault benchmark cli cli-reimplemented decrypt decryption encrypt encrytion golang
Last synced: 30 days ago
JSON representation
ansible-vault CLI reimplemented in go
- Host: GitHub
- URL: https://github.com/goodwaygroup/gwvault
- Owner: GoodwayGroup
- License: mit
- Created: 2018-08-17T14:31:52.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T00:38:18.000Z (4 months ago)
- Last Synced: 2024-09-07T03:19:34.833Z (4 months ago)
- Topics: ansible, ansible-vault, benchmark, cli, cli-reimplemented, decrypt, decryption, encrypt, encrytion, golang
- Language: Go
- Homepage: https://goodwaygroup.github.io/gwvault/
- Size: 2.21 MB
- Stars: 30
- Watchers: 11
- Forks: 10
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
Please see [the docs for details on the commands.](./docs/gwvault.md)
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:
main [global options] command [command options] [arguments...]
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 inputs of encrypted file
encrypt_string, av_encrypt_string encrypt provided string, output in ansible-vault format
install-manpage Generate and install man page
version, v Print version info
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
--new-vault-password-file NEW_VAULT_PASSWORD_FILE new vault password file for rekey NEW_VAULT_PASSWORD_FILE
--help, -h show help (default: false)
```
## Installation
### [`asdf` plugin](https://github.com/GoodwayGroup/asdf-gwvault)
Add plugin:
```
$ asdf plugin add gwvault
```
Install the latest version:
```
$ asdf install gwvault latest
```
### [Homebrew](https://brew.sh) (for macOS users)
```
brew tap GoodwayGroup/gwvault
brew install gwvault
```
### curl binary
```
$ curl https://i.jpillora.com/GoodwayGroup/gwvault! | bash
```
### [docker](https://www.docker.com/)
The compiled docker images are maintained on [GitHub Container Registry (ghcr.io)](https://github.com/orgs/GoodwayGroup/packages/container/package/gwvault).
We maintain the following tags:
- `edge`: Image that is build from the current `HEAD` of the main line branch.
- `latest`: Image that is built from the [latest released version](https://github.com/GoodwayGroup/gwvault/releases)
- `x.y.z` (versions): Images that are build from the tagged versions within Github.
```bash
docker pull ghcr.io/goodwaygroup/gwvault
docker run -v "$PWD":/workdir ghcr.io/goodwaygroup/gwvault --version
```
### man page
To install `man` page:
```
$ gwvault install-manpage
```
## Benchmarks
Benchmarking done using [`bench`](https://github.com/Gabriel439/bench). Execute the `benchmark/run.sh` script to generate a new benchmark.
As compared to `ansible-vault` (v2.9.11 on python v3.8.5), typical actions take a 80% less time to complete.
|Action|`ansible-vault`|`gwvault`|
|------|---------------|---------|
| encrypt | 482 ms | **94 ms** |
| decrypt | 499 ms | **96 ms** |
| rekey | 650 ms | **162 ms** |
| encrypt_string | 429 ms | **64 ms** |
| encrypt + decrypt | 1,087 ms | **168 ms** |
See [`./benchmark/results.html`](./benchmark/results.html) for a detailed breakdown of the results after running the benchmark.
## Built With
* go v1.16+
* make
* [goreleaser](https://goreleaser.com/install/)
## Deployment
Run `./release.sh $VERSION`
This will update docs, changelog, add the tag, push main and the tag to the repo. The `goreleaser` action will publish the binaries to the Github Release.
If you want to simulate the `goreleaser` process, run the following command:
```
$ curl -sL https://git.io/goreleaser | bash -s -- --rm-dist --skip-publish --snapshot
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
1. Fork the [GoodwayGroup/gwvault](https://github.com/GoodwayGroup/gwvault) repo
1. Use `go >= 1.16`
1. Branch & Code
1. Run linters :broom: `golangci-lint run`
- The project uses [golangci-lint](https://golangci-lint.run/usage/install/#local-installation)
1. Commit with a Conventional Commit
1. Open a PR
## Versioning
We employ [git-chglog](https://github.com/git-chglog/git-chglog) to manage the [CHANGELOG.md](CHANGELOG.md). For the versions available, see the [tags on this repository](https://github.com/GoodwayGroup/gwvault/tags).
## Authors
* **Derek Smith** - [@clok](https://github.com/clok)
* **Paulo Black** - [@paulojblack](https://github.com/paulojblack)
See also the list of [contributors](https://github.com/GoodwayGroup/gwvault/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Acknowledgments
* Thank you to [@pbthorste](https://github.com/pbthorste) for doing the heavy lifting on [avtool](https://github.com/pbthorste/avtool)
## Sponsors
[![goodwaygroup][goodwaygroup]](https://goodwaygroup.com)
[goodwaygroup]: https://s3.amazonaws.com/gw-crs-assets/goodwaygroup/logos/ggLogo_sm.png "Goodway Group"