.TH pam_ecryptfs "8" "2008-07-21" "Linux\-PAM Manual" "Linux\-PAM Manual"
.SH "NAME"
pam_ecryptfs \- PAM module for eCryptfs
.SH "SYNOPSIS"
.HP 12
\fBpam_ecryptfs.so\fR [unwrap]
.SH "DESCRIPTION"
.PP
pam_ecryptfs is a PAM module that can use the login password to unwrap an ecryptfs mount passphrase stored in ~/.ecryptfs/wrapped-passphrase, and automatically mount a private cryptographic directory.
.SH "OPTIONS"
.PP
.TP 3n
\fBunwrap\fR
Use the login passphrase to unwrap an eCryptfs mount passphrase.
.TP 3n
.SH "MODULE SERVICES PROVIDED"
.PP
The services \fBauth\fR, and \fBsession\fR are supported.
.SH "EXAMPLES"
.PP
To unwrap a mount passphrase and automatically mount a private directory on login, add the following lines to

\fI/etc/pam.d/common-auth\fR:
.sp
.RS 3n
.nf
        auth    required        pam_ecryptfs.so unwrap
.fi
.RE
.sp
\fI/etc/pam.d/common-session\fR:
.sp
.RS 3n
.nf
        session optional        pam_ecryptfs.so unwrap
.fi
.RE
.sp

.SH "SEE ALSO"
.PP
\fBecryptfs\fR(7),
\fBpam.conf\fR(5),
\fBpam.d\fR(8),
\fBpam\fR(8)

.TP
\fI/usr/share/doc/ecryptfs-utils/ecryptfs-faq.html\fP

.TP
\fIhttp://ecryptfs.org/\fP
.PD

.SH AUTHOR
This manpage 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.

On Debian and Ubuntu systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.