1
1
# agevault
2
2
3
- ` agevault ` is a directory encryption tool using [ age] ( https://github.com/FiloSottile/age ) file encryption.
3
+ ` agevault ` is a directory encryption tool using
4
+ [ age] ( https://github.com/FiloSottile/age ) file encryption.
4
5
5
6
It locks/unlocks a vault (directory) with a passphrase-protected identity file.
6
7
7
- Like age, it features no config options, allowing for a straightforward secure flow.
8
+ Like age, it features no config options, allowing for a straightforward secure
9
+ flow.
8
10
9
11
## Disclaimer
10
12
11
- ** Use it at your own risk!** (see [ LICENSE] ( https://github.com/ndavd/agevault/blob/main/LICENSE ) )
13
+ ** Use it at your own risk!** (see
14
+ [ LICENSE] ( https://github.com/ndavd/agevault/blob/main/LICENSE ) )
12
15
13
- Also, this is a project in early-development and hasn't been thoroughly tested. So far, I've tested it on Linux.
16
+ Also, this is a project in early-development and hasn't been thoroughly tested.
17
+ So far, I've tested it on Linux.
14
18
15
19
## Installation
16
20
17
- Download the pre-build binaries from the [ latest release] ( https://github.com/ndavd/agevault/releases/latest ) .
21
+ Always install the latest release to make sure you have the latest security
22
+ improvements and fixes. If the update has the same major version (e.g.
23
+ ` v1.x.x ` ), then it's guaranteed to be backwards compatible.
24
+
25
+ Download the pre-built binaries from the
26
+ [ latest release] ( https://github.com/ndavd/agevault/releases/latest ) .
18
27
19
28
Or using ` go ` :
29
+
20
30
```
21
31
$ go install github.com/ndavd/agevault@latest
22
32
```
@@ -29,22 +39,29 @@ usage: agevault [vault-name] lock|unlock|keygen
29
39
```
30
40
31
41
Securing ` my-vault/ ` :
42
+
32
43
1 . Generate identity file
44
+
33
45
```
34
46
$ agevault my-vault keygen
35
47
create identity passphrase:
36
48
confirm identity passphrase:
37
49
.age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc.my-vault.key.age CREATED (do not change the filename)
38
50
```
51
+
39
52
2 . Lock vault
53
+
40
54
```
41
55
$ agevault my-vault lock
42
56
my-vault SECURED with age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc
43
57
```
58
+
44
59
3 . Unlock vault
60
+
45
61
```
46
62
$ agevault my-vault unlock
47
63
enter passphrase for identity file ".age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc.my-vault.key.age":
48
64
my-vault DECRYPTED
49
65
```
66
+
50
67
4 . That's it. Do your changes, lock it again, etc.
0 commit comments