man5-editing-pass-20051213
[openafs.git] / doc / man-pages / pod5 / KeyFile.pod
1 =head1 NAME
2
3 KeyFile - Defines AFS server encryption keys
4
5 =head1 DESCRIPTION
6
7 The F<KeyFile> file defines the server encryption keys that the AFS server
8 processes running on the machine use to decrypt the tickets presented by
9 clients during the mutual authentication process. AFS server processes
10 perform privileged actions only for clients that possess a ticket
11 encrypted with one of the keys from the file. The file must reside in the
12 F</usr/afs/etc> directory on every server machine. For more detailed
13 information on mutual authentication and server encryption keys, see the
14 I<IBM AFS Administration Guide>.
15
16 Each key has a corresponding a key version number that distinguishes it
17 from the other keys. The tickets that clients present are also marked with
18 a key version number to tell the server process which key to use to
19 decrypt it. The F<KeyFile> file must always include a key with the same
20 key version number and contents as the key currently listed for the C<afs>
21 entry in the Authentication Database.
22
23 The F<KeyFile> file is in binary format, so always use the appropriate
24 commands from the B<bos> command suite to administer it:
25
26 =over 4
27
28 =item *
29
30 The B<bos addkey> command to define a new key.
31
32 =item *
33
34 The B<bos listkeys> command to display the keys.
35
36 =item *
37
38 The B<bos removekey> command to remove a key from the file.
39
40 =back
41
42 In cells that use the Update Server to distribute the contents of the
43 F</usr/afs/etc> directory, it is customary to edit only the copy of the
44 file stored on the system control machine. Otherwise, edit the file on
45 each server machine individually.
46
47 =head1 SEE ALSO
48
49 L<bos_addkey(8)>,
50 L<bos_listkeys(8)>,
51 L<bos_removekey(8)>,
52 L<kas_setpassword(8)>,
53 L<upclient(8)>,
54 L<upserver(8)>
55
56 I<IBM AFS Administration Guide>
57
58 =head1 COPYRIGHT
59
60 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
61
62 This documentation is covered by the IBM Public License Version 1.0.  It was
63 converted from HTML to POD by software written by Chas Williams and Russ
64 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.