2 * Copyright (c) 1998-2007 The TCPDUMP project
3 * Copyright (c) 2009 Florian Forster
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that: (1) source code
7 * distributions retain the above copyright notice and this paragraph
8 * in its entirety, and (2) distributions including binary code include
9 * the above copyright notice and this paragraph in its entirety in
10 * the documentation or other materials provided with the distribution.
11 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
12 * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
13 * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14 * FOR A PARTICULAR PURPOSE.
16 * Original code by Hannes Gredler <hannes@gredler.at>
17 * IPv6 additions by Florian Forster <octo at verplant.org>
20 /* \summary: Optimized Link State Routing Protocol (OLSR) printer */
22 /* specification: RFC 3626 */
28 #include "netdissect-stdinc.h"
30 #include "netdissect.h"
31 #include "addrtoname.h"
35 * RFC 3626 common header
38 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
39 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
40 * | Packet Length | Packet Sequence Number |
41 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
42 * | Message Type | Vtime | Message Size |
43 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
44 * | Originator Address |
45 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
46 * | Time To Live | Hop Count | Message Sequence Number |
47 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
51 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
52 * | Message Type | Vtime | Message Size |
53 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
54 * | Originator Address |
55 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
56 * | Time To Live | Hop Count | Message Sequence Number |
57 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
61 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
66 nd_uint16_t packet_len;
67 nd_uint16_t packet_seq;
70 #define OLSR_HELLO_MSG 1 /* rfc3626 */
71 #define OLSR_TC_MSG 2 /* rfc3626 */
72 #define OLSR_MID_MSG 3 /* rfc3626 */
73 #define OLSR_HNA_MSG 4 /* rfc3626 */
74 #define OLSR_POWERINFO_MSG 128
75 #define OLSR_NAMESERVICE_MSG 130
76 #define OLSR_HELLO_LQ_MSG 201 /* LQ extensions olsr.org */
77 #define OLSR_TC_LQ_MSG 202 /* LQ extensions olsr.org */
79 static const struct tok olsr_msg_values[] = {
80 { OLSR_HELLO_MSG, "Hello" },
81 { OLSR_TC_MSG, "TC" },
82 { OLSR_MID_MSG, "MID" },
83 { OLSR_HNA_MSG, "HNA" },
84 { OLSR_POWERINFO_MSG, "Powerinfo" },
85 { OLSR_NAMESERVICE_MSG, "Nameservice" },
86 { OLSR_HELLO_LQ_MSG, "Hello-LQ" },
87 { OLSR_TC_LQ_MSG, "TC-LQ" },
117 struct olsr_hello_link {
118 nd_uint8_t link_code;
139 /** gateway HNA flags */
140 enum gateway_hna_flags {
141 GW_HNA_FLAG_LINKSPEED = 1 << 0,
142 GW_HNA_FLAG_IPV4 = 1 << 1,
143 GW_HNA_FLAG_IPV4_NAT = 1 << 2,
144 GW_HNA_FLAG_IPV6 = 1 << 3,
145 GW_HNA_FLAG_IPV6PREFIX = 1 << 4
148 /** gateway HNA field byte offsets in the netmask field of the HNA */
149 enum gateway_hna_fields {
154 GW_HNA_V6PREFIXLEN = 4,
159 #define OLSR_EXTRACT_LINK_TYPE(link_code) (link_code & 0x3)
160 #define OLSR_EXTRACT_NEIGHBOR_TYPE(link_code) (link_code >> 2)
162 static const struct tok olsr_link_type_values[] = {
163 { 0, "Unspecified" },
170 static const struct tok olsr_neighbor_type_values[] = {
171 { 0, "Not-Neighbor" },
173 { 2, "Symmetric-MPR" },
177 struct olsr_lq_neighbor4 {
179 nd_uint8_t link_quality;
180 nd_uint8_t neighbor_link_quality;
184 struct olsr_lq_neighbor6 {
186 nd_uint8_t link_quality;
187 nd_uint8_t neighbor_link_quality;
191 #define MAX_SMARTGW_SPEED 320000000
194 * Convert an encoded 1 byte transport value (5 bits mantissa, 3 bits exponent)
195 * to an uplink/downlink speed value
197 * @param value the encoded 1 byte transport value
198 * @return the uplink/downlink speed value (in kbit/s)
200 static uint32_t deserialize_gw_speed(uint8_t value) {
208 if (value == UINT8_MAX) {
209 /* maximum value: also return maximum value */
210 return MAX_SMARTGW_SPEED;
213 speed = (value >> 3) + 1;
224 * macro to convert the 8-bit mantissa/exponent to a double float
225 * taken from olsr.org.
227 #define VTIME_SCALE_FACTOR 0.0625
228 #define ME_TO_DOUBLE(me) \
229 (double)(VTIME_SCALE_FACTOR*(1+(double)(me>>4)/16)*(double)(1<<(me&0x0F)))
232 * print a neighbor list with LQ extensions.
235 olsr_print_lq_neighbor4(netdissect_options *ndo,
236 const u_char *msg_data, u_int hello_len)
238 const struct olsr_lq_neighbor4 *lq_neighbor;
240 while (hello_len >= sizeof(struct olsr_lq_neighbor4)) {
242 lq_neighbor = (const struct olsr_lq_neighbor4 *)msg_data;
243 ND_TCHECK_SIZE(lq_neighbor);
245 ND_PRINT("\n\t neighbor %s, link-quality %.2f%%"
246 ", neighbor-link-quality %.2f%%",
247 GET_IPADDR_STRING(lq_neighbor->neighbor),
248 ((double) GET_U_1(lq_neighbor->link_quality)/2.55),
249 ((double) GET_U_1(lq_neighbor->neighbor_link_quality)/2.55));
251 msg_data += sizeof(struct olsr_lq_neighbor4);
252 hello_len -= sizeof(struct olsr_lq_neighbor4);
260 olsr_print_lq_neighbor6(netdissect_options *ndo,
261 const u_char *msg_data, u_int hello_len)
263 const struct olsr_lq_neighbor6 *lq_neighbor;
265 while (hello_len >= sizeof(struct olsr_lq_neighbor6)) {
267 lq_neighbor = (const struct olsr_lq_neighbor6 *)msg_data;
268 ND_TCHECK_SIZE(lq_neighbor);
270 ND_PRINT("\n\t neighbor %s, link-quality %.2f%%"
271 ", neighbor-link-quality %.2f%%",
272 GET_IP6ADDR_STRING(lq_neighbor->neighbor),
273 ((double) GET_U_1(lq_neighbor->link_quality)/2.55),
274 ((double) GET_U_1(lq_neighbor->neighbor_link_quality)/2.55));
276 msg_data += sizeof(struct olsr_lq_neighbor6);
277 hello_len -= sizeof(struct olsr_lq_neighbor6);
285 * print a neighbor list.
288 olsr_print_neighbor(netdissect_options *ndo,
289 const u_char *msg_data, u_int hello_len)
293 ND_PRINT("\n\t neighbor\n\t\t");
296 while (hello_len >= sizeof(nd_ipv4)) {
297 /* print 4 neighbors per line */
298 ND_PRINT("%s%s", GET_IPADDR_STRING(msg_data),
299 neighbor % 4 == 0 ? "\n\t\t" : " ");
301 msg_data += sizeof(nd_ipv4);
302 hello_len -= sizeof(nd_ipv4);
309 olsr_print(netdissect_options *ndo,
310 const u_char *pptr, u_int length, int is_ipv6)
313 const struct olsr_common *common;
314 const struct olsr_msg4 *msg4;
315 const struct olsr_msg6 *msg6;
316 const struct olsr_hello *hello;
317 const struct olsr_hello_link *hello_link;
318 const struct olsr_tc *tc;
319 const struct olsr_hna4 *hna;
322 u_int msg_type, msg_len, msg_tlen, hello_len;
323 uint16_t name_entry_type, name_entry_len;
324 u_int name_entry_padding;
325 uint8_t link_type, neighbor_type;
326 const u_char *tptr, *msg_data;
328 ndo->ndo_protocol = "olsr";
331 nd_print_protocol_caps(ndo);
332 ND_PRINT("v%u", (is_ipv6) ? 6 : 4);
334 if (length < sizeof(struct olsr_common)) {
338 ND_TCHECK_LEN(tptr, sizeof(struct olsr_common));
340 ptr.common = (const struct olsr_common *)tptr;
341 length = ND_MIN(length, GET_BE_U_2(ptr.common->packet_len));
343 ND_PRINT(", seq 0x%04x, length %u",
344 GET_BE_U_2(ptr.common->packet_seq),
347 tptr += sizeof(struct olsr_common);
350 * In non-verbose mode, just print version.
352 if (ndo->ndo_vflag < 1) {
356 while (tptr < (pptr+length)) {
359 const struct olsr_msg4 *v4;
360 const struct olsr_msg6 *v6;
362 int msg_len_valid = 0;
366 ND_TCHECK_LEN(tptr, sizeof(struct olsr_msg6));
367 msgptr.v6 = (const struct olsr_msg6 *) tptr;
368 msg_type = GET_U_1(msgptr.v6->msg_type);
369 msg_len = GET_BE_U_2(msgptr.v6->msg_len);
370 if ((msg_len >= sizeof (struct olsr_msg6))
371 && (msg_len <= length))
374 /* infinite loop check */
375 if (msg_type == 0 || msg_len == 0) {
379 ND_PRINT("\n\t%s Message (%#04x), originator %s, ttl %u, hop %u"
380 "\n\t vtime %.3fs, msg-seq 0x%04x, length %u%s",
381 tok2str(olsr_msg_values, "Unknown", msg_type),
382 msg_type, GET_IP6ADDR_STRING(msgptr.v6->originator),
383 GET_U_1(msgptr.v6->ttl),
384 GET_U_1(msgptr.v6->hopcount),
385 ME_TO_DOUBLE(GET_U_1(msgptr.v6->vtime)),
386 GET_BE_U_2(msgptr.v6->msg_seq),
387 msg_len, (msg_len_valid == 0) ? " (invalid)" : "");
388 if (!msg_len_valid) {
392 msg_tlen = msg_len - sizeof(struct olsr_msg6);
393 msg_data = tptr + sizeof(struct olsr_msg6);
395 else /* (!is_ipv6) */
397 ND_TCHECK_LEN(tptr, sizeof(struct olsr_msg4));
398 msgptr.v4 = (const struct olsr_msg4 *) tptr;
399 msg_type = GET_U_1(msgptr.v4->msg_type);
400 msg_len = GET_BE_U_2(msgptr.v4->msg_len);
401 if ((msg_len >= sizeof (struct olsr_msg4))
402 && (msg_len <= length))
405 /* infinite loop check */
406 if (msg_type == 0 || msg_len == 0) {
410 ND_PRINT("\n\t%s Message (%#04x), originator %s, ttl %u, hop %u"
411 "\n\t vtime %.3fs, msg-seq 0x%04x, length %u%s",
412 tok2str(olsr_msg_values, "Unknown", msg_type),
413 msg_type, GET_IPADDR_STRING(msgptr.v4->originator),
414 GET_U_1(msgptr.v4->ttl),
415 GET_U_1(msgptr.v4->hopcount),
416 ME_TO_DOUBLE(GET_U_1(msgptr.v4->vtime)),
417 GET_BE_U_2(msgptr.v4->msg_seq),
418 msg_len, (msg_len_valid == 0) ? " (invalid)" : "");
419 if (!msg_len_valid) {
423 msg_tlen = msg_len - sizeof(struct olsr_msg4);
424 msg_data = tptr + sizeof(struct olsr_msg4);
429 case OLSR_HELLO_LQ_MSG:
430 if (msg_tlen < sizeof(struct olsr_hello))
432 ND_TCHECK_LEN(msg_data, sizeof(struct olsr_hello));
434 ptr.hello = (const struct olsr_hello *)msg_data;
435 ND_PRINT("\n\t hello-time %.3fs, MPR willingness %u",
436 ME_TO_DOUBLE(GET_U_1(ptr.hello->htime)),
437 GET_U_1(ptr.hello->will));
438 msg_data += sizeof(struct olsr_hello);
439 msg_tlen -= sizeof(struct olsr_hello);
441 while (msg_tlen >= sizeof(struct olsr_hello_link)) {
442 int hello_len_valid = 0;
447 ND_TCHECK_LEN(msg_data, sizeof(struct olsr_hello_link));
449 ptr.hello_link = (const struct olsr_hello_link *)msg_data;
451 hello_len = GET_BE_U_2(ptr.hello_link->len);
452 link_type = OLSR_EXTRACT_LINK_TYPE(GET_U_1(ptr.hello_link->link_code));
453 neighbor_type = OLSR_EXTRACT_NEIGHBOR_TYPE(GET_U_1(ptr.hello_link->link_code));
455 if ((hello_len <= msg_tlen)
456 && (hello_len >= sizeof(struct olsr_hello_link)))
459 ND_PRINT("\n\t link-type %s, neighbor-type %s, len %u%s",
460 tok2str(olsr_link_type_values, "Unknown", link_type),
461 tok2str(olsr_neighbor_type_values, "Unknown", neighbor_type),
463 (hello_len_valid == 0) ? " (invalid)" : "");
465 if (hello_len_valid == 0)
468 msg_data += sizeof(struct olsr_hello_link);
469 msg_tlen -= sizeof(struct olsr_hello_link);
470 hello_len -= sizeof(struct olsr_hello_link);
472 ND_TCHECK_LEN(msg_data, hello_len);
473 if (msg_type == OLSR_HELLO_MSG) {
474 if (olsr_print_neighbor(ndo, msg_data, hello_len) == -1)
478 if (olsr_print_lq_neighbor6(ndo, msg_data, hello_len) == -1)
481 if (olsr_print_lq_neighbor4(ndo, msg_data, hello_len) == -1)
486 msg_data += hello_len;
487 msg_tlen -= hello_len;
493 if (msg_tlen < sizeof(struct olsr_tc))
495 ND_TCHECK_LEN(msg_data, sizeof(struct olsr_tc));
497 ptr.tc = (const struct olsr_tc *)msg_data;
498 ND_PRINT("\n\t advertised neighbor seq 0x%04x",
499 GET_BE_U_2(ptr.tc->ans_seq));
500 msg_data += sizeof(struct olsr_tc);
501 msg_tlen -= sizeof(struct olsr_tc);
503 if (msg_type == OLSR_TC_MSG) {
504 if (olsr_print_neighbor(ndo, msg_data, msg_tlen) == -1)
508 if (olsr_print_lq_neighbor6(ndo, msg_data, msg_tlen) == -1)
511 if (olsr_print_lq_neighbor4(ndo, msg_data, msg_tlen) == -1)
519 u_int addr_size = (u_int)sizeof(nd_ipv4);
522 addr_size = (u_int)sizeof(nd_ipv6);
524 while (msg_tlen >= addr_size) {
525 ND_TCHECK_LEN(msg_data, addr_size);
526 ND_PRINT("\n\t interface address %s",
527 is_ipv6 ? GET_IP6ADDR_STRING(msg_data) :
528 GET_IPADDR_STRING(msg_data));
530 msg_data += addr_size;
531 msg_tlen -= addr_size;
541 ND_PRINT("\n\t Advertised networks (total %u)",
542 (unsigned int) (msg_tlen / sizeof(struct olsr_hna6)));
544 while (msg_tlen >= sizeof(struct olsr_hna6)) {
545 const struct olsr_hna6 *hna6;
547 ND_TCHECK_LEN(msg_data, sizeof(struct olsr_hna6));
549 hna6 = (const struct olsr_hna6 *)msg_data;
551 ND_PRINT("\n\t #%i: %s/%u",
552 i, GET_IP6ADDR_STRING(hna6->network),
553 mask62plen (hna6->mask));
555 msg_data += sizeof(struct olsr_hna6);
556 msg_tlen -= sizeof(struct olsr_hna6);
563 ND_PRINT("\n\t Advertised networks (total %u)",
564 (unsigned int) (msg_tlen / sizeof(struct olsr_hna4)));
566 while (msg_tlen >= sizeof(struct olsr_hna4)) {
567 ND_TCHECK_LEN(msg_data, sizeof(struct olsr_hna4));
569 ptr.hna = (const struct olsr_hna4 *)msg_data;
571 /* print 4 prefixes per line */
572 if (!ptr.hna->network[0] && !ptr.hna->network[1] &&
573 !ptr.hna->network[2] && !ptr.hna->network[3] &&
574 !ptr.hna->mask[GW_HNA_PAD] &&
575 ptr.hna->mask[GW_HNA_FLAGS]) {
577 ND_PRINT("%sSmart-Gateway:%s%s%s%s%s %u/%u",
578 col == 0 ? "\n\t " : ", ", /* indent */
581 (ptr.hna->mask[GW_HNA_FLAGS] &
582 GW_HNA_FLAG_LINKSPEED) ? " LINKSPEED" : "",
584 (ptr.hna->mask[GW_HNA_FLAGS] &
585 GW_HNA_FLAG_IPV4) ? " IPV4" : "",
587 (ptr.hna->mask[GW_HNA_FLAGS] &
588 GW_HNA_FLAG_IPV4_NAT) ? " IPV4-NAT" : "",
590 (ptr.hna->mask[GW_HNA_FLAGS] &
591 GW_HNA_FLAG_IPV6) ? " IPV6" : "",
593 (ptr.hna->mask[GW_HNA_FLAGS] &
594 GW_HNA_FLAG_IPV6PREFIX) ? " IPv6-PREFIX" : "",
596 (ptr.hna->mask[GW_HNA_FLAGS] &
597 GW_HNA_FLAG_LINKSPEED) ?
598 deserialize_gw_speed(ptr.hna->mask[GW_HNA_UPLINK]) : 0,
600 (ptr.hna->mask[GW_HNA_FLAGS] &
601 GW_HNA_FLAG_LINKSPEED) ?
602 deserialize_gw_speed(ptr.hna->mask[GW_HNA_DOWNLINK]) : 0
607 col == 0 ? "\n\t " : ", ",
608 GET_IPADDR_STRING(ptr.hna->network),
609 mask2plen(GET_BE_U_4(ptr.hna->mask)));
612 msg_data += sizeof(struct olsr_hna4);
613 msg_tlen -= sizeof(struct olsr_hna4);
620 case OLSR_NAMESERVICE_MSG:
624 int name_entries_valid;
630 name_entries = GET_BE_U_2(msg_data + 2);
635 name_entries_valid = 0;
636 if ((name_entries > 0)
637 && ((name_entries * (4 + addr_size)) <= msg_tlen))
638 name_entries_valid = 1;
640 ND_PRINT("\n\t Version %u, Entries %u%s",
641 GET_BE_U_2(msg_data),
642 name_entries, (name_entries_valid == 0) ? " (invalid)" : "");
644 if (name_entries_valid == 0)
650 for (i = 0; i < name_entries; i++) {
651 int name_entry_len_valid = 0;
656 name_entry_type = GET_BE_U_2(msg_data);
657 name_entry_len = GET_BE_U_2(msg_data + 2);
662 if ((name_entry_len > 0) && ((addr_size + name_entry_len) <= msg_tlen))
663 name_entry_len_valid = 1;
665 ND_PRINT("\n\t #%u: type %#06x, length %u%s",
666 (unsigned int) i, name_entry_type,
667 name_entry_len, (name_entry_len_valid == 0) ? " (invalid)" : "");
669 if (name_entry_len_valid == 0)
672 /* 32-bit alignment */
673 name_entry_padding = 0;
674 if (name_entry_len%4 != 0)
675 name_entry_padding = 4-(name_entry_len%4);
677 if (msg_tlen < addr_size + name_entry_len + name_entry_padding)
680 ND_TCHECK_LEN(msg_data,
681 addr_size + name_entry_len + name_entry_padding);
684 ND_PRINT(", address %s, name \"",
685 GET_IP6ADDR_STRING(msg_data));
687 ND_PRINT(", address %s, name \"",
688 GET_IPADDR_STRING(msg_data));
689 (void)nd_printn(ndo, msg_data + addr_size, name_entry_len, NULL);
692 msg_data += addr_size + name_entry_len + name_entry_padding;
693 msg_tlen -= addr_size + name_entry_len + name_entry_padding;
694 } /* for (i = 0; i < name_entries; i++) */
696 } /* case OLSR_NAMESERVICE_MSG */
699 * FIXME those are the defined messages that lack a decoder
700 * you are welcome to contribute code ;-)
702 case OLSR_POWERINFO_MSG:
704 print_unknown_data(ndo, msg_data, "\n\t ", msg_tlen);
706 } /* switch (msg_type) */
708 } /* while (tptr < (pptr+length)) */