doc/man-pages/pod8/bos_removekey.pod

   1 =head1 NAME
   2
   3 bos removekey - Removes a server encryption key from the KeyFile file
   4
   5 =head1 SYNOPSIS
   6
   7 B<bos removekey> B<-server> <I<machine name>>
   8     B<-kvno> <I<key version number>>+ [B<-cell> <I<cell name>>]
   9     [B<-noauth>] [B<-localauth>] [B<-help>]
  10
  11 B<bos removek> B<-s> <I<machine name>> B<-k> <I<key version number>>+
  12     [B<-c> <I<cell name>>] [B<-n>] [B<-l>] [B<-h>]
  13
  14 =head1 DESCRIPTION
  15
  16 The B<bos removekey> command removes each specified encryption key from
  17 the F</usr/afs/etc/KeyFile> file on the machine named by the B<-server>
  18 argument. Use the B<-kvno> argument to identify each key by its key
  19 version number; use the B<bos listkeys> command to display the key version
  20 numbers.
  21
  22 =head1 CAUTIONS
  23
  24 Before removing a obsolete key, verify that the cell's maximum ticket
  25 lifetime has passed since the current key was defined using the B<kas
  26 setpassword> and B<bos addkey> commands. This ensures that no clients
  27 still possess tickets encrypted with the obsolete key.
  28
  29 =head1 OPTIONS
  30
  31 =over 4
  32
  33 =item B<-server> <I<machine name>>
  34
  35 Indicates the server machine on which to change the
  36 F</usr/afs/etc/KeyFile> file. Identify the machine by IP address or its
  37 host name (either fully-qualified or abbreviated unambiguously). For
  38 details, see L<bos(8)>.
  39
  40 In cells that use the Update Server to distribute the contents of the
  41 F</usr/afs/etc> directory, it is conventional to specify only the system
  42 control machine as a value for the B<-server> argument. Otherwise, repeat
  43 the command for each file server machine. For further discussion, see
  44 L<bos(8)>.
  45
  46 =item B<-kvno> <I<key version number>>+
  47
  48 Specifies the key version number of each key to remove.
  49
  50 =item B<-cell> <I<cell name>>
  51
  52 Names the cell in which to run the command. Do not combine this argument
  53 with the B<-localauth> flag. For more details, see L<bos(8)>.
  54
  55 =item B<-noauth>
  56
  57 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  58 combine this flag with the B<-localauth> flag. For more details, see
  59 L<bos(8)>.
  60
  61 =item B<-localauth>
  62
  63 Constructs a server ticket using a key from the local
  64 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
  65 ticket to the BOS Server during mutual authentication. Do not combine this
  66 flag with the B<-cell> or B<-noauth> options. For more details, see
  67 L<bos(8)>.
  68
  69 =item B<-help>
  70
  71 Prints the online help for this command. All other valid options are
  72 ignored.
  73
  74 =back
  75
  76 =head1 EXAMPLES
  77
  78 The following command removes the keys with key version numbers 5 and 6
  79 from the F<KeyFile> file on the system control machine C<fs1.abc.com>.
  80
  81    % bos removekey -server fs1.abc.com -kvno 5 6
  82
  83 =head1 PRIVILEGE REQUIRED
  84
  85 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
  86 machine named by the B<-server> argument, or must be logged onto a server
  87 machine as the local superuser C<root> if the B<-localauth> flag is
  88 included.
  89
  90 =head1 SEE ALSO
  91
  92 L<KeyFile(5)>,
  93 L<UserList(5)>,
  94 L<bos(8)>,
  95 L<bos_addkey(8)>,
  96 L<bos_listkeys(8)>
  97
  98 =head1 COPYRIGHT
  99
 100 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 101
 102 This documentation is covered by the IBM Public License Version 1.0.  It was
 103 converted from HTML to POD by software written by Chas Williams and Russ
 104 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.