doc/pod/sasl.conf.pod

   1 =head1 NAME
   2
   3 sasl.conf - SASL Configuration file for nnrpd.
   4
   5 =head1 DESCRIPTION
   6
   7 The file F<sasl.conf> in I<pathetc> specifies Simple Authentication
   8 and Security Layer (SASL), defined in RFC 2222, for nnrpd.
   9 Now nnrpd implements only Security Layer support, which is an extension
  10 of RFC 2595. This means you can get SSL or TLS encrypted NNRP between
  11 your server and newsreaders. It requires OpenSSL 0.9.3 or newer from
  12 http://www.openssl.org/; it has been tested with versions 0.9.4 and 0.9.5.
  13
  14 =head1 INSTALLATION
  15
  16 To use SSL, a certificate and private key are needed that you can
  17 create using the openssl binary.
  18 Make certain that each keys are owned by your news user, news group,
  19 and are mode 0640 or 0660.
  20
  21 =head2 EXAMPLE
  22
  23    openssl req -new -x509 -nodes -out /usr/local/news/lib/cert.pem\
  24     -days 366 -keyout /usr/local/news/lib/cert.pem
  25    chown news:news /usr/local/news/lib/cert.pem
  26    chmod 640 /usr/local/news/lib/cert.pem
  27
  28 You also can make the keys as the root user with C<make cert>.
  29
  30 =head1 CONFIGURATION
  31
  32 Comments begin with a number  sign  (C<#>)  and  continue through the
  33 end of the line.  Blank lines and comments are ignored.
  34 All other lines specify parameters, and should be of the form
  35
  36     <option>: <value>
  37
  38 where <option> is the name of the configuration option being set and
  39 <value> is the value that the configuration option is being set to.
  40
  41 Blank lines and lines beginning with (C<#>) are ignored.
  42 For boolean options, the values  C<yes>,  C<on>,  C<t>,
  43 and  C<1> turn the option on; the values C<no>, C<off>,
  44 C<f>, and C<0> turn the option off.
  45
  46 =over 4
  47
  48 =item tls_cert_file
  49
  50 The path to a file containing the server's certificate.
  51
  52 =item tls_key_file
  53
  54 The path to a file containing the server's private key.
  55
  56 =item tls_ca_path
  57
  58 The path to a directory containing the CA's certificate.
  59
  60 =item tls_ca_file
  61
  62 The path to a file containing the CA's certificate.
  63
  64 =back
  65
  66 =head1 TO DO
  67
  68 Implement methods of the authentication protocols of SASL.
  69
  70 =head1 HISTORY
  71
  72 Written by Kenichi OKADA E<lt>okada@opaopa.orgE<gt> for InterNetNews.
  73
  74 =head1 SEE ALSO
  75
  76 inn.conf(5), innd(8), nnrpd(8), readers.conf(5)
  77
  78 =cut