Skip to content

Commit

Permalink
DESIGN.md: Add markdown headings
Browse files Browse the repository at this point in the history
  • Loading branch information
rfjakob committed Dec 8, 2014
1 parent f4d1006 commit ca6c46e
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions DESIGN.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

For notes about internationalization, see README-NLS.

EncFS is a program which provides an encrypted virtual filesystem for Linux
Expand All @@ -7,7 +6,8 @@ download the latest version of FUSE ). FUSE provides a loadable kernel module
which exports a filesystem interface to user-mode. EncFS runs entirely in
user-mode and acts as a transparent encrypted filesystem.

Usage:
Usage
-----

- To see command line options, see the man page for encfs and encfsctl, or for
brief usage message, run the programs without an argument (or '-h'):
Expand All @@ -33,7 +33,8 @@ Usage:
created.


Technology:
Technology
----------

- Encfs uses algorithms from third-party libraries (OpenSSL is the default) to
encrypt data and filenames.
Expand Down Expand Up @@ -92,7 +93,8 @@ Technology:
file has a unique initialization vector. This makes it infeasible to copy a
whole block from one file to another.

Backward Compatibility:
Backward Compatibility
----------------------

At the top level of the raw (encrypted) storage for an EncFS filesystem is a
configuration file, created automatically by EncFS when a new filesystem is
Expand All @@ -109,15 +111,17 @@ Backward Compatibility:
newer versions use algorithms and/or new options which were not previously
available.

Utility:
Utility
-------

In addition to the "encfs" main program, a utility "encfsctl" has been
provided which can perform some operations on encfs filesystems. Encfsctl
can display information about the filesystem for the curious (the encryption
algorithm used, key length, block size), and more importantly it can also
change the user-supplied password used to encrypt the volume key.

Dependencies:
Dependencies
------------

Encfs uses the OpenSSL toolkit (http://www.openssl.org) by default.
OpenSSL is not covered by the GPL, and some people are concerned about the
Expand Down

0 comments on commit ca6c46e

Please sign in to comment.