aboutsummaryrefslogtreecommitdiff
path: root/Documentation/MANPAGE-XRAY.md
blob: 5a5162c4b59b4224fb24ce1405e61521a1fd7bc0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
% GOCRYPTFS-XRAY(1)
% github.com/rfjakob
% Jan 2018

NAME
====

gocryptfs-xray - examine gocryptfs-related data

SYNOPSIS
========

#### Examine encrypted file/directory
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
========

Examine an encrypted file:

	gocryptfs-xray myfs/mCXnISiv7nEmyc0glGuhTQ

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)