share/man/man4/fast_ipsec.4

   1 .\"     $NetBSD: fast_ipsec.4,v 1.7 2008/05/25 20:08:12 wiz Exp $
   2 .\"     $FreeBSD: fast_ipsec.4,v 1.2 2003/03/03 11:51:30 ru Exp $
   3 .\"
   4 .\" Copyright (c) 2004
   5 .\"     Jonathan Stone <jonathan@dsg.stanford.edu>. All rights reserved.
   6 .\"
   7 .\" Copyright (c) 2003
   8 .\"     Sam Leffler <sam@errno.com>. All rights reserved.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  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 .Dd April 24, 2007
  32 .Dt FAST_IPSEC 4
  33 .Os
  34 .Sh NAME
  35 .Nm fast_ipsec
  36 .Nd Fast IPsec hardware-accelerated IP Security Protocols
  37 .Sh SYNOPSIS
  38 .Cd "options FAST_IPSEC"
  39 .Cd "options IPSEC_NAT_T"
  40 .Cd "pseudo-device crypto"
  41 .Sh DESCRIPTION
  42 .Tn IPsec
  43 is a set of protocols,
  44 .Tn ESP
  45 (for Encapsulating Security Payload)
  46 .Tn AH
  47 (for Authentication Header),
  48 and
  49 .Tn IPComp
  50 (for IP Payload Compression Protocol)
  51 that provide security services for IP datagrams.
  52 Fast IPsec
  53 is an implementation of these protocols that uses the
  54 .Xr opencrypto 9
  55 subsystem to carry out cryptographic operations.
  56 This means, in particular, that cryptographic hardware devices are
  57 employed whenever possible to optimize the performance of these protocols.
  58 .Pp
  59 In general, the
  60 Fast IPsec
  61 implementation is intended to be compatible with the
  62 .Tn KAME IPsec
  63 implementation.
  64 This documentation concentrates on differences from that software.
  65 The user should refer to
  66 .Xr ipsec 4
  67 for basic information on setting up and using these protocols.
  68 .Pp
  69 System configuration requires the
  70 .Xr opencrypto 9
  71 subsystem.
  72 When the
  73 Fast IPsec
  74 protocols are configured for use, all protocols are included in the system.
  75 To selectively enable/disable protocols, use
  76 .Xr sysctl 8 .
  77 .Sh DIAGNOSTICS
  78 To be added.
  79 .Sh SEE ALSO
  80 .Xr ipsec 4 ,
  81 .Xr setkey 8 ,
  82 .Xr sysctl 8 ,
  83 .Xr opencrypto 9
  84 .Sh HISTORY
  85 The protocols draw heavily on the
  86 .Ox
  87 implementation of the
  88 .Tn IPsec
  89 protocols.
  90 The policy management code is derived from the
  91 .Tn KAME
  92 implementation found in their
  93 .Tn IPsec
  94 protocols.
  95 The
  96 Fast IPsec
  97 protocols are based on code which appeared in
  98 .Fx 4.7 .
  99 The
 100 .Nx
 101 version is a close copy of the
 102 .Fx
 103 original, and first appeared in
 104 .Nx 2.0 .
 105 .Pp
 106 Support for IPv6 and
 107 .Tn IPcomp
 108 protocols has been added in
 109 .Nx 4.0 .
 110 .Pp
 111 Support for IPSEC_NAT_T
 112 (Network Address Translator Traversal as
 113 described in RFCs 3947 and 3948) has been added in
 114 .Nx 5.0 .
 115 .Sh BUGS
 116 There still are some issues in the IPv6 support.
 117 In particular
 118 .Tn FAST_IPSEC
 119 does not protect packets with IPv6 extension headers.
 120 .Pp
 121 Certain legacy authentication algorithms are not supported because of
 122 issues with the
 123 .Xr opencrypto 9
 124 subsystem.
 125 .Pp
 126 This documentation is incomplete.