[ViewVC] Diff of: cvs/gvpe/doc/gvpe.osdep.5.pod

Comparing gvpe/doc/gvpe.osdep.5.pod (file contents):
Revision 1.6 by pcg, Wed Mar 23 17:03:58 2005 UTC vs.
Revision 1.9 by pcg, Fri Mar 25 15:38:07 2005 UTC

…		…
5	=head1 DESCRIPTION	5	=head1 DESCRIPTION
6		6
7	This file tries to capture OS-dependent configuration or build issues,	7	This file tries to capture OS-dependent configuration or build issues,
8	quirks and platform limitations, as known.	8	quirks and platform limitations, as known.
9		9
10	=head2 TUN vs. TAP interface	10	=head1 TUN vs. TAP interface
11		11
12	Most operating systems nowadays support something called a	12	Most operating systems nowadays support something called a
13	I<tunnel>-device, which makes it possible to divert IPv4 (and often other	13	I<tunnel>-device, which makes it possible to divert IPv4 (and often other
14	protocols, too) into a userspace daemon like C<gvpe>. This is being	14	protocols, too) into a userspace daemon like C<gvpe>. This is being
15	referred to as a TUN-device.	15	referred to as a TUN-device.
…		…
28	found on a specific host, you will either need to hardwire the MAC address	28	found on a specific host, you will either need to hardwire the MAC address
29	for TUN-style hosts on all networks (and avoid ARP altogether, which is	29	for TUN-style hosts on all networks (and avoid ARP altogether, which is
30	possible), or you need to send a packet from these hosts into the vpn	30	possible), or you need to send a packet from these hosts into the vpn
31	network to tell gvpe the local interface address.	31	network to tell gvpe the local interface address.
32		32
		33	=head1 Interface Initialisation
		34
		35	Unless otherwise notes, the network interface will be initialized with the
		36	expected MAC address and correct MTU value. With most interface drivers,
		37	this is done by running C</sbin/ifconfig>, so make sure that this command
		38	exists.
		39
		40	=head1 Interface Types
		41
33	=head2 native/linux	42	=head2 native/linux
34		43
35	TAP-device; already part of the kernel (only 2.4+ supported, but see	44	TAP-device; already part of the kernel (only 2.4+ supported, but see
36	tincd/linux). This is the configuration tested best, as gvpe is being	45	tincd/linux). This is the configuration tested best, as gvpe is being
37	developed on this platform.	46	developed on this platform.
38		47
39	To configure the interface, use either iproute2:	48	C<ifname> should be set to the name of the network device.
40
41	ip set $IFNAME address $MAC mtu $MTU up
42	ip addr add $IFNAME 10.11.12.13
43	ip route add $IFNAME 10.11.12.13/8
44
45	Or C<ifconfig>:
46
47	ifconfig $IFNAME hw ether $MAC mtu $MTU
48	ifconfig $IFNAME 10.11.12.13 netmask 255.0.0.0
49		49
50	To hardwire ARP addresses, use iproute2 (C<arp> can do it, too):	50	To hardwire ARP addresses, use iproute2 (C<arp> can do it, too):
51		51
52	MAC=fe:fd:80:00:00:$(printf "%02x" $NODEID)	52	MAC=fe:fd:80:00:00:$(printf "%02x" $NODEID)
53	ip neighbour add 10.11.12.13 lladdr $MAC nud permanent dev $IFNAME	53	ip neighbour add 10.11.12.13 lladdr $MAC nud permanent dev $IFNAME
54		54
55	=head2 tincd/linux	55	=head2 tincd/linux
56		56
57	TAP-device; already part of the kernel (2.2+ supported). See	57	TAP-device; already part of the kernel (2.2 only). See
58	C<native/linux> for more info.	58	C<native/linux> for more info.
		59
		60	C<ifname> should be set to the path of a tap device,
		61	e.g. C</dev/tap0>. The interface will be named accordingly.
59		62
60	=head2 native/cygwin	63	=head2 native/cygwin
61		64
62	TAP-device; The TAP device to be used must either be the CIPE driver	65	TAP-device; The TAP device to be used must either be the CIPE driver
63	(C<http://cipe-win32.sourceforge.net/>), or (highly recommended) the newer	66	(C<http://cipe-win32.sourceforge.net/>), or (highly recommended) the newer
64	TAP-Win32 driver bundled with openvpn (http://openvpn.sf.net/). Just	67	TAP-Win32 driver bundled with openvpn (http://openvpn.sf.net/). Just
65	download and run the openvpn installer. The only option you need to select	68	download and run the openvpn installer. The only option you need to select
66	is the TAP driver.	69	is the TAP driver.
67		70
68	The MAC need not be set (and in fact I<cannot> be set). The MAC address	71	C<ifname> should be set to the name of the device, found in the registry
69	is dynamically being patched into packets and ARP-requests, so only IPv4	72	at (no kidding :):
70	works with ARP on this platform.	73
		74	HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Network\{4D36E972-E325-11CE-BFC1-08002BE10318}\<adapterid>\Connection\Name
		75
		76	The MAC address is dynamically being patched into packets and
		77	ARP-requests, so only IPv4 works with ARP on this platform.
71		78
72	=head2 tincd/freebsd	79	=head2 tincd/freebsd
73		80
74	TAP-device; part of the kernel (since 4.x, maybe earlier). To initialize	81	TAP-device; part of the kernel (since 4.x, maybe earlier).
75	the interface, use this command:
76		82
77	ifconfig $IFNAME ether $MAC mtu $MTU up	83	C<ifname> should be set to the path of a tap device,
		84	e.g. C</dev/tap0>. The interface will be named accordingly.
		85
		86	These commands might be helpful examples:
		87
		88	ifconfig $IFNAME 10.0.0.$NODEID
		89	route add -net 10.0.0.0 -netmask 255.255.255.0 -interface $IFNAME 10.0.0.$NODEID
78		90
79	=head2 tincd/netbsd	91	=head2 tincd/netbsd
80		92
81	TUN-device; The interface is a point to point-device. To initialize it,	93	TUN-device; The interface is a point-to-point device. To initialize it,
82	you currently need to configure it as such, giving it an address on your	94	you currently need to configure it as a point-to-point device, giving it
83	vpn (the exact address doesn't matter), like this:	95	an address on your vpn (the exact address doesn't matter), like this:
84		96
85	ifconfig $IFNAME mtu $MTU up	97	ifconfig $IFNAME mtu $MTU up
86	ifconfig $IFNAME 10.11.12.13 10.55.66.77	98	ifconfig $IFNAME 10.11.12.13 10.55.66.77
87	route add -net 10.0.0.0 10.55.66.77 255.0.0.0	99	route add -net 10.0.0.0 10.55.66.77 255.0.0.0
88	ping -c1 10.55.66.77 # ping once to tell gvpe your gw ip	100	ping -c1 10.55.66.77 # ping once to tell gvpe your gw ip
89		101
		102	The ping is required to tell the ARP emulator inside GVPE the local IP
		103	address.
		104
		105	C<ifname> should be set to the path of a tun device,
		106	e.g. C</dev/tun0>. The interface will be named accordingly.
		107
90	=head2 tincd/openbsd	108	=head2 tincd/openbsd
91		109
92	TUN-device; already part of the kernel. See C<tincd/netbsd> for more information.	110	TUN-device; already part of the kernel. See C<tincd/netbsd> for more information.
93		111
94	=head2 native/darwin	112	=head2 native/darwin
…		…
98	The necessary kernel extension can be found here:	116	The necessary kernel extension can be found here:
99		117
100	http://www-user.rhrk.uni-kl.de/~nissler/tuntap/	118	http://www-user.rhrk.uni-kl.de/~nissler/tuntap/
101		119
102	There are two drivers, the one to use is the "tap" driver. It driver must	120	There are two drivers, the one to use is the "tap" driver. It driver must
103	be loaded before use, using C<kmodload>.	121	be loaded before use, read the docs on how to install it as a startup
		122	item.
		123
		124	C<ifname> should be set to the path of a tap device,
		125	e.g. C</dev/tap0>. The interface will be named accordingly.
		126
		127	These commands might be helpful examples:
		128
		129	ifconfig $IFNAME 10.0.0.$NODEID
		130	route add -net 10.0.0.0 -interface $IFNAME 255.255.255.0
104		131
105	=head2 tincd/darwin	132	=head2 tincd/darwin
106		133
107	TUN-device; See C<tincd/netbsd> for more information. C<native/darwin> is	134	TUN-device; See C<tincd/netbsd> for more information. C<native/darwin> is
108	preferable.	135	preferable.
109		136
110	The necessary kernel extension can be found here:	137	The necessary kernel extension can be found here:
111		138
112	http://chrisp.de/en/projects/tunnel.html	139	http://chrisp.de/en/projects/tunnel.html
113		140
		141	C<ifname> should be set to the path of a tun device,
		142	e.g. C</dev/tun0>. The interface will be named accordingly.
		143
114	The driver must be loaded before use:	144	The driver must be loaded before use:
115		145
116	kmodload tunnel	146	kmodload tunnel
117		147
118	=head2 tincd/solaris	148	=head2 tincd/solaris
119		149
120	TUN-device; already part of the kernel, or available here:	150	TUN-device; already part of the kernel(?), or available here:
121		151
122	http://vtun.sourceforge.net/tun/	152	http://vtun.sourceforge.net/tun/
123		153
124	Some precompiled tun drivers might be available here:	154	Some precompiled tun drivers might be available here:
125		155
126	http://www.monkey.org/~dugsong/fragroute/	156	http://www.monkey.org/~dugsong/fragroute/
127		157
		158	The interface MAC and MTU are I<NOT> set up for you. Please try it out and
		159	send me an C<ifconfig> command invocation that does that.
		160
128	See C<tincd/netbsd> for more information.	161	See C<tincd/netbsd> for more information.
129		162
130	Completely unstested so far.	163	Completely unstested so far.
131		164
132	=head2 tincd/mingw	165	=head2 tincd/mingw
133		166
134	TAP-device; see C<native/cygwin> for more information.	167	TAP-device; see C<native/cygwin> for more information.
135		168
		169	The setup is likely to be similar to C<native/cygwin>.
		170
136	Completely untested so far.	171	Completely untested so far.
137		172
138	=head2 tincd/raw_socket	173	=head2 tincd/raw_socket
139		174
140	TAP-device; purpose unknown and untested, probably binds itself on an	175	TAP-device; purpose unknown and untested, probably binds itself on an
141	existing ethernet device (given by C<ifname>), which should probably not	176	existing ethernet device (given by C<ifname>). It must be down prior to
142	be configured in any way, except for setting it I<up>.	177	running the command, and GVPE will try to set it's MAC address and MTU to
		178	the "correct" values.
		179
		180	Completely untested so far.
143		181
144	=head2 tincd/uml_socket	182	=head2 tincd/uml_socket
145		183
146	TAP-device; purpose unknown and untested, probably creates a unix datagram	184	TAP-device; purpose unknown and untested, probably creates a unix datagram
147	socket (path given by C<ifname>) and reads and writes raw packets, so	185	socket (path given by C<ifname>) and reads and writes raw packets, so
148	might be useful in other than UML contexts.	186	might be useful in other than UML contexts.
149		187
		188	No network interface is created, and the MAC and MTU must be set as
		189	approriate on the other side of the socket. GVPE will exit if the MAC
		190	address doesn't match what it expects.
		191
		192	Completely untested so far.
		193
150	=head2 tincd/cygwin	194	=head2 tincd/cygwin
151		195
152	Known to be broken, use C<native/cygwin> instead.	196	Known to be broken, use C<native/cygwin> instead.
153		197
154	=head1 SEE ALSO	198	=head1 SEE ALSO

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing gvpe/doc/gvpe.osdep.5.pod (file contents): Revision 1.6 by pcg, Wed Mar 23 17:03:58 2005 UTC vs. Revision 1.9 by pcg, Fri Mar 25 15:38:07 2005 UTC

Diff Legend

Comparing gvpe/doc/gvpe.osdep.5.pod (file contents):
Revision 1.6 by pcg, Wed Mar 23 17:03:58 2005 UTC vs.
Revision 1.9 by pcg, Fri Mar 25 15:38:07 2005 UTC