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