| 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.2</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 request-key callout program. This requres that request-key be told where and how to call this program. The current cifs.upcall program handles two different key types:</para>
|
|---|
| 66 |
|
|---|
| 67 | <variablelist>
|
|---|
| 68 | <varlistentry>
|
|---|
| 69 | <term>cifs.spnego</term>
|
|---|
| 70 | <listitem><para>This keytype is for retrieving kerberos session keys
|
|---|
| 71 | </para></listitem>
|
|---|
| 72 | </varlistentry>
|
|---|
| 73 |
|
|---|
| 74 | <varlistentry>
|
|---|
| 75 | <term>dns_resolver</term>
|
|---|
| 76 | <listitem><para>This key type is for resolving hostnames into IP addresses
|
|---|
| 77 | </para></listitem>
|
|---|
| 78 | </varlistentry>
|
|---|
| 79 | </variablelist>
|
|---|
| 80 |
|
|---|
| 81 | <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>
|
|---|
| 82 | <programlisting>
|
|---|
| 83 | #OPERATION TYPE D C PROGRAM ARG1 ARG2...
|
|---|
| 84 | #========= ============= = = ==========================================
|
|---|
| 85 | create cifs.spnego * * /usr/local/sbin/cifs.upcall -c %k
|
|---|
| 86 | create dns_resolver * * /usr/local/sbin/cifs.upcall %k
|
|---|
| 87 | </programlisting>
|
|---|
| 88 | <para>
|
|---|
| 89 | See <citerefentry><refentrytitle>request-key.conf<manvolnum>5</manvolnum></refentrytitle></citerefentry> for more info on each field.
|
|---|
| 90 | </para>
|
|---|
| 91 | </refsect1>
|
|---|
| 92 |
|
|---|
| 93 | <refsect1>
|
|---|
| 94 | <title>SEE ALSO</title>
|
|---|
| 95 | <para>
|
|---|
| 96 | <citerefentry><refentrytitle>request-key.conf</refentrytitle>
|
|---|
| 97 | <manvolnum>5</manvolnum></citerefentry>,
|
|---|
| 98 | <citerefentry><refentrytitle>mount.cifs</refentrytitle>
|
|---|
| 99 | <manvolnum>8</manvolnum></citerefentry>
|
|---|
| 100 | </para>
|
|---|
| 101 | </refsect1>
|
|---|
| 102 |
|
|---|
| 103 | <refsect1>
|
|---|
| 104 | <title>AUTHOR</title>
|
|---|
| 105 |
|
|---|
| 106 | <para>Igor Mammedov wrote the cifs.upcall program.</para>
|
|---|
| 107 | <para>Jeff Layton authored this manpage.</para>
|
|---|
| 108 | <para>The maintainer of the Linux CIFS VFS is Steve French.</para>
|
|---|
| 109 | <para>The <ulink url="mailto:linux-cifs-client@lists.samba.org">Linux
|
|---|
| 110 | CIFS Mailing list</ulink> is the preferred place to ask
|
|---|
| 111 | questions regarding these programs.
|
|---|
| 112 | </para>
|
|---|
| 113 | </refsect1>
|
|---|
| 114 |
|
|---|
| 115 | </refentry>
|
|---|
