doc/man-pages/pod1/fs_setcrypt.pod

   1 =head1 NAME
   2
   3 fs_setcrypt - Enables of disables the encryption of AFS file transfers
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fs setcrypt> S<<< [B<-crypt>] <I<on/off>> >>> [B<-help>]
  11
  12 =for html
  13 </div>
  14
  15 =head1 DESCRIPTION
  16
  17 The B<fs setcrypt> command sets the status of network traffic encryption
  18 for file traffic in the AFS client. This encryption applies to file
  19 traffic going to and coming from the AFS File Server for users with valid
  20 tokens.  This command does not control the encryption used for
  21 authentication, which uses Kerberos 5 or klog/kaserver. The complement of
  22 this command is B<fs getcrypt>, which shows the status of encryption on
  23 the client.
  24
  25 The default encryption status is enabled.
  26
  27 This is a global setting and applies to all subsequent connections to an
  28 AFS File Server from this Cache Manager. There is no way to enable or
  29 disable encryption for specific connections.
  30
  31 =head1 CAUTIONS
  32
  33 AFS uses an encryption scheme called fcrypt, based on but slightly weaker
  34 than DES, and there is currently no way to specify a different encryption
  35 mechanism. Because fcrypt and DES are obsolete, the user must decide how
  36 much to trust the encryption. Consider using a Virtual Private Network at
  37 the IP level if better encryption is needed.
  38
  39 Encrypting file traffic requires a token. Unauthenticated connections or
  40 connections authorized via IP-based ACLs will not be encrypted even when
  41 encryption is turned on.
  42
  43 =head1 OPTIONS
  44
  45 =over 4
  46
  47 =item B<-crypt> <I<on/off>>
  48
  49 This is the only option to B<fs setcrypt>. The B<-crypt> option takes
  50 either C<on> or C<off>. C<on> enables encryption. C<off> disables
  51 encryption. Since this is the only option, the C<-crypt> flag may be
  52 omitted.
  53
  54 C<0> and C<1> or C<true> and C<false> are not supported as replacements
  55 for C<on> and C<off>.
  56
  57 =item B<-help>
  58
  59 Prints the online help for this command. All other valid options are
  60 ignored.
  61
  62 =back
  63
  64 =head1 OUTPUT
  65
  66 This command produces no output other than error messages.
  67
  68 =head1 EXAMPLES
  69
  70 There are only four ways to invoke B<fs setcrypt>.  Either of:
  71
  72    % fs setcrypt -crypt on
  73    % fs setcrypt on
  74
  75 will enable encryption for authenticated connections and:
  76
  77    % fs setcrypt -crypt off
  78    % fs setcrypt off
  79
  80 will disable encryption.
  81
  82 =head1 PRIVILEGE REQUIRED
  83
  84 The issuer must be logged in as the local superuser root.
  85
  86 =head1 SEE ALSO
  87
  88 L<fs_getcrypt(1)>
  89
  90 The description of the fcrypt encryption mechanism at
  91 L<http://surfvi.com/~ota/fcrypt-paper.txt>.
  92
  93 =head1 COPYRIGHT
  94
  95 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
  96
  97 This documentation is covered by the BSD License as written in the
  98 doc/LICENSE file. This man page was written by Jason Edgecombe for
  99 OpenAFS.