share/man/man4/faith.4

   1 .\" Copyright (C) 1995, 1996, 1997, and 1998 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: faith.4,v 1.1.1.1 1999/08/08 23:30:37 itojun Exp $
  29 .\"     $FreeBSD$
  30 .\"
  31 .Dd April 10, 1999
  32 .Dt FAITH 4
  33 .Os
  34 .Sh NAME
  35 .Nm faith
  36 .Nd
  37 .Tn IPv6-to-IPv4 TCP relay capturing interface
  38 .Sh SYNOPSIS
  39 .Cd "pseudo-device faith 1"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 interface captures IPv6 TCP traffic
  44 for implementing userland IPv6-to-IPv4 TCP relays
  45 like
  46 .Xr faithd 8 .
  47 .Pp
  48 Special action will be taken when IPv6 TCP traffic is seen on a router
  49 and the routing table suggests to route it to the
  50 .Nm
  51 interface.
  52 In this case the packet will be accepted by the router,
  53 regardless of the list of IPv6 interface addresses assigned to the router.
  54 The packet will be captured by an IPv6 TCP socket if it has the
  55 .Dv IN6P_FAITH
  56 flag turned on and it has matching address/port pairs.
  57 As a result,
  58 .Nm
  59 will let you divert IPv6 TCP traffic to some specific destination addresses.
  60 Userland programs, such as
  61 .Xr faithd 8 ,
  62 can use this behavior to relay IPv6 TCP traffic to IPv4 TCP traffic.
  63 The program can accept some specific IPv6 TCP traffic, perform
  64 .Xr getsockname 3
  65 to get the IPv6 destination address specified by the client,
  66 and perform application-specific address mapping to relay IPv6 TCP to IPv4 TCP.
  67 .Pp
  68 The
  69 .Dv IN6P_FAITH
  70 flag on an IPv6 TCP socket can be set by using
  71 .Xr setsockopt 2 ,
  72 with
  73 .Fa level
  74 set to
  75 .Dv IPPROTO_IPV6
  76 and
  77 .Fa optname
  78 set to
  79 .Dv IPv6_FAITH .
  80 .Pp
  81 To handle error reports by ICMPv6 some of the ICMPv6 packets routed to the
  82 .Nm
  83 interface will need be delivered to IPv6 TCP as well.
  84 .Pp
  85 To understand how
  86 .Nm
  87 can be used take a look at the source code of
  88 .Xr faithd 8 .
  89 .Pp
  90 As the
  91 .Nm
  92 interface implements potentially dangerous operations,
  93 great care must be taken when configuring the
  94 .Nm
  95 interface.
  96 To avoid possible misuse the
  97 .Xr sysctl 8
  98 variable
  99 .Li net.inet6.ip6.keepfaith
 100 must be set to
 101 .Li 1
 102 prior to the use of the interface.
 103 When
 104 .Li net.inet6.ip6.keepfaith
 105 is set to
 106 .Li 0 ,
 107 no packets will be captured by the
 108 .Nm
 109 interface.
 110 .Pp
 111 The
 112 .Nm
 113 interface is intended to be used on routers, not on hosts.
 114 .\"
 115 .Sh SEE ALSO
 116 .Xr inet 4 ,
 117 .Xr inet6 4 ,
 118 .Xr faithd 8
 119 .\" .Rs
 120 .\" .%A Jun-ichiro itojun Hagino
 121 .\" .%A Kazu Yamamoto
 122 .\" .%T ``FAITH'' IPv6-to-IPv4 TCP relay translator
 123 .\" .%D July 1999
 124 .\" .Re
 125 .\"
 126 .Sh HISTORY
 127 The FAITH IPv6-to-IPv4 TCP relay translator first appeared in
 128 WIDE hydrangea IPv6 stack.