summaryrefslogtreecommitdiffstats
path: root/epan/dissectors/packet-lisp-data.c
blob: 787f71310b2108cacdba5c4fe7f27f4cea1cdea6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
/* packet-lisp-data.c
 * Routines for LISP Data Message dissection
 * Copyright 2010, Lorand Jakab <lj@lispmon.net>
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

#include "config.h"

#include <epan/packet.h>
#include <epan/expert.h>

void proto_register_lisp_data(void);
void proto_reg_handoff_lisp_data(void);

/* See RFC 6830 "Locator/ID Separation Protocol (LISP)" */

/*  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 *  |N|L|E|V|I|flags|            Nonce/Map-Version                  |
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 *  |                 Instance ID/Locator Status Bits               |
 *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 */

#define LISP_CONTROL_PORT       4342
#define LISP_DATA_PORT          4341
#define LISP_DATA_HEADER_LEN    8       /* Number of bytes in LISP data header */

#define LISP_DATA_FLAGS_WIDTH   8       /* Width (in bits) of the flags field */
#define LISP_DATA_FLAG_N        0x80    /* Nonce present */
#define LISP_DATA_FLAG_L        0x40    /* Locator-Status-Bits field enabled */
#define LISP_DATA_FLAG_E        0x20    /* Echo-Nonce-Request */
#define LISP_DATA_FLAG_V        0x10    /* Map-Version present */
#define LISP_DATA_FLAG_I        0x08    /* Instance ID present */
#define LISP_DATA_FLAG_RES      0x07    /* Reserved */

/* Initialize the protocol and registered fields */
static int proto_lisp_data = -1;
static int hf_lisp_data_flags = -1;
static int hf_lisp_data_flags_nonce = -1;
static int hf_lisp_data_flags_lsb = -1;
static int hf_lisp_data_flags_enr = -1;
static int hf_lisp_data_flags_mv = -1;
static int hf_lisp_data_flags_iid = -1;
static int hf_lisp_data_flags_res = -1;
static int hf_lisp_data_nonce = -1;
static int hf_lisp_data_mapver = -1;
static int hf_lisp_data_srcmapver = -1;
static int hf_lisp_data_dstmapver = -1;
static int hf_lisp_data_iid = -1;
static int hf_lisp_data_lsb = -1;
static int hf_lisp_data_lsb8 = -1;

/* Initialize the subtree pointers */
static gint ett_lisp_data = -1;
static gint ett_lisp_data_flags = -1;
static gint ett_lisp_data_mapver = -1;

static expert_field ei_lisp_data_flags_en_invalid = EI_INIT;
static expert_field ei_lisp_data_flags_nv_invalid = EI_INIT;

static dissector_handle_t ipv4_handle;
static dissector_handle_t ipv6_handle;
static dissector_handle_t lisp_handle;
static dissector_handle_t lisp_data_handle;

