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