sect5/KeyFile.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="KeyFile5">
   3   <refmeta>
   4     <refentrytitle>KeyFile</refentrytitle>
   5     <manvolnum>5</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>KeyFile</refname>
   9     <refpurpose>Defines AFS server encryption keys</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Description</title>
  13     <para>The <replaceable>KeyFile</replaceable> file defines the server encryption keys that the AFS server
  14     processes running on the machine use to decrypt the tickets presented by
  15     clients during the mutual authentication process. AFS server processes
  16     perform privileged actions only for clients that possess a ticket
  17     encrypted with one of the keys from the file. The file must reside in the
  18     <replaceable>/usr/afs/etc</replaceable> directory on every server machine. For more detailed
  19     information on mutual authentication and server encryption keys, see the
  20     <emphasis>IBM AFS Administration Guide</emphasis>.</para>
  21
  22     <para>Each key has a corresponding a key version number that distinguishes it
  23     from the other keys. The tickets that clients present are also marked with
  24     a key version number to tell the server process which key to use to
  25     decrypt it. The <replaceable>KeyFile</replaceable> file must always include a key with the same
  26     key version number and contents as the key currently listed for the <computeroutput>afs</computeroutput>
  27     entry in the Authentication Database.</para>
  28
  29     <para>The <replaceable>KeyFile</replaceable> file is in binary format, so always use the appropriate
  30     commands from the <emphasis role="bold">bos</emphasis> command suite to administer it:</para>
  31
  32     <itemizedlist>
  33       <listitem>
  34         <para>The <emphasis role="bold">bos addkey</emphasis> command to define a new key.</para>
  35
  36       </listitem>
  37       <listitem>
  38         <para>The <emphasis role="bold">bos listkeys</emphasis> command to display the keys.</para>
  39
  40       </listitem>
  41       <listitem>
  42         <para>The <emphasis role="bold">bos removekey</emphasis> command to remove a key from the file.</para>
  43
  44       </listitem>
  45     </itemizedlist>
  46     <para>In cells that use the Update Server to distribute the contents of the
  47     <replaceable>/usr/afs/etc</replaceable> directory, it is customary to edit only the copy of the
  48     file stored on the system control machine. Otherwise, edit the file on
  49     each server machine individually.</para>
  50
  51   </refsect1>
  52   <refsect1>
  53     <title>See Also</title>
  54     <para><link linkend="bos_addkey8">bos_addkey(8)</link>,
  55     <link linkend="bos_listkeys8">bos_listkeys(8)</link>,
  56     <link linkend="bos_removekey8">bos_removekey(8)</link>,
  57     <link linkend="kas_setpassword8">kas_setpassword(8)</link>,
  58     <link linkend="upclient8">upclient(8)</link>,
  59     <link linkend="upserver8">upserver(8)</link></para>
  60
  61     <para><emphasis>IBM AFS Administration Guide</emphasis></para>
  62
  63   </refsect1>
  64   <refsect1>
  65     <title>Copyright</title>
  66     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
  67
  68     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
  69     converted from HTML to POD by software written by Chas Williams and Russ
  70     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
  71
  72   </refsect1>
  73 </refentry>