| blob | d06693317896e268496e42bd39586c2a01b22144 |
1 .\" $NetBSD: etherip.4,v 1.6 2007/09/10 10:35:52 cube Exp $
2 .\"
3 .\" Copyright (c) 2006, Hans Rosenfeld <rosenfeld@grumpf.hope-2000.org>.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of Hans Rosenfeld nor the names of his contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"
31 .\" Copyright (c) 2004, 2005 The NetBSD Foundation.
32 .\" All rights reserved.
33 .\"
34 .\" Redistribution and use in source and binary forms, with or without
35 .\" modification, are permitted provided that the following conditions
36 .\" are met:
37 .\" 1. Redistributions of source code must retain the above copyright
38 .\" notice, this list of conditions and the following disclaimer.
39 .\" 2. Redistributions in binary form must reproduce the above copyright
40 .\" notice, this list of conditions and the following disclaimer in the
41 .\" documentation and/or other materials provided with the distribution.
42 .\"
43 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
44 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
45 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
46 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
47 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
48 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
49 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
50 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
51 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
52 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
53 .\" POSSIBILITY OF SUCH DAMAGE.
54 .\"
55 .\"
56 .\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
57 .\" All rights reserved.
58 .\"
59 .\" Redistribution and use in source and binary forms, with or without
60 .\" modification, are permitted provided that the following conditions
61 .\" are met:
62 .\" 1. Redistributions of source code must retain the above copyright
63 .\" notice, this list of conditions and the following disclaimer.
64 .\" 2. Redistributions in binary form must reproduce the above copyright
65 .\" notice, this list of conditions and the following disclaimer in the
66 .\" documentation and/or other materials provided with the distribution.
67 .\" 3. Neither the name of the project nor the names of its contributors
68 .\" may be used to endorse or promote products derived from this software
69 .\" without specific prior written permission.
70 .\"
71 .\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
72 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
73 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
74 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
75 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
76 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
77 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
78 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
79 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
80 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
81 .\" SUCH DAMAGE.
82 .\"
83 .Dd November 23, 2006
84 .Dt ETHERIP 4
85 .Os
86 .Sh NAME
87 .Nm etherip
88 .Nd EtherIP tunneling device
89 .Sh SYNOPSIS
90 .Cd "pseudo-device etherip"
91 .Sh DESCRIPTION
92 The
93 .Nm
94 interface is a tunneling pseudo device for Ethernet frames.
95 It can tunnel Ethernet traffic over IPv4 and IPv6 using the EtherIP
96 protocol specified in RFC 3378.
97 .Pp
98 The only difference between an
99 .Nm
100 interface and a real Ethernet interface is that there is an IP tunnel
101 instead of a wire.
102 Therefore, to use
103 .Nm
104 the administrator must first create the interface and then configure
105 protocol and addresses used for the outer header.
106 This can be done by using
107 .Xr ifconfig 8
108 .Cm create
109 and
110 .Cm tunnel
111 subcommands, or
112 .Dv SIOCIFCREATE
113 and
114 .Dv SIOCSLIFPHYADDR
115 ioctls.
116 .Ss Packet format
117 Ethernet frames are prepended with a EtherIP header as described by
118 RFC 3378.
119 The resulting EtherIP packets will be encapsulated in an
120 outer packet, which may be either an IPv4 or IPv6 packet, with IP
121 protocol number 97.
122 .Ss Ethernet address
123 When a
124 .Nm
125 device is created, it is assigned an Ethernet address
126 of the form f2:0b:a5:xx:xx:xx.
127 This address can later be changed through a sysctl node.
128 .Pp
129 The sysctl node is net.link.etherip.\*[Lt]iface\*[Gt].
130 Any string of six colon-separated hexadecimal numbers will be accepted.
131 Reading that node will provide a string representation of the current
132 Ethernet address.
133 .Ss Security
134 The EtherIP header of incoming packets is not checked for
135 validity.
136 This is because there seems to be some confusion about how
137 such a header has to look like.
138 For outgoing packets, the header is set up the same way as done in
139 .Ox ,
140 .Fx ,
141 and Linux to be compatible with those systems.
142 .Ss Converting from previous implementation
143 A tunnel configured for the previous (undocumented) implementation
144 will work with just renaming the device from gif to
145 .Nm .
146 .Sh SEE ALSO
147 .Xr bridge 4 ,
148 .Xr gif 4 ,
149 .Xr inet 4 ,
150 .Xr inet6 4 ,
151 .Xr tap 4 ,
152 .Xr ifconfig 8
153 .\"
154 .Sh HISTORY
155 The
156 .Nm
157 device first appeared in
158 .Nx 4.0 ,
159 it is based on
160 .Xr tap 4 ,
161 .Xr gif 4 ,
162 and the former gif-based EtherIP implementation ported from
163 .Ox .
164 .\"
165 .Sh BUGS
166 Probably many.
167 There is lots of code duplication between
168 .Nm ,
169 .Xr tap 4 ,
170 .Xr gif 4 ,
171 and probably other tunnelling drivers which should be cleaned up.