~ecryptfs/ecryptfs/trunk

« back to all changes in this revision

Viewing changes to doc/manpage/ecryptfs.pod

  • Committer: mhalcrow@us.ibm.com
  • Date: 2007-11-06 22:56:01 UTC
  • Revision ID: git-v1:f8357de9d554b274497b5cce9db4347254b7e7eb
Initial import of eCryptfs filesystem userspace utilities (mount helper, daemon component,
etc.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
=pod
 
3
 
 
4
=head1 NAME
 
5
 
 
6
eCryptfs - an enterprise-class cryptographic filesystem for linux
 
7
 
 
8
=head1 SYNOPSIS
 
9
 
 
10
B<mount -t ecryptfs>
 
11
[I<SRC DIR>]
 
12
[I<DST DIR>]
 
13
B<-o>
 
14
[I<OPTIONS>]
 
15
 
 
16
=head1 DESCRIPTION
 
17
 
 
18
eCryptfs is a POSIX-compliant enterprise-class stacked cryptographic
 
19
filesystem for Linux. It is derived from Erez Zadok's Cryptfs, implemented
 
20
through the FiST framework for generating stacked filesystems. eCryptfs
 
21
extends Cryptfs to provide advanced key management and policy features.
 
22
eCryptfs stores cryptographic metadata in the header of each file written,
 
23
so that encrypted files can be copied between hosts; the file will be
 
24
decryptable with the proper key, and there is no need to keep track of any
 
25
additional information aside from what is already in the encrypted file
 
26
itself. Think of eCryptfs as a sort of "gnupgfs."
 
27
 
 
28
=head1 OPTIONS
 
29
 
 
30
=head2 STANDARD OPTIONS
 
31
 
 
32
=over 10
 
33
 
 
34
=item B<key=(keytype):[Key Options]>
 
35
 
 
36
Specify the type of key to be used when mounting eCryptfs.
 
37
 
 
38
=item B<cipher=(cipher)>
 
39
 
 
40
Specify the symmetric cipher to be used on a per file basis
 
41
 
 
42
=item B<ecryptfs_key_bytes=(key_bytes)>
 
43
 
 
44
Specify the keysize to be used with the selected cipher. If the cipher
 
45
only has one keysize the keysize does not need to be specified.
 
46
 
 
47
=item B<passthrough>
 
48
 
 
49
Allows for non-eCryptfs files to be read and written from within an
 
50
eCryptfs mount. This option is turned off by default.
 
51
 
 
52
=item B<verbosity=(level)>
 
53
Seting verbosity prevents eCryptfs from interactively requesting for options
 
54
to be entered.  The mount will fail if an essential option is absent.
 
55
 
 
56
=head2 KEY OPTIONS
 
57
 
 
58
=item B<passwd=(passphrase)>
 
59
 
 
60
The actual password is password. Since the password is visible to utilities
 
61
(like ’ps’ under Unix) this form should only be used where security is not
 
62
important.
 
63
 
 
64
=item B<passfile=(filename)>
 
65
 
 
66
The password should be specified in a file with B<passwd=(passphrase)>. It is
 
67
highly reccomended that the file be stored on a secure medium such as a
 
68
personal usb key.
 
69
 
 
70
=item B<passfd=(file descriptor)>
 
71
 
 
72
The password is specified through the specified file descriptor.
 
73
 
 
74
=item B<passstdin>
 
75
 
 
76
The user types their passphrase in through stdin.
 
77
 
 
78
=item B<salt=(hex value)>
 
79
 
 
80
The salt should be specified as a 16 digit hex value. 
 
81
 
 
82
=item B<keyfile=(filename)>
 
83
 
 
84
The filename should be the filename of a file containing an RSA SSL key.
 
85
 
 
86
=head1 SEE ALSO
 
87
 
 
88
L<mount(8)|mount(8)>
 
89
 
 
90
=head1 NOTES
 
91
 
 
92
Do not run eCryptfs in higher verbosity levels
 
93
unless you are doing so for the sole purpose of development, since
 
94
secret values will be written out to the system log in that case.
 
95
 
 
96
=head1 BUGS
 
97
 
 
98
Please send bug reports to the lead developer, an eCryptfs mailing
 
99
list hosted from SourceForge, or to the SourceForge bug tracker for
 
100
the eCryptfs project. For kernel bugs, please follow the procedure
 
101
detailed in Documentation/oops-tracing.txt to help us figure out what
 
102
is happening.
 
103
 
 
104
 
 
105
=cut