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$
  30 .\"
  31 .Dd April 13, 1999
  32 .Dt KAME 4
  33 .Os
  34 .Sh NAME
  35 .Nm KAME
  36 .Nd introduction and roadmap to KAME IPv6 software package
  37 .Sh DESCRIPTION
  38 .Nm
  39 software package is a result of joint work of several IPv6 researchers
  40 in Japan, to provide reference implementation of IPv6 to
  41 Berkeley Software Distribution
  42 .Pq Bx
  43 derived system such as
  44 .Bsx ,
  45 .Fx ,
  46 .Nx
  47 and
  48 .Ox
  49 (in alphabetical order).
  50 .Pp
  51 .\" Package consists of set of patches and additions to kernel,
  52 .\" modification to application, daemons, header files and libraries.
  53 KAME kit consists of IPv6/IPsec-ready kernel, application, daemons,
  54 header files and libraries.
  55 .Sh HIGHLIGHTS
  56 Following are some of highlights of this implementation.
  57 .Pp
  58 Note: features not yet integrated into
  59 .Fx
  60 are marked with the
  61 .Pq -
  62 sign.
  63 .\"
  64 .Ss Kernel
  65 IPv6 and IPsec protocol stacks are implemented and available.
  66 See below for conformance to standards and/or internet drafts.
  67 .\"
  68 .Ss Plug and Play and protocol stack/interface configuration
  69 .Xr ndp 8 ,
  70 .Xr rrenumd 8 ,
  71 .Xr rtadvd 8 ,
  72 .Xr rtsol 8 ,
  73 .Xr rtsold 8 .
  74 .\"
  75 .Ss Routing
  76 .Xr rip6query 8 ,
  77 .Xr route6d 8 .
  78 .\"
  79 .Ss Multicast (includes routing and utilities)
  80 .Xr mchat 1
  81 .Pq - ,
  82 .Xr ifmcstat 8 ,
  83 .Xr pim6dd 8 Pq Pa ports/net/pim6dd ,
  84 .Xr pim6sd 8 Pq Pa ports/net/pim6sd ,
  85 .Xr pim6stat 8 .
  86 .\"
  87 .Ss Transition Tools
  88 Two IPv4 to IPv6 transition tools are available.
  89 TCP relay translator, FAITH
  90 .Pq Xr faithd 8
  91 and SIIT IPv6-to-v4 header translator implementation
  92 .Pq Xr ptrconfig 8 .
  93 .Xr ptrconfig 8
  94 is not yet integrated into
  95 .Fx .
  96 .\"
  97 .Ss IPsec and tunnelling
  98 .Xr ipsec 4 ,
  99 .Xr racoon 8 Pq Pa ports/security/racoon ,
 100 .Xr setkey 8 .
 101 .Pp
 102 Dozen of existing tools are modified for IPsec support, like
 103 .Xr ping 8 .
 104 .\"
 105 .Ss Utilities/Diagnosis
 106 .Xr v6test 1
 107 .Pq - ,
 108 .Xr ping6 8 ,
 109 .Xr traceroute6 8 .
 110 .Pp
 111 Dozen of existing utilities are modified for IPv6/IPsec support, like
 112 .Xr ftp 1
 113 and/or
 114 .Xr telnet 1 .
 115 .\"
 116 .Ss Application Daemons
 117 .Xr inetd 8
 118 modified for IPv4/v6 support, or
 119 IPv6-only
 120 .Xr inet6d 8
 121 .Pq -
 122 is supplied.
 123 .Pp
 124 Dozen of existing daemons are modified for IPv6/IPsec support, like
 125 .Xr ftpd 8
 126 and/or
 127 .Xr telnetd 8 .
 128 .\"
 129 .Sh DOCUMENTATION
 130 Although some of documentations have not modified yet, program itself
 131 may be heavily modified.
 132 Following lists are not complete, but give you some idea what kind of
 133 new software modules are available, or, modifications are made.
 134 Please refer to each manual page for detail.
 135 .\"
 136 .Ss Installation and basic usage documentations
 137 Please read the following files in the directories
 138 .Pa /usr/share/doc/IPv6
 139 and
 140 .Pa /usr/share/examples/IPv6
 141 to get a basic idea of (and installation methods for
 142 .Nm .
 143 You also can check out the IPv6 and IPsec chapters in the
 144 .Fx
 145 handbook.
 146 Also check latest status of project at web page:
 147 .Pa http://www.kame.net/ .
 148 (Hope you can see a
 149 .Dq Dancing Turtle
 150 .Li :-) )
 151 .\"
 152 .Ss APIs introduced or modified
 153 .Xr if_indextoname 3 ,
 154 .Xr getipnodebyname 3 ,
 155 .Xr gethostbyname 3 ,
 156 .Xr rresvport_af 3 ,
 157 .Xr hosts_ctl 3 ,
 158 .Xr ipsec_get_policylen 3 ,
 159 .Xr getnameinfo 3 ,
 160 .Xr freeaddrinfo 3 ,
 161 .Xr getaddrinfo 3 ,
 162 .Xr pcap 3 ,
 163 .Xr getipnodebyaddr 3 ,
 164 .Xr resolver 3 ,
 165 .Xr ipsec_strerror 3 ,
 166 .Xr gai_strerror 3 ,
 167 .Xr hosts_access 3 ,
 168 .Xr request_set 3 ,
 169 .Xr request_init 3 ,
 170 .Xr freehostent 3 ,
 171 .Xr if_nameindex 3 ,
 172 .Xr if_freenameindex 3 ,
 173 .Xr if_nametoindex 3 ,
 174 .Xr ipsec_dump_policy 3 ,
 175 .Xr ipsec_set_policy 3
 176 .\"
 177 .Ss Added/modified/renamed features and tools
 178 Please consult the manpages referred above.
 179 .\"
 180 .Sh SEE ALSO
 181 To understand
 182 .Nm
 183 protocol stack conformance, please refer to
 184 .Pa /usr/share/doc/IPv6/IMPLEMENTATION .
 185 .Pp
 186 Bug reporting form, user mailing list, frequently asked questions list,
 187 latest packages, related software, and more information can be found at
 188 .Pa http://www.kame.net/ .
 189 .\"
 190 .Ss "Related project"
 191 TAHI project who is providing verification technology for IPv6, is
 192 heavily related with KAME project.
 193 You can get current verification
 194 status of KAME software at following TAHI project web page:
 195 .Pa http://www.tahi.org/
 196 .\"
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 project started in April 1999.
 201 .Nm
 202 kit was mostly integrated into
 203 .Fx
 204 by
 205 .An Youshinobu Inoue Aq shin@FreeBSD.org
 206 in January 2000.