src/WINNT/doc/install/Documentation/en_US/html/CmdRef/auarf095.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
   2 <HTML><HEAD>
   3 <TITLE>Administration Reference</TITLE>
   4 <!-- Begin Header Records  ========================================== -->
   5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
   6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
   7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
   8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
   9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58: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="auarf094.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="auarf096.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_ADDKEY" HREF="auarf002.htm#ToC_109">bos addkey</A></H2>
  19 <A NAME="IDX4456"></A>
  20 <A NAME="IDX4457"></A>
  21 <A NAME="IDX4458"></A>
  22 <A NAME="IDX4459"></A>
  23 <A NAME="IDX4460"></A>
  24 <A NAME="IDX4461"></A>
  25 <A NAME="IDX4462"></A>
  26 <A NAME="IDX4463"></A>
  27 <A NAME="IDX4464"></A>
  28 <P><STRONG>Purpose</STRONG>
  29 <P>Adds a new server encryption key to the <B>/usr/afs/etc/KeyFile</B>
  30 file
  31 <P><STRONG>Synopsis</STRONG>
  32 <PRE><B>bos addkey -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-key</B> &lt;<VAR>key</VAR>>]
  33            <B>-kvno</B> &lt;<VAR>key&nbsp;version&nbsp;number</VAR>>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]
  34            [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-help</B>]
  35
  36 <B>bos addk -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  [<B>-ke</B> &lt;<VAR>key</VAR>>]  <B>-kv</B> &lt;<VAR>key version&nbsp;number</VAR>>
  37          [<B>-ce</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-h</B>]
  38 </PRE>
  39 <P><STRONG>Description</STRONG>
  40 <P>The <B>bos addkey</B> command constructs a server encryption key from
  41 the text string provided, assigns it the key version number specified with the
  42 <B>-kvno</B> argument, and adds it to the <B>/usr/afs/etc/KeyFile</B>
  43 file on the machine specified with the <B>-server</B> argument. Be
  44 sure to use the <B>kas setpassword</B> or <B>kas setkey</B> command to
  45 add the same key to the <B>afs</B> entry in the Authentication
  46 Database.
  47 <P>Do not use the <B>-key</B> argument, which echoes the password string
  48 visibly on the screen. If the argument is omitted, the BOS Server
  49 prompts for the string and does not echo it visibly&#58;
  50 <PRE>   Input key&#58;
  51    Retype input key&#58;
  52
  53 </PRE>
  54 <P>The BOS Server prohibits reuse of any key version number already listed in
  55 the <B>/usr/afs/etc/KeyFile</B> file. This ensures that users who
  56 still have tickets sealed with the current key are not prevented from
  57 communicating with a server process because the current key is overwritten
  58 with a new key. Use the <B>bos listkeys</B> command to display the
  59 key version numbers in the <B>/usr/afs/etc/KeyFile</B> file.
  60 <P><STRONG>Options</STRONG>
  61 <DL>
  62 <P><DT><B><B>-server</B>
  63 </B><DD>Indicates the server machine on which to change the
  64 <B>/usr/afs/etc/KeyFile</B> file. Identify the machine by IP
  65 address or its host name (either fully-qualified or abbreviated
  66 unambiguously). For details, see the introductory reference page for
  67 the <B>bos</B> command suite.
  68 <P>In cells that run the United States edition of AFS and use the Update
  69 Server to distribute the contents of the <B>/usr/afs/etc</B> directory, it
  70 is conventional to specify only the system control machine as a value for the
  71 <B>-server</B> argument. In cells that run the international
  72 version of AFS, repeat the command for each file server machine. For
  73 further discussion, see the introductory reference page for the <B>bos</B>
  74 command suite.
  75 <P><DT><B><B>-key</B>
  76 </B><DD>Specifies a character string just like a password; the BOS Server
  77 calls a DES conversion function to encode it into a form appropriate for use
  78 as an encryption key. Omit this argument to have the BOS Server prompt
  79 for the string instead.
  80 <P><DT><B><B>-kvno</B>
  81 </B><DD>Defines the new key&#39;s key version number. It must be an
  82 integer in the range from <B>0</B> (zero) through <B>255</B>.
  83 For the sake of simplicity, use the number one higher than the current highest
  84 key version number; use the <B>bos listkeys</B> command to display
  85 key version numbers.
  86 <A NAME="IDX4465"></A>
  87 <P><DT><B><B>-cell</B>
  88 </B><DD>Names the cell in which to run the command. Do not combine this
  89 argument with the <B>-localauth</B> flag. For more details, see the
  90 introductory <B>bos</B> reference page.
  91 <P><DT><B><B>-noauth</B>
  92 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
  93 issuer. Do not combine this flag with the <B>-localauth</B>
  94 flag. For more details, see the introductory <B>bos</B> reference
  95 page.
  96 <P><DT><B><B>-localauth</B>
  97 </B><DD>Constructs a server ticket using a key from the local
  98 <B>/usr/afs/etc/KeyFile</B> file. The <B>bos</B> command
  99 interpreter presents the ticket to the BOS Server during mutual
 100 authentication. Do not combine this flag with the <B>-cell</B> or
 101 <B>-noauth</B> options. For more details, see the introductory
 102 <B>bos</B> reference page.
 103 <P><DT><B>-help
 104 </B><DD>Prints the online help for this command. All other valid options
 105 are ignored.
 106 </DL>
 107 <P><STRONG>Output</STRONG>
 108 <P>If the strings typed at the <TT>Input key</TT> and <TT>Retype  input
 109 key</TT> prompts do not match, the following message appears, and the command
 110 exits without adding a new key&#58;
 111 <PRE>   Input key mismatch
 112
 113 </PRE>
 114 <P><STRONG>Examples</STRONG>
 115 <P>The following command adds a new server encryption key with key version
 116 number 14 to the <B>KeyFile</B> file kept on the machine
 117 <B>fs1.abc.com</B> (the system control machine). The
 118 issuer omits the <B>-key</B> argument, as recommended, and provides the
 119 password at the prompts.
 120 <PRE>   % <B>bos addkey -server fs1.abc.com -kvno 14</B>
 121    Input key&#58;
 122    Retype input key&#58;
 123
 124 </PRE>
 125 <P><STRONG>Privilege Required</STRONG>
 126 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
 127 the machine named by the <B>-server</B> argument, or must be logged onto a
 128 server machine as the local superuser <B>root</B> if the
 129 <B>-localauth</B> flag is included.
 130 <P><STRONG>Related Information</STRONG>
 131 <P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
 132 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
 133 <P><A HREF="auarf093.htm#HDRBOS_INTRO">bos</A>
 134 <P><A HREF="auarf107.htm#HDRBOS_LISTKEYS">bos listkeys</A>
 135 <P><A HREF="auarf111.htm#HDRBOS_REMOVEKEY">bos removekey</A>
 136 <P>
 137 <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="auarf094.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="auarf096.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>
 138 <!-- Begin Footer Records  ========================================== -->
 139 <P><HR><B>
 140 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 141 </B>
 142 <!-- End Footer Records  ============================================ -->
 143 <A NAME="Bot_Of_Page"></A>
 144 </BODY></HTML>