/* Code to actually dissect the packets */
static int
dissect_lisp_data(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
    gint        offset = 0;
    guint8      flags;
    guint8      ip_ver;
    tvbuff_t   *next_tvb;
    proto_item *ti;
    proto_item *tif;
    proto_tree *lisp_data_tree;
    proto_tree *lisp_data_flags_tree;

    /* Check if we have a LISP control packet */
    if (pinfo->destport == LISP_CONTROL_PORT)
        return call_dissector(lisp_handle, tvb, pinfo, tree);

    /* Check that there's enough data */
    if (tvb_reported_length(tvb) < LISP_DATA_HEADER_LEN)
        return 0;

    /* Make entries in Protocol column and Info column on summary display */
    col_set_str(pinfo->cinfo, COL_PROTOCOL, "LISP");

    col_set_str(pinfo->cinfo, COL_INFO, "LISP Encapsulation Header");

    /* create display subtree for the protocol */
    ti = proto_tree_add_item(tree, proto_lisp_data, tvb, 0,
            LISP_DATA_HEADER_LEN, ENC_NA);

    lisp_data_tree = proto_item_add_subtree(ti, ett_lisp_data);

    tif = proto_tree_add_item(lisp_data_tree,
            hf_lisp_data_flags, tvb, offset, 1, ENC_BIG_ENDIAN);

    lisp_data_flags_tree = proto_item_add_subtree(tif, ett_lisp_data_flags);

    proto_tree_add_item(lisp_data_flags_tree,
            hf_lisp_data_flags_nonce, tvb, offset, 1, ENC_BIG_ENDIAN);
    proto_tree_add_item(lisp_data_flags_tree,
            hf_lisp_data_flags_lsb, tvb, offset, 1, ENC_BIG_ENDIAN);
    proto_tree_add_item(lisp_data_flags_tree,
            hf_lisp_data_flags_enr, tvb, offset, 1, ENC_BIG_ENDIAN);
    proto_tree_add_item(lisp_data_flags_tree,
            hf_lisp_data_flags_mv, tvb, offset, 1, ENC_BIG_ENDIAN);
    proto_tree_add_item(lisp_data_flags_tree,
            hf_lisp_data_flags_iid, tvb, offset, 1, ENC_BIG_ENDIAN);
    proto_tree_add_item(lisp_data_flags_tree,
            hf_lisp_data_flags_res, tvb, offset, 1, ENC_BIG_ENDIAN);

    flags = tvb_get_guint8(tvb, offset);
    offset += 1;

    if (flags&LISP_DATA_FLAG_E && !(flags&LISP_DATA_FLAG_N)) {
        expert_add_info(pinfo, tif, &ei_lisp_data_flags_en_invalid);
    }

    if (flags&LISP_DATA_FLAG_N) {
        if (flags&LISP_DATA_FLAG_V) {
            expert_add_info(pinfo, tif, &ei_lisp_data_flags_nv_invalid);
        }
        proto_tree_add_item(lisp_data_tree,
                hf_lisp_data_nonce, tvb, offset, 3, ENC_BIG_ENDIAN);
    } else {
        if (flags&LISP_DATA_FLAG_V) {
            proto_item *tiv;
            proto_tree *lisp_data_mapver_tree;

            tiv = proto_tree_add_item(lisp_data_tree,
                    hf_lisp_data_mapver, tvb, offset, 3, ENC_BIG_ENDIAN);

            lisp_data_mapver_tree = proto_item_add_subtree(tiv, ett_lisp_data_mapver);

            proto_tree_add_item(lisp_data_mapver_tree,
                    hf_lisp_data_srcmapver, tvb, offset, 3, ENC_BIG_ENDIAN);
            proto_tree_add_item(lisp_data_mapver_tree,
                    hf_lisp_data_dstmapver, tvb, offset, 3, ENC_BIG_ENDIAN);
        }
    }
    offset += 3;

    if (flags&LISP_DATA_FLAG_I) {
        proto_tree_add_item(lisp_data_tree,
                hf_lisp_data_iid, tvb, offset, 3, ENC_BIG_ENDIAN);
        offset += 3;
        if (flags&LISP_DATA_FLAG_L) {
            proto_tree_add_item(lisp_data_tree,
                    hf_lisp_data_lsb8, tvb, offset, 1, ENC_BIG_ENDIAN);
        }
        /*offset +=1;*/
    } else {
        if (flags&LISP_DATA_FLAG_L) {
            proto_tree_add_item(lisp_data_tree,
                    hf_lisp_data_lsb, tvb, offset, 4, ENC_BIG_ENDIAN);
            /*offset += 4;*/
        }
    }

    /* Check if there is stuff left in the buffer, and return if not */

    /* Determine if encapsulated packet is IPv4 or IPv6, and call dissector */
    next_tvb = tvb_new_subset_remaining(tvb, LISP_DATA_HEADER_LEN);
    ip_ver = tvb_get_bits8(next_tvb, 0, 4);
    switch (ip_ver) {
        case 4:
            call_dissector(ipv4_handle, next_tvb, pinfo, tree);
            return tvb_reported_length(tvb);
        case 6:
            call_dissector(ipv6_handle, next_tvb, pinfo, tree);
            return tvb_reported_length(tvb);
    }

    /* Return the amount of data this dissector was able to dissect */
    return LISP_DATA_HEADER_LEN;
}


