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 .\"
  35 .Sh NAME
  36 .Nm KAME
  37 .Nd introduction and roadmap to KAME IPv6 software package
  38 .\"
  39 .Sh DESCRIPTION
  40 .Nm KAME
  41 software package is a result of joint work of several IPv6 researchers
  42 in Japan, to provide reference implementation of IPv6 to
  43 Berkeley Software Distribution
  44 .Pq BSD
  45 derived system such as BSD/OS,
  46 FreeBSD, NetBSD and OpenBSD
  47 .Pq in alphabetical order .
  48 .Pp
  49 .\" Package consists of set of patches and additions to kernel,
  50 .\" modification to application, daemons, header files and libraries.
  51 KAME kit consists of IPv6/IPsec-ready kernel, application, daemons,
  52 header files and libraries.
  53 .\"
  54 .Sh HIGHLIGHTS
  55 Following are some of highlights of this implementation.
  56 .\"
  57 .Ss Kernel
  58 IPv6 and IPsec protocol stacks are implemented and available.
  59 See below for conformance to standards and/or internet drafts.
  60 .\"
  61 .Ss Plug and Play and protocol stack/interface configuration
  62 .Xr ndp 8 ,
  63 .Xr prefix 8 ,
  64 .Xr rrenumd 8 ,
  65 .Xr rtadvd 8 ,
  66 .Xr rtsol 8 ,
  67 .Xr rtsold 8 .
  68 .\"
  69 .Ss Routing
  70 .Xr bgpd 8 ,
  71 .Xr hroute6d 8 ,
  72 .Xr rip6admin 8 ,
  73 .Xr rip6query 8 ,
  74 .Xr route6d 8 .
  75 .\"
  76 .Ss Multicast (includes routing and utilities)
  77 .Xr mcastread 1 ,
  78 .Xr mcastsend 1 ,
  79 .Xr mchat 1 ,
  80 .Xr ifmcstat 8 ,
  81 .Xr mld6query 8 ,
  82 .Xr pim6dd 8 ,
  83 .Xr pim6sd 8 ,
  84 .Xr pim6stat 8 .
  85 .\"
  86 .Ss Transition Tools
  87 Two IPv4 to IPv6 transition tools are available.
  88 TCP relay translator, FAITH
  89 .Po
  90 .Xr faithd 8
  91 .Pc .
  92 and SIIT IPv6-to-v4 header translator implementation
  93 .Po
  94 .Xr ptrconfig 8
  95 .Pc .
  96 .\"
  97 .Ss IPsec and tunnelling
  98 .Xr gifconfig 8 ,
  99 .Xr ipsec 4 ,
 100 .\" (dtcp and racoon doesn't exist yet.)
 101 .\" .Xr dtcpc 8 ,
 102 .\" .Xr dtcps 8 ,
 103 .\" .Xr racoon 8 ,
 104 .Xr setkey 8 .
 105 .Pp
 106 Dozen of existing tools are modified for IPsec support, like
 107 .Xr ping 8 .
 108 .\"
 109 .Ss Utilities/Diagnosis
 110 .Xr cksum6 1 ,
 111 .Xr v6test 1 ,
 112 .Xr icmp6dump 8 ,
 113 .Xr ping6 8 ,
 114 .Xr traceroute6 8 ,
 115 .Xr v6p 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 .Ss Miscellaneous
 135 SuMiRe IPv4 NAT
 136 .Po
 137 .Xr pma 8
 138 .Pc
 139 is available in addition to OS-supplied IPv4 NAT.
 140 .\"
 141 .Sh DOCUMENTATION
 142 Although some of documentations have not modified yet, program itself
 143 may be heavily modified.
 144 Following lists are not complete, but give you some idea what kind of
 145 new software modules are available, or, modifications are made.
 146 Please refer to each manual page for detail.
 147 Manpages are installed into
 148 .Pa /usr/local/v6/man
 149 so you may want to add the pathname to
 150 .Dv MANPATH .
 151 .\"
 152 .Ss Installation and basic usage documentations
 153 Please read following files in directory
 154 .Pa /usr/local/v6/share/doc/kame
 155 to get basic idea and installation methods on
 156 .Nm KAME :
 157 .Pa README ,
 158 .Pa RELNOTES ,
 159 .Pa USAGE
 160 and
 161 .Pa IMPLEMENTATION .
 162 Also check latest status of project at web page:
 163 .Pa http://www.kame.net/ .
 164 .Po
 165 Hope you can see a
 166 .Dq Dancing Turtle
 167 .Dv :-)
 168 .Pc
 169 .\"
 170 .Ss APIs introduced or modified
 171 .Xr if_indextoname 3 ,
 172 .Xr getipnodebyname 3 ,
 173 .Xr gethostbyname 3 ,
 174 .Xr rresvport_af 3 ,
 175 .Xr hosts_ctl 3 ,
 176 .Xr ipsec_get_policylen 3 ,
 177 .Xr getnameinfo 3 ,
 178 .Xr freeaddrinfo 3 ,
 179 .Xr getaddrinfo 3 ,
 180 .Xr pcap 3 ,
 181 .Xr getipnodebyaddr 3 ,
 182 .Xr resolver 3 ,
 183 .Xr ipsec_strerror 3 ,
 184 .Xr gai_strerror 3 ,
 185 .Xr hosts_access 3 ,
 186 .Xr request_set 3 ,
 187 .Xr request_init 3 ,
 188 .Xr freehostent 3 ,
 189 .Xr if_nameindex 3 ,
 190 .Xr if_freenameindex 3 ,
 191 .Xr if_nametoindex 3 ,
 192 .Xr ipsec_dump_policy 3 ,
 193 .Xr ipsec_set_policy 3
 194 .\"
 195 .Ss Added/modified/renamed features and tools
 196 Please consult the manpages referred above.
 197 .\"
 198 .Sh REFERENCES
 199 To understand
 200 .Nm KAME
 201 protocol stack conformance, please refer
 202 .Pa /usr/local/v6/share/doc/kame/IMPLEMENTATION .
 203 .Pp
 204 Bug reporting form, user mailing list, frequently asked questions list,
 205 latest packages, related software, and more information can be found at
 206 .Pa http://www.kame.net/ .
 207 .\"
 208 .Ss "Related project"
 209 TAHI project who is providing verification technology for IPv6, is
 210 heavily related with KAME project.
 211 You can get current verification
 212 status of KAME software at following THAI project web page:
 213 .Pa http://www.tahi.org/
 214 .\"
 215 .Sh HISTORY
 216 The
 217 .Nm
 218 project started in April 1999.