.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CIFS.UPCALL" 8 "" "" ""
.SH NAME
cifs.upcall \- Userspace upcall helper for Common Internet File System (CIFS)
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B cifs.upcall [\-\-trust\-dns|\-t] [\-\-version|\-v] [\-\-legacy\-uid|\-l]
[\-\-krb5conf=/path/to/krb5.conf|\-k /path/to/krb5.conf]
[\-\-keytab=/path/to/keytab|\-K /path/to/keytab] [\-\-expire|\-e nsecs] {keyid}
.UNINDENT
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
This tool is part of the cifs\-utils suite.
.sp
\fBcifs.upcall\fP is a userspace helper program for the linux CIFS client
filesystem. There are a number of activities that the kernel cannot
easily do itself. This program is a callout program that does these
things for the kernel and then returns the result.
.sp
\fBcifs.upcall\fP is generally intended to be run when the kernel calls
request\-key(8) for a particular key type. While it can be run
directly from the command\-line, it\(aqs not generally intended to be run
that way.
.SH OPTIONS
.INDENT 0.0
.TP
.B  \-c
This option is deprecated and is currently ignored.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-no\-env\-probe|\-E
Normally, \fBcifs.upcall\fP will probe the environment variable space of
the process that initiated the upcall in order to fetch the value of
\fB$KRB5CCNAME\fP\&. This can assist the program with finding credential
caches in non\-default locations. If this option is set, then the
program won\(aqt do this and will rely on finding credcaches in the
default locations specified in \fIkrb5.conf\fP\&. Note that this is never
performed when the uid is 0. The default credcache location is always
used when the uid is 0, regardless of the environment variable setting
in the process.
.TP
.B \-\-krb5conf|\-k=/path/to/krb5.conf
This option allows administrators to set an alternate location for the
\fIkrb5.conf\fP file that \fBcifs.upcall\fP will use.
.TP
.B \-\-keytab=|\-K=/path/to/keytab
This option allows administrators to specify a keytab file to be
used. When a user has no credential cache already established,
\fBcifs.upcall\fP will attempt to use this keytab to acquire them. The
default is the system\-wide keytab \fI/etc/krb5.keytab\fP\&.
.TP
.B \-\-trust\-dns|\-t
With krb5 upcalls, the name used as the host portion of the service
principal defaults to the hostname portion of the UNC. This option
allows the upcall program to reverse resolve the network address of
the server in order to get the hostname.
.sp
This is less secure than not trusting DNS. When using this option,
it\(aqs possible that an attacker could get control of DNS and trick the
client into mounting a different server altogether. It\(aqs preferable to
instead add server principals to the KDC for every possible hostname,
but this option exists for cases where that isn\(aqt possible. The
default is to not trust reverse hostname lookups in this fashion.
.TP
.B \-\-legacy\-uid|\-l
Traditionally, the kernel has sent only a single uid= parameter to the
upcall for the SPNEGO upcall that\(aqs used to determine what user\(aqs
credential cache to use.  This parameter is affected by the uid=
mount option, which also governs the ownership of files on the mount.
.sp
Newer kernels send a creduid= option as well, which contains what uid
it thinks actually owns the credentials that it\(aqs looking for. At
mount time, this is generally set to the real uid of the user doing
the mount. For multisession mounts, it\(aqs set to the fsuid of the mount
user. Set this option if you want cifs.upcall to use the older uid=
parameter instead of the creduid= parameter.
.TP
.B \-\-expire|\-e
Override default timeout value (600 seconds) for \fBdns_resolver\fP key.
.TP
.B \-\-version|\-v
Print version number and exit.
.UNINDENT
.SH ENVIRONMENT VARIABLES
.INDENT 0.0
.TP
.B GSS_USE_PROXY="yes"
Enable usage of gssproxy for credential retrieval. This includes keytab
based client initiation as well as (Resource Based) Constrained Delegation.
See gssproxy\-mech(8).
.UNINDENT
.SH CONFIGURATION FOR KEYCTL
.sp
\fBcifs.upcall\fP is designed to be called from the kernel via the
request\-key callout program. This requires that request\-key be told
where and how to call this program.  The current \fBcifs.upcall\fP
program handles two different key types:
.INDENT 0.0
.TP
.B cifs.spnego
This keytype is for retrieving kerberos session keys
.TP
.B dns_resolver
This key type is for resolving hostnames into IP addresses. Support
for this key type may eventually be deprecated (see below).
.sp
To make this program useful for CIFS, you\(aqll need to set up entries
for them in request\-key.conf(5). Here\(aqs an example of an entry for
each key type:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
#OPERATION  TYPE           D C PROGRAM ARG1 ARG2...
#=========  =============  = = ================================
create      cifs.spnego    * * /usr/sbin/cifs.upcall %k
create      dns_resolver   * * /usr/sbin/cifs.upcall %k
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
See request\-key.conf(5) for more info on each field.
.sp
The keyutils package has also started including a dns_resolver
handling program as well that is preferred over the one in
\fBcifs.upcall\fP\&. If you are using a keyutils version equal to or
greater than 1.5, you should use \fBkey.dns_resolver\fP to handle the
\fBdns_resolver\fP keytype instead of \fBcifs.upcall\fP\&. See
key.dns_resolver(8) for more info.
.UNINDENT
.SH SEE ALSO
.sp
request\-key.conf(5), mount.cifs(8), key.dns_resolver(8)
.SH AUTHOR
.sp
Igor Mammedov wrote the cifs.upcall program.
.sp
Jeff Layton authored this manpage.
.sp
The maintainer of the Linux CIFS VFS is Steve French.
.sp
The Linux CIFS Mailing list is the preferred place to ask questions
regarding these programs.
.\" Generated by docutils manpage writer.
.