doc/man-pages/pod8/kas.pod

   1 =head1 NAME
   2
   3 kas - Introduction to the kas command suite
   4
   5 =head1 DESCRIPTION
   6
   7 The commands in the B<kas> command suite are the administrative interface
   8 to the Authentication Server, an obsolete AFS server process that
   9 maintains the Authentication Database and provides the authentication
  10 tickets that client applications must present to AFS servers in order to
  11 obtain access to AFS data and other services. It is used only for cells
  12 still running the Authentication Server until they can migrate to a
  13 Kerberos version 5 KDC.
  14
  15 There are several categories of commands in the B<kas> command suite:
  16
  17 =over 4
  18
  19 =item *
  20
  21 Commands to create, modify, examine and delete entries in the
  22 Authentication Database, including passwords: B<kas create>, B<kas
  23 delete>, B<kas examine>, B<kas list>, B<kas setfields>, B<kas setkey>,
  24 B<kas setpassword>, and B<kas unlock>.
  25
  26 =item *
  27
  28 Commands to create, delete, and examine tokens and server tickets: B<kas
  29 forgetticket>, B<kas listtickets>, B<kas noauthentication>, and B<kas
  30 stringtokey>.
  31
  32 =item *
  33
  34 A command to enter interactive mode: B<kas interactive>.
  35
  36 =item *
  37
  38 A command to trace Authentication Server operations: B<kas statistics>.
  39
  40 =item *
  41
  42 Commands to obtain help: B<kas apropos> and B<kas help>.
  43
  44 =back
  45
  46 Because of the sensitivity of information in the Authentication Database,
  47 the Authentication Server authenticates issuers of B<kas> commands
  48 directly, rather than accepting the standard token generated by the Ticket
  49 Granting Service. Any B<kas> command that requires administrative
  50 privilege prompts the issuer for a password. The resulting ticket is valid
  51 for six hours unless the maximum ticket lifetime for the issuer or the
  52 Authentication Server's Ticket Granting Service is shorter.
  53
  54 To avoid having to provide a password repeatedly when issuing a sequence
  55 of B<kas> commands, enter I<interactive mode> by issuing the B<kas
  56 interactive> command, typing B<kas> without any operation code, or typing
  57 B<kas> followed by a user and cell name, separated by an at-sign (C<@>; an
  58 example is C<kas smith.admin@abc.com>). After prompting once for a
  59 password, the Authentication Server accepts the resulting token for every
  60 command issued during the interactive session. See L<kas_interactive(8)>
  61 for a discussion of when to use each method for entering interactive mode
  62 and of the effects of entering a session.
  63
  64 The Authentication Server maintains two databases on the local disk of the
  65 machine where it runs:
  66
  67 =over 4
  68
  69 =item *
  70
  71 The Authentication Database (F</usr/afs/db/kaserver.DB0>) stores the
  72 information used to provide AFS authentication services to users and
  73 servers, including the password scrambled as an encryption key. The
  74 reference page for the B<kas examine> command describes the information in
  75 a database entry.
  76
  77 =item *
  78
  79 An auxiliary file (F</usr/afs/local/kaauxdb> by default) that tracks how
  80 often the user has provided an incorrect password to the local
  81 Authentication Server. The reference page for the B<kas setfields> command
  82 describes how the Authentication Server uses this file to enforce the
  83 limit on consecutive authentication failures. To designate an alternate
  84 directory for the file, use the B<kaserver> command's B<-localfiles>
  85 argument.
  86
  87 =back
  88
  89 =head1 CAUTIONS
  90
  91 The B<kas> command suite is provided only for administration of the
  92 obsolete Authentication Server for cells that have not yet migrated to a
  93 Kerberos version 5 KDC. New deployments should not use the Authentication
  94 Server, and it and the B<kas> command suite will be removed in a future
  95 version of OpenAFS.
  96
  97 =head1 OPTIONS
  98
  99 The following arguments and flags are available on many commands in the
 100 B<kas> suite. (Some of them are unavailable on commands entered in
 101 interactive mode, because the information they specify is established when
 102 entering interactive mode and cannot be changed except by leaving
 103 interactive mode.) The reference page for each command also lists them,
 104 but they are described here in greater detail.
 105
 106 =over 4
 107
 108 =item B<-admin_username> <I<user name>>
 109
 110 Specifies the user identity under which to authenticate with the
 111 Authentication Server for execution of the command. If this argument is
 112 omitted, the B<kas> command interpreter requests authentication for the
 113 identity under which the issuer is logged onto the local machine.  Do not
 114 combine this argument with the B<-noauth> flag.
 115
 116 =item B<-cell> <I<cell name>>
 117
 118 Names the cell in which to run the command. It is acceptable to abbreviate
 119 the cell name to the shortest form that distinguishes it from the other
 120 entries in the F</usr/vice/etc/CellServDB> file on the local machine. If
 121 the B<-cell> argument is omitted, the command interpreter determines the
 122 name of the local cell by reading the following in order:
 123
 124 =over 4
 125
 126 =item *
 127
 128 The value of the AFSCELL environment variable.
 129
 130 =item *
 131
 132 The local F</usr/vice/etc/ThisCell> file.
 133
 134 =back
 135
 136 The B<-cell> argument is not available on commands issued in interactive
 137 mode. The cell defined when the B<kas> command interpreter enters
 138 interactive mode applies to all commands issued during the interactive
 139 session.
 140
 141 =item B<-help>
 142
 143 Prints a command's online help message on the standard output stream. Do
 144 not combine this flag with any of the command's other options; when it is
 145 provided, the command interpreter ignores all other options, and only
 146 prints the help message.
 147
 148 =item B<-noauth>
 149
 150 Establishes an unauthenticated connection to the Authentication Server, in
 151 which the Authentication Server treats the issuer as the unprivileged user
 152 C<anonymous>. It is useful only when authorization checking is disabled on
 153 the server machine (during the installation of a server machine or when
 154 the B<bos setauth> command has been used during other unusual
 155 circumstances). In normal circumstances, the Authentication Server allows
 156 only privileged users to issue most B<kas> commands, and refuses to
 157 perform such an action even if the B<-noauth> flag is provided. Do not
 158 combine this flag with the B<-admin_username> and B<-password_for_admin>
 159 arguments.
 160
 161 =item B<-password_for_admin> <I<password>>
 162
 163 Specifies the password of the command's issuer. It is best to omit this
 164 argument, which echoes the password visibly in the command shell, instead
 165 enter the password at the prompt. Do not combine this argument with the
 166 B<-noauth> flag.
 167
 168 =item B<-servers> <I<machine name>>+
 169
 170 Establishes a connection with the Authentication Server running on each
 171 specified database server machine, instead of on each machine listed in
 172 the local F</usr/vice/etc/CellServDB> file. In either case, the B<kas>
 173 command interpreter then chooses one of the machines at random to contact
 174 for execution of each subsequent command. The issuer can abbreviate the
 175 machine name to the shortest form that allows the local name service to
 176 identify it uniquely.
 177
 178 =back
 179
 180 =head1 PRIVILEGE REQUIRED
 181
 182 To issue most kas commands, the issuer must have the C<ADMIN> flag set in
 183 his or her Authentication Database entry (use the B<kas setfields> command
 184 to turn the flag on).
 185
 186 =head1 SEE ALSO
 187
 188 L<CellServDB(5)>,
 189 L<kaserver.DB0(5)>,
 190 L<kaserverauxdb(5)>,
 191 L<kas_apropos(8)>,
 192 L<kas_create(8)>,
 193 L<kas_delete(8)>,
 194 L<kas_examine(8)>,
 195 L<kas_forgetticket(8)>,
 196 L<kas_help(8)>,
 197 L<kas_interactive(8)>,
 198 L<kas_list(8)>,
 199 L<kas_listtickets(8)>,
 200 L<kas_noauthentication(8)>,
 201 L<kas_quit(8)>,
 202 L<kas_setfields(8)>,
 203 L<kas_setpassword(8)>,
 204 L<kas_statistics(8)>,
 205 L<kas_stringtokey(8)>,
 206 L<kas_unlock(8)>,
 207 L<kaserver(8)>
 208
 209 =head1 COPYRIGHT
 210
 211 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 212
 213 This documentation is covered by the IBM Public License Version 1.0.  It was
 214 converted from HTML to POD by software written by Chas Williams and Russ
 215 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.