encfsctl(1)

1ENCFSCTL(1)                  Encrypted Filesystem                  ENCFSCTL(1)
2
3
4

NAME

6       encfsctl - administrative tool for working with EncFS filesystems
7

SYNOPSIS

9       encfsctl [command command_args]
10
11       encfsctl [info] rootdir
12
13       encfsctl passwd rootdir
14
15       encfsctl showcruft rootdir
16
17       encfsctl decode [--extpass=prog] rootdir [encoded name ...]
18
19       encfsctl encode [--extpass=prog] rootdir [plaintext name ...]
20
21       encfsctl cat [--extpass=prog] [--reverse] rootdir <(cipher|plain)
22       filename>
23

DESCRIPTION

25       encfsctl is an administrative tool for working with EncFS filesystems.
26       It is capable of changing the user supplied password, displaying basic
27       information about an encrypted volume, and other related operations.
28

COMMANDS

30       info
31           Display basic information about the filesystem.  Takes a single
32           argument, rootdir, which is the root directory of the encrypted
33           filesystem.  The filesystem need not be mounted.  Info is also the
34           default command if only a root directory is provided on the command
35           line.
36
37       passwd
38           Allows changing the password of the encrypted filesystem.  The user
39           will be prompted for the existing password and the new password.
40
41       showcruft
42           Recursively search through the entire volume and display all files
43           which are not decodable (only checks filename encoding, not block
44           MAC headers).  This might be useful for cleanup in case you've made
45           use of features which create files which are not decodable under
46           the primary key.
47
48       decode
49           Allows you to specify an encoded name on the command line, and
50           displays decoded version.  This is mostly useful for debugging, as
51           debug messages always display encrypted filenames (to avoid leaking
52           sensitive data through the debug channels).  So this command
53           provides a way to decode the filenames.
54
55           The --extpass option can be used to specify the program which
56           returns the password - just like with encfs.
57
58           If no names are specified on the command line, then a list of
59           filenames will be read from stdin and decoded.
60
61       encode
62           Allows you to specify a filename on the command line, and displays
63           its encoded version. This is useful if e.g. you are taking a backup
64           of an encrypted directory and would like to exclude some files.
65
66           The --extpass option can be used to specify the program which
67           returns the password - just like with encfs.
68
69           If no names are specified on the command line, then a list of
70           filenames will be read from stdin and encoded.
71
72       cat Decodes and cats the content of an encrypted file.  The filename
73           can be given in a plain or ciphered form.  With --reverse The file
74           content will instead be encrypted.
75

EXAMPLES

77       Show information about an encrypted filesystem:
78
79        % encfsctl info ~/.crypt
80
81        Version 5 configuration; created by EncFS 1.1 (revision 20040504)
82        Filesystem cipher: "ssl/aes" , version 2:1:1
83        Filename encoding: "nameio/block" , version 3:0:1
84        Key Size: 192 bits
85        Block Size: 512 bytes
86        Each file contains 8 byte header with unique IV data.
87        Filesname encoded using IV chaining mode.
88

DISCLAIMER

90       This library is distributed in the hope that it will be useful, but
91       WITHOUT ANY WARRANTY; without even the implied warranty of
92       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  Please refer to
93       the "COPYING" file distributed with encfs for complete details.
94

AUTHORS

96       EncFS was written by Valient Gough <vgough@pobox.com>.
97