summaryrefslogtreecommitdiff
path: root/share/man/man4/faith.4
diff options
context:
space:
mode:
authorTheo de Raadt <deraadt@cvs.openbsd.org>2003-01-18 23:53:50 +0000
committerTheo de Raadt <deraadt@cvs.openbsd.org>2003-01-18 23:53:50 +0000
commit0737851f1642d613c81b8ae2ee1cb7603cbd837a (patch)
treef302a7fae29e75d80a8f4c984253110ec1eab569 /share/man/man4/faith.4
parent46ff6b272921b15bc0df982c467b575d17c674a6 (diff)
inet6 fixes from jmc@prioris.mini.pw.edu.pl
Diffstat (limited to 'share/man/man4/faith.4')
-rw-r--r--share/man/man4/faith.441
1 files changed, 22 insertions, 19 deletions
diff --git a/share/man/man4/faith.4 b/share/man/man4/faith.4
index 1e982252873..3b9450bb51f 100644
--- a/share/man/man4/faith.4
+++ b/share/man/man4/faith.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: faith.4,v 1.10 2001/06/30 01:05:23 itojun Exp $
+.\" $OpenBSD: faith.4,v 1.11 2003/01/18 23:53:49 deraadt Exp $
.\" $KAME: faith.4,v 1.10 2001/06/30 00:42:48 itojun Exp $
.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
@@ -41,21 +41,22 @@ The
.Nm
interface captures IPv6 TCP traffic,
for implementing userland IPv6-to-IPv4 TCP relay
-like
+similar to
.Xr faithd 8 .
.Pp
Special action will be taken when IPv6 TCP traffic is seen on a router,
-and routing table suggests to route it to
+and the routing table suggests routing it to the
.Nm
interface.
In this case, the packet will be accepted by the router,
-regardless of list of IPv6 interface addresses assigned to the router.
-The packet will be captured by an IPv6 TCP socket, if it has
+regardless of the list of IPv6 interface addresses assigned to the router.
+The packet is captured by an IPv6 TCP socket, if it has the
.Dv IN6P_FAITH
flag turned on and it has matching address/port pairs.
-In result,
+Thus,
.Nm
-will let you capture IPv6 TCP traffic to some specific destination addresses.
+allows captured IPv6 TCP traffic to be relayed to some
+specific destination addresses.
Userland programs, such as
.Xr faithd 8
can use this behavior to relay IPv6 TCP traffic to IPv4 TCP traffic.
@@ -64,44 +65,46 @@ The program can accept some specific IPv6 TCP traffic, perform
to get the IPv6 destination address specified by the client,
and perform application-specific address mapping to relay IPv6 TCP to IPv4 TCP.
.Pp
+The
.Dv IN6P_FAITH
-flag on IPv6 TCP socket can be set by using
+flag on an IPv6 TCP socket can be set by using
.Xr setsockopt 2 ,
-with level equals to
+with level set to
.Dv IPPROTO_IPV6
-and optname equals to
+and optname set to
.Dv IPv6_FAITH .
.Pp
-To handle error reports by ICMPv6, some of ICMPv6 packets routed to
+To handle error reports by ICMPv6, some of the ICMPv6 packets routed to the
.Nm
interface will be delivered to IPv6 TCP, as well.
.Pp
To understand how
.Nm
-can be used, take a look at source code of
+can be used, take a look at the source code of
.Xr faithd 8 .
.Pp
-As
+As the
.Nm
-interface implements potentially dangerous operation,
-great care must be taken when configuring
+interface implements a potentially dangerous operation,
+great care must be taken when configuring the
.Nm
interface.
-To avoid possible misuse,
+To avoid possible misuse, the
.Xr sysctl 8
variable
.Li net.inet6.ip6.keepfaith
must be set to
.Li 1
-prior to the use of the interface.
+prior to use of the interface.
When
.Li net.inet6.ip6.keepfaith
is
.Li 0 ,
-no packet will be captured by
+no packet is captured by the
.Nm
interface.
.Pp
+The
.Nm
interface is intended to be used on routers, not on hosts.
.\"
@@ -118,5 +121,5 @@ interface is intended to be used on routers, not on hosts.
.%D June 2001
.Re
.Sh HISTORY
-The FAITH IPv6-to-IPv4 TCP relay translator was first appeared in
+The FAITH IPv6-to-IPv4 TCP relay translator first appeared in
WIDE hydrangea IPv6 stack.