| blob | 120676491fc496ce32c9a877aef8d0a56cb018d2 |
1 .\" $KAME: dhcp6s.conf.5,v 1.18 2005/01/12 06:06:12 suz Exp $
2 .\"
3 .\" Copyright (C) 2002 WIDE Project.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the project nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .Dd July 29, 2004
31 .Dt DHCP6S.CONF 5
32 .Os KAME
33 .\"
34 .Sh NAME
35 .Nm dhcp6s.conf
36 .Nd DHCPv6 server configuration file
37 .\"
38 .Sh SYNOPSIS
39 .Pa /usr/local/etc/dhcp6s.conf
40 .\"
41 .Sh DESCRIPTION
42 The
43 .Nm
44 file contains configuration information for KAME's DHCPv6 server,
45 .Nm dhcp6s .
46 The configuration file consists of a sequence of statements terminated
47 by a semi-colon (`;').
48 Statements are composed of tokens separated by white space,
49 which can be any combination of blanks,
50 tabs and newlines.
51 In some cases a set of statements is combined with a pair of brackets,
52 which is regarded as a single token.
53 Lines beginning with
54 .Ql #
55 are comments.
56 .Sh Interface specification
57 There are some statements that may or have to specify interface.
58 Interfaces are specified in the form of "name unit", such as
59 .Ar fxp0
60 and
61 .Ar gif1.
62 .\"
63 .Sh Include statement
64 An include statement specifies another configuration file to be included.
65 The format of an include statement is as follows:
66 .Bl -tag -width Ds -compact
67 .It Xo
68 .Ic include Ar \(dqfilename\(dq ;
69 .Xc
70 Where
71 .Ar \(dqfilename\(dq
72 is the name (full path) of the file to be included.
73 .El
74 .\"
75 .Sh Option statement
76 An option statement specifies configuration parameters provided for
77 every client.
78 The format of the statement is as follows.
79 .Bl -tag -width Ds -compact
80 .It Xo
81 .Ic option Ar option-name Op Ar option-value
82 ;
83 .Xc
84 The following options can be specified in an option statement.
85 .Bl -tag -width Ds -compact
86 .It Xo
87 .Ic domain-name-servers Ar dns-address Op Ar dns-addresses... ;
88 .Xc
89 provides DNS server address(es).
90 Each
91 .Ar dns-address
92 must be a numeric IPv6 address.
93 Multiple server addresses can also be specified by a sequence of
94 these statements.
95 .It Xo
96 .Ic domain-name Ar \(dqdns-name\(dq ;
97 .Xc
98 provides a domain name of a DNS search path.
99 Multiple names in the path can be specified by a sequence of these
100 statements.
101 .It Xo
102 .Ic ntp-servers Ar ntp-address Op Ar ntp-addresses... ;
103 .Xc
104 provides NTP server address(es).
105 Each
106 .Ar ntp-address
107 must be a numeric IPv6 address.
108 Multiple server addresses can also be specified by a sequence of these
109 statements.
110 .It Xo
111 .Ic sip-server-address Ar sip-server-address Op Ar sip-server-addresses... ;
112 .Xc
113 provides SIP server address(es).
114 Each
115 .Ar sip-server-address
116 must be a numeric IPv6 address.
117 Multiple server addresses can also be specified by a sequence of
118 these statements.
119 .It Xo
120 .Ic sip-server-domain-name Ar \(dqsip-server-domain-name\(dq ;
121 .Xc
122 provides a domain name of a SIP server.
123 Multiple names in the path can be specified by a sequence of these
124 statements.
125 .It Xo
126 .Ic nis-server-address Ar nis-server-address Op Ar nis-server-addresses... ;
127 .Xc
128 provides NIS server address(es).
129 Each
130 .Ar nis-server-address
131 must be a numeric IPv6 address.
132 Multiple server addresses can also be specified by a sequence of
133 these statements.
134 .It Xo
135 .Ic nis-domain-name Ar \(dqnis-domain-name\(dq ;
136 .Xc
137 provides a NIS domain name.
138 Multiple names in the path can be specified by a sequence of these
139 statements.
140 .It Xo
141 .Ic nisp-server-address Ar nisp-server-address Op Ar nisp-server-addresses... ;
142 .Xc
143 provides NIS+ server address(es).
144 Each
145 .Ar nisp-server-address
146 must be a numeric IPv6 address.
147 Multiple server addresses can also be specified by a sequence of
148 these statements.
149 .It Xo
150 .Ic nisp-domain-name Ar \(dqnisp-domain-name\(dq ;
151 .Xc
152 provides a NIS+ domain name.
153 Multiple names in the path can be specified by a sequence of these
154 statements.
155 .It Xo
156 .Ic bcmcs-server-address Ar bcmcs-server-address Op Ar bcmcs-server-addresses... ;
157 .Xc
158 provides BCMCS server address(es).
159 Each
160 .Ar bcmcs-server-address
161 must be a numeric IPv6 address.
162 Multiple server addresses can also be specified by a sequence of
163 these statements.
164 .It Xo
165 .Ic bcmcs-server-domain-name Ar \(dqbcmcs-server-domain-name\(dq ;
166 .Xc
167 provides a domain name of a BCMCS server.
168 Multiple names in the path can be specified by a sequence of these
169 statements.
170 .It Xo
171 .Ic refreshtime Ar interval ;
172 .Xc
173 specifies the refresh time of stateless information that does not have
174 particular lease duration in seconds.
175 This option is only applicable to stateless configuration by
176 information-request and reply exchanges.
177 .El
178 .El
179 .\"
180 .Sh Interface statement
181 An interface statement specifies configuration parameters on the
182 interface.
183 The generic format of an interface statement is as follows:
184 .Bl -tag -width Ds -compact
185 .It Xo
186 .Ic interface Ar interface
187 {
188 .Ar substatements
189 };
190 .Xc
191 The followings are possible
192 .Ar substatements
193 in an interface statement.
194 .Bl -tag -width Ds -compact
195 .It Xo
196 .Ic allow Ar allow-options
197 ;
198 .Xc
199 This statement specifies DHCPv6 options accepted by the server.
200 Currently only
201 .Ar rapid-commit
202 can be specified in an
203 .Ic allow
204 statement, which specifies the server to
205 accept a rapid-commit option in solicit messages.
206 .It Ic preference Ar pref ;
207 This statement sets the server's preference value on the
208 interface to the value
209 .Ar pref .
210 The specified value will be contained in a preference option of
211 advertise messages.
212 The preference value must be a decimal integer and be between 0 and
213 255 (inclusive.)
214 .It Ic address-pool Ar pool Ar pltime Op Ar vltime ;
215 This statement assigns an address pool
216 .Ar pool
217 to the interface. When
218 .Nm
219 receives a allocation request for an IA-NA, it assigns one IPv6 address from this pool.
220 The specified pool name will be defined in a pool statement.
221 Regarding the
222 .Ar pltime
223 and
224 .Ar vltime
225 , please see the explanation in the
226 .Ar prefix
227 substatement in host statement section.
228 .El
229 .El
230 .\"
231 .Sh Host statement
232 A host statement specifies configuration parameters for a particular
233 client.
234 The generic format of a host statement is as follows:
235 .Bl -tag -width Ds -compact
236 .It Xo
237 .Ic host Ar name
238 {
239 .Ar substatements
240 };
241 .Xc
242 .Ar name
243 is an arbitrary string.
244 It does not affect server's behavior but is provided for
245 readability of log messages.
246 Possible substatements are as follows.
247 .Bl -tag -width Ds -compact
248 .It Ic duid Ar ID ;
249 This statement defines the client's DHCP unique identifier
250 .Pq DUID .
251 .Ar ID
252 is a colon-separated hexadecimal sequence where each separated part
253 must be composed of two hexadecimal values.
254 This statement is used to identify a particular host by the server
255 and must be included in a host statement.
256 .It Ic prefix Ar ipv6-prefix pltime Op Ar vltime ;
257 This statement specifies an IPv6 prefix to be delegated to the client.
258 .Ar ipv6-prefix
259 is a string representing a valid IPv6 prefix
260 .Pq see the example below .
261 .Ar pltime
262 and
263 .Ar vltime
264 are preferred and valid lifetimes of the prefix, respectively.
265 When the latter is omitted, it will be set to the same value of
266 .Ar pltime.
267 A positive decimal number or a special string
268 .Ic infinity
269 can be specified as a lifetime.
270 A decimal number provides the lifetime in seconds,
271 while
272 .Ic infinity
273 means the corresponding lifetime never expires.
274 When both lifetimes are specified,
275 .Ar pltime
276 must not be larger than
277 .Ar vltime .
278 Multiple prefixes can be specified,
279 each of which is given by a single
280 .Ic prefix
281 statement.
282 In that case,
283 all or some of the specified prefixes will be delegated to the client,
284 based on required parameters by the client.
285 .It Ic address Ar ipv6-address pltime Op Ar vltime ;
286 This statement specifies an IPv6 address to be assigned to the client.
287 Everything is same as
288 .Ar prefix
289 option, except that you do not need specify prefix length.
290 .It Ic delayedkey Ar keyname ;
291 This statement specifies a secret key shared with the client for the DHCPv6
292 delayed authentication protocol.
293 .Ar keyname
294 is a string that identifies a particular set of key parameters.
295 A separate
296 .Ic keyinfo
297 statement for
298 .Ar keyname
299 must be provided in the configuration file.
300 When this statement is specified and the client includes an
301 authentication option for the delayed authentication protocol in a
302 Solicit message,
303 .Ic dhcp6s
304 will perform the authentication protocol for succeeding message
305 exchanges.
306 .El
307 .El
308 .\"
309 .Sh Pool statement
310 A pool statement specifies an address pool for a particular interface.
311 The generic format of a pool statement is as follows:
312 .Bl -tag -width Ds -compact
313 .It Xo
314 .Ic pool Ar name
315 {
316 .Ar substatements ;
317 };
318 .Xc
319 .Ar name
320 is an arbitrary string.
321 It does not affect server's behavior but is provided for
322 readability of log messages.
323 Possible substatements are as follows.
324 .Bl -tag -width Ds -compact
325 .It Ic range Ar min-addr Ic to Ar max-addr
326 This substatement defines the range of addresses allocated for the pool,
327 i.e. from
328 .Ar min-addr
329 to
330 .Ar max-addr.
331 .El
332 .El
333 .\"
334 .Sh Keyinfo statement
335 This statement defines a secret key shared with a client to
336 authenticate DHCPv6 messages.
337 The format and the description of this statement is provided in
338 .Xr dhcp6c.conf 5 .
339 One important difference in the server configuration is,
340 however,
341 the
342 .Ar keyname
343 is referred from a
344 .Ic host
345 statement as described above.
346 .\"
347 .Sh Examples
348 The followings are a sample configuration to provide a DNS server
349 address for every client as well as to delegate a permanent IPv6
350 prefix 2001:db8:1111::/48 to a client whose DUID is 00:01:00:01:aa:bb.
351 .Bd -literal -offset
352 option domain-name-servers 2001:db8::35;
354 host kame {
355 duid 00:01:00:01:aa:bb;
356 prefix 2001:db8:1111::/48 infinity;
357 };
358 .Ed
359 .Pp
360 If a shared secret should be configured in both the server and the
361 client for DHCPv6 authentication,
362 it would be specified in the configuration file as follows:
363 .Bd -literal -offset
364 keyinfo kame {
365 realm "kame.net";
366 keyid 1;
367 secret "5pvW2g48OHPvkYMJSw0vZA==";
368 };
369 .Ed
370 .Pp
371 And the
372 .Ic host
373 statement would be modified as follows:
374 .Bd -literal -offset
375 host kame {
376 duid 00:01:00:01:aa:bb;
377 prefix 2001:db8:1111::/48 infinity;
378 delayedkey kame;
379 };
380 .Ed
381 .Sh SEE ALSO
382 .Xr dhcp6c.conf 5
383 .Xr dhcp6s 8
384 .\"
385 .Sh HISTORY
386 The
387 .Nm
388 configuration file first appeared in the WIDE/KAME IPv6 protocol
389 stack kit.