.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "GOCRYPTFS-XRAY" "1" "Jan 2018" "" ""
.hy
.SH NAME
.PP
gocryptfs-xray - examine gocryptfs-related data
.SH SYNOPSIS
.SS Examine encrypted file/directory
.PP
gocryptfs-xray CIPHERDIR/ENCRYPTED-FILE-OR-DIR
.SS Decrypt and show master key
.PP
gocryptfs-xray -dumpmasterkey CIPHERDIR/gocryptfs.conf
.SS Encrypt paths
.PP
gocryptfs-xray -encrypt-paths SOCKET
.SH DESCRIPTION
.PP
Available options are listed below.
.SS -0
.PP
Use \[rs]0 instead of \[rs]n as separator for -decrypt-paths and
-encrypt-paths.
.SS -aessiv
.PP
Assume AES-SIV mode instead of AES-GCM when examining an encrypted file.
Is not needed and has no effect in \f[V]-dumpmasterkey\f[R] mode.
.SS -decrypt-paths
.PP
Decrypt file paths using gocryptfs control socket.
Reads from stdin.
See \f[V]-ctlsock\f[R] in gocryptfs(1).
.SS -dumpmasterkey
.PP
Decrypts and shows the master key.
.SS -encrypt-paths
.PP
Encrypt file paths using gocryptfs control socket.
Reads from stdin.
See \f[V]-ctlsock\f[R] in gocryptfs(1).
.SH EXAMPLES
.PP
Examine an encrypted file:
.IP
.nf
\f[C]
gocryptfs-xray myfs/mCXnISiv7nEmyc0glGuhTQ
\f[R]
.fi
.PP
Print the master key:
.IP
.nf
\f[C]
gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf
\f[R]
.fi
.PP
Mount gocryptfs with control socket and use gocryptfs-xray to encrypt
some paths:
.IP
.nf
\f[C]
gocryptfs -ctlsock myfs.sock myfs myfs.mnt
echo -e \[dq]foo\[rs]nbar\[dq] | gocryptfs-xray -encrypt-paths myfs.sock
\f[R]
.fi
.SH SEE ALSO
.PP
gocryptfs(1) fuse(8)
.SH AUTHORS
github.com/rfjakob.