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 rootdir
12
13       encfsctl info rootdir
14
15       encfsctl passwd rootdir
16
17       encfsctl showcruft rootdir
18
19       encfsctl decode rootdir [encoded name]
20

DESCRIPTION

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

COMMANDS

27       info
28           Display basic information about the filesystem.  Takes a single
29           argument, rootdir, which is the root directory of the encrypted
30           filesystem.  The filesystem need not be mounted.  Info is also the
31           default command if only a root directory is provided on the command
32           line.
33
34       passwd
35           Allows changing the password of the encrypted filesystem.  The user
36           will be prompted for the existing password and the new password.
37
38       showcruft
39           Recursively search through the entire volume and display all files
40           which are not decodable (only checks filename encoding, not block
41           MAC headers).  This might be useful for cleanup in case you've made
42           use of features which create files which are not decodable under
43           the primary key.
44
45       decode
46           Allows you to specify an encoded name on the command line, and dis‐
47           played a decoded version.  This is mostly useful for debugging, as
48           debug messages always display encrypted filenames (to avoid leaking
49           sensitive data through the debug channels).  So this command pro‐
50           vides a way to decode the filenames.
51
52           If no name is specified on the command line, then a list of file‐
53           names will be read from stdin and decoded.
54

EXAMPLES

56       Show information about an encrypted filesystem:
57
58        % encfsctl info ~/.crypt
59
60        Version 5 configuration; created by EncFS 1.1 (revision 20040504)
61        Filesystem cipher: "ssl/aes" , version 2:1:1
62        Filename encoding: "nameio/block" , version 3:0:1
63        Key Size: 192 bits
64        Block Size: 512 bytes
65        Each file contains 8 byte header with unique IV data.
66        Filesname encoded using IV chaining mode.
67

DISCLAIMER

69       This library is distributed in the hope that it will be useful, but
70       WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
71       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  Please refer to the
72       "COPYING" file distributed with encfs for complete details.
73

AUTHORS

75       EncFS was written by Valient Gough <vgough@pobox.com>.
76