.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "BOS_ADDKEY 8" .TH BOS_ADDKEY 8 2024-03-20 OpenAFS "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME bos_addkey \- Adds a new server encryption key to the KeyFile file .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBbos addkey\fR \fB\-server\fR\ <\fImachine\ name\fR> [\fB\-key\fR\ <\fIkey\fR>] \fB\-kvno\fR\ <\fIkey\ version\ number\fR> [\fB\-cell\fR\ <\fIcell\ name\fR>] [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-help\fR] .PP \&\fBbos addk\fR \fB\-s\fR\ <\fImachine\ name\fR> [\fB\-ke\fR\ <\fIkey\fR>] \fB\-kv\fR\ <\fIkey\ version\ number\fR> [\fB\-ce\fR\ <\fIcell\ name\fR>] [\fB\-n\fR] [\fB\-l\fR] [\fB\-h\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" The \fBbos addkey\fR command constructs a server encryption key from the text string provided, assigns it the key version number specified with the \&\fB\-kvno\fR argument, and adds it to the \fI/etc/openafs/server/KeyFile\fR file on the machine specified with the \fB\-server\fR argument. .PP Normally, \fBasetkey add\fR should be used instead of this command; see \&\fBasetkey\fR\|(8) for more details. The primary use of \fBbos addkey\fR is for cells that are still using the Authentication Server instead of a Kerberos v5 KDC. It may, however, also be useful in unusual circumstances where a key needs to be added based on a known password rather than via a Kerberos v5 keytab. .PP When using \fBbos addkey\fR with an AFS cell that uses the Authentication Server, be sure to use the \fBkas setpassword\fR or \fBkas setkey\fR command to add the same key to the \f(CW\*(C`afs\*(C'\fR entry in the Authentication Database. .PP Do not use the \fB\-key\fR argument, which echoes the password string visibly on the screen. If the argument is omitted, the BOS Server prompts for the string and does not echo it visibly: .PP .Vb 2 \& Input key: \& Retype input key: .Ve .PP The BOS Server prohibits reuse of any key version number already listed in the \fI/etc/openafs/server/KeyFile\fR file. This ensures that users who still have tickets sealed with the current key are not prevented from communicating with a server process because the current key is overwritten with a new key. Use the \fBbos listkeys\fR command to display the key version numbers in the \fI/etc/openafs/server/KeyFile\fR file. .SH CAUTIONS .IX Header "CAUTIONS" In the unusual case of using \fBbos addkey\fR to add a key with a known password matching a password used to generate Kerberos v5 keys, the key in the Kerberos v5 KDC database must have only the DES encryption type and must use \f(CW\*(C`afs3\*(C'\fR salt, not the default Kerberos v5 salt. Otherwise, the key generated by \fBbos addkey\fR will not match the key generated by the Kerberos v5 KDC. .PP This command can only add keys to the \fIKeyFile\fR; these keys must be DES keys. The stronger keys used by the rxkad\-k5 extension are stored in the \fIKeyFileExt\fR, which is not supported by this command. .PP As such, the use of this command is disrecommended; use \&\fBasetkey\fR\|(8) instead to benefit from the increased security of the rxkad\-k5 extension. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-server\fR <\fImachine name\fR>" 4 .IX Item "-server " Indicates the server machine on which to change the \&\fI/etc/openafs/server/KeyFile\fR file. Identify the machine by IP address or its host name (either fully-qualified or abbreviated unambiguously). For details, see \fBbos\fR\|(8). .Sp In cells that use the Update Server to distribute the contents of the \&\fI/etc/openafs/server\fR directory, it is conventional to specify only the system control machine as a value for the \fB\-server\fR argument. Otherwise, repeat the command for each file server machine. For further discussion, see \&\fBbos\fR\|(8). .IP "\fB\-key\fR <\fIkey\fR>" 4 .IX Item "-key " Specifies a character string just like a password; the BOS Server calls a DES conversion function to encode it into a form appropriate for use as an encryption key. Omit this argument to have the BOS Server prompt for the string instead. .IP "\fB\-kvno\fR <\fIkey version number\fR>" 4 .IX Item "-kvno " Defines the new key's key version number. It must be an integer in the range from \f(CW0\fR (zero) through \f(CW255\fR. For the sake of simplicity, use the number one higher than the current highest key version number; use the \&\fBbos listkeys\fR command to display key version numbers. .IP "\fB\-cell\fR <\fIcell name\fR>" 4 .IX Item "-cell " Names the cell in which to run the command. Do not combine this argument with the \fB\-localauth\fR flag. For more details, see \fBbos\fR\|(8). .IP \fB\-noauth\fR 4 .IX Item "-noauth" Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not combine this flag with the \fB\-localauth\fR flag. For more details, see \fBbos\fR\|(8). .IP \fB\-localauth\fR 4 .IX Item "-localauth" Constructs a server ticket using a key from the local \&\fI/etc/openafs/server/KeyFile\fR or \fI/etc/openafs/server/KeyFileExt\fR file. The \fBbos\fR command interpreter presents the ticket to the BOS Server during mutual authentication. Do not combine this flag with the \fB\-cell\fR or \fB\-noauth\fR options. For more details, see \&\fBbos\fR\|(8). .IP \fB\-help\fR 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH OUTPUT .IX Header "OUTPUT" If the strings typed at the \f(CW\*(C`Input key\*(C'\fR and \f(CW\*(C`Retype input key\*(C'\fR prompts do not match, the following message appears, and the command exits without adding a new key: .PP .Vb 1 \& Input key mismatch .Ve .SH EXAMPLES .IX Header "EXAMPLES" The following command adds a new server encryption key with key version number 14 to the \fBKeyFile\fR file kept on the machine \f(CW\*(C`fs1.example.com\*(C'\fR (the system control machine). The issuer omits the \fB\-key\fR argument, as recommended, and provides the password at the prompts. .PP .Vb 3 \& % bos addkey \-server fs1.example.com \-kvno 14 \& Input key: \& Retype input key: .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be listed in the \fI/etc/openafs/server/UserList\fR file on the machine named by the \fB\-server\fR argument, or must be logged onto a server machine as the local superuser \f(CW\*(C`root\*(C'\fR if the \fB\-localauth\fR flag is included. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBKeyFile\fR\|(5), \&\fBKeyFileExt\fR\|(5), \&\fBUserList\fR\|(5), \&\fBasetkey\fR\|(8), \&\fBbos\fR\|(8), \&\fBbos_listkeys\fR\|(8), \&\fBbos_removekey\fR\|(8) .SH COPYRIGHT .IX Header "COPYRIGHT" IBM Corporation 2000. All Rights Reserved. .PP 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.