path: root/epan/dissectors/packet-ymsg.c

/* packet-ymsg.c
 * Routines for Yahoo Messenger YMSG protocol packet version 13 dissection
 * Copyright 2003, Wayne Parrott <wayne_p@pacific.net.au>
 * Copied from packet-yhoo.c and updated
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

#include "config.h"

#include <epan/packet.h>

#include "packet-tcp.h"
#include <epan/prefs.h>

void proto_register_ymsg(void);
void proto_reg_handoff_ymsg(void);

static int proto_ymsg = -1;
static int hf_ymsg_version = -1;
static int hf_ymsg_vendor = -1;
static int hf_ymsg_len = -1;
static int hf_ymsg_service = -1;
static int hf_ymsg_status = -1;
static int hf_ymsg_session_id = -1;

static int hf_ymsg_content = -1;
static int hf_ymsg_content_line = -1;
static int hf_ymsg_content_line_key = -1;
static int hf_ymsg_content_line_value = -1;

static gint ett_ymsg = -1;
static gint ett_ymsg_content = -1;
static gint ett_ymsg_content_line = -1;

#define TCP_PORT_YMSG	  23	/* XXX - this is Telnet! */
#define TCP_PORT_YMSG_2	  25	/* And this is SMTP! */
#define TCP_PORT_YMSG_3	5050	/* This, however, is regular Yahoo Messenger */

/* desegmentation of YMSG over TCP */
static gboolean ymsg_desegment = TRUE;

/*
 * This is from yahoolib2.c from libyahoo2.
 *
 * See also
 *
 *	http://libyahoo2.sourceforge.net/ymsg-9.txt
 *
 * and
 *
 *	http://www.venkydude.com/articles/yahoo.htm
 *
 * and
 *
 *	http://www.cse.iitb.ac.in/~varunk/YahooProtocol.htm
 *
 * and
 *
 *	http://www.geocrawler.com/archives/3/4893/2002/1/0/7459037/
 *
 * and
 *
 *	http://www.geocities.com/ziggycubbe/ym.html
 */

