diff options
| author | Jakob Unterwurzacher | 2024-04-18 18:51:04 +0200 |
|---|---|---|
| committer | Jakob Unterwurzacher | 2024-04-18 18:51:04 +0200 |
| commit | 7883d383d842707994b664f4d56ffbe833d3dc52 (patch) | |
| tree | 7f6a58a63a03d641b174a9da0a3fbfe264244c63 /Documentation/MANPAGE.md | |
| parent | 8ced867c4f2a26e00e32d7703fe13aa47d9df923 (diff) | |
MANPAGE: emphasize that -reverse implies -aessiv, so you must specify it with -masterkey
Fixes: https://github.com/rfjakob/gocryptfs/issues/841
Diffstat (limited to 'Documentation/MANPAGE.md')
| -rw-r--r-- | Documentation/MANPAGE.md | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md index 8793330..8c4af3f 100644 --- a/Documentation/MANPAGE.md +++ b/Documentation/MANPAGE.md @@ -155,7 +155,10 @@ mounted using gocryptfs v1.2 and higher. Default true. #### -reverse Reverse mode shows a read-only encrypted view of a plaintext -directory. Implies "-aessiv". +directory. Implies `-aessiv`. + +If you want to mount the encrypted view using `-masterkey`, you *must* +specify `-aessiv`. #### -xchacha Use XChaCha20-Poly1305 file content encryption. This should be much faster @@ -501,10 +504,14 @@ settings have to be passed on the command line: `-aessiv` when you mount a filesystem that was created using reverse mode, or `-plaintextnames` for a filesystem that was created with that option. -Examples: +Example 1: Mount a filesystem that was created using default options: + + gocryptfs -masterkey=6f717d8b-6b5f8e8a-fd0aa206-778ec093-62c5669b-abd229cd-241e00cd-b4d6713d cipher mnt + gocryptfs -masterkey=stdin cipher mnt + +Example 2: Mount a `gocryptfs -reverse` filesystem (note that you *must* specify `-aessiv`): - -masterkey=6f717d8b-6b5f8e8a-fd0aa206-778ec093-62c5669b-abd229cd-241e00cd-b4d6713d - -masterkey=stdin + gocryptfs -masterkey=stdin -aessiv cipher mnt Applies to: all actions that ask for a password. |