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