gocryptfs-xray: document -encrypt-paths / -decrypt-paths

This commit is contained in:
Jakob Unterwurzacher 2020-05-10 00:14:03 +02:00
parent a9895b3487
commit 5af7d3c699
2 changed files with 22 additions and 1 deletions

View File

@ -16,18 +16,32 @@ gocryptfs-xray CIPHERDIR/ENCRYPTED-FILE-OR-DIR
#### Decrypt and show master key #### Decrypt and show master key
gocryptfs-xray -dumpmasterkey CIPHERDIR/gocryptfs.conf gocryptfs-xray -dumpmasterkey CIPHERDIR/gocryptfs.conf
#### Encrypt paths
gocryptfs-xray -encrypt-paths SOCKET
DESCRIPTION DESCRIPTION
=========== ===========
Available options are listed below. Available options are listed below.
#### -0
Use \\0 instead of \\n as separator for -decrypt-paths and -encrypt-paths.
#### -aessiv #### -aessiv
Assume AES-SIV mode instead of AES-GCM when examining an encrypted file. Assume AES-SIV mode instead of AES-GCM when examining an encrypted file.
Is not needed and has no effect in `-dumpmasterkey` mode. Is not needed and has no effect in `-dumpmasterkey` mode.
#### -decrypt-paths
Decrypt file paths using gocryptfs control socket. Reads from stdin.
See `-ctlsock` in gocryptfs(1).
#### -dumpmasterkey #### -dumpmasterkey
Decrypts and shows the master key. Decrypts and shows the master key.
#### -encrypt-paths
Encrypt file paths using gocryptfs control socket. Reads from stdin.
See `-ctlsock` in gocryptfs(1).
EXAMPLES EXAMPLES
======== ========
@ -39,6 +53,12 @@ Print the master key:
gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf
Mount gocryptfs with control socket and use gocryptfs-xray to
encrypt some paths:
gocryptfs -ctlsock myfs.sock myfs myfs.mnt
echo -e "foo\nbar" | gocryptfs-xray -encrypt-paths myfs.sock
SEE ALSO SEE ALSO
======== ========
gocryptfs(1) fuse(8) gocryptfs(1) fuse(8)

View File

@ -46,7 +46,8 @@ func usage() {
fmt.Fprintf(os.Stderr, "\n"+ fmt.Fprintf(os.Stderr, "\n"+
"Examples:\n"+ "Examples:\n"+
" gocryptfs-xray myfs/mCXnISiv7nEmyc0glGuhTQ\n"+ " gocryptfs-xray myfs/mCXnISiv7nEmyc0glGuhTQ\n"+
" gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf\n") " gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf\n"+
" gocryptfs-xray -encrypt-paths myfs.sock\n")
} }
// sum counts the number of true values // sum counts the number of true values