share/man/man4/kame.4

   1 .\" Copyright (C) 1995, 1996, 1997, 1998 and 1999 WIDE Project.
   2 .\" 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. Neither the name of the project nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     $Id: kame.4,v 1.4 1999/10/07 04:01:15 itojun Exp $
  29 .\"     $FreeBSD: src/share/man/man4/kame.4,v 1.3.2.7 2002/07/17 18:20:32 blackend Exp $
  30 .\"     $DragonFly: src/share/man/man4/Attic/kame.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  31 .\"
  32 .Dd April 13, 1999
  33 .Dt KAME 4
  34 .Os
  35 .Sh NAME
  36 .Nm KAME
  37 .Nd introduction and roadmap to KAME IPv6 software package
  38 .Sh DESCRIPTION
  39 .Nm
  40 software package is a result of joint work of several IPv6 researchers
  41 in Japan, to provide reference implementation of IPv6 to
  42 Berkeley Software Distribution
  43 .Pq Bx
  44 derived system such as
  45 .Bsx ,
  46 .Fx ,
  47 .Nx
  48 and
  49 .Ox
  50 (in alphabetical order).
  51 .Pp
  52 .\" Package consists of set of patches and additions to kernel,
  53 .\" modification to application, daemons, header files and libraries.
  54 KAME kit consists of IPv6/IPsec-ready kernel, application, daemons,
  55 header files and libraries.
  56 .Sh HIGHLIGHTS
  57 Following are some of highlights of this implementation.
  58 .Pp
  59 Note: features not yet integrated into
  60 .Fx
  61 are marked with the
  62 .Pq -
  63 sign.
  64 .\"
  65 .Ss Kernel
  66 IPv6 and IPsec protocol stacks are implemented and available.
  67 See below for conformance to standards and/or internet drafts.
  68 .\"
  69 .Ss Plug and Play and protocol stack/interface configuration
  70 .Xr ndp 8 ,
  71 .Xr prefix 8 ,
  72 .Xr rrenumd 8 ,
  73 .Xr rtadvd 8 ,
  74 .Xr rtsol 8 ,
  75 .Xr rtsold 8 .
  76 .\"
  77 .Ss Routing
  78 .Xr rip6query 8 ,
  79 .Xr route6d 8 .
  80 .\"
  81 .Ss Multicast (includes routing and utilities)
  82 .Xr mchat 1
  83 .Pq - ,
  84 .Xr ifmcstat 8 ,
  85 .Xr pim6dd 8 ,
  86 .Xr pim6sd 8 ,
  87 .Xr pim6stat 8 .
  88 .\"
  89 .Ss Transition Tools
  90 Two IPv4 to IPv6 transition tools are available.
  91 TCP relay translator, FAITH
  92 .Pq Xr faithd 8
  93 and SIIT IPv6-to-v4 header translator implementation
  94 .Pq Xr ptrconfig 8 .
  95 .Xr ptrconfig 8
  96 is not yet integrated into
  97 .Fx .
  98 .\"
  99 .Ss IPsec and tunnelling
 100 .Xr gifconfig 8 ,
 101 .Xr ipsec 4 ,
 102 .\" (dtcp and racoon doesn't exist yet.)
 103 .\" .Xr dtcpc 8 ,
 104 .\" .Xr dtcps 8 ,
 105 .\" .Xr racoon 8 ,
 106 .Xr setkey 8 .
 107 .Pp
 108 Dozen of existing tools are modified for IPsec support, like
 109 .Xr ping 8 .
 110 .\"
 111 .Ss Utilities/Diagnosis
 112 .Xr v6test 1
 113 .Pq - ,
 114 .Xr ping6 8 ,
 115 .Xr traceroute6 8 .
 116 .Pp
 117 Dozen of existing utilities are modified for IPv6/IPsec support, like
 118 .Xr ftp 1
 119 and/or
 120 .Xr telnet 1 .
 121 .\"
 122 .Ss Application Daemons
 123 .Xr inetd 8
 124 modified for IPv4/v6 support, or
 125 IPv6-only
 126 .Xr inet6d 8
 127 is supplied.
 128 .Pp
 129 Dozen of existing daemons are modified for IPv6/IPsec support, like
 130 .Xr ftpd 8
 131 and/or
 132 .Xr telnetd 8 .
 133 .\"
 134 .Sh DOCUMENTATION
 135 Although some of documentations have not modified yet, program itself
 136 may be heavily modified.
 137 Following lists are not complete, but give you some idea what kind of
 138 new software modules are available, or, modifications are made.
 139 Please refer to each manual page for detail.
 140 .\"
 141 .Ss Installation and basic usage documentations
 142 Please read the following files in the directories
 143 .Pa /usr/share/doc/IPv6
 144 and
 145 .Pa /usr/share/examples/IPv6
 146 to get a basic idea of (and installation methods for
 147 .Nm .
 148 You also can check out the IPv6 and IPsec chapters in the
 149 .Fx
 150 handbook.
 151 Also check latest status of project at web page:
 152 .Pa http://www.kame.net/ .
 153 (Hope you can see a
 154 .Dq Dancing Turtle
 155 .Li :-) )
 156 .\"
 157 .Ss APIs introduced or modified
 158 .Xr if_indextoname 3 ,
 159 .Xr getipnodebyname 3 ,
 160 .Xr gethostbyname 3 ,
 161 .Xr rresvport_af 3 ,
 162 .Xr hosts_ctl 3 ,
 163 .Xr ipsec_get_policylen 3 ,
 164 .Xr getnameinfo 3 ,
 165 .Xr freeaddrinfo 3 ,
 166 .Xr getaddrinfo 3 ,
 167 .Xr pcap 3 ,
 168 .Xr getipnodebyaddr 3 ,
 169 .Xr resolver 3 ,
 170 .Xr ipsec_strerror 3 ,
 171 .Xr gai_strerror 3 ,
 172 .Xr hosts_access 3 ,
 173 .Xr request_set 3 ,
 174 .Xr request_init 3 ,
 175 .Xr freehostent 3 ,
 176 .Xr if_nameindex 3 ,
 177 .Xr if_freenameindex 3 ,
 178 .Xr if_nametoindex 3 ,
 179 .Xr ipsec_dump_policy 3 ,
 180 .Xr ipsec_set_policy 3
 181 .\"
 182 .Ss Added/modified/renamed features and tools
 183 Please consult the manpages referred above.
 184 .\"
 185 .Sh SEE ALSO
 186 To understand
 187 .Nm
 188 protocol stack conformance, please refer to
 189 .Pa /usr/share/doc/IPv6/IMPLEMENTATION .
 190 .Pp
 191 Bug reporting form, user mailing list, frequently asked questions list,
 192 latest packages, related software, and more information can be found at
 193 .Pa http://www.kame.net/ .
 194 .\"
 195 .Ss "Related project"
 196 TAHI project who is providing verification technology for IPv6, is
 197 heavily related with KAME project.
 198 You can get current verification
 199 status of KAME software at following TAHI project web page:
 200 .Pa http://www.tahi.org/
 201 .\"
 202 .Sh HISTORY
 203 The
 204 .Nm
 205 project started in April 1999.
 206 .Nm
 207 kit was mostly integrated into
 208 .Fx
 209 by
 210 .An Youshinobu Inoue Aq shin@FreeBSD.org
 211 in January 2000.