Skip to content

Commit

Permalink
MANPAGE: emphasize that -reverse implies -aessiv, so you must specify…
Browse files Browse the repository at this point in the history
… it with -masterkey

Fixes: #841
  • Loading branch information
rfjakob committed Apr 18, 2024
1 parent 8ced867 commit 7883d38
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions Documentation/MANPAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 7883d38

Please sign in to comment.