packet-link16: Link 16 message dissector (MIL-STD-6016)

Described in:
Robertson, W., and Ross, P., Extending the Wireshark Network Protocol Analyser
to Decode Link 16 Tactical Data Link Messages, Defence Science and Technology
Organisation, January 2014. DSTO-TN-1257.

Change-Id: Ie4b1228ef112e56b3ab975d0c9254fa468b90cc2
Reviewed-on: https://code.wireshark.org/review/1551
Reviewed-by: Michael Mann <mmann78@netscape.net>

1 files changed, 291 insertions, 0 deletions

diff --git a/epan/dissectors/packet-link16.c b/epan/dissectors/packet-link16.c
new file mode 100644
index 0000000000..2dbba9027a
--- /dev/null
+++ b/epan/dissectors/packet-link16.c
@@ -0,0 +1,291 @@
+/* packet-link16.c
+ * Routines for Link 16 message dissection (MIL-STD-6016)
+ * William Robertson <aliask@gmail.com>
+ * Peter Ross <peter.ross@dsto.defence.gov.au>
+ *
+ * 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
+ */
+
+#include "config.h"
+
+#include <glib.h>
+#include <epan/packet.h>
+#include "packet-link16.h"
+
+/* Elmasry, G., (2012), Tactical Wireless Communications and Networks: Design Concepts and Challenges, Wiley, ISBN 9781119951766. */
+enum {
+    WORDFORMAT_INITIAL = 0,
+    WORDFORMAT_CONTINUATION,
+    WORDFORMAT_EXTENSION,
+};
+
+static const value_string WordFormat_Strings[] = {
+    { WORDFORMAT_INITIAL, "Initial Word" },
+    { WORDFORMAT_CONTINUATION, "Continuation Word" },
+    { WORDFORMAT_EXTENSION, "Extension Word" },
+    { 0, NULL },
+};
+
+/* Viasat, Inc., (2012), Link 16 Network Participant Group and Message Card, accessed from <http://www.viasat.com/files/assets/assets/Link16_NPG_Message_Card_100112a.pdf> on 15 April 2013. */
+static const value_string Link16_Label_Strings[] = {
+    { 0, "Network Management" },
+    { 1, "Network Management" },
+    { 2, "Precise Participant Location and Identificaton" },
+    { 3, "Surveillance" },
+    { 5, "Anti-submarine Warfare" },
+    { 6, "Intelligence" },
+    { 7, "Information Management" },
+    { 8, "Information Management" },
+    { 9, "Weapons Coordination and Management" },
+    { 10, "Weapons Coordination and Management" },
+    { 11, "Weapons Coordination and Management" },
+    { 12, "Control" },
+    { 13, "Platform and System Status" },
+    { 14, "Electronic Warfare" },
+    { 15, "Threat Warning" },
+    { 16, "Imagery" },
+    { 17, "Weather" },
+    { 28, "National Use" },
+    { 29, "National Use" },
+    { 30, "National Use" },
+    { 31, "Miscellaneous" },
+    { 0, NULL },
+};
+
+/* Viasat, Inc., (2012), Link 16 Network Participant Group and Message Card, accessed from <http://www.viasat.com/files/assets/assets/Link16_NPG_Message_Card_100112a.pdf> on 15 April 2013. */
+#define MKPAIR(a, b) (((b) << 5) | (a))
+static const value_string Link16_Message_Strings[] = {
+    { MKPAIR(0, 0), "Initial Entry" },
+    { MKPAIR(0, 1), "Test" },
+    { MKPAIR(0, 2), "Network Time Update" },
+    { MKPAIR(0, 3), "Time Slot Assignment" },
+    { MKPAIR(0, 4), "Radio Relay Control" },
+    { MKPAIR(0, 5), "Repromulgation Relay" },
+    { MKPAIR(0, 6), "Communication Control" },
+    { MKPAIR(0, 7), "Time Slot Reallocation" },
+    { MKPAIR(1, 0), "Connectivity Interrogation" },
+    { MKPAIR(1, 1), "Connectivity Status" },
+    { MKPAIR(1, 2), "Route Establishment" },
+    { MKPAIR(1, 3), "Acknowledgment" },
+    { MKPAIR(1, 4), "Communication Status" },
+    { MKPAIR(1, 5), "Net Control Initialization" },
+    { MKPAIR(1, 6), "Needline Participation Group Assignment" },
+    { MKPAIR(2, 0), "Indirect Interface Unit PPLI" },
+    { MKPAIR(2, 2), "Air PPLI" },
+    { MKPAIR(2, 3), "Surface PPLI" },
+    { MKPAIR(2, 4), "Subsurface PPLI" },
+    { MKPAIR(2, 5), "Land Point PPLI" },
+    { MKPAIR(2, 6), "Land Track PPLI" },
+    { MKPAIR(3, 0), "Reference Point" },
+    { MKPAIR(3, 1), "Emergency Point" },
+    { MKPAIR(3, 2), "Air Track" },
+    { MKPAIR(3, 3), "Surface Track" },
+    { MKPAIR(3, 4), "Subsurface Track" },
+    { MKPAIR(3, 5), "Land Point or Track" },
+    { MKPAIR(3, 6), "Space Track" },
+    { MKPAIR(3, 7), "Electronic Warfare Product Information" },
+    { MKPAIR(5, 4), "Acoustic Bearing and Range" },
+    { MKPAIR(6, 0), "Amplification" },
+    { MKPAIR(7, 0), "Track Management" },
+    { MKPAIR(7, 1), "Data Update Request" },
+    { MKPAIR(7, 2), "Correlation" },
+    { MKPAIR(7, 3), "Pointer" },
+    { MKPAIR(7, 4), "Track Identifier" },
+    { MKPAIR(7, 5), "IFF/SIF Management" },
+    { MKPAIR(7, 6), "Filter Management" },
+    { MKPAIR(7, 7), "Association" },
+    { MKPAIR(8, 0), "Unit Designator" },
+    { MKPAIR(8, 1), "Mission Correlator Change" },
+    { MKPAIR(9, 0), "Command" },
+    { MKPAIR(10, 2), "Engagement Status" },
+    { MKPAIR(10, 3), "Handover" },
+    { MKPAIR(10, 5), "Controlling Unit Report" },
+    { MKPAIR(10, 6), "Pairing" },
+    { MKPAIR(11, 0), "From the Weapon" },
+    { MKPAIR(11, 1), "To the Weapon" },
+    { MKPAIR(11, 2), "Weapon Coordination" },
+    { MKPAIR(12, 0), "Mission Assignment" },
+    { MKPAIR(12, 1), "Vector" },
+    { MKPAIR(12, 2), "Precision Aircraft Direction" },
+    { MKPAIR(12, 3), "Flight Path" },
+    { MKPAIR(12, 4), "Controlling Unit Change" },
+    { MKPAIR(12, 5), "Target/Track Correlation" },
+    { MKPAIR(12, 6), "Target Sorting" },
+    { MKPAIR(12, 7), "Target Bearing" },
+    { MKPAIR(13, 0), "Airfield Status" },
+    { MKPAIR(13, 2), "Air Platform and System Status" },
+    { MKPAIR(13, 3), "Surface Platform and System Status" },
+    { MKPAIR(13, 4), "Subsurface Platform and System Status" },
+    { MKPAIR(13, 5), "Land Platform and System Status" },
+    { MKPAIR(14, 0), "Parametric Information" },
+    { MKPAIR(14, 2), "Electronic Warfare Control / Coordination" },
+    { MKPAIR(15, 0), "Threat Warning" },
+    { MKPAIR(16, 0), "Imagery" },
+    { MKPAIR(17, 0), "Weather Over target" },
+    { MKPAIR(28, 0), "U.S. National 1 (Army)" },
+    { MKPAIR(28, 1), "U.S. National 2 (Navy)" },
+    { MKPAIR(28, 2), "U.S. National 3 (Air Force)" },
+    { MKPAIR(28, 3), "U.S. National 4 (Marine Corps)" },
+    { MKPAIR(28, 4), "French National 1" },
+    { MKPAIR(28, 5), "French National 2" },
+    { MKPAIR(28, 6), "U.S. National 5 (NSA)" },
+    { MKPAIR(28, 7), "UK National" },
+    { MKPAIR(31, 0), "Over-the-Air Rekeying Management" },
+    { MKPAIR(31, 1), "Over-the-Air Rekeying" },
+    { MKPAIR(31, 7), "No Statement" },
+    { 0, NULL },
+};
+
+/* Viasat, Inc., (2012), Link 16 Network Participant Group and Message Card, accessed from <http://www.viasat.com/files/assets/assets/Link16_NPG_Message_Card_100112a.pdf> on 15 April 2013. */
+const value_string Link16_NPG_Strings[] = {
+    { 1, "Initial Entry" },
+    { 2, "RTT-A" },
+    { 3, "RTT-B" },
+    { 4, "Network Management" },
+    { 5, "PPLI and Status" },
+    { 6, "PPLI and Status" },
+    { 7, "Surveillance" },
+    { 8, "Mission Management/Weapons Coordination" },
+    { 9, "Control" },
+    { 11, "Image Transfer" },
+    { 12, "Voice A" },
+    { 13, "Voice B" },
+    { 18, "Network Enabled Weapons" },
+    { 19, "Figher-to-Fighter A" },
+    { 20, "Figher-to-Fighter B" },
+    { 21, "Engagement Coordination" },
+    { 27, "Joint Net PPLI" },
+    { 28, "Distributed Network Management" },
+    { 0, NULL },
+};
+
+static int proto_link16 = -1;
+
+static gint hf_link16_wordformat = -1;
+static gint hf_link16_label = -1;
+static gint hf_link16_sublabel = -1;
+static gint hf_link16_mli = -1;
+static gint hf_link16_contlabel = -1;
+
+static gint ett_link16 = -1;
+
+static const int *link16_initial_word_fields[] = {
+    &hf_link16_wordformat,
+    &hf_link16_label,
+    &hf_link16_sublabel,
+    &hf_link16_mli,
+    NULL
+};
+
+static const int * link16_continuation_word_fields[] = {
+    &hf_link16_wordformat,
+    &hf_link16_contlabel,
+    NULL
+};
+
+static const int * link16_extension_or_other_word_fields[] = {
+    &hf_link16_wordformat,
+    NULL
+};
+
+static const int ** link16_fields[4] = {
+    link16_initial_word_fields,
+    link16_continuation_word_fields,
+    link16_extension_or_other_word_fields,
+    link16_extension_or_other_word_fields
+};
+
+static int dissect_link16(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data)
+{
+    Link16State *state = (Link16State *)data;
+    proto_item *link16_item = NULL;
+    proto_tree *link16_tree = NULL;
+    guint16 cache;
+    guint8 wordformat, contlabel;
+
+    if (!state)
+        REPORT_DISSECTOR_BUG("Link 16 dissector state missing");
+
+    cache = tvb_get_letohs(tvb, 0);
+    wordformat = cache & 0x3;
+
+    col_set_str(pinfo->cinfo, COL_PROTOCOL, "Link 16");
+
+    if (tree) {
+        link16_item = proto_tree_add_item(tree, proto_link16, tvb, 0, -1, ENC_NA);
+        link16_tree = proto_item_add_subtree(link16_item, ett_link16);
+        proto_tree_add_bitmask_text(link16_tree, tvb, 0, 2, "Header", NULL, ett_link16, link16_fields[wordformat], ENC_LITTLE_ENDIAN, BMT_NO_APPEND);
+    }
+
+    /* Elmasry, G., (2012), Tactical Wireless Communications and Networks: Design Concepts and Challenges, Wiley, ISBN 9781119951766. */
+    switch (wordformat) {
+    case WORDFORMAT_INITIAL:
+        state->label     = (cache >> 2) & 0x1F;
+        state->sublabel  = (cache >> 7) & 0x7;
+        state->extension = 0;
+        col_append_fstr(pinfo->cinfo, COL_INFO, " J%d.%dI", state->label, state->sublabel);
+
+        proto_item_append_text(link16_item, " J%d.%dI", state->label, state->sublabel);
+        break;
+    case WORDFORMAT_EXTENSION:
+        col_append_fstr(pinfo->cinfo, COL_INFO, " J%d.%dE%d", state->label, state->sublabel, state->extension);
+
+        proto_item_append_text(link16_item, " J%d.%dE%d", state->label, state->sublabel, state->extension);
+        state->extension++;
+        break;
+    case WORDFORMAT_CONTINUATION:
+        contlabel = (cache >> 2) & 0x1F;
+        col_append_fstr(pinfo->cinfo, COL_INFO, " J%d.%dC%d", state->label, state->sublabel, contlabel);
+
+        proto_item_append_text(link16_item, " J%d.%dC%d", state->label, state->sublabel, contlabel);
+    }
+
+    proto_item_append_text(link16_item, " %s", val_to_str_const(MKPAIR(state->label, state->sublabel), Link16_Message_Strings, "Unknown"));
+
+    return tvb_captured_length(tvb);
+}
+
+void proto_register_link16(void)
+{
+    static hf_register_info hf[] = {
+        { &hf_link16_wordformat,
+          { "Word Format", "link16.wordformat", FT_UINT16, BASE_DEC, VALS(WordFormat_Strings), 0x3,
+            NULL, HFILL }},
+        { &hf_link16_label,
+          { "Label", "link16.label", FT_UINT16, BASE_DEC, VALS(Link16_Label_Strings), 0x7C,
+            NULL, HFILL }},
+        { &hf_link16_sublabel,
+          { "Sublabel", "link16.sublabel", FT_UINT16, BASE_DEC, NULL, 0x380,
+            NULL, HFILL }},
+        { &hf_link16_mli,
+          { "Message Length Indicator", "link16.mli", FT_UINT16, BASE_DEC, NULL, 0x1C00,
+            NULL, HFILL }},
+        { &hf_link16_contlabel,
+          { "Continuation Word Label", "link16.contlabel", FT_UINT16, BASE_DEC, NULL, 0x7C,
+            NULL, HFILL }}
+    };
+    static gint *ett[] = {
+        &ett_link16,
+    };
+
+    proto_link16 = proto_register_protocol("Link 16", "LINK16", "link16");
+    proto_register_field_array(proto_link16, hf, array_length (hf));
+    proto_register_subtree_array(ett, array_length(ett));
+    new_register_dissector("link16", dissect_link16, proto_link16);
+}
+
+void proto_reg_handoff_link16(void)
+{
+}