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  *       Add sip msg body dissection based on Content-Type for:
   8  *                SDP, MIME, and other types
   9  *       Align SIP methods with recent Internet Drafts or RFC
  10  *               (SIP INFO, rfc2976 - done)
  11  *               (SIP SUBSCRIBE-NOTIFY - done)
  12  *               (SIP REFER - done)
  13  *               check for other
  14  *
  15  * Copyright 2000, Heikki Vatiainen <hessu@cs.tut.fi>
  16  * Copyright 2001, Jean-Francois Mule <jfm@clarent.com>
  17  *
  18  * $Id: packet-sip.c,v 1.23 2002/02/02 02:56:19 guy Exp $
  19  *
  20  * Ethereal - Network traffic analyzer
  21  * By Gerald Combs <gerald@ethereal.com>
  22  * Copyright 1998 Gerald Combs
  23  *
  24  * Copied from packet-cops.c
  25  *
  26  * This program is free software; you can redistribute it and/or
  27  * modify it under the terms of the GNU General Public License
  28  * as published by the Free Software Foundation; either version 2
  29  * of the License, or (at your option) any later version.
  30  *
  31  * This program is distributed in the hope that it will be useful,
  32  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  33  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  34  * GNU General Public License for more details.
  35  *
  36  * You should have received a copy of the GNU General Public License
  37  * along with this program; if not, write to the Free Software
  38  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  39  */
  40
  41 #ifdef HAVE_CONFIG_H
  42 # include "config.h"
  43 #endif
  44
  45 #include <stdio.h>
  46 #include <stdlib.h>
  47 #include <string.h>
  48
  49 #include <glib.h>
  50 #include <epan/packet.h>
  51
  52 #define TCP_PORT_SIP 5060
  53 #define UDP_PORT_SIP 5060
  54
  55 /* Initialize the protocol and registered fields */
  56 static gint proto_sip = -1;
  57 static gint hf_msg_hdr = -1;
  58
  59 /* Initialize the subtree pointers */
  60 static gint ett_sip = -1;
  61 static gint ett_sip_hdr = -1;
  62
  63 static const char *sip_methods[] = {
  64         "<Invalid method>",      /* Pad so that the real methods start at index 1 */
  65         "INVITE",
  66         "ACK",
  67         "OPTIONS",
  68         "BYE",
  69         "CANCEL",
  70         "REGISTER",
  71         "INFO",
  72         "REFER",
  73         "SUBSCRIBE",
  74         "NOTIFY"
  75 };
  76
  77 static gboolean sip_is_request(tvbuff_t *tvb, guint32 offset);
  78 static gint sip_get_msg_offset(tvbuff_t *tvb, guint32 offset);
  79
  80 static dissector_handle_t sdp_handle;
  81 static dissector_handle_t data_handle;
  82
  83 #define SIP2_HDR "SIP/2.0 "
  84 #define SIP2_HDR_LEN (strlen (SIP2_HDR))
  85
  86 /* Code to actually dissect the packets */
  87 static void dissect_sip(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
  88 {
  89         guint32 offset;
  90         gint eol, next_offset, msg_offset;
  91         tvbuff_t *next_tvb;
  92         gboolean is_request;
  93
  94         /*
  95          * Note that "tvb_strneql()" doesn't throw exceptions, so
  96          * "sip_is_request()" won't throw an exception.
  97          *
  98          * Note that "tvb_find_line_end()" will return a value that
  99          * is not longer than what's in the buffer, so the
 100          * "tvb_get_ptr()" call s below won't throw exceptions.
 101          */
 102         offset = 0;
 103         eol = tvb_find_line_end(tvb, 0, -1, &next_offset);
 104         is_request = sip_is_request(tvb, 0);
 105         /* XXX - Is this case-sensitive?  RFC 2543 didn't explicitly say. */
 106         if (tvb_strneql(tvb, 0, SIP2_HDR, SIP2_HDR_LEN) != 0 && ! is_request)
 107                 goto bad;
 108
 109         if (check_col(pinfo->cinfo, COL_PROTOCOL))
 110                 col_set_str(pinfo->cinfo, COL_PROTOCOL, "SIP");
 111
 112
 113         if (check_col(pinfo->cinfo, COL_INFO))
 114                 col_add_fstr(pinfo->cinfo, COL_INFO, "%s: %s",
 115                              is_request ? "Request" : "Status",
 116                              is_request ?
 117                              tvb_format_text(tvb, 0, eol - SIP2_HDR_LEN) :
 118                              tvb_format_text(tvb, SIP2_HDR_LEN, eol - SIP2_HDR_LEN));
 119
 120         msg_offset = sip_get_msg_offset(tvb, offset);
 121         if (msg_offset < 0) {
 122                 /*
 123                  * XXX - this may just mean that the entire SIP message
 124                  * didn't fit in this TCP segment.
 125                  */
 126                 goto bad;
 127         }
 128
 129         if (tree) {
 130                 proto_item *ti, *th;
 131                 proto_tree *sip_tree, *hdr_tree;
 132
 133                 ti = proto_tree_add_item(tree, proto_sip, tvb, 0, -1, FALSE);
 134                 sip_tree = proto_item_add_subtree(ti, ett_sip);
 135
 136                 proto_tree_add_text(sip_tree, tvb, 0, next_offset, "%s-Line: %s",
 137                                     is_request ? "Request" : "Status",
 138                                     tvb_format_text(tvb, 0, eol));
 139
 140                 offset = next_offset;
 141                 th = proto_tree_add_item(sip_tree, hf_msg_hdr, tvb, offset, msg_offset - offset, FALSE);
 142                 hdr_tree = proto_item_add_subtree(th, ett_sip_hdr);
 143
 144                 /* - 2 since we have a CRLF separating the message-body */
 145                 while (msg_offset - 2 > (int) offset) {
 146                         eol = tvb_find_line_end(tvb, offset, -1, &next_offset);
 147                         proto_tree_add_text(hdr_tree, tvb, offset, next_offset - offset, "%s",
 148                                             tvb_format_text(tvb, offset, eol));
 149                         offset = next_offset;
 150                 }
 151                 offset += 2;  /* Skip the CRLF mentioned above */
 152        }
 153
 154         if (tvb_offset_exists(tvb, msg_offset)) {
 155                 next_tvb = tvb_new_subset(tvb, msg_offset, -1, -1);
 156                 call_dissector(sdp_handle, next_tvb, pinfo, tree);
 157         }
 158
 159         return;
 160
 161   bad:
 162         next_tvb = tvb_new_subset(tvb, offset, -1, -1);
 163         call_dissector(data_handle,next_tvb, pinfo, tree);
 164
 165         return;
 166 }
 167
 168 /* Returns the offset to the start of the optional message-body, or
 169  * -1 if not found.
 170  */
 171 static gint sip_get_msg_offset(tvbuff_t *tvb, guint32 offset)
 172 {
 173         gint eol;
 174
 175         while ((eol = tvb_find_guint8(tvb, offset, -1, '\r')) > 0
 176             && tvb_bytes_exist(tvb, eol, 4)) {
 177                 if (tvb_get_guint8(tvb, eol + 1) == '\n' &&
 178                     tvb_get_guint8(tvb, eol + 2) == '\r' &&
 179                     tvb_get_guint8(tvb, eol + 3) == '\n')
 180                         return eol + 4;
 181                 offset = eol + 2;
 182         }
 183
 184         return -1;
 185 }
 186
 187 static gboolean sip_is_request(tvbuff_t *tvb, guint32 offset)
 188 {
 189         u_int i;
 190
 191         for (i = 1; i < array_length(sip_methods); i++) {
 192                 if (tvb_strneql(tvb, offset, sip_methods[i], strlen(sip_methods[i])) == 0)
 193                         return TRUE;
 194         }
 195
 196         return FALSE;
 197 }
 198
 199 /* Register the protocol with Ethereal */
 200 void proto_register_sip(void)
 201 {
 202
 203         /* Setup list of header fields */
 204         static hf_register_info hf[] = {
 205
 206                 { &hf_msg_hdr,
 207                         { "Message Header",           "sip.msg_hdr",
 208                         FT_NONE, 0, NULL, 0,
 209                         "Message Header in SIP message", HFILL }
 210                 },
 211         };
 212
 213         /* Setup protocol subtree array */
 214         static gint *ett[] = {
 215                 &ett_sip,
 216                 &ett_sip_hdr,
 217         };
 218
 219         /* Register the protocol name and description */
 220         proto_sip = proto_register_protocol("Session Initiation Protocol",
 221             "SIP", "sip");
 222
 223         /* Required function calls to register the header fields and subtrees used */
 224         proto_register_field_array(proto_sip, hf, array_length(hf));
 225         proto_register_subtree_array(ett, array_length(ett));
 226 }
 227
 228 void
 229 proto_reg_handoff_sip(void)
 230 {
 231         dissector_handle_t sip_handle;
 232
 233         sip_handle = create_dissector_handle(dissect_sip, proto_sip);
 234         dissector_add("tcp.port", TCP_PORT_SIP, sip_handle);
 235         dissector_add("udp.port", UDP_PORT_SIP, sip_handle);
 236
 237         /*
 238          * Get a handle for the SDP dissector.
 239          */
 240         sdp_handle = find_dissector("sdp");
 241         data_handle = find_dissector("data");
 242 }