doc/man-pages/pod8/kdb.pod

   1 =head1 NAME
   2
   3 kdb - Displays log or privileged actions performed by the Authentication Server
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<kdb> S<<< [B<-dbmfile> <I<dbmfile to use (default /usr/afs/logs/AuthLog)>>] >>>
  11     S<<< [B<-key> <I<extract entries that match specified key>>] >>> [B<-help>]
  12
  13 =for html
  14 </div>
  15
  16 =head1 DESCRIPTION
  17
  18 The B<kdb> command displays the contents of the F<AuthLog.dir> and
  19 F<AuthLog.pag> files associated with the F<AuthLog> file that resides on
  20 the local disk, by default in the F</usr/afs/logs> directory. The files
  21 must exist in that directory, which normally implies that the
  22 Authentication Server is running on the machine. The files contain
  23 information on privileged actions performed by the obsolete Authentication
  24 Server.
  25
  26 =head1 CAUTIONS
  27
  28 The B<kdb> command is only used to read the log files from the obsolete
  29 Authentication Server, which should no longer be used. It is provided for
  30 sites that have not yet migrated to a Kerberos version 5 KDC. The
  31 Authentication Server and supporting commands, including B<kdb>, will be
  32 removed in a future version of OpenAFS.
  33
  34 It is possible that on some operating systems that AFS otherwise supports,
  35 the Authentication Server cannot create the F</usr/afs/logs/AuthLog.dir>
  36 and F</usr/afs/logs/AuthLog.pag> files, making this command inoperative.
  37
  38 =head1 OPTIONS
  39
  40 =over 4
  41
  42 =item B<-dbmfile> <I<dbmfile to use>>
  43
  44 Specifies the pathname of the file to display. Provide either a complete
  45 pathname, a pathname relative to the F</usr/afs/logs> directory, or a
  46 filename only, in which case the file must reside in the F</usr/afs/logs>
  47 directory. Omit this argument to display information from the
  48 F<AuthLog.dir> and F<AuthLog.pag> files in the F</usr/afs/logs> directory.
  49
  50 =item B<-key> <I<extract entries that match specified key>>
  51
  52 Specifies each entry to be displayed from the indicated file.
  53
  54 =item B<-help>
  55
  56 Prints the online help for this command. All other valid options are
  57 ignored.
  58
  59 =back
  60
  61 =head1 OUTPUT
  62
  63 The first line of output indicates the location of the files from which
  64 the subsequent information is derived:
  65
  66    Printing all entries found in <file_location>
  67
  68 Each entry then includes the following two fields, separated by a colon:
  69
  70 =over 4
  71
  72 =item user/server
  73
  74 Identifies the user requesting the corresponding service and the server
  75 that performed that service. In cases where no user is directly involved,
  76 only the server appears; in cases where no server is directly involved,
  77 only the user appears.
  78
  79 =item service
  80
  81 Identifies one of the following actions or services performed by the user
  82 or server process.
  83
  84 =over 4
  85
  86 =item *
  87
  88 C<auth>: Obtained a ticket-granting ticket.
  89
  90 =item *
  91
  92 C<chp>: Changed a user password.
  93
  94 =item *
  95
  96 C<cruser>: Created a user entry in the Authentication Database.
  97
  98 =item *
  99
 100 C<delu>: Deleted a user entry from the Authentication Database.
 101
 102 =item *
 103
 104 C<gtck>: Obtained a ticket other than a ticket-granting ticket.
 105
 106 =item *
 107
 108 C<setf>: Set fields in an Authentication Database entry.
 109
 110 =item *
 111
 112 C<unlok>: Unlocked an Authentication Database entry.
 113
 114 =back
 115
 116 =back
 117
 118 The final line of output sums the number of entries.
 119
 120 =head1 EXAMPLES
 121
 122 The following example shows the output of the B<kdb> command in the Example
 123 Corporation cell (C<example.com>):
 124
 125    % kdb
 126    Printing all entries found in /usr/afs/logs/AuthLog
 127    admin,krbtgt.EXAMPLE.COM:auth
 128    admin,afs:gtck
 129    admin:cruser
 130    admin:delu
 131    4 entries were found
 132
 133 =head1 PRIVILEGE REQUIRED
 134
 135 The issuer must be logged in as the local superuser C<root>.
 136
 137 =head1 SEE ALSO
 138
 139 L<AuthLog.dir(5)>,
 140 L<bos_getlog(8)>,
 141 L<kaserver(8)>
 142
 143 =head1 COPYRIGHT
 144
 145 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 146
 147 This documentation is covered by the IBM Public License Version 1.0.  It was
 148 converted from HTML to POD by software written by Chas Williams and Russ
 149 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.