← Back to branch summary

~ubuntu-branches/ubuntu/vivid/ecryptfs-utils/vivid

« back to all changes in this revision

Viewing changes to doc/manpage/mount.ecryptfs_private.1

  • Committer: Bazaar Package Importer
  • Author(s): Dustin Kirkland
  • Date: 2008-08-04 15:58:24 UTC
  • mfrom: (1.1.11 upstream)
  • Revision ID: james.westby@ubuntu.com-20080804155824-c3ob82b8h6wpx2x6
Tags: 53-1ubuntu1
https://launchpad.net/bugs/254714
https://launchpad.net/bugs/251245
https://launchpad.net/bugs/253816
 * Merge from debian unstable (LP: #254714, #251245), remaining changes:
  - debian/rules: install ecryptfs auth-client-config profile
  - debian/control: Update maintainer, suggest auth-client-config
  - debian/ecryptfs.acc: define auth-client-config profile
  - debian/ecryptfs-utils.install: install auth-client-config profile
 * Dropped changes:
  - debian/ecryptfs-utils.dirs: handled by install -D rule
 * Additional changes
  - debian/ecryptfs.acc: Add to common-password stack, make all pam_ecryptfs
    entries optional (LP: #253816).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpage/mount.ecryptfs_private.1
 
1
.TH mount.ecryptfs_private 1 2008-07-21 ecryptfs-utils "eCryptfs"
 
2
.SH NAME
 
3
mount.ecryptfs_private \- eCryptfs private mount helper.
 
4
 
 
5
.SH SYNOPSIS
 
6
\fBmount.ecryptfs_private\fP
 
7
 
 
8
.SH DESCRIPTION
 
9
\fBmount.ecryptfs_private\fP is a mount helper utility for non-root users to cryptographically mount a private directory, ~/Private.
 
10
 
 
11
If, and only if:
 
12
  - the private mount passphrase is in their kernel keyring, and
 
13
  - the current user owns both ~/.Private and ~/Private, and
 
14
  - ~/Private is not already mounted, then
 
15
 
 
16
This program will:
 
17
  - mount ~/.Private onto ~/Private
 
18
  - as an ecryptfs filesystem
 
19
  - using the AES cipher
 
20
  - with a key length of 16 bytes
 
21
  - using the passphrase whose signature is in ~/.ecryptfs/Private.sig
 
22
 
 
23
The only setuid operation in this program is the call to \fBmount\fP(8).
 
24
 
 
25
The \fBecryptfs-setup-private\fP(1) utility will create the ~/.Private and ~/Private directories, generate a mount passphrase, wrap the passphrase, and write the ~/.ecryptfs/Private.sig.
 
26
 
 
27
The system administrator can add the pam_ecryptfs.so module to the PAM stack which will automatically use the login passphrase to unwrap the mount passphrase, add the passphrase to the user's kernel keyring, and automatically perform the mount. See \fBpam_ecryptfs\fP(8).
 
28
 
 
29
.SH FILES
 
30
\fI~/.Private\fP - underlying directory containing encrypted data
 
31
 
 
32
\fI~/Private\fP - mountpoint containing decrypted data (when mounted)
 
33
 
 
34
\fI~/.ecryptfs/Private.sig\fP - file containing signature of mountpoint passphrase
 
35
 
 
36
\fI~/.ecryptfs/wrapped-passphrase\fP - mount passphrase, encrypted with the login passphrase
 
37
 
 
38
.SH SEE ALSO
 
39
.PD 0
 
40
.TP
 
41
\fBecryptfs\fP(7), \fBecryptfs-rewrap-passphrase\fP(1), \fBecryptfs-setup-private\fP(1), \fBkeyctl\fP(1), \fBmount\fP(8), \fBumount.ecryptfs_private\fP(1), \fBpam_ecryptfs\fP(8)
 
42
 
 
43
.TP
 
44
\fI/usr/share/doc/ecryptfs-utils/ecryptfs-faq.html\fP
 
45
 
 
46
.TP
 
47
\fIhttp://ecryptfs.sourceforge.net/\fP
 
48
.PD
 
49
 
 
50
.SH AUTHOR
 
51
This manpage and the \fBmount.ecryptfs_private\fP utility was written by Dustin Kirkland <kirkland@canonical.com> for Ubuntu systems (but may be used by others).  Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
 
52
 
 
53
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.