298 lines
17 KiB
C
298 lines
17 KiB
C
/* packet-componentstatus.c
|
|
* Routines for the Component Status Protocol of the rsplib RSerPool implementation
|
|
* http://www.tdr.wiwi.uni-due.de/forschung/forschungsprojekte/reliable-server-pooling//
|
|
*
|
|
* Copyright 2006 by Thomas Dreibholz <dreibh [AT] exp-math.uni-essen.de>
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* Copied from README.developer
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <epan/packet.h>
|
|
|
|
|
|
#if 0
|
|
#define CSP_VERSION 0x0200
|
|
|
|
#define CID_GROUP(id) (((uint64_t) id >> 56) & (0xffffULL)
|
|
#define CID_OBJECT(id) (((uint64_t) id & 0xffffffffffffffULL)
|
|
|
|
#define CID_GROUP_REGISTRAR 0x0001
|
|
#define CID_GROUP_POOLELEMENT 0x0002
|
|
#define CID_GROUP_POOLUSER 0x0003
|
|
|
|
#define CID_COMPOUND(group, object) (((uint64_t) (group & 0xffff) << 56) | CID_OBJECT((uint64_t)object))
|
|
|
|
#define CSPT_REPORT
|
|
#endif
|
|
|
|
void proto_register_componentstatusprotocol(void);
|
|
void proto_reg_handoff_componentstatusprotocol(void);
|
|
|
|
/* Initialize the protocol and registered fields */
|
|
static int proto_componentstatusprotocol = -1;
|
|
static int hf_message_type = -1;
|
|
static int hf_message_flags = -1;
|
|
static int hf_message_length = -1;
|
|
static int hf_message_version = -1;
|
|
static int hf_message_senderid = -1;
|
|
static int hf_message_sendertimestamp = -1;
|
|
static int hf_componentstatusreport_reportinterval = -1;
|
|
static int hf_componentstatusreport_location = -1;
|
|
static int hf_componentstatusreport_status = -1;
|
|
static int hf_componentstatusreport_workload = -1;
|
|
static int hf_componentstatusreport_associations = -1;
|
|
/* static int hf_componentstatusreport_associationarray = -1; */
|
|
static int hf_componentassociation_receiverid = -1;
|
|
static int hf_componentassociation_duration = -1;
|
|
static int hf_componentassociation_flags = -1;
|
|
static int hf_componentassociation_protocolid = -1;
|
|
static int hf_componentassociation_ppid = -1;
|
|
static int hf_message_flags_final_bit = -1;
|
|
|
|
/* Initialize the subtree pointers */
|
|
static gint ett_componentstatusprotocol = -1;
|
|
static gint ett_message_flags = -1;
|
|
static gint ett_association = -1;
|
|
|
|
|
|
#define COMPONENTSTATUSPROTOCOL_PORT 2960 /* Not IANA registered */
|
|
#define COMPONENTSTATUSPROTOCOL_VERSION 0x0200
|
|
|
|
|
|
/* Dissectors for messages. This is specific to ComponentStatusProtocol */
|
|
#define MESSAGE_TYPE_LENGTH 1
|
|
#define MESSAGE_FLAGS_LENGTH 1
|
|
#define MESSAGE_LENGTH_LENGTH 2
|
|
#define MESSAGE_VERSION_LENGTH 4
|
|
#define MESSAGE_SENDERID_LENGTH 8
|
|
#define MESSAGE_SENDERTIMESTAMP_LENGTH 8
|
|
|
|
|
|
#define MESSAGE_TYPE_OFFSET 0
|
|
#define MESSAGE_FLAGS_OFFSET (MESSAGE_TYPE_OFFSET + MESSAGE_TYPE_LENGTH)
|
|
#define MESSAGE_LENGTH_OFFSET (MESSAGE_FLAGS_OFFSET + MESSAGE_FLAGS_LENGTH)
|
|
#define MESSAGE_VERSION_OFFSET (MESSAGE_LENGTH_OFFSET + MESSAGE_LENGTH_LENGTH)
|
|
#define MESSAGE_SENDERID_OFFSET (MESSAGE_VERSION_OFFSET + MESSAGE_VERSION_LENGTH)
|
|
#define MESSAGE_SENDERTIMESTAMP_OFFSET (MESSAGE_SENDERID_OFFSET + MESSAGE_SENDERID_LENGTH)
|
|
#define MESSAGE_VALUE_OFFSET (MESSAGE_SENDERTIMESTAMP_OFFSET + MESSAGE_SENDERTIMESTAMP_LENGTH)
|
|
|
|
|
|
#define COMPONENTSTATUSREPORT_REPORTINTERVAL_LENGTH 4
|
|
#define COMPONENTSTATUSREPORT_WORKLOAD_LENGTH 2
|
|
#define COMPONENTSTATUSREPORT_ASSOCIATIONS_LENGTH 2
|
|
#define COMPONENTSTATUSREPORT_LOCATION_LENGTH 128
|
|
#define COMPONENTSTATUSREPORT_STATUS_LENGTH 128
|
|
|
|
|
|
#define COMPONENTSTATUSREPORT_REPORTINTERVAL_OFFSET MESSAGE_VALUE_OFFSET
|
|
#define COMPONENTSTATUSREPORT_LOCATION_OFFSET (COMPONENTSTATUSREPORT_REPORTINTERVAL_OFFSET + COMPONENTSTATUSREPORT_REPORTINTERVAL_LENGTH)
|
|
#define COMPONENTSTATUSREPORT_STATUS_OFFSET (COMPONENTSTATUSREPORT_LOCATION_OFFSET + COMPONENTSTATUSREPORT_LOCATION_LENGTH)
|
|
#define COMPONENTSTATUSREPORT_WORKLOAD_OFFSET (COMPONENTSTATUSREPORT_STATUS_OFFSET + COMPONENTSTATUSREPORT_STATUS_LENGTH)
|
|
#define COMPONENTSTATUSREPORT_ASSOCIATIONS_OFFSET (COMPONENTSTATUSREPORT_WORKLOAD_OFFSET + COMPONENTSTATUSREPORT_WORKLOAD_LENGTH)
|
|
#define COMPONENTSTATUSREPORT_ASSOCIATIONARRAY_OFFSET (COMPONENTSTATUSREPORT_ASSOCIATIONS_OFFSET + COMPONENTSTATUSREPORT_ASSOCIATIONS_LENGTH)
|
|
|
|
|
|
#define COMPONENTASSOCIATION_RECEIVERID_LENGTH 8
|
|
#define COMPONENTASSOCIATION_DURATION_LENGTH 8
|
|
#define COMPONENTASSOCIATION_FLAGS_LENGTH 2
|
|
#define COMPONENTASSOCIATION_PROTOCOLID_LENGTH 2
|
|
#define COMPONENTASSOCIATION_PPID_LENGTH 4
|
|
|
|
#define COMPONENTASSOCIATION_RECEIVERID_OFFSET 0
|
|
#define COMPONENTASSOCIATION_DURATION_OFFSET (COMPONENTASSOCIATION_RECEIVERID_OFFSET + COMPONENTASSOCIATION_RECEIVERID_LENGTH)
|
|
#define COMPONENTASSOCIATION_FLAGS_OFFSET (COMPONENTASSOCIATION_DURATION_OFFSET + COMPONENTASSOCIATION_DURATION_LENGTH)
|
|
#define COMPONENTASSOCIATION_PROTOCOLID_OFFSET (COMPONENTASSOCIATION_FLAGS_OFFSET + COMPONENTASSOCIATION_FLAGS_LENGTH)
|
|
#define COMPONENTASSOCIATION_PPID_OFFSET (COMPONENTASSOCIATION_PROTOCOLID_OFFSET + COMPONENTASSOCIATION_PROTOCOLID_LENGTH)
|
|
#define COMPONENTASSOCIATION_LENGTH (COMPONENTASSOCIATION_PPID_OFFSET + COMPONENTASSOCIATION_PPID_LENGTH)
|
|
|
|
|
|
#define COMPONENTSTATUS_COMPONENTSTATUSREPORT_MESSAGE_TYPE 0x01
|
|
|
|
|
|
#define CSPF_FINAL (1 << 0)
|
|
static const true_false_string message_flags_final_bit = {
|
|
"Final message",
|
|
"Not final message"
|
|
};
|
|
|
|
|
|
static const value_string message_type_values[] = {
|
|
{ COMPONENTSTATUS_COMPONENTSTATUSREPORT_MESSAGE_TYPE, "ComponentStatus Report" },
|
|
{ 0, NULL }
|
|
};
|
|
|
|
|
|
static void
|
|
dissect_componentstatusprotocol_componentassociation_message(tvbuff_t *message_tvb, proto_tree *message_tree)
|
|
{
|
|
proto_tree_add_item(message_tree, hf_componentassociation_receiverid, message_tvb, COMPONENTASSOCIATION_RECEIVERID_OFFSET, COMPONENTASSOCIATION_RECEIVERID_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(message_tree, hf_componentassociation_duration, message_tvb, COMPONENTASSOCIATION_DURATION_OFFSET, COMPONENTASSOCIATION_DURATION_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(message_tree, hf_componentassociation_flags, message_tvb, COMPONENTASSOCIATION_FLAGS_OFFSET, COMPONENTASSOCIATION_FLAGS_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(message_tree, hf_componentassociation_protocolid, message_tvb, COMPONENTASSOCIATION_PROTOCOLID_OFFSET, COMPONENTASSOCIATION_PROTOCOLID_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(message_tree, hf_componentassociation_ppid, message_tvb, COMPONENTASSOCIATION_PPID_OFFSET, COMPONENTASSOCIATION_PPID_LENGTH, ENC_BIG_ENDIAN);
|
|
}
|
|
|
|
|
|
static void
|
|
dissect_componentstatusprotocol_componentstatusreport_message(tvbuff_t *message_tvb, proto_tree *message_tree)
|
|
{
|
|
tvbuff_t *association_tvb;
|
|
proto_tree *association_tree;
|
|
/* gint associations; - variable set but not used, so commented out */
|
|
int i;
|
|
gint offset;
|
|
|
|
proto_tree_add_item(message_tree, hf_componentstatusreport_reportinterval, message_tvb, COMPONENTSTATUSREPORT_REPORTINTERVAL_OFFSET, COMPONENTSTATUSREPORT_REPORTINTERVAL_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(message_tree, hf_componentstatusreport_location, message_tvb, COMPONENTSTATUSREPORT_LOCATION_OFFSET, COMPONENTSTATUSREPORT_LOCATION_LENGTH, ENC_ASCII|ENC_NA);
|
|
proto_tree_add_item(message_tree, hf_componentstatusreport_status, message_tvb, COMPONENTSTATUSREPORT_STATUS_OFFSET, COMPONENTSTATUSREPORT_STATUS_LENGTH, ENC_ASCII|ENC_NA);
|
|
proto_tree_add_item(message_tree, hf_componentstatusreport_workload, message_tvb, COMPONENTSTATUSREPORT_WORKLOAD_OFFSET, COMPONENTSTATUSREPORT_WORKLOAD_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(message_tree, hf_componentstatusreport_associations, message_tvb, COMPONENTSTATUSREPORT_ASSOCIATIONS_OFFSET, COMPONENTSTATUSREPORT_ASSOCIATIONS_LENGTH, ENC_BIG_ENDIAN);
|
|
|
|
/* associations = tvb_get_ntohs(message_tvb, COMPONENTSTATUSREPORT_ASSOCIATIONS_OFFSET); */
|
|
offset = COMPONENTSTATUSREPORT_ASSOCIATIONARRAY_OFFSET;
|
|
i = 1;
|
|
while(tvb_reported_length_remaining(message_tvb, offset) >= COMPONENTASSOCIATION_LENGTH) {
|
|
association_tree = proto_tree_add_subtree_format(message_tree, message_tvb, offset, COMPONENTASSOCIATION_LENGTH,
|
|
ett_association, NULL, "Association #%d", i++);
|
|
association_tvb = tvb_new_subset_length_caplen(message_tvb, offset,
|
|
MIN(COMPONENTASSOCIATION_LENGTH, tvb_reported_length_remaining(message_tvb, offset)),
|
|
COMPONENTASSOCIATION_LENGTH);
|
|
|
|
dissect_componentstatusprotocol_componentassociation_message(association_tvb, association_tree);
|
|
offset += COMPONENTASSOCIATION_LENGTH;
|
|
}
|
|
}
|
|
|
|
|
|
static void
|
|
dissect_componentstatusprotocol_message(tvbuff_t *message_tvb, packet_info *pinfo, proto_tree *componentstatusprotocol_tree)
|
|
{
|
|
proto_item* flags_item;
|
|
proto_tree* flags_tree;
|
|
guint8 type;
|
|
|
|
type = tvb_get_guint8(message_tvb, MESSAGE_TYPE_OFFSET);
|
|
col_set_str(pinfo->cinfo, COL_INFO, val_to_str_const(type, message_type_values, "Unknown ComponentStatusProtocol type"));
|
|
proto_tree_add_item(componentstatusprotocol_tree, hf_message_type, message_tvb, MESSAGE_TYPE_OFFSET, MESSAGE_TYPE_LENGTH, ENC_BIG_ENDIAN);
|
|
flags_item = proto_tree_add_item(componentstatusprotocol_tree, hf_message_flags, message_tvb, MESSAGE_FLAGS_OFFSET, MESSAGE_FLAGS_LENGTH, ENC_BIG_ENDIAN);
|
|
flags_tree = proto_item_add_subtree(flags_item, ett_message_flags);
|
|
proto_tree_add_item(flags_tree, hf_message_flags_final_bit, message_tvb, MESSAGE_FLAGS_OFFSET, MESSAGE_FLAGS_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(componentstatusprotocol_tree, hf_message_length, message_tvb, MESSAGE_LENGTH_OFFSET, MESSAGE_LENGTH_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(componentstatusprotocol_tree, hf_message_version, message_tvb, MESSAGE_VERSION_OFFSET, MESSAGE_VERSION_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(componentstatusprotocol_tree, hf_message_senderid, message_tvb, MESSAGE_SENDERID_OFFSET, MESSAGE_SENDERID_LENGTH, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(componentstatusprotocol_tree, hf_message_sendertimestamp, message_tvb, MESSAGE_SENDERTIMESTAMP_OFFSET, MESSAGE_SENDERTIMESTAMP_LENGTH, ENC_BIG_ENDIAN);
|
|
switch (type) {
|
|
case COMPONENTSTATUS_COMPONENTSTATUSREPORT_MESSAGE_TYPE:
|
|
dissect_componentstatusprotocol_componentstatusreport_message(message_tvb, componentstatusprotocol_tree);
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
static int
|
|
dissect_componentstatusprotocol(tvbuff_t *message_tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
|
|
{
|
|
proto_item *componentstatusprotocol_item;
|
|
proto_tree *componentstatusprotocol_tree;
|
|
gint8 type;
|
|
gint32 version;
|
|
|
|
if (tvb_reported_length(message_tvb) < (MESSAGE_VERSION_OFFSET + MESSAGE_VERSION_LENGTH))
|
|
return(0);
|
|
|
|
/* Check, if this packet really contains a ComponentStatusProtocol message */
|
|
type = tvb_get_guint8(message_tvb, MESSAGE_TYPE_OFFSET);
|
|
if (type != COMPONENTSTATUS_COMPONENTSTATUSREPORT_MESSAGE_TYPE) {
|
|
return(0);
|
|
}
|
|
version = tvb_get_ntohl(message_tvb, MESSAGE_VERSION_OFFSET);
|
|
if (version != COMPONENTSTATUSPROTOCOL_VERSION) {
|
|
return(0);
|
|
}
|
|
|
|
col_set_str(pinfo->cinfo, COL_PROTOCOL, "ComponentStatusProtocol");
|
|
|
|
/* create the componentstatusprotocol protocol tree */
|
|
componentstatusprotocol_item = proto_tree_add_item(tree, proto_componentstatusprotocol, message_tvb, 0, -1, ENC_NA);
|
|
componentstatusprotocol_tree = proto_item_add_subtree(componentstatusprotocol_item, ett_componentstatusprotocol);
|
|
|
|
/* dissect the message */
|
|
dissect_componentstatusprotocol_message(message_tvb, pinfo, componentstatusprotocol_tree);
|
|
return(tvb_reported_length(message_tvb));
|
|
}
|
|
|
|
|
|
/* Register the protocol with Wireshark */
|
|
void
|
|
proto_register_componentstatusprotocol(void)
|
|
{
|
|
|
|
/* Setup list of header fields */
|
|
static hf_register_info hf[] = {
|
|
{ &hf_message_type, { "Type", "componentstatusprotocol.message_type", FT_UINT8, BASE_DEC, VALS(message_type_values), 0x0, NULL, HFILL } },
|
|
{ &hf_message_flags, { "Flags", "componentstatusprotocol.message_flags", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_message_flags_final_bit, { "F-Bit", "componentstatusprotocol.message_final_bit", FT_BOOLEAN, 8, TFS(&message_flags_final_bit), CSPF_FINAL, NULL, HFILL } },
|
|
{ &hf_message_length, { "Length", "componentstatusprotocol.message_length", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_message_version, { "Version", "componentstatusprotocol.message_version", FT_UINT32, BASE_HEX, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_message_senderid, { "SenderID", "componentstatusprotocol.message_senderid", FT_UINT64, BASE_HEX, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_message_sendertimestamp, { "SenderTimeStamp", "componentstatusprotocol.message_sendertimestamp", FT_UINT64, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentstatusreport_reportinterval, { "ReportInterval", "componentstatusprotocol.componentstatusreport_reportinterval", FT_UINT32, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentstatusreport_location, { "Location", "componentstatusprotocol.componentstatusreport_location", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentstatusreport_status, { "Status", "componentstatusprotocol.componentstatusreport_status", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentstatusreport_workload, { "Workload", "componentstatusprotocol.componentstatusreport_workload", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentstatusreport_associations, { "Associations", "componentstatusprotocol.componentstatusreport_associations", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
#if 0
|
|
{ &hf_componentstatusreport_associationarray, { "AssociationArray", "componentstatusprotocol.componentstatusreport_AssociationArray", FT_UINT32, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
#endif
|
|
{ &hf_componentassociation_receiverid, { "ReceiverID", "componentstatusprotocol.componentassociation_receiverid", FT_UINT64, BASE_HEX, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentassociation_duration, { "Duration", "componentstatusprotocol.componentassociation_duration", FT_UINT64, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentassociation_flags, { "Flags", "componentstatusprotocol.componentassociation_flags", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentassociation_protocolid, { "ProtocolID", "componentstatusprotocol.componentassociation_protocolid", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_componentassociation_ppid, { "PPID", "componentstatusprotocol.componentassociation_ppid", FT_UINT32, BASE_DEC, NULL, 0x0, NULL, HFILL } },
|
|
};
|
|
|
|
/* Setup protocol subtree array */
|
|
static gint *ett[] = {
|
|
&ett_componentstatusprotocol,
|
|
&ett_message_flags,
|
|
&ett_association
|
|
};
|
|
|
|
/* Register the protocol name and description */
|
|
proto_componentstatusprotocol = proto_register_protocol("Component Status Protocol", "ComponentStatusProtocol", "componentstatusprotocol");
|
|
|
|
/* Required function calls to register the header fields and subtrees used */
|
|
proto_register_field_array(proto_componentstatusprotocol, hf, array_length(hf));
|
|
proto_register_subtree_array(ett, array_length(ett));
|
|
}
|
|
|
|
void
|
|
proto_reg_handoff_componentstatusprotocol(void)
|
|
{
|
|
dissector_handle_t componentstatusprotocol_handle;
|
|
|
|
componentstatusprotocol_handle = create_dissector_handle(dissect_componentstatusprotocol, proto_componentstatusprotocol);
|
|
dissector_add_uint_with_preference("udp.port", COMPONENTSTATUSPROTOCOL_PORT, componentstatusprotocol_handle);
|
|
}
|
|
|
|
/*
|
|
* Editor modelines
|
|
*
|
|
* Local Variables:
|
|
* c-basic-offset: 2
|
|
* tab-width: 8
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
*
|
|
* ex: set shiftwidth=2 tabstop=8 expandtab:
|
|
* :indentSize=2:tabSize=8:noTabs=true:
|
|
*/
|