diff --git a/docbook/release-notes.asciidoc b/docbook/release-notes.asciidoc index dc1bc709e8..d11ed1bb61 100644 --- a/docbook/release-notes.asciidoc +++ b/docbook/release-notes.asciidoc @@ -70,6 +70,8 @@ PROXY (v2) protocol -- GSM-R protocol (User-to-User Information Element usage) -- +STCSIG (Spirent Test Center Signature decoding for Ethernet and FibreChannel, disabled by default) +-- === Updated Protocol Support diff --git a/epan/dissectors/CMakeLists.txt b/epan/dissectors/CMakeLists.txt index 2db198c7cd..a026fd343a 100644 --- a/epan/dissectors/CMakeLists.txt +++ b/epan/dissectors/CMakeLists.txt @@ -1679,6 +1679,7 @@ set(DISSECTOR_SRC ${CMAKE_CURRENT_SOURCE_DIR}/packet-starteam.c ${CMAKE_CURRENT_SOURCE_DIR}/packet-stat-notify.c ${CMAKE_CURRENT_SOURCE_DIR}/packet-stat.c + ${CMAKE_CURRENT_SOURCE_DIR}/packet-stcsig.c ${CMAKE_CURRENT_SOURCE_DIR}/packet-steam-ihs-discovery.c ${CMAKE_CURRENT_SOURCE_DIR}/packet-stt.c ${CMAKE_CURRENT_SOURCE_DIR}/packet-stun.c diff --git a/epan/dissectors/packet-stcsig.c b/epan/dissectors/packet-stcsig.c new file mode 100644 index 0000000000..a19e1a164c --- /dev/null +++ b/epan/dissectors/packet-stcsig.c @@ -0,0 +1,346 @@ +/* packet-stcsig.c + * Routines for dissecting Spirent Test Center Signatures + * Copyright 2018 Joerg Mayer (see AUTHORS file) + * Based on disassembly of Spirent's modified version of Wireshark 1.10.3 + * + * Wireshark - Network traffic analyzer + * By Gerald Combs + * Copyright 1998 Gerald Combs + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ + +/* The logic is based on the dissassembly of libwireshark.dll which was + * part of wireshark-win64-1.10.3-spirent-2.exe, distributed by Spirent + * to customers of their Spirent Test Center. + * As the installer displays the normal GPLv2+ license the choice was + * made to go with dissassembly instead of finding out who to ask for + * the source code. + * + * Please report errors or missing features when compared to the original. + */ + +/* TODO: + * - Find out the meaning of the unknown trailer (perhaps some fcs or + * some prbseq related stuff?) + * - Find out meaning of prbseq + * - Is there a (fixed) structure in the csp field? + * - Validate the timestamp decoding: The seconds value is identical to + * Spirent's stcsig dissector, the ns value differs + */ + +#define NEW_PROTO_TREE_API + +#include "config.h" + +#include +#include + +void proto_register_stcsig(void); +void proto_reg_handoff_stcsig(void); + +static int proto_stcsig = -1; + +#define PROTO_SHORT_NAME "STCSIG" +#define PROTO_LONG_NAME "Spirent Test Center Signature" + +static header_field_info *hfi_stcsig = NULL; + +#define STCSIG_HFI_INIT HFI_INIT(proto_stcsig) + +static header_field_info hfi_stcsig_rawdata STCSIG_HFI_INIT = + { "Raw Data", "stcsig.rawdata", FT_BYTES, BASE_NONE, NULL, 0x0, + NULL, HFILL }; + +static header_field_info hfi_stcsig_iv STCSIG_HFI_INIT = + { "IV", "stcsig.iv", FT_UINT8, BASE_HEX, NULL, 0x0, + "Deobfuscation Initialization Vector", HFILL }; + +/* IV originally was: +static header_field_info hfi_stcsig_seqbyte STCSIG_HFI_INIT = + { "Complement of Sequence Byte", "stcsig.seqbyte", FT_UINT8, BASE_HEX, NULL, 0x0, + NULL, HFILL }; */ + +static header_field_info hfi_stcsig_streamid STCSIG_HFI_INIT = + { "StreamID", "stcsig.streamid", FT_INT32, BASE_DEC, NULL, 0x0, + NULL, HFILL }; + +static header_field_info hfi_stcsig_csp STCSIG_HFI_INIT = + { "ChassisSlotPort", "stcsig.csp", FT_UINT16, BASE_DEC, NULL, 0x0, + NULL, HFILL }; + +static header_field_info hfi_stcsig_seqnum_edm STCSIG_HFI_INIT = + { "Sequence Number (EDM)", "stcsig.seqnum", FT_UINT32, BASE_DEC, NULL, 0x0, + "Sequence Number (Enhanced Detection Mode)", HFILL }; + +static header_field_info hfi_stcsig_seqnum_sm STCSIG_HFI_INIT = + { "Sequence Number (SM)", "stcsig.seqnum", FT_UINT48, BASE_DEC, NULL, 0x0, + "Sequence Number (Sequence Mode)", HFILL }; + +static header_field_info hfi_stcsig_streamindex STCSIG_HFI_INIT = + { "Stream Index", "stcsig.streamindex", FT_UINT16, BASE_DEC, NULL, 0x0, + NULL, HFILL }; + +static header_field_info hfi_stcsig_timestamp STCSIG_HFI_INIT = + { "Timestamp", "stcsig.timestamp", FT_RELATIVE_TIME, BASE_NONE, NULL, 0x0, + NULL, HFILL }; + +static header_field_info hfi_stcsig_prbseq STCSIG_HFI_INIT = + { "Pseudo-Random Binary Sequence", "stcsig.prbseq", FT_BOOLEAN, 8, TFS(&tfs_true_false), 0x02, + NULL, HFILL }; + +static const true_false_string tfs_end_start = { "EndOfFrame", "StartOfFrame" }; + +static header_field_info hfi_stcsig_tslr STCSIG_HFI_INIT = + { "TSLR", "stcsig.tslr", FT_BOOLEAN, 8, TFS(&tfs_end_start), 0x01, + "Time Stamp Location Reference", HFILL }; + +static const true_false_string tfs_hard_soft = { "Hard", "Soft" }; + +static header_field_info hfi_stcsig_streamtype STCSIG_HFI_INIT = + { "StreamType", "stcsig.streamtype", FT_BOOLEAN, 8, TFS(&tfs_hard_soft), 0x80, + NULL, HFILL }; + +static header_field_info hfi_stcsig_unknown STCSIG_HFI_INIT = + { "Unknown", "stcsig.unknown", FT_BYTES, BASE_NONE, NULL, 0x0, + "Unknown Trailer (not obfuscated)", HFILL }; + +static gint ett_stcsig = -1; + +/* + * For the last 20 bytes of the data section to be a Spirent Signature + * the fist byte (offset 0) plus the 11th byte (offset 10) of the deocded + * signature must add up to 255 + */ +static gboolean +is_signature(tvbuff_t *tvb, gint sigoffset) +{ + /* + * How to generate the table below: + * + * static guint8 runit = 1; + * for(int k=0; k<256; k++) { + * obfuscation_value = k; + * for(int i=1; i<=10; i++) { + * obfuscation_value = deobfuscate_this[obfuscation_value]; + * } + * printf("0x%02x, ", obfuscation_value); + * if (k%8 == 7) printf("\n"); + * } + */ + + static const guint8 deobfuscate_offset_10[256] = { + 0x00, 0x86, 0x0d, 0x8b, 0x9d, 0x1b, 0x90, 0x16, + 0xbc, 0x3a, 0xb1, 0x37, 0x21, 0xa7, 0x2c, 0xaa, + 0x78, 0xfe, 0x75, 0xf3, 0xe5, 0x63, 0xe8, 0x6e, + 0xc4, 0x42, 0xc9, 0x4f, 0x59, 0xdf, 0x54, 0xd2, + 0xf1, 0x77, 0xfc, 0x7a, 0x6c, 0xea, 0x61, 0xe7, + 0x4d, 0xcb, 0x40, 0xc6, 0xd0, 0x56, 0xdd, 0x5b, + 0x89, 0x0f, 0x84, 0x02, 0x14, 0x92, 0x19, 0x9f, + 0x35, 0xb3, 0x38, 0xbe, 0xa8, 0x2e, 0xa5, 0x23, + 0xe2, 0x64, 0xef, 0x69, 0x7f, 0xf9, 0x72, 0xf4, + 0x5e, 0xd8, 0x53, 0xd5, 0xc3, 0x45, 0xce, 0x48, + 0x9a, 0x1c, 0x97, 0x11, 0x07, 0x81, 0x0a, 0x8c, + 0x26, 0xa0, 0x2b, 0xad, 0xbb, 0x3d, 0xb6, 0x30, + 0x13, 0x95, 0x1e, 0x98, 0x8e, 0x08, 0x83, 0x05, + 0xaf, 0x29, 0xa2, 0x24, 0x32, 0xb4, 0x3f, 0xb9, + 0x6b, 0xed, 0x66, 0xe0, 0xf6, 0x70, 0xfb, 0x7d, + 0xd7, 0x51, 0xda, 0x5c, 0x4a, 0xcc, 0x47, 0xc1, + 0x43, 0xc5, 0x4e, 0xc8, 0xde, 0x58, 0xd3, 0x55, + 0xff, 0x79, 0xf2, 0x74, 0x62, 0xe4, 0x6f, 0xe9, + 0x3b, 0xbd, 0x36, 0xb0, 0xa6, 0x20, 0xab, 0x2d, + 0x87, 0x01, 0x8a, 0x0c, 0x1a, 0x9c, 0x17, 0x91, + 0xb2, 0x34, 0xbf, 0x39, 0x2f, 0xa9, 0x22, 0xa4, + 0x0e, 0x88, 0x03, 0x85, 0x93, 0x15, 0x9e, 0x18, + 0xca, 0x4c, 0xc7, 0x41, 0x57, 0xd1, 0x5a, 0xdc, + 0x76, 0xf0, 0x7b, 0xfd, 0xeb, 0x6d, 0xe6, 0x60, + 0xa1, 0x27, 0xac, 0x2a, 0x3c, 0xba, 0x31, 0xb7, + 0x1d, 0x9b, 0x10, 0x96, 0x80, 0x06, 0x8d, 0x0b, + 0xd9, 0x5f, 0xd4, 0x52, 0x44, 0xc2, 0x49, 0xcf, + 0x65, 0xe3, 0x68, 0xee, 0xf8, 0x7e, 0xf5, 0x73, + 0x50, 0xd6, 0x5d, 0xdb, 0xcd, 0x4b, 0xc0, 0x46, + 0xec, 0x6a, 0xe1, 0x67, 0x71, 0xf7, 0x7c, 0xfa, + 0x28, 0xae, 0x25, 0xa3, 0xb5, 0x33, 0xb8, 0x3e, + 0x94, 0x12, 0x99, 0x1f, 0x09, 0x8f, 0x04, 0x82 + }; + guint8 byte0; + guint8 byte10; + + /* Byte 0 also is the initialization vector for the obfuscation of offsets 1 - 15 */ + byte0 = tvb_get_guint8(tvb, sigoffset); + byte10 = tvb_get_guint8(tvb, sigoffset + 10); + + if (byte0 + (byte10 ^ deobfuscate_offset_10[byte0]) == 255) { + return TRUE; + } else { + return FALSE; + } +} + +static void +decode_signature(guint8* decode_buffer) +{ + static const guint8 deobfuscate_this[256] = { + 0x00, 0x71, 0xe3, 0x92, 0xb6, 0xc7, 0x55, 0x24, + 0x1c, 0x6d, 0xff, 0x8e, 0xaa, 0xdb, 0x49, 0x38, + 0x39, 0x48, 0xda, 0xab, 0x8f, 0xfe, 0x6c, 0x1d, + 0x25, 0x54, 0xc6, 0xb7, 0x93, 0xe2, 0x70, 0x01, + 0x72, 0x03, 0x91, 0xe0, 0xc4, 0xb5, 0x27, 0x56, + 0x6e, 0x1f, 0x8d, 0xfc, 0xd8, 0xa9, 0x3b, 0x4a, + 0x4b, 0x3a, 0xa8, 0xd9, 0xfd, 0x8c, 0x1e, 0x6f, + 0x57, 0x26, 0xb4, 0xc5, 0xe1, 0x90, 0x02, 0x73, + 0xe4, 0x95, 0x07, 0x76, 0x52, 0x23, 0xb1, 0xc0, + 0xf8, 0x89, 0x1b, 0x6a, 0x4e, 0x3f, 0xad, 0xdc, + 0xdd, 0xac, 0x3e, 0x4f, 0x6b, 0x1a, 0x88, 0xf9, + 0xc1, 0xb0, 0x22, 0x53, 0x77, 0x06, 0x94, 0xe5, + 0x96, 0xe7, 0x75, 0x04, 0x20, 0x51, 0xc3, 0xb2, + 0x8a, 0xfb, 0x69, 0x18, 0x3c, 0x4d, 0xdf, 0xae, + 0xaf, 0xde, 0x4c, 0x3d, 0x19, 0x68, 0xfa, 0x8b, + 0xb3, 0xc2, 0x50, 0x21, 0x05, 0x74, 0xe6, 0x97, + 0xb8, 0xc9, 0x5b, 0x2a, 0x0e, 0x7f, 0xed, 0x9c, + 0xa4, 0xd5, 0x47, 0x36, 0x12, 0x63, 0xf1, 0x80, + 0x81, 0xf0, 0x62, 0x13, 0x37, 0x46, 0xd4, 0xa5, + 0x9d, 0xec, 0x7e, 0x0f, 0x2b, 0x5a, 0xc8, 0xb9, + 0xca, 0xbb, 0x29, 0x58, 0x7c, 0x0d, 0x9f, 0xee, + 0xd6, 0xa7, 0x35, 0x44, 0x60, 0x11, 0x83, 0xf2, + 0xf3, 0x82, 0x10, 0x61, 0x45, 0x34, 0xa6, 0xd7, + 0xef, 0x9e, 0x0c, 0x7d, 0x59, 0x28, 0xba, 0xcb, + 0x5c, 0x2d, 0xbf, 0xce, 0xea, 0x9b, 0x09, 0x78, + 0x40, 0x31, 0xa3, 0xd2, 0xf6, 0x87, 0x15, 0x64, + 0x65, 0x14, 0x86, 0xf7, 0xd3, 0xa2, 0x30, 0x41, + 0x79, 0x08, 0x9a, 0xeb, 0xcf, 0xbe, 0x2c, 0x5d, + 0x2e, 0x5f, 0xcd, 0xbc, 0x98, 0xe9, 0x7b, 0x0a, + 0x32, 0x43, 0xd1, 0xa0, 0x84, 0xf5, 0x67, 0x16, + 0x17, 0x66, 0xf4, 0x85, 0xa1, 0xd0, 0x42, 0x33, + 0x0b, 0x7a, 0xe8, 0x99, 0xbd, 0xcc, 0x5e, 0x2f + }; + guint8 obfuscation_value; + + obfuscation_value = decode_buffer[0]; + + for(int i=1; i<16; i++) { + obfuscation_value = deobfuscate_this[obfuscation_value]; + decode_buffer[i] ^= obfuscation_value; + } + /* decode_buffer[16...19] is unobfuscated */ +} + +static int +dissect_stcsig(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_) +{ + gint bytes, length; + gint sig_offset; + + tvbuff_t *stcsig_tvb; + proto_item *ti; + proto_tree *stcsig_tree; + guint8 *real_stcsig; + + guint64 timestamp_2_5_ns; + nstime_t timestamp; + + length = tvb_captured_length(tvb); + if (length >= 20 && is_signature(tvb, length - 20)) { + bytes = 20; + } else if (length >= 24 && is_signature(tvb, length - 24)) { + /* Sigsize + 4 bytes FCS */ + bytes = 24; + } else if (length >= 28 && is_signature(tvb, length - 28)) { + /* Sigsize + 8 bytes FCS, i.e. FibreChannel */ + bytes = 28; + } else { + return 0; + } + sig_offset = length - bytes; + +#if 0 + /* Maybe make this a preference */ + col_set_str(pinfo->cinfo, COL_PROTOCOL, PROTO_SHORT_NAME); + col_set_str(pinfo->cinfo, COL_INFO, PROTO_LONG_NAME); +#endif + + real_stcsig = (guint8 *)tvb_memdup(pinfo->pool, tvb, sig_offset, 20); + decode_signature(real_stcsig); + stcsig_tvb = tvb_new_child_real_data(tvb, real_stcsig, 20, 20); + add_new_data_source(pinfo, stcsig_tvb, PROTO_LONG_NAME); + + ti = proto_tree_add_item(tree, hfi_stcsig, tvb, sig_offset, 20, ENC_NA); + stcsig_tree = proto_item_add_subtree(ti, ett_stcsig); + + proto_tree_add_item(stcsig_tree, &hfi_stcsig_rawdata, tvb, sig_offset, 20, ENC_NA); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_iv, stcsig_tvb, 0, 1, ENC_NA); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_streamtype, stcsig_tvb, 3, 1, ENC_NA); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_streamid, stcsig_tvb, 1, 4, ENC_BIG_ENDIAN); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_csp, stcsig_tvb, 1, 2, ENC_BIG_ENDIAN); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_streamindex, stcsig_tvb, 3, 2, ENC_BIG_ENDIAN); + if (tvb_get_ntohs(stcsig_tvb, 5) + tvb_get_ntohs(stcsig_tvb, 7) == 0xffff) { + proto_tree_add_item(stcsig_tree, &hfi_stcsig_seqnum_edm, stcsig_tvb, 7, 4, ENC_BIG_ENDIAN); + } else { + proto_tree_add_item(stcsig_tree, &hfi_stcsig_seqnum_sm, stcsig_tvb, 5, 6, ENC_BIG_ENDIAN); + } + timestamp_2_5_ns = (guint64)(tvb_get_guint8(stcsig_tvb, 15) & 0xfc) << 30; + timestamp_2_5_ns |= tvb_get_ntohl(stcsig_tvb, 11); + timestamp.secs = timestamp_2_5_ns / 400000000L; + timestamp.nsecs = timestamp_2_5_ns % 400000000L; + proto_tree_add_time(stcsig_tree, &hfi_stcsig_timestamp, stcsig_tvb, 11, 5, ×tamp); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_prbseq, stcsig_tvb, 15, 1, ENC_NA); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_tslr, stcsig_tvb, 15, 1, ENC_NA); + proto_tree_add_item(stcsig_tree, &hfi_stcsig_unknown, stcsig_tvb, 16, 4, ENC_NA); + + /* Ignored for post-dissectors but required by function type */ + return length; +} + +void +proto_register_stcsig(void) +{ +#ifndef HAVE_HFI_SECTION_INIT + static header_field_info *hfi[] = { + &hfi_stcsig_rawdata, + &hfi_stcsig_iv, /* &hfi_stcsig_seqbyte, */ + &hfi_stcsig_streamtype, + &hfi_stcsig_streamid, + &hfi_stcsig_csp, + &hfi_stcsig_seqnum_edm, + &hfi_stcsig_seqnum_sm, + &hfi_stcsig_streamindex, + &hfi_stcsig_timestamp, + &hfi_stcsig_prbseq, + &hfi_stcsig_tslr, + &hfi_stcsig_unknown + }; +#endif + + static gint *ett[] = { + &ett_stcsig + }; + + dissector_handle_t stcsig_handle; + + proto_stcsig = proto_register_protocol(PROTO_LONG_NAME, PROTO_SHORT_NAME, "stcsig"); + hfi_stcsig = proto_registrar_get_nth(proto_stcsig); + + register_dissector("stcsig", dissect_stcsig, proto_stcsig); + + proto_register_fields(proto_stcsig, hfi, array_length(hfi)); + proto_register_subtree_array(ett, array_length(ett)); + + stcsig_handle = register_dissector(PROTO_SHORT_NAME, dissect_stcsig, proto_stcsig); + register_postdissector(stcsig_handle); + + /* STCSIG is a rarely used case, disable it by default for performance reasons. */ + proto_disable_by_default(proto_stcsig); +} + +/* + * 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: + */