2 * Copyright (c) 2015 Ritesh Ranjan (r.ranjan789@gmail.com)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
29 /* \summary: - Locator/Identifier Separation Protocol (LISP) printer */
32 * specification: RFC 6830
35 * The Map-Register message format is:
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 * |Type=3 |P|S|I|R| Reserved |M| Record Count |
41 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
43 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
45 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
46 * | Key ID | Authentication Data Length |
47 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
48 * ~ Authentication Data ~
49 * +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
51 * | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
52 * R | Locator Count | EID mask-len | ACT |A| Reserved |
53 * e +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
54 * c | Rsvd | Map-Version Number | EID-Prefix-AFI |
55 * o +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
57 * d +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
58 * | /| Priority | Weight | M Priority | M Weight |
59 * | L +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
60 * | o | Unused Flags |L|p|R| Loc-AFI |
61 * | c +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
63 * +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
66 * The Map-Notify message format is:
69 * 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
70 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
71 * |Type=4 |I|R| Reserved | Record Count |
72 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
74 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
76 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
77 * | Key ID | Authentication Data Length |
78 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
79 * ~ Authentication Data ~
80 * +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
82 * | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
83 * R | Locator Count | EID mask-len | ACT |A| Reserved |
84 * e +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
85 * c | Rsvd | Map-Version Number | EID-Prefix-AFI |
86 * o +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
88 * d +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
89 * | /| Priority | Weight | M Priority | M Weight |
90 * | L +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
91 * | o | Unused Flags |L|p|R| Loc-AFI |
92 * | c +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
94 * +-> +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
101 #include "netdissect-stdinc.h"
102 #include "netdissect.h"
108 #include "addrtoname.h"
114 #define LISP_MAP_NOTIFY_IBIT_MASK 8
115 #define LISP_MAP_REGISTER_IBIT_MASK 2
118 LISP_MAP_REQUEST = 1,
122 LISP_ENCAPSULATED_CONTROL_MESSAGE = 8
131 static const struct tok lisp_type [] = {
132 { 0, "LISP-Reserved" },
133 { 1, "LISP-Map-Request" },
134 { 2, "LISP-Map-Reply" },
135 { 3, "LISP-Map-Register" },
136 { 4, "LISP-Map-Notify" },
137 { 8, "LISP-Encapsulated-Contol-Message" },
142 * P-Bit : Request for Proxy Map-Reply from the MS/MR
143 * S-Bit : Security Enhancement. ETR is LISP-SEC enabled. draft-ietf-lisp-sec
144 * I-Bit : 128 bit xTR-ID and 64 bit Site-ID present.
145 * xTR-ID and Site-ID help in differentiation of xTRs in multi xTR
146 * and multi Site deployment scenarios.
147 * R-Bit : Built for a Reencapsulating-Tunnel-Router. Used in Traffic
148 * Engineering and Service Chaining
150 static const struct tok map_register_hdr_flag[] = {
151 { 0x08000000, "P-Proxy-Map-Reply" },
152 { 0x04000000, "S-LISP-SEC-Capable" },
153 { 0x02000000, "I-xTR-ID-Present" },
154 { 0x01000000, "R-Build-For-RTR" },
155 { 0x00000100, "M-Want-Map-Notify" },
159 static const struct tok map_notify_hdr_flag[] = {
160 { 0x08000000, "I-xTR-ID-Present" },
161 { 0x04000000, "R-Build-For-RTR" },
165 static const struct tok auth_type[] = {
166 { LISP_AUTH_NONE, "None" },
167 { LISP_AUTH_SHA1, "SHA1" },
168 { LISP_AUTH_SHA256, "SHA256" },
172 static const struct tok lisp_eid_action[] = {
174 { 1, "Natively-Forward" },
175 { 2, "Send-Map-Request" },
180 static const struct tok lisp_loc_flag[] = {
181 { 0x0004, "Local-Locator" },
182 { 0x0002, "RLoc-Probed" },
183 { 0x0001, "Reachable" },
187 typedef struct map_register_hdr {
188 nd_uint8_t type_and_flag;
190 nd_uint8_t reserved_and_flag2;
191 nd_uint8_t record_count;
194 nd_uint16_t auth_data_len;
195 } lisp_map_register_hdr;
197 #define MAP_REGISTER_HDR_LEN sizeof(lisp_map_register_hdr)
199 typedef struct map_register_eid {
201 nd_uint8_t locator_count;
202 nd_uint8_t eid_prefix_mask_length;
203 nd_uint8_t act_auth_inc_res;
205 nd_uint16_t reserved_and_version;
206 nd_uint16_t eid_prefix_afi;
207 } lisp_map_register_eid;
209 #define MAP_REGISTER_EID_LEN sizeof(lisp_map_register_eid)
211 typedef struct map_register_loc {
214 nd_uint8_t m_priority;
216 nd_uint16_t unused_and_flag;
217 nd_uint16_t locator_afi;
218 } lisp_map_register_loc;
220 #define MAP_REGISTER_LOC_LEN sizeof(lisp_map_register_loc)
222 static uint8_t extract_lisp_type(uint8_t);
223 static uint8_t is_xtr_data_present(uint8_t, uint8_t);
224 static void lisp_hdr_flag(netdissect_options *, const lisp_map_register_hdr *);
225 static void action_flag(netdissect_options *, uint8_t);
226 static void loc_hdr_flag(netdissect_options *, uint16_t);
229 lisp_print(netdissect_options *ndo, const u_char *bp, u_int length)
231 uint8_t type_and_flag;
236 uint8_t record_count;
240 uint16_t map_version;
241 uint16_t packet_offset;
242 uint16_t auth_data_len;
244 const u_char *packet_iterator;
245 const u_char *loc_ip_pointer;
246 const lisp_map_register_hdr *lisp_hdr;
247 const lisp_map_register_eid *lisp_eid;
248 const lisp_map_register_loc *lisp_loc;
250 ndo->ndo_protocol = "lisp";
251 /* Check if enough bytes for header are available */
252 ND_TCHECK_LEN(bp, MAP_REGISTER_HDR_LEN);
253 lisp_hdr = (const lisp_map_register_hdr *) bp;
254 lisp_hdr_flag(ndo, lisp_hdr);
255 /* Supporting only MAP NOTIFY and MAP REGISTER LISP packets */
256 type_and_flag = GET_U_1(lisp_hdr->type_and_flag);
257 type = extract_lisp_type(type_and_flag);
258 if ((type != LISP_MAP_REGISTER) && (type != LISP_MAP_NOTIFY))
261 /* Find if the packet contains xTR and Site-ID data */
262 xtr_present = is_xtr_data_present(type, type_and_flag);
264 /* Extract the number of EID records present */
265 auth_data_len = GET_BE_U_2(lisp_hdr->auth_data_len);
266 packet_iterator = (const u_char *)(lisp_hdr);
267 packet_offset = MAP_REGISTER_HDR_LEN;
268 record_count = GET_U_1(lisp_hdr->record_count);
270 if (ndo->ndo_vflag) {
271 key_id = GET_BE_U_2(lisp_hdr->key_id);
272 ND_PRINT("\n %u record(s), ", record_count);
273 ND_PRINT("Authentication %s,",
274 tok2str(auth_type, "unknown-type", key_id));
275 hex_print(ndo, "\n Authentication-Data: ", packet_iterator +
276 packet_offset, auth_data_len);
278 ND_PRINT(" %u record(s),", record_count);
280 packet_offset += auth_data_len;
282 if (record_count == 0)
285 /* Print all the EID records */
286 while ((length > packet_offset) && (record_count--)) {
288 ND_TCHECK_LEN(packet_iterator + packet_offset,
289 MAP_REGISTER_EID_LEN);
291 lisp_eid = (const lisp_map_register_eid *)
292 ((const u_char *)lisp_hdr + packet_offset);
293 packet_offset += MAP_REGISTER_EID_LEN;
294 mask_len = GET_U_1(lisp_eid->eid_prefix_mask_length);
295 eid_afi = GET_BE_U_2(lisp_eid->eid_prefix_afi);
296 loc_count = GET_U_1(lisp_eid->locator_count);
298 if (ndo->ndo_vflag) {
299 ttl = GET_BE_U_4(lisp_eid->ttl);
300 ND_PRINT(" Record TTL %u,", ttl);
301 action_flag(ndo, GET_U_1(lisp_eid->act_auth_inc_res));
302 map_version = GET_BE_U_2(lisp_eid->reserved_and_version) & 0x0FFF;
303 ND_PRINT(" Map Version: %u,", map_version);
308 ND_PRINT(" EID %s/%u,",
309 GET_IPADDR_STRING(packet_iterator + packet_offset),
314 ND_PRINT(" EID %s/%u,",
315 GET_IP6ADDR_STRING(packet_iterator + packet_offset),
321 * No support for LCAF right now.
327 ND_PRINT(" %u locator(s)", loc_count);
329 while (loc_count--) {
330 ND_TCHECK_LEN(packet_iterator + packet_offset,
331 MAP_REGISTER_LOC_LEN);
332 lisp_loc = (const lisp_map_register_loc *) (packet_iterator + packet_offset);
333 loc_ip_pointer = (const u_char *) (lisp_loc + 1);
334 packet_offset += MAP_REGISTER_LOC_LEN;
335 loc_afi = GET_BE_U_2(lisp_loc->locator_afi);
342 ND_TCHECK_4(packet_iterator + packet_offset);
343 ND_PRINT(" LOC %s", GET_IPADDR_STRING(loc_ip_pointer));
347 ND_TCHECK_16(packet_iterator + packet_offset);
348 ND_PRINT(" LOC %s", GET_IP6ADDR_STRING(loc_ip_pointer));
354 if (ndo->ndo_vflag) {
355 ND_PRINT("\n Priority/Weight %u/%u,"
356 " Multicast Priority/Weight %u/%u,",
357 GET_U_1(lisp_loc->priority),
358 GET_U_1(lisp_loc->weight),
359 GET_U_1(lisp_loc->m_priority),
360 GET_U_1(lisp_loc->m_weight));
362 GET_BE_U_2(lisp_loc->unused_and_flag));
368 * Print xTR and Site ID. Handle the fact that the packet could be invalid.
369 * If the xTR_ID_Present bit is not set, and we still have data to display,
370 * show it as hex data.
373 if (!ND_TTEST_LEN(packet_iterator + packet_offset, 24))
375 hex_print(ndo, "\n xTR-ID: ", packet_iterator + packet_offset, 16);
376 ND_PRINT("\n SITE-ID: %" PRIu64,
377 GET_BE_U_8(packet_iterator + packet_offset + 16));
379 /* Check if packet isn't over yet */
380 if (packet_iterator + packet_offset < ndo->ndo_snapend) {
381 hex_print(ndo, "\n Data: ", packet_iterator + packet_offset,
382 ND_BYTES_AVAILABLE_AFTER(packet_iterator + packet_offset));
390 nd_print_invalid(ndo);
394 extract_lisp_type(uint8_t lisp_hdr_flags)
396 return (lisp_hdr_flags) >> TYPE_INDEX;
400 is_xtr_data_present(uint8_t type, uint8_t lisp_hdr_flags)
402 uint8_t xtr_present = 0;
404 if (type == LISP_MAP_REGISTER)
405 xtr_present = (lisp_hdr_flags) & LISP_MAP_REGISTER_IBIT_MASK;
406 else if (type == LISP_MAP_NOTIFY)
407 xtr_present = (lisp_hdr_flags) & LISP_MAP_NOTIFY_IBIT_MASK;
412 static void lisp_hdr_flag(netdissect_options *ndo, const lisp_map_register_hdr *lisp_hdr)
414 uint8_t type = extract_lisp_type(GET_U_1(lisp_hdr->type_and_flag));
416 if (!ndo->ndo_vflag) {
417 ND_PRINT("%s,", tok2str(lisp_type, "unknown-type-%u", type));
420 ND_PRINT("%s,", tok2str(lisp_type, "unknown-type-%u", type));
423 if (type == LISP_MAP_REGISTER) {
424 ND_PRINT(" flags [%s],", bittok2str(map_register_hdr_flag,
425 "none", GET_BE_U_4(lisp_hdr)));
426 } else if (type == LISP_MAP_NOTIFY) {
427 ND_PRINT(" flags [%s],", bittok2str(map_notify_hdr_flag,
428 "none", GET_BE_U_4(lisp_hdr)));
432 static void action_flag(netdissect_options *ndo, uint8_t act_auth_inc_res)
435 uint8_t authoritative;
437 authoritative = ((act_auth_inc_res >> 4) & 1);
440 ND_PRINT(" Authoritative,");
442 ND_PRINT(" Non-Authoritative,");
444 action = act_auth_inc_res >> 5;
445 ND_PRINT(" %s,", tok2str(lisp_eid_action, "unknown", action));
448 static void loc_hdr_flag(netdissect_options *ndo, uint16_t flag)
450 ND_PRINT(" flags [%s],", bittok2str(lisp_loc_flag, "none", flag));