chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / sasl.conf.5
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "SASL.CONF 5"
132 .TH SASL.CONF 5 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 sasl.conf \- SASL Configuration file for nnrpd.
135 .SH "DESCRIPTION"
136 .IX Header "DESCRIPTION"
137 The file \fIsasl.conf\fR in \fIpathetc\fR specifies Simple Authentication
138 and Security Layer (\s-1SASL\s0), defined in \s-1RFC\s0 2222, for nnrpd.
139 Now nnrpd implements only Security Layer support, which is an extension
140 of \s-1RFC\s0 2595. This means you can get \s-1SSL\s0 or \s-1TLS\s0 encrypted \s-1NNRP\s0 between
141 your server and newsreaders. It requires OpenSSL 0.9.3 or newer from
142 http://www.openssl.org/; it has been tested with versions 0.9.4 and 0.9.5.
143 .SH "INSTALLATION"
144 .IX Header "INSTALLATION"
145 To use \s-1SSL\s0, a certificate and private key are needed that you can
146 create using the openssl binary. 
147 Make certain that each keys are owned by your news user, news group,
148 and are mode 0640 or 0660.
149 .Sh "\s-1EXAMPLE\s0"
150 .IX Subsection "EXAMPLE"
151 .Vb 4
152 \&   openssl req \-new \-x509 \-nodes \-out /usr/local/news/lib/cert.pem\e
153 \&    \-days 366 \-keyout /usr/local/news/lib/cert.pem
154 \&   chown news:news /usr/local/news/lib/cert.pem
155 \&   chmod 640 /usr/local/news/lib/cert.pem
156 .Ve
157 .PP
158 You also can make the keys as the root user with \f(CW\*(C`make cert\*(C'\fR.
159 .SH "CONFIGURATION"
160 .IX Header "CONFIGURATION"
161 Comments begin with a number  sign  (\f(CW\*(C`#\*(C'\fR)  and  continue through the 
162 end of the line.  Blank lines and comments are ignored.
163 All other lines specify parameters, and should be of the form
164 .PP
165 .Vb 1
166 \&    <option>: <value>
167 .Ve
168 .PP
169 where <option> is the name of the configuration option being set and
170 <value> is the value that the configuration option is being set to.
171 .PP
172 Blank lines and lines beginning with (\f(CW\*(C`#\*(C'\fR) are ignored.
173 For boolean options, the values  \f(CW\*(C`yes\*(C'\fR,  \f(CW\*(C`on\*(C'\fR,  \f(CW\*(C`t\*(C'\fR,
174 and  \f(CW1\fR turn the option on; the values \f(CW\*(C`no\*(C'\fR, \f(CW\*(C`off\*(C'\fR,
175 \&\f(CW\*(C`f\*(C'\fR, and \f(CW0\fR turn the option off.
176 .IP "tls_cert_file" 4
177 .IX Item "tls_cert_file"
178 The path to a file containing the server's certificate.
179 .IP "tls_key_file" 4
180 .IX Item "tls_key_file"
181 The path to a file containing the server's private key.
182 .IP "tls_ca_path" 4
183 .IX Item "tls_ca_path"
184 The path to a directory containing the \s-1CA\s0's certificate.
185 .IP "tls_ca_file" 4
186 .IX Item "tls_ca_file"
187 The path to a file containing the \s-1CA\s0's certificate.
188 .SH "TO DO"
189 .IX Header "TO DO"
190 Implement methods of the authentication protocols of \s-1SASL\s0.
191 .SH "HISTORY"
192 .IX Header "HISTORY"
193 Written by Kenichi \s-1OKADA\s0 <okada@opaopa.org> for InterNetNews.
194 .SH "SEE ALSO"
195 .IX Header "SEE ALSO"
196 \&\fIinn.conf\fR\|(5), \fIinnd\fR\|(8), \fInnrpd\fR\|(8), \fIreaders.conf\fR\|(5)