protocol
is one of following:
- esp
-
ESP based on rfc2405
- esp-old
-
ESP based on rfc1827
- ah
-
AH based on rfc2402
- ah-old
-
AH based on rfc1826
- spi
-
Security Parameter Index
(SPI)
for the SAD and the SPD.
spi
must be a decimal number, or a hexadecimal number with
``0x
''
prefix.
SPI values between 0 and 255 are reserved for future use by IANA
and they cannot be used.
- 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 check don't take place.
- -u id
-
Specify the identifier of the policy entry in SPD.
See
policy
- -f pad_option
-
defines the content of the ESP padding.
pad_option
is one of following:
- zero-pad
-
All of the padding are zero.
- random-pad
-
A series of randomized values are set.
- seq-pad
-
A series of sequential increasing numbers started from 1 are set.
- -f nocyclic-seq
-
Don't allow cyclic sequence number.
- -lh time
-
- -ls time
-
Specify hard/soft life time duration of the SA.
- algorithm
-
- -E ealgo key
-
Specify a encryption algorithm
ealgo
for ESP.
-
-E ealgo key
-A aalgo key
-
- Specify a encryption algorithm
ealgo
as well as a payload authentication algorith
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,
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 double-quoted character string, or a series of hexadecimal digits
preceded by
``0x
''
Possible values for
ealgo
aalgo
and
calgo
are specified in separate section.
- src_range
-
- dst_range
-
These are selections of the secure communication specified as
IPv4/v6 address or IPv4/v6 address range, and it may accompany
TCP/UDP port specification.
This takes the following form:
address
address/prefixlen
address[port]
address/prefixlen[port]
prefixlen
and
port
must be decimal number.
The square bracket around
port
is really necessary.
They are not manpage metacharacters.
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 words in
/etc/protocols
as
upperspec
Or
icmp6
ip4
and
any
can be specified.
any
stands for
``any protocol''
Also you can use the protocol number.
You can specify a type and/or a code of ICMPv6 when
Upper-layer protocol is ICMPv6.
the specification can be placed after
icmp6
A type is separated with a code by single comma.
A code must be specified anytime.
When a zero is specified, the kernel deals with it as a wildcard.
Note that the kernel can not distinguish a wildcard from that a type
of ICMPv6 is zero.
For example, the following means 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 forwarding node
(not implemented at this moment)
We have many protocols in
/etc/protocols
but protocols except of TCP, UDP and ICMP may not be suitable to use with IPSec.
You have to consider and be careful to use them.
- policy
-
policy
is the one of the following three formats:
- -P direction discard
- -P direction none
- -P direction ipsec
protocol/mode/src-dst/level [...]
-
- You must specify the direction of its policy as
direction
Either
out
or
in
are used.
discard
means the packet matching indexes will be discarded.
none
means that IPsec operation will not take place onto the packet.
ipsec
means that IPsec operation will take place onto the packet.
The part of
protocol/mode/src-dst/level
specifies the rule how to process the packet .
Either
ah
esp
or
ipcomp
is to be set as
protocol
mode
is either
transport
or
tunnel
If
mode
is
tunnel
you must specify the end-points addresses of the SA as
src
and
dst
with
`-'
between these addresses which is used to specify the SA to use.
If
mode
is
transport
both
src
and
dst
can be omitted.
level
is to be one of the following:
default , use , require
or
unique
If the SA is not available in every level, the kernel will request
getting SA to the key exchange daemon.
default
means the kernel consults to the system wide default against protocol you
specified, e.g.
esp_trans_deflev
sysctl variable, when the kernel processes the packet.
use
means that the kernel use a SA if it's available,
otherwise the kernel keeps normal operation.
require
means SA is required whenever the kernel sends a packet matched
with the policy.
unique
is the same to require,
in addition, it allows the policy to bind with the unique out-bound SA.
You just specify the policy level
unique
racoon(8)
will configure the SA for the policy.
If you configure the SA by manual keying for that policy,
you can put the decimal number as the policy identifier after
unique
separated by colon
`:'
like the following;
unique:number
in order to bind this policy to the SA .
number
must be between 1 and 32767.
It corresponds to
extensions -u
of the manual SA configuration.
When you want to use SA bundle, you can define multiple rules.
For example, if an IP header was followed by AH header followed by ESP header
followed by an upper layer protocol header, the rule
would be:
esp/transport//require ah/transport//require
The rule order is very important.
Note that
``discard''
and ``none''
are not in the syntax described in ipsec_set_policy(3).
There are little differences in the syntax.
See
ipsec_set_policy(3) for detail.
Algorithms
The following list shows the supported algorithms.
protocol
and
algorithm
are almost orthogonal.
Followings are the list of authentication algorithms that can be used as
aalgo
in
-A aalgo
of
protocol
parameter:
algorithm keylen (bits)
hmac-md5 128 ah: rfc2403
128 ah-old: rfc2085
hmac-sha1 160 ah: rfc2404
160 ah-old: 128bit ICV (no document)
keyed-md5 128 ah: 96bit ICV (no document)
128 ah-old: rfc1828
keyed-sha1 160 ah: 96bit ICV (no document)
160 ah-old: 128bit ICV (no document)
null 0 to 2048 for debugging
hmac-sha2-256 256 ah: 96bit ICV (draft-ietf-ipsec-ciph-sha-256-00)
256 ah-old: 128bit ICV (no document)
hmac-sha2-384 384 ah: 96bit ICV (no document)
384 ah-old: 128bit ICV (no document)
hmac-sha2-512 512 ah: 96bit ICV (no document)
512 ah-old: 128bit ICV (no document)
Followings are the list of encryption algorithms that can be used as
ealgo
in
-E ealgo
of
protocol
parameter:
algorithm keylen (bits)
des-cbc 64 esp-old: rfc1829, esp: rfc2405
3des-cbc 192 rfc2451
simple 0 to 2048 rfc2410
blowfish-cbc 40 to 448 rfc2451
cast128-cbc 40 to 128 rfc2451
des-deriv 64 ipsec-ciph-des-derived-01 (expired)
3des-deriv 192 no document
rijndael-cbc 128/192/256 draft-ietf-ipsec-ciph-aes-cbc-01
rc4
Followings are the list of compression algorithms that can be used as
calgo
in
-C calgo
of
protocol
parameter:
algorithm
deflate rfc2394
RETURN VALUES
The command exits with 0 on success, and non-zero on errors.
EXAMPLES
add 3ffe:501:4819::1 3ffe:501:481d::1 esp 123457
-E des-cbc 0x3ffe05014819ffff ;
add -6 myhost.example.com yourhost.example.com ah 123456
-A hmac-sha1 "AH SA configuration!" ;
add 10.0.11.41 10.0.11.33 esp 0x10001
-E des-cbc 0x3ffe05014819ffff
-A hmac-md5 "authentication!!" ;
get 3ffe:501:4819::1 3ffe:501:481d::1 ah 123456 ;
flush ;
dump esp ;
spdadd 10.0.11.41/32[21] 10.0.11.33/32[any] any
-P out ipsec esp/tunnel/192.168.0.1-192.168.1.2/require ;
SEE ALSO
racoon(8)
HISTORY
The
setkey
command first appeared in WIDE Hydrangea IPv6 protocol stack kit.
The command was completely re-designed in June 1998.
BUGS
setkey
should report and handle syntax errors better.
This document was created by
man2html.