Cameron Katri's Manual Page Server

Configuration syntax

With -c or -f on the command line, setkey accepts the following configuration syntax. Lines starting with hash signs (‘#’) are treated as comment lines.

add [-46n] src dst protocol spi [extensions] algorithm ... ;

Add an SAD entry. add can fail for multiple reasons, including when the key length does not match the specified algorithm.

get [-46n] src dst protocol spi ;

Show an SAD entry.

delete [-46n] src dst protocol spi ;

Remove an SAD entry.

deleteall [-46n] src dst protocol ;

Remove all SAD entries that match the specification.

flush [protocol] ;

Clear all SAD entries matched by the options. -F on the command line achieves the same functionality.

dump [protocol] ;

Dumps all SAD entries matched by the options. -D on the command line achieves the same functionality.

spdadd [-46n] src_range dst_range upperspec policy ;

Add an SPD entry.

spdadd tagged tag policy ;

Add an SPD entry based on a PF tag. tag must be a string surrounded by double quotes.

spddelete [-46n] src_range dst_range upperspec -P direction ;

Delete an SPD entry.

spdflush ;

Clear all SPD entries. -FP on the command line achieves the same functionality.

spddump ;

Dumps all SPD entries. -DP on the command line achieves the same functionality.

Meta-arguments are as follows:

src

 

dst

Source/destination of the secure communication is specified as an IPv4/v6 address, and an optional port number between square brackets. setkey can resolve a FQDN into numeric addresses. If the FQDN resolves into multiple addresses, setkey will install multiple SAD/SPD entries into the kernel by trying all possible combinations. -4, -6, and -n restrict the address resolution of FQDN in certain ways. -4 and -6 restrict results into IPv4/v6 addresses only, respectively. -n avoids FQDN resolution and requires addresses to be numeric addresses.

protocol

protocol is one of following:

esp

ESP based on rfc2406

esp-old

ESP based on rfc1827

ah

AH based on rfc2402

ah-old

AH based on rfc1826

ipcomp

IPComp

tcp

TCP-MD5 based on rfc2385

spi

Security Parameter Index (SPI) for the SAD and the SPD. spi must be a decimal number, or a hexadecimal number with a “0x” prefix. SPI values between 0 and 255 are reserved for future use by IANA and cannot be used. TCP-MD5 associations must use 0x1000 and therefore only have per-host granularity at this time.

extensions

take some of the following:

-m mode

Specify a security protocol mode for use. mode is one of following: transport, tunnel, or any. The default value is any.

-r size

Specify window size of bytes for replay prevention. size must be decimal number in 32-bit word. If size is zero or not specified, replay checks don't take place.

-u id

Specify the identifier of the policy entry in the SPD. See policy.

-f pad_option

defines the content of the ESP padding. pad_option is one of following:

zero-pad

All the paddings are zero.

random-pad

A series of randomized values are used.

seq-pad

A series of sequential increasing numbers started from 1 are used.

-f nocyclic-seq

Don't allow cyclic sequence numbers.

-lh time

 

-ls time

Specify hard/soft life time duration of the SA measured in seconds.

-bh bytes

 

-bs bytes

Specify hard/soft life time duration of the SA measured in bytes transported.

algorithm

-E ealgo key

Specify an encryption algorithm ealgo for ESP.

-E ealgo key -A aalgo key

Specify an encryption algorithm ealgo, as well as a payload authentication algorithm aalgo, for ESP.

-A aalgo key

Specify an authentication algorithm for AH.

-C calgo [-R]

Specify a compression algorithm for IPComp. If -R is specified, the spi field value will be used as the IPComp CPI (compression parameter index) on wire as-is. If -R is not specified, the kernel will use well-known CPI on wire, and spi field will be used only as an index for kernel internal usage.

key must be a double-quoted character string, or a series of hexadecimal digits preceded by “0x”.

Possible values for ealgo, aalgo, and calgo are specified in the Algorithms sections.

src_range

 

dst_range

These select the communications that should be secured by IPsec. They can be an IPv4/v6 address or an IPv4/v6 address range, and may be accompanied by a TCP/UDP port specification. This takes the following form:

address
address/prefixlen
address[port]
address/prefixlen[port]

prefixlen and port must be decimal numbers. The square brackets around port are really necessary, they are not man page meta-characters. For FQDN resolution, the rules applicable to src and dst apply here as well.

upperspec

Upper-layer protocol to be used. You can use one of the words in /etc/protocols as upperspec, or icmp6, ip4, or any. any stands for “any protocol”. You can also use the protocol number. You can specify a type and/or a code of ICMPv6 when the upper-layer protocol is ICMPv6. The specification can be placed after icmp6. A type is separated from a code by single comma. A code must always be specified. When a zero is specified, the kernel deals with it as a wildcard. Note that the kernel can not distinguish a wildcard from an ICPMv6 type of zero. For example, the following means that the policy doesn't require IPsec for any inbound Neighbor Solicitation.

spdadd ::/0 ::/0 icmp6 135,0 -P in none

;

Note: upperspec does not work against forwarding case at this moment, as it requires extra reassembly at the forwarding node (not implemented at this moment). There are many protocols in /etc/protocols, but all protocols except of TCP, UDP, and ICMP may not be suitable to use with IPsec. You have to consider carefully what to use.

policy

policy is in one of the following three formats: