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 [--extpass=prog] rootdir [encoded name ...]
20
21       encfsctl encode [--extpass=prog] rootdir [plaintext name ...]
22

DESCRIPTION

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

COMMANDS

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

EXAMPLES

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

DISCLAIMER

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

AUTHORS

91       EncFS was written by Valient Gough <vgough@pobox.com>.
92