mirror of
https://git.openafs.org/openafs.git
synced 2025-01-31 13:38:01 +00:00
03b9fcc883
Complete an initial editing and cleanup pass for all section one man pages. Fix various conversion problems, formatting inconsistencies, and obvious problems. Please note that no editing for content has yet been done; this is solely editing for formatting and correct conversion to POD. Also, add some additional section five man pages that were omitted from the first conversion run due to unusual file names, and globally replace CAVEATS with CAUTIONS in the man pages to match the original section name. The section one man pages should now be in reasonable shape and ready for additional review and further updates, although there are probably still remaining obvious problems. ==================== This delta was composed from multiple commits as part of the CVS->Git migration. The checkin message with each commit was inconsistent. The following are the additional commit messages. ==================== This file got the wrong name when it was originally committed. Fix.
117 lines
3.4 KiB
Plaintext
117 lines
3.4 KiB
Plaintext
=head1 NAME
|
|
|
|
bos removekey - Removes a server encryption key from the /usr/afs/etc/KeyFile
|
|
file
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<bos removekey -server> <I<machine name>> -kvno <I<key version number>>+
|
|
[B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-help>]
|
|
|
|
B<bos removek -s> <I<machine name>> -k <I<key version number>>+
|
|
[B<-c> <I<cell name>>] [B<-n>] [B<-l>] [B<-h>]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The bos removekey command removes each specified encryption key
|
|
from the B</usr/afs/etc/KeyFile> file on the machine named by the
|
|
B<-server> argument. Use the B<-kvno> argument to
|
|
identify each key by its key version number; use the B<bos
|
|
listkeys> command to display the key version numbers.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
Before removing a obsolete key, verify that the cell's maximum ticket
|
|
lifetime has passed since the current key was defined using the B<kas
|
|
setpassword> and B<bos addkey> commands. This ensures that
|
|
no clients still possess tickets encrypted with the obsolete key.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -server
|
|
>
|
|
|
|
Indicates the server machine on which to change the
|
|
B</usr/afs/etc/KeyFile> file. Identify the machine by IP
|
|
address or its host name (either fully-qualified or abbreviated
|
|
unambiguously). For details, see the introductory reference page for
|
|
the B<bos> command suite.
|
|
|
|
In cells that run the United States edition of AFS and use the Update
|
|
Server to distribute the contents of the B</usr/afs/etc> directory, it
|
|
is conventional to specify only the system control machine as a value for the
|
|
B<-server> argument. In cells that run the international
|
|
version of AFS, repeat the command for each file server machine. For
|
|
further discussion, see the introductory reference page for the B<bos>
|
|
command suite.
|
|
|
|
=item -kvno
|
|
>
|
|
|
|
Specifies the key version number of each key to remove.
|
|
|
|
=item -cell
|
|
>
|
|
|
|
Names the cell in which to run the command. Do not combine this
|
|
argument with the B<-localauth> flag. For more details, see the
|
|
introductory B<bos> reference page.
|
|
|
|
=item -noauth
|
|
>
|
|
|
|
Assigns the unprivileged identity anonymous to the
|
|
issuer. Do not combine this flag with the B<-localauth>
|
|
flag. For more details, see the introductory B<bos> reference
|
|
page.
|
|
|
|
=item -localauth
|
|
>
|
|
|
|
Constructs a server ticket using a key from the local
|
|
B</usr/afs/etc/KeyFile> file. The B<bos> command
|
|
interpreter presents the ticket to the BOS Server during mutual
|
|
authentication. Do not combine this flag with the B<-cell> or
|
|
B<-noauth> options. For more details, see the introductory
|
|
B<bos> reference page.
|
|
|
|
=item -help
|
|
|
|
Prints the online help for this command. All other valid options
|
|
are ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command removes the keys with key version numbers 5 and 6
|
|
from the B<KeyFile> file on the system control machine
|
|
B<fs1.abc.com>.
|
|
|
|
% bos removekey -server fs1.abc.com -kvno 5 6
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be listed in the /usr/afs/etc/UserList file on
|
|
the machine named by the B<-server> argument, or must be logged onto a
|
|
server machine as the local superuser B<root> if the
|
|
B<-localauth> flag is included.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<KeyFile(1)>,
|
|
L<UserList(1)>,
|
|
L<bos(1)>,
|
|
L<bos_addkey(1)>,
|
|
L<bos_listkeys(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
|