src/WINNT/doc/install/Documentation/en_US/html/CmdRef/auarf181.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="auarf180.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="auarf182.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="HDRKAS_INTRO" HREF="auarf002.htm#ToC_195">kas</A></H2>
  19 <A NAME="IDX5057"></A>
  20 <A NAME="IDX5058"></A>
  21 <A NAME="IDX5059"></A>
  22 <A NAME="IDX5060"></A>
  23 <A NAME="IDX5061"></A>
  24 <P><STRONG>Purpose</STRONG>
  25 <P>Introduction to the <B>kas</B> command suite
  26 <P><STRONG>Description</STRONG>
  27 <P>The commands in the <B>kas</B> command suite are the administrative
  28 interface to the Authentication Server, which runs on each database server
  29 machine in a cell, maintains the Authentication Database, and provides the
  30 authentication tickets that client applications must present to AFS servers in
  31 order to obtain access to AFS data and other services.
  32 <P>There are several categories of commands in the <B>kas</B> command
  33 suite&#58;
  34 <UL>
  35 <P><LI>Commands to create, modify, examine and delete entries in the
  36 Authentication Database, including passwords&#58; <B>kas create</B>,
  37 <B>kas delete</B>, <B>kas examine</B>, <B>kas list</B>, <B>kas
  38 setfields</B>, <B>kas setkey</B>, <B>kas setpassword</B>, and
  39 <B>kas unlock</B>
  40 <P><LI>Commands to create, delete, and examine tokens and server tickets&#58;
  41 <B>kas forgetticket</B>, <B>kas listtickets</B>, <B>kas
  42 noauthentication</B>, and <B>kas stringtokey</B>
  43 <P><LI>A command to enter interactive mode&#58; <B>kas interactive</B>
  44 <P><LI>A command to trace Authentication Server operations&#58; <B>kas
  45 statistics</B>
  46 <P><LI>Commands to obtain help&#58; <B>kas apropos</B> and <B>kas
  47 help</B>
  48 </UL>
  49 <P>Because of the sensitivity of information in the Authentication Database,
  50 the Authentication Server authenticates issuers of <B>kas</B> commands
  51 directly, rather than accepting the standard token generated by the Ticket
  52 Granting Service. Any <B>kas</B> command that requires
  53 administrative privilege prompts the issuer for a password. The
  54 resulting ticket is valid for six hours unless the maximum ticket lifetime for
  55 the issuer or the Authentication Server&#39;s Ticket Granting Service is
  56 shorter.
  57 <A NAME="IDX5062"></A>
  58 <A NAME="IDX5063"></A>
  59 <P>To avoid having to provide a password repeatedly when issuing a sequence of
  60 <B>kas</B> commands, enter <I>interactive mode</I> by issuing the
  61 <B>kas interactive</B> command, typing <B>kas</B> without any
  62 operation code, or typing <B>kas</B> followed by a user and cell name,
  63 separated by an at-sign (<B>@</B>; an example is <B>kas
  64 smith.admin@abc.com</B>). After prompting once for a
  65 password, the Authentication Server accepts the resulting token for every
  66 command issued during the interactive session. See the reference page
  67 for the <B>kas interactive</B> command for a discussion of when to use
  68 each method for entering interactive mode and of the effects of entering a
  69 session.
  70 <P>The Authentication Server maintains two databases on the local disk of the
  71 machine where it runs&#58;
  72 <UL>
  73 <P><LI>The Authentication Database (<B>/usr/afs/db/kaserver.DB0</B>)
  74 stores the information used to provide AFS authentication services to users
  75 and servers, including the password scrambled as an encryption key. The
  76 reference page for the <B>kas examine</B> command describes the
  77 information in a database entry.
  78 <P><LI>An auxiliary file (<B>/usr/afs/local/kaauxdb</B> by default) that
  79 tracks how often the user has provided an incorrect password to the local
  80 Authentication Server. The reference page for the <B>kas
  81 setfields</B> command describes how the Authentication Server uses this file
  82 to enforce the limit on consecutive authentication failures. To
  83 designate an alternate directory for the file, use the <B>kaserver</B>
  84 command&#39;s <B>-localfiles</B> argument.
  85 </UL>
  86 <P><STRONG>Options</STRONG>
  87 <P>The following arguments and flags are available on many commands in the
  88 <B>kas</B> suite. (Some of them are unavailable on commands entered
  89 in interactive mode, because the information they specify is established when
  90 entering interactive mode and cannot be changed except by leaving interactive
  91 mode.) The reference page for each command also lists them, but they
  92 are described here in greater detail.
  93 <DL>
  94 <P><DT><B>
  95 <A NAME="IDX5064"></A>
  96 <B>-admin_username</B>
  97 </B><DD>Specifies the user identity under which to authenticate with the
  98 Authentication Server for execution of the command. If this argument is
  99 omitted, the <B>kas</B> command interpreter requests authentication for
 100 the identity under which the issuer is logged onto the local machine.
 101 Do not combine this argument with the <B>-noauth</B> flag.
 102 <A NAME="IDX5065"></A>
 103 <P><DT><B>-cell &lt;<VAR>cell name</VAR>>
 104 </B><DD>Names the cell in which to run the command. It is acceptable to
 105 abbreviate the cell name to the shortest form that distinguishes it from the
 106 other entries in the <B>/usr/vice/etc/CellServDB</B> file on the local
 107 machine. If the <B>-cell</B> argument is omitted, the command
 108 interpreter determines the name of the local cell by reading the following in
 109 order&#58;
 110 <OL TYPE=1>
 111 <P><LI>The value of the AFSCELL environment variable
 112 <P><LI>The local <B>/usr/vice/etc/ThisCell</B> file
 113 </OL>
 114 <P>
 115 <P>The <B>-cell</B> argument is not available on commands issued in
 116 interactive mode. The cell defined when the <B>kas</B> command
 117 interpreter enters interactive mode applies to all commands issued during the
 118 interactive session.
 119 <A NAME="IDX5066"></A>
 120 <P><DT><B>-help
 121 </B><DD>Prints a command&#39;s online help message on the standard output
 122 stream. Do not combine this flag with any of the command&#39;s other
 123 options; when it is provided, the command interpreter ignores all other
 124 options, and only prints the help message.
 125 <P><DT><B>
 126 <A NAME="IDX5067"></A>
 127 <B>-noauth</B>
 128 </B><DD>Establishes an unauthenticated connection to the Authentication Server, in
 129 which the Authentication Server treats the issuer as the unprivileged user
 130 <B>anonymous</B>. It is useful only when authorization checking is
 131 disabled on the server machine (during the installation of a server machine or
 132 when the <B>bos setauth</B> command has been used during other unusual
 133 circumstances). In normal circumstances, the Authentication Server
 134 allows only privileged users to issue most <B>kas</B> commands, and
 135 refuses to perform such an action even if the <B>-noauth</B> flag is
 136 provided. Do not combine this flag with the <B>-admin_username</B>
 137 and <B>-password_for_admin</B> arguments.
 138 <P><DT><B>
 139 <A NAME="IDX5068"></A>
 140 <B>-password_for_admin</B>
 141 </B><DD>Specifies the password of the command&#39;s issuer. It is best to
 142 omit this argument, which echoes the password visibly in the command shell,
 143 instead enter the password at the prompt. Do not combine this argument
 144 with the <B>-noauth</B> flag.
 145 <P><DT><B>
 146 <A NAME="IDX5069"></A>
 147 <B>-servers</B>
 148 </B><DD>Establishes a connection with the Authentication Server running on each
 149 specified database server machine, instead of on each machine listed in the
 150 local <B>/usr/vice/etc/CellServDB</B> file. In either case, the
 151 <B>kas</B> command interpreter then chooses one of the machines at random
 152 to contact for execution of each subsequent command. The issuer can
 153 abbreviate the machine name to the shortest form that allows the local name
 154 service to identify it uniquely.
 155 </DL>
 156 <P><STRONG>Privilege Required</STRONG>
 157 <P>To issue most <B>kas</B> commands, the issuer must have the
 158 <TT>ADMIN</TT> flag set in his or her Authentication Database entry (use the
 159 <B>kas setfields</B> command to turn the flag on).
 160 <P><STRONG>Related Information</STRONG>
 161 <P><A HREF="auarf019.htm#HDRCLI_CSDB">CellServDB (client version)</A>
 162 <P><A HREF="auarf045.htm#HDRKASERVERDB">kaserver.DB0 and kaserver.DBSYS1</A>
 163 <P><A HREF="auarf046.htm#HDRKASERVERAUXDB">kaserverauxdb</A>
 164 <P><A HREF="auarf182.htm#HDRKAS_APROPOS">kas apropos</A>
 165 <P><A HREF="auarf183.htm#HDRKAS_CREATE">kas create</A>
 166 <P><A HREF="auarf184.htm#HDRKAS_DELETE">kas delete</A>
 167 <P><A HREF="auarf185.htm#HDRKAS_EXAMINE">kas examine</A>
 168 <P><A HREF="auarf186.htm#HDRKAS_FORGETTICKET">kas forgetticket</A>
 169 <P><A HREF="auarf187.htm#HDRKAS_HELP">kas help</A>
 170 <P><A HREF="auarf188.htm#HDRKAS_INTERACTIVE">kas interactive</A>
 171 <P><A HREF="auarf189.htm#HDRKAS_LIST">kas list</A>
 172 <P><A HREF="auarf190.htm#HDRKAS_LISTTICKETS">kas listtickets</A>
 173 <P><A HREF="auarf191.htm#HDRKAS_NOAUTH">kas noauthentication</A>
 174 <P><A HREF="auarf192.htm#HDRKAS_QUIT">kas quit</A>
 175 <P><A HREF="auarf193.htm#HDRKAS_SETFIELDS">kas setfields</A>
 176 <P><A HREF="auarf194.htm#HDRKAS_SETPASSWORD">kas setpassword</A>
 177 <P><A HREF="auarf195.htm#HDRKAS_STATISTICS">kas statistics</A>
 178 <P><A HREF="auarf196.htm#HDRKAS_STRINGTOKEY">kas stringtokey</A>
 179 <P><A HREF="auarf197.htm#HDRKAS_UNLOCK">kas unlock</A>
 180 <P><A HREF="auarf198.htm#HDRKASERVER">kaserver</A>
 181 <P>
 182 <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="auarf180.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="auarf182.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>
 183 <!-- Begin Footer Records  ========================================== -->
 184 <P><HR><B>
 185 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 186 </B>
 187 <!-- End Footer Records  ============================================ -->
 188 <A NAME="Bot_Of_Page"></A>
 189 </BODY></HTML>