cifscreds.1

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
   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 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "CIFSCREDS 1"
 127 .TH CIFSCREDS 1 "2012-07-17" "" ""
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 cifscreds \- manage NTLM credentials in kernel keyring
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 cifscreds add|clear|clearall|update [\-u username] [\-d] host|domain
 137 .SH "DESCRIPTION"
 138 .IX Header "DESCRIPTION"
 139 The \fBcifscreds\fR program is a tool for managing credentials (username
 140 and password) for the purpose of establishing sessions in multiuser
 141 mounts.
 142 .PP
 143 When a cifs filesystem is mounted with the \*(L"multiuser\*(R" option, and does
 144 not use krb5 authentication, it needs to be able to get the credentials
 145 for each user from somewhere. The \fBcifscreds\fR program is the tool used
 146 to provide these credentials to the kernel.
 147 .PP
 148 The first non-option argument to cifscreds is a command (see the
 149 \&\fB\s-1COMMANDS\s0\fR section below). The second non-option argument is a hostname
 150 or address, or an \s-1NT\s0 domain name.
 151 .SH "COMMANDS"
 152 .IX Header "COMMANDS"
 153 .IP "\fBadd\fR" 4
 154 .IX Item "add"
 155 Add credentials to the kernel to be used for connecting to the given server, or servers in the given domain.
 156 .IP "\fBclear\fR" 4
 157 .IX Item "clear"
 158 Clear credentials for a particular host or domain from the kernel.
 159 .IP "\fBclearall\fR" 4
 160 .IX Item "clearall"
 161 Clear all cifs credentials from the kernel.
 162 .IP "\fBupdate\fR" 4
 163 .IX Item "update"
 164 Update stored credentials in the kernel with a new username and
 165 password.
 166 .SH "OPTIONS"
 167 .IX Header "OPTIONS"
 168 .IP "\fB\-d\fR, \fB\-\-domain\fR" 4
 169 .IX Item "-d, --domain"
 170 The provided host/domain argument is a \s-1NT\s0 domainname.
 171 .Sp
 172 Ordinarily the second argument provided to cifscreds is treated as a
 173 hostname or \s-1IP\s0 address. This option causes the cifscreds program to
 174 treat that argument as an \s-1NT\s0 domainname instead.
 175 .Sp
 176 If there are not host specific credentials for the mounted server, then
 177 the kernel will next look for a set of domain credentials equivalent to
 178 the domain= option provided at mount time.
 179 .IP "\fB\-u\fR, \fB\-\-username\fR" 4
 180 .IX Item "-u, --username"
 181 Ordinarily, the username is derived from the unix username of the user
 182 adding the credentials. This option allows the user to substitute a
 183 different username.
 184 .SH "NOTES"
 185 .IX Header "NOTES"
 186 The cifscreds utility requires a kernel built with support for the
 187 \&\fBlogin\fR key type. That key type was added in v3.3 in mainline Linux
 188 kernels.
 189 .PP
 190 Since \fBcifscreds\fR adds keys to the session keyring, it is highly
 191 recommended that one use \fBpam_keyinit\fR to ensure that a session keyring
 192 is established at login time.
 193 .SH "SEE ALSO"
 194 .IX Header "SEE ALSO"
 195 \&\fIpam_keyinit\fR\|(8)
 196 .SH "AUTHORS"
 197 .IX Header "AUTHORS"
 198 The cifscreds program was originally developed by Igor Druzhinin
 199 <jaxbrigs@gmail.com>. This manpage and a redesign of the code was done
 200 by Jeff Layton <jlayton@samba.org>.