fc79ce9405e8a5abf99ee75e6dd9cc7b19b21559
[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.37 2001/01/09 09:59:28 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 "packet.h"
40 #include "packet-ip.h"
41 #include "packet-ipx.h"
42 #include "packet-wccp.h"
43 #include "in_cksum.h"
44
45 static int proto_gre = -1;
46 static int hf_gre_proto = -1;
47
48 static gint ett_gre = -1;
49 static gint ett_gre_flags = -1;
50 static gint ett_gre_wccp2_redirect_header = -1;
51
52 /* bit positions for flags in header */
53 #define GH_B_C          0x8000
54 #define GH_B_R          0x4000
55 #define GH_B_K          0x2000
56 #define GH_B_S          0x1000
57 #define GH_B_s          0x0800
58 #define GH_B_RECUR      0x0700
59 #define GH_P_A          0x0080  /* only in special PPTPized GRE header */
60 #define GH_P_FLAGS      0x0078  /* only in special PPTPized GRE header */
61 #define GH_R_FLAGS      0x00F8
62 #define GH_B_VER        0x0007
63
64 #define GRE_PPP         0x880B
65 #define GRE_IP          0x0800
66 #define GRE_WCCP        0x883E
67 #define GRE_IPX         0x8137
68 #define GRE_FR          0x6559
69
70 static void add_flags_and_ver(proto_tree *, guint16, tvbuff_t *, int, int);
71 static void dissect_gre_wccp2_redirect_header(tvbuff_t *, int, proto_tree *);
72
73 static const value_string typevals[] = {
74         { GRE_PPP,  "PPP" },
75         { GRE_IP,   "IP" },
76         { GRE_WCCP, "WCCP"},
77         { GRE_IPX,  "IPX"},
78         { GRE_FR,   "FR"},
79         { 0,        NULL  }
80 };
81
82 static dissector_handle_t ip_handle;
83 static dissector_handle_t ipx_handle;
84 static dissector_handle_t ppp_handle;
85 static dissector_handle_t fr_handle;
86
87 static void
88 dissect_gre(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
89 {
90   int           offset = 0;
91   guint16       flags_and_ver;
92   guint16       type;
93   gboolean      is_ppp = FALSE;
94   gboolean      is_wccp2 = FALSE;
95   guint         len = 4;
96   proto_item    *ti;
97   proto_tree    *gre_tree = NULL;
98   guint16       sre_af;
99   guint8        sre_length;
100   tvbuff_t      *next_tvb;
101
102   CHECK_DISPLAY_AS_DATA(proto_gre, tvb, pinfo, tree);
103
104   pinfo->current_proto = "GRE";
105
106   flags_and_ver = tvb_get_ntohs(tvb, offset);
107   type = tvb_get_ntohs(tvb, offset + sizeof(flags_and_ver));
108
109   if (check_col(pinfo->fd, COL_PROTOCOL))
110     col_set_str(pinfo->fd, COL_PROTOCOL, "GRE");
111
112   if (check_col(pinfo->fd, COL_INFO)) {
113     col_add_fstr(pinfo->fd, COL_INFO, "Encapsulated %s",
114                  val_to_str(type, typevals, "0x%04X (unknown)"));
115   }
116
117   if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R)
118     len += 4;
119   if (flags_and_ver & GH_B_K)
120     len += 4;
121   if (flags_and_ver & GH_B_S)
122     len += 4;
123   switch (type) {
124
125   case GRE_PPP:
126     if (flags_and_ver & GH_P_A)
127       len += 4;
128     is_ppp = TRUE;
129     break;
130
131   case GRE_WCCP:
132     /* WCCP2 puts an extra 4 octets into the header, but uses the same
133        encapsulation type; if it looks as if the first octet of the packet
134        isn't the beginning of an IPv4 header, assume it's WCCP2. */
135     if ((tvb_get_guint8(tvb, offset + sizeof(flags_and_ver) + sizeof(type)) & 0xF0) != 0x40) {
136       len += 4;
137       is_wccp2 = TRUE;
138     }
139     break;
140   }
141
142   if (tree) {
143     ti = proto_tree_add_protocol_format(tree, proto_gre, tvb, offset, len,
144       "Generic Routing Encapsulation (%s)",
145       val_to_str(type, typevals, "0x%04X - unknown"));
146     gre_tree = proto_item_add_subtree(ti, ett_gre);
147     add_flags_and_ver(gre_tree, flags_and_ver, tvb, offset, is_ppp);
148   }
149   offset += sizeof(flags_and_ver);
150
151   if (tree) {
152     proto_tree_add_uint(gre_tree, hf_gre_proto, tvb, offset, sizeof(type), type);
153   }
154   offset += sizeof(type);
155
156   if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R) {
157     if (tree) {
158       guint length, reported_length;
159       vec_t cksum_vec[1];
160       guint16 cksum, computed_cksum;
161
162       cksum = tvb_get_ntohs(tvb, offset);
163       length = tvb_length(tvb);
164       reported_length = tvb_reported_length(tvb);
165       if ((flags_and_ver & GH_B_C) && !pinfo->fragmented
166                 && length >= reported_length) {
167         /* The Checksum Present bit is set, and the packet isn't part of a
168            fragmented datagram and isn't truncated, so we can checksum it. */
169
170         cksum_vec[0].ptr = tvb_get_ptr(tvb, 0, reported_length);
171         cksum_vec[0].len = reported_length;
172         computed_cksum = in_cksum(cksum_vec, 1);
173         if (computed_cksum == 0) {
174           proto_tree_add_text(gre_tree, tvb, offset, 2,
175                         "Checksum: 0x%04x (correct)", cksum);
176         } else {
177           proto_tree_add_text(gre_tree, tvb, offset, 2,
178                         "Checksum: 0x%04x (incorrect, should be 0x%04x)",
179                         cksum, in_cksum_shouldbe(cksum, computed_cksum));
180         }
181       } else {
182         proto_tree_add_text(gre_tree, tvb, offset, 2,
183                           "Checksum: 0x%04x", cksum);
184       }
185     }
186     offset += 2;
187   }
188
189   if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R) {
190     if (tree) {
191       proto_tree_add_text(gre_tree, tvb, offset, 2,
192                           "Offset: %u", tvb_get_ntohs(tvb, offset));
193     }
194     offset += 2;
195   }
196
197   if (flags_and_ver & GH_B_K) {
198     if (is_ppp) {
199       if (tree) {
200         proto_tree_add_text(gre_tree, tvb, offset, 2,
201                             "Payload length: %u", tvb_get_ntohs(tvb, offset));
202       }
203       offset += 2;
204       if (tree) {
205         proto_tree_add_text(gre_tree, tvb, offset, 2,
206                             "Call ID: %u", tvb_get_ntohs(tvb, offset));
207       }
208       offset += 2;
209     }
210     else {
211       if (tree) {
212         proto_tree_add_text(gre_tree, tvb, offset, 4,
213                             "Key: %u", tvb_get_ntohl(tvb, offset));
214       }
215       offset += 4;
216     }
217   }
218     
219   if (flags_and_ver & GH_B_S) {
220     if (tree) {
221       proto_tree_add_text(gre_tree, tvb, offset, 4,
222                           "Sequence number: %u", tvb_get_ntohl(tvb, offset));
223     }
224     offset += 4;
225   }
226
227   if (is_ppp && flags_and_ver & GH_P_A) {
228     if (tree) {
229       proto_tree_add_text(gre_tree, tvb, offset, 4,
230                           "Acknowledgement number: %u", tvb_get_ntohl(tvb, offset));
231     }
232     offset += 4;
233   }
234
235   if (flags_and_ver & GH_B_R) {
236     for (;;) {
237       sre_af = tvb_get_ntohs(tvb, offset);
238       if (tree) {
239         proto_tree_add_text(gre_tree, tvb, offset, sizeof(guint16),
240                           "Address family: %u", sre_af);
241       }
242       offset += sizeof(guint16);
243       if (tree) {
244         proto_tree_add_text(gre_tree, tvb, offset, 1,
245                           "SRE offset: %u", tvb_get_guint8(tvb, offset));
246       }
247       offset += sizeof(guint8);
248       sre_length = tvb_get_guint8(tvb, offset);
249       if (tree) {
250         proto_tree_add_text(gre_tree, tvb, offset, sizeof(guint8),
251                           "SRE length: %u", sre_length);
252       }
253       offset += sizeof(guint8);
254       if (sre_af == 0 && sre_length == 0)
255         break;
256       offset += sre_length;
257     }
258   }
259
260   next_tvb = tvb_new_subset(tvb, offset, -1, -1);
261   switch (type) {
262     case GRE_PPP:
263       call_dissector(ppp_handle, next_tvb, pinfo, tree);
264       break;
265     case GRE_IP:
266       call_dissector(ip_handle, next_tvb, pinfo, tree);
267       break;
268     case GRE_WCCP:
269       if (is_wccp2) {
270         if (tree)
271           dissect_gre_wccp2_redirect_header(tvb, offset, gre_tree);
272         offset += 4;
273       }
274       call_dissector(ip_handle, next_tvb, pinfo, tree);
275       break;
276     case GRE_IPX:
277       call_dissector(ipx_handle, next_tvb, pinfo, tree);
278       break;
279     case GRE_FR:
280       call_dissector(fr_handle, next_tvb, pinfo, tree);
281       break;        
282     default:
283       dissect_data(next_tvb, 0, pinfo, gre_tree);
284       break;
285   }
286 }
287
288 static void
289 add_flags_and_ver(proto_tree *tree, guint16 flags_and_ver, tvbuff_t *tvb,
290     int offset, int is_ppp)
291 {
292   proto_item *  ti;
293   proto_tree *  fv_tree;
294   int           nbits = sizeof(flags_and_ver) * 8;
295   
296   ti = proto_tree_add_text(tree, tvb, offset, 2, 
297                            "Flags and version: %#04x", flags_and_ver);
298   fv_tree = proto_item_add_subtree(ti, ett_gre_flags);
299   
300   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
301                       decode_boolean_bitfield(flags_and_ver, GH_B_C, nbits,
302                                               "Checksum", "No checksum"));
303   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
304                       decode_boolean_bitfield(flags_and_ver, GH_B_R, nbits,
305                                               "Routing", "No routing"));
306   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
307                       decode_boolean_bitfield(flags_and_ver, GH_B_K, nbits,
308                                               "Key", "No key"));
309   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
310                       decode_boolean_bitfield(flags_and_ver, GH_B_S, nbits,
311                                               "Sequence number", "No sequence number"));
312   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
313                       decode_boolean_bitfield(flags_and_ver, GH_B_s, nbits,
314                                               "Strict source route", "No strict source route"));
315   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
316                       decode_numeric_bitfield(flags_and_ver, GH_B_RECUR, nbits,
317                                               "Recursion control: %u"));
318   if (is_ppp) {
319     proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
320                         decode_boolean_bitfield(flags_and_ver, GH_P_A, nbits,
321                                                 "Acknowledgment number", "No acknowledgment number"));
322     proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
323                         decode_numeric_bitfield(flags_and_ver, GH_P_FLAGS, nbits,
324                                                 "Flags: %u"));
325   }
326   else {
327     proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
328                         decode_numeric_bitfield(flags_and_ver, GH_R_FLAGS, nbits,
329                                                 "Flags: %u"));
330   }
331
332   proto_tree_add_text(fv_tree, tvb, offset, sizeof(flags_and_ver), "%s",
333                       decode_numeric_bitfield(flags_and_ver, GH_B_VER, nbits,
334                                               "Version: %u"));
335  }
336
337 static void
338 dissect_gre_wccp2_redirect_header(tvbuff_t *tvb, int offset, proto_tree *tree)
339 {
340   proto_item *  ti;
341   proto_tree *  rh_tree;
342   guint8        rh_flags;
343   
344   ti = proto_tree_add_text(tree, tvb, offset, 4, "Redirect header");
345   rh_tree = proto_item_add_subtree(ti, ett_gre_wccp2_redirect_header);
346
347   rh_flags = tvb_get_guint8(tvb, offset);
348   proto_tree_add_text(rh_tree, tvb, offset, 1, "%s",
349                       decode_boolean_bitfield(rh_flags, 0x80, 8,
350                                       "Dynamic service", "Well-known service"));
351   proto_tree_add_text(rh_tree, tvb, offset, 1, "%s",
352                       decode_boolean_bitfield(rh_flags, 0x40, 8,
353                               "Alternative bucket used", "Alternative bucket not used"));
354
355   proto_tree_add_text(rh_tree, tvb, offset + 1, 1, "Service ID: %s",
356       val_to_str(tvb_get_guint8(tvb, offset + 1), service_id_vals, "Unknown (0x%02X)"));
357   if (rh_flags & 0x40)
358     proto_tree_add_text(rh_tree, tvb, offset + 2, 1, "Alternative bucket index: %u",
359                         tvb_get_guint8(tvb, offset + 2));
360   proto_tree_add_text(rh_tree, tvb, offset + 3, 1, "Primary bucket index: %u",
361                         tvb_get_guint8(tvb, offset + 3));
362 }
363  
364 void
365 proto_register_gre(void)
366 {
367         static hf_register_info hf[] = {
368                 { &hf_gre_proto,
369                         { "Protocol Type", "gre.proto", FT_UINT16, BASE_HEX, VALS(typevals), 0x0,
370                                 "The protocol that is GRE encapsulated"}
371                 },
372         };
373         static gint *ett[] = {
374                 &ett_gre,
375                 &ett_gre_flags,
376                 &ett_gre_wccp2_redirect_header,
377         };
378
379         proto_gre = proto_register_protocol("Generic Routing Encapsulation",
380             "GRE", "gre");
381         proto_register_field_array(proto_gre, hf, array_length(hf));
382         proto_register_subtree_array(ett, array_length(ett));
383 }
384
385 void
386 proto_reg_handoff_gre(void)
387 {
388         dissector_add("ip.proto", IP_PROTO_GRE, dissect_gre, proto_gre);
389
390         /*
391          * Get handles for the IP, IPX, PPP, and Frame Relay dissectors.
392          */
393         ip_handle = find_dissector("ip");
394         ipx_handle = find_dissector("ipx");
395         ppp_handle = find_dissector("ppp");
396         fr_handle = find_dissector("fr");
397 }