forked from osmocom/wireshark
484 lines
14 KiB
C
484 lines
14 KiB
C
/* packet-erspan.c
|
|
* Routines for the disassembly of Cisco's ERSPAN protocol
|
|
*
|
|
* Copyright 2005 Joerg Mayer (see AUTHORS file)
|
|
* Updates for newer versions by Jason Masker <jason at masker.net>
|
|
* Updates to support ERSPAN3 by Peter Membrey <peter@membrey.hk>
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Protocol Spec:
|
|
* https://tools.ietf.org/html/draft-foschiano-erspan-01
|
|
*
|
|
* For ERSPAN packets, the "protocol type" field value in the GRE header
|
|
* is 0x88BE (version 1) or 0x22EB (version 2).
|
|
* ERSPAN type II is version 1
|
|
* ERSPAN type III is version 2
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <epan/packet.h>
|
|
#include <epan/prefs.h>
|
|
#include <epan/expert.h>
|
|
#include "packet-gre.h"
|
|
|
|
void proto_register_erspan(void);
|
|
void proto_reg_handoff_erspan(void);
|
|
|
|
static int proto_erspan = -1;
|
|
|
|
static gint ett_erspan = -1;
|
|
|
|
static int hf_erspan_version = -1;
|
|
static int hf_erspan_vlan = -1;
|
|
static int hf_erspan_priority = -1;
|
|
static int hf_erspan_encap = -1;
|
|
static int hf_erspan_truncated = -1;
|
|
static int hf_erspan_spanid = -1;
|
|
static int hf_erspan_index = -1;
|
|
static int hf_erspan_timestamp = -1;
|
|
static int hf_erspan_direction2 = -1;
|
|
|
|
static int hf_erspan_bso = -1;
|
|
static int hf_erspan_sgt = -1;
|
|
static int hf_erspan_p = -1;
|
|
static int hf_erspan_ft = -1;
|
|
static int hf_erspan_hw = -1;
|
|
static int hf_erspan_gra = -1;
|
|
static int hf_erspan_o = -1;
|
|
|
|
/* Optional Sub-header */
|
|
static int hf_erspan_platid = -1;
|
|
/* Platform ID = 1 */
|
|
static int hf_erspan_pid1_domain_id = -1;
|
|
static int hf_erspan_pid1_port_index = -1;
|
|
/* Platform ID = 3 */
|
|
static int hf_erspan_pid3_port_index = -1;
|
|
static int hf_erspan_pid3_timestamp = -1;
|
|
/* Platform ID = 4 */
|
|
static int hf_erspan_pid4_rsvd1 = -1;
|
|
static int hf_erspan_pid4_rsvd2 = -1;
|
|
static int hf_erspan_pid4_rsvd3 = -1;
|
|
/* Platform ID = 5 or 6 */
|
|
static int hf_erspan_pid5_switchid = -1;
|
|
static int hf_erspan_pid5_port_index = -1;
|
|
static int hf_erspan_pid5_timestamp = -1;
|
|
/* ID: 0x0, 0x2, 0x7-0x63 are reserved. */
|
|
static int hf_erspan_pid_rsvd = -1;
|
|
|
|
static expert_field ei_erspan_version_unknown = EI_INIT;
|
|
|
|
#define PROTO_SHORT_NAME "ERSPAN"
|
|
#define PROTO_LONG_NAME "Encapsulated Remote Switch Packet ANalysis"
|
|
|
|
/* Global ERSPAN Preference */
|
|
static gboolean pref_fake_erspan = FALSE;
|
|
|
|
#define ERSPAN_DIRECTION_INCOMING 0
|
|
#define ERSPAN_DIRECTION_OUTGOING 1
|
|
static const value_string erspan_direction_vals[] = {
|
|
{ERSPAN_DIRECTION_INCOMING, "Incoming"},
|
|
{ERSPAN_DIRECTION_OUTGOING, "Outgoing"},
|
|
{0, NULL},
|
|
};
|
|
|
|
#define ERSPAN_ENCAP_00 0
|
|
#define ERSPAN_ENCAP_01 1
|
|
#define ERSPAN_ENCAP_10 2
|
|
#define ERSPAN_ENCAP_11 3
|
|
static const value_string erspan_encap_vals[] = {
|
|
{ERSPAN_ENCAP_00, "Originally without VLAN tag"},
|
|
{ERSPAN_ENCAP_01, "Originally ISL encapsulated"},
|
|
{ERSPAN_ENCAP_10, "Originally 802.1Q encapsulated"},
|
|
{ERSPAN_ENCAP_11, "VLAN tag preserved in frame"},
|
|
{0, NULL}
|
|
};
|
|
|
|
static const value_string erspan_truncated_vals[] = {
|
|
{0, "Not truncated"},
|
|
{1, "Truncated"},
|
|
{0, NULL},
|
|
};
|
|
|
|
static const value_string erspan_version_vals[] = {
|
|
{1, "Type II"},
|
|
{2, "Type III"},
|
|
{0, NULL},
|
|
};
|
|
|
|
static const value_string erspan_granularity_vals[] = {
|
|
{0, "100 microseconds"},
|
|
{1, "100 nanoseconds"},
|
|
{2, "IEEE 1588"},
|
|
{3, "Custom granularity"},
|
|
{0, NULL}
|
|
};
|
|
|
|
static dissector_handle_t ethnofcs_handle;
|
|
|
|
static int
|
|
dissect_erspan(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
|
|
{
|
|
proto_item *ti;
|
|
proto_item *ti_ver;
|
|
proto_tree *erspan_tree = NULL;
|
|
tvbuff_t *eth_tvb;
|
|
guint32 offset = 0;
|
|
guint16 version;
|
|
guint16 subheader = 0;
|
|
|
|
col_set_str(pinfo->cinfo, COL_PROTOCOL, PROTO_SHORT_NAME);
|
|
col_set_str(pinfo->cinfo, COL_INFO, PROTO_SHORT_NAME ":");
|
|
|
|
|
|
if (tree) {
|
|
ti = proto_tree_add_item(tree, proto_erspan, tvb, offset, -1,
|
|
ENC_NA);
|
|
erspan_tree = proto_item_add_subtree(ti, ett_erspan);
|
|
}
|
|
|
|
if(pref_fake_erspan) {
|
|
/* Some vendors don't include ERSPAN Header...*/
|
|
eth_tvb = tvb_new_subset_remaining(tvb, offset);
|
|
call_dissector(ethnofcs_handle, eth_tvb, pinfo, tree);
|
|
return tvb_captured_length(tvb);
|
|
}
|
|
|
|
|
|
version = tvb_get_ntohs(tvb, offset) >> 12;
|
|
|
|
ti_ver = proto_tree_add_item(erspan_tree, hf_erspan_version, tvb, offset, 2,
|
|
ENC_BIG_ENDIAN);
|
|
if ((version != 1) && (version != 2 )) {
|
|
expert_add_info(pinfo, ti_ver, &ei_erspan_version_unknown);
|
|
return 2;
|
|
}
|
|
proto_tree_add_item(erspan_tree, hf_erspan_vlan, tvb, offset, 2,
|
|
ENC_BIG_ENDIAN);
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_priority, tvb, offset, 2,
|
|
ENC_BIG_ENDIAN);
|
|
|
|
if (version == 1)
|
|
proto_tree_add_item(erspan_tree, hf_erspan_encap, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
else
|
|
proto_tree_add_item(erspan_tree, hf_erspan_bso, tvb, offset, 2,
|
|
ENC_BIG_ENDIAN);
|
|
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_truncated, tvb, offset, 2,
|
|
ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(erspan_tree, hf_erspan_spanid, tvb, offset, 2,
|
|
ENC_BIG_ENDIAN);
|
|
offset += 2;
|
|
|
|
if (version == 1) {
|
|
proto_tree_add_item(erspan_tree, hf_erspan_index, tvb,
|
|
offset, 4, ENC_BIG_ENDIAN);
|
|
offset += 4;
|
|
}
|
|
else {
|
|
proto_tree_add_item(erspan_tree, hf_erspan_timestamp, tvb,
|
|
offset, 4, ENC_BIG_ENDIAN);
|
|
offset += 4;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_sgt, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_p, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_ft, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_hw, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_direction2, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_gra, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_o, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
|
|
subheader = tvb_get_ntohs(tvb, offset) & 0x1;
|
|
offset += 2;
|
|
|
|
/* Platform Sepcific SubHeader, 8 octets, optional */
|
|
if (subheader) {
|
|
gint32 platform_id = tvb_get_ntohl(tvb, offset) >> 26;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_platid, tvb,
|
|
offset, 2, ENC_BIG_ENDIAN);
|
|
|
|
switch (platform_id) {
|
|
case 1:
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid1_domain_id,
|
|
tvb, offset, 2, ENC_BIG_ENDIAN);
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid1_port_index,
|
|
tvb, offset, 4, ENC_BIG_ENDIAN);
|
|
offset += 4;
|
|
break;
|
|
|
|
case 3:
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid3_port_index,
|
|
tvb, offset, 2, ENC_BIG_ENDIAN);
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid3_timestamp,
|
|
tvb, offset, 4, ENC_BIG_ENDIAN);
|
|
offset += 4;
|
|
break;
|
|
|
|
case 4:
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid4_rsvd1, tvb,
|
|
offset, 4, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid4_rsvd2, tvb,
|
|
offset, 4, ENC_BIG_ENDIAN);
|
|
offset += 4;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid4_rsvd3, tvb,
|
|
offset, 4, ENC_BIG_ENDIAN);
|
|
offset += 4;
|
|
break;
|
|
|
|
case 5:
|
|
case 6:
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid5_switchid,
|
|
tvb, offset, 2, ENC_BIG_ENDIAN);
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid5_port_index,
|
|
tvb, offset, 2, ENC_BIG_ENDIAN);
|
|
offset += 2;
|
|
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid5_timestamp,
|
|
tvb, offset, 4, ENC_BIG_ENDIAN);
|
|
offset += 4;
|
|
break;
|
|
|
|
default:
|
|
/* ID: 0x0, 0x2, 0x7-0x63 are reserved. */
|
|
proto_tree_add_item(erspan_tree, hf_erspan_pid_rsvd,
|
|
tvb, offset, 8, ENC_BIG_ENDIAN);
|
|
offset += 8;
|
|
break;
|
|
|
|
}
|
|
}
|
|
}
|
|
|
|
eth_tvb = tvb_new_subset_remaining(tvb, offset);
|
|
call_dissector(ethnofcs_handle, eth_tvb, pinfo, tree);
|
|
return tvb_captured_length(tvb);
|
|
}
|
|
|
|
void
|
|
proto_register_erspan(void)
|
|
{
|
|
module_t *erspan_module;
|
|
expert_module_t* expert_erspan;
|
|
|
|
static hf_register_info hf[] = {
|
|
|
|
{ &hf_erspan_version,
|
|
{ "Version", "erspan.version", FT_UINT16, BASE_DEC, VALS(erspan_version_vals),
|
|
0xf000, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_vlan,
|
|
{ "Vlan", "erspan.vlan", FT_UINT16, BASE_DEC, NULL,
|
|
0x0fff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_priority,
|
|
{ "Priority", "erspan.priority", FT_UINT16, BASE_DEC, NULL,
|
|
0xe000, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_encap,
|
|
{ "Encap", "erspan.encap", FT_UINT16, BASE_DEC, VALS(erspan_encap_vals),
|
|
0x1800, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_bso,
|
|
{ "Bad/Short/Oversized", "erspan.bso", FT_UINT16, BASE_DEC, VALS(erspan_truncated_vals),
|
|
0x1800, NULL, HFILL }},
|
|
|
|
|
|
{ &hf_erspan_truncated,
|
|
{ "Truncated", "erspan.truncated", FT_UINT16, BASE_DEC, VALS(erspan_truncated_vals),
|
|
0x0400, "ERSPAN packet exceeded the MTU size", HFILL }},
|
|
|
|
{ &hf_erspan_spanid,
|
|
{ "SpanID", "erspan.spanid", FT_UINT16, BASE_DEC, NULL,
|
|
0x03ff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_index,
|
|
{ "Index", "erspan.index", FT_UINT32, BASE_DEC, NULL,
|
|
0xfffff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_timestamp,
|
|
{ "Timestamp", "erspan.timestamp", FT_UINT32, BASE_DEC, NULL,
|
|
0xffffffff, NULL, HFILL }},
|
|
|
|
|
|
{ &hf_erspan_sgt,
|
|
{ "Security Group Tag", "erspan.sgt", FT_UINT16, BASE_DEC, NULL,
|
|
0xffff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_p,
|
|
{ "Has Ethernet PDU", "erspan.p", FT_UINT16, BASE_DEC, NULL,
|
|
0x8000, NULL, HFILL }},
|
|
|
|
|
|
{ &hf_erspan_ft,
|
|
{ "Frame Type", "erspan.ft", FT_UINT16, BASE_DEC, NULL,
|
|
0x7C00, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_hw,
|
|
{ "Hardware ID", "erspan.hw", FT_UINT16, BASE_DEC, NULL,
|
|
0x03f0, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_gra,
|
|
{ "Timestamp granularity", "erspan.gra", FT_UINT16, BASE_DEC, VALS(erspan_granularity_vals),
|
|
0x0006, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_direction2,
|
|
{ "Direction", "erspan.direction2", FT_UINT16, BASE_DEC, VALS(erspan_direction_vals),
|
|
0x0008, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_o,
|
|
{ "Optional Sub headers", "erspan.o", FT_UINT16, BASE_DEC, NULL,
|
|
0x0001, NULL, HFILL }},
|
|
|
|
/* Sub-header Fields, optional */
|
|
{ &hf_erspan_platid,
|
|
{ "Platform ID", "erspan.platid", FT_UINT16, BASE_DEC, NULL,
|
|
0xfc00, NULL, HFILL }},
|
|
|
|
/* ID = 1 */
|
|
{ &hf_erspan_pid1_domain_id,
|
|
{ "VSM Domain ID", "erspan.pid1.vsmid", FT_UINT16, BASE_DEC, NULL,
|
|
0x0fff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_pid1_port_index,
|
|
{ "Port ID/Index", "erspan.pid1.port_index", FT_UINT32, BASE_DEC, NULL,
|
|
0xffffffff, NULL, HFILL }},
|
|
|
|
/* ID = 3 */
|
|
{ &hf_erspan_pid3_port_index,
|
|
{ "Port ID/Index", "erspan.pid3.port_index", FT_UINT16, BASE_DEC, NULL,
|
|
0x3fff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_pid3_timestamp,
|
|
{ "Upper 32-bit Timestamp", "erspan.pid3.timestamp", FT_UINT32, BASE_DEC, NULL,
|
|
0xffffffff, NULL, HFILL }},
|
|
|
|
/* ID = 4 */
|
|
{ &hf_erspan_pid4_rsvd1,
|
|
{ "Reserved", "erspan.pid4.rsvd1", FT_UINT32, BASE_DEC, NULL,
|
|
0x3ffc0000, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_pid4_rsvd2,
|
|
{ "Reserved", "erspan.pid4.rsvd2", FT_UINT32, BASE_DEC, NULL,
|
|
0x00003fff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_pid4_rsvd3,
|
|
{ "Reserved", "erspan.pid4.rsvd3", FT_UINT32, BASE_DEC, NULL,
|
|
0xffffffff, NULL, HFILL }},
|
|
|
|
/* ID = 5 or 6 */
|
|
{ &hf_erspan_pid5_switchid,
|
|
{ "Switch ID", "erspan.pid5.switchid", FT_UINT16, BASE_DEC, NULL,
|
|
0x03ff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_pid5_port_index,
|
|
{ "Port ID/Index", "erspan.pid5.port_index", FT_UINT16, BASE_DEC, NULL,
|
|
0xffff, NULL, HFILL }},
|
|
|
|
{ &hf_erspan_pid5_timestamp,
|
|
{ "Timestamp (seconds)", "erspan.pid5.timestamp", FT_UINT32, BASE_DEC, NULL,
|
|
0xffffffff, NULL, HFILL }},
|
|
|
|
/* Reserved */
|
|
{ &hf_erspan_pid_rsvd,
|
|
{ "Reserved", "erspan.pid.rsvd", FT_UINT64, BASE_DEC, NULL,
|
|
0x03ffffff, NULL, HFILL }},
|
|
|
|
};
|
|
|
|
static gint *ett[] = {
|
|
&ett_erspan,
|
|
};
|
|
|
|
static ei_register_info ei[] = {
|
|
{ &ei_erspan_version_unknown, { "erspan.version.unknown", PI_UNDECODED, PI_WARN, "Unknown version, please report or test to use fake ERSPAN preference", EXPFILL }},
|
|
};
|
|
|
|
proto_erspan = proto_register_protocol(PROTO_LONG_NAME, PROTO_SHORT_NAME, "erspan");
|
|
proto_register_field_array(proto_erspan, hf, array_length(hf));
|
|
proto_register_subtree_array(ett, array_length(ett));
|
|
expert_erspan = expert_register_protocol(proto_erspan);
|
|
expert_register_field_array(expert_erspan, ei, array_length(ei));
|
|
|
|
/* register dissection preferences */
|
|
erspan_module = prefs_register_protocol(proto_erspan, NULL);
|
|
|
|
prefs_register_bool_preference(erspan_module, "fake_erspan",
|
|
"FORCE to decode fake ERSPAN frame",
|
|
"When set, dissector will FORCE to decode directly Ethernet Frame"
|
|
"Some vendor use fake ERSPAN frame (with not ERSPAN Header)",
|
|
&pref_fake_erspan);
|
|
}
|
|
|
|
void
|
|
proto_reg_handoff_erspan(void)
|
|
{
|
|
dissector_handle_t erspan_handle;
|
|
|
|
ethnofcs_handle = find_dissector_add_dependency("eth_withoutfcs", proto_erspan);
|
|
|
|
erspan_handle = create_dissector_handle(dissect_erspan, proto_erspan);
|
|
dissector_add_uint("gre.proto", GRE_ERSPAN_88BE, erspan_handle);
|
|
dissector_add_uint("gre.proto", GRE_ERSPAN_22EB, erspan_handle);
|
|
|
|
}
|
|
|
|
/*
|
|
* Editor modelines - http://www.wireshark.org/tools/modelines.html
|
|
*
|
|
* Local variables:
|
|
* c-basic-offset: 8
|
|
* tab-width: 8
|
|
* indent-tabs-mode: t
|
|
* End:
|
|
*
|
|
* vi: set shiftwidth=8 tabstop=8 noexpandtab:
|
|
* :indentSize=8:tabSize=8:noTabs=false:
|
|
*/
|