| blob | cc69a58212551189371fe1b0b128d7fc7aa6d155 |
1 .\" $NetBSD: racoon.conf.5,v 1.58 2009/09/01 12:22:09 tteras Exp $
2 .\"
3 .\" Id: racoon.conf.5,v 1.54 2006/08/22 18:17:17 manubsd Exp
4 .\"
5 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6 .\" All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. Neither the name of the project nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd March 12, 2009
33 .Dt RACOON.CONF 5
34 .Os
35 .\"
36 .Sh NAME
37 .Nm racoon.conf
38 .Nd configuration file for racoon
39 .\"
40 .\" .Sh SYNOPSIS
41 .\"
42 .Sh DESCRIPTION
43 .Nm
44 is the configuration file for the
45 .Xr racoon 8
46 ISAKMP daemon.
47 .Xr racoon 8
48 negotiates security associations for itself (ISAKMP SA, or phase 1 SA)
49 and for kernel IPsec (IPsec SA, or phase 2 SA).
50 The file consists of a sequence of directives and statements.
51 Each directive is composed by a tag and statements, enclosed by
52 .Ql {
53 and
54 .Ql } .
55 Lines beginning with
56 .Ql #
57 are comments.
58 .\"
59 .Ss Meta Syntax
60 Keywords and special characters that the parser expects exactly are
61 displayed using
62 .Ic this
63 font.
64 Parameters are specified with
65 .Ar this
66 font.
67 Square brackets
68 .Po
69 .Ql \&[
70 and
71 .Ql \&]
72 .Pc
73 are used to show optional keywords and parameters.
74 Note that
75 you have to pay attention when this manual is describing
76 .Ar port
77 numbers.
78 The
79 .Ar port
80 number is always enclosed by
81 .Ql \&[
82 and
83 .Ql \&] .
84 In this case, the port number is not an optional keyword.
85 If it is possible to omit the
86 .Ar port
87 number,
88 the expression becomes
89 .Bq Bq Ar port .
90 The vertical bar
91 .Pq Ql \&|
92 is used to indicate
93 a choice between optional parameters.
94 Parentheses
95 .Po
96 .Ql \&(
97 and
98 .Ql \&)
99 .Pc
100 are used to group keywords and parameters when necessary.
101 Major parameters are listed below.
102 .Pp
103 .Bl -tag -width addressx -compact
104 .It Ar number
105 means a hexadecimal or a decimal number.
106 The former must be prefixed with
107 .Ql Li 0x .
108 .It Ar string
109 .It Ar path
110 .It Ar file
111 means any string enclosed in
112 .Ql \&"
113 .Pq double quotes .
114 .It Ar address
115 means IPv6 and/or IPv4 address.
116 .It Ar port
117 means a TCP/UDP port number.
118 The port number is always enclosed by
119 .Ql \&[
120 and
121 .Ql \&] .
122 .It Ar timeunit
123 is one of following:
124 .Ic sec , secs , second , seconds ,
125 .Ic min , mins , minute , minutes ,
126 .Ic hour , hours .
127 .El
128 .\"
129 .Ss Privilege separation
130 .Bl -tag -width Ds -compact
131 .It Ic privsep { Ar statements Ic }
132 Specifies privilege separation parameters.
133 When enabled, these enable
134 .Xr racoon 8
135 to operate with an unprivileged instance doing most of the work, while
136 a privileged instance takes care of performing the following operations
137 as root: reading PSK and private keys, launching hook scripts, and
138 validating passwords against system databases or against PAM.
139 Please note that using privilege separation makes changes to the
140 .Ar listen
141 and
142 .Ar paths
143 sections ignored upon configuration reloads.
144 A
145 .Xr racoon 8
146 restart is required if you want such changes to be taken into account.
147 .Pp
148 .Bl -tag -width Ds -compact
149 .It Ic user Ar user ;
150 The user to which the unprivileged instance of
151 .Xr racoon 8 ,
152 should switch.
153 This can be a quoted user name or a numeric UID.
154 .It Ic group Ar group ;
155 The group the unprivileged instance of
156 .Xr racoon 8 ,
157 should switch.
158 This can be a quoted group name or a numeric GID.
159 .It Ic chroot Ar path ;
160 A directory to which the unprivileged instance of
161 .Xr racoon 8
162 should
163 .Xr chroot 2 .
164 This directory should hold a tree where the following files must be
165 reachable:
166 .Bl -tag -width Ds -compact
167 .It Pa /dev/random
168 .It Pa /dev/urandom
169 .It The certificates
170 .It The file containing the Xauth banner
171 .El
172 .Pp
173 The PSK file, the private keys, and the hook scripts are accessed through the
174 privileged instance of
175 .Xr racoon 8
176 and do not need to be reachable in the
177 .Xr chroot 2 Ap ed
178 tree.
179 .El
180 .El
181 .Ss Path Specification
182 This section specifies various paths used by racoon.
183 When running in privilege separation mode,
184 .Ic certificate
185 and
186 .Ic script
187 paths are mandatory.
188 A
189 .Xr racoon 8
190 restart is required if you want path changes to be taken into account.
191 .Bl -tag -width Ds -compact
192 .It Ic path include Ar path ;
193 Specifies a path to include a file.
194 See
195 .Sx File Inclusion .
196 .It Ic path pre_shared_key Ar file ;
197 Specifies a file containing pre-shared key(s) for various ID(s).
198 See
199 .Sx Pre-shared key File .
200 .It Ic path certificate Ar path ;
201 .Xr racoon 8
202 will search this directory if a certificate or certificate request is received.
203 If you run with privilege separation,
204 .Xr racoon 8
205 will refuse to use a certificate stored outside of this directory.
206 .It Ic path backupsa Ar file ;
207 Specifies a file to which SA information negotiated by
208 racoon should be stored.
209 .Xr racoon 8
210 will install SA(s) from the file when started with the
211 .Fl B
212 flag.
213 The file is growing because
214 .Xr racoon 8
215 simply adds SAs to it.
216 You should maintain the file manually.
217 .It Ic path script Ar path ;
218 .Xr racoon 8
219 will search this directory for scripts hooks.
220 If you run with privilege separation,
221 .Xr racoon 8
222 will refuse to execute a script stored outside of this directory.
223 .It Ic path pidfile Ar file ;
224 Specifies file where to store PID of process.
225 If path starts with
226 .Pa /
227 it is treated as an absolute path.
228 Otherwise, it is treated as a relative
229 path to the VARRUN directory specified at compilation time.
230 Default is
231 .Pa racoon.pid .
232 .El
233 .\"
234 .Ss File Inclusion
235 .Bl -tag -width Ds -compact
236 .It Ic include Ar file
237 Specifies other configuration files to be included.
238 .El
239 .\"
240 .Ss Timer Specification
241 .Bl -tag -width Ds -compact
242 .It Ic timer { Ar statements Ic }
243 This section specifies various timer values used by racoon.
244 .Pp
245 .Bl -tag -width Ds -compact
246 .It Ic counter Ar number ;
247 The maximum number of retries to send.
248 The default is 5.
249 .It Ic interval Ar number Ar timeunit ;
250 The interval to resend, in seconds.
251 The default time is 10 seconds.
252 .It Ic persend Ar number ;
253 The number of packets per send.
254 The default is 1.
255 .It Ic phase1 Ar number Ar timeunit ;
256 The maximum time it should take to complete phase 1.
257 The default time is 15 seconds.
258 .It Ic phase2 Ar number Ar timeunit ;
259 The maximum time it should take to complete phase 2.
260 The default time is 10 seconds.
261 .It Ic natt_keepalive Ar number Ar timeunit ;
262 The interval between sending NAT-Traversal keep-alive packets.
263 The default time is 20 seconds.
264 Set to 0s to disable keep-alive packets.
265 .El
266 .El
267 .\"
268 .Ss Listening Port Specification
269 .Bl -tag -width Ds -compact
270 .It Ic listen { Ar statements Ic }
271 If no
272 .Ar listen
273 directive is specified,
274 .Xr racoon 8
275 will listen on all available interface addresses.
276 The following is the list of valid statements:
277 .Pp
278 .Bl -tag -width Ds -compact
279 .\" How do I express bold brackets; `[' and `]' .
280 .\" Answer: For bold brackets, do "Ic \&[ foo \&]".
281 .\" Is the "Bq Ic [ Ar port ] ;" buggy ?
282 .It Ic isakmp Ar address Bq Bq Ar port ;
283 If this is specified,
284 .Xr racoon 8
285 will only listen on the defined
286 .Ar address .
287 The default port is 500, which is specified by IANA.
288 You can provide more than one address definition.
289 .It Ic isakmp_natt Ar address Bq Ar port ;
290 Same as
291 .Ic isakmp
292 but also sets the socket options to accept UDP-encapsulated ESP traffic for
293 NAT-Traversal.
294 If you plan to use NAT-T, you should provide at least one address
295 with port 4500, which is specified by IANA.
296 There is no default.
297 .It Ic strict_address ;
298 Requires that all addresses for ISAKMP be bound.
299 This statement will be ignored if you do not specify address definitions.
300 .El
301 When running in privilege separation mode, you need to restart
302 .Xr racoon 8
303 to have changes to the
304 .Ar listen
305 section taken into account.
306 .Pp
307 The
308 .Ar listen
309 section can also be used to specify the admin socket mode and ownership
310 if racoon was built with support for admin port.
311 .Bl -tag -width Ds -compact
312 .It Ic adminsock Ar path Op Ar owner\ group\ mode ;
313 The
314 .Ar path ,
315 .Ar owner ,
316 and
317 .Ar group
318 values specify the socket path, owner, and group.
319 They must be quoted.
320 The defaults are
321 .Pa /var/racoon/racoon.sock ,
322 UID 0, and GID 0.
323 .Ar mode
324 is the access mode in octal.
325 The default is 0600.
326 .It Ic adminsock disabled ;
327 This directive tells racoon to not listen on the admin socket.
328 .El
329 .El
330 .\"
331 .Ss Miscellaneous Global Parameters
332 .Bl -tag -width Ds -compact
333 .It Ic gss_id_enc Ar enctype ;
334 Older versions of
335 .Xr racoon 8
336 used ISO-Latin-1 as the encoding of the GSS-API identifier attribute.
337 For interoperability with Microsoft Windows' GSS-API authentication
338 scheme, the default encoding has been changed to UTF-16LE.
339 The
340 .Ic gss_id_enc
341 parameter allows
342 .Xr racoon 8
343 to be configured to use the old encoding for compatibility with existing
344 .Xr racoon 8
345 installations.
346 The following are valid values for
347 .Ar enctype :
348 .Pp
349 .Bl -tag -width Ds -compact
350 .It Ic utf-16le
351 Use UTF-16LE to encode the GSS-API identifier attribute.
352 This is the default encoding.
353 This encoding is compatible with Microsoft Windows.
354 .It Ic latin1
355 Use ISO-Latin-1 to encode the GSS-API identifier attribute.
356 This is the encoding used by older versions of
357 .Xr racoon 8 .
358 .El
359 .El
360 .\"
361 .Pp
362 .Bl -tag -width Ds -compact
363 .It Ic pfkey_buffer Ar kBytes
364 Specifies the socket send/receive buffer size in kilobytes.
365 Numerous kernel PF_KEY implementations have problems with dumping
366 SAD/SDP with large amount of entries (this happens when 100s to
367 1000s of tunnels are configured).
368 .Pp
369 The default value of 0 leaves everything at the OS-specific default value.
370 If the default buffer size is greater than what is specified here racoon
371 will not decrease it.
372 .Pp
373 This problem is known to be fixed in Linux 2.6.25 and later.
374 .El
375 .\"
376 .Ss Remote Nodes Specifications
377 .Bl -tag -width Ds -compact
378 .It Ic remote Ar name Bo Ic inherit Ar parent_name Bc Ic { Ar statements Ic }
379 Specifies the IKE phase 1 parameters for each remote node.
380 .Pp
381 If connection is initiated using racoonctl, a unique match using the
382 remote IP must be found or the remote block name has to be given.
383 For received acquires (kernel notices traffic requiring a new SA) the
384 remote IP and remoteid from matching sainfo block are used to decide
385 the remoteblock.
386 If no uniquely matching remoteblock is found using
387 these criteria, no connection attempt is done.
388 .Pp
389 When acting as responder, racoon picks the first proposal that has one
390 or more acceptable remote configurations.
391 When determining if a remote
392 specification is matching the following information is checked:
393 .Bl -bullet -width Ds -compact
394 .It
395 The remote IP is checked against
396 .Ic remote_address .
397 .It
398 ISAKMP exchange type is checked against
399 .Ic exchange_mode .
400 .It
401 ISAKMP SA attributes must match a
402 .Ic proposal
403 block.
404 .It
405 The remote identity is matched against
406 .Ic peers_identifier
407 if
408 .Ic verify_identifier
409 is on.
410 .It
411 If a certificate request was received, it must match the issuer of
412 .Ic "certificate_type x509"
413 certificate.
414 If certificate request without issuer name was sent, the
415 .Ic match_empty_cr
416 parameter specifies whether or not remote block matches.
417 .El
418 .Pp
419 Similarly, NAT-T is enabled if any of the initial remote configuration
420 candidates allow NAT-T.
421 .Pp
422 Sections with
423 .Ic inherit Ar parent
424 statements (where
425 .Ar parent
426 is either
427 .Ar address
428 or a keyword
429 .Ic anonymous )
430 that have all values predefined to those of a given
431 .Ar parent .
432 In these sections it is enough to redefine only the changed parameters.
433 .Pp
434 The following are valid statements.
435 .Pp
436 .Bl -tag -width Ds -compact
437 .\"
438 .It Ic remote_address Ar address ;
439 Defines the IP address of the peer.
440 .\"
441 .It Ic exchange_mode ( main | aggressive | base ) ;
442 Defines the exchange mode for phase 1 when racoon is the initiator.
443 It also means the acceptable exchange mode when racoon is the responder.
444 More than one mode can be specified by separating them with a comma.
445 All of the modes are acceptable.
446 The first exchange mode is what racoon uses when it is the initiator.
447 .\"
448 .It Ic doi Ic ipsec_doi ;
449 Means to use IPsec DOI as specified in RFC 2407.
450 You can omit this statement.
451 .\"
452 .It Ic situation Ic identity_only ;
453 Means to use SIT_IDENTITY_ONLY as specified in RFC 2407.
454 You can omit this statement.
455 .\"
456 .It Ic my_identifier Bo Ar qualifier Bc Ar idtype ... ;
457 Specifies the identifier sent to the remote host
458 and the type to use in the phase 1 negotiation.
459 .Ic address, fqdn , user_fqdn , keyid ,
460 and
461 .Ic asn1dn
462 can be used as an
463 .Ar idtype .
464 The
465 .Ar qualifier
466 is currently only used for
467 .Ic keyid ,
468 and can be either
469 .Ic file
470 or
471 .Ic tag .
472 The possible values are :
473 .Bl -tag -width Ds -compact
474 .It Ic my_identifier Ic address Bq Ar address ;
475 The type is the IP address.
476 This is the default type if you do not specify an identifier to use.
477 .It Ic my_identifier Ic user_fqdn Ar string ;
478 The type is a USER_FQDN (user fully-qualified domain name).
479 .It Ic my_identifier Ic fqdn Ar string ;
480 The type is a FQDN (fully-qualified domain name).
481 .It Ic my_identifier Ic keyid Bo Ic file Bc Ar file ;
482 The type is a KEY_ID, read from the file.
483 .It Ic my_identifier Ic keyid Ic tag Ar string ;
484 The type is a KEY_ID, specified in the quoted string.
485 .It Ic my_identifier Ic asn1dn Bq Ar string ;
486 The type is an ASN.1 distinguished name.
487 If
488 .Ar string
489 is omitted,
490 .Xr racoon 8
491 will get the DN from the Subject field in the certificate.
492 .El
493 .\"
494 .It Ic xauth_login Bq Ar string ;
495 Specifies the login to use in client-side Hybrid authentication.
496 It is available only if
497 .Xr racoon 8
498 has been built with this option.
499 The associated password is looked up in the pre-shared key files,
500 using the login
501 .Ic string
502 as the key id.
503 .\"
504 .It Ic peers_identifier Ar idtype ... ;
505 Specifies the peer's identifier to be received.
506 If it is not defined then
507 .Xr racoon 8
508 will not verify the peer's identifier in ID payload transmitted from the peer.
509 If it is defined, the behavior of the verification depends on the flag of
510 .Ic verify_identifier .
511 The usage of
512 .Ar idtype
513 is the same as
514 .Ic my_identifier
515 except that the individual component values of an
516 .Ic asn1dn
517 identifier may specified as
518 .Ic *
519 to match any value (e.g. "C=XX, O=MyOrg, OU=*, CN=Mine").
520 The format of the
521 specification should correspond to RFC 2253; in particular, commas and certain
522 other characters -
523 .Ic ,=+\*[Lt]\*[Gt]#;
524 - may be included in a name by preceeding them with a backslash "\e", and
525 arbitrary characters may be inserted in a name with the "\enn" escape, where
526 nn is the hex representation of the ascii value of the desired character.
527 Alternative acceptable peer identifiers may be specified by repeating the
528 .Ic peers_identifier
529 statement.
530 .\"
531 .It Ic verify_identifier (on | off) ;
532 If you want to verify the peer's identifier,
533 set this to on.
534 In this case, if the value defined by
535 .Ic peers_identifier
536 is not the same as the peer's identifier in the ID payload,
537 the negotiation will fail.
538 The default is off.
539 .\"
540 .It Ic certificate_type Ar certspec ;
541 Specifies a certificate specification.
542 .Ar certspec
543 is one of followings:
544 .Bl -tag -width Ds -compact
545 .It Ic x509 Ar certfile Ar privkeyfile ;
546 .Ar certfile
547 means a file name of a certificate.
548 .Ar privkeyfile
549 means a file name of a secret key.
550 .El
551 .Bl -tag -width Ds -compact
552 .It Ic plain_rsa Ar privkeyfile ;
553 .Ar privkeyfile
554 means a file name of a private key generated by
555 .Xr plainrsa-gen 8 .
556 Required
557 for RSA authentication.
558 .El
559 .It Ic ca_type Ar cacertspec ;
560 Specifies a root certificate authority specification.
561 .Ar cacertspec
562 is one of followings:
563 .Bl -tag -width Ds -compact
564 .It Ic x509 Ar cacertfile ;
565 .Ar cacertfile
566 means a file name of the root certificate authority.
567 Default is
568 .Pa /etc/openssl/cert.pem
569 .El
570 .\"
571 .It Ic mode_cfg (on | off) ;
572 Gather network information through ISAKMP mode configuration.
573 Default is off.
574 .\"
575 .It Ic weak_phase1_check (on | off) ;
576 Tells racoon to act on unencrypted deletion messages during phase 1.
577 This is a small security risk, so the default is off, meaning that
578 racoon will keep on trying to establish a connection even if the
579 user credentials are wrong, for instance.
580 .\"
581 .It Ic peers_certfile ( dnssec | Ar certfile | Ic plain_rsa Ar pubkeyfile ) ;
582 If
583 .Ic dnssec
584 is defined,
585 .Xr racoon 8
586 will ignore the CERT payload from the peer,
587 and try to get the peer's certificate from DNS instead.
588 If
589 .Ar certfile
590 is defined,
591 .Xr racoon 8
592 will ignore the CERT payload from the peer,
593 and will use this certificate as the peer's certificate.
594 If
595 .Ic plain_rsa
596 is defined,
597 .Xr racoon 8
598 will expect
599 .Ar pubkeyfile
600 to be the peer's public key that was generated by
601 .Xr plainrsa-gen 8 .
602 .\"
603 .It Ic script Ar script Ic phase1_up
604 .It Ic script Ar script Ic phase1_down
605 Shell scripts that get executed when a phase 1 SA goes up or down.
606 Both scripts get either
607 .Ic phase1_up
608 or
609 .Ic phase1_down
610 as first argument, and the following
611 variables are set in their environment:
612 .Bl -tag -width Ds -compact
613 .It Ev LOCAL_ADDR
614 The local address of the phase 1 SA.
615 .It Ev LOCAL_PORT
616 The local port used for IKE for the phase 1 SA.
617 .It Ev REMOTE_ADDR
618 The remote address of the phase 1 SA.
619 .It Ev REMOTE_PORT
620 The remote port used for IKE for the phase 1 SA.
621 .It Ev REMOTE_ID
622 The remote identity received in IKE for the phase 1 SA.
623 .El
624 The following variables are only set if
625 .Ic mode_cfg
626 was enabled:
627 .Bl -tag -width Ds -compact
628 .It INTERNAL_ADDR4
629 An IPv4 internal address obtained by ISAKMP mode config.
630 .It INTERNAL_NETMASK4
631 An IPv4 internal netmask obtained by ISAKMP mode config.
632 .It INTERNAL_CIDR4
633 An IPv4 internal netmask obtained by ISAKMP mode config, in CIDR notation.
634 .It INTERNAL_DNS4
635 The first internal DNS server IPv4 address obtained by ISAKMP mode config.
636 .It INTERNAL_DNS4_LIST
637 A list of internal DNS servers IPv4 address obtained by ISAKMP mode config,
638 separated by spaces.
639 .It INTERNAL_WINS4
640 The first internal WINS server IPv4 address obtained by ISAKMP mode config.
641 .It INTERNAL_WINS4_LIST
642 A list of internal WINS servers IPv4 address obtained by ISAKMP mode config,
643 separated by spaces.
644 .It SPLIT_INCLUDE
645 The space separated list of IPv4 addresses and masks (address slash mask)
646 that define the networks to be encrypted (as opposed to the default where
647 all the traffic should be encrypted) ; obtained by ISAKMP mode config ;
648 SPLIT_INCLUDE and SPLIT_LOCAL are mutually exclusive.
649 .It SPLIT_LOCAL
650 The space separated list of IPv4 addresses and masks (address slash mask)
651 that define the networks to be considered local, and thus excluded from the
652 tunnels ; obtained by ISAKMP mode config.
653 .It SPLIT_INCLUDE_CIDR
654 Same as SPLIT_INCLUDE, with netmasks in CIDR notation.
655 .It SPLIT_LOCAL_CIDR
656 Same as SPLIT_LOCAL, with netmasks in CIDR notation.
657 .It DEFAULT_DOMAIN
658 The DNS default domain name obtained by ISAKMP mode config.
659 .El
660 .\"
661 .\"
662 .It Ic send_cert (on | off) ;
663 If you do not want to send a certificate, set this to off.
664 The default is on.
665 .\"
666 .It Ic send_cr (on | off) ;
667 If you do not want to send a certificate request, set this to off.
668 The default is on.
669 .\"
670 .It Ic match_empty_cr (on | off) ;
671 Specifies whether this remote block is a valid match when a non-specific
672 certificate request is received.
673 The default is on.
674 .\"
675 .It Ic verify_cert (on | off) ;
676 By default, the identifier sent by the remote host (as specified in its
677 .Ic my_identifier
678 statement) is compared with the credentials in the certificate
679 used to authenticate the remote host as follows:
680 .Bl -tag -width Ds -compact
681 .It Type Ic asn1dn :
682 The entire certificate subject name is compared with the identifier,
683 e.g. "C=XX, O=YY, ...".
684 .It Type Ic address, fqdn, or user_fqdn :
685 The certificate's subjectAltName is compared with the identifier.
686 .El
687 If the two do not match the negotiation will fail.
688 If you do not want to verify the identifier using the peer's certificate,
689 set this to off.
690 .\"
691 .It Ic lifetime time Ar number Ar timeunit ;
692 Define a lifetime of a certain time
693 which will be proposed in the phase 1 negotiations.
694 Any proposal will be accepted, and the attribute(s) will not be proposed to
695 the peer if you do not specify it (them).
696 They can be individually specified in each proposal.
697 .\"
698 .It Ic ike_frag (on | off | force) ;
699 Enable receiver-side IKE fragmentation if
700 .Xr racoon 8
701 has been built with this feature.
702 If set to on, racoon will advertise
703 itself as being capable of receiving packets split by IKE fragmentation.
704 This extension is there to work around broken firewalls that do not
705 work with fragmented UDP packets.
706 IKE fragmentation is always enabled on the sender-side, and it is
707 used if the peer advertises itself as IKE fragmentation capable.
708 By selecting force, IKE Fragmentation will
709 be used when racoon is acting as the initiator even before the remote
710 peer has advertised itself as IKE fragmentation capable.
711 .\"
712 .It Ic esp_frag Ar fraglen ;
713 This option is only relevant if you use NAT traversal in tunnel mode.
714 Its purpose is to work around broken DSL routers that reject UDP
715 fragments, by fragmenting the IP packets before ESP encapsulation.
716 The result is ESP over UDP of fragmented packets instead of fragmented
717 ESP over UDP packets (i.e., IP:UDP:ESP:frag(IP) instead of
718 frag(IP:UDP:ESP:IP)).
719 .Ar fraglen
720 is the maximum size of the fragments.
721 552 should work anywhere,
722 but the higher
723 .Ar fraglen
724 is, the better the performance.
725 .Pp
726 Note that because PMTU discovery is broken on many sites, you will
727 have to use MSS clamping if you want TCP to work correctly.
728 .\"
729 .It Ic initial_contact (on | off) ;
730 Enable this to send an INITIAL-CONTACT message.
731 The default value is
732 .Ic on .
733 This message is useful only when the responder implementation chooses an
734 old SA when there are multiple SAs with different established time and the
735 initiator reboots.
736 If racoon did not send the message,
737 the responder would use an old SA even when a new SA was established.
738 For systems that use a KAME derived IPSEC stack, the
739 .Xr sysctl 8
740 variable net.key.preferred_oldsa can be used to control this preference.
741 When the value is zero, the stack always uses a new SA.
742 .\"
743 .It Ic passive (on | off) ;
744 If you do not want to initiate the negotiation, set this to on.
745 The default value is
746 .Ic off .
747 It is useful for a server.
748 .\"
749 .It Ic proposal_check Ar level ;
750 Specifies the action of lifetime length, key length, and PFS of the phase 2
751 selection on the responder side, and the action of lifetime check in
752 phase 1.
753 The default level is
754 .Ic strict .
755 If the
756 .Ar level
757 is:
758 .Bl -tag -width Ds -compact
759 .It Ic obey
760 The responder will obey the initiator anytime.
761 .It Ic strict
762 If the responder's lifetime length is longer than the initiator's or
763 the responder's key length is shorter than the initiator's,
764 the responder will use the initiator's value.
765 Otherwise, the proposal will be rejected.
766 If PFS is not required by the responder, the responder will obey the proposal.
767 If PFS is required by both sides and the responder's group is not equal to
768 the initiator's, then the responder will reject the proposal.
769 .It Ic claim
770 If the responder's lifetime length is longer than the initiator's or
771 the responder's key length is shorter than the initiator's,
772 the responder will use the initiator's value.
773 If the responder's lifetime length is shorter than the initiator's,
774 the responder uses its own length AND sends a RESPONDER-LIFETIME notify
775 message to an initiator in the case of lifetime (phase 2 only).
776 For PFS, this directive behaves the same as
777 .Ic strict .
778 .It Ic exact
779 If the initiator's lifetime or key length is not equal to the responder's,
780 the responder will reject the proposal.
781 If PFS is required by both sides and the responder's group is not equal to
782 the initiator's, then the responder will reject the proposal.
783 .El
784 .\"
785 .It Ic support_proxy (on | off) ;
786 If this value is set to on, then both values of ID payloads in the
787 phase 2 exchange are always used as the addresses of end-point of
788 IPsec-SAs.
789 The default is off.
790 .\"
791 .It Ic generate_policy (on | off | require | unique) ;
792 This directive is for the responder.
793 Therefore you should set
794 .Ic passive
795 to on in order that
796 .Xr racoon 8
797 only becomes a responder.
798 If the responder does not have any policy in SPD during phase 2
799 negotiation, and the directive is set to on, then
800 .Xr racoon 8
801 will choose the first proposal in the
802 SA payload from the initiator, and generate policy entries from the proposal.
803 It is useful to negotiate with clients whose IP address is allocated
804 dynamically.
805 Note that an inappropriate policy might be installed into the responder's SPD
806 by the initiator,
807 so other communications might fail if such policies are installed
808 due to a policy mismatch between the initiator and the responder.
809 .Ic on
810 and
811 .Ic require
812 values mean the same thing (generate a require policy).
813 .Ic unique
814 tells racoon to set up unique policies, with a monotoning increasing
815 reqid number (between 1 and IPSEC_MANUAL_REQID_MAX).
816 This directive is ignored in the initiator case.
817 The default value is
818 .Ic off .
819 .\"
820 .\"
821 .It Ic nat_traversal (on | off | force) ;
822 This directive enables use of the NAT-Traversal IPsec extension
823 (NAT-T).
824 NAT-T allows one or both peers to reside behind a NAT gateway (i.e.,
825 doing address- or port-translation).
826 If a NAT gateway is detected during the phase 1 handshake, racoon will
827 attempt to negotiate the use of NAT-T with the remote peer.
828 If the negotiation succeeds, all ESP and AH packets for the given connection
829 will be encapsulated into UDP datagrams (port 4500, by default).
830 Possible values are:
831 .Bl -tag -width Ds -compact
832 .It Ic on
833 NAT-T is used when a NAT gateway is detected between the peers.
834 .It Ic off
835 NAT-T is not proposed/accepted.
836 This is the default.
837 .It Ic force
838 NAT-T is used regardless of whether a NAT gateway is detected between the
839 peers or not.
840 .El
841 Please note that NAT-T support is a compile-time option.
842 Although it is enabled in the source distribution by default, it
843 may not be available in your particular build.
844 In that case you will get a
845 warning when using any NAT-T related config options.
846 .\"
847 .It Ic dpd_delay Ar delay ;
848 This option activates the DPD and sets the time (in seconds) allowed
849 between 2 proof of liveliness requests.
850 The default value is
851 .Ic 0 ,
852 which disables DPD monitoring, but still negotiates DPD support.
853 .\"
854 .It Ic dpd_retry Ar delay ;
855 If
856 .Ic dpd_delay
857 is set, this sets the delay (in seconds) to wait for a proof of
858 liveliness before considering it as failed and send another request.
859 The default value is
860 .Ic 5 .
861 .\"
862 .It Ic dpd_maxfail Ar number ;
863 If
864 .Ic dpd_delay
865 is set, this sets the maximum number of liveliness proofs to request
866 (without reply) before considering the peer is dead.
867 The default value is
868 .Ic 5 .
869 .\"
870 .It Ic rekey (on | off | force) ;
871 Enable automatic renegotiation of expired phase1 when there are non-dying
872 phase2 SAs.
873 Possible values are:
874 .Bl -tag -width Ds -compact
875 .It Ic force
876 Rekeying is done unconditionally.
877 .It Ic on
878 Rekeying is done only if DPD monitoring is active.
879 This is the default.
880 .It Ic off
881 No automatic rekeying.
882 Do note that turning off automatic rekeying will
883 result in inaccurate DPD monitoring.
884 .El
885 .\"
886 .It Ic nonce_size Ar number ;
887 define the byte size of nonce value.
888 Racoon can send any value although
889 RFC2409 specifies that the value MUST be between 8 and 256 bytes.
890 The default size is 16 bytes.
891 .\"
892 .It Ic ph1id Ar number ;
893 An optional number to identify the remote proposal and to link it
894 only with sainfos who have the same number.
895 Defaults to 0.
896 .\"
897 .It Ic proposal { Ar sub-substatements Ic }
898 .Bl -tag -width Ds -compact
899 .\"
900 .It Ic encryption_algorithm Ar algorithm ;
901 Specifies the encryption algorithm used for the phase 1 negotiation.
902 This directive must be defined.
903 .Ar algorithm
904 is one of following:
905 .Ic des, 3des, blowfish, cast128, aes, camellia
906 .\".Ic rc5 , idea
907 for Oakley.
908 For other transforms, this statement should not be used.
909 .\"
910 .It Ic hash_algorithm Ar algorithm ;
911 Defines the hash algorithm used for the phase 1 negotiation.
912 This directive must be defined.
913 .Ar algorithm
914 is one of following:
915 .Ic md5, sha1, sha256, sha384, sha512
916 for Oakley.
917 .\"
918 .It Ic authentication_method Ar type ;
919 Defines the authentication method used for the phase 1 negotiation.
920 This directive must be defined.
921 .Ar type
922 is one of:
923 .Ic pre_shared_key , rsasig
924 (for plain RSA authentication),
925 .Ic gssapi_krb , hybrid_rsa_server ,
926 .Ic hybrid_rsa_client , xauth_rsa_server , xauth_rsa_client , xauth_psk_server
927 or
928 .Ic xauth_psk_client .
929 .\"
930 .It Ic dh_group Ar group ;
931 Defines the group used for the Diffie-Hellman exponentiations.
932 This directive must be defined.
933 .Ar group
934 is one of following:
935 .Ic modp768 , modp1024 , modp1536 ,
936 .Ic modp2048 , modp3072 , modp4096 ,
937 .Ic modp6144 , modp8192 .
938 Or you can define 1, 2, 5, 14, 15, 16, 17, or 18 as the DH group number.
939 When you want to use aggressive mode,
940 you must define the same DH group in each proposal.
941 .It Ic lifetime time Ar number Ar timeunit ;
942 Defines the lifetime of the phase 1 SA proposal.
943 Refer to the description of the
944 .Ic lifetime
945 directive defined in the
946 .Ic remote
947 directive.
948 .It Ic gss_id Ar string ;
949 Defines the GSS-API endpoint name, to be included as an attribute in the SA,
950 if the
951 .Ic gssapi_krb
952 authentication method is used.
953 If this is not defined, the default value of
954 .Ql host/hostname
955 is used, where hostname is the value returned by the
956 .Xr hostname 1
957 command.
958 .El
959 .El
960 .Pp
961 .It Ic remote Po Ar address | Ic anonymous Pc Bo Bo Ar port Bc Bc \
962 Bo Ic inherit Ar parent Bc Ic { Ar statements Ic }
963 Deprecated format of specifying a remote block.
964 This will be removed in future.
965 It is a remnant from time when remote block was decided
966 solely based on the peers IP address.
967 .Pp
968 This is equivalent to:
969 .Bd -literal -offset
970 remote "address" [inherit "parent-address"] {
971 remote_address address;
972 }
973 .Ed
974 .El
975 .\"
976 .Ss Sainfo Specifications
977 .Bl -tag -width Ds -compact
978 .It Ic sainfo Po Ar local_id | Ic anonymous Pc \
979 Po Ar remote_id | Ic clientaddr | Ic anonymous Pc \
980 Bo Ic from Ar idtype Bo Ar string Bc Bc Bo Ic group Ar string Bc \
981 Ic { Ar statements Ic }
982 Defines the parameters of the IKE phase 2 (IPsec-SA establishment).
983 .Pp
984 The
985 .Ar local_id
986 and
987 .Ar remote_id
988 strings are constructed like:
989 .Pp
990 .Ic address Ar address
991 .Bq Ic / Ar prefix
992 .Bq Ic [ Ar port ]
993 .Ar ul_proto
994 .Pp
995 or
996 .Pp
997 .Ic subnet Ar address
998 .Bq Ic / Ar prefix
999 .Bq Ic [ Ar port ]
1000 .Ar ul_proto
1001 .Pp
1002 An id string should be expressed to match the exact value of an ID payload.
1003 This is not like a filter rule.
1004 For example, if you define 3ffe:501:4819::/48 as
1005 .Ar local_id .
1006 3ffe:501:4819:1000:/64 will not match.
1007 In the case of a longest prefix (selecting a single host),
1008 .Ar address
1009 instructs to send ID type of ADDRESS while
1010 .Ar subnet
1011 instructs to send ID type of SUBNET.
1012 Otherwise, these instructions are identical.
1013 .Pp
1014 The
1015 .Ic anonymous
1016 keyword can be used to match any id.
1017 The
1018 .Ic clientaddr
1019 keyword can be used to match a remote id that is equal to either the peer
1020 ip address or the mode_cfg ip address (if assigned).
1021 This can be useful
1022 to restrict policy generation when racoon is acting as a client gateway
1023 for peers with dynamic ip addresses.
1024 .Pp
1025 The
1026 .Ic from
1027 keyword allows an sainfo to only match for peers that use a specific phase1
1028 id value during authentication.
1029 The
1030 .Ic group
1031 keyword allows an XAuth group membership check to be performed
1032 for this sainfo section.
1033 When the mode_cfg auth source is set to
1034 .Ic system
1035 or
1036 .Ic ldap ,
1037 the XAuth user is verified to be a member of the specified group
1038 before allowing a matching SA to be negotiated.
1039 .Pp
1040 .Bl -tag -width Ds -compact
1041 .\"
1042 .It Ic pfs_group Ar group ;
1043 define the group of Diffie-Hellman exponentiations.
1044 If you do not require PFS then you can omit this directive.
1045 Any proposal will be accepted if you do not specify one.
1046 .Ar group
1047 is one of following:
1048 .Ic modp768 , modp1024 , modp1536 ,
1049 .Ic modp2048 , modp3072 , modp4096 ,
1050 .Ic modp6144 , modp8192 .
1051 Or you can define 1, 2, 5, 14, 15, 16, 17, or 18 as the DH group number.
1052 .\"
1053 .It Ic lifetime time Ar number Ar timeunit ;
1054 define how long an IPsec-SA will be used, in timeunits.
1055 Any proposal will be accepted, and no attribute(s) will be proposed to
1056 the peer if you do not specify it(them).
1057 See the
1058 .Ic proposal_check
1059 directive.
1060 .\"
1061 .It Ic remoteid Ar number ;
1062 Sainfos will only be used if their remoteid matches the ph1id of the
1063 remote section used for phase 1.
1064 Defaults to 0, which is also the default for ph1id.
1065 .El
1066 .\"
1067 .Pp
1068 .Xr racoon 8
1069 does not have a list of security protocols to be negotiated.
1070 The list of security protocols are passed by SPD in the kernel.
1071 Therefore you have to define all of the potential algorithms
1072 in the phase 2 proposals even if there are algorithms which will not be used.
1073 These algorithms are define by using the following three directives,
1074 with a single comma as the separator.
1075 For algorithms that can take variable-length keys, algorithm names
1076 can be followed by a key length, like
1077 .Dq Li blowfish 448 .
1078 .Xr racoon 8
1079 will compute the actual phase 2 proposals by computing
1080 the permutation of the specified algorithms,
1081 and then combining them with the security protocol specified by the SPD.
1082 For example, if
1083 .Ic des , 3des , hmac_md5 ,
1084 and
1085 .Ic hmac_sha1
1086 are specified as algorithms, we have four combinations for use with ESP,
1087 and two for AH.
1088 Then, based on the SPD settings,
1089 .Xr racoon 8
1090 will construct the actual proposals.
1091 If the SPD entry asks for ESP only, there will be 4 proposals.
1092 If it asks for both AH and ESP, there will be 8 proposals.
1093 Note that the kernel may not support the algorithm you have specified.
1094 .\"
1095 .Bl -tag -width Ds -compact
1096 .It Ic encryption_algorithm Ar algorithms ;
1097 .Ic des , 3des , des_iv64 , des_iv32 ,
1098 .Ic rc5 , rc4 , idea , 3idea ,
1099 .Ic cast128 , blowfish , null_enc ,
1100 .Ic twofish , rijndael , aes , camellia
1101 .Pq used with ESP
1102 .\"
1103 .It Ic authentication_algorithm Ar algorithms ;
1104 .Ic des , 3des , des_iv64 , des_iv32 ,
1105 .Ic hmac_md5 , hmac_sha1 , hmac_sha256, hmac_sha384, hmac_sha512, non_auth
1106 .Pq used with ESP authentication and AH
1107 .\"
1108 .It Ic compression_algorithm Ar algorithms ;
1109 .Ic deflate
1110 .Pq used with IPComp
1111 .El
1112 .El
1113 .\"
1114 .Ss Logging level
1115 .Bl -tag -width Ds -compact
1116 .It Ic log Ar level ;
1117 Defines the logging level.
1118 .Ar level
1119 is one of following:
1120 .Ic error , warning , notify , info , debug
1121 or
1122 .Ic debug2 .
1123 The default is
1124 .Ic info .
1125 If you set the logging level too high on slower machines,
1126 IKE negotiation can fail due to timing constraint changes.
1127 .El
1128 .\"
1129 .Ss Specifies the way to pad
1130 .Bl -tag -width Ds -compact
1131 .It Ic padding { Ar statements Ic }
1132 specifies the padding format.
1133 The following are valid statements:
1134 .Bl -tag -width Ds -compact
1135 .It Ic randomize (on | off) ;
1136 Enables the use of a randomized value for padding.
1137 The default is on.
1138 .It Ic randomize_length (on | off) ;
1139 The pad length will be random.
1140 The default is off.
1141 .It Ic maximum_length Ar number ;
1142 Defines a maximum padding length.
1143 If
1144 .Ic randomize_length
1145 is off, this is ignored.
1146 The default is 20 bytes.
1147 .It Ic exclusive_tail (on | off) ;
1148 Means to put the number of pad bytes minus one into the last part
1149 of the padding.
1150 The default is on.
1151 .It Ic strict_check (on | off) ;
1152 Means to constrain the peer to set the number of pad bytes.
1153 The default is off.
1154 .El
1155 .El
1156 .Ss ISAKMP mode configuration settings
1157 .Bl -tag -width Ds -compact
1158 .It Ic mode_cfg { Ar statements Ic }
1159 Defines the information to return for remote hosts' ISAKMP mode config
1160 requests.
1161 Also defines the authentication source for remote peers
1162 authenticating through Xauth.
1163 .Pp
1164 The following are valid statements:
1165 .Bl -tag -width Ds -compact
1166 .It Ic auth_source (system | radius | pam | ldap) ;
1167 Specifies the source for authentication of users through Xauth.
1168 .Ar system
1169 means to use the Unix user database.
1170 This is the default.
1171 .Ar radius
1172 means to use a RADIUS server.
1173 It works only if
1174 .Xr racoon 8
1175 was built with libradius support.
1176 Radius configuration is handled by statements in the
1177 .Ic radiuscfg
1178 section.
1179 .Ar pam
1180 means to use PAM.
1181 It works only if
1182 .Xr racoon 8
1183 was built with libpam support.
1184 .Ar ldap
1185 means to use LDAP.
1186 It works only if
1187 .Xr racoon 8
1188 was built with libldap support.
1189 LDAP configuration is handled by statements in the
1190 .Ic ldapcfg
1191 section.
1192 .It Ic auth_groups Ar "group1", ... ;
1193 Specifies the group memberships for Xauth in quoted group name strings.
1194 When defined, the authenticating user must be a member of at least one
1195 group for Xauth to succeed.
1196 .It Ic group_source (system | ldap) ;
1197 Specifies the source for group validation of users through Xauth.
1198 .Ar system
1199 means to use the Unix user database.
1200 This is the default.
1201 .Ar ldap
1202 means to use LDAP.
1203 It works only if
1204 .Xr racoon 8
1205 was built with libldap support and requires LDAP authentication.
1206 LDAP configuration is handled by statements in the
1207 .Ic ldapcfg
1208 section.
1209 .It Ic conf_source (local | radius | ldap) ;
1210 Specifies the source for IP addresses and netmask allocated through ISAKMP
1211 mode config.
1212 .Ar local
1213 means to use the local IP pool defined by the
1214 .Ic network4
1215 and
1216 .Ic pool_size
1217 statements.
1218 This is the default.
1219 .Ar radius
1220 means to use a RADIUS server.
1221 It works only if
1222 .Xr racoon 8
1223 was built with libradius support and requires RADIUS authentication.
1224 RADIUS configuration is handled by statements in the
1225 .Ic radiuscfg
1226 section.
1227 .Ar ldap
1228 means to use an LDAP server.
1229 It works only if
1230 .Xr racoon 8
1231 was built with libldap support and requires LDAP authentication.
1232 LDAP configuration is handled by
1233 statements in the
1234 .Ic ldapcfg
1235 section.
1236 .It Ic accounting (none | system | radius | pam) ;
1237 Enables or disables accounting for Xauth logins and logouts.
1238 The default is
1239 .Ar none
1240 which disable accounting.
1241 Specifying
1242 .Ar system
1243 enables system accounting through
1244 .Xr utmp 5 .
1245 Specifying
1246 .Ar radius
1247 enables RADIUS accounting.
1248 It works only if
1249 .Xr racoon 8
1250 was built with libradius support and requires RADIUS authentication.
1251 RADIUS configuration is handled by statements in the
1252 .Ic radiuscfg
1253 section.
1254 Specifying
1255 .Ar pam
1256 enables PAM accounting.
1257 It works only if
1258 .Xr racoon 8
1259 was build with libpam support and requires PAM authentication.
1260 .It Ic pool_size Ar size
1261 Specify the size of the IP address pool, either local or allocated
1262 through RADIUS.
1263 .Ic conf_source
1264 selects the local pool or the RADIUS configuration, but in both
1265 configurations, you cannot have more than
1266 .Ar size
1267 users connected at the same time.
1268 The default is 255.
1269 .It Ic network4 Ar address ;
1270 .It Ic netmask4 Ar address ;
1271 The local IP pool base address and network mask from which dynamically
1272 allocated IPv4 addresses should be taken.
1273 This is used if
1274 .Ic conf_source
1275 is set to
1276 .Ar local
1277 or if the RADIUS server returned
1278 .Ar 255.255.255.254 .
1279 Default is
1280 .Ar 0.0.0.0/0.0.0.0 .
1281 .It Ic dns4 Ar addresses ;
1282 A list of IPv4 addresses for DNS servers, separated by commas, or on multiple
1283 .Ic dns4
1284 lines.
1285 .It Ic wins4 Ar addresses ;
1286 A list of IPv4 address for WINS servers.
1287 The keyword
1288 .It nbns4
1289 can also be used as an alias for
1290 .It wins4 .
1291 .It Ic split_network (include | local_lan) Ar network/mask, ...
1292 The network configuration to send, in CIDR notation (e.g. 192.168.1.0/24).
1293 If
1294 .Ic include
1295 is specified, the tunnel should be only used to encrypt the indicated
1296 destinations ; otherwise, if
1297 .Ic local_lan
1298 is used, everything will pass through the tunnel but those destinations.
1299 .It Ic default_domain Ar domain ;
1300 The default DNS domain to send.
1301 .It Ic split_dns Ar "domain", ...
1302 The split dns configuration to send, in quoted domain name strings.
1303 This list can be used to describe a list of domain names for which
1304 a peer should query a modecfg assigned dns server.
1305 DNS queries for all other domains would be handled locally.
1306 (Cisco VPN client only).
1307 .It Ic banner Ar path ;
1308 The path of a file displayed on the client at connection time.
1309 Default is
1310 .Ar /etc/motd .
1311 .It Ic auth_throttle Ar delay ;
1312 On each failed Xauth authentication attempt, refuse new attempts for a set
1313 .Ar delay
1314 of seconds.
1315 This is to avoid dictionary attacks on Xauth passwords.
1316 Default is one second.
1317 Set to zero to disable authentication delay.
1318 .It Ic pfs_group Ar group ;
1319 Sets the PFS group used in the client proposal (Cisco VPN client only).
1320 Default is 0.
1321 .It Ic save_passwd (on | off) ;
1322 Allow the client to save the Xauth password (Cisco VPN client only).
1323 Default is off.
1324 .El
1325 .El
1326 .Ss Ldap configuration settings
1327 .Bl -tag -width Ds -compact
1328 .It Ic ldapcfg { Ar statements Ic }
1329 Defines the parameters that will be used to communicate with an ldap
1330 server for
1331 .Ic xauth
1332 authentication.
1333 .Pp
1334 The following are valid statements:
1335 .Bl -tag -width Ds -compact
1336 .It Ic version (2 | 3) ;
1337 The ldap protocol version used to communicate with the server.
1338 The default is
1339 .Ic 3 .
1340 .It Ic host Ar (hostname | address) ;
1341 The host name or ip address of the ldap server.
1342 The default is
1343 .Ic localhost .
1344 .It Ic port Ar number ;
1345 The port that the ldap server is configured to listen on.
1346 The default is
1347 .Ic 389 .
1348 .It Ic base Ar distinguished name ;
1349 The ldap search base.
1350 This option has no default value.
1351 .It Ic subtree (on | off) ;
1352 Use the subtree ldap search scope.
1353 Otherwise, use the one level search scope.
1354 The default is
1355 .Ic off .
1356 .It Ic bind_dn Ar distinguished name ;
1357 The user dn used to optionally bind as before performing ldap search operations.
1358 If this option is not specified, anonymous binds are used.
1359 .It Ic bind_pw Ar string ;
1360 The password used when binding as
1361 .Ic bind_dn .
1362 .It Ic attr_user Ar attribute name ;
1363 The attribute used to specify a users name in an ldap directory.
1364 For example,
1365 if a user dn is "cn=jdoe,dc=my,dc=net" then the attribute would be "cn".
1366 The default value is
1367 .Ic cn .
1368 .It Ic attr_addr Ar attribute name ;
1369 .It Ic attr_mask Ar attribute name ;
1370 The attributes used to specify a users network address and subnet mask in an
1371 ldap directory.
1372 These values are forwarded during mode_cfg negotiation when
1373 the conf_source is set to ldap.
1374 The default values are
1375 .Ic racoon-address
1376 and
1377 .Ic racoon-netmask .
1378 .It Ic attr_group Ar attribute name ;
1379 The attribute used to specify a group name in an ldap directory.
1380 For example,
1381 if a group dn is "cn=users,dc=my,dc=net" then the attribute would be "cn".
1382 The default value is
1383 .Ic cn .
1384 .It Ic attr_member Ar attribute name ;
1385 The attribute used to specify group membership in an ldap directory.
1386 The default value is
1387 .Ic member .
1388 .El
1389 .El
1390 .Ss Radius configuration settings
1391 .Bl -tag -width Ds -compact
1392 .It Ic radiuscfg { Ar statements Ic }
1393 Defines the parameters that will be used to communicate with radius
1394 servers for
1395 .Ic xauth
1396 authentication.
1397 If radius is selected as the xauth authentication or accounting
1398 source and no servers are defined in this section, settings from
1399 the system
1400 .Xr radius.conf 5
1401 configuration file will be used instead.
1402 .Pp
1403 The following are valid statements:
1404 .Bl -tag -width Ds -compact
1405 .It Ic auth Ar (hostname | address) [port] sharedsecret ;
1406 The host name or ip address, optional port value and shared secret value
1407 of a radius authentication server.
1408 Up to 5 radius authentication servers
1409 may be specified using multiple lines.
1410 .It Ic acct Ar (hostname | address) [port] sharedsecret ;
1411 The host name or ip address, optional port value and shared secret value
1412 of a radius accounting server.
1413 Up to 5 radius accounting servers may be
1414 specified using multiple lines.
1415 .It Ic timeout Ar seconds ;
1416 The timeout for receiving replies from radius servers.
1417 The default is
1418 .Ic 3 .
1419 .It Ic retries Ar count ;
1420 The maximum number of repeated requests to make before giving up
1421 on a radius server.
1422 The default is
1423 .Ic 3 .
1424 .El
1425 .El
1426 .Ss Special directives
1427 .Bl -tag -width Ds -compact
1428 .It Ic complex_bundle (on | off) ;
1429 defines the interpretation of proposal in the case of SA bundle.
1430 Normally
1431 .Dq IP AH ESP IP payload
1432 is proposed as
1433 .Dq AH tunnel and ESP tunnel .
1434 The interpretation is more common to other IKE implementations, however,
1435 it allows very limited set of combinations for proposals.
1436 With the option enabled, it will be proposed as
1437 .Dq AH transport and ESP tunnel .
1438 The default value is
1439 .Ic off .
1440 .El
1441 .\"
1442 .Ss Pre-shared key File
1443 The pre-shared key file defines pairs of identifiers and corresponding
1444 shared secret keys which are used in the pre-shared key authentication
1445 method in phase 1.
1446 The pair in each line is separated by some number of blanks and/or tab
1447 characters like in the
1448 .Xr hosts 5
1449 file.
1450 Key can include blanks because everything after the first blanks
1451 is interpreted as the secret key.
1452 Lines starting with
1453 .Ql #
1454 are ignored.
1455 Keys which start with
1456 .Ql 0x
1457 are interpreted as hexadecimal strings.
1458 Note that the file must be owned by the user ID running
1459 .Xr racoon 8
1460 .Pq usually the privileged user ,
1461 and must not be accessible by others.
1462 .\"
1463 .Sh EXAMPLES
1464 The following shows how the remote directive should be configured.
1465 .Bd -literal -offset
1466 path pre_shared_key "/usr/local/v6/etc/psk.txt" ;
1467 remote anonymous
1468 {
1469 exchange_mode aggressive,main,base;
1470 lifetime time 24 hour;
1471 proposal {
1472 encryption_algorithm 3des;
1473 hash_algorithm sha1;
1474 authentication_method pre_shared_key;
1475 dh_group 2;
1476 }
1477 }
1479 sainfo anonymous
1480 {
1481 pfs_group 2;
1482 lifetime time 12 hour ;
1483 encryption_algorithm 3des, blowfish 448, twofish, rijndael ;
1484 authentication_algorithm hmac_sha1, hmac_md5 ;
1485 compression_algorithm deflate ;
1486 }
1487 .Ed
1488 .Pp
1489 If you are configuring plain RSA authentication, the remote directive
1490 should look like the following:
1491 .Bd -literal -offset
1492 path certificate "/usr/local/v6/etc" ;
1493 remote anonymous
1494 {
1495 exchange_mode main,base ;
1496 lifetime time 12 hour ;
1497 certificate_type plain_rsa "/usr/local/v6/etc/myrsakey.priv";
1498 peers_certfile plain_rsa "/usr/local/v6/etc/yourrsakey.pub";
1499 proposal {
1500 encryption_algorithm aes ;
1501 hash_algorithm sha1 ;
1502 authentication_method rsasig ;
1503 dh_group 2 ;
1504 }
1505 }
1506 .Ed
1507 .Pp
1508 The following is a sample for the pre-shared key file.
1509 .Bd -literal -offset
1510 10.160.94.3 mekmitasdigoat
1511 172.16.1.133 0x12345678
1512 194.100.55.1 whatcertificatereally
1513 3ffe:501:410:ffff:200:86ff:fe05:80fa mekmitasdigoat
1514 3ffe:501:410:ffff:210:4bff:fea2:8baa mekmitasdigoat
1515 foo@kame.net mekmitasdigoat
1516 foo.kame.net hoge
1517 .Ed
1518 .\"
1519 .Sh SEE ALSO
1520 .Xr racoon 8 ,
1521 .Xr racoonctl 8 ,
1522 .Xr setkey 8
1523 .\"
1524 .Sh HISTORY
1525 The
1526 .Nm
1527 configuration file first appeared in the
1528 .Dq YIPS
1529 Yokogawa IPsec implementation.
1530 .\"
1531 .Sh BUGS
1532 Some statements may not be handled by
1533 .Xr racoon 8
1534 yet.
1535 .Pp
1536 Diffie-Hellman computation can take a very long time, and may cause
1537 unwanted timeouts, specifically when a large D-H group is used.
1538 .\"
1539 .Sh SECURITY CONSIDERATIONS
1540 The use of IKE phase 1 aggressive mode is not recommended,
1541 as described in
1542 .Li http://www.kb.cert.org/vuls/id/886601 .