share/man/man4/fast_ipsec.4

   1 .\" Copyright (c) 2003
   2 .\"     Sam Leffler <sam@errno.com>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY Sam Leffler AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23 .\" THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 20, 2003
  28 .Dt FAST_IPSEC 4
  29 .Os
  30 .Sh NAME
  31 .Nm "Fast IPsec"
  32 .Nd hardware-accelerated IP Security Protocols
  33 .Sh SYNOPSIS
  34 .Cd "options FAST_IPSEC"
  35 .Cd "device crypto"
  36 .Pp
  37 .Bl -item -compact
  38 .It
  39 .Va net.inet.esp.enable
  40 .It
  41 .Va net.inet.ah.enable
  42 .It
  43 .Va net.inet.ipcomp.enable
  44 .El
  45 .Sh DESCRIPTION
  46 .Tn IPsec
  47 is a set of protocols,
  48 .Tn ESP
  49 (for Encapsulating Security Payload)
  50 .Tn AH
  51 (for Authentication Header),
  52 and
  53 .Tn IPComp
  54 (for IP Payload Compression Protocol)
  55 that provide security services for IP datagrams.
  56 .Nm
  57 is an experimental implementation of these protocols that uses the
  58 .Xr crypto 4
  59 subsystem to carry out cryptographic operations.
  60 This means, in particular, that cryptographic hardware devices are
  61 employed whenever possible to optimize the performance of these protocols.
  62 .Pp
  63 In general, the
  64 .Nm
  65 implementation is intended to be compatible with the
  66 .Tn KAME IPsec
  67 implementation.
  68 This documentation concentrates on differences from that software.
  69 The user should refer to
  70 .Xr ipsec 4
  71 for basic information on setting up and using these protocols.
  72 .Pp
  73 System configuration requires the
  74 .Xr crypto 4
  75 subsystem.
  76 When the
  77 .Nm
  78 protocols are configured for use, all protocols are included in the system.
  79 To selectively enable/disable protocols, use
  80 .Xr sysctl 8 .
  81 .Pp
  82 The packets can be passed to a virtual interface,
  83 .Dq enc0 ,
  84 to perform packet filtering before outbound encryption and after decapsulation
  85 inbound.
  86 .Sh DIAGNOSTICS
  87 To be added.
  88 .Sh SEE ALSO
  89 .Xr crypto 4 ,
  90 .Xr enc 4 ,
  91 .Xr ipsec 4 ,
  92 .Xr setkey 8 ,
  93 .Xr sysctl 8
  94 .Sh HISTORY
  95 The protocols draw heavily on the
  96 .Ox
  97 implementation of the
  98 .Tn IPsec
  99 protocols.
 100 The policy management code is derived from the
 101 .Tn KAME
 102 implementation found
 103 in their
 104 .Tn IPsec
 105 protocols.
 106 The
 107 .Nm
 108 protocols first appeared in
 109 .Fx 5.0 .
 110 .Sh BUGS
 111 There is presently no support for IPv6.
 112 .Pp
 113 The
 114 .Tn IPcomp
 115 protocol support does not work.
 116 .Pp
 117 Certain legacy authentication algorithms are not supported because of
 118 issues with the
 119 .Xr crypto 4
 120 subsystem.
 121 .Pp
 122 This documentation is incomplete.