Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.65 KB

README.md

File metadata and controls

67 lines (46 loc) · 1.65 KB

agevault

agevault is a directory encryption tool using age file encryption.

It locks/unlocks a vault (directory) with a passphrase-protected identity file.

Like age, it features no config options, allowing for a straightforward secure flow.

Disclaimer

Use it at your own risk! (see LICENSE)

Also, this is a project in early-development and hasn't been thoroughly tested. So far, I've tested it on Linux.

Installation

Always install the latest release to make sure you have the latest security improvements and fixes. If the update has the same major version (e.g. v1.x.x), then it's guaranteed to be backwards compatible.

Download the pre-built binaries from the latest release.

Or using go:

$ go install github.com/ndavd/agevault@latest

Usage

lock/unlock directory with passphrase-protected identity file
usage: agevault [directory-name] lock|unlock|keygen

Securing my-vault/:

  1. Generate identity file
$ agevault my-vault keygen
create identity passphrase: 
confirm identity passphrase: 
.age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc.my-vault.key.age CREATED (do not change the filename)
  1. Lock vault
$ agevault my-vault lock
my-vault LOCKED with age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc
  1. Unlock vault
$ agevault my-vault unlock
enter passphrase for identity file ".age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc.my-vault.key.age": 
my-vault UNLOCKED
  1. That's it. Do your changes, lock it again, etc.