Projecte

General

Perfil

Wiki » Historial » Versió 59

Axel Neumann, 18-08-2013 10:17

1 54 Pau Escrich
!bmx6.png!
2 1 Pau Escrich
3
Bmx6 is a routing protocol for Linux based operating systems.
4 6 Axel Neumann
The following intro provides kind of tutorial to get started.
5
6 56 Pau Escrich
{{>toc}}
7 1 Pau Escrich
8 8 Axel Neumann
h2. Installation
9 6 Axel Neumann
10 8 Axel Neumann
h3. Requirements
11 7 Axel Neumann
12 6 Axel Neumann
The following tools are needed to obtain, compile, and install bmx6
13
* git (debian package: git-core)
14
* gcc
15
* make
16
17
18 8 Axel Neumann
h3. Downloading
19 6 Axel Neumann
20
Latest development sources are available from bmx6 git repository
21
<pre>
22
git clone git://qmp.cat/bmx6.git
23
cd bmx6
24
</pre>
25
26 8 Axel Neumann
h3. Compile and Install
27 6 Axel Neumann
28 7 Axel Neumann
To only compile the main bmx6 daemon (no bmx6 plugins)
29 6 Axel Neumann
<pre>
30
make
31
sudo make install
32
</pre>
33
34
35 57 Pau Escrich
h2. Installing in OpenWRT 
36
37
Bmx6 is currently in the official routing feed of OpenWRT, so to install it from a existing system you can use opkg
38
39
    opkg install bmx6 bmx6-uci-config
40
41
h3. Compile it by adding a feed
42
43
If you are compiling your own OpenWRT, you can add the routing feed (already enabled by default) which can be found here
44
45
     https://github.com/openwrt-routing/packages
