3 bos addkey - Adds a new server encryption key to the KeyFile file
7 B<bos addkey> B<-server> <I<machine name>> [B<-key> <I<key>>]
8 B<-kvno> <I<key version number>> [B<-cell> <I<cell name>>]
9 [B<-noauth>] [B<-localauth>] [B<-help>]
11 B<bos addk> B<-s> <I<machine name>> [B<-ke> <I<key>>]
12 B<-kv> <I<key version number>> [B<-ce> <I<cell name>>] [B<-n>]
17 The B<bos addkey> command constructs a server encryption key from the text
18 string provided, assigns it the key version number specified with the
19 B<-kvno> argument, and adds it to the F</usr/afs/etc/KeyFile> file on the
20 machine specified with the B<-server> argument. Be sure to use the B<kas
21 setpassword> or B<kas setkey> command to add the same key to the C<afs>
22 entry in the Authentication Database.
24 Do not use the B<-key> argument, which echoes the password string visibly
25 on the screen. If the argument is omitted, the BOS Server prompts for the
26 string and does not echo it visibly:
31 The BOS Server prohibits reuse of any key version number already listed in
32 the F</usr/afs/etc/KeyFile> file. This ensures that users who still have
33 tickets sealed with the current key are not prevented from communicating
34 with a server process because the current key is overwritten with a new
35 key. Use the B<bos listkeys> command to display the key version numbers in
36 the F</usr/afs/etc/KeyFile> file.
42 =item B<-server> <I<machine name>>
44 Indicates the server machine on which to change the
45 F</usr/afs/etc/KeyFile> file. Identify the machine by IP address or its
46 host name (either fully-qualified or abbreviated unambiguously). For
47 details, see L<bos(8)>.
49 In cells that use the Update Server to distribute the contents of the
50 F</usr/afs/etc> directory, it is conventional to specify only the system
51 control machine as a value for the B<-server> argument. Otherwise, repeat
52 the command for each file server machine. For further discussion, see
55 =item B<-key> <I<key>>
57 Specifies a character string just like a password; the BOS Server calls a
58 DES conversion function to encode it into a form appropriate for use as an
59 encryption key. Omit this argument to have the BOS Server prompt for the
62 =item B<-kvno> <I<key version number>>
64 Defines the new key's key version number. It must be an integer in the
65 range from C<0> (zero) through C<255>. For the sake of simplicity, use
66 the number one higher than the current highest key version number; use the
67 B<bos listkeys> command to display key version numbers.
69 =item B<-cell> <I<cell name>>
71 Names the cell in which to run the command. Do not combine this argument
72 with the B<-localauth> flag. For more details, see L<bos(8)>.
76 Assigns the unprivileged identity C<anonymous> to the issuer. Do not combine
77 this flag with the B<-localauth> flag. For more details, see L<bos(8)>.
81 Constructs a server ticket using a key from the local
82 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
83 ticket to the BOS Server during mutual authentication. Do not combine this
84 flag with the B<-cell> or B<-noauth> options. For more details, see
89 Prints the online help for this command. All other valid options are
96 If the strings typed at the C<Input key> and C<Retype input key> prompts
97 do not match, the following message appears, and the command exits without
104 The following command adds a new server encryption key with key version
105 number 14 to the B<KeyFile> file kept on the machine C<fs1.abc.com> (the
106 system control machine). The issuer omits the B<-key> argument, as
107 recommended, and provides the password at the prompts.
109 % bos addkey -server fs1.abc.com -kvno 14
113 =head1 PRIVILEGE REQUIRED
115 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
116 machine named by the B<-server> argument, or must be logged onto a server
117 machine as the local superuser C<root> if the B<-localauth> flag is
130 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
132 This documentation is covered by the IBM Public License Version 1.0. It was
133 converted from HTML to POD by software written by Chas Williams and Russ
134 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.