Attach a descriptive name field type and base to dissector tables; that
[obnox/wireshark/wip.git] / packet-udp.c
1 /* packet-udp.c
2  * Routines for UDP packet disassembly
3  *
4  * $Id: packet-udp.c,v 1.99 2001/12/08 06:41:42 guy Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@ethereal.com>
8  * Copyright 1998 Gerald Combs
9  *
10  * Richard Sharpe, 13-Feb-1999, added dispatch table support and 
11  *                              support for tftp.
12  * 
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  * 
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  * 
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  */
27  
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #ifdef HAVE_SYS_TYPES_H
33 # include <sys/types.h>
34 #endif
35
36 #ifdef HAVE_NETINET_IN_H
37 # include <netinet/in.h>
38 #endif
39
40 #include <stdio.h>
41 #include <stdlib.h>
42 #include <string.h>
43
44 #include <glib.h>
45 #include "packet.h"
46 #include "resolv.h"
47 #include "ipproto.h"
48 #include "in_cksum.h"
49 #include "prefs.h"
50
51 #include "packet-udp.h"
52
53 #include "packet-ip.h"
54 #include "conversation.h"
55
56 static int proto_udp = -1;              
57 static int hf_udp_srcport = -1;
58 static int hf_udp_dstport = -1;
59 static int hf_udp_port = -1;
60 static int hf_udp_length = -1;
61 static int hf_udp_checksum = -1;
62 static int hf_udp_checksum_bad = -1;
63
64 static gint ett_udp = -1;
65
66 /* Place UDP summary in proto tree */
67 static gboolean udp_summary_in_tree = TRUE;
68
69 /* UDP structs and definitions */
70
71 typedef struct _e_udphdr {
72   guint16 uh_sport;
73   guint16 uh_dport;
74   guint16 uh_ulen;
75   guint16 uh_sum;
76 } e_udphdr;
77
78 static dissector_table_t udp_dissector_table;
79 static heur_dissector_list_t heur_subdissector_list;
80 static dissector_handle_t data_handle;
81
82 /* Determine if there is a sub-dissector and call it.  This has been */
83 /* separated into a stand alone routine to other protocol dissectors */
84 /* can call to it, ie. socks    */
85
86 void
87 decode_udp_ports(tvbuff_t *tvb, int offset, packet_info *pinfo,
88         proto_tree *tree, int uh_sport, int uh_dport)
89 {
90   tvbuff_t *next_tvb;
91
92   next_tvb = tvb_new_subset(tvb, offset, -1, -1);
93
94 /* determine if this packet is part of a conversation and call dissector */
95 /* for the conversation if available */
96
97   if (try_conversation_dissector(&pinfo->src, &pinfo->dst, PT_UDP,
98                 uh_sport, uh_dport, next_tvb, pinfo, tree))
99     return;
100
101   /* do lookup with the subdissector table */
102   if (dissector_try_port(udp_dissector_table, uh_sport, next_tvb, pinfo, tree) ||
103       dissector_try_port(udp_dissector_table, uh_dport, next_tvb, pinfo, tree))
104     return;
105
106   /* do lookup with the heuristic subdissector table */
107   if (dissector_try_heuristic(heur_subdissector_list, next_tvb, pinfo, tree))
108     return;
109
110   call_dissector(data_handle,next_tvb, pinfo, tree);
111 }
112
113
114 static void
115 dissect_udp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
116 {
117   e_udphdr  uh;
118   guint16    uh_sport, uh_dport, uh_ulen, uh_sum;
119   proto_tree *udp_tree;
120   proto_item *ti;
121   guint      len;
122   guint      reported_len;
123   vec_t      cksum_vec[4];
124   guint32    phdr[2];
125   guint16    computed_cksum;
126   int        offset = 0;
127
128   if (check_col(pinfo->fd, COL_PROTOCOL))
129     col_set_str(pinfo->fd, COL_PROTOCOL, "UDP");
130   if (check_col(pinfo->fd, COL_INFO))
131     col_clear(pinfo->fd, COL_INFO);
132
133   /* Avoids alignment problems on many architectures. */
134   tvb_memcpy(tvb, (guint8 *)&uh, offset, sizeof(e_udphdr));
135   uh_sport = ntohs(uh.uh_sport);
136   uh_dport = ntohs(uh.uh_dport);
137   uh_ulen  = ntohs(uh.uh_ulen);
138   uh_sum   = ntohs(uh.uh_sum);
139   
140   if (check_col(pinfo->fd, COL_INFO))
141     col_add_fstr(pinfo->fd, COL_INFO, "Source port: %s  Destination port: %s",
142             get_udp_port(uh_sport), get_udp_port(uh_dport));
143     
144   if (tree) {
145     if (udp_summary_in_tree) {
146       ti = proto_tree_add_protocol_format(tree, proto_udp, tvb, offset, 8,
147       "User Datagram Protocol, Src Port: %s (%u), Dst Port: %s (%u)",
148       get_udp_port(uh_sport), uh_sport, get_udp_port(uh_dport), uh_dport);
149     } else {
150       ti = proto_tree_add_item(tree, proto_udp, tvb, offset, 8, FALSE);
151     }
152     udp_tree = proto_item_add_subtree(ti, ett_udp);
153
154     proto_tree_add_uint_format(udp_tree, hf_udp_srcport, tvb, offset, 2, uh_sport,
155         "Source port: %s (%u)", get_udp_port(uh_sport), uh_sport);
156     proto_tree_add_uint_format(udp_tree, hf_udp_dstport, tvb, offset + 2, 2, uh_dport,
157         "Destination port: %s (%u)", get_udp_port(uh_dport), uh_dport);
158
159     proto_tree_add_uint_hidden(udp_tree, hf_udp_port, tvb, offset, 2, uh_sport);
160     proto_tree_add_uint_hidden(udp_tree, hf_udp_port, tvb, offset+2, 2, uh_dport);
161
162     proto_tree_add_uint(udp_tree, hf_udp_length, tvb, offset + 4, 2,  uh_ulen);
163     reported_len = tvb_reported_length(tvb);
164     len = tvb_length(tvb);
165     if (uh_sum == 0) {
166       /* No checksum supplied in the packet. */
167       proto_tree_add_uint_format(udp_tree, hf_udp_checksum, tvb,
168         offset + 6, 2, uh_sum, "Checksum: 0x%04x (none)", uh_sum);
169     } else if (!pinfo->fragmented && len >= reported_len && len >= uh_ulen) {
170       /* The packet isn't part of a fragmented datagram and isn't
171          truncated, so we can checksum it.
172          XXX - make a bigger scatter-gather list once we do fragment
173          reassembly? */
174
175       /* Set up the fields of the pseudo-header. */
176       cksum_vec[0].ptr = pinfo->src.data;
177       cksum_vec[0].len = pinfo->src.len;
178       cksum_vec[1].ptr = pinfo->dst.data;
179       cksum_vec[1].len = pinfo->dst.len;
180       cksum_vec[2].ptr = (const guint8 *)&phdr;
181       switch (pinfo->src.type) {
182
183       case AT_IPv4:
184         phdr[0] = htonl((IP_PROTO_UDP<<16) + reported_len);
185         cksum_vec[2].len = 4;
186         break;
187
188       case AT_IPv6:
189         phdr[0] = htonl(reported_len);
190         phdr[1] = htonl(IP_PROTO_UDP);
191         cksum_vec[2].len = 8;
192         break;
193
194       default:
195         /* TCP runs only atop IPv4 and IPv6.... */
196         g_assert_not_reached();
197         break;
198       }
199       cksum_vec[3].ptr = tvb_get_ptr(tvb, offset, len);
200       cksum_vec[3].len = reported_len;
201       computed_cksum = in_cksum(&cksum_vec[0], 4);
202       if (computed_cksum == 0) {
203         proto_tree_add_uint_format(udp_tree, hf_udp_checksum, tvb,
204           offset + 6, 2, uh_sum, "Checksum: 0x%04x (correct)", uh_sum);
205       } else {
206         proto_tree_add_boolean_hidden(udp_tree, hf_udp_checksum_bad, tvb,
207            offset + 6, 2, TRUE);
208         proto_tree_add_uint_format(udp_tree, hf_udp_checksum, tvb,
209           offset + 6, 2, uh_sum,
210           "Checksum: 0x%04x (incorrect, should be 0x%04x)", uh_sum,
211            in_cksum_shouldbe(uh_sum, computed_cksum));
212       }
213     } else {
214       proto_tree_add_uint_format(udp_tree, hf_udp_checksum, tvb,
215         offset + 6, 2, uh_sum, "Checksum: 0x%04x", uh_sum);
216     }
217   }
218
219   /* Skip over header */
220   offset += 8;
221
222   pinfo->ptype = PT_UDP;
223   pinfo->srcport = uh_sport;
224   pinfo->destport = uh_dport;
225
226 /* call sub-dissectors */
227   decode_udp_ports( tvb, offset, pinfo, tree, uh_sport, uh_dport);
228
229 }
230
231 void
232 proto_register_udp(void)
233 {
234         module_t *udp_module;
235         static hf_register_info hf[] = {
236                 { &hf_udp_srcport,
237                 { "Source Port",        "udp.srcport", FT_UINT16, BASE_DEC, NULL, 0x0,
238                         "", HFILL }},
239
240                 { &hf_udp_dstport,
241                 { "Destination Port",   "udp.dstport", FT_UINT16, BASE_DEC, NULL, 0x0,
242                         "", HFILL }},
243
244                 { &hf_udp_port,
245                 { "Source or Destination Port", "udp.port", FT_UINT16, BASE_DEC,  NULL, 0x0,
246                         "", HFILL }},
247
248                 { &hf_udp_length,
249                 { "Length",             "udp.length", FT_UINT16, BASE_DEC, NULL, 0x0,
250                         "", HFILL }},
251
252                 { &hf_udp_checksum_bad,
253                 { "Bad Checksum",       "udp.checksum_bad", FT_BOOLEAN, BASE_NONE, NULL, 0x0,
254                         "", HFILL }},
255
256                 { &hf_udp_checksum,
257                 { "Checksum",           "udp.checksum", FT_UINT16, BASE_HEX, NULL, 0x0,
258                         "", HFILL }},
259         };
260         static gint *ett[] = {
261                 &ett_udp,
262         };
263
264         proto_udp = proto_register_protocol("User Datagram Protocol",
265             "UDP", "udp");
266         proto_register_field_array(proto_udp, hf, array_length(hf));
267         proto_register_subtree_array(ett, array_length(ett));
268
269 /* subdissector code */
270         udp_dissector_table = register_dissector_table("udp.port",
271             "UDP port", FT_UINT16, BASE_DEC);
272         register_heur_dissector_list("udp", &heur_subdissector_list);
273         
274         /* Register configuration preferences */
275         udp_module = prefs_register_protocol(proto_udp, NULL);
276         prefs_register_bool_preference(udp_module, "udp_summary_in_tree",
277         "Show UDP summary in protocol treee", 
278         "Whether the UDP summary line should be shown in the protocol tree",
279         &udp_summary_in_tree);
280 }
281
282 void
283 proto_reg_handoff_udp(void)
284 {
285         dissector_handle_t udp_handle;
286
287         udp_handle = create_dissector_handle(dissect_udp, proto_udp);
288         dissector_add("ip.proto", IP_PROTO_UDP, udp_handle);
289         data_handle = find_dissector("data");
290 }