/* Register the protocol with Wireshark */
void
proto_register_lisp_data(void)
{
    /* Setup list of header fields */
    static hf_register_info hf[] = {
        { &hf_lisp_data_flags,
                { "Flags", "lisp-data.flags",
                FT_UINT8, BASE_HEX, NULL, 0x0, "LISP Data Header Flags", HFILL }},
        { &hf_lisp_data_flags_nonce,
                { "N bit (Nonce present)", "lisp-data.flags.nonce",
                FT_BOOLEAN, LISP_DATA_FLAGS_WIDTH, TFS(&tfs_set_notset),
                LISP_DATA_FLAG_N, NULL, HFILL }},
        { &hf_lisp_data_flags_lsb,
                { "L bit (Locator-Status-Bits field enabled)", "lisp-data.flags.lsb",
                FT_BOOLEAN, LISP_DATA_FLAGS_WIDTH, TFS(&tfs_set_notset),
                LISP_DATA_FLAG_L, NULL, HFILL }},
        { &hf_lisp_data_flags_enr,
                { "E bit (Echo-Nonce-Request)", "lisp-data.flags.enr",
                FT_BOOLEAN, LISP_DATA_FLAGS_WIDTH, TFS(&tfs_set_notset),
                LISP_DATA_FLAG_E, NULL, HFILL }},
        { &hf_lisp_data_flags_mv,
                { "V bit (Map-Version present)", "lisp-data.flags.mv",
                FT_BOOLEAN, LISP_DATA_FLAGS_WIDTH, TFS(&tfs_set_notset),
                LISP_DATA_FLAG_V, NULL, HFILL }},
        { &hf_lisp_data_flags_iid,
                { "I bit (Instance ID present)", "lisp-data.flags.iid",
                FT_BOOLEAN, LISP_DATA_FLAGS_WIDTH, TFS(&tfs_set_notset),
                LISP_DATA_FLAG_I, NULL, HFILL }},
        { &hf_lisp_data_flags_res,
                { "Reserved", "lisp-data.flags.res",
                FT_UINT8, BASE_HEX, NULL,
                LISP_DATA_FLAG_RES, "Must be zero", HFILL }},
        { &hf_lisp_data_nonce,
                { "Nonce", "lisp-data.nonce",
                FT_UINT24, BASE_DEC_HEX, NULL, 0x0, NULL, HFILL }},
        { &hf_lisp_data_mapver,
                { "Map-Version", "lisp-data.mapver",
                FT_UINT24, BASE_HEX, NULL, 0x0, NULL, HFILL }},
        { &hf_lisp_data_srcmapver,
                { "Source Map-Version", "lisp-data.srcmapver",
                FT_UINT24, BASE_DEC, NULL, 0xFFF000, NULL, HFILL }},
        { &hf_lisp_data_dstmapver,
                { "Destination Map-Version", "lisp-data.dstmapver",
                FT_UINT24, BASE_DEC, NULL, 0x000FFF, NULL, HFILL }},
        { &hf_lisp_data_iid,
                { "Instance ID", "lisp-data.iid",
                FT_UINT24, BASE_DEC, NULL, 0x0, NULL, HFILL }},
        { &hf_lisp_data_lsb,
                { "Locator-Status-Bits", "lisp-data.lsb",
                FT_UINT32, BASE_HEX, NULL, 0xFFFFFFFF, NULL, HFILL }},
        { &hf_lisp_data_lsb8,
                { "Locator-Status-Bits", "lisp-data.lsb8",
                FT_UINT8, BASE_HEX, NULL, 0xFF, NULL, HFILL }}
    };

    /* Setup protocol subtree array */
    static gint *ett[] = {
        &ett_lisp_data,
        &ett_lisp_data_flags,
        &ett_lisp_data_mapver
    };

    static ei_register_info ei[] = {
        { &ei_lisp_data_flags_en_invalid, { "lisp-data.flags.en_invalid", PI_PROTOCOL, PI_WARN, "Invalid flag combination: if E is set, N MUST be set", EXPFILL }},
        { &ei_lisp_data_flags_nv_invalid, { "lisp-data.flags.nv_invalid", PI_PROTOCOL, PI_WARN, "Invalid flag combination: N and V can't be set both", EXPFILL }},
    };

    expert_module_t* expert_lisp_data;

    /* Register the protocol name and description */
    proto_lisp_data = proto_register_protocol("Locator/ID Separation Protocol (Data)",
        "LISP Data", "lisp-data");

    /* Required function calls to register the header fields and subtrees used */
    proto_register_field_array(proto_lisp_data, hf, array_length(hf));
    proto_register_subtree_array(ett, array_length(ett));
    expert_lisp_data = expert_register_protocol(proto_lisp_data);
    expert_register_field_array(expert_lisp_data, ei, array_length(ei));

    /* Register the dissector */
    lisp_data_handle = register_dissector("lisp-data", dissect_lisp_data, proto_lisp_data);
}

/* Simple form of proto_reg_handoff_lisp_data which can be used if there are
   no prefs-dependent registration function calls.
 */

void
proto_reg_handoff_lisp_data(void)
{
    dissector_add_uint_with_preference("udp.port", LISP_DATA_PORT, lisp_data_handle);
    ipv4_handle = find_dissector_add_dependency("ip", proto_lisp_data);
    ipv6_handle = find_dissector_add_dependency("ipv6", proto_lisp_data);
    lisp_handle = find_dissector_add_dependency("lisp", proto_lisp_data);
}

/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */