If we get an exception when dissecting a packet, append "[Short Frame]"
[obnox/wireshark/wip.git] / packet-sip.c
1 /* packet-sip.c
2  * Routines for the Session Initiation Protocol (SIP) dissection.
3  * RFC 2543
4  * 
5  * TODO: Pay attention to Content-Type: It might not always be SDP.
6  *       Add hf_* fields for filtering support.
7  *
8  * Copyright 2000, Heikki Vatiainen <hessu@cs.tut.fi>
9  *
10  * $Id: packet-sip.c,v 1.8 2000/11/19 08:54:06 guy Exp $
11  *
12  * Ethereal - Network traffic analyzer
13  * By Gerald Combs <gerald@zing.org>
14  * Copyright 1998 Gerald Combs
15  *
16  * Copied from packet-cops.c
17  * 
18  * This program is free software; you can redistribute it and/or
19  * modify it under the terms of the GNU General Public License
20  * as published by the Free Software Foundation; either version 2
21  * of the License, or (at your option) any later version.
22  * 
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  * 
28  * You should have received a copy of the GNU General Public License
29  * along with this program; if not, write to the Free Software
30  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
31  */
32
33 #ifdef HAVE_CONFIG_H
34 # include "config.h"
35 #endif
36
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <string.h>
40
41 #include <glib.h>
42 #include "packet.h"
43
44 #define TCP_PORT_SIP 5060
45 #define UDP_PORT_SIP 5060
46
47 /* Initialize the protocol and registered fields */
48 static gint proto_sip = -1;
49 static gint hf_msg_hdr = -1;
50
51 /* Initialize the subtree pointers */
52 static gint ett_sip = -1;
53 static gint ett_sip_hdr = -1;
54
55 static const char *sip_methods[] = {
56         "<Invalid method>",      /* Pad so that the real methods start at index 1 */
57         "INVITE",
58         "ACK",
59         "OPTIONS",
60         "BYE",
61         "CANCEL",
62         "REGISTER"
63 };
64
65 static int sip_is_request(tvbuff_t *tvb, guint32 offset);
66 static gint sip_get_msg_offset(tvbuff_t *tvb, guint32 offset);
67  
68 static dissector_handle_t sdp_handle;
69
70 /* Code to actually dissect the packets */
71 static void dissect_sip(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
72 {
73         guint32 offset;
74         gint eol, next_offset, msg_offset;
75         tvbuff_t *next_tvb;
76         gboolean is_request;
77
78         CHECK_DISPLAY_AS_DATA(proto_sip, tvb, pinfo, tree);
79
80         pinfo->current_proto = "SIP";
81         if (check_col(pinfo->fd, COL_PROTOCOL)) 
82                 col_set_str(pinfo->fd, COL_PROTOCOL, "SIP");
83     
84         offset = 0;
85         is_request = sip_is_request(tvb, 0);
86         eol = tvb_find_line_end(tvb, 0, -1, &next_offset);
87
88         if (check_col(pinfo->fd, COL_INFO))
89                 col_add_fstr(pinfo->fd, COL_INFO, "%s: %s",
90                              is_request ? "Request" : "Status",
91                              is_request ? 
92                              tvb_format_text(tvb, 0, eol - strlen(" SIP/2.0")) :
93                              tvb_format_text(tvb, strlen("SIP/2.0 "), eol - strlen("SIP/2.0 ")));
94
95         msg_offset = sip_get_msg_offset(tvb, offset);
96         if (msg_offset < 0) goto bad;
97
98         if (tree) {
99                 proto_item *ti, *th;
100                 proto_tree *sip_tree, *hdr_tree;
101
102                 ti = proto_tree_add_item(tree, proto_sip, tvb, 0, tvb_length(tvb), FALSE);
103                 sip_tree = proto_item_add_subtree(ti, ett_sip);
104
105                 proto_tree_add_text(sip_tree, tvb, 0, next_offset, "%s-Line: %s",
106                                     is_request ? "Request" : "Status",
107                                     tvb_format_text(tvb, 0, eol));
108
109                 offset = next_offset;
110                 th = proto_tree_add_item(sip_tree, hf_msg_hdr, tvb, offset, msg_offset - offset, FALSE);
111                 hdr_tree = proto_item_add_subtree(th, ett_sip_hdr);
112
113                 /* - 2 since we have a CRLF separating the message-body */
114                 while (msg_offset - 2 > offset) {
115                         eol = tvb_find_line_end(tvb, offset, -1, &next_offset);
116                         proto_tree_add_text(hdr_tree, tvb, offset, next_offset - offset, "%s",
117                                             tvb_format_text(tvb, offset, eol));
118                         offset = next_offset;
119                 }
120                 offset += 2;  /* Skip the CRLF mentioned above */
121        }
122
123         if (tvb_length_remaining(tvb, msg_offset) > 0) {
124                 next_tvb = tvb_new_subset(tvb, offset, -1, -1);
125                 call_dissector(sdp_handle, next_tvb, pinfo, tree);
126         }
127
128         return;
129
130   bad:
131         next_tvb = tvb_new_subset(tvb, offset, -1, -1);
132         dissect_data(next_tvb, 0, pinfo, tree);
133
134         return;
135 }
136
137 /* Returns the offset to the start of the optional message-body, or
138  * -1 for an error.
139  */
140 static gint sip_get_msg_offset(tvbuff_t *tvb, guint32 offset)
141 {
142         gint eol;
143
144         while ((eol = tvb_find_guint8(tvb, offset, tvb_length_remaining(tvb, offset), '\r')) > 0) {
145                         if (tvb_get_guint8(tvb, eol + 1) == '\n' && 
146                             tvb_get_guint8(tvb, eol + 2) == '\r' && 
147                             tvb_get_guint8(tvb, eol + 3) == '\n')
148                                 return eol + 4;
149                         offset = eol + 2;
150         }
151
152         return -1;
153 }
154                 
155 static int sip_is_request(tvbuff_t *tvb, guint32 offset)
156 {
157         int i;
158
159         for (i = 1; i < array_length(sip_methods); i++) {
160                 if (tvb_strneql(tvb, offset, sip_methods[i], strlen(sip_methods[i])) == 0)
161                         return i;
162         }
163
164         return 0;
165 }
166
167 /* Register the protocol with Ethereal */
168 void proto_register_sip(void)
169 {                 
170
171         /* Setup list of header fields */
172         static hf_register_info hf[] = {
173
174                 { &hf_msg_hdr,
175                         { "Message Header",           "sip.msg_hdr",
176                         FT_NONE, 0, NULL, 0,
177                         "Message Header in SIP message" }
178                 },
179         };
180
181         /* Setup protocol subtree array */
182         static gint *ett[] = {
183                 &ett_sip,
184                 &ett_sip_hdr,
185         };
186
187         /* Register the protocol name and description */
188         proto_sip = proto_register_protocol("Session Initiation Protocol", "sip");
189
190         /* Required function calls to register the header fields and subtrees used */
191         proto_register_field_array(proto_sip, hf, array_length(hf));
192         proto_register_subtree_array(ett, array_length(ett));
193 };
194
195 void
196 proto_reg_handoff_sip(void)
197 {
198         dissector_add("tcp.port", TCP_PORT_SIP, dissect_sip);
199         dissector_add("udp.port", UDP_PORT_SIP, dissect_sip);
200
201         /*
202          * Get a handle for the SDP dissector.
203          */
204         sdp_handle = find_dissector("sdp");
205 }