/* Service constants */
enum yahoo_service { /* these are easier to see in hex */
	YAHOO_SERVICE_LOGON			= 1,
	YAHOO_SERVICE_LOGOFF,
	YAHOO_SERVICE_ISAWAY,
	YAHOO_SERVICE_ISBACK,
	YAHOO_SERVICE_IDLE,				/* 5 (placemarker) */
	YAHOO_SERVICE_MESSAGE,
	YAHOO_SERVICE_IDACT,
	YAHOO_SERVICE_IDDEACT,
	YAHOO_SERVICE_MAILSTAT,
	YAHOO_SERVICE_USERSTAT,				/* 0xa */
	YAHOO_SERVICE_NEWMAIL,
	YAHOO_SERVICE_CHATINVITE,
	YAHOO_SERVICE_CALENDAR,
	YAHOO_SERVICE_NEWPERSONALMAIL,
	YAHOO_SERVICE_NEWCONTACT,
	YAHOO_SERVICE_ADDIDENT,				/* 0x10 */
	YAHOO_SERVICE_ADDIGNORE,
	YAHOO_SERVICE_PING,
	YAHOO_SERVICE_GOTGROUPRENAME,			/* < 1, 36(old), 37(new) */
	YAHOO_SERVICE_SYSMESSAGE		= 0x14,
	YAHOO_SERVICE_SKINNAME			= 0x15,
	YAHOO_SERVICE_PASSTHROUGH2		= 0x16,
	YAHOO_SERVICE_CONFINVITE		= 0x18,
	YAHOO_SERVICE_CONFLOGON,
	YAHOO_SERVICE_CONFDECLINE,
	YAHOO_SERVICE_CONFLOGOFF,
	YAHOO_SERVICE_CONFADDINVITE,
	YAHOO_SERVICE_CONFMSG,
	YAHOO_SERVICE_CHATLOGON,
	YAHOO_SERVICE_CHATLOGOFF,
	YAHOO_SERVICE_CHATMSG			= 0x20,
	YAHOO_SERVICE_GAMELOGON			= 0x28,
	YAHOO_SERVICE_GAMELOGOFF,
	YAHOO_SERVICE_GAMEMSG			= 0x2a,
	YAHOO_SERVICE_FILETRANSFER		= 0x46,
	YAHOO_SERVICE_VOICECHAT			= 0x4A,
	YAHOO_SERVICE_NOTIFY,
	YAHOO_SERVICE_VERIFY,
	YAHOO_SERVICE_P2PFILEXFER,
	YAHOO_SERVICE_PEERTOPEER		= 0x4F, /* Checks if P2P possible */
	YAHOO_SERVICE_WEBCAM,
	YAHOO_SERVICE_AUTHRESP			= 0x54,
	YAHOO_SERVICE_LIST,
	YAHOO_SERVICE_AUTH			= 0x57,
	YAHOO_SERVICE_AUTHBUDDY			= 0x6d,
	YAHOO_SERVICE_ADDBUDDY			= 0x83,
	YAHOO_SERVICE_REMBUDDY,
	YAHOO_SERVICE_IGNORECONTACT,			/* > 1, 7, 13 < 1, 66, 13, 0*/
	YAHOO_SERVICE_REJECTCONTACT,
	YAHOO_SERVICE_GROUPRENAME		= 0x89, /* > 1, 65(new), 66(0), 67(old) */
	YAHOO_SERVICE_KEEPALIVE			= 0x8a,
	YAHOO_SERVICE_CHATONLINE		= 0x96, /* > 109(id), 1, 6(abcde) < 0,1*/
	YAHOO_SERVICE_CHATGOTO,
	YAHOO_SERVICE_CHATJOIN,				/* > 1 104-room 129-1600326591 62-2 */
	YAHOO_SERVICE_CHATLEAVE,
	YAHOO_SERVICE_CHATEXIT			= 0x9b,
	YAHOO_SERVICE_CHATADDINVITE		= 0x9d,
	YAHOO_SERVICE_CHATLOGOUT		= 0xa0,
	YAHOO_SERVICE_CHATPING,
	YAHOO_SERVICE_COMMENT			= 0xa8,
	YAHOO_SERVICE_GAME_INVITE		= 0xb7,
	YAHOO_SERVICE_STEALTH_PERM		= 0xb9,
	YAHOO_SERVICE_STEALTH_SESSION		= 0xba,
	YAHOO_SERVICE_AVATAR			= 0xbc,
	YAHOO_SERVICE_PICTURE_CHECKSUM		= 0xbd,
	YAHOO_SERVICE_PICTURE			= 0xbe,
	YAHOO_SERVICE_PICTURE_UPDATE		= 0xc1,
	YAHOO_SERVICE_PICTURE_UPLOAD		= 0xc2,
	YAHOO_SERVICE_YAB_UPDATE		= 0xc4,
	YAHOO_SERVICE_Y6_VISIBLE_TOGGLE		= 0xc5, /* YMSG13, key 13: 2 = invisible, 1 = visible */
	YAHOO_SERVICE_Y6_STATUS_UPDATE		= 0xc6, /* YMSG13 */
	YAHOO_SERVICE_PICTURE_STATUS		= 0xc7,	/* YMSG13, key 213: 0 = none, 1 = avatar, 2 = picture */
	YAHOO_SERVICE_VERIFY_ID_EXISTS		= 0xc8,
	YAHOO_SERVICE_AUDIBLE			= 0xd0,
	YAHOO_SERVICE_Y7_PHOTO_SHARING		= 0xd2,
	YAHOO_SERVICE_Y7_CONTACT_DETAILS	= 0xd3,	/* YMSG13 */
	YAHOO_SERVICE_Y7_CHAT_SESSION		= 0xd4,
	YAHOO_SERVICE_Y7_AUTHORIZATION		= 0xd6,	/* YMSG13 */
	YAHOO_SERVICE_Y7_FILETRANSFER		= 0xdc,	/* YMSG13 */
	YAHOO_SERVICE_Y7_FILETRANSFERINFO,		/* YMSG13 */
	YAHOO_SERVICE_Y7_FILETRANSFERACCEPT,		/* YMSG13 */
	YAHOO_SERVICE_Y7_MINGLE			= 0xe1, /* YMSG13 */
	YAHOO_SERVICE_Y7_CHANGE_GROUP		= 0xe7, /* YMSG13 */
 	YAHOO_SERVICE_STATUS_15			= 0xf0,
 	YAHOO_SERVICE_LIST_15			= 0xf1,
	YAHOO_SERVICE_WEBLOGIN			= 0x0226,
	YAHOO_SERVICE_SMS_MSG			= 0x02ea
};

