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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Sam Leffler AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD: src/share/man/man4/fast_ipsec.4,v 1.1.2.1 2003/01/24 05:12:59 sam Exp $
  32 .\" $DragonFly: src/share/man/man4/fast_ipsec.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  33 .\"
  34 .Dd January 20, 2003
  35 .Dt FAST_IPSEC 4
  36 .Os
  37 .Sh NAME
  38 .Nm "Fast IPsec"
  39 .Nd Hardware-accelerated IP Security Protocols
  40 .Sh SYNOPSIS
  41 .Cd "options FAST_IPSEC"
  42 .Cd "device crypto"
  43 .Pp
  44 .Cd net.inet.esp.enable
  45 .Cd net.inet.ah.enable
  46 .Cd net.inet.ipcomp.enable
  47 .El
  48 .Sh DESCRIPTION
  49 .Tn IPsec
  50 is a set of protocols,
  51 .Tn ESP
  52 (for Encapsulating Security Payload)
  53 .Tn AH
  54 (for Authentication Header),
  55 and
  56 .Tn IPComp
  57 (for IP Payload Compression Protocol)
  58 that provide security services for IP datagrams.
  59 .Tn Fast IPsec
  60 is an experimental implementation of these protocols that uses the
  61 .Xr crypto 4
  62 subsystem to carry out cryptographic operations.
  63 This means, in particular, that cryptograph hardware devices are
  64 employed whenever possible to optimize the performance of these protocols.
  65 .Pp
  66 In general the
  67 .Tn Fast IPsec
  68 implementation is intended to be compatible with the
  69 KAME
  70 .Tn IPsec
  71 implementation.
  72 This documentation concentrates on differences from that software.
  73 The user should refer to
  74 .Xr ipsec 4
  75 for basic information on setting up and using these protocols.
  76 .Pp
  77 System configuration requires the crypto subsystem.
  78 When the
  79 .Tn Fast IPsec
  80 protocols are configured for use all protocols are included in the system.
  81 To selectively enable/disable protocols use
  82 .Xr sysctl 8 .
  83 .Sh DIAGNOSTICS
  84 To be added.
  85 .Sh BUGS
  86 There is presently no support for IPv6.
  87 The IPcomp protocol support does not work.
  88 Certain legacy authentication algorithms are not supported because of
  89 issues with the crypto subsystem.
  90 This documentation is incomplete.
  91 .Sh SEE ALSO
  92 .Xr ipsec 4 ,
  93 .Xr setkey 8 ,
  94 .Xr sysctl 8
  95 .Sh HISTORY
  96 The protocols draw heavily on the OpenBSD implementation of the
  97 .Tn IPsec
  98 protocols.
  99 The policy management code is derived from the KAME implementation found
 100 in their
 101 .Tn IPsec
 102 protocols.
 103 The
 104 .Tn Fast IPsec
 105 protocols first appeared in
 106 .Fx 5.0 .