summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJakob Unterwurzacher2020-05-10 00:14:03 +0200
committerJakob Unterwurzacher2020-05-10 00:14:03 +0200
commit5af7d3c699d1f78ba81b447285dd4ebae78ee644 (patch)
treee3af1cb7758a066d18c5c85d8d65c823f7b33492 /Documentation
parenta9895b34872d2299cfe424444fab15516e7f96c9 (diff)
gocryptfs-xray: document -encrypt-paths / -decrypt-paths
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/MANPAGE-XRAY.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/Documentation/MANPAGE-XRAY.md b/Documentation/MANPAGE-XRAY.md
index da041b6..5a5162c 100644
--- a/Documentation/MANPAGE-XRAY.md
+++ b/Documentation/MANPAGE-XRAY.md
@@ -16,18 +16,32 @@ gocryptfs-xray CIPHERDIR/ENCRYPTED-FILE-OR-DIR
#### Decrypt and show master key
gocryptfs-xray -dumpmasterkey CIPHERDIR/gocryptfs.conf
+#### Encrypt paths
+gocryptfs-xray -encrypt-paths SOCKET
+
DESCRIPTION
===========
Available options are listed below.
+#### -0
+Use \\0 instead of \\n as separator for -decrypt-paths and -encrypt-paths.
+
#### -aessiv
Assume AES-SIV mode instead of AES-GCM when examining an encrypted file.
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
Decrypts and shows the master key.
+#### -encrypt-paths
+Encrypt file paths using gocryptfs control socket. Reads from stdin.
+See `-ctlsock` in gocryptfs(1).
+
EXAMPLES
========
@@ -39,6 +53,12 @@ Print the master key:
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
========
gocryptfs(1) fuse(8)