46
47
Then run "make menuconfig" and select the bmx6 package in _Networking -> Routing and redirection_
48
49
It is recommended to select also, at least, the uci plugin (bmx6-uci-config)
50
51
You can select "luci-app-bmx6" to have a nice web interface for manage and monitorize the routing daemon.
52
53
Finally type "make" to build the image.
54
55
56 8 Axel Neumann
h2. Usage (hello mesh)
57 6 Axel Neumann
58 19 Axel Neumann
h3. Starting
59 3 Axel Neumann
60
In its most simple configuration, the only required parameter are the interfaces names that should be used for meshing.
61
The following example starts bmx6 on interface wlan0:
62
<pre>
63 15 Axel Neumann
root@mlc1001:~# bmx6 dev=eth1
64 3 Axel Neumann
</pre>
65
66
However, to let this simple command work as expected also check the following basic requirements:
67
68 15 Axel Neumann
* bmx6 must be executed in root context (with super user permissions). If you are not already root, prepend all commands with sudo (eg: @ sudo bmx6 dev=eth1 @ ).
69 3 Axel Neumann
70 9 Axel Neumann
* NO IP address needs to be configured. By default bmx6 assumes IPv6 and autoconfigures an ULA based IPv6 address for each interface based on the MAC address of the device. Just, the interfaces must be UP. The linux ip command can do this for you (eg: @ ip link set wlan0 up @). Also, if you are using a wireless interface, the wireless interface settings must be set correctly so that link-layer connectivity is given with bmx6 daemons running on other nodes (computers). The good old iwconfig command may help to achieve that. For example @ iwconfig wlan0 mode ad-hoc ap 02:ca:ff:ee:ba:be channel 11 essid my-mesh-network @ is a typical configuration for a wireless mesh setup.
71 3 Axel Neumann
72 15 Axel Neumann
* Bmx6 (by default) works in daemon mode, thus sends itself to background and gives back a prompt. To let it run in foreground specify a debug level with the startup command like: @ bmx6 debug=0 dev=eth1 @ . Of course you may need to kill a previously started bmx6 daemon beforehand (@ killall bmx6 @)
73 1 Pau Escrich
74 19 Axel Neumann
If everything went fine bmx6 is running now, searching for neighboring bmx6 daemons via the configured interface (link), and coordinates with them to learn about existence-of and routes-to all other bmx6 nodes in the network.
75 1 Pau Escrich
76 19 Axel Neumann
77
78
79
80
h3. Accessing Protocol Events, Status, and Network Information
81
82
To access debug and status information of the bmx6 daemon which has just been started, a second bmx6 process can be launched in client mode (with the --connect or -c parameter) to connect to the main bmx6 daemon and retrieve the desired information.
83
84
In the following, a few example will be discussed
85
86
Continuous debug levels with different verbosity and scope are accessible with the --debug or -d parameter.
87
* Debug level 0 only reports critical events
88
* Debug level 3 reports relevant changes and 
89
* Debug level 4 reports everything.
90
* Debug level 12 dump in and outgoing protocol traffic
91 50 Pau Escrich
92
Eg.: @ bmx6 -cd3 @ connects a bmx6 client process to debug-level 3 of the main daemon and logs the output stdout until terminated with ctrl-c
93 19 Axel Neumann
94
95
96
Status, network, and statistic information are accessible with dedicated parameters:
97
* status
98
* interfaces
99
* links
100
* originators
101 21 Axel Neumann
* descriptions, plus optional sub-parameters for filtering
102 19 Axel Neumann
* tunnels
103
* traffic=DEV where DEV:= all or eth1, ....
104
105
106 18 Axel Neumann
<pre>
107 1 Pau Escrich
root@mlc1001:~# bmx6 -c status
108
version        compatibility codeVersion globalId                     primaryIp                       myLocalId uptime     cpu nodes 
109
BMX6-0.1-alpha 16            9           mlc1001.7A7422752001EC4AC4C8 fd66:66:66:0:a2cd:efff:fe10:101 24100101  0:00:40:37 0.1 4
110
</pre>
111 18 Axel Neumann
112 5 Axel Neumann
So apart from version, compatibility number, and code, the status reveals the daemon's global (see: [[Wiki#Global-ID]] ) and local ID, its primary (self-configured) IPv6 address, the time since when it is running (40 minutes), its current cpu consumption (0.1%) and the total number of 4 learned nodes in the network (including itself).
113 9 Axel Neumann
114 19 Axel Neumann
These desired types can be combined. Also the above given example shows kind of shortcut. The long argument would be
115
@ bmx6 connect show=status @. A more informative case using the long form would be:
116 1 Pau Escrich
<pre>
117 9 Axel Neumann
root@mlc1001:~# bmx6 connect show=status show=interfaces show=links show=originators show=tunnels
118 1 Pau Escrich
status:
119 18 Axel Neumann
version        compatibility codeVersion globalId                     primaryIp                       myLocalId uptime     cpu nodes
120
BMX6-0.1-alpha 16            9           mlc1001.7A7422752001EC4AC4C8 fd66:66:66:0:a2cd:efff:fe10:101 06100101  0:00:53:19 0.3 4
121 15 Axel Neumann
interfaces:
122 18 Axel Neumann
devName state type     rateMin rateMax llocalIp                    globalIp                           multicastIp primary
123
eth1    UP    ethernet 1000M   1000M   fe80::a2cd:efff:fe10:101/64 fd66:66:66:0:a2cd:efff:fe10:101/64 ff02::2     1
124 15 Axel Neumann
links:
125 18 Axel Neumann
globalId                     llocalIp                 viaDev rxRate txRate bestTxLink routes wantsOgms nbLocalId
126
mlc1000.0AE58311046412F248CD fe80::a2cd:efff:fe10:1   eth1   100    100    1          1      1         9B100001
127
mlc1002.91DCF042934B5913BB00 fe80::a2cd:efff:fe10:201 eth1   100    100    1          2      1         BB100201
128 15 Axel Neumann
originators:
129 18 Axel Neumann
globalId                     blocked primaryIp                       routes viaIp                    viaDev metric lastDesc lastRef
130
mlc1000.0AE58311046412F248CD 0       fd66:66:66:0:a2cd:efff:fe10:1   1      fe80::a2cd:efff:fe10:1   eth1   999M   3193     3 
131
mlc1001.7A7422752001EC4AC4C8 0       fd66:66:66:0:a2cd:efff:fe10:101 0      ::                       ---    128G   3197     0
132
mlc1002.91DCF042934B5913BB00 0       fd66:66:66:0:a2cd:efff:fe10:201 1      fe80::a2cd:efff:fe10:201 eth1   999M   3196     3 
133
mlc1003.09E796BC491D386248C3 0       fd66:66:66:0:a2cd:efff:fe10:301 1      fe80::a2cd:efff:fe10:201 eth1   576M   22       3 
134 1 Pau Escrich
</pre>
135
136 9 Axel Neumann
Only if relevant information for a requested type is available it will be shown.
137
In this example no tunnels are configured nor offered by other nodes and therefore no tunnel information is shown.
138 1 Pau Escrich
139 9 Axel Neumann
The loop argument can be prepended to the connect argument to continuously show the requested information.
140
Many of the long arguments are usable via a short notation, like l for loop, c for connect, s for show, d for debug.
141
And there is another shortcut summarizing my current favorite information types via debug level 8
142
The following commands do the same as above: @ bmx6 -lc status interfaces links originators tunnels @ or just @ bmx6 -lcd8 @.
143 1 Pau Escrich
144 18 Axel Neumann
Description of the provided info:
145 14 Axel Neumann
* interfaces: Followed by one line per configured interface
146
** dev: Interface name
147
** state and type: Whether the interface is UP or DOWN and its assumed link-layer type.
148
** rateMin and rateMax: Min- and maximum transmit rates assumed for this interface.
149
** llocalIp: IPv6 link-local address (used as source address for all outgoing protocol data).
150
** globalIp: Autoconfigured address used for sending network traffic via this interface and which is propagated to other nodes.
151
** multicastIp: Multicast IP (used as destination address for all bmx6 protocol traffic send via this interface).
152
** primary: Indicates whether the global ip of this interface is used as primary ip for this daemon.
153
* links: Followed by one line per detected neighboring bmx6 node.
154 16 Axel Neumann
** globalId: GlobalId of that neighbor (see: [[Wiki#Global-ID]] ).
155 14 Axel Neumann
** llocalIp: Link-local IP of the neighbor's interface building the other side of the link.
156
** viaDev: Interface of this node for the link.
157
** rxRate: Measured receive rate in percent for the link.
158
** txRate: Measured transmit rate in percent for the link.
159
** bestTxLink: Indicates whether this link is the best link to a neighboring nodes.
160 1 Pau Escrich
** routes: Indicates for how much routes to other nodes this link is used.
161
** wantsOgms: Indicates whether the neighboring node has requested (this node) to propagate originator messsages (OGMs) via this link.
162
** nbLocalId: Neighbors local ID.
163
* originators: Followed by one line per aware originator in the network (including itself).
164
** globalId: Global Id of that node (see: [[Wiki#Global-ID]] ).
165 30 Axel Neumann
** blocked: Indicates whether this node is currently blocked (see: [[Wiki#Blocked-Nodes]] ).
166 1 Pau Escrich
** primaryIp: The primary IP of that node. 
167
** routes: Number of potential routes towards this node.
168
** viaIp: Next hops link-local IP of the best route towards this node.
169
** viaDev: Outgoing interface of the best route towards this node.
170
** metric: The end to end path metric to this node
171
** lastDesc: Seconds since the last description update was received (see: [[Widi#Description]] )
172 18 Axel Neumann
** lastRef: Seconds since this node was referenced by any neighboring node (like last sign of life)
173
174
175
Quick summary of provided info:
176
* Node mlc1001 uses one wired interface (eth1) which is up and actively used for meshing.
177
* Node mlc1001 got aware of 2 neighbors and 4 nodes (originators) including itself.
178
* The link qualities (rx and tx rate) to its neighbors are perfect (100%) and actively used (bestTxLink)
179 1 Pau Escrich
* Routes to nodes mlc1000 and mlc1002 are via interface eth1 and directly to the neighbor's link-local address with a metric of 999M (nearly maximum tx/rx rate of the configured interface)
180
* Route to node mlc1003 is setup via interface eth1 and via the link-local address of neighbor mlc1002 (at least two hops to the destination node).
181
182 21 Axel Neumann
The following links of the total network topology can be guessed from this information (further links may exist):
183 1 Pau Escrich
@ mlc1000 --- mlc1001 --- mlc1002 - - - mlc1003 @
184
185 21 Axel Neumann
186
187
188 19 Axel Neumann
h3. Simple Ping Test
189
190 1 Pau Escrich
This could be verified using traceroute6 towards the primary IP of the other nodes.
191 18 Axel Neumann
192 19 Axel Neumann
To mlc1000's primary IP fd66:66:66:0:a2cd:efff:fe10:1 shows one hop:
193 18 Axel Neumann
<pre>
194
root@mlc1001:~# traceroute6 -n -q 1 fd66:66:66:0:a2cd:efff:fe10:1
195
traceroute to fd66:66:66:0:a2cd:efff:fe10:1 (fd66:66:66:0:a2cd:efff:fe10:1), 30 hops max, 80 byte packets
196 1 Pau Escrich
 1  fd66:66:66:0:a2cd:efff:fe10:1  0.324 ms
197 18 Axel Neumann
</pre>
198
199 19 Axel Neumann
To mlc1002's primary IP fd66:66:66:0:a2cd:efff:fe10:201 shows one hop:
200 18 Axel Neumann
<pre>
201
root@mlc1001:~# traceroute6 -n -q 1 fd66:66:66:0:a2cd:efff:fe10:201
202
traceroute to fd66:66:66:0:a2cd:efff:fe10:201 (fd66:66:66:0:a2cd:efff:fe10:201), 30 hops max, 80 byte packets
203
 1  fd66:66:66:0:a2cd:efff:fe10:201  0.302 ms
204 1 Pau Escrich
</pre>
205
206 19 Axel Neumann
To mlc1003's primary IP fd66:66:66:0:a2cd:efff:fe10:301 shows two hops:
207 1 Pau Escrich
<pre>
208
root@mlc1001:~# traceroute6 -n -q 1 fd66:66:66:0:a2cd:efff:fe10:301
209 18 Axel Neumann
traceroute to fd66:66:66:0:a2cd:efff:fe10:301 (fd66:66:66:0:a2cd:efff:fe10:301), 30 hops max, 80 byte packets
210
 1  fd66:66:66:0:a2cd:efff:fe10:201  0.313 ms
211
 2  fd66:66:66:0:a2cd:efff:fe10:301  0.429 ms
212
</pre>
213 19 Axel Neumann
214 1 Pau Escrich
215
h3. Dynamic Reconfiguration
216
217
Most bmx6 parameters can be applied not only at startup, but also dynamically to an already running main daemon, using the --connect command.
218 21 Axel Neumann
For example interfaces can be added, removed, or specified with more details:
219
The following example removes interface eth1 and adds eth2 with a max rate of 100 Mbits (overwriting the default assumption of 1000Mbits for ethernet interfaces).
220
<pre>
221
bmx6 -c dev=-eth1 dev=eth2 /rateMax=100000
222
bmx6 -cd8
223
</pre>
224 1 Pau Escrich
225 21 Axel Neumann
Checking new status of interfaces, links, and originator:
226
<pre>
227
root@mlc1001:~# bmx6 -cd8
228
status:
229
version        compatibility codeVersion globalId                     primaryIp                       myLocalId uptime     cpu nodes 
230
BMX6-0.1-alpha 16            9           mlc1001.7A7422752001EC4AC4C8 fd66:66:66:0:a2cd:efff:fe10:102 06100101  0:02:26:00 0.1 4 
231
interfaces:
232
devName state type     rateMin rateMax llocalIp                    globalIp                           multicastIp primary 
233
eth2    UP    ethernet 100M    100M    fe80::a2cd:efff:fe10:102/64 fd66:66:66:0:a2cd:efff:fe10:102/64 ff02::2     1       
234
links:
235
globalId                     llocalIp               viaDev rxRate txRate bestTxLink routes wantsOgms nbLocalId 
236
mlc1000.0AE58311046412F248CD fe80::a2cd:efff:fe10:2 eth2   89     88     1          3      1         9B100001  
237
originators:
238
globalId                     blocked primaryIp                       routes viaIp                  viaDev metric lastDesc lastRef 
239
mlc1000.0AE58311046412F248CD 0       fd66:66:66:0:a2cd:efff:fe10:1   1      fe80::a2cd:efff:fe10:2 eth2   81757K 18       0      
240
mlc1001.7A7422752001EC4AC4C8 0       fd66:66:66:0:a2cd:efff:fe10:102 0      ::                     ---    128G   80       0      
241
mlc1002.91DCF042934B5913BB00 0       fd66:66:66:0:a2cd:efff:fe10:201 1      fe80::a2cd:efff:fe10:2 eth2   83620K 14       4      
242
mlc1003.09E796BC491D386248C3 0       fd66:66:66:0:a2cd:efff:fe10:301 1      fe80::a2cd:efff:fe10:2 eth2   81488K 9        0
243
</pre>
244 1 Pau Escrich
245 21 Axel Neumann
It can be seen that:
246
* Interface eth1 has been replaced by eth2 with a lower rate.
247
* The primary IP of the node has changed (using the autoconfigured IP from eth2.
248
* The old links (via eth1) are removed and a single new link via eth2 to mlc1000 has been detected
249
* All routes are now going via eth2 and mlc1000's link-local IP fe80::a2cd:efff:fe10:2
250 1 Pau Escrich
251 21 Axel Neumann
252
253
254
255 1 Pau Escrich
h2. Concepts
256 17 Axel Neumann
257
h3. Global ID
258
259
Each bmx6 node creates during its initialization (booting) a global ID for itself. 
260
This ID is created as a concatenation of the node's hostname and a random value.
261
In the above given example with node hostname: "mlc1001" the globalID is: mlc1001.7A7422752001EC4AC4C8
262 1 Pau Escrich
When the bmx6 daemon restarts the hostname will remain. But the rand part will change.
263
As a consequence, the restarted node will appear as a new node to other nodes in the mesh while the old Global ID is still present in their node table.
264
Since both node IDs are announcing the same resources (eg the same primary IP), the ID that appears later will be blocked until the state maintained for the first ID expires.
265
266 26 Axel Neumann
267
268 21 Axel Neumann
h3. Descriptions
269
270 22 Axel Neumann
Instead of propagating individual routing updates for each announced network and interface address, each bmx6 daemon summarizes this and other node specific attributes into a single node-specific description. A specific description is propagated only once to all other nodes. Subsequent routing updates are referencing to the corresponding description with it's hash.
271 23 Axel Neumann
If a node is reconfigured, for example because its interfaces change or a new network shall be announced, than also the node's description changes.
272
Other nodes are becoming aware of the changed attributes of a reconfigured node by receiving a corresponding description update.
273
Subsequent references to this node will use the hash of the new description.
274
275
Because the description is designed very generic it can be easily used to piggyback other non-routing specific data. For example the bmx6-sms plugin is taking advantage of this option by adding arbitrary short messages data to the node's description.
276
277 25 Axel Neumann
Currently there is a limit for the total size of a description of 1400 bytes. While this is more than sufficient for quite a number of interfaces and announced networks per node, it is critical few when considering a gateway node with BGP route exchange that is announcing 100eds of networks.
278 23 Axel Neumann
279 30 Axel Neumann
h3. Blocked Nodes
280 26 Axel Neumann
281 29 Axel Neumann
Nodes may be blocked by other nodes.
282
When a node is blocked no routing updates (OGMs) of the blocked node are propagated by the blocking node.
283
The decision for blocking another node is done locally based on the detection of more than one node announcing the same unique resource.
284 59 Axel Neumann
This happens if two nodes are declaring themselves as the owner of a unique resource. Then one of those two nodes (usually the latter) is blocked to avoid the propagation of conflicting allocations (and ambiguous forwarding state). Duplicate address usage is the most common reason for such events which happens if two nodes are using (and announcing) the same primary IPs. Another typical scenario causing such case temporary is the rebooting of a node. Once a bmx6 daemon restarts it appears as a new node (with a new random part of it's global ID) to the network but (due to a typically persistant configuration) announcing the same address as the previous process. Since the resources allocated by the previous resources are still in the database of other nodes in the mesh they will block the new process until this information expires (by default after 100 seconds).
285 26 Axel Neumann
286 1 Pau Escrich
287 29 Axel Neumann
288
289
h2. Unicast Host Network Announcements (UHNA)
290
291 26 Axel Neumann
A Host Network Announcements (HNA) describes the advertisement of IP addresses and networks by a node to other nodes in the mesh.
292 29 Axel Neumann
Typically (but not with BMX6), several nodes can announce the same or overlapping HNAs at the same time.
293
Announced networks do overlap if they are equal or one being a subset of another (eg. 10.1.1.0/24 is a subset and overlapped by 10.1.0.0/16).
294 26 Axel Neumann
Packets with a destination address matching an announced networks will be routed toward any node that originated a corresponding HNA.
295
Therefore these HNA types may also be called anycast HNA.
296
297 30 Axel Neumann
In bmx6, HNAs have an unicast nature (UHNAs) because each network can only be announced once and announced networks MUST NOT overlap (See also [[Wiki#Blocked-Nodes]]).
298 26 Axel Neumann
This way it can be ensured that the destination of an UHNA routed packet is exactly known.
299
300
In a sense the origination and propagation (by intermediate nodes) of UHNA announcements can be thought of a promise that guarantees:
301
1. All packets with a destination address matching an announced UHNA network will be routed exactly to the node (with the global ID) that originated the UHNA and
302
2. each node on the forwarding path towards the originator of the UHNA is supporting this promise.
303
304
By default, Bmx6 only announces primary and non-primary interface addresses via UHNAs.
305 1 Pau Escrich
The auto address configuration ensures that interface addresses are unique.
306 26 Axel Neumann
307 1 Pau Escrich
Using UHNAs for the announcements of networks requires a strict coordination to ensure that no network is announced twice.
308
309
Technically, multiple UHNAs, each wrapped into a single message, are aggregated into a UHNA frame and attached to the description of a node.
310
311 32 Axel Neumann
If Bmx6 is configured in IPv6 mode only IPv6 UHNAs can be announced and in IPv4 mode only IPv4 UHNAs
312
313
314 31 Axel Neumann
h3. UHNA Configuration
315 30 Axel Neumann
316
The announcement of UHNAs can be configured with the --unicastHna or -u parameter followed by a network specification in ip/prefixlen notation.
317
By default all interface addresses are announced via UHNAs. However, this can be disabled by setting the --dev subparameter /announce or /a to 0.
318
319
The following example reconfigures an already running bmx6 daemon (in IPv6 mode) to UHNA announce the network fd00:ffff:ffff:ffff::/64 and fd01:ffff:ffff::/48.
320
By omitting the --connect / -c parameter, the same could be configured as startup parameter for bmx6.
321
<pre>
322
bmx6 -c u=fd00:ffff:ffff:ffff::/64 u=fd01:ffff:ffff::/48
323
</pre>
324
325
An already active announcement can be removed by preceeding the network with the '-' char:
326
<pre>
327
bmx6 -c u=-fd00:ffff:ffff:ffff::/64
328
</pre>
329
330
Before bmx6 accepts a dynamically configured UHNA announcement it checks if this UHNA is not overlapping with an already existing UHNA announcement form another node.
331
If this is the case the configuration will fail.
332
To check if a chain of dynamic commands would be accepted by a bmx6 daemon without actually applying it, the --test command may follow the --connect /-c command.
333
334
335 26 Axel Neumann
336 29 Axel Neumann
h2. Tunnel Announcements
337 26 Axel Neumann
338 27 Axel Neumann
339 32 Axel Neumann
Tunnel announcements offer an alternative mechanism to propagate routes. 
340 59 Axel Neumann
Tunnel announcements are currently only implemented for Bmx6-IPv6 mode. 
341
However, in IPv6 mode IPv6 and IPv4 networks can be announced.
342
In contrast to UHNAs, using tunnel announcements, the same or overlapping networks can be announced from different nodes. Tunnel announcements are an offer from the originating node to other nodes. Other nodes can take the offer or not. For example several nodes in a network may offer to share their DSL connection by doing a default-route (0.0.0.0/0 or ::/0) tunnel announcement.
343 1 Pau Escrich
Other nodes looking for a route to the internet (a default route) can choose between the multiple offers by establishing a tunnel to one specific of the offering nodes.
344
Therefore an unidirectional (onw-way) tunnel is established from the searching to the offering node.
345 46 Axel Neumann
At the searching node, the remote (outer) tunnel address is configured with an UHNA address (usually the primary address) of the offering node.
346
The networks advertised with the tunnel announcements are configured at the client side as routes via (into) the unidirectional tunnel.
347 1 Pau Escrich
348
This way, each node can make an individual choice between networks offered via tunnel announcements.
349
The automatic selection can be specified via a policy description that considers parameters such as advertised bandwidth, path metric, trust in specific GW nodes, hysteresis, ... .
350 26 Axel Neumann
Since an UHNA address is used as the outer (remote) tunnel address, the client end of the tunnel can be sure that all packets routed into the tunnel will indeed end up at the intended GW node (see [[Wiki#Unicast-Host-Network-Announcements-UHNA]]).
351 29 Axel Neumann
352 59 Axel Neumann
Technically, multiple tunnel announcements, each wrapped into a single tun4/6in6-net message, are aggregated into a tun4/6in6-net frame and attached to the description of a node.
353 1 Pau Escrich
354 32 Axel Neumann
Tunnel announcements are also used for redistributing routes from other routing protocols (see [[Wiki#Quagga-Plugin]]) into a bmx6 zone. 
355 1 Pau Escrich
Therefore, each announcements message is decorated with a route-type field indicating the routing protocol that exported the route for being redistributed.
356 31 Axel Neumann
357 1 Pau Escrich
358 31 Axel Neumann
h3. Tunnel Configuration and Debugging
359 33 Axel Neumann
360 34 Axel Neumann
In general, a specific tunnel configuration is described from two perspectives:
361 32 Axel Neumann
* Gateway (GW) nodes or just GWs are offering GW services to networks via the advertizement of tunnel announcements and the provisioning of tunnel-end-points.
362 1 Pau Escrich
* GW-client nodes (or just GW-clients) that are searching for GWs with tunnel endpoints and routing services to networks.
363
364
A node can (and usually is) operating in both modes (as GW and as GW-client). 
365 59 Axel Neumann
But regarding a specific network each node is operating either in GW mode (thus, offering GW-services to that network) or in GW-client mode (thus, searching and using GW-services to that network)!
366 1 Pau Escrich
367
368
Remark: Since master commit f2fd75072f7dc4738069be6c69625419b9cc7767 the syntax for configuring tunnels has changed.
369
In the following the new syntax is explained. 
370
For the old syntax please use the build-in --help and --verboseHelp of the binary you are using
371 59 Axel Neumann
372
373
h4. Tunnel Device Configuration
374
375
Operation in GW and/or GW-client mode implies the configuration of a bmx6 tunnel device and the IPv4 and/or IPv6 addresses that shall be used for tunnel traffic.
376
The following command dynamically configures:
377
* A linux ip4/6in6 tunnel device called bmx6Default (check it with <pre>ip link</pre> command)
378
* Assignes the address 10.10.0.1 and 2012:0:0:1000::1 to the tunnel interface and uses them for outgoing tunnel traffic
379
* Makes a tunnel announcement for these networks so that other nodes can select it for tunneling packets to this node.
380
<pre>
381
bmx6 -c tunDev=Default /tun4Address=10.10.0.1/24 /tun6Address=2012:0:0:1000::1/64
382
</pre>
383
384 58 Axel Neumann
385
386 1 Pau Escrich
h4. Gateway Nodes
387
388 58 Axel Neumann
The advertisement of a tunnel endpoint to a network can be configured with the --tunIn=<arbitrary name>  and /network=<network> argument and an optional bandwidth specification (given as bits per second) using the /bandwidth or /b sub parameter.
389
Announcement can be removed by preceeding the name argument with a '-' char. 
390 33 Axel Neumann
The configuration can be done during daemon startup or dynamically (using --connect / -c parameter). 
391 1 Pau Escrich
392
The following command dynamically configures the advertisement of the following routes:
393 33 Axel Neumann
* An IPv4 default route 0.0.0.0/0 with a bandwidth of 32 Mbps.
394 58 Axel Neumann
* A more specific route to 10.10.0.0/16 with a bandwidth of 10 Mbps (could be a local v4 Network).
395 33 Axel Neumann
* An IPv6 route to the [RFC 4291] designated 2000::/3 global unicast address space with a bandwidth of 16 Mbps.
396 58 Axel Neumann
* A more specific route to the 2012:1234::/32 IPv6 space at 10 Mbps (could be a local v6 Network).
397 32 Axel Neumann
398 1 Pau Escrich
<pre>
399 58 Axel Neumann
bmx6 -c tunIn=def4Offer /n=0.0.0.0/0 /b=32000000  tunIn=local4 /n=10.10.0.0/16 /b=10000000  tunIn=def6Offer /n=2000::/3 /b=16000000  tunIn=local6 /n=2012:1234::/32 /b=10000000
400 1 Pau Escrich
</pre>
401
402 34 Axel Neumann
One aspect that must be considered when configuring GW nodes is that tunnels are unidirectional from the GW client to the GW.
403
But clients usually also need a route back from the GW to the client to allow a bidirectional communication.
404 1 Pau Escrich
405 34 Axel Neumann
One (however not recommended) option would be that GW clients are using their primary address as source address for all packets routed into the GW tunnel because a route from the GW to the GW-client via the client's primary address already exist. However, by default, the client's primary address is an autoconfigured ULA address which is not routable outside the bmx6 network. Also the primary address is either an IPv4 or an IPv6 address and can only be used to route to a corresponding destination network.
406 1 Pau Escrich
407 34 Axel Neumann
The recommended procedure to let clients use addresses that are routable outside of the bmx6 cloud is that also GW client nodes advertize a host-address via UHNA or tunnel announcements. In the latter (recommended) case, the client node also appears as a GW node to its private address space used for communication with other remote networks. To support this recommended case, the GW node must also be configured as a GW client searching for tunnel announcements from it's potential GW-client nodes to their (rather small) private (but outside routable) address space. The details for such configuration are described in the following section. 
408
However, for completeness a simple configuration for the GW-node to search for back routes to clients is given here. The following commands essentially configures a GW node to:
409 45 Axel Neumann
* use the IP addresses 10.254.10.1 and 2012:1234:5678:90ab::1 for tunnel traffic
410 46 Axel Neumann
* search and automatically configure back-wards tunnel to nodes that advertise an IPv4 prefix with a minimum length of 24 and are within the range of 10.254.0.0/16
411 45 Axel Neumann
* search and automatically configure back-wards tunnel to nodes that advertise an IPv6 prefix with a minimum length of 64 and are within the range of 2012:1234:5678::/48
412 1 Pau Escrich
413 34 Axel Neumann
<pre>
414 46 Axel Neumann
bmx6 -c tun4Address=10.254.10.1/32 tun6Address=2012:1234:5678:1::1/64 
415
bmx6 -c tunOut=v4Nodes /network=10.254.0.0/16 /minPrefixLen=24
416
bmx6 -c tunOut=v6Nodes /network=2012:1234:5678::/48 /minPrefixLen=64
417 34 Axel Neumann
</pre>
418
419 46 Axel Neumann
For more information please see [[Wiki#Gateway-Client-Nodes]].
420 34 Axel Neumann
421
422
423 1 Pau Escrich
h4. Gateway-Client Nodes
424 33 Axel Neumann
425 1 Pau Escrich
The configuration of GW clients can be simple but also, depending on the preferences of a desired GW-selection policy, very complex.
426
427
A general requirement for GW clients is the configuration of source addresses for all outgoing tunnels.
428
At least one network address must be configured for IPv6 and/or IPv4 tunnels using the the --tun4Address and/or --tun6Address parameters.
429 46 Axel Neumann
The specified network address will automatically be advertized as tunnel announcements, allowing the GW client to be reachable via the given addresses.
430 1 Pau Escrich
Thereby, each GW client node is also a GW node to its own (usually small) tunnel address space.
431
The selection of this address should be coordinated with GW administrators since (depending on the GW connection to other networks) only specific addresses are routable and considered to be originated from the bmx6 cloud.
432
433 46 Axel Neumann
In the following simple example a GW-client node is:
434
* specifying its own tunnel addresses for IPv4 and IPv6
435
* searching for any other kind of offered IPv4 and v6 tunnels
436 1 Pau Escrich
437 46 Axel Neumann
<pre>
438
bmx6 -c tun4Address=10.254.10.123/32 tun6Address=2012:1234:5678:123::1/64 
439
bmx6 -c tunOut=v4Default /network=0.0.0.0/0 tunOut=v6Default /network=::/0
440
</pre>
441
442
443
The disadvantage of the above configured tunnel selection policy is that offered tunnels are selected based on the path metric in the bmx6 cloud, ignoring the prefix-length of announced tunnels (routes that are more specific than others).
444
445
Imagine the following address assignment policy for the IPv4. The general idea can be straight translated to IPv6.
446
* Most nodes in the mesh cloud announce their private address ranges with a prefix length equal or larger than 24 and somewhere in the range of 10.254.0.0/16. Announcements of this type should always be preferred, even if any of the following announced types has a better end-to-end metric.
447
448
* Some BGP GW nodes are connected to other mesh clouds/areas of the same overall community network. These clouds are operating in a different IPv4 range (than 10.254.0.0/16) but always somewhere in the range of 10.0.0.0/8. Route announcements of this type should be preferred over the announcement of a default route. 
449
450
* Some DSL GW nodes are offering to share their DSL line and are announcing a default route (0.0.0.0/0). Only default route announcements from two well known GWs (with hostname pepe and paula) are acceptible. To mitigate the effects of GW switching if both GWs show a similar end-to-end metric a GW switch should only happen if the other GW is at least 30% better.
451
452
The following configuration configures a GW client respectively:
453
454
<pre>
455
bmx6 -c tun4Address=10.254.10.123/32
456
bmx6 -c tunOut=v4Nodes /network=10.254.0.0/16 /minPrefixLen=24 /ipMetric=2001
457
bmx6 -c tunOut=v4Clouds /network=10.0.0.0/8 /maxPrefixLen=16 bgp=1 /ipMetric=2002
458
bmx6 -c tunOut=-v4Default # revert the above configured v4 tunnel search
459
bmx6 -c tunOut=v4DefaultPepe  /network=0.0.0.0/0 /maxPrefixLen=0 /name=pepe  /hysteresis=30 /ipMetric=2003
460
bmx6 -c tunOut=v4DefaultPaula /network=0.0.0.0/0 /maxPrefixLen=0 /name=paula /hysteresis=30 /ipMetric=2003
461
</pre>
462 1 Pau Escrich
463 33 Axel Neumann
464
h4. Tunnel Status Information
465
466 36 Axel Neumann
Tunnel status information can be accessed with the --tunnels parameters.
467 29 Axel Neumann
468 10 Axel Neumann
469 1 Pau Escrich
470
471
h2. Bmx6 Plugins
472
473 36 Axel Neumann
h3. Compile and Install
474 1 Pau Escrich
475 36 Axel Neumann
To compile and install bmx6 daemon and all bmx6 plugins simply do:
476
<pre>
477
make build_all
478
sudo make install_all
479
</pre>
480 1 Pau Escrich
481 36 Axel Neumann
However. specific requirements may need to be fulfilled for some plugins in order to compile correctly.
482
These requirements are described in the corresponding plugin section.
483 32 Axel Neumann
484
485 1 Pau Escrich
486 36 Axel Neumann
h2. Config Plugin
487 1 Pau Escrich
488 8 Axel Neumann
489 36 Axel Neumann
h3. Requirements
490 1 Pau Escrich
491 8 Axel Neumann
uci libs are needed for the bmx6-config plugin.
492
To install it do:
493 1 Pau Escrich
<pre>
494 8 Axel Neumann
wget http://downloads.openwrt.org/sources/uci-0.7.5.tar.gz
495
tar xzvf uci-0.7.5.tar.gz
496
cd uci-0.7.5
497 1 Pau Escrich
make
498 8 Axel Neumann
sudo make install
499
</pre>
500 1 Pau Escrich
501 8 Axel Neumann
Depending on your system there happens to be an error during compilation.
502
Then edit cli.c and change line 465 to: @ char *argv[MAX_ARGS+2]; @
503
504 36 Axel Neumann
h3. Compile and Install
505 8 Axel Neumann
506
<pre>
507 36 Axel Neumann
make -C lib/bmx6_uci_config/ 
508
sudo make -C lib/bmx6_uci_config/ install
509 8 Axel Neumann
</pre>
510
511
512 36 Axel Neumann
h3. Usage
513 8 Axel Neumann
514
515
516 36 Axel Neumann
h2. Json Plugin
517 8 Axel Neumann
518
519 36 Axel Neumann
h3. Requirements
520 1 Pau Escrich
521 8 Axel Neumann
* json-c for bmx6_json plugin (debian package: libjson0 libjson0-dev)
522 1 Pau Escrich
523 8 Axel Neumann
524 1 Pau Escrich
json-c developer libs are needed!
525 8 Axel Neumann
For further reading check: http://json.org/ or https://github.com/jehiah/json-c
526
527
Note for debian sid:
528
The debian package libjson0-dev 0.10-1 seems to miss the file /usr/include/json/json_object_iterator.h
529
Manually copying it from the below mentioned json-c_0.10.orig.tar.gz archive helps.
530
531
532
To install manually (only if NOT installed via debian or other package management system):
533
<pre>
534
wget http://ftp.de.debian.org/debian/pool/main/j/json-c/json-c_0.10.orig.tar.gz
535
tar xzvf json-c_0.10.orig.tar.gz
536 1 Pau Escrich
cd json-c..
537 8 Axel Neumann
./configure ; make ; make install; ldconfig
538
</pre>
539
540
541 36 Axel Neumann
h3. Compile and Install
542 8 Axel Neumann
543 36 Axel Neumann
To compile and install only the  bmx6 json plugins:
544 1 Pau Escrich
<pre>
545 36 Axel Neumann
make -C lib/bmx6_json/ 
546
sudo make -C lib/bmx6_json/ install
547 8 Axel Neumann
</pre>
548
549
550 36 Axel Neumann
h3. Usage
551 3 Axel Neumann
552 35 Axel Neumann
553
554 36 Axel Neumann
h2. SMS Plugin
555 35 Axel Neumann
556 47 Pau Escrich
This plug-in uses routing packets to transmit any information from one node to the
557
whole network. The good point is that propagation works even if there is no continuous data-
558
path. Even though the WiFi network is under bad conditions (because the Wireless noise,
559
distance between nodes, etc...), the data will be propagated. However in the current implemen-
560 48 Simó Albert i Beltran
tation, there exist a maximum size limit of 240 Bytes for each file.
561 47 Pau Escrich
562
The API of the sms plug-in is very simple. It simply clones the content of one or more files
563
given by one node to all other nodes. All other nodes can do the same. Once started, each
564 48 Simó Albert i Beltran
node will have two directories:/var/run/bmx6/sms/rcvdSms and /var/run/bmx6/sms/sendSms. Files
565
put into the sendSms folder will be cloned to all other nodes inside rcvdSms folder.
566 47 Pau Escrich
QMP is using this feature for several things. The positioning Map information is transmitted
567
using it. There is a chat in web interface which uses it too. And in the future we are planning
568
to use it for more purposes like statistics, captive portal, MAC filter rules, etc...
569 35 Axel Neumann
570
571 36 Axel Neumann
h2. Quagga Plugin
572 35 Axel Neumann
573
The bmx6 quagga plugin can be used to exchange routes with a quagga/zebra daemon.
574
Both, export and redistribution of routes is supported.
575
576
577 36 Axel Neumann
h3. Requirements, Compile, and Install
578 35 Axel Neumann
579 41 Axel Neumann
h4. Quagga
580 1 Pau Escrich
581 41 Axel Neumann
Quagga version 0.99.21 must be patched for bmx6 support.
582
583
The bmx6 directory lib/bmx6_quagga/patches/ contains patches to enable quagga for bmx6 support.
584
The following example provides instructions for obtaining, patching, compiling, and installing quagga:
585
586
<pre>
587
wget http://download.savannah.gnu.org/releases/quagga/quagga-0.99.21.tar.gz
588
tar xzvf quagga-0.99.21.tar.gz
589
cd quagga-0.99.21
590
patch -p1 < ../bmx6/lib/bmx6_quagga/patches/quagga-0.99.21.tar.diff
591
./configure
592
make
593
sudo make install
594
</pre>
595
596
For further instructions to obtain, patch, compile, and install quagga please have a look at:
597 1 Pau Escrich
the file lib/bmx6_quagga/patches/README in the bmx6 sources.
598
599 41 Axel Neumann
h4. Bmx6
600
601 35 Axel Neumann
To compile and install the bmx6 part of the quagga plugin simply do:
602
<pre>
603 36 Axel Neumann
make -C lib/bmx6_quagga/ 
604
sudo make -C lib/bmx6_quagga/ install
605 2 Pau Escrich
</pre>
606 1 Pau Escrich
607 36 Axel Neumann
608 37 Axel Neumann
h3. Usage
609 38 Axel Neumann
610
To use the bmx6 quagga plugin it must be loaded during bmx6 daemon startup with the @ plugin=bmx6_quagga.so @ argument. 
611
Alternatively a plugin section can be defined in the bmx6 config file like this:
612
<pre>
613
config 'plugin'
614
        option 'plugin' 'bmx6_quagga.so'
615
</pre>
616
617
Once the plugin is successfully loaded, the bmx6 daemon will try to connect with the zebra process (via the ZAPI socket) 
618
and new parameters for exchanging routes with quagga/zebra daemon are enabled.
619
620
A quick documentation of the quagga-related parameters is available via the --help and --verboseHelp option.
621
If the quagga-enabled daemon is already running @ bmc6 -c verboseHelp /r=1 @ will print all currently supported parameters.
622 1 Pau Escrich
623
624 39 Axel Neumann
625
626 41 Axel Neumann
h3. Redistributing routes (from quagga/zebra to bmx6)
627 39 Axel Neumann
628
Redistribution of routes is configurable with the --redistribute parameter.
629 38 Axel Neumann
Similar to the --tunOutNet parameter,  --redistribute must be given with an arbitrary name for referencing to a specific redistribution directive and further sub-criterias.
630
631
Further mandatory sub-parameters are /bandwidth and at least one (to-be redistributed route type).
632
The following route types exist:
633
<pre>
634
  /system <VAL>                          def: 0       range: [ 0 , 1 ]
635
  /kernel <VAL>                          def: 0       range: [ 0 , 1 ]
636
  /connect <VAL>                         def: 0       range: [ 0 , 1 ]
637
  /rip <VAL>                             def: 0       range: [ 0 , 1 ]
638
  /ripng <VAL>                           def: 0       range: [ 0 , 1 ]
639
  /ospf <VAL>                            def: 0       range: [ 0 , 1 ]
640
  /ospf6 <VAL>                           def: 0       range: [ 0 , 1 ]
641
  /isis <VAL>                            def: 0       range: [ 0 , 1 ]
642
  /bgp <VAL>                             def: 0       range: [ 0 , 1 ]
643
  /babel <VAL>                           def: 0       range: [ 0 , 1 ]
644
  /hsls <VAL>                            def: 0       range: [ 0 , 1 ]
645
  /olsr <VAL>                            def: 0       range: [ 0 , 1 ]
646
  /batman <VAL>                          def: 0       range: [ 0 , 1 ]
647
</pre>
648
649 1 Pau Escrich
Only quagga/zebra routes types that are explicitly specified will be redistributed to the bmx6 network.
650 38 Axel Neumann
In addition, one usually wants to filter out networks from being redistributed based on their prefix.
651
Therefore the sub parameters /network, /minPrefixLen, and /maxPrefixLen can be used in the same way as for the --tunOutNet parameter.
652
653 41 Axel Neumann
h4. Route Aggregation
654 40 Axel Neumann
655 1 Pau Escrich
By default, maximum aggregation of to-be redistributed routes is enabled.
656 40 Axel Neumann
This means that to-be redistributed neighboring and overlapping networks with the same route type and bandwidth are aggregated if possible.
657
The extend of aggregation can be controlled with the /aggregatePrefixLen sub-parameter.
658
The given value limits the aggregation to a minimum prefix length.
659
The default of 0 defines maximum aggregation whenever possible which may not be wanted.
660
661 45 Axel Neumann
For example the GW node may be configured to redistribute the following routes:
662 40 Axel Neumann
663 45 Axel Neumann
* 10.254.20.1/32
664
* 10.254.20.0/24
665
* 10.254.21.0/24
666
* 10.254.22.0/24
667 40 Axel Neumann
* 0.0.0.0/0
668
669
The following bmx6 configuration would aggregate all 5 routes into a single 0.0.0.0/0 tunnel announcement since 0.0.0.0/0 is overlapping any other more-specific route:
670
<pre>
671
redistribute=ipv4 /bandwidth=10000000 /kernel=1 /aggregatePrefixLen=0
672
</pre>
673
674
This aggregation may be too generic since GW-client nodes are usually looking for more specific routes to specific destination.
675
The following configuration would aggregate only routes with a prefix-len larger than 16:
676
677
<pre>
678
redistribute=ipv4 /bandwidth=10000000 /kernel=1 /aggregatePrefixLen=16
679
</pre>
680
681
Resulting in the following aggregations:
682 45 Axel Neumann
* 10.254.20.1/32: Aggregated (sub-network of 10.254.20.0/24)! NOT announced!
683
* 10.254.20.0/24: Aggregated with 10.254.21.0/24! Announced as 10.254.20.0/23 
684
* 10.254.21.0/24: Aggregated with 10.254.20.0/24! Announced as 10.254.20.0/23 
685
* 10.254.22.0/24: Not aggregatable into larger network! Announced as is!
686 40 Axel Neumann
* 0.0.0.0/0:      Not aggregated (prefix-len smaller than /aggregatePrefixLen=16)! Announced as is!
687
688 38 Axel Neumann
689
690 41 Axel Neumann
h3. Exporting routes (from bmx6 to quagga/zebra)
691 42 Axel Neumann
692
693
For exporting routes received as bmx6 tunnel announcements, the /exportDistance can be used as a subparameter of the --tunOut parameter.
694
The default value of /exportDistance is 256 which is considered as infinit or disabled.
695
Any lower configured value will export the corresponding outgoing tunnel (once it becomes active) with the given distance to quagga/zebra.
696
697
A GW node usually only wants to export bmx6 routes that were announced by other (non-GW) bmx6 nodes in the mesh.
698
699 43 Axel Neumann
In the following example there are 3 other bmx6 nodes, each tunnel announcing a private /32 network.
700 1 Pau Escrich
701 43 Axel Neumann
The given parametrization configures a GW node to search, establish related tunnels, and export all tunnel announcements for other bmx6 daemons that have a prefix-length smaller that /27 and fall into the network range of 10.254.0.0/16:
702
703 1 Pau Escrich
<pre>
704 43 Axel Neumann
plugin=bmx6_quagga.so tunOut=privV4Nets /network=10.254.0.0/16 /minPrefixLen=27 /exportDistance=0
705
</pre>
706
707
Checking the export from the quagga perspective show the following:
708
<pre>
709
root@mlc1001:~# telnet localhost zebra
710
Trying ::1...
711
Trying 127.0.0.1...
712
Connected to localhost.
713
Escape character is '^]'.
714
715
Hello, this is Quagga (version 0.99.21).
716
Copyright 1996-2005 Kunihiro Ishiguro, et al.
717
718
User Access Verification
719
Password:
720
721
Router> show ip route
722
Codes: K - kernel route, C - connected, S - static, R - RIP,
723
       O - OSPF, I - IS-IS, B - BGP, H - HSLS, o - OLSR,
724
       b - BATMAN, x - BMX6, A - Babel,
725
       > - selected route, * - FIB route
726
727
K>* 0.0.0.0/0 via 10.0.0.1, eth0
728
C>* 10.0.0.0/11 is directly connected, eth0
729
x>* 10.254.10.0/32 [0/1024] is directly connected, bmx6_out0000, 00:03:24
730
C * 10.254.10.1/32 is directly connected, bmx6_out0003
731
C * 10.254.10.1/32 is directly connected, bmx6_out0002
732
C * 10.254.10.1/32 is directly connected, bmx6_out0001
733
C * 10.254.10.1/32 is directly connected, bmx6_out0000
734
C>* 10.254.10.1/32 is directly connected, bmx6_in0000
735
x>* 10.254.10.2/32 [0/1024] is directly connected, bmx6_out0001, 00:03:24
736
x>* 10.254.10.3/32 [0/1024] is directly connected, bmx6_out0002, 00:03:24
737
x>* 10.254.10.4/32 [0/1024] is directly connected, bmx6_out0003, 00:03:24
738
C>* 127.0.0.0/8 is directly connected, lo
739 42 Axel Neumann
</pre>