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