]> git.proxmox.com Git - mirror_frr.git/blob - doc/user/nhrpd.rst
Merge pull request #3516 from qlyoung/doc-ip-nht-resolve-via-default
[mirror_frr.git] / doc / user / nhrpd.rst
1 .. _nhrp:
2
3 ****
4 NHRP
5 ****
6
7 *nhrpd* is an implementation of the :abbr:NHRP `(Next Hop Routing Protocol)`.
8 NHRP is described in :rfc`2332`.
9
10 NHRP is used to improve the efficiency of routing computer network traffic over
11 :abbr:`NBMA (Non-Broadcast, Multiple Access)` networks. NHRP provides an
12 ARP-like solution that allows a system to dynamically learn the NBMA address of
13 the other systems that are part of that network, allowing these systems to
14 directly communicate without requiring traffic to use an intermediate hop.
15
16 Cisco Dynamic Multipoint VPN (DMVPN) is based on NHRP, and |PACKAGE_NAME| nhrpd
17 implements this scenario.
18
19 .. _routing-design:
20
21 Routing Design
22 ==============
23
24 nhrpd never handles routing of prefixes itself. You need to run some
25 real routing protocol (e.g. BGP) to advertise routes over the tunnels.
26 What nhrpd does it establishes 'shortcut routes' that optimizes the
27 routing protocol to avoid going through extra nodes in NBMA GRE mesh.
28
29 nhrpd does route NHRP domain addresses individually using per-host prefixes.
30 This is similar to Cisco FlexVPN; but in contrast to opennhrp which uses
31 a generic subnet route.
32
33 To create NBMA GRE tunnel you might use the following (Linux terminal
34 commands):::
35
36 ip tunnel add gre1 mode gre key 42 ttl 64
37 ip addr add 10.255.255.2/32 dev gre1
38 ip link set gre1 up
39
40
41 Note that the IP-address is assigned as host prefix to gre1. nhrpd will
42 automatically create additional host routes pointing to gre1 when
43 a connection with these hosts is established.
44
45 The gre1 subnet prefix should be announced by routing protocol from the
46 hub nodes (e.g. BGP 'network' announce). This allows the routing protocol
47 to decide which is the closest hub and determine the relay hub on prefix
48 basis when direct tunnel is not established.
49
50 nhrpd will redistribute directly connected neighbors to zebra. Within
51 hub nodes, these routes should be internally redistributed using some
52 routing protocol (e.g. iBGP) to allow hubs to be able to relay all traffic.
53
54 This can be achieved in hubs with the following bgp configuration (network
55 command defines the GRE subnet):
56
57 .. code-block:: frr
58
59 router bgp 65555
60 address-family ipv4 unicast
61 network 172.16.0.0/16
62 redistribute nhrp
63 exit-address-family
64
65
66 .. _configuring-nhrp:
67
68 Configuring NHRP
69 ================
70
71 FIXME
72
73 .. _hub-functionality:
74
75 Hub Functionality
76 =================
77
78 In addition to routing nhrp redistributed host prefixes, the hub nodes
79 are also responsible to send NHRP Traffic Indication messages that
80 trigger creation of the shortcut tunnels.
81
82 nhrpd sends Traffic Indication messages based on network traffic captured
83 using NFLOG. Typically you want to send Traffic Indications for network
84 traffic that is routed from gre1 back to gre1 in rate limited manner.
85 This can be achieved with the following iptables rule.
86
87 .. code-block:: shell
88
89 iptables -A FORWARD -i gre1 -o gre1 \\
90 -m hashlimit --hashlimit-upto 4/minute --hashlimit-burst 1 \\
91 --hashlimit-mode srcip,dstip --hashlimit-srcmask 24 --hashlimit-dstmask 24 \\
92 --hashlimit-name loglimit-0 -j NFLOG --nflog-group 1 --nflog-range 128
93
94
95 You can fine tune the src/dstmask according to the prefix lengths you
96 announce internal, add additional IP range matches, or rate limitation
97 if needed. However, the above should be good in most cases.
98
99 This kernel NFLOG target's nflog-group is configured in global nhrp config
100 with:
101
102 .. code-block:: frr
103
104 nhrp nflog-group 1
105
106 To start sending these traffic notices out from hubs, use the nhrp
107 per-interface directive:
108
109 .. code-block:: frr
110
111 interface gre1
112 ip nhrp redirect
113
114
115 .. _integration-with-ike:
116
117 Integration with IKE
118 ====================
119
120 nhrpd needs tight integration with IKE daemon for various reasons.
121 Currently only strongSwan is supported as IKE daemon.
122
123 nhrpd connects to strongSwan using VICI protocol based on UNIX socket
124 (hardcoded now as /var/run/charon.vici).
125
126 strongSwan currently needs few patches applied. Please check out the
127 `http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras-release,release <http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras-release,release>`_
128 and
129 `http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras,working tree <http://git.alpinelinux.org/cgit/user/tteras/strongswan/log/?h=tteras,working tree>`_
130 git repositories for the patches.
131
132 .. _nhrp-events:
133
134 NHRP Events
135 ===========
136
137 FIXME
138
139 Configuration Example
140 =====================
141
142 FIXME
143