290 lines
7.6 KiB
Groff
290 lines
7.6 KiB
Groff
.\" cryfs(1) man page
|
|
.
|
|
.TH cryfs 1
|
|
.
|
|
.
|
|
.
|
|
.SH NAME
|
|
cryfs \- cryptographic filesystem for the cloud
|
|
.
|
|
.
|
|
.
|
|
.SH SYNOPSIS
|
|
.\" mount/create syntax
|
|
.B cryfs
|
|
[\fB\-c\fR \fIfile\fR]
|
|
[\fB\-f\fR]
|
|
[\fIoptions\fR]
|
|
.I basedir mountpoint
|
|
.br
|
|
.\" show-ciphers syntax
|
|
.B cryfs \-\-help\fR|\fB\-\-version\fR|\fB\-\-show-ciphers
|
|
.
|
|
.
|
|
.
|
|
.SH DESCRIPTION
|
|
.
|
|
.B CryFS
|
|
encrypts your files, so you can safely store them anywhere.
|
|
.PP
|
|
.
|
|
The goal of CryFS is not only to keep file contents, but also
|
|
file sizes, metadata and directory structure confidential.
|
|
CryFS uses
|
|
.B encrypted same-size blocks
|
|
to store both the files themselves and the block's relations to another.
|
|
These blocks are stored as individual files in the base directory,
|
|
which can then be synchronized with cloud services such as Dropbox.
|
|
.PP
|
|
.
|
|
The blocks are encrypted using a random key, which is stored in a
|
|
.B configuration file
|
|
encrypted by the user's passphrase.
|
|
By default, it will be stored together with the data in the base directory,
|
|
but you can choose a different location if you do not want it in your cloud
|
|
or when using a weak passphrase.
|
|
.
|
|
.
|
|
.
|
|
.SH USING CRYFS
|
|
.
|
|
.SS Selecting base and mount directories
|
|
.
|
|
While you can access your files through your
|
|
.B mount directory,
|
|
CryFS actually places them in your
|
|
.B base directory
|
|
after encrypting.
|
|
CryFS will encrypt and decrypt your files 'on the fly' as they are accessed,
|
|
so files will never be stored on the disk in unencrypted form.
|
|
.PP
|
|
.
|
|
You can choose any empty directory as your base, but your mount directory
|
|
should be outside of any cloud storage, as your cloud may try to sync your
|
|
(temporarily mounted) unencrypted files as well.
|
|
.
|
|
.SS Setup and usage of your encrypted directory
|
|
.
|
|
.TP
|
|
Creating and mounting your encrypted storage use the same command-line syntax:
|
|
.B cryfs
|
|
.I basedir mountpoint
|
|
.PP
|
|
.
|
|
If CryFS detects an encrypted storage in the given base directory, you will
|
|
be asked for the passphrase to unlock and mount it. Otherwise, CryFS will
|
|
help you with creating one, just follow the on-screen instructions.
|
|
.PP
|
|
.
|
|
.TP
|
|
After you are done working with your encrypted files, unmount your storage \
|
|
with the command
|
|
.B cryfs-unmount
|
|
.I mountpoint
|
|
.
|
|
.
|
|
.SS Changing your passphrase
|
|
.
|
|
As the encryption key to your CryFS storage is stored in your configuration
|
|
file, it would be possible to re-encrypt it using a different passphrase
|
|
(although this feature has not been implemented yet).
|
|
.PP
|
|
.
|
|
However, this does not change the actual encryption key of your storage, so
|
|
someone with access to the old passphrase and configuration file (for example
|
|
through the file history of your cloud or your file system) could still access
|
|
your files, even those created after the password change.
|
|
.PP
|
|
.
|
|
For this reason, the recommended way to change your passphrase is to create a
|
|
new CryFS storage with the new passphrase and move your files from the old to
|
|
the new one.
|
|
.
|
|
.
|
|
.
|
|
.SH OPTIONS
|
|
.
|
|
.SS Getting help
|
|
.
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
.
|
|
Show a help message containing short descriptions for all options.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-show\-ciphers\fR
|
|
.
|
|
Show a list of all supported encryption ciphers.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-version\fR
|
|
.
|
|
Show the CryFS version number.
|
|
.
|
|
.
|
|
.SS Encryption parameters
|
|
.
|
|
.TP
|
|
\fB\-\-blocksize\fR \fIarg\fR
|
|
.
|
|
Set the block size to \fIarg\fR bytes. Defaults to
|
|
.BR 32768 .
|
|
.br
|
|
\" Intentional space
|
|
.br
|
|
A higher block size may help reducing the file count in your base directory
|
|
(especially when storing large files), but will also waste more space when
|
|
storing smaller files.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-cipher\fR \fIarg\fR
|
|
.
|
|
Use \fIarg\fR as the cipher for the encryption. Defaults to
|
|
.BR aes-256-gcm .
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-c\fR \fIfile\fR, \fB\-\-config\fR \fIfile\fR
|
|
.
|
|
Use \fIfile\fR as configuration file for this CryFS storage instead of
|
|
\fIbasedir\fR/cryfs.config
|
|
.
|
|
.
|
|
.SS General options
|
|
.
|
|
.TP
|
|
\fB\-f\fR, \fB\-\-foreground\fI
|
|
.
|
|
Run CryFS in the foreground. Stop using CTRL-C.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-allow-filesystem-upgrade\fI
|
|
.
|
|
Allow upgrading the file system if it was created with an old CryFS version. After the upgrade, older CryFS versions might not be able to use the file system anymore.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-allow-integrity-violations\fI
|
|
.
|
|
By default, CryFS checks for integrity violations, i.e. will notice if an adversary modified or rolled back the file system. Using this flag, you can disable the integrity checks. This can for example be helpful for loading an old snapshot of your file system without CryFS thinking an adversary rolled it back.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-allow-replaced-filesystem\fI
|
|
.
|
|
By default, CryFS remembers file systems it has seen in this base directory and checks that it didn't get replaced by an attacker with an entirely different file system since the last time it was loaded. However, if you do want to replace the file system with an entirely new one, you can pass in this option to disable the check.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-create-missing-basedir\fI
|
|
.
|
|
Creates the base directory even if there is no directory currently there, skipping the normal confirmation message to create it later.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-create-missing-mountpoint\fI
|
|
.
|
|
Creates the mountpoint even if there is no directory currently there, skipping the normal confirmation message to create it later.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-missing-block-is-integrity-violation\fR=true
|
|
.
|
|
When CryFS encounters a missing ciphertext block, it cannot cannot (yet) know if it was deleted by an unauthorized adversary or by a second authorized client. This is one of the restrictions of the integrity checks currently in place. You can enable this flag to treat missing ciphertext blocks as integrity violations, but then your file system will not be usable by multiple clients anymore. By default, this flag is disabled.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-logfile\fR \fIfile\fR
|
|
.
|
|
Write status information to \fIfile\fR. If no logfile is given, CryFS will
|
|
write them to syslog in background mode, or to stdout in foreground mode.
|
|
.
|
|
.
|
|
.TP
|
|
\fB\-\-unmount\-idle\fR \fIarg\fR
|
|
.
|
|
Unmount automatically after \fIarg\fR minutes of inactivity.
|
|
.
|
|
.
|
|
.
|
|
.SH FUSE Options
|
|
.
|
|
.TP
|
|
\fB\-o\fR \fIoption\fR, \fB\-\-fuse\-option\fR \fIoption\fR
|
|
.
|
|
Pass through options to the FUSE filesystem driver.
|
|
|
|
.TP
|
|
For example:
|
|
.TP
|
|
\fB\-o\fR \fIallow_other\fR
|
|
This option overrides the security measure restricting file
|
|
access to the filesystem owner, so that all users (including
|
|
root) can access the files.
|
|
.TP
|
|
\fB\-o\fR \fIallow_root\fR
|
|
This option is similar to allow_other but file access is
|
|
limited to the filesystem owner and root. This option and
|
|
allow_other are mutually exclusive.
|
|
.
|
|
.
|
|
.
|
|
.SH ENVIRONMENT
|
|
.
|
|
.TP
|
|
\fBCRYFS_FRONTEND\fR=noninteractive
|
|
.
|
|
With this option set, CryFS will only ask for the encryption passphrase once.
|
|
Instead of asking the user for parameters not specified on the command line,
|
|
it will just use the default values. CryFS will also not ask you to confirm
|
|
your passphrase when creating a new CryFS storage.
|
|
.br
|
|
\" Intentional space
|
|
.br
|
|
Set this environment variable when automating CryFS using external tools or
|
|
shell scripts.
|
|
.
|
|
.
|
|
.TP
|
|
\fBCRYFS_NO_UPDATE_CHECK\fR=true
|
|
.
|
|
By default, CryFS connects to the internet to check for known security
|
|
vulnerabilities and new versions. This option disables this.
|
|
.
|
|
.
|
|
.TP
|
|
\fBCRYFS_LOCAL_STATE_DIR\fR=[path]
|
|
.
|
|
Sets the directory cryfs uses to store local state. This local state
|
|
is used to recognize known file systems and run integrity checks
|
|
(i.e. check that they haven't been modified by an attacker.
|
|
Default value: ${HOME}/.cryfs
|
|
.
|
|
.
|
|
.
|
|
.SH SEE ALSO
|
|
.
|
|
.BR mount.fuse (1),
|
|
.BR fusermount (1)
|
|
.BR cryfs-unmount (1)
|
|
.PP
|
|
.
|
|
For more information about the design of CryFS, visit
|
|
.B https://www.cryfs.org
|
|
.PP
|
|
.
|
|
Visit the development repository at
|
|
.B https://github.com/cryfs/cryfs
|
|
for the source code and the full list of contributors to CryFS.
|
|
.
|
|
.
|
|
.
|
|
.SH AUTHORS
|
|
.
|
|
CryFS was created by Sebastian Messmer and contributors.
|
|
This man page was written by Maximilian Wende.
|