pam_cifscreds.8

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "PAM_CIFSCREDS 8"
 136 .TH PAM_CIFSCREDS 8 "2013-12-13" "" ""
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 pam_cifscreds \- PAM module to manage NTLM credentials in kernel keyring
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 Edit the \s-1PAM\s0 configuration files for the systems that you want to
 146 automatically register \s-1NTLM\s0 credentials for, e.g. /etc/pam.d/login,
 147 and modify as follows:
 148 .PP
 149 .Vb 5
 150 \&        ...
 151 \&        auth       substack     system\-auth
 152 \&    +++ auth       optional     pam_cifscreds.so
 153 \&        auth       include      postlogin
 154 \&        ...
 155 \&
 156 \&        ...
 157 \&        session    include      system\-auth
 158 \&    +++ session    optional     pam_cifscreds.so domain=DOMAIN
 159 \&        session    include      postlogin
 160 \&        ...
 161 .Ve
 162 .PP
 163 Change \s-1DOMAIN\s0 to the name of you Windows domain, or use host= as
 164 described below.
 165 .SH "DESCRIPTION"
 166 .IX Header "DESCRIPTION"
 167 The \fBpam_cifscreds\fR \s-1PAM\s0 module is a tool for automatically adding
 168 credentials (username and password) for the purpose of establishing
 169 sessions in multiuser mounts.
 170 .PP
 171 When a cifs filesystem is mounted with the \*(L"multiuser\*(R" option, and does
 172 not use krb5 authentication, it needs to be able to get the credentials
 173 for each user from somewhere. The \fBpam_cifscreds\fR module can be used
 174 to provide these credentials to the kernel automatically at login.
 175 .PP
 176 In the session section of the \s-1PAM\s0 configuration file, the module can
 177 either an \s-1NT\s0 domain name or a list of hostname or addresses.
 178 .SH "OPTIONS"
 179 .IX Header "OPTIONS"
 180 \&\fBpam_cifscreds\fR supports a couple options which can be set in the \s-1PAM\s0
 181 configuration files.  You must have one (and only one) of domain= or
 182 host=.
 183 .IP "\fBdebug\fR" 4
 184 .IX Item "debug"
 185 Turns on some extra debug logging.
 186 .IP "\fBdomain\fR=<\s-1NT\s0 domain name>" 4
 187 .IX Item "domain=<NT domain name>"
 188 Credentials will be added for the specified \s-1NT\s0 domain name.
 189 .IP "\fBhost\fR=<hostname or \s-1IP\s0 address>[,...]" 4
 190 .IX Item "host=<hostname or IP address>[,...]"
 191 Credentials will be added for the specified hostnames or \s-1IP\s0 addresses.
 192 .SH "NOTES"
 193 .IX Header "NOTES"
 194 The pam_cifscreds \s-1PAM\s0 module requires a kernel built with support for
 195 the \fBlogin\fR key type. That key type was added in v3.3 in mainline Linux
 196 kernels.
 197 .PP
 198 Since \fBpam_cifscreds\fR adds keys to the session keyring, it is highly
 199 recommended that one use \fBpam_keyinit\fR to ensure that a session keyring
 200 is established at login time.
 201 .SH "SEE ALSO"
 202 .IX Header "SEE ALSO"
 203 \&\fIcifscreds\fR\|(1), \fIpam_keyinit\fR\|(8)
 204 .SH "AUTHOR"
 205 .IX Header "AUTHOR"
 206 The pam_cifscreds \s-1PAM\s0 module was developed by Orion Poplawski
 207 <orion@nwra.com>.