doc/manpage/ecryptfs-setup-private.1

   1 .TH ecryptfs-setup-private 1 2008-11-17 ecryptfs-utils "eCryptfs"
   2 .SH NAME
   3 ecryptfs-setup-private \- setup an eCryptfs private directory.
   4
   5 .SH SYNOPSIS
   6 .BI "ecryptfs-setup-private [\-f|\-\-force] [\-w|\-\-wrapping] [\-b|\-\-bootstrap] [\-n|\-\-no-fnek] [\-\-nopwcheck] [\-u|\-\-username USER] [\-l|\-\-loginpass LOGINPASS] [\-m|\-\-mountpass MOUNTPASS]"
   7
   8 .SH OPTIONS
   9 Options available for the \fBecryptfs-setup-private\fP command:
  10 .TP
  11 .B \-f, \-\-force
  12 Force overwriting of an existing setup
  13 .TP
  14 .B \-w, \-\-wrapping
  15 Use an independent wrapping passphrase, different from the login passphrase
  16 .TP
  17 .B \-u, \-\-username USER
  18 User to setup, default is current user if omitted
  19 .TP
  20 .B \-l, \-\-loginpass LOGINPASS
  21 System passphrase for USER, used to wrap MOUNTPASS, will interactively prompt if omitted
  22 .TP
  23 .B \-m, \-\-mountpass MOUNTPASS
  24 Passphrase for mounting the ecryptfs directory, default is 16 bytes from /dev/random if omitted
  25 .TP
  26 .B \-b, \-\-bootstrap
  27 Bootstrap a new user's entire home directory
  28 .TP
  29 .B \-\-undo
  30 Display instructions on how to undo an encrypted private setup
  31 .TP
  32 .B \-n, \-\-no\-fnek
  33 Do not encrypt filenames; otherwise, filenames will be encrypted on systems which support filename encryption
  34 .TP
  35 .B \-\-nopwcheck
  36 Do not check the validity of the specified login password (useful for LDAP user accounts)
  37 .TP
  38 .B \-\-noautomount
  39 Setup this user such that the encrypted private directory is not automatically mounted on login
  40 .TP
  41 .B \-\-noautoumount
  42 Setup this user such that the encrypted private directory is not automatically unmounted at logout
  43
  44
  45 .SH DESCRIPTION
  46 \fBecryptfs-setup-private\fP is a program that sets up a private cryptographic mountpoint for a non-root user.
  47
  48 Be sure to properly escape your parameters according to your shell's special character nuances, and also surround the parameters by double quotes, if necessary. Any of the parameters may be:
  49
  50   1) exported as environment variables
  51   2) specified on the command line
  52   3) left empty and interactively prompted
  53
  54 \fBThe user SHOULD ABSOLUTELY RECORD THE MOUNT PASSPHRASE AND STORE IN A SAFE LOCATION.  If the mount passphase file is lost, or the mount passphrase is forgotten, THERE IS NO WAY TO RECOVER THE ENCRYPTED DATA.\fP
  55
  56 Using the values of USER, MOUNTPASS, and LOGINPASS, \fBecryptfs-setup-private\fP will:
  57   - Create ~/.Private (permission 700)
  58   - Create ~/Private (permission 500)
  59   - Backup any existing wrapped passphrases
  60   - Use LOGINPASS to wrap and encrypt MOUNTPASS
  61   - Write to ~/.ecryptfs/wrapped-passphrase
  62   - Add the passphrase to the current keyring
  63   - Write the passphrase signature to ~/.ecryptfs/Private.sig
  64   - Test the cryptographic mount with a few reads and writes
  65
  66 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 \fPpam_ecryptfs\fP(8).
  67
  68 .SH FILES
  69 \fI~/.ecryptfs/auto-mount\fP
  70
  71 \fI~/.Private\fP - underlying directory containing encrypted data
  72
  73 \fI~/Private\fP - mountpoint containing decrypted data (when mounted)
  74
  75 \fI~/.ecryptfs/Private.sig\fP - file containing signature of mountpoint passphrase
  76
  77 \fI~/.ecryptfs/Private.mnt\fP - file containing path of the private directory mountpoint
  78
  79 \fI~/.ecryptfs/wrapped-passphrase\fP - file containing the mount passphrase, wrapped with the login passphrase
  80
  81 \fI~/.ecryptfs/wrapping-independent\fP - this file exists if the wrapping passphrase is independent from login passphrase
  82
  83 .SH SEE ALSO
  84 .PD 0
  85 .TP
  86 \fBecryptfs-rewrap-passphrase\fP(1), \fBmount.ecryptfs_private\fP(1), \fBpam_ecryptfs\fP(8), \fBumount.ecryptfs_private\fP(1)
  87
  88 .TP
  89 \fI/usr/share/doc/ecryptfs-utils/ecryptfs-faq.html\fP
  90
  91 .TP
  92 \fIhttp://ecryptfs.org/\fP
  93 .PD
  94
  95 .SH AUTHOR
  96 This manpage and the \fBecryptfs-setup-private\fP utility was written by Dustin Kirkland <kirkland@ubuntu.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.
  97
  98 On Debian and Ubuntu systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.