doc/man-pages/pod8/kaserver.pod

   1 =head1 NAME
   2
   3 kaserver - Initializes the Authentication Server
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<kaserver> [B<-noAuth>] [B<-fastKeys>] [B<-database> <I<dbpath>>]
  11     S<<< [B<-localfiles> <I<lclpath>>] >>> S<<< [B<-minhours> <I<n>>] >>>
  12     S<<< [B<-servers> <I<serverlist>>] >>> [B<-enable_peer_stats>]
  13     [B<-enable_process_stats>] [B<-help>]
  14
  15 =for html
  16 </div>
  17
  18 =head1 DESCRIPTION
  19
  20 The B<kaserver> command initializes the Authentication Server, which runs
  21 on every database server machine. In the conventional configuration, its
  22 binary file is located in the F</usr/afs/bin> directory on a file server
  23 machine.
  24
  25 The B<kaserver> command is not normally issued at the command shell prompt
  26 but rather placed into a file server machine's F</usr/afs/local/BosConfig>
  27 file with the B<bos create> command. If it is ever issued at the command
  28 shell prompt, the issuer must be logged onto a database server machine as
  29 the local superuser C<root>.
  30
  31 As it initializes, the Authentication Server process creates the two files
  32 that constitute the Authentication Database, F<kaserver.DB0> and
  33 F<kaserver.DBSYS1>, in the F</usr/afs/db> directory if they do not already
  34 exist. Use the commands in the B<kas> suite to administer the database.
  35
  36 The Authentication Server is responsible for several aspects of AFS
  37 security, including:
  38
  39 =over 4
  40
  41 =item *
  42
  43 Maintenance of all AFS server encryption keys and user passwords in the
  44 Authentication Database.
  45
  46 =item *
  47
  48 Creation of the tickets and tokens that users and servers use to establish
  49 secure connections. Its Ticket Granting Service (TGS) component performs
  50 this function.
  51
  52 =back
  53
  54 The Authentication Server records a trace of its activity in the
  55 F</usr/afs/logs/AuthLog> file. Use the B<bos getlog> command to display
  56 the contents of the file. Use the B<kdb> command to read the protected
  57 files associated with the F<AuthLog> file, F<AuthLog.dir> and
  58 F<AuthLog.pag>.
  59
  60 This command does not use the syntax conventions of the AFS command
  61 suites. Provide the command name and all option names in full.
  62
  63 =head1 OPTIONS
  64
  65 =over 4
  66
  67 =item B<-noAuth>
  68
  69 Assigns the unprivileged identity C<anonymous> to the issuer. Thus, it
  70 establishes an unauthenticated connection between the issuer and the
  71 Authentication Server. It is useful only when authorization checking is
  72 disabled on the database server machine. In normal circumstances, the
  73 Authentication Server allows only authorized (privileged) users to issue
  74 commands that affect or contact the Authentication Database and will
  75 refuse to perform such an action even if the B<-noAuth> flag is used.
  76
  77 =item B<-fastKeys>
  78
  79 Is a test flag for use by the AFS Development staff; it serves no
  80 functional purpose.
  81
  82 =item B<-database> <I<dbpath>>
  83
  84 Specifies the pathname of an alternate directory in which the
  85 Authentication Database files reside. Provide the complete pathname,
  86 ending in the base filename to which the C<.DB0> and C<.DBSYS1> extensions
  87 are appended. For example, the appropriate value for the default database
  88 files is F</usr/afs/db/kaserver>.
  89
  90 Provide the B<-localfiles> argument along with this one; otherwise, the
  91 B<-localfiles> argument is also set to the value of this argument, which
  92 is probably inappropriate.
  93
  94 =item B<-localfiles> <I<lclpath>>
  95
  96 Specifies the pathname of an alternate directory in which the auxiliary
  97 Authentication Database file resides. Provide the complete pathname,
  98 ending in the base filename to which the C<auxdb> suffix is appended. For
  99 example, the appropriate value for the default auxiliary database file is
 100 F</usr/afs/local/kaserver>.
 101
 102 =item B<-minhours> <I<n>>
 103
 104 Specifies the minimum number of hours that must pass between password
 105 changes made by any regular user. System administrators (with the C<ADMIN>
 106 flag in their Authentication Database entry) can change passwords as often
 107 as desired. Setting a minimum time between password changes is not
 108 recommended.
 109
 110 =item B<-servers> <I<authentication servers>>+
 111
 112 Names each database server machine running an Authentication Server with
 113 which the local Authentication Server is to synchronize its copy of the
 114 Authentication Database, rather than with the machines listed in the local
 115 F</usr/afs/etc/CellServDB> file.
 116
 117 =item B<-enable_peer_stats>
 118
 119 Activates the collection of Rx statistics and allocates memory for their
 120 storage. For each connection with a specific UDP port on another machine,
 121 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
 122 so on) sent or received. To display or otherwise access the records, use
 123 the Rx Monitoring API.
 124
 125 =item B<-enable_process_stats>
 126
 127 Activates the collection of Rx statistics and allocates memory for their
 128 storage. A separate record is kept for each type of RPC (FetchFile,
 129 GetStatus, and so on) sent or received, aggregated over all connections to
 130 other machines. To display or otherwise access the records, use the Rx
 131 Monitoring API.
 132
 133 =item B<-help>
 134
 135 Prints the online help for this command. All other valid options are
 136 ignored.
 137
 138 =back
 139
 140 =head1 EXAMPLES
 141
 142 The following B<bos create> command creates a C<kaserver> process on
 143 C<fs3.abc.com> (the command appears on two lines here only for
 144 legibility):
 145
 146    % bos create -server fs3.abc.com -instance kaserver \
 147                 -type simple -cmd /usr/afs/bin/kaserver
 148
 149 =head1 PRIVILEGE REQUIRED
 150
 151 The issuer must be logged in as the superuser C<root> on a file server
 152 machine to issue the command at a command shell prompt. It is conventional
 153 instead to create and start the process by issuing the B<bos create>
 154 command.
 155
 156 =head1 SEE ALSO
 157
 158 L<AuthLog(5)>,
 159 L<BosConfig(5)>,
 160 L<CellServDB(5)>,
 161 L<kaserver.DB0(5)>,
 162 L<kaserverauxdb(5)>,
 163 L<bos(8)>,
 164 L<bos_create(8)>,
 165 L<bos_getlog(8)>,
 166 L<kas(8)>,
 167 L<kdb(8)>
 168
 169 =head1 COPYRIGHT
 170
 171 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 172
 173 This documentation is covered by the IBM Public License Version 1.0.  It was
 174 converted from HTML to POD by software written by Chas Williams and Russ
 175 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.