251d1d0b2b5749618e655205285607152903856e
[kai/samba-autobuild/.git] / docs-xml / manpages-3 / cifs.upcall.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="cifs.upcall.8">
4
5
6 <refmeta>
7         <refentrytitle>cifs.upcall</refentrytitle>
8         <manvolnum>8</manvolnum>
9         <refmiscinfo class="source">Samba</refmiscinfo>
10         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
11         <refmiscinfo class="version">3.6</refmiscinfo>
12 </refmeta>
13
14 <refnamediv>
15         <refname>cifs.upcall</refname>
16         <refpurpose>Userspace upcall helper for Common Internet File System (CIFS)</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>cifs.upcall</command>
22                 <arg choice="opt">--trust-dns|-t</arg>
23                 <arg choice="opt">--version|-v</arg>
24                 <arg choice="req">keyid</arg>
25         </cmdsynopsis>
26 </refsynopsisdiv>
27
28
29 <refsect1>
30         <title>DESCRIPTION</title>
31
32         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
33         <manvolnum>7</manvolnum></citerefentry> suite.</para>
34
35 <para>cifs.upcall is a userspace helper program for the linux CIFS client
36 filesystem. There are a number of activities that the kernel cannot easily
37 do itself. This program is a callout program that does these things for the
38 kernel and then returns the result.</para>
39
40 <para>cifs.upcall is generally intended to be run when the kernel calls
41 request-key<manvolnum>8</manvolnum> for a particular key type. While it
42 can be run directly from the command-line, it's not generally intended
43 to be run that way.</para>
44 </refsect1>
45
46 <refsect1>
47         <title>OPTIONS</title>
48         <variablelist>
49                 <varlistentry>
50                 <term>-c</term>
51                 <listitem><para>This option is deprecated and is currently ignored.
52                 </para></listitem>
53                 </varlistentry>
54                 <varlistentry>
55                 <term>--trust-dns|-t</term>
56                 <listitem><para>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.</para>
57                 <para>This is less secure than not trusting DNS. When using this option, it's possible that an attacker could get control of DNS and trick the client into mounting a different server altogether. It's preferable to instead add server principals to the KDC for every possible hostname, but this option exists for cases where that isn't possible. The default is to not trust reverse hostname lookups in this fashion.
58                 </para></listitem>
59                 </varlistentry>
60                 <varlistentry>
61                 <term>--version|-v</term>
62                 <listitem><para>Print version number and exit.
63                 </para></listitem>
64                 </varlistentry>
65         </variablelist>
66 </refsect1>
67
68 <refsect1>
69         <title>CONFIGURATION FOR KEYCTL</title>
70         <para>cifs.upcall is designed to be called from the kernel via the
71         request-key callout program. This requires that request-key be told
72         where and how to call this program. The current cifs.upcall program
73         handles two different key types:
74         </para>
75
76         <variablelist>
77                 <varlistentry>
78                 <term>cifs.spnego</term>
79                 <listitem><para>This keytype is for retrieving kerberos session keys
80                 </para></listitem>
81                 </varlistentry>
82
83                 <varlistentry>
84                 <term>dns_resolver</term>
85                 <listitem><para>This key type is for resolving hostnames into IP addresses
86                 </para></listitem>
87                 </varlistentry>
88         </variablelist>
89
90         <para>To make this program useful for CIFS, you'll need to set up entries for them in request-key.conf<manvolnum>5</manvolnum>. Here's an example of an entry for each key type:</para>
91 <programlisting>
92 #OPERATION  TYPE           D C PROGRAM ARG1 ARG2...
93 #=========  =============  = = ================================
94 create      cifs.spnego    * * /usr/local/sbin/cifs.upcall %k
95 create      dns_resolver   * * /usr/local/sbin/cifs.upcall %k
96 </programlisting>
97 <para>
98 See <citerefentry><refentrytitle>request-key.conf<manvolnum>5</manvolnum></refentrytitle></citerefentry> for more info on each field.
99 </para>
100 </refsect1>
101
102 <refsect1>
103         <title>SEE ALSO</title>
104         <para>
105         <citerefentry><refentrytitle>request-key.conf</refentrytitle>
106         <manvolnum>5</manvolnum></citerefentry>,
107         <citerefentry><refentrytitle>mount.cifs</refentrytitle>
108         <manvolnum>8</manvolnum></citerefentry>
109         </para>
110 </refsect1>
111
112 <refsect1>
113         <title>AUTHOR</title>
114
115         <para>Igor Mammedov wrote the cifs.upcall program.</para>
116         <para>Jeff Layton authored this manpage.</para>
117         <para>The maintainer of the Linux CIFS VFS is Steve French.</para>
118         <para>The <ulink url="mailto:linux-cifs-client@lists.samba.org">Linux
119                 CIFS Mailing list</ulink> is the preferred place to ask
120                 questions regarding these programs.
121         </para>
122 </refsect1>
123
124 </refentry>