1 .\" $KAME: setkey.8,v 1.89 2003/09/07 22:17:41 itojun Exp $
3 .\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
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
38 .Nd "manually manipulate the IPsec SA/SP database"
60 utility adds, updates, dumps, or flushes
61 Security Association Database (SAD) entries
62 as well as Security Policy Database (SPD) entries in the kernel.
66 utility takes a series of operations from the standard input
73 .Bl -tag -width indent
78 the SPD entries are dumped.
80 Flush the SAD entries.
83 the SPD entries are flushed.
88 usually does not display dead SAD entries with
92 the dead SAD entries will be displayed as well.
93 A dead SAD entry means that
94 it has been expired but remains in the system
95 because it is referenced by some SPD entries.
97 Add hexadecimal dump on
101 Loop forever with short output on
105 The program will dump messages exchanged on
107 socket, including messages sent from other processes to the kernel.
109 Loop forever and dump all the messages transmitted to
113 makes each timestamps unformatted.
115 .Ss Configuration syntax
122 accepts the following configuration syntax.
123 Lines starting with hash signs
125 are treated as comment lines.
126 .Bl -tag -width indent
130 .Ar src Ar dst Ar protocol Ar spi
137 can fail with multiple reasons,
138 including when the key length does not match the specified algorithm.
143 .Ar src Ar dst Ar protocol Ar spi
151 .Ar src Ar dst Ar protocol Ar spi
159 .Ar src Ar dst Ar protocol
162 Remove all SAD entries that match the specification.
169 Clear all SAD entries matched by the options.
171 on the command line achieves the same functionality.
178 Dumps all SAD entries matched by the options.
180 on the command line achieves the same functionality.
185 .Ar src_range Ar dst_range Ar upperspec Ar policy
193 .Ar src_range Ar dst_range Ar upperspec Fl P Ar direction
202 Clear all SPD entries.
204 on the command line achieves the same functionality.
210 Dumps all SPD entries.
212 on the command line achieves the same functionality.
216 Meta-arguments are as follows:
218 .Bl -tag -compact -width indent
221 Source/destination of the secure communication is specified as
226 can resolve a FQDN into numeric addresses.
227 If the FQDN resolves into multiple addresses,
229 will install multiple SAD/SPD entries into the kernel
230 by trying all possible combinations.
235 restricts the address resolution of FQDN in certain ways.
239 restrict results into IPv4/v6 addresses only, respectively.
241 avoids FQDN resolution and requires addresses to be numeric addresses.
247 .Bl -tag -width Fl -compact
259 TCP-MD5 based on rfc2385
264 Security Parameter Index
266 for the SAD and the SPD.
268 must be a decimal number, or a hexadecimal number with
271 SPI values between 0 and 255 are reserved for future use by IANA
272 and they cannot be used.
273 TCP-MD5 associations must use 0x1000 and therefore only have per-host
274 granularity at this time.
278 take some of the following:
279 .Bl -tag -width Fl -compact
282 Specify a security protocol mode for use.
285 .Li transport , tunnel
292 Specify window size of bytes for replay prevention.
294 must be decimal number in 32-bit word.
297 is zero or not specified, replay check does not take place.
300 Specify the identifier of the policy entry in SPD.
304 .It Fl f Ar pad_option
305 defines the content of the ESP padding.
308 .Bl -tag -width random-pad -compact
310 All of the padding are zero.
312 A series of randomized values are set.
314 A series of sequential increasing numbers started from 1 are set.
317 .It Fl f Li nocyclic-seq
318 Do not allow cyclic sequence number.
322 Specify hard/soft life time duration of the SA.
327 .Bl -tag -width Fl -compact
328 .It Fl E Ar ealgo Ar key
329 Specify an encryption algorithm
333 .Fl E Ar ealgo Ar key
334 .Fl A Ar aalgo Ar key
336 Specify a encryption algorithm
338 as well as a payload authentication algorithm
341 .It Fl A Ar aalgo Ar key
342 Specify an authentication algorithm for AH.
343 .It Fl C Ar calgo Op Fl R
344 Specify a compression algorithm for IPComp.
349 field value will be used as the IPComp CPI
350 (compression parameter index)
355 the kernel will use well-known CPI on wire, and
357 field will be used only as an index for kernel internal usage.
361 must be double-quoted character string, or a series of hexadecimal digits
370 are specified in separate section.
375 These are selections of the secure communication specified as
376 IPv4/v6 address or IPv4/v6 address range, and it may accompany
377 TCP/UDP port specification.
378 This takes the following form:
381 .Ar address/prefixlen
383 .Ar address/prefixlen[port]
389 must be a decimal number.
390 The square brackets around
392 are necessary and are not manpage metacharacters.
393 For FQDN resolution, the rules applicable to
401 The upper layer protocol to be used.
402 You can use one of the words in
415 The protocol number may also be used to specify the
417 A type and code related to ICMPv6 may also be specified as an
419 The type is specified first, followed by a comma and then the relevant
421 The specification must be placed after
423 The kernel considers a zero to be a wildcard but
424 cannot distinguish between a wildcard and an ICMPv6
426 The following example shows a policy where IPSec is not required for
427 inbound Neighbor Solicitations:
429 .Dl "spdadd ::/0 ::/0 icmp6 135,0 -P in none;"
433 does not work in the forwarding case at this moment,
434 as it requires extra reassembly at forwarding node,
435 which is not implemented at this moment.
436 Although there are many protocols in
438 protocols other than TCP, UDP and ICMP may not be suitable to use with IPsec.
443 is expressed in one of the following three formats:
446 .It Fl P Ar direction Li discard
447 .It Fl P Ar direction Li none
448 .It Xo Fl P Ar direction Li ipsec
449 .Ar protocol/mode/src-dst/level Op ...
453 The direction of a policy must be specified as
464 means that packets matching the supplied indices will be discarded
467 means that IPsec operations will not take place on the packet and
469 means that IPsec operation will take place onto the packet.
471 .Ar protocol/mode/src-dst/level
472 statement gives the rule for how to process the packet.
490 you must specify the end-point addresses of the SA as
496 between the addresses.
508 is one of the following:
509 .Li default , use , require
512 If the SA is not available in every level, the kernel will request
513 the SA from the key exchange daemon.
516 tells the kernel to use the system wide default protocol
517 e.g.\& the one from the
519 sysctl variable, when the kernel processes the packet.
522 means that the kernel will use an SA if it is available,
523 otherwise the kernel will pass the packet as it would normally.
526 means that an SA is required whenever the kernel sends a packet matched
527 that matches the policy.
532 but, in addition, it allows the policy to bind with the unique out-bound SA.
533 For example, if you specify the policy level
536 will configure the SA for the policy.
537 If you configure the SA by manual keying for that policy,
538 you can put the decimal number as the policy identifier after
542 as in the following example:
544 In order to bind this policy to the SA,
546 must be between 1 and 32767,
549 of manual SA configuration.
551 When you want to use an SA bundle, you can define multiple rules.
553 example, if an IP header was followed by an AH header followed by an
554 ESP header followed by an upper layer protocol header, the rule would
556 .Dl esp/transport//require ah/transport//require ;
557 The rule order is very important.
563 are not in the syntax described in
564 .Xr ipsec_set_policy 3 .
565 There are small, but important, differences in the syntax.
567 .Xr ipsec_set_policy 3
573 The following list shows the supported algorithms.
578 are almost completely orthogonal.
579 The following list of authentication algorithms can be used as
586 .Bd -literal -offset indent
587 algorithm keylen (bits) comment
588 hmac-md5 128 ah: rfc2403
590 hmac-sha1 160 ah: rfc2404
591 160 ah-old: 128bit ICV (no document)
592 keyed-md5 128 ah: 96bit ICV (no document)
594 keyed-sha1 160 ah: 96bit ICV (no document)
595 160 ah-old: 128bit ICV (no document)
596 null 0 to 2048 for debugging
597 hmac-sha2-256 256 ah: 96bit ICV
598 (draft-ietf-ipsec-ciph-sha-256-00)
599 256 ah-old: 128bit ICV (no document)
600 hmac-sha2-384 384 ah: 96bit ICV (no document)
601 384 ah-old: 128bit ICV (no document)
602 hmac-sha2-512 512 ah: 96bit ICV (no document)
603 512 ah-old: 128bit ICV (no document)
604 hmac-ripemd160 160 ah: 96bit ICV (RFC2857)
605 ah-old: 128bit ICV (no document)
606 aes-xcbc-mac 128 ah: 96bit ICV (RFC3566)
607 128 ah-old: 128bit ICV (no document)
608 tcp-md5 8 to 640 tcp: rfc2385
611 The following is the list of encryption algorithms that can be used as the
618 .Bd -literal -offset indent
619 algorithm keylen (bits) comment
620 des-cbc 64 esp-old: rfc1829, esp: rfc2405
622 null 0 to 2048 rfc2410
623 blowfish-cbc 40 to 448 rfc2451
624 cast128-cbc 40 to 128 rfc2451
625 des-deriv 64 ipsec-ciph-des-derived-01
626 3des-deriv 192 no document
627 rijndael-cbc 128/192/256 rfc3602
628 aes-ctr 160/224/288 draft-ietf-ipsec-ciph-aes-ctr-03
629 camllia-cbc 128/192/256 rfc4312
632 Note that the first 128/192/256 bits of a key for
634 will be used as AES key, and remaining 32 bits will be used as nonce.
636 The following are the list of compression algorithms that can be used
644 .Bd -literal -offset indent
653 Add an ESP SA between two IPv6 addresses using the
654 des-cbc encryption algorithm.
656 add 3ffe:501:4819::1 3ffe:501:481d::1 esp 123457
657 -E des-cbc 0x3ffe05014819ffff ;
661 Add an authentication SA between two FQDN specified hosts:
663 add -6 myhost.example.com yourhost.example.com ah 123456
664 -A hmac-sha1 "AH SA configuration!" ;
667 Use both ESP and AH between two numerically specified hosts:
669 add 10.0.11.41 10.0.11.33 esp 0x10001
670 -E des-cbc 0x3ffe05014819ffff
671 -A hmac-md5 "authentication!!" ;
674 Get the SA information associated with first example above:
676 get 3ffe:501:4819::1 3ffe:501:481d::1 ah 123456 ;
679 Flush all entries from the database:
684 Dump the ESP entries from the database:
689 Add a security policy between two networks that uses ESP in tunnel mode:
691 spdadd 10.0.11.41/32[21] 10.0.11.33/32[any] any
692 -P out ipsec esp/tunnel/192.168.0.1-192.168.1.2/require ;
695 Use TCP MD5 between two numerically specified hosts:
697 add 10.1.10.34 10.1.10.36 tcp 0x1000 -A tcp-md5 "TCP-MD5 BGP secret" ;
702 .Xr ipsec_set_policy 3 ,
706 .%T "Changed manual key configuration for IPsec"
707 .%U http://www.kame.net/newsletter/19991007/
714 utility first appeared in WIDE Hydrangea IPv6 protocol stack kit.
715 The utility was completely re-designed in June 1998.
721 should report and handle syntax errors better.
723 For IPsec gateway configuration,
727 with TCP/UDP port number do not work, as the gateway does not reassemble
729 (cannot inspect upper-layer headers).