doc/html/AdminReference/auarf107.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
   2 <HTML><HEAD>
   3 <TITLE>Administration Reference</TITLE>
   4 <!-- Begin Header Records  ========================================== -->
   5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
   6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
   7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
   8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
   9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
  10 </HEAD><BODY>
  11 <!-- (C) IBM Corporation 2000. All Rights Reserved    -->
  12 <BODY bgcolor="ffffff">
  13 <!-- End Header Records  ============================================ -->
  14 <A NAME="Top_Of_Page"></A>
  15 <H1>Administration Reference</H1>
  16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf106.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf108.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
  17 <P>
  18 <H2><A NAME="HDRBOS_LISTKEYS" HREF="auarf002.htm#ToC_121">bos listkeys</A></H2>
  19 <A NAME="IDX4563"></A>
  20 <A NAME="IDX4564"></A>
  21 <A NAME="IDX4565"></A>
  22 <A NAME="IDX4566"></A>
  23 <A NAME="IDX4567"></A>
  24 <A NAME="IDX4568"></A>
  25 <A NAME="IDX4569"></A>
  26 <P><STRONG>Purpose</STRONG>
  27 <P>Displays the server encryption keys from the
  28 <B>/usr/afs/etc/KeyFile</B> file
  29 <P><STRONG>Synopsis</STRONG>
  30 <PRE><B>bos listkeys -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-showkey</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]
  31              [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]
  32
  33 <B>bos listk -se</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-sh</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
  34 </PRE>
  35 <P><STRONG>Description</STRONG>
  36 <P>The <B>bos listkeys</B> command formats and displays the list of server
  37 encryption keys from the <B>/usr/afs/etc/KeyFile</B> file on the server
  38 machine named by the <B>-server</B> argument.
  39 <P>To edit the list of keys, use the <B>bos addkey</B> and <B>bos
  40 removekey</B> commands.
  41 <P><STRONG>Cautions</STRONG>
  42 <P>Displaying actual keys on the standard output stream (by including the
  43 <B>-showkey</B> flag) is a security exposure. Displaying a checksum
  44 is sufficient for most purposes.
  45 <P><STRONG>Options</STRONG>
  46 <DL>
  47 <P><DT><B><B>-server</B>
  48 </B><DD>Indicates the server machine from which to display the <B>KeyFile</B>
  49 file. Identify the machine by IP address or its host name (either
  50 fully-qualified or abbreviated unambiguously). For details, see the
  51 introductory reference page for the <B>bos</B> command suite.
  52 <P>For consistent performance in the cell, the output must be the same on
  53 every server machine. The <B>bos addkey</B> reference page explains
  54 how to keep the machines synchronized.
  55 <P><DT><B><B>-showkey</B>
  56 </B><DD>Displays the octal digits that constitute each key.
  57 <P><DT><B><B>-cell</B>
  58 </B><DD>Names the cell in which to run the command. Do not combine this
  59 argument with the <B>-localauth</B> flag. For more details, see the
  60 introductory <B>bos</B> reference page.
  61 <P><DT><B><B>-noauth</B>
  62 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
  63 issuer. Do not combine this flag with the <B>-localauth</B>
  64 flag. For more details, see the introductory <B>bos</B> reference
  65 page.
  66 <P><DT><B><B>-localauth</B>
  67 </B><DD>Constructs a server ticket using a key from the local
  68 <B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
  69 interpreter presents the ticket to the BOS Server during mutual
  70 authentication. Do not combine this flag with the <B>-cell</B> or
  71 <B>-noauth</B> options. For more details, see the introductory
  72 <B>bos</B> reference page.
  73 <P><DT><B>-help
  74 </B><DD>Prints the online help for this command. All other valid options
  75 are ignored.
  76 </DL>
  77 <P><STRONG>Output</STRONG>
  78 <P>The output includes one line for each server encryption key listed in the
  79 <B>KeyFile</B> file, identified by its key version number.
  80 <P>If the <B>-showkey</B> flag is included, the output displays the actual
  81 string of eight octal numbers that constitute the key. Each octal
  82 number is a backslash and three decimal digits.
  83 <P>If the <B>-showkey</B> flag is not included, the output represents each
  84 key as a checksum, which is a decimal number derived by encrypting a constant
  85 with the key.
  86 <P>Following the list of keys or checksums, the string <TT>Keys last
  87 changed</TT> indicates when a key was last added to the <B>KeyFile</B>
  88 file. The words <TT>All done</TT> indicate the end of the
  89 output.
  90 <P>For mutual authentication to work properly, the output from the command
  91 <B>kas examine afs</B> must match the key or checksum with the same key
  92 version number in the output from this command.
  93 <P><STRONG>Examples</STRONG>
  94 <P>The following example shows the checksums for the keys stored in the
  95 <B>KeyFile</B> file on the machine
  96 <B>fs3.abc.com</B>.
  97 <PRE>   % <B>bos listkeys fs3.abc.com</B>
  98    key 1 has cksum 972037177
  99    key 3 has cksum 2825175022
 100    key 4 has cksum 260617746
 101    key 6 has cksum 4178774593
 102    Keys last changed on Mon Apr 12 11:24:46 1999.
 103    All done.
 104
 105 </PRE>
 106 <P>The following example shows the actual keys from the <B>KeyFile</B>
 107 file on the machine <B>fs6.abc.com</B>.
 108 <PRE>   % <B>bos listkeys fs6.abc.com -showkey</B>
 109    key 0 is '\040\205\211\241\345\002\023\211'
 110    key 1 is '\343\315\307\227\255\320\135\244'
 111    key 2 is '\310\310\255\253\326\236\261\211'
 112    Keys last changed on Wed Mar 31 11:24:46 1999.
 113    All done.
 114
 115 </PRE>
 116 <P><STRONG>Privilege Required</STRONG>
 117 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
 118 the machine named by the <B>-server</B> argument, or must be logged onto a
 119 server machine as the local superuser <B>root</B> if the
 120 <B>-localauth</B> flag is included.
 121 <P><STRONG>Related Information</STRONG>
 122 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
 123 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
 124 <P><A HREF="auarf095.htm#HDRBOS_ADDKEY">bos addkey</A>
 125 <P><A HREF="auarf111.htm#HDRBOS_REMOVEKEY">bos removekey</A>
 126 <P><A HREF="auarf115.htm#HDRBOS_SETAUTH">bos setauth</A>
 127 <P><A HREF="auarf185.htm#HDRKAS_EXAMINE">kas examine</A>
 128 <P>
 129 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf106.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf108.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
 130 <!-- Begin Footer Records  ========================================== -->
 131 <P><HR><B>
 132 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 133 </B>
 134 <!-- End Footer Records  ============================================ -->
 135 <A NAME="Bot_Of_Page"></A>
 136 </BODY></HTML>