share/man/man4/gre.4

   1 .\" $NetBSD: gre.4,v 1.28 2002/06/10 02:49:35 itojun Exp $
   2 .\"
   3 .\" Copyright 1998 (c) The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Heiko W.Rupp <hwr@pilhuhn.de>
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"     This product includes software developed by the NetBSD
  20 .\"     Foundation, Inc. and its contributors.
  21 .\" 4. Neither the name of the The NetBSD Foundation nor the names of its
  22 .\"    contributors may be used to endorse or promote products derived
  23 .\"    from this software without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd June 20, 2008
  40 .Dt GRE 4
  41 .Os
  42 .Sh NAME
  43 .Nm gre
  44 .Nd encapsulating network device
  45 .Sh SYNOPSIS
  46 To compile the
  47 .Ns Nm
  48 device into the kernel, place the following line in the kernel
  49 configuration file:
  50 .Bd -ragged -offset indent
  51 .Cd "device gre"
  52 .Ed
  53 .Pp
  54 Alternatively, to load the
  55 .Ns Nm
  56 device as a module at boot time, place the following line in
  57 .Xr loader.conf 5 :
  58 .Bd -literal -offset indent
  59 if_gre_load="YES"
  60 .Ed
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 network interface pseudo device encapsulates datagrams
  65 into IP.
  66 These encapsulated datagrams are routed to a destination host,
  67 where they are decapsulated and further routed to their final destination.
  68 The
  69 .Dq tunnel
  70 appears to the inner datagrams as one hop.
  71 .Pp
  72 .Nm
  73 interfaces are dynamically created and destroyed with the
  74 .Xr ifconfig 8
  75 .Cm create
  76 and
  77 .Cm destroy
  78 subcommands.
  79 .Pp
  80 This driver currently supports the following modes of operation:
  81 .Bl -tag -width indent
  82 .It "GRE encapsulation (IP protocol number 47)"
  83 Encapsulated datagrams are
  84 prepended an outer datagram and a GRE header.
  85 The GRE header specifies
  86 the type of the encapsulated datagram and thus allows for tunneling other
  87 protocols than IP like e.g.\& AppleTalk.
  88 GRE mode is also the default tunnel mode on Cisco routers.
  89 This is also the default mode of operation of the
  90 .Nm
  91 interfaces.
  92 As part of the GRE mode,
  93 .Nm
  94 also supports Cisco WCCP protocol, both version 1 and version 2.
  95 Since there is no reliable way to distinguish between WCCP versions, it
  96 should be configured manually using the
  97 .Cm link2
  98 flag.
  99 If the
 100 .Cm link2
 101 flag is not set (default), then WCCP version 1 is selected.
 102 .It "MOBILE encapsulation (IP protocol number 55)"
 103 Datagrams are
 104 encapsulated into IP, but with a shorter encapsulation.
 105 The original
 106 IP header is modified and the modifications are inserted between the
 107 so modified header and the original payload.
 108 Like
 109 .Xr gif 4 ,
 110 only for IP-in-IP encapsulation.
 111 .El
 112 .Pp
 113 The
 114 .Nm
 115 interfaces support a number of
 116 .Xr ioctl 2 Ns s ,
 117 such as:
 118 .Bl -tag -width ".Dv GRESADDRS"
 119 .It Dv GRESADDRS
 120 Set the IP address of the local tunnel end.
 121 This is the source address
 122 set by or displayed by
 123 .Xr ifconfig 8
 124 for the
 125 .Nm
 126 interface.
 127 .It Dv GRESADDRD
 128 Set the IP address of the remote tunnel end.
 129 This is the destination address
 130 set by or displayed by
 131 .Xr ifconfig 8
 132 for the
 133 .Nm
 134 interface.
 135 .It Dv GREGADDRS
 136 Query the IP address that is set for the local tunnel end.
 137 This is the
 138 address the encapsulation header carries as local address (i.e., the real
 139 address of the tunnel start point).
 140 .It Dv GREGADDRD
 141 Query the IP address that is set for the remote tunnel end.
 142 This is the
 143 address the encapsulated packets are sent to (i.e., the real address of
 144 the remote tunnel endpoint).
 145 .It Dv GRESPROTO
 146 Set the operation mode to the specified IP protocol value.
 147 The
 148 protocol is passed to the interface in
 149 .Po Vt "struct ifreq" Pc Ns Li -> Ns Va ifr_flags .
 150 The operation mode can also be given as
 151 .Pp
 152 .Bl -tag -width ".Cm -link0" -compact
 153 .It Cm link0
 154 .Dv IPPROTO_GRE
 155 .It Cm -link0
 156 .Dv IPPROTO_MOBILE
 157 .El
 158 .Pp
 159 to
 160 .Xr ifconfig 8 .
 161 .Pp
 162 The
 163 .Cm link1
 164 flag is not used to choose encapsulation, but to modify the
 165 internal route search for the remote tunnel endpoint, see the
 166 .Sx BUGS
 167 section below.
 168 .It Dv GREGPROTO
 169 Query operation mode.
 170 .It Dv GRESKEY
 171 Set the GRE key used for outgoing packets.
 172 A value of 0 disables the key option.
 173 .It Dv GREGKEY
 174 Get the GRE key currently used for outgoing packets.
 175 0 means no outgoing key.
 176 .El
 177 .Pp
 178 Note that the IP addresses of the tunnel endpoints may be the same as the
 179 ones defined with
 180 .Xr ifconfig 8
 181 for the interface (as if IP is encapsulated), but need not be, as e.g.\& when
 182 encapsulating AppleTalk.
 183 .Sh EXAMPLES
 184 Configuration example:
 185 .Bd -literal
 186 Host X-- Host A  ----------------tunnel---------- Cisco D------Host E
 187           \\                                          |
 188            \\                                        /
 189             +------Host B----------Host C----------+
 190 .Ed
 191 .Pp
 192 On host A
 193 .Pq Fx :
 194 .Bd -literal -offset indent
 195 route add default B
 196 ifconfig greN create
 197 ifconfig greN A D netmask 0xffffffff linkX up
 198 ifconfig greN tunnel A D
 199 route add E D
 200 .Ed
 201 .Pp
 202 On Host D (Cisco):
 203 .Bd -literal -offset indent
 204 Interface TunnelX
 205  ip unnumbered D   ! e.g. address from Ethernet interface
 206  tunnel source D   ! e.g. address from Ethernet interface
 207  tunnel destination A
 208 ip route C <some interface and mask>
 209 ip route A mask C
 210 ip route X mask tunnelX
 211 .Ed
 212 .Pp
 213 OR
 214 .Pp
 215 On Host D
 216 .Pq Fx :
 217 .Bd -literal -offset indent
 218 route add default C
 219 ifconfig greN create
 220 ifconfig greN D A
 221 ifconfig greN tunnel D A
 222 .Ed
 223 .Pp
 224 If all goes well, you should see packets flowing ;-)
 225 .Pp
 226 If you want to reach Host A over the tunnel (from Host D (Cisco)), then
 227 you have to have an alias on Host A for e.g.\& the Ethernet interface like:
 228 .Pp
 229 .Dl "ifconfig <etherif> alias Y"
 230 .Pp
 231 and on the Cisco:
 232 .Pp
 233 .Dl "ip route Y mask tunnelX"
 234 .Pp
 235 A similar setup can be used to create a link between two private networks
 236 (for example in the 192.168 subnet) over the Internet:
 237 .Bd -literal
 238 192.168.1.* --- Router A  -------tunnel-------- Router B --- 192.168.2.*
 239                    \\                              /
 240                     \\                            /
 241                      +------ the Internet ------+
 242 .Ed
 243 .Pp
 244 Assuming router A has the (external) IP address A and the internal address
 245 192.168.1.1, while router B has external address B and internal address
 246 192.168.2.1, the following commands will configure the tunnel:
 247 .Pp
 248 On router A:
 249 .Bd -literal -offset indent
 250 ifconfig greN create
 251 ifconfig greN 192.168.1.1 192.168.2.1 link1
 252 ifconfig greN tunnel A B
 253 route add -net 192.168.2 -netmask 255.255.255.0 192.168.2.1
 254 .Ed
 255 .Pp
 256 On router B:
 257 .Bd -literal -offset indent
 258 ifconfig greN create
 259 ifconfig greN 192.168.2.1 192.168.1.1 link1
 260 ifconfig greN tunnel B A
 261 route add -net 192.168.1 -netmask 255.255.255.0 192.168.1.1
 262 .Ed
 263 .Pp
 264 Note that this is a safe situation where the
 265 .Cm link1
 266 flag (as discussed in the
 267 .Sx BUGS
 268 section below) may (and probably should) be set.
 269 .Sh NOTES
 270 The MTU of
 271 .Nm
 272 interfaces is set to 1476 by default, to match the value used by Cisco routers.
 273 If grekey is set this is lowered to 1472.
 274 This may not be an optimal value, depending on the link between the two tunnel
 275 endpoints.
 276 It can be adjusted via
 277 .Xr ifconfig 8 .
 278 .Pp
 279 For correct operation, the
 280 .Nm
 281 device needs a route to the destination that is less specific than the
 282 one over the tunnel.
 283 (Basically, there needs to be a route to the decapsulating host that
 284 does not run over the tunnel, as this would be a loop.)
 285 If the addresses are ambiguous, doing the
 286 .Nm ifconfig Cm tunnel
 287 step before the
 288 .Xr ifconfig 8
 289 call to set the
 290 .Nm
 291 IP addresses will help to find a route outside the tunnel.
 292 .Pp
 293 In order to tell
 294 .Xr ifconfig 8
 295 to actually mark the interface as
 296 .Dq up ,
 297 the keyword
 298 .Cm up
 299 must be given last on its command line.
 300 .Pp
 301 The kernel must be set to forward datagrams by setting the
 302 .Va net.inet.ip.forwarding
 303 .Xr sysctl 8
 304 variable to non-zero.
 305 .Sh SEE ALSO
 306 .\" Xr atalk 4 ,
 307 .Xr gif 4 ,
 308 .Xr inet 4 ,
 309 .Xr ip 4 ,
 310 .Xr netintro 4 ,
 311 .\" Xr options 4 ,
 312 .Xr protocols 5 ,
 313 .Xr ifconfig 8 ,
 314 .Xr sysctl 8
 315 .Pp
 316 A description of GRE encapsulation can be found in RFC 1701 and RFC 1702.
 317 .Pp
 318 A description of MOBILE encapsulation can be found in RFC 2004.
 319 .Sh AUTHORS
 320 .An Heiko W.Rupp Aq hwr@pilhuhn.de
 321 .Sh BUGS
 322 The
 323 .Fn compute_route
 324 code in
 325 .Pa if_gre.c
 326 toggles the last bit of the
 327 IP-address to provoke the search for a less specific route than the
 328 one directly over the tunnel to prevent loops.
 329 This is possibly not the best solution.
 330 .Pp
 331 To avoid the address munging described above, turn on the
 332 .Cm link1
 333 flag on the
 334 .Xr ifconfig 8
 335 command line.
 336 This implies that the GRE packet destination and the ifconfig remote host
 337 are not the same IP addresses, and that the GRE destination does not route
 338 over the
 339 .Nm
 340 interface itself.
 341 .Pp
 342 The current implementation uses the key only for outgoing packets.
 343 Incomming packets with a different key or without a key will be treated as if they
 344 would belong to this interface.
 345 .Pp
 346 RFC1701 is not fully supported, however all unsupported features have been
 347 deprecated in RFC2784.