Ethereal-dev: [Ethereal-dev] RMI dissector patch

Note: This archive is from the project's previous web site, ethereal.com. This list is no longer active.

From: Michael Stiller <ms@xxxxxxxxxx>
Date: 29 May 2002 12:49:16 +0200
Hi, 

attached is a patch for ethereal 0.9.4 which adds Java RMI protocoll
dissector capability. 
This is my first dissector for ethereal, so please bear with me ;)
Comments are very welcome.

Cheers,

-Michael



diff -ruN ethereal-0.9.4.orig/Makefile.am ethereal-0.9.4/Makefile.am
--- ethereal-0.9.4.orig/Makefile.am	Sat May 18 04:42:04 2002
+++ ethereal-0.9.4/Makefile.am	Mon May 20 10:53:17 2002
@@ -240,6 +240,7 @@
 	packet-rip.c   \
 	packet-ripng.c \
 	packet-rlogin.c \
+	packet-rmi.c \
 	packet-rpc.c   \
 	packet-rquota.c \
 	packet-rsh.c   \
diff -ruN ethereal-0.9.4.orig/Makefile.nmake ethereal-0.9.4/Makefile.nmake
--- ethereal-0.9.4.orig/Makefile.nmake	Sat May 18 04:42:04 2002
+++ ethereal-0.9.4/Makefile.nmake	Mon May 20 10:53:38 2002
@@ -191,6 +191,7 @@
 	packet-rip.c   \
 	packet-ripng.c \
 	packet-rlogin.c \
+	packet-rmi.c \
 	packet-rpc.c   \
 	packet-rquota.c \
 	packet-rsh.c   \
