Make GRE use a dissector table for its protocol types, and register
[obnox/wireshark/wip.git] / packet-gre.c
1 /* packet-gre.c
2  * Routines for the Generic Routing Encapsulation (GRE) protocol
3  * Brad Robel-Forrest <brad.robel-forrest@watchguard.com>
4  *
5  * $Id: packet-gre.c,v 1.38 2001/01/13 07:47:48 guy Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@zing.org>
9  * Copyright 1998 Gerald Combs
10  *
11  * 
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  * 
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  * 
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  */
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #ifdef HAVE_SYS_TYPES_H
32 # include <sys/types.h>
33 #endif
34
35 #ifdef HAVE_NETINET_IN_H
36 #include <netinet/in.h>
37 #endif
38 #include <glib.h>
39 #include "etypes.h"
40 #include "greproto.h"
41 #include "packet.h"
42 #include "packet-ip.h"
43 #include "packet-ipx.h"
44 #include "packet-wccp.h"
45 #include "in_cksum.h"
46
47 static int proto_gre = -1;
48 static int hf_gre_proto = -1;
49
50 static gint ett_gre = -1;
51 static gint ett_gre_flags = -1;
52 static gint ett_gre_wccp2_redirect_header = -1;
53
54 static dissector_table_t gre_dissector_table;
55
56 /* bit positions for flags in header */
57 #define GH_B_C          0x8000
58 #define GH_B_R          0x4000
59 #define GH_B_K          0x2000
60 #define GH_B_S          0x1000
61 #define GH_B_s          0x0800
62 #define GH_B_RECUR      0x0700
63 #define GH_P_A          0x0080  /* only in special PPTPized GRE header */
64 #define GH_P_FLAGS      0x0078  /* only in special PPTPized GRE header */
65 #define GH_R_FLAGS      0x00F8
66 #define GH_B_VER        0x0007
67
68 static void add_flags_and_ver(proto_tree *, guint16, tvbuff_t *, int, int);
69 static void dissect_gre_wccp2_redirect_header(tvbuff_t *, int, proto_tree *);
70
71 static const value_string typevals[] = {
72         { ETHERTYPE_PPP, "PPP" },
73         { ETHERTYPE_IP,  "IP" },
74         { GRE_WCCP,      "WCCP"},
75         { ETHERTYPE_IPX, "IPX"},
76         { GRE_FR,        "FR"},
77         { 0,             NULL  }
78 };
79
80 static void
81 dissect_gre(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
82 {
83   int           offset = 0;
84   guint16       flags_and_ver;
85   guint16       type;
86   gboolean      is_ppp = FALSE;
87   gboolean      is_wccp2 = FALSE;
88   guint         len = 4;
89   proto_item    *ti;
90   proto_tree    *gre_tree = NULL;
91   guint16       sre_af;
92   guint8        sre_length;
93   tvbuff_t      *next_tvb;
94
95   CHECK_DISPLAY_AS_DATA(proto_gre, tvb, pinfo, tree);
96
97   pinfo->current_proto = "GRE";
98
99   flags_and_ver = tvb_get_ntohs(tvb, offset);
100   type = tvb_get_ntohs(tvb, offset + sizeof(flags_and_ver));
101
102   if (check_col(pinfo->fd, COL_PROTOCOL))
103     col_set_str(pinfo->fd, COL_PROTOCOL, "GRE");
104
105   if (check_col(pinfo->fd, COL_INFO)) {
106     col_add_fstr(pinfo->fd, COL_INFO, "Encapsulated %s",
107                  val_to_str(type, typevals, "0x%04X (unknown)"));
108   }
109
110   if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R)
111     len += 4;
112   if (flags_and_ver & GH_B_K)
113     len += 4;
114   if (flags_and_ver & GH_B_S)
115     len += 4;
116   switch (type) {
117
118   case ETHERTYPE_PPP:
119     if (flags_and_ver & GH_P_A)
120       len += 4;
121     is_ppp = TRUE;
122     break;
123
124   case GRE_WCCP:
125     /* WCCP2 puts an extra 4 octets into the header, but uses the same
126        encapsulation type; if it looks as if the first octet of the packet
127        isn't the beginning of an IPv4 header, assume it's WCCP2. */
128     if ((tvb_get_guint8(tvb, offset + sizeof(flags_and_ver) + sizeof(type)) & 0xF0) != 0x40) {
129       len += 4;
130       is_wccp2 = TRUE;
131     }
132     break;
133   }
134
135   if (tree) {
136     ti = proto_tree_add_protocol_format(tree, proto_gre, tvb, offset, len,
137       "Generic Routing Encapsulation (%s)",
138       val_to_str(type, typevals, "0x%04X - unknown"));
139     gre_tree = proto_item_add_subtree(ti, ett_gre);
140     add_flags_and_ver(gre_tree, flags_and_ver, tvb, offset, is_ppp);
141   }
142   offset += sizeof(flags_and_ver);
143
144   if (tree) {
145     proto_tree_add_uint(gre_tree, hf_gre_proto, tvb, offset, sizeof(type), type);
146   }
147   offset += sizeof(type);
148
149   if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R) {
150     if (tree) {
151       guint length, reported_length;
152       vec_t cksum_vec[1];
153       guint16 cksum, computed_cksum;
154
155       cksum = tvb_get_ntohs(tvb, offset);
156       length = tvb_length(tvb);
157       reported_length = tvb_reported_length(tvb);
158       if ((flags_and_ver & GH_B_C) && !pinfo->fragmented
159                 && length >= reported_length) {
160         /* The Checksum Present bit is set, and the packet isn't part of a
161            fragmented datagram and isn't truncated, so we can checksum it. */
162
163         cksum_vec[0].ptr = tvb_get_ptr(tvb, 0, reported_length);
164         cksum_vec[0].len = reported_length;
165         computed_cksum = in_cksum(cksum_vec, 1);
166         if (computed_cksum == 0) {
167           proto_tree_add_text(gre_tree, tvb, offset, 2,
168                         "Checksum: 0x%04x (correct)", cksum);
169         } else {
170           proto_tree_add_text(gre_tree, tvb, offset, 2,
171                         "Checksum: 0x%04x (incorrect, should be 0x%04x)",
172                         cksum, in_cksum_shouldbe(cksum, computed_cksum));
173         }
174       } else {
175         proto_tree_add_text(gre_tree, tvb, offset, 2,
176                           "Checksum: 0x%04x", cksum);
177       }
178     }
179     offset += 2;
180   }
181
182   if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R) {
183     if (tree) {
184       proto_tree_add_text(gre_tree, tvb, offset, 2,
185                           "Offset: %u", tvb_get_ntohs(tvb, offset));
186     }
187     offset += 2;
188   }
189
190   if (flags_and_ver & GH_B_K) {
191     if (is_ppp) {
192       if (tree) {
193         proto_tree_add_text(gre_tree, tvb, offset, 2,
194                             "Payload length: %u", tvb_get_ntohs(tvb, offset));
195       }
196       offset += 2;
197       if (tree) {
198         proto_tree_add_text(gre_tree, tvb, offset, 2,
199                             "Call ID: %u", tvb_get_ntohs(tvb, offset));
200       }
201       offset += 2;
202     }
203     else {
204       if (tree) {
205         proto_tree_add_text(gre_tree, tvb, offset, 4,
206                             "Key: %u", tvb_get_ntohl(tvb, offset));
207       }
208       offset += 4;
209     }
210   }
211     
212   if (flags_and_ver & GH_B_S) {
213     if (tree) {
214       proto_tree_add_text(gre_tree, tvb, offset, 4,
215                           "Sequence number: %u", tvb_get_ntohl(tvb, offset));
216     }
217     offset += 4;
218   }
219
220   if (is_ppp && flags_and_ver & GH_P_A) {
221     if (tree) {
222       proto_tree_add_text(gre_tree, tvb, offset, 4,
223                           "Acknowledgement number: %u", tvb_get_ntohl(tvb, offset));
224     }
225     offset += 4;
226   }
227
228   if (flags_and_ver & GH_B_R) {
229     for (;;) {
230       sre_af = tvb_get_ntohs(tvb, offset);
231       if (tree) {
232         proto_tree_add_text(gre_tree, tvb, offset, sizeof(guint16),
233                           "Address family: %u", sre_af);
234       }
235       offset += sizeof(guint16);
236       if (tree) {
237         proto_tree_add_text(gre_tree, tvb, offset, 1,
238                           "SRE offset: %u", tvb_get_guint8(tvb, offset));
239       }
240       offset += sizeof(guint8);
241       sre_length = tvb_get_guint8(tvb, offset);
242       if (tree) {
243         proto_tree_add_text(gre_tree, tvb, offset, sizeof(guint8),
244                           "SRE length: %u", sre_length);
245       }
246       offset += sizeof(guint8);
247       if (sre_af == 0 && sre_length == 0)
248         break;
249       offset += sre_length;
250     }
251   }
252
253   if (type == GRE_WCCP) {
254     if (is_wccp2) {
255       if (tree)
256         dissect_gre_wccp2_redirect_header(tvb, offset, gre_tree);
257       offset += 4;
258     }
259   }
260   next_tvb = tvb_new_subset(tvb, offset, -1, -1);
261   if (!dissector_try_port(gre_dissector_table, type, next_tvb, pinfo, tree))
262     dissect_data(next_tvb, 0, pinfo, gre_tree);
263 }
264
265 static void
266 add_flags_and_ver(proto_tree *tree, guint16 flags_and_ver, tvbuff_t *tvb,
267     int offset, int is_ppp)
268 {
269   proto_item *  ti;
270   proto_tree *  fv_tree;
271   int           nbits = sizeof(flags_and_ver) * 8;
272   
273   ti = proto_tree_add_text(tree, tvb, offset, 2, 
274                            "Flags and version: %#04x", flags_and_ver);
275   fv_tree = proto_item_add_subtree(ti, ett_gre_flags);
276   
277   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
278                       decode_boolean_bitfield(flags_and_ver, GH_B_C, nbits,
279                                               "Checksum", "No checksum"));
280   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
281                       decode_boolean_bitfield(flags_and_ver, GH_B_R, nbits,
282                                               "Routing", "No routing"));
283   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
284                       decode_boolean_bitfield(flags_and_ver, GH_B_K, nbits,
285                                               "Key", "No key"));
286   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
287                       decode_boolean_bitfield(flags_and_ver, GH_B_S, nbits,
288                                               "Sequence number", "No sequence number"));
289   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
290                       decode_boolean_bitfield(flags_and_ver, GH_B_s, nbits,
291                                               "Strict source route", "No strict source route"));
292   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
293                       decode_numeric_bitfield(flags_and_ver, GH_B_RECUR, nbits,
294                                               "Recursion control: %u"));
295   if (is_ppp) {
296     proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
297                         decode_boolean_bitfield(flags_and_ver, GH_P_A, nbits,
298                                                 "Acknowledgment number", "No acknowledgment number"));
299     proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
300                         decode_numeric_bitfield(flags_and_ver, GH_P_FLAGS, nbits,
301                                                 "Flags: %u"));
302   }
303   else {
304     proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
305                         decode_numeric_bitfield(flags_and_ver, GH_R_FLAGS, nbits,
306                                                 "Flags: %u"));
307   }
308
309   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
310                       decode_numeric_bitfield(flags_and_ver, GH_B_VER, nbits,
311                                               "Version: %u"));
312  }
313
314 static void
315 dissect_gre_wccp2_redirect_header(tvbuff_t *tvb, int offset, proto_tree *tree)
316 {
317   proto_item *  ti;
318   proto_tree *  rh_tree;
319   guint8        rh_flags;
320   
321   ti = proto_tree_add_text(tree, tvb, offset, 4, "Redirect header");
322   rh_tree = proto_item_add_subtree(ti, ett_gre_wccp2_redirect_header);
323
324   rh_flags = tvb_get_guint8(tvb, offset);
325   proto_tree_add_text(rh_tree, tvb, offset, 1, "%s",
326                       decode_boolean_bitfield(rh_flags, 0x80, 8,
327                                       "Dynamic service", "Well-known service"));
328   proto_tree_add_text(rh_tree, tvb, offset, 1, "%s",
329                       decode_boolean_bitfield(rh_flags, 0x40, 8,
330                               "Alternative bucket used", "Alternative bucket not used"));
331
332   proto_tree_add_text(rh_tree, tvb, offset + 1, 1, "Service ID: %s",
333       val_to_str(tvb_get_guint8(tvb, offset + 1), service_id_vals, "Unknown (0x%02X)"));
334   if (rh_flags & 0x40)
335     proto_tree_add_text(rh_tree, tvb, offset + 2, 1, "Alternative bucket index: %u",
336                         tvb_get_guint8(tvb, offset + 2));
337   proto_tree_add_text(rh_tree, tvb, offset + 3, 1, "Primary bucket index: %u",
338                         tvb_get_guint8(tvb, offset + 3));
339 }
340  
341 void
342 proto_register_gre(void)
343 {
344         static hf_register_info hf[] = {
345                 { &hf_gre_proto,
346                         { "Protocol Type", "gre.proto", FT_UINT16, BASE_HEX, VALS(typevals), 0x0,
347                                 "The protocol that is GRE encapsulated"}
348                 },
349         };
350         static gint *ett[] = {
351                 &ett_gre,
352                 &ett_gre_flags,
353                 &ett_gre_wccp2_redirect_header,
354         };
355
356         proto_gre = proto_register_protocol("Generic Routing Encapsulation",
357             "GRE", "gre");
358         proto_register_field_array(proto_gre, hf, array_length(hf));
359         proto_register_subtree_array(ett, array_length(ett));
360
361         /* subdissector code */
362         gre_dissector_table = register_dissector_table("gre.proto");
363 }
364
365 void
366 proto_reg_handoff_gre(void)
367 {
368         dissector_add("ip.proto", IP_PROTO_GRE, dissect_gre, proto_gre);
369 }