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 August 24, 2006
  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 "options IPSEC_FILTERGIF"
  36 .Cd "device crypto"
  37 .Pp
  38 .Bl -item -compact
  39 .It
  40 .Va net.inet.esp.enable
  41 .It
  42 .Va net.inet.ah.enable
  43 .It
  44 .Va net.inet.ipcomp.enable
  45 .El
  46 .Sh DESCRIPTION
  47 .Tn IPsec
  48 is a set of protocols,
  49 .Tn ESP
  50 (for Encapsulating Security Payload)
  51 .Tn AH
  52 (for Authentication Header),
  53 and
  54 .Tn IPComp
  55 (for IP Payload Compression Protocol)
  56 that provide security services for IP datagrams.
  57 .Nm
  58 is an experimental implementation of these protocols that uses the
  59 .Xr crypto 4
  60 subsystem to carry out cryptographic operations.
  61 This means, in particular, that cryptographic hardware devices are
  62 employed whenever possible to optimize the performance of these protocols.
  63 .Pp
  64 In general, the
  65 .Nm
  66 implementation is intended to be compatible with the
  67 .Tn KAME IPsec
  68 implementation.
  69 This documentation concentrates on differences from that software.
  70 The user should refer to
  71 .Xr ipsec 4
  72 for basic information on setting up and using these protocols.
  73 Note that it is not currently possible to use
  74 .Nm
  75 in conjunction with the
  76 .Tn "KAME IPsec"
  77 implementation.
  78 .Pp
  79 System configuration requires the
  80 .Xr crypto 4
  81 subsystem.
  82 When the
  83 .Nm
  84 protocols are configured for use, all protocols are included in the system.
  85 To selectively enable/disable protocols, use
  86 .Xr sysctl 8 .
  87 .Pp
  88 The packets can be passed to a virtual interface,
  89 .Dq enc0 ,
  90 to perform packet filtering before outbound encryption and after decapsulation
  91 inbound.
  92 .Pp
  93 To properly filter
  94 .Xr gif 4
  95 tunnels with firewalls, add
  96 .Cd "options IPSEC_FILTERGIF"
  97 to the kernel configuration file.
  98 .Sh DIAGNOSTICS
  99 To be added.
 100 .Sh SEE ALSO
 101 .Xr crypto 4 ,
 102 .Xr enc 4 ,
 103 .Xr ipsec 4 ,
 104 .Xr setkey 8 ,
 105 .Xr sysctl 8
 106 .Sh HISTORY
 107 The protocols draw heavily on the
 108 .Ox
 109 implementation of the
 110 .Tn IPsec
 111 protocols.
 112 The policy management code is derived from the
 113 .Tn KAME
 114 implementation found
 115 in their
 116 .Tn IPsec
 117 protocols.
 118 The
 119 .Nm
 120 protocols first appeared in
 121 .Fx 5.0 .
 122 .Sh BUGS
 123 There is presently no support for IPv6.
 124 .Pp
 125 The
 126 .Tn IPcomp
 127 protocol support does not work.
 128 .Pp
 129 Certain legacy authentication algorithms are not supported because of
 130 issues with the
 131 .Xr crypto 4
 132 subsystem.
 133 .Pp
 134 This documentation is incomplete.