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 .\"
  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 prefix 8 ,
  71 .Xr rrenumd 8 ,
  72 .Xr rtadvd 8 ,
  73 .Xr rtsol 8 ,
  74 .Xr rtsold 8 .
  75 .\"
  76 .Ss Routing
  77 .Xr rip6query 8 ,
  78 .Xr route6d 8 .
  79 .\"
  80 .Ss Multicast (includes routing and utilities)
  81 .Xr mchat 1
  82 .Pq - ,
  83 .Xr ifmcstat 8 ,
  84 .Xr pim6dd 8 ,
  85 .Xr pim6sd 8 ,
  86 .Xr pim6stat 8 .
  87 .\"
  88 .Ss Transition Tools
  89 Two IPv4 to IPv6 transition tools are available.
  90 TCP relay translator, FAITH
  91 .Pq Xr faithd 8
  92 and SIIT IPv6-to-v4 header translator implementation
  93 .Pq Xr ptrconfig 8 .
  94 .Xr ptrconfig 8
  95 is not yet integrated into
  96 .Fx .
  97 .\"
  98 .Ss IPsec and tunnelling
  99 .Xr gifconfig 8 ,
 100 .Xr ipsec 4 ,
 101 .\" (dtcp and racoon doesn't exist yet.)
 102 .\" .Xr dtcpc 8 ,
 103 .\" .Xr dtcps 8 ,
 104 .\" .Xr racoon 8 ,
 105 .Xr setkey 8 .
 106 .Pp
 107 Dozen of existing tools are modified for IPsec support, like
 108 .Xr ping 8 .
 109 .\"
 110 .Ss Utilities/Diagnosis
 111 .Xr v6test 1
 112 .Pq - ,
 113 .Xr ping6 8 ,
 114 .Xr traceroute6 8 .
 115 .Pp
 116 Dozen of existing utilities are modified for IPv6/IPsec support, like
 117 .Xr ftp 1
 118 and/or
 119 .Xr telnet 1 .
 120 .\"
 121 .Ss Application Daemons
 122 .Xr inetd 8
 123 modified for IPv4/v6 support, or
 124 IPv6-only
 125 .Xr inet6d 8
 126 is supplied.
 127 .Pp
 128 Dozen of existing daemons are modified for IPv6/IPsec support, like
 129 .Xr ftpd 8
 130 and/or
 131 .Xr telnetd 8 .
 132 .\"
 133 .Sh DOCUMENTATION
 134 Although some of documentations have not modified yet, program itself
 135 may be heavily modified.
 136 Following lists are not complete, but give you some idea what kind of
 137 new software modules are available, or, modifications are made.
 138 Please refer to each manual page for detail.
 139 .\"
 140 .Ss Installation and basic usage documentations
 141 Please read the following files in the directories
 142 .Pa /usr/share/doc/IPv6
 143 and
 144 .Pa /usr/share/examples/IPv6
 145 to get a basic idea of (and installation methods for
 146 .Nm .
 147 You also can check out the IPv6 and IPsec chapters in the
 148 .Fx
 149 handbook.
 150 Also check latest status of project at web page:
 151 .Pa http://www.kame.net/ .
 152 (Hope you can see a
 153 .Dq Dancing Turtle
 154 .Li :-) )
 155 .\"
 156 .Ss APIs introduced or modified
 157 .Xr if_indextoname 3 ,
 158 .Xr getipnodebyname 3 ,
 159 .Xr gethostbyname 3 ,
 160 .Xr rresvport_af 3 ,
 161 .Xr hosts_ctl 3 ,
 162 .Xr ipsec_get_policylen 3 ,
 163 .Xr getnameinfo 3 ,
 164 .Xr freeaddrinfo 3 ,
 165 .Xr getaddrinfo 3 ,
 166 .Xr pcap 3 ,
 167 .Xr getipnodebyaddr 3 ,
 168 .Xr resolver 3 ,
 169 .Xr ipsec_strerror 3 ,
 170 .Xr gai_strerror 3 ,
 171 .Xr hosts_access 3 ,
 172 .Xr request_set 3 ,
 173 .Xr request_init 3 ,
 174 .Xr freehostent 3 ,
 175 .Xr if_nameindex 3 ,
 176 .Xr if_freenameindex 3 ,
 177 .Xr if_nametoindex 3 ,
 178 .Xr ipsec_dump_policy 3 ,
 179 .Xr ipsec_set_policy 3
 180 .\"
 181 .Ss Added/modified/renamed features and tools
 182 Please consult the manpages referred above.
 183 .\"
 184 .Sh SEE ALSO
 185 To understand
 186 .Nm
 187 protocol stack conformance, please refer to
 188 .Pa /usr/share/doc/IPv6/IMPLEMENTATION .
 189 .Pp
 190 Bug reporting form, user mailing list, frequently asked questions list,
 191 latest packages, related software, and more information can be found at
 192 .Pa http://www.kame.net/ .
 193 .\"
 194 .Ss "Related project"
 195 TAHI project who is providing verification technology for IPv6, is
 196 heavily related with KAME project.
 197 You can get current verification
 198 status of KAME software at following TAHI project web page:
 199 .Pa http://www.tahi.org/
 200 .\"
 201 .Sh HISTORY
 202 The
 203 .Nm
 204 project started in April 1999.
 205 .Nm
 206 kit was mostly integrated into
 207 .Fx
 208 by
 209 .An Youshinobu Inoue Aq shin@FreeBSD.org
 210 in January 2000.