aboutsummaryrefslogtreecommitdiff
path: root/sbin/setkey/setkey.8
diff options
context:
space:
mode:
Diffstat (limited to 'sbin/setkey/setkey.8')
-rw-r--r--sbin/setkey/setkey.853
1 files changed, 45 insertions, 8 deletions
diff --git a/sbin/setkey/setkey.8 b/sbin/setkey/setkey.8
index 7dab0f622efd..e3bcf10b9a9a 100644
--- a/sbin/setkey/setkey.8
+++ b/sbin/setkey/setkey.8
@@ -27,7 +27,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd May 27, 2023
+.Dd August 25, 2024
.Dt SETKEY 8
.Os
.\"
@@ -230,7 +230,7 @@ IPv4/v6 address.
The
.Nm
utility
-can resolve a FQDN into numeric addresses.
+can resolve an FQDN into numeric addresses.
If the FQDN resolves into multiple addresses,
.Nm
will install multiple SAD/SPD entries into the kernel
@@ -341,6 +341,13 @@ symbols are part of the syntax for the ports specification,
not indication of the optional components.
.It Fl natt_mtu Ar fragsize
Configure NAT-T fragment size.
+.It Fl esn
+Enable Extended Sequence Number extension for this SA.
+.It Fl hwif Ar ifname
+Request hardware offload to the specified interface
+.Ar ifname
+(only).
+By default offload occurs to all capable interfaces.
.El
.\"
.Pp
@@ -472,27 +479,43 @@ is expressed in one of the following three formats:
.Xc
.El
.Pp
-The direction of a policy must be specified as
-one of:
+.Bl -tag -compact -width "policy level"
+.It Ar direction
+The
+.Ar direction
+of a policy must be specified as one of:
.Li out
or
.Li in .
+.It Ar policy level
The direction is followed by one of the following policy levels:
.Li discard ,
.Li none ,
or
.Li ipsec .
+.Bl -compact -bullet
+.It
The
.Li discard
-policylevel means that packets matching the supplied indices will
-be discarded while
+policy level means that packets matching the supplied indices will
+be discarded.
+.It
+The
.Li none
-means that IPsec operations will not take place on the packet and
+policy level means that IPsec operations will not take place on
+the packet.
+.It
+The
.Li ipsec
-means that IPsec operation will take place onto the packet.
+policy level means that IPsec operation will take place onto
+the packet.
+.El
+.It Ar protocol/mode/src-dst/level
The
.Ar protocol/mode/src-dst/level
statement gives the rule for how to process the packet.
+.Bl -compact -bullet
+.It
The
.Ar protocol
is specified as
@@ -500,12 +523,15 @@ is specified as
.Li esp
or
.Li ipcomp .
+.It
The
.Ar mode
is either
.Li transport
or
.Li tunnel .
+.El
+.Pp
If
.Ar mode
is
@@ -517,6 +543,7 @@ and
with a dash,
.Sq - ,
between the addresses.
+.Pp
If
.Ar mode
is
@@ -526,6 +553,7 @@ both
and
.Ar dst
can be omitted.
+.Pp
The
.Ar level
is one of the following:
@@ -534,25 +562,32 @@ or
.Li unique .
If the SA is not available in every level, the kernel will request
the SA from the key exchange daemon.
+.Pp
+.Bl -compact -bullet
+.It
A value of
.Li default
tells the kernel to use the system wide default protocol
e.g.,\& the one from the
.Li esp_trans_deflev
sysctl variable, when the kernel processes the packet.
+.It
A value of
.Li use
means that the kernel will use an SA if it is available,
otherwise the kernel will pass the packet as it would normally.
+.It
A value of
.Li require
means that an SA is required whenever the kernel sends a packet matched
that matches the policy.
+.It
The
.Li unique
level is the same as
.Li require
but, in addition, it allows the policy to bind with the unique out-bound SA.
+.Pp
For example, if you specify the policy level
.Li unique ,
.Xr racoon 8 Pq Pa ports/security/ipsec-tools
@@ -570,6 +605,8 @@ must be between 1 and 32767,
which corresponds to
.Ar extensions Fl u
of manual SA configuration.
+.El
+.El
.Pp
When you want to use an SA bundle, you can define multiple rules.
For