/* Message flags */
enum yahoo_status {
	YAHOO_STATUS_AVAILABLE	    = 0,
	YAHOO_STATUS_BRB,
	YAHOO_STATUS_BUSY,
	YAHOO_STATUS_NOTATHOME,
	YAHOO_STATUS_NOTATDESK,
	YAHOO_STATUS_NOTINOFFICE,
	YAHOO_STATUS_ONPHONE,
	YAHOO_STATUS_ONVACATION,
	YAHOO_STATUS_OUTTOLUNCH,
	YAHOO_STATUS_STEPPEDOUT,
	YAHOO_STATUS_INVISIBLE	    = 12,
	YAHOO_STATUS_CUSTOM	    = 99,
	YAHOO_STATUS_IDLE	    = 999,
	YAHOO_STATUS_WEBLOGIN	    = 0x5a55aa55,
	YAHOO_STATUS_OFFLINE	    = 0x5a55aa56, /* don't ask */
	YAHOO_STATUS_TYPING	    = 0x16,
	YAHOO_STATUS_DISCONNECTED   = -1 /* in ymsg 15. doesn't mean the normal sense of 'disconnected' */
};

enum ypacket_status {
	YPACKET_STATUS_DISCONNECTED = -1,
	YPACKET_STATUS_DEFAULT	    = 0,
	YPACKET_STATUS_SERVERACK    = 1,
	YPACKET_STATUS_GAME	    = 0x2,
	YPACKET_STATUS_AWAY	    = 0x4,
	YPACKET_STATUS_CONTINUED    = 0x5,
	YPACKET_STATUS_INVISIBLE    = 12,
	YPACKET_STATUS_NOTIFY	    = 0x16,        /* TYPING */
	YPACKET_STATUS_WEBLOGIN	    = 0x5a55aa55,
	YPACKET_STATUS_OFFLINE	    = 0x5a55aa56
};

/* The size of the below struct minus 6 bytes of content */
#define YAHOO_HEADER_SIZE 20

#if 0
struct yahoo_rawpacket
{
	char ymsg[4];			/* Packet identification string (YMSG) */
	unsigned char version[2];	/* 2 bytes, little endian */
	unsigned char vendor[2];	/* 2 bytes, little endian */
	unsigned char len[2];		/* length - little endian */
	unsigned char service[2];	/* service - little endian */
	unsigned char status[4];	/* Status - online, away etc.*/
	unsigned char session_id[4];	/* Session ID */
	char content[6];		/* 6 is the minimum size of the content */
};
#endif

