doc/man-pages/pod8/bos_listkeys.pod

   1 =head1 NAME
   2
   3 bos_listkeys - Displays the server encryption keys from the KeyFile file
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<bos listkeys> S<<< B<-server> <I<machine name>> >>> [B<-showkey>]
  11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
  12
  13 B<bos listk> S<<< B<-se> <I<machine name>> >>> [B<-sh>] S<<< [B<-c> <I<cell name>>] >>>
  14     [B<-n>] [B<-l>] [B<-h>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<bos listkeys> command formats and displays the list of server
  22 encryption keys from the F</usr/afs/etc/KeyFile> file on the server
  23 machine named by the B<-server> argument.
  24
  25 To edit the list of keys, use the B<bos addkey> and B<bos removekey>
  26 commands.
  27
  28 =head1 CAUTIONS
  29
  30 Displaying actual keys on the standard output stream (by including the
  31 B<-showkey> flag) is a security exposure. Displaying a checksum is
  32 sufficient for most purposes.
  33
  34 =head1 OPTIONS
  35
  36 =over 4
  37
  38 =item B<-server> <I<machine name>>
  39
  40 Indicates the server machine from which to display the KeyFile
  41 file. Identify the machine by IP address or its host name (either
  42 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
  43
  44 For consistent performance in the cell, the output must be the same on
  45 every server machine. The B<bos addkey> reference page explains how to
  46 keep the machines synchronized.
  47
  48 =item B<-showkey>
  49
  50 Displays the octal digits that constitute each key.
  51
  52 =item B<-cell> <I<cell name>>
  53
  54 Names the cell in which to run the command. Do not combine this argument
  55 with the B<-localauth> flag. For more details, see L<bos(8)>.
  56
  57 =item B<-noauth>
  58
  59 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  60 combine this flag with the B<-localauth> flag. For more details, see
  61 L<bos(8)>.
  62
  63 =item B<-localauth>
  64
  65 Constructs a server ticket using a key from the local
  66 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
  67 ticket to the BOS Server during mutual authentication. Do not combine this
  68 flag with the B<-cell> or B<-noauth> options. For more details, see
  69 L<bos(8)>.
  70
  71 =item B<-help>
  72
  73 Prints the online help for this command. All other valid options are
  74 ignored.
  75
  76 =back
  77
  78 =head1 OUTPUT
  79
  80 The output includes one line for each server encryption key listed in the
  81 F<KeyFile> file, identified by its key version number.
  82
  83 If the B<-showkey> flag is included, the output displays the actual string
  84 of eight octal numbers that constitute the key. Each octal number is a
  85 backslash and three decimal digits.
  86
  87 If the B<-showkey> flag is not included, the output represents each key as
  88 a checksum, which is a decimal number derived by encrypting a constant
  89 with the key.
  90
  91 Following the list of keys or checksums, the string C<Keys last changed>
  92 indicates when a key was last added to the F<KeyFile> file. The words
  93 C<All done> indicate the end of the output.
  94
  95 For mutual authentication to work properly, the output from the command
  96 C<kas examine afs> must match the key or checksum with the same key
  97 version number in the output from this command.
  98
  99 =head1 EXAMPLES
 100
 101 The following example shows the checksums for the keys stored in the
 102 F<KeyFile> file on the machine C<fs3.abc.com>.
 103
 104    % bos listkeys fs3.abc.com
 105    key 1 has cksum 972037177
 106    key 3 has cksum 2825175022
 107    key 4 has cksum 260617746
 108    key 6 has cksum 4178774593
 109    Keys last changed on Mon Apr 12 11:24:46 1999.
 110    All done.
 111
 112 The following example shows the actual keys from the F<KeyFile> file on
 113 the machine C<fs6.abc.com>.
 114
 115    % bos listkeys fs6.abc.com -showkey
 116    key 0 is '\040\205\211\241\345\002\023\211'
 117    key 1 is '\343\315\307\227\255\320\135\244'
 118    key 2 is '\310\310\255\253\326\236\261\211'
 119    Keys last changed on Wed Mar 31 11:24:46 1999.
 120    All done.
 121
 122 =head1 PRIVILEGE REQUIRED
 123
 124 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 125 machine named by the B<-server> argument, or must be logged onto a server
 126 machine as the local superuser C<root> if the B<-localauth> flag is
 127 included.
 128
 129 =head1 SEE ALSO
 130
 131 L<KeyFile(5)>,
 132 L<UserList(5)>,
 133 L<bos_addkey(8)>,
 134 L<bos_removekey(8)>,
 135 L<bos_setauth(8)>,
 136 L<kas_examine(8)>
 137
 138 =head1 COPYRIGHT
 139
 140 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 141
 142 This documentation is covered by the IBM Public License Version 1.0.  It was
 143 converted from HTML to POD by software written by Chas Williams and Russ
 144 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.