cbd9d7ae8f4aac77bb7b152bb4438bbed2264391
[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.16 2000/03/12 04:47:38 gram 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-ppp.h"
42
43 static int proto_gre = -1;
44 static int hf_gre_proto = -1;
45
46 static gint ett_gre = -1;
47 static gint ett_gre_flags = -1;
48
49 /* bit positions for flags in header */
50 #define GH_B_C          0x8000
51 #define GH_B_R          0x4000
52 #define GH_B_K          0x2000
53 #define GH_B_S          0x1000
54 #define GH_B_s          0x0800
55 #define GH_B_RECUR      0x0700
56 #define GH_P_A          0x0080  /* only in special PPTPized GRE header */
57 #define GH_P_FLAGS      0x0078  /* only in special PPTPized GRE header */
58 #define GH_R_FLAGS      0x00F8
59 #define GH_B_VER        0x0007
60
61 #define GRE_PPP         0x880B
62 #define GRE_IP          0x0800
63 #define GRE_WCCP        0x883E
64
65 static void add_flags_and_ver(proto_tree *, guint16, int, int);
66
67 static const value_string typevals[] = {
68         { GRE_PPP,  "PPP" },
69         { GRE_IP,   "IP" },
70         { GRE_WCCP, "WCCP"},
71         { 0,        NULL  }
72 };
73
74 void
75 dissect_gre(const u_char *pd, int offset, frame_data *fd, proto_tree *tree) {
76   
77   guint16       flags_and_ver = pntohs(pd + offset);
78   guint16       type          = pntohs(pd + offset + sizeof(flags_and_ver));
79   guint16       sre_af;
80   guint8        sre_length;
81
82   if (check_col(fd, COL_PROTOCOL))
83     col_add_str(fd, COL_PROTOCOL, "GRE");
84         
85   if (check_col(fd, COL_INFO)) {
86     col_add_fstr(fd, COL_INFO, "Encapsulated %s",
87         val_to_str(type, typevals, "0x%04X (unknown)"));
88   }
89                 
90   if (IS_DATA_IN_FRAME(offset) && tree) {
91     gboolean            is_ppp = FALSE;
92     gboolean            is_wccp2 = FALSE;
93     proto_item *        ti;
94     proto_tree *        gre_tree;
95     guint               len = 4;
96
97     if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R)
98       len += 4;
99     if (flags_and_ver & GH_B_K)
100       len += 4;
101     if (flags_and_ver & GH_B_S)
102       len += 4;
103     switch (type) {
104
105     case GRE_PPP:
106       if (flags_and_ver & GH_P_A)
107         len += 4;
108       is_ppp = TRUE;
109       break;
110
111     case GRE_WCCP:
112       /* WCCP2 apparently puts an extra 4 octets into the header, but uses
113          the same encapsulation type; if it looks as if the first octet of
114          the packet isn't the beginning of an IPv4 header, assume it's
115          WCCP2. */
116       if ((pd[offset + sizeof(flags_and_ver) + sizeof(type)] & 0xF0) != 0x40) {
117         len += 4;
118         is_wccp2 = TRUE;
119       }
120       break;
121     }
122
123     ti = proto_tree_add_protocol_format(tree, proto_gre, offset, len,
124       "Generic Routing Encapsulation (%s)",
125       val_to_str(type, typevals, "0x%04X - unknown"));
126     gre_tree = proto_item_add_subtree(ti, ett_gre);
127     add_flags_and_ver(gre_tree, flags_and_ver, offset, is_ppp);
128
129     offset += sizeof(flags_and_ver);
130
131     proto_tree_add_item(gre_tree, hf_gre_proto, offset, sizeof(type), type);
132     offset += sizeof(type);
133
134     if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R) {
135       guint16 checksum = pntohs(pd + offset);
136       proto_tree_add_text(gre_tree, offset, sizeof(checksum),
137                           "Checksum: %u", checksum);
138       offset += sizeof(checksum);
139     }
140     
141     if (flags_and_ver & GH_B_C || flags_and_ver & GH_B_R) {
142       guint16 rtoffset = pntohs(pd + offset);
143       proto_tree_add_text(gre_tree, offset, sizeof(rtoffset),
144                           "Offset: %u", rtoffset);
145       offset += sizeof(rtoffset);
146     }
147
148     if (flags_and_ver & GH_B_K) {
149       if (is_ppp) {
150         guint16 paylen;
151         guint16 callid;
152         
153         paylen = pntohs(pd + offset);
154         proto_tree_add_text(gre_tree, offset, sizeof(paylen),
155                             "Payload length: %u", paylen);
156         offset += sizeof(paylen);
157
158         callid = pntohs(pd + offset);
159         proto_tree_add_text(gre_tree, offset, sizeof(callid),
160                             "Call ID: %u", callid);
161         offset += sizeof(callid);
162       }
163       else {
164         guint32 key = pntohl(pd + offset);
165         proto_tree_add_text(gre_tree, offset, sizeof(key),
166                             "Key: %u", key);
167         offset += sizeof(key);
168       }
169     }
170     
171     if (flags_and_ver & GH_B_S) {
172       guint32 seqnum = pntohl(pd + offset);
173       proto_tree_add_text(gre_tree, offset, sizeof(seqnum),
174                           "Sequence number: %u", seqnum);
175       offset += sizeof(seqnum);
176     }
177
178     if (is_ppp && flags_and_ver & GH_P_A) {
179       guint32 acknum = pntohl(pd + offset);
180       proto_tree_add_text(gre_tree, offset, sizeof(acknum),
181                           "Acknowledgement number: %u", acknum);
182       offset += sizeof(acknum);
183     }
184
185     if (flags_and_ver & GH_B_R) {
186       for (;;) {
187         sre_af = pntohs(pd + offset);
188         proto_tree_add_text(gre_tree, offset, sizeof(guint16),
189                           "Address family: %u", sre_af);
190         offset += sizeof(guint16);
191         proto_tree_add_text(gre_tree, offset, 1,
192                           "SRE offset: %u", pd[offset++]);
193         sre_length = pd[offset];
194         proto_tree_add_text(gre_tree, offset, sizeof(guint8),
195                           "SRE length: %u", sre_length);
196         offset += sizeof(guint8);
197         if (sre_af == 0 && sre_length == 0)
198           break;
199         offset += sre_length;
200       }
201     }
202
203     switch (type) {
204       case GRE_PPP:
205         dissect_payload_ppp(pd, offset, fd, tree);
206         break;
207       case GRE_IP:
208         dissect_ip(pd, offset, fd, tree);
209         break;
210       case GRE_WCCP:
211         if (is_wccp2) {
212           proto_tree_add_text(gre_tree, offset, sizeof(guint32), "WCCPv2 Data");
213           offset += 4;
214         }
215         dissect_ip(pd, offset, fd, tree);
216         break;
217       default:
218         dissect_data(pd, offset, fd, gre_tree);
219         break;
220     }
221   }
222 }
223
224 static void
225 add_flags_and_ver(proto_tree *tree, guint16 flags_and_ver, int offset, int is_ppp) {
226
227   proto_item *  ti;
228   proto_tree *  fv_tree;
229   int           nbits = sizeof(flags_and_ver) * 8;
230   
231   ti = proto_tree_add_text(tree, offset, 2, 
232                            "Flags and version: %#04x", flags_and_ver);
233   fv_tree = proto_item_add_subtree(ti, ett_gre_flags);
234   
235   proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
236                       decode_boolean_bitfield(flags_and_ver, GH_B_C, nbits,
237                                               "Checksum", "No checksum"));
238   proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
239                       decode_boolean_bitfield(flags_and_ver, GH_B_R, nbits,
240                                               "Routing", "No routing"));
241   proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
242                       decode_boolean_bitfield(flags_and_ver, GH_B_K, nbits,
243                                               "Key", "No key"));
244   proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
245                       decode_boolean_bitfield(flags_and_ver, GH_B_S, nbits,
246                                               "Sequence number", "No sequence number"));
247   proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
248                       decode_boolean_bitfield(flags_and_ver, GH_B_s, nbits,
249                                               "Strict source route", "No strict source route"));
250   proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
251                       decode_numeric_bitfield(flags_and_ver, GH_B_RECUR, nbits,
252                                               "Recursion control: %u"));
253   if (is_ppp) {
254     proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
255                         decode_boolean_bitfield(flags_and_ver, GH_P_A, nbits,
256                                                 "Acknowledgment number", "No acknowledgment number"));
257     proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
258                         decode_numeric_bitfield(flags_and_ver, GH_P_FLAGS, nbits,
259                                                 "Flags: %u"));
260   }
261   else {
262     proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
263                         decode_numeric_bitfield(flags_and_ver, GH_R_FLAGS, nbits,
264                                                 "Flags: %u"));
265   }
266
267   proto_tree_add_text(fv_tree, offset, sizeof(flags_and_ver), "%s",
268                       decode_numeric_bitfield(flags_and_ver, GH_B_VER, nbits,
269                                               "Version: %u"));
270  }
271  
272 void
273 proto_register_gre(void)
274 {
275         static hf_register_info hf[] = {
276                 { &hf_gre_proto,
277                         { "Protocol Type", "gre.proto", FT_UINT16, BASE_HEX, VALS(typevals), 0x0,
278                                 "The protocol that is GRE encapsulated"}
279                 },
280         };
281         static gint *ett[] = {
282                 &ett_gre,
283                 &ett_gre_flags,
284         };
285
286         proto_gre = proto_register_protocol("Generic Routing Encapsulation", "gre");
287         proto_register_field_array(proto_gre, hf, array_length(hf));
288         proto_register_subtree_array(ett, array_length(ett));
289 }