diff -ruN ethereal-0.9.4.orig/packet-rmi.c ethereal-0.9.4/packet-rmi.c
--- ethereal-0.9.4.orig/packet-rmi.c	Thu Jan  1 01:00:00 1970
+++ ethereal-0.9.4/packet-rmi.c	Mon May 20 10:51:39 2002
@@ -0,0 +1,371 @@
+/* packet-rmi.c
+ * Routines for java rmiregistry dissection
+ * Copyright 2002, Michael Stiller <ms@xxxxxxxxxx>
+ *
+ * $Id: packet-rmi.c,v 1.2 2002/04/29 21:01:42 ms Exp $
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@xxxxxxxxxxxx>
+ * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#ifdef HAVE_SYS_TYPES_H
+# include <sys/types.h>
+#endif
+
+#ifdef HAVE_NETINET_IN_H
+# include <netinet/in.h>
+#endif
+
+#include <glib.h>
+
+#ifdef NEED_SNPRINTF_H
+# include "snprintf.h"
+#endif
+
+#include <epan/packet.h>
+#include <epan/strutil.h>
+
+#include "packet-rmi.h"
+
+/* Initialize the protocol and registered fields */
+static int proto_rmi             = -1;
+static int proto_ser             = -1;
+static int hf_rmi_magic          = -1;
+static int hf_rmi_version        = -1;
+static int hf_rmi_protocol       = -1;
+static int hf_rmi_inputmessage   = -1;
+static int hf_rmi_outputmessage  = -1;
+static int hf_rmi_epid_length    = -1;
+static int hf_rmi_epid_hostname  = -1;
+static int hf_rmi_epid_port      = -1;
+
+static int hf_ser_magic          = -1;
+static int hf_ser_version        = -1;
+
+/* Initialize the subtree pointers */
+static gint ett_rmi               = -1;
+static gint ett_rmi_magic         = -1;
+static gint ett_rmi_version       = -1;
+static gint ett_rmi_protocol      = -1;
+static gint ett_rmi_inputmessage  = -1;
+static gint ett_rmi_outputmessage = -1;
+static gint ett_rmi_epid_length   = -1;
+static gint ett_rmi_epid_hostname = -1;
+static gint ett_rmi_epid_port     = -1;
+
+static gint ett_ser               = -1;
+static gint ett_ser_magic         = -1;
+static gint ett_ser_version       = -1;
+
+#define TCP_PORT_RMI	1099
+
+static void
+dissect_rmi(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+    proto_item *ti;
+    proto_tree *rmi_tree;
+
+    tvbuff_t   *next_tvb;
+
+    gint       offset;
+    gint       next_offset;
+    int        datalen;
+    const u_char *data;
+
+    guint16    version, len, port;
+    guint8     message, proto;
+
+    rmi_type   rmitype;
+
+    char epid_hostname[256];
+
+    offset     = 0;
+    rmitype    = 0;
+
+/* Make entries in Protocol column and Info column on summary display */
+    if (check_col(pinfo->cinfo, COL_PROTOCOL)) 
+	col_set_str(pinfo->cinfo, COL_PROTOCOL, "RMI");
+
+    datalen = tvb_find_line_end(tvb, offset, -1, &next_offset);
+    data = tvb_get_ptr(tvb, offset, datalen);
+    
+    rmitype = get_rmi_type(data, datalen);
+    
+    if (check_col(pinfo->cinfo, COL_INFO)) {
+	switch(rmitype) {
+	case RMI_OUTPUTSTREAM:
+	    version = tvb_get_ntohs(tvb,4);
+	    col_add_fstr(pinfo->cinfo, COL_INFO,
+			 "JRMI, Version: %d, ", version);
+
+	    proto   = tvb_get_guint8(tvb, 6);
+	    col_append_str(pinfo->cinfo, COL_INFO, 
+			   val_to_str(proto, rmi_protocol_str,
+				      "Unknown protocol"));
+	    break;
+	case RMI_OUTPUTMESSAGE:
+	    message = tvb_get_guint8(tvb,0);
+	    col_add_str(pinfo->cinfo, COL_INFO,
+			"JRMI, ");
+	    col_append_str(pinfo->cinfo, COL_INFO,
+			   val_to_str(message, rmi_output_message_str,
+				      "Unknown message"));
+	    break;
+	case RMI_INPUTSTREAM:
+	    message = tvb_get_guint8(tvb,0);
+	    col_add_str(pinfo->cinfo, COL_INFO,
+			"JRMI, ");
+	    col_append_str(pinfo->cinfo, COL_INFO,
+			   val_to_str(message, rmi_input_message_str,
+				      "Unknown message"));
+	    break;
+	case SERIALIZATION_DATA:
+	    version = tvb_get_ntohs(tvb,2);
+	    col_add_fstr(pinfo->cinfo, COL_INFO,
+			 "Serialization data, Version: %d", version);
+	    break;
+	default:
+	    col_set_str(pinfo->cinfo, COL_INFO, "Continuation");
+	    break;
+	}
+    }
+
+    if (tree) {
+	ti = proto_tree_add_item(tree, proto_rmi, tvb, 0, -1, FALSE);
+	rmi_tree = proto_item_add_subtree(ti, ett_rmi);
+	switch(rmitype) {
+	case RMI_OUTPUTSTREAM:
+	    proto_tree_add_uint(rmi_tree, hf_rmi_magic,
+				tvb, offset,     4, tvb_get_ntohl(tvb,0));
+	    proto_tree_add_uint(rmi_tree, hf_rmi_version,
+				tvb, offset + 4, 2, tvb_get_ntohs(tvb,4));
+	    proto_tree_add_string(rmi_tree, hf_rmi_protocol,
+				  tvb, offset + 6, 1,
+				  val_to_str(tvb_get_guint8(tvb, 6),
+					     rmi_protocol_str,
+					     "Unknown Protocol"));
+	    break;
+	case RMI_INPUTSTREAM:
+	    message = tvb_get_guint8(tvb, 0);
+	    proto_tree_add_string(rmi_tree, hf_rmi_inputmessage,
+				  tvb, offset, 1,
+				  val_to_str(message,
+					     rmi_input_message_str,
+					     "Unknown Message"));
+	    if(message == RMI_INPUTSTREAM_MESSAGE_ACK) {
+		proto_tree_add_text(rmi_tree, tvb, offset + 1, -1,
+				    "EndPointIdentifier");
+		/* MESSAGE_ACK should include EndpointIdentifier */
+		len = tvb_get_ntohs(tvb, 1);
+		proto_tree_add_uint(rmi_tree, hf_rmi_epid_length,
+				       tvb, offset + 1, 2, len);
+		memset(epid_hostname, 0, sizeof(epid_hostname));
+		if (len < sizeof(epid_hostname)) {
+		    strncpy(epid_hostname,tvb_get_ptr(tvb, offset + 3, len),
+			    sizeof(epid_hostname));
+		} else {
+		    strncpy(epid_hostname,
+			    "<string too long>", sizeof(epid_hostname));
+		}
+		proto_tree_add_string(rmi_tree, hf_rmi_epid_hostname,
+				      tvb, offset + 3, strlen(epid_hostname),
+				      epid_hostname);
+
+		port = tvb_get_ntohs(tvb, offset + len + 5);
+  		proto_tree_add_uint(rmi_tree, hf_rmi_epid_port, 
+  				    tvb, offset + len + 5, 2, port);
+	    }
+	    if(message == RMI_INPUTSTREAM_MESSAGE_RETURNDATA) {
+		proto_tree_add_text(rmi_tree, tvb, offset + 1, -1,
+				    "Serialization Data");
+		next_tvb = tvb_new_subset(tvb, offset + 1, -1, -1);
+		dissect_ser(next_tvb, pinfo, tree);
+	    }
+	    break;
+	case RMI_OUTPUTMESSAGE:
+	    message = tvb_get_guint8(tvb, 0);
+	    proto_tree_add_string(rmi_tree, hf_rmi_outputmessage,
+				  tvb, offset, 1,
+				  val_to_str(message,
+					     rmi_output_message_str,
+					     "Unknown Message"));
+	    if(message == RMI_OUTPUTSTREAM_MESSAGE_CALL) {
+		proto_tree_add_text(rmi_tree, tvb, offset + 1, -1,
+				    "Serialization Data");
+		/* XXX */
+		next_tvb = tvb_new_subset(tvb, offset + 1, -1, -1);
+		dissect_ser(next_tvb, pinfo, tree);
+	    }
+	    if(message == RMI_OUTPUTSTREAM_MESSAGE_DGCACK) {
+		proto_tree_add_text(rmi_tree, tvb, offset + 1, -1,
+				    "UniqueIdentifier");
+	    }
+	    break;
+	case SERIALIZATION_DATA:
+	    dissect_ser(tvb, pinfo, tree);
+	    break;
+	default:
+	    break;
+	}
+    }
+}
+
+static void
+dissect_ser(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+    proto_item *ti;
+    proto_tree *ser_tree;
+
+    gint offset;
+
+    offset = 0;
+    
+    if(tree) {
+	ti = proto_tree_add_item(tree, proto_ser, tvb, 0, -1, FALSE);
+	ser_tree = proto_item_add_subtree(ti, ett_ser);
+	proto_tree_add_uint(ser_tree, hf_ser_magic,
+			    tvb, offset,     2, tvb_get_ntohs(tvb,0));
+	proto_tree_add_uint(ser_tree, hf_ser_version,
+			    tvb, offset + 2, 2, tvb_get_ntohs(tvb,2));
+
+    }
+}
+
+static rmi_type
+get_rmi_type(const u_char *data, int datalen)
+{
+    guint16 ser_magic;
+    
+    if (datalen >= 2) {
+	ser_magic = data[0] << 8 | data[1];
+	if (ser_magic == SER_STREAM_MAGIC) {
+	    return SERIALIZATION_DATA;
+	}
+    }
+    if (datalen >= 4) {
+	if(strncmp(data, "JRMI", 4) == 0) {
+	    return RMI_OUTPUTSTREAM;
+	}
+    }
+    if (datalen >= 1) {
+	if (data[0] == RMI_INPUTSTREAM_MESSAGE_ACK ||
+	    data[0] == RMI_INPUTSTREAM_MESSAGE_NOTSUPPORTED ||
+	    data[0] == RMI_INPUTSTREAM_MESSAGE_RETURNDATA ||
+	    data[0] == RMI_INPUTSTREAM_MESSAGE_PINGACK) {
+	    return RMI_INPUTSTREAM;
+	}
+    }
+    if (datalen >= 1) {
+	if (data[0] == RMI_OUTPUTSTREAM_MESSAGE_CALL ||
+	    data[0] == RMI_OUTPUTSTREAM_MESSAGE_PING ||
+	    data[0] == RMI_OUTPUTSTREAM_MESSAGE_DGCACK) {
+	    return RMI_OUTPUTMESSAGE;
+	}
+    }
+    return CONTINUATION;
+}
+
+void
+proto_register_rmi(void)
+{
+    
+    static hf_register_info hf[] = {
+	{ &hf_rmi_magic,
+	  { "Magic",   "rmi.magic",
+	    FT_UINT32, BASE_HEX, NULL, 0x0,
+	    "RMI Header Magic", HFILL }},
+	{ &hf_rmi_version,
+	  { "Version", "rmi.version",
+	    FT_UINT16, BASE_DEC, NULL, 0x0,          
+	    "RMI Protocol Version", HFILL }},
+	{ &hf_rmi_protocol,
+	  { "Protocol","rmi.protocol",
+	    FT_STRING, BASE_HEX, NULL, 0x0,          
+	    "RMI Protocol Type", HFILL }},
+	{ &hf_rmi_inputmessage,
+	  { "Input Stream Message", "rmi.inputstream.message",
+	    FT_STRING, BASE_HEX, NULL, 0x0,
+	    "RMI Inputstream Message Token", HFILL }},
+	{ &hf_rmi_outputmessage,
+	  { "Output Stream Message", "rmi.outputstream.message",
+	    FT_STRING, BASE_HEX, NULL, 0x0,
+	    "RMI Outputstream Message token", HFILL }},
+	{ &hf_rmi_epid_length,
+	  { "Length", "rmi.endpoint_id.length",
+	    FT_UINT16, BASE_DEC, NULL, 0x0,          
+	    "RMI Endpointidentifier Length", HFILL }},
+	{ &hf_rmi_epid_hostname,
+	  { "Hostname", "rmi.endpoint_id.hostname",
+	    FT_STRING, BASE_HEX, NULL, 0x0,
+	    "RMI Endpointidentifier Hostname", HFILL }},
+	{ &hf_rmi_epid_port,
+	  { "Port", "rmi.endpoint_id.port",
+	    FT_UINT16, BASE_DEC, NULL, 0x0,
+	    "RMI Endpointindentifier Port", HFILL }},
+
+	{ &hf_ser_magic,
+	  { "Magic",   "rmi.ser.magic",
+	    FT_UINT16, BASE_HEX, NULL, 0x0,
+	    "Java Serialization Magic", HFILL }},
+	{ &hf_ser_version,
+	  { "Version", "rmi.ser.version",
+	    FT_UINT16, BASE_DEC, NULL, 0x0,          
+	    "Java Serialization Version", HFILL }},
+    };
+    
+    static gint *ett[] = {
+	&ett_rmi,
+	&ett_rmi_magic,
+	&ett_rmi_version,
+	&ett_rmi_inputmessage,
+	&ett_rmi_outputmessage,
+	&ett_rmi_epid_length,
+	&ett_rmi_epid_hostname,
+	&ett_rmi_epid_port,
+	&ett_ser,
+    };
+    
+    proto_rmi = proto_register_protocol("Java RMI", "RMI", "rmi");
+    proto_ser = proto_register_protocol("Java Serialization", "Serialization",
+					"serialization");
+    proto_register_field_array(proto_rmi, hf, array_length(hf));
+    proto_register_subtree_array(ett, array_length(ett));
+
+}
+
+void
+proto_reg_handoff_rmi(void)
+{
+    dissector_handle_t rmi_handle;
+
+    rmi_handle = create_dissector_handle(dissect_rmi, proto_rmi);
+    dissector_add("tcp.port", TCP_PORT_RMI, rmi_handle);
+}
+
+
+
+
+
diff -ruN ethereal-0.9.4.orig/packet-rmi.h ethereal-0.9.4/packet-rmi.h
--- ethereal-0.9.4.orig/packet-rmi.h	Thu Jan  1 01:00:00 1970
+++ ethereal-0.9.4/packet-rmi.h	Mon May 20 10:51:39 2002
@@ -0,0 +1,100 @@
+/* packet-rmi.h
+ * header file for java rmiregistry dissection
+ * Copyright 2002, Michael Stiller <ms@xxxxxxxxxx>
+ *
+ * $Id: packet-rmi.h,v 1.2 2002/04/29 21:01:42 ms Exp $
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@xxxxxxxxxxxx>
+ * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+#ifndef __PACKET_RMI_H__
+#define __PACKET_RMI_H__
+
+#define SER_STREAM_MAGIC   0xaced
+
+#define SER_STREAM_VERSION 5
+
+#define SER_TC_NULL		0x70
+#define SER_TC_REFERENCE	0x71
+#define SER_TC_CLASSDESC	0x72
+#define SER_TC_OBJECT		0x73
+#define SER_TC_STRING		0x74
+#define SER_TC_ARRAY		0x75
+#define SER_TC_CLASS		0x76
+#define SER_TC_BLOCKDATA	0x77
+#define SER_TC_ENDBLOCKDATA	0x78
+#define SER_TC_RESET		0x79
+#define SER_TC_BLOCKDATALONG   	0x7A
+#define SER_TC_EXCEPTION   	0x7B
+
+#define RMI_MAGIC               "JRMI"
+#define RMI_MAGIC_HEX           0x4a524d49
+
+#define RMI_OUTPUTSTREAM_PROTOCOL_STREAM     0x4b
+#define RMI_OUTPUTSTREAM_PROTOCOL_SINGLEOP   0x4c
+#define RMI_OUTPUTSTREAM_PROTOCOL_MULTIPLEX  0x4d 
+
+#define RMI_OUTPUTSTREAM_MESSAGE_CALL        0x50
+#define RMI_OUTPUTSTREAM_MESSAGE_PING        0x52
+#define RMI_OUTPUTSTREAM_MESSAGE_DGCACK      0x54
+
+#define RMI_INPUTSTREAM_MESSAGE_ACK          0x4e
+#define RMI_INPUTSTREAM_MESSAGE_NOTSUPPORTED 0x4f
+#define RMI_INPUTSTREAM_MESSAGE_RETURNDATA   0x51
+#define RMI_INPUTSTREAM_MESSAGE_PINGACK      0x53
+
+typedef enum {
+    CONTINUATION        = 1,
+    RMI_OUTPUTSTREAM    = 2,
+    RMI_OUTPUTMESSAGE   = 3,
+    RMI_INPUTSTREAM     = 16,    
+    SERIALIZATION_DATA  = 128,
+} rmi_type;
+
+static const value_string rmi_protocol_str[] = {
+    {RMI_OUTPUTSTREAM_PROTOCOL_STREAM,    "StreamProtocol"},
+    {RMI_OUTPUTSTREAM_PROTOCOL_SINGLEOP,  "SingleOpProtocol"},
+    {RMI_OUTPUTSTREAM_PROTOCOL_MULTIPLEX, "MultiPlexProtocol"},
+    {0, NULL}
+};
+
+static const value_string rmi_output_message_str[] = {
+    {RMI_OUTPUTSTREAM_MESSAGE_CALL,       "Call"},
+    {RMI_OUTPUTSTREAM_MESSAGE_PING,       "Ping"},
+    {RMI_OUTPUTSTREAM_MESSAGE_DGCACK,     "DgcAck"},
+    {0, NULL}
+};
+
+static const value_string rmi_input_message_str[] = {
+    {RMI_INPUTSTREAM_MESSAGE_ACK,          "ProtocolAck"},
+    {RMI_INPUTSTREAM_MESSAGE_NOTSUPPORTED, "ProtocolNotSupported"},
+    {RMI_INPUTSTREAM_MESSAGE_RETURNDATA,   "ReturnData"},
+    {RMI_INPUTSTREAM_MESSAGE_PINGACK,      "PingAck"},
+    {0, NULL}
+};
+
+static void
+dissect_rmi(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+
+static void
+dissect_ser(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
+
+static rmi_type
+get_rmi_type(const u_char *data, int datalen);
+
+#endif