]> git.lizzy.rs Git - plan9front.git/blob - sys/man/8/6in4
getuser(2): add source or sysname()
[plan9front.git] / sys / man / 8 / 6in4
1 .TH 6IN4 8
2 .SH NAME
3 6in4, ayiya - configure and run automatic or manual tunnel of IPv6 through IPv4
4 .SH SYNOPSIS
5 .B ip/6in4
6 [
7 .B -ag
8 ] [
9 .B -m
10 .I mtu
11 ] [
12 .B -x
13 .I netmtpt
14 ] [
15 .B -o
16 .I outnetmtpt
17 ]  [
18 .B -i
19 .I local4
20 ] [
21 .IB local6 [ /mask ]
22 [
23 .I remote4
24 [
25 .I remote6
26 ] ] ]
27 .br
28 .B ip/ayiya
29 [
30 .B -g
31 ] [
32 .B -m
33 .I mtu
34 ] [
35 .B -x
36 .I netmtpt
37 ] [
38 .B -k
39 .I secret
40 ]
41 .IB local6 [ /mask ]
42 .I remote4
43 .I remote6
44 .SH DESCRIPTION
45 .I 6in4
46 sets up and maintains a 6to4 tunnel of IPv6 traffic through an IPv4 connection.
47 .I Ayiya
48 is similar, but uses the UDP based Anything In Anything protocol to
49 tunnel IPv6 traffic.
50 .PP
51 .I Local6
52 and
53 .I mask
54 define the IPv6 address and subnet of the near end of the tunnel
55 .RI ( mask
56 defaults to
57 .L /128
58 for a single-host
59 tunnel).
60 If
61 .I local6
62 is missing or
63 .LR - ,
64 it defaults to
65 .IP
66 .BI 2002: aabb : ccdd ::1/48
67 .PP
68 where
69 .IR aa ,
70 .IR bb ,
71 .I cc
72 and
73 .I dd
74 are the hexadecimal equivalents of the bytes
75 .IB a . b . c .\c
76 .I d
77 in this host's primary IPv4 address.
78 .PP
79 .I Remote4
80 is the IPv4 address of the far end of the tunnel
81 (must be given explicitly for a configured tunnel, or
82 defaults to the anycast address 192.88.99.1 for
83 .IR 6to4 ).
84 .PP
85 .I Remote6
86 is the IPv6 address of the far end of the tunnel
87 (used as the point-to-point destination for routing, and
88 defaults to a link-local address constructed from
89 .IR remote4 ).
90 .PP
91 The program forks a pair of background processes to copy packets to and from
92 the tunnel.
93 .PP
94 Options are:
95 .TF -x
96 .PD 0
97 .TP
98 .B -a
99 for
100 .IR 6in4 ,
101 permit any remote IPv4 address as the far end of a tunnel.
102 This is likely to be useful for the server side of a tunnel.
103 .TP
104 .B -i
105 for
106 .IR 6in4 ,
107 define what is the local IPv4 address, otherwise it takes the first
108 non-loopback address of the outside IP stack.
109 .TP
110 .B -g
111 use the tunnel as the default route for global IPv6 addresses
112 .TP
113 .B -m
114 .I mtu
115 specifies the outside MTU in bytes from which the inside
116 tunnel MTU is derived. Deaults to 1500 - 8 (Ethernet - PPPoE).
117 .TP
118 .B -x
119 use the network mounted at
120 .I netmtpt
121 instead of
122 .LR /net
123 for binding the tunnel interface and sending/receiving IPv4
124 packets.
125 .TP
126 .B -o
127 for
128 .IR 6in4 ,
129 use
130 .I outnetmtpt
131 for the IPv4 packets but bind the IPv6 interface on
132 .LR /net
133 or
134 .I netmtpt
135 when specified by a previous
136 .B -x
137 option.
138 .TP
139 .B -k
140 for
141 .IR ayiya ,
142 use the shared secret key
143 .I secret
144 to authenticate messages on the tunnel.
145 .PD
146 .SH EXAMPLES
147 If your primary IPv4 address is public,
148 you can start a
149 .I 6to4
150 tunnel simply with
151 .IP
152 .EX
153 ip/6in4 -g
154 .EE
155 .PP
156 Similarly, you can start a server for
157 .I 6to4
158 tunnels with
159 .IP
160 .EX
161 ip/6in4 -ag
162 .EE
163 .PP
164 If you use a tunnel broker at address
165 .LR 5.6.7.8 ,
166 configured to give you a
167 .L /64
168 subnet with address
169 .LR 2001:1122:3344:5566:: ,
170 you can start the tunnel with
171 .IP
172 .EX
173 ip/6in4 -g 2001:1122:3344:5566::/64 5.6.7.8
174 .EE
175 .SH FILES
176 .TF /net/ipmux
177 .PD 0
178 .TP
179 .B /net/ipmux
180 access to IPv6-in-IPv4 packets
181 .TP
182 .B /net/ipifc
183 packet interface to IPv6 network
184 .SH SEE ALSO
185 .IR bridge (3),
186 .I ipmux
187 in
188 .IR ip (3),
189 .I linklocal
190 in
191 .IR ipconfig (8)
192 .br
193 .B /lib/rfc/rfc3056
194 .br
195 .B /lib/rfc/rfc3068
196 .br
197 .B http://tools.ietf.org/id/draft-massar-v6ops-ayiya-02.txt
198 .SH BUGS
199 Needs a kernel with an
200 .I ipmux
201 driver.
202 .PP
203 The tunnel client filters addresses fairly conservatively in both directions.
204 However it's not watertight,
205 and may be flakey in other ways so don't put too much trust in it.