static const value_string ymsg_service_vals[] = {
	{YAHOO_SERVICE_LOGON,                 "Pager Logon"},
	{YAHOO_SERVICE_LOGOFF,                "Pager Logoff"},
	{YAHOO_SERVICE_ISAWAY,                "Is Away"},
	{YAHOO_SERVICE_ISBACK,                "Is Back"},
	{YAHOO_SERVICE_IDLE,                  "Idle"},
	{YAHOO_SERVICE_MESSAGE,               "Message"},
	{YAHOO_SERVICE_IDACT,                 "Activate Identity"},
	{YAHOO_SERVICE_IDDEACT,               "Deactivate Identity"},
	{YAHOO_SERVICE_MAILSTAT,              "Mail Status"},
	{YAHOO_SERVICE_USERSTAT,              "User Status"},
	{YAHOO_SERVICE_NEWMAIL,               "New Mail"},
	{YAHOO_SERVICE_CHATINVITE,            "Chat Invitation"},
	{YAHOO_SERVICE_CALENDAR,              "Calendar Reminder"},
	{YAHOO_SERVICE_NEWPERSONALMAIL,       "New Personals Mail"},
	{YAHOO_SERVICE_NEWCONTACT,            "New Friend"},
	{YAHOO_SERVICE_ADDIDENT,              "Add Identity"},
	{YAHOO_SERVICE_ADDIGNORE,             "Add Ignore"},
	{YAHOO_SERVICE_PING,                  "Ping"},
	{YAHOO_SERVICE_GOTGROUPRENAME,        "Got Group Rename"},
	{YAHOO_SERVICE_SYSMESSAGE,            "System Message"},
	{YAHOO_SERVICE_SKINNAME,              "Skinname"},
	{YAHOO_SERVICE_PASSTHROUGH2,          "Passthrough 2"},
	{YAHOO_SERVICE_CONFINVITE,            "Conference Invitation"},
	{YAHOO_SERVICE_CONFLOGON,             "Conference Logon"},
	{YAHOO_SERVICE_CONFDECLINE,           "Conference Decline"},
	{YAHOO_SERVICE_CONFLOGOFF,            "Conference Logoff"},
	{YAHOO_SERVICE_CONFADDINVITE,         "Conference Additional Invitation"},
	{YAHOO_SERVICE_CONFMSG,               "Conference Message"},
	{YAHOO_SERVICE_CHATLOGON,             "Chat Logon"},
	{YAHOO_SERVICE_CHATLOGOFF,            "Chat Logoff"},
	{YAHOO_SERVICE_CHATMSG,               "Chat Message"},
	{YAHOO_SERVICE_GAMELOGON,             "Game Logon"},
	{YAHOO_SERVICE_GAMELOGOFF,            "Game Logoff"},
	{YAHOO_SERVICE_GAMEMSG,               "Game Message"},
	{YAHOO_SERVICE_FILETRANSFER,          "File Transfer"},
	{YAHOO_SERVICE_VOICECHAT,             "Voice Chat"},
	{YAHOO_SERVICE_NOTIFY,                "Notify"},
	{YAHOO_SERVICE_VERIFY,                "Verify"},
	{YAHOO_SERVICE_P2PFILEXFER,           "P2P File Transfer"},
	{YAHOO_SERVICE_PEERTOPEER,            "Peer To Peer"},
	{YAHOO_SERVICE_WEBCAM,                "WebCam"},
	{YAHOO_SERVICE_AUTHRESP,              "Authentication Response"},
	{YAHOO_SERVICE_LIST,                  "List"},
	{YAHOO_SERVICE_AUTH,                  "Authentication"},
	{YAHOO_SERVICE_AUTHBUDDY,             "Authorize Buddy"},
	{YAHOO_SERVICE_ADDBUDDY,              "Add Buddy"},
	{YAHOO_SERVICE_REMBUDDY,              "Remove Buddy"},
	{YAHOO_SERVICE_IGNORECONTACT,         "Ignore Contact"},
	{YAHOO_SERVICE_REJECTCONTACT,         "Reject Contact"},
	{YAHOO_SERVICE_GROUPRENAME,           "Group Rename"},
	{YAHOO_SERVICE_KEEPALIVE,             "Keep Alive"},
	{YAHOO_SERVICE_CHATONLINE,            "Chat Online"},
	{YAHOO_SERVICE_CHATGOTO,              "Chat Goto"},
	{YAHOO_SERVICE_CHATJOIN,              "Chat Join"},
	{YAHOO_SERVICE_CHATLEAVE,             "Chat Leave"},
	{YAHOO_SERVICE_CHATEXIT,              "Chat Exit"},
	{YAHOO_SERVICE_CHATADDINVITE,         "Chat Invite"},
	{YAHOO_SERVICE_CHATLOGOUT,            "Chat Logout"},
	{YAHOO_SERVICE_CHATPING,              "Chat Ping"},
	{YAHOO_SERVICE_COMMENT,               "Comment"},
	{YAHOO_SERVICE_GAME_INVITE,           "Game Invite"},
	{YAHOO_SERVICE_STEALTH_PERM,          "Stealth Permanent"},
	{YAHOO_SERVICE_STEALTH_SESSION,       "Stealth Session"},
	{YAHOO_SERVICE_AVATAR,                "Avatar"},
	{YAHOO_SERVICE_PICTURE_CHECKSUM,      "Picture Checksum"},
	{YAHOO_SERVICE_PICTURE,               "Picture"},
	{YAHOO_SERVICE_PICTURE_UPDATE,        "Picture Update"},
	{YAHOO_SERVICE_PICTURE_UPLOAD,        "Picture Upload"},
	{YAHOO_SERVICE_YAB_UPDATE,            "Yahoo Address Book Update"},
	{YAHOO_SERVICE_Y6_VISIBLE_TOGGLE,     "Y6 Visibility Toggle"},
	{YAHOO_SERVICE_Y6_STATUS_UPDATE,      "Y6 Status Update"},
	{YAHOO_SERVICE_PICTURE_STATUS,        "Picture Sharing Status"},
	{YAHOO_SERVICE_VERIFY_ID_EXISTS,      "Verify ID Exists"},
	{YAHOO_SERVICE_AUDIBLE,               "Audible"},
	{YAHOO_SERVICE_Y7_CONTACT_DETAILS,    "Y7 Contact Details"},
	{YAHOO_SERVICE_Y7_CHAT_SESSION,       "Y7 Chat Session"},
	{YAHOO_SERVICE_Y7_AUTHORIZATION,      "Y7 Buddy Authorization"},
	{YAHOO_SERVICE_Y7_FILETRANSFER,       "Y7 File Transfer"},
	{YAHOO_SERVICE_Y7_FILETRANSFERINFO,   "Y7 File Transfer Information"},
	{YAHOO_SERVICE_Y7_FILETRANSFERACCEPT, "Y7 File Transfer Accept"},
	{YAHOO_SERVICE_Y7_CHANGE_GROUP,       "Y7 Change Group"},
	{YAHOO_SERVICE_STATUS_15,             "Status V15"},
	{YAHOO_SERVICE_LIST_15,               "List V15"},
	{YAHOO_SERVICE_WEBLOGIN,              "WebLogin"},
	{YAHOO_SERVICE_SMS_MSG,               "SMS Message"},
	{0, NULL}
};

