doc/man-pages/pod8/kaserver.pod

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