--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
+<HTML><HEAD>
+<TITLE>Administration Reference</TITLE>
+<!-- Begin Header Records ========================================== -->
+<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
+<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
+<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
+<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
+<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
+</HEAD><BODY>
+<!-- (C) IBM Corporation 2000. All Rights Reserved -->
+<BODY bgcolor="ffffff">
+<!-- End Header Records ============================================ -->
+<A NAME="Top_Of_Page"></A>
+<H1>Administration Reference</H1>
+<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>
+<P>
+<H2><A NAME="HDRBOS_LISTKEYS" HREF="auarf002.htm#ToC_121">bos listkeys</A></H2>
+<A NAME="IDX4563"></A>
+<A NAME="IDX4564"></A>
+<A NAME="IDX4565"></A>
+<A NAME="IDX4566"></A>
+<A NAME="IDX4567"></A>
+<A NAME="IDX4568"></A>
+<A NAME="IDX4569"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Displays the server encryption keys from the
+<B>/usr/afs/etc/KeyFile</B> file
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>bos listkeys -server</B> <<VAR>machine name</VAR>> [<B>-showkey</B>] [<B>-cell</B> <<VAR>cell name</VAR>>]
+ [<B>-noauth</B>] [<B>-localauth</B>] [<B>-help</B>]
+
+<B>bos listk -se</B> <<VAR>machine name</VAR>> [<B>-sh</B>] [<B>-c</B> <<VAR>cell name</VAR>>] [<B>-n</B>] [<B>-l</B>] [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>bos listkeys</B> command formats and displays the list of server
+encryption keys from the <B>/usr/afs/etc/KeyFile</B> file on the server
+machine named by the <B>-server</B> argument.
+<P>To edit the list of keys, use the <B>bos addkey</B> and <B>bos
+removekey</B> commands.
+<P><STRONG>Cautions</STRONG>
+<P>Displaying actual keys on the standard output stream (by including the
+<B>-showkey</B> flag) is a security exposure. Displaying a checksum
+is sufficient for most purposes.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B><B>-server</B>
+</B><DD>Indicates the server machine from which to display the <B>KeyFile</B>
+file. Identify the machine by IP address or its host name (either
+fully-qualified or abbreviated unambiguously). For details, see the
+introductory reference page for the <B>bos</B> command suite.
+<P>For consistent performance in the cell, the output must be the same on
+every server machine. The <B>bos addkey</B> reference page explains
+how to keep the machines synchronized.
+<P><DT><B><B>-showkey</B>
+</B><DD>Displays the octal digits that constitute each key.
+<P><DT><B><B>-cell</B>
+</B><DD>Names the cell in which to run the command. Do not combine this
+argument with the <B>-localauth</B> flag. For more details, see the
+introductory <B>bos</B> reference page.
+<P><DT><B><B>-noauth</B>
+</B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
+issuer. Do not combine this flag with the <B>-localauth</B>
+flag. For more details, see the introductory <B>bos</B> reference
+page.
+<P><DT><B><B>-localauth</B>
+</B><DD>Constructs a server ticket using a key from the local
+<B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
+interpreter presents the ticket to the BOS Server during mutual
+authentication. Do not combine this flag with the <B>-cell</B> or
+<B>-noauth</B> options. For more details, see the introductory
+<B>bos</B> reference page.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Output</STRONG>
+<P>The output includes one line for each server encryption key listed in the
+<B>KeyFile</B> file, identified by its key version number.
+<P>If the <B>-showkey</B> flag is included, the output displays the actual
+string of eight octal numbers that constitute the key. Each octal
+number is a backslash and three decimal digits.
+<P>If the <B>-showkey</B> flag is not included, the output represents each
+key as a checksum, which is a decimal number derived by encrypting a constant
+with the key.
+<P>Following the list of keys or checksums, the string <TT>Keys last
+changed</TT> indicates when a key was last added to the <B>KeyFile</B>
+file. The words <TT>All done</TT> indicate the end of the
+output.
+<P>For mutual authentication to work properly, the output from the command
+<B>kas examine afs</B> must match the key or checksum with the same key
+version number in the output from this command.
+<P><STRONG>Examples</STRONG>
+<P>The following example shows the checksums for the keys stored in the
+<B>KeyFile</B> file on the machine
+<B>fs3.abc.com</B>.
+<PRE> % <B>bos listkeys fs3.abc.com</B>
+ key 1 has cksum 972037177
+ key 3 has cksum 2825175022
+ key 4 has cksum 260617746
+ key 6 has cksum 4178774593
+ Keys last changed on Mon Apr 12 11:24:46 1999.
+ All done.
+
+</PRE>
+<P>The following example shows the actual keys from the <B>KeyFile</B>
+file on the machine <B>fs6.abc.com</B>.
+<PRE> % <B>bos listkeys fs6.abc.com -showkey</B>
+ key 0 is '\040\205\211\241\345\002\023\211'
+ key 1 is '\343\315\307\227\255\320\135\244'
+ key 2 is '\310\310\255\253\326\236\261\211'
+ Keys last changed on Wed Mar 31 11:24:46 1999.
+ All done.
+
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
+the machine named by the <B>-server</B> argument, or must be logged onto a
+server machine as the local superuser <B>root</B> if the
+<B>-localauth</B> flag is included.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
+<P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
+<P><A HREF="auarf095.htm#HDRBOS_ADDKEY">bos addkey</A>
+<P><A HREF="auarf111.htm#HDRBOS_REMOVEKEY">bos removekey</A>
+<P><A HREF="auarf115.htm#HDRBOS_SETAUTH">bos setauth</A>
+<P><A HREF="auarf185.htm#HDRKAS_EXAMINE">kas examine</A>
+<P>
+<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>
+<!-- Begin Footer Records ========================================== -->
+<P><HR><B>
+<br>© <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
+</B>
+<!-- End Footer Records ============================================ -->
+<A NAME="Bot_Of_Page"></A>
+</BODY></HTML>
git://git.openafs.org / openafs.git / blobdiff