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