6e22bff9c27542bb509a25f4433d6f8c897a292e
[sfrench/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.5</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">-c</arg>
23                 <arg choice="opt">-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>When handling a kerberos upcall, use a service principal that starts with "cifs/". The default is to use the "host/" service principal.
52                 </para></listitem>
53                 </varlistentry>
54
55                 <varlistentry>
56                 <term>-v</term>
57                 <listitem><para>Print version number and exit.
58                 </para></listitem>
59                 </varlistentry>
60         </variablelist>
61 </refsect1>
62
63 <refsect1>
64         <title>CONFIGURATION FOR KEYCTL</title>
65         <para>cifs.upcall is designed to be called from the kernel via the
66         request-key callout program. This requires that request-key be told
67         where and how to call this program. The current cifs.upcall program
68         handles two different key types:
69         </para>
70
71         <variablelist>
72                 <varlistentry>
73                 <term>cifs.spnego</term>
74                 <listitem><para>This keytype is for retrieving kerberos session keys
75                 </para></listitem>
76                 </varlistentry>
77
78                 <varlistentry>
79                 <term>dns_resolver</term>
80                 <listitem><para>This key type is for resolving hostnames into IP addresses
81                 </para></listitem>
82                 </varlistentry>
83         </variablelist>
84
85         <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>
86 <programlisting>
87 #OPERATION  TYPE           D C PROGRAM ARG1 ARG2...
88 #=========  =============  = = ==========================================
89 create      cifs.spnego    * * /usr/local/sbin/cifs.upcall -c %k
90 create      dns_resolver   * * /usr/local/sbin/cifs.upcall %k
91 </programlisting>
92 <para>
93 See <citerefentry><refentrytitle>request-key.conf<manvolnum>5</manvolnum></refentrytitle></citerefentry> for more info on each field.
94 </para>
95 </refsect1>
96
97 <refsect1>
98         <title>SEE ALSO</title>
99         <para>
100         <citerefentry><refentrytitle>request-key.conf</refentrytitle>
101         <manvolnum>5</manvolnum></citerefentry>,
102         <citerefentry><refentrytitle>mount.cifs</refentrytitle>
103         <manvolnum>8</manvolnum></citerefentry>
104         </para>
105 </refsect1>
106
107 <refsect1>
108         <title>AUTHOR</title>
109
110         <para>Igor Mammedov wrote the cifs.upcall program.</para>
111         <para>Jeff Layton authored this manpage.</para>
112         <para>The maintainer of the Linux CIFS VFS is Steve French.</para>
113         <para>The <ulink url="mailto:linux-cifs-client@lists.samba.org">Linux
114                 CIFS Mailing list</ulink> is the preferred place to ask
115                 questions regarding these programs.
116         </para>
117 </refsect1>
118
119 </refentry>