OPENAFS-SA-2018-001 backup: use authenticated connection to butc
[openafs.git] / doc / man-pages / pod8 / backup.pod
index 4cb65af..0900fe6 100644 (file)
@@ -72,6 +72,10 @@ Commands to obtain help:
 L<B<backup apropos>|backup_apropos(8)>
 and L<B<backup help>|backup_help(8)>.
 
+=item *
+
+A command to display the OpenAFS command suite version: B<backup version>.
+
 =back
 
 The backup command interpreter interacts with two other processes:
@@ -162,13 +166,15 @@ prints the help message.
 =item B<-localauth>
 
 Constructs a server ticket using the server encryption key with the
-highest key version number in the local F</usr/afs/etc/KeyFile> file. The
+highest key version number in the local F</usr/afs/etc/KeyFile>
+or F</usr/afs/etc/KeyFileExt> file. The
 B<backup> command interpreter presents the ticket, which never expires, to
 the Backup Server, Volume Server and Volume Location (VL) Server during
 mutual authentication.
 
 Use this flag only when issuing a command on a server machine; client
-machines do not usually have a F</usr/afs/etc/KeyFile> file.  The issuer
+machines do not usually have a F</usr/afs/etc/KeyFile> or
+F</usr/afs/etc/KeyFileExt> file.  The issuer
 of a command that includes this flag must be logged on to the server
 machine as the local superuser C<root>. The flag is useful for commands
 invoked by an unattended application program, such as a process controlled
@@ -188,6 +194,18 @@ interactive mode. The local identity and AFS tokens with which the
 B<backup> command interpreter enters interactive mode apply to all
 commands issued during the interactive session.
 
+=item B<-nobutcauth>
+
+Prior to the fix for OPENAFS-SA-2018-001, B<butc> did not allow incoming
+connections to be authenticated.  As part of that fix, B<backup> was modified
+to authenticate to the B<butc> services when possible, but a B<backup> utility
+with the security fix will not interoperate with a B<butc> that lacks the fix
+unless this option is passed, which forces the use of unauthenticated
+connections to the B<butc>.  Use of this option is strongly disrecommended,
+and it is provided only for backwards compatibility in environments where
+B<backup> and B<butc> communicate over a secure network environment that denies
+access to untrusted parties.
+
 =item B<-portoffset> <I<TC port offset>>
 
 Specifies the port offset number of the Tape Coordinator that is to
@@ -260,7 +278,7 @@ on every Backup Server machine, every Volume Location (VL) Server machine,
 and every file server machine that houses affected volumes. By convention,
 a common F<UserList> file is distributed to all database server and file
 server machines in the cell. See the chapter on privileged users in the
-I<IBM AFS Administration Guide> for more information on this type of
+I<OpenAFS Administration Guide> for more information on this type of
 privilege.
 
 If the B<-localauth> flag is included, the user must instead be logged on
@@ -272,6 +290,7 @@ command is issued.
 L<BosConfig(5)>,
 L<CellServDB(5)>,
 L<KeyFile(5)>,
+L<KeyFileExt(5)>,
 L<ThisCell(5)>,
 L<UserList(5)>,
 L<butc(5)>,