static const value_string ymsg_status_vals[] = {
	{YPACKET_STATUS_DISCONNECTED, "Disconnected"},
	{YPACKET_STATUS_DEFAULT,      "Default"},
	{YPACKET_STATUS_SERVERACK,    "Server Ack"},
	{YPACKET_STATUS_GAME,         "Playing Game"},
	{YPACKET_STATUS_AWAY,         "Away"},
	{YPACKET_STATUS_CONTINUED,    "More Packets??"},
	{YPACKET_STATUS_NOTIFY,       "Notify"},
	{YPACKET_STATUS_WEBLOGIN,     "Web Login"},
	{YPACKET_STATUS_OFFLINE,      "Offline"},
	{0, NULL}
};

/* Find the end of the current content line and return its length */
static int get_content_item_length(tvbuff_t *tvb, int offset)
{
	int origoffset = offset;

	/* Keep reading until the magic delimiter (or end of tvb) is found */
	while (tvb_captured_length_remaining(tvb, offset) >= 2) {
		if (tvb_get_ntohs(tvb, offset) == 0xc080) {
			break;
		}
		offset += 1;
	}
	return offset - origoffset;
}

static guint
get_ymsg_pdu_len(packet_info *pinfo _U_, tvbuff_t *tvb, int offset, void *data _U_)
{
	guint plen;

	/*
	 * Get the length of the YMSG packet.
	 */
	plen = tvb_get_ntohs(tvb, offset + 8);

	/*
	 * That length doesn't include the length of the header itself; add that in.
	 */
	return plen + YAHOO_HEADER_SIZE;
}

static int
dissect_ymsg_pdu(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
{
	proto_tree *ymsg_tree, *ti;
	proto_item *content_item;
	proto_tree *content_tree;
	char       *keybuf;
	char       *valbuf;
	int         keylen;
	int         vallen;
	int         content_len;
	int         offset = 0;

	col_set_str(pinfo->cinfo, COL_PROTOCOL, "YMSG");

	col_add_fstr(pinfo->cinfo, COL_INFO,
			"%s (status=%s)   ",
			val_to_str(tvb_get_ntohs(tvb, offset + 10),
				 ymsg_service_vals, "Unknown Service: %u"),
			val_to_str(tvb_get_ntohl(tvb, offset + 12),
				 ymsg_status_vals, "Unknown Status: %u")
		);

	if (tree) {
		ti = proto_tree_add_item(tree, proto_ymsg, tvb, offset, -1, ENC_NA);
		ymsg_tree = proto_item_add_subtree(ti, ett_ymsg);

		offset += 4; /* skip the YMSG string */

		/* Version */
		proto_tree_add_item(ymsg_tree, hf_ymsg_version, tvb, offset, 2, ENC_BIG_ENDIAN);
		offset += 2;

		/* Vendor ID */
		proto_tree_add_item(ymsg_tree, hf_ymsg_vendor, tvb, offset, 2, ENC_BIG_ENDIAN);
		offset += 2;

		/* Length */
		content_len = tvb_get_ntohs(tvb, offset);
		proto_tree_add_item(ymsg_tree, hf_ymsg_len, tvb, offset, 2, ENC_BIG_ENDIAN);
		offset += 2;

		/* Service */
		proto_item_append_text(ti, " (%s)",
		                       val_to_str_const(tvb_get_ntohs(tvb, offset),
							ymsg_service_vals,
							"Unknown"));

		proto_tree_add_item(ymsg_tree, hf_ymsg_service, tvb, offset, 2, ENC_BIG_ENDIAN);
		offset += 2;

		/* Status */
		proto_tree_add_item(ymsg_tree, hf_ymsg_status, tvb, offset, 4, ENC_BIG_ENDIAN);
		offset += 4;

		/* Session id */
		proto_tree_add_item(ymsg_tree, hf_ymsg_session_id, tvb, offset, 4, ENC_LITTLE_ENDIAN);
		offset += 4;

		/* Contents */
		if (content_len) {
			/* Create content subtree */
			content_item = proto_tree_add_item(ymsg_tree, hf_ymsg_content, tvb,
			                                   offset, -1, ENC_NA);
			content_tree = proto_item_add_subtree(content_item, ett_ymsg_content);

			/* Each entry consists of:
			   <key string> <delimiter> <value string> <delimiter>
			*/

			/* Parse and show each line of the contents */
			for (;;)
			{
				proto_item  *ti_2;
				proto_tree  *content_line_tree;

				/* Don't continue unless there is room for another whole item.
				   (including 2 2-byte delimiters */
				if (offset >= (YAHOO_HEADER_SIZE+content_len-4))
				{
					break;
				}

				/* Get the length of the key */
				keylen = get_content_item_length(tvb, offset);
				/* Extract the key */
				keybuf = tvb_format_text(pinfo->pool, tvb, offset, keylen);

				/* Get the length of the value */
				vallen = get_content_item_length(tvb, offset+keylen+2);
				/* Extract the value */
				valbuf = tvb_format_text(pinfo->pool, tvb, offset+keylen+2, vallen);

				/* Add a text item with the key... */
				ti_2 =  proto_tree_add_string_format(content_tree, hf_ymsg_content_line, tvb,
				                                   offset, keylen+2+vallen+2,
				                                   "", "%s:%s", keybuf, valbuf);
				content_line_tree = proto_item_add_subtree(ti_2, ett_ymsg_content_line);

				/* And add the key and value separately inside */
				proto_tree_add_item(content_line_tree, hf_ymsg_content_line_key, tvb,
				                    offset, keylen, ENC_ASCII);
				proto_tree_add_item(content_line_tree, hf_ymsg_content_line_value, tvb,
				                    offset+keylen+2, vallen, ENC_ASCII);

				/* Move beyone key and value lines */
				offset += keylen+2+vallen+2;
			}
		}
	}

	col_set_fence(pinfo->cinfo, COL_INFO);

	return tvb_captured_length(tvb);
}


static gboolean
dissect_ymsg(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data)
{
	if (tvb_captured_length(tvb) < 4) {
		return FALSE;
	}
	if (tvb_memeql(tvb, 0, (const guint8*)"YMSG", 4) == -1) {
		/* Not a Yahoo Messenger packet. */
		return FALSE;
	}

	tcp_dissect_pdus(tvb, pinfo, tree, ymsg_desegment, 10, get_ymsg_pdu_len,
			 dissect_ymsg_pdu, data);
	return TRUE;
}

void
proto_register_ymsg(void)
{
	static hf_register_info hf[] = {
		{ &hf_ymsg_version, {
				"Version", "ymsg.version", FT_UINT16, BASE_DEC,
				NULL, 0, "Packet version identifier", HFILL }},
		{ &hf_ymsg_vendor, {
				"Vendor ID", "ymsg.vendor", FT_UINT16, BASE_DEC,
				NULL, 0, "Vendor identifier", HFILL }},
		{ &hf_ymsg_len, {
				"Packet Length", "ymsg.len", FT_UINT16, BASE_DEC,
				NULL, 0, NULL, HFILL }},
		{ &hf_ymsg_service, {
				"Service", "ymsg.service", FT_UINT16, BASE_DEC,
				VALS(ymsg_service_vals), 0, "Service Type", HFILL }},
		{ &hf_ymsg_status, {
				"Status", "ymsg.status", FT_UINT32, BASE_DEC,
				VALS(ymsg_status_vals), 0, "Message Type Flags", HFILL }},
		{ &hf_ymsg_session_id, {
				"Session ID", "ymsg.session_id", FT_UINT32, BASE_HEX,
				NULL, 0, "Connection ID", HFILL }},

		{ &hf_ymsg_content, {
				"Content", "ymsg.content", FT_BYTES, BASE_NONE,
				NULL, 0, "Data portion of the packet", HFILL }},
		{ &hf_ymsg_content_line, {
				"Content-line", "ymsg.content-line", FT_STRING, BASE_NONE,
				NULL, 0, "Content line", HFILL }},
		{ &hf_ymsg_content_line_key, {
				"Key", "ymsg.content-line.key", FT_STRING, BASE_NONE,
				NULL, 0, "Content line key", HFILL }},
		{ &hf_ymsg_content_line_value, {
				"Value", "ymsg.content-line.value", FT_STRING, BASE_NONE,
				NULL, 0, "Content line value", HFILL }}
	};
	static gint *ett[] = {
		&ett_ymsg,
		&ett_ymsg_content,
		&ett_ymsg_content_line
	};
	module_t *ymsg_module;

	proto_ymsg = proto_register_protocol("Yahoo YMSG Messenger Protocol",
	    "YMSG", "ymsg");

	proto_register_field_array(proto_ymsg, hf, array_length(hf));

	proto_register_subtree_array(ett, array_length(ett));

	ymsg_module = prefs_register_protocol(proto_ymsg, NULL);
	prefs_register_bool_preference(ymsg_module, "desegment",
				       "Reassemble YMSG messages spanning multiple TCP segments",
				       "Whether the YMSG dissector should reassemble messages spanning multiple TCP segments. "
				       "To use this option, you must also enable"
				       " \"Allow subdissectors to reassemble TCP streams\" in the TCP protocol settings.",
				       &ymsg_desegment);
}

void
proto_reg_handoff_ymsg(void)
{
	/*
	 * DO NOT register for port 23, as that's Telnet, or for port
	 * 25, as that's SMTP.
	 *
	 * Also, DO NOT register for port 5050, as that's used by the
	 * old and new Yahoo messenger protocols.
	 *
	 * Just register as a heuristic TCP dissector, and reject stuff
	 * that doesn't begin with a YMSG signature.
	 */
	heur_dissector_add("tcp", dissect_ymsg, "Yahoo YMSG Messenger over TCP", "ymsg_tcp", proto_ymsg, HEURISTIC_ENABLE);
}

/*
 * Editor modelines  -  https://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:
 */