doc/man-pages/pod8/bos_addkey.pod

   1 =head1 NAME
   2
   3 bos addkey - Adds a new server encryption key to the /usr/afs/etc/KeyFile
   4 file
   5
   6 =head1 SYNOPSIS
   7
   8 B<bos addkey -server> <I<machine name>>  [-key <I<key>>]
   9 B<-kvno> <I<key version number>>  [B<-cell> <I<cell name>>]
  10            [B<-noauth>]  [B<-localauth>]  [-help]
  11
  12 B<bos addk -s> <I<machine name>>  [B<-ke> <I<key>>]  -kv <I<key version number>>
  13 [B<-ce> <I<cell name>>]  [B<-n>]  [B<-l>]  [B<-h>]
  14
  15 =head1 DESCRIPTION
  16
  17 The bos addkey command constructs a server encryption key from
  18 the text string provided, assigns it the key version number specified with the
  19 B<-kvno> argument, and adds it to the B</usr/afs/etc/KeyFile>
  20 file on the machine specified with the B<-server> argument. Be
  21 sure to use the B<kas setpassword> or B<kas setkey> command to
  22 add the same key to the B<afs> entry in the Authentication
  23 Database.
  24
  25 Do not use the -key argument, which echoes the password string
  26 visibly on the screen. If the argument is omitted, the BOS Server
  27 prompts for the string and does not echo it visibly:
  28
  29    Input key:
  30    Retype input key:
  31
  32 The BOS Server prohibits reuse of any key version number already listed in
  33 the B</usr/afs/etc/KeyFile> file. This ensures that users who
  34 still have tickets sealed with the current key are not prevented from
  35 communicating with a server process because the current key is overwritten
  36 with a new key. Use the B<bos listkeys> command to display the
  37 key version numbers in the B</usr/afs/etc/KeyFile> file.
  38
  39 =head1 OPTIONS
  40
  41 =over 4
  42
  43 =item -server
  44 >
  45
  46 Indicates the server machine on which to change the
  47 B</usr/afs/etc/KeyFile> file. Identify the machine by IP
  48 address or its host name (either fully-qualified or abbreviated
  49 unambiguously). For details, see the introductory reference page for
  50 the B<bos> command suite.
  51
  52 In cells that run the United States edition of AFS and use the Update
  53 Server to distribute the contents of the B</usr/afs/etc> directory, it
  54 is conventional to specify only the system control machine as a value for the
  55 B<-server> argument. In cells that run the international
  56 version of AFS, repeat the command for each file server machine. For
  57 further discussion, see the introductory reference page for the B<bos>
  58 command suite.
  59
  60 =item -key
  61 >
  62
  63 Specifies a character string just like a password; the BOS Server
  64 calls a DES conversion function to encode it into a form appropriate for use
  65 as an encryption key. Omit this argument to have the BOS Server prompt
  66 for the string instead.
  67
  68 =item -kvno
  69 >
  70
  71 Defines the new key's key version number. It must be an
  72 integer in the range from B<0> (zero) through B<255>.
  73 For the sake of simplicity, use the number one higher than the current highest
  74 key version number; use the B<bos listkeys> command to display
  75 key version numbers.
  76 L<(1)>
  77
  78 =item -cell
  79 >
  80
  81 Names the cell in which to run the command. Do not combine this
  82 argument with the B<-localauth> flag. For more details, see the
  83 introductory B<bos> reference page.
  84
  85 =item -noauth
  86 >
  87
  88 Assigns the unprivileged identity anonymous to the
  89 issuer. Do not combine this flag with the B<-localauth>
  90 flag. For more details, see the introductory B<bos> reference
  91 page.
  92
  93 =item -localauth
  94 >
  95
  96 Constructs a server ticket using a key from the local
  97 B</usr/afs/etc/KeyFile> file. The B<bos> command
  98 interpreter presents the ticket to the BOS Server during mutual
  99 authentication. Do not combine this flag with the B<-cell> or
 100 B<-noauth> options. For more details, see the introductory
 101 B<bos> reference page.
 102
 103 =item -help
 104
 105 Prints the online help for this command. All other valid options
 106 are ignored.
 107
 108 =back
 109
 110 =head1 OUTPUT
 111
 112 If the strings typed at the C<Input key> and C<Retype  input
 113 key> prompts do not match, the following message appears, and the command
 114 exits without adding a new key:
 115
 116    Input key mismatch
 117
 118 =head1 EXAMPLES
 119
 120 The following command adds a new server encryption key with key version
 121 number 14 to the B<KeyFile> file kept on the machine
 122 B<fs1.abc.com> (the system control machine). The
 123 issuer omits the B<-key> argument, as recommended, and provides the
 124 password at the prompts.
 125
 126    % bos addkey -server fs1.abc.com -kvno 14
 127    Input key:
 128    Retype input key:
 129
 130 =head1 PRIVILEGE REQUIRED
 131
 132 The issuer must be listed in the /usr/afs/etc/UserList file on
 133 the machine named by the B<-server> argument, or must be logged onto a
 134 server machine as the local superuser B<root> if the
 135 B<-localauth> flag is included.
 136
 137 =head1 SEE ALSO
 138
 139 L<KeyFile(1)>,
 140 L<UserList(1)>,
 141 L<bos(1)>,
 142 L<bos_listkeys(1)>,
 143 L<bos_removekey(1)>
 144
 145 =head1 COPYRIGHT
 146
 147 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 148
 149 This documentation is covered by the IBM Public License Version 1.0.  It was
 150 converted from HTML to POD by software written by Chas Williams and Russ
 151 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.