GTK: Wrap static preference labels.
[metze/wireshark/wip.git] / epan / dissectors / packet-vlan.c
1 /* packet-vlan.c
2  * Routines for VLAN 802.1Q ethernet header disassembly
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22
23 #define NEW_PROTO_TREE_API
24
25 #include "config.h"
26
27 #include <epan/packet.h>
28 #include <epan/capture_dissectors.h>
29 #include <wsutil/pint.h>
30 #include <epan/expert.h>
31 #include "packet-ieee8023.h"
32 #include "packet-ipx.h"
33 #include "packet-llc.h"
34 #include <epan/etypes.h>
35 #include <epan/prefs.h>
36 #include <epan/to_str.h>
37 #include <epan/addr_resolv.h>
38
39 void proto_register_vlan(void);
40 void proto_reg_handoff_vlan(void);
41
42 static unsigned int q_in_q_ethertype = ETHERTYPE_QINQ_OLD;
43
44 static gboolean vlan_summary_in_tree = TRUE;
45
46 enum version_value {
47   IEEE_8021Q_1998,
48   IEEE_8021Q_2005,
49   IEEE_8021Q_2011
50 };
51
52 static gint vlan_version = (gint)IEEE_8021Q_2011;
53
54 enum priority_drop_value {
55   Priority_Drop_8P0D,
56   Priority_Drop_7P1D,
57   Priority_Drop_6P2D,
58   Priority_Drop_5P3D,
59 };
60
61 static gint vlan_priority_drop = (gint)Priority_Drop_8P0D;
62
63 static dissector_handle_t vlan_handle;
64 static dissector_handle_t ethertype_handle;
65
66 static capture_dissector_handle_t llc_cap_handle;
67 static capture_dissector_handle_t ipx_cap_handle;
68
69 static header_field_info *hfi_vlan = NULL;
70
71 #define VLAN_HFI_INIT HFI_INIT(proto_vlan)
72
73 /* From Table G-2 of IEEE standard 802.1D-2004 */
74 /* Note that 0 is the default priority, but is above 1 and 2.
75  * Priority order from lowest to highest is 1,2,0,3,4,5,6,7 */
76 static const value_string pri_vals_old[] = {
77   { 0, "Best Effort (default)"             },
78   { 1, "Background"                        },
79   { 2, "Spare"                             },
80   { 3, "Excellent Effort"                  },
81   { 4, "Controlled Load"                   },
82   { 5, "Video, < 100ms latency and jitter" },
83   { 6, "Voice, < 10ms latency and jitter"  },
84   { 7, "Network Control"                   },
85   { 0, NULL                                }
86 };
87
88 static header_field_info hfi_vlan_priority_old VLAN_HFI_INIT = {
89         "Priority", "vlan.priority", FT_UINT16, BASE_DEC,
90         VALS(pri_vals_old), 0xE000, "Descriptions are recommendations from IEEE standard 802.1D-2004", HFILL };
91
92 /* From Table G-2 of IEEE standard 802.1Q-2005 (and I-2 of 2011 and 2014 revisions) */
93 /* Note that 0 is still the default, but priority 2 was moved from below 0 to
94  * above it. The new order from lowest to highest is 1,0,2,3,4,5,6,7 */
95 static const value_string pri_vals[] = {
96   { 0, "Best Effort (default)"             },
97   { 1, "Background"                        },
98   { 2, "Excellent Effort"                  },
99   { 3, "Critical Applications"             },
100   { 4, "Video, < 100ms latency and jitter" },
101   { 5, "Voice, < 10ms latency and jitter"  },
102   { 6, "Internetwork Control"              },
103   { 7, "Network Control"                   },
104   { 0, NULL                                }
105 };
106
107 static header_field_info hfi_vlan_priority VLAN_HFI_INIT = {
108         "Priority", "vlan.priority", FT_UINT16, BASE_DEC,
109         VALS(pri_vals), 0xE000, "Descriptions are recommendations from IEEE standard 802.1Q-2014", HFILL };
110
111 /* From Tables G-2,3 of IEEE standard 802.1Q-2005 (and I-2,3,7 of 2011 and 2014 revisions) */
112 static const value_string pri_vals_7[] = {
113   { 0, "Best Effort (default)"                           },
114   { 1, "Background"                                      },
115   { 2, "Excellent Effort"                                },
116   { 3, "Critical Applications"                           },
117   { 4, "Voice, < 10ms latency and jitter, Drop Eligible" },
118   { 5, "Voice, < 10ms latency and jitter"                },
119   { 6, "Internetwork Control"                            },
120   { 7, "Network Control"                                 },
121   { 0, NULL                                              }
122 };
123
124 static header_field_info hfi_vlan_priority_7 VLAN_HFI_INIT = {
125         "Priority", "vlan.priority", FT_UINT16, BASE_DEC,
126         VALS(pri_vals_7), 0xE000, "Descriptions are recommendations from IEEE standard 802.1Q-2014", HFILL };
127
128 /* From Tables G-2,3 of IEEE standard 802.1Q-2005 (and I-2,3,7 of 2011 and 2015 revisions) */
129 static const value_string pri_vals_6[] = {
130   { 0, "Best Effort (default)"                            },
131   { 1, "Background"                                       },
132   { 2, "Critical Applications, Drop Eligible"             },
133   { 3, "Critical Applications"                            },
134   { 4, "Voice, < 10ms latency and jitter, Drop Eligible"  },
135   { 5, "Voice, < 10ms latency and jitter"                 },
136   { 6, "Internetwork Control"                             },
137   { 7, "Network Control"                                  },
138   { 0, NULL                                               }
139 };
140
141 static header_field_info hfi_vlan_priority_6 VLAN_HFI_INIT = {
142         "Priority", "vlan.priority", FT_UINT16, BASE_DEC,
143         VALS(pri_vals_6), 0xE000, "Descriptions are recommendations from IEEE standard 802.1Q-2014", HFILL };
144
145 /* From Tables G-2,3 of IEEE standard 802.1Q-2005 (and I-2,3,7 of 2011 and 2015 revisions) */
146 static const value_string pri_vals_5[] = {
147   { 0, "Best Effort (default), Drop Eligible"            },
148   { 1, "Best Effort (default)"                           },
149   { 2, "Critical Applications, Drop Eligible"            },
150   { 3, "Critical Applications"                           },
151   { 4, "Voice, < 10ms latency and jitter, Drop Eligible" },
152   { 5, "Voice, < 10ms latency and jitter"                },
153   { 6, "Internetwork Control"                            },
154   { 7, "Network Control"                                 },
155   { 0, NULL                                              }
156 };
157
158 static header_field_info hfi_vlan_priority_5 VLAN_HFI_INIT = {
159         "Priority", "vlan.priority", FT_UINT16, BASE_DEC,
160         VALS(pri_vals_5), 0xE000, "Descriptions are recommendations from IEEE standard 802.1Q-2014", HFILL };
161
162 /* True is non-canonical (i.e., bit-reversed MACs like Token Ring) since usually 0 and canonical. */
163 static const true_false_string tfs_noncanonical_canonical = { "Non-canonical", "Canonical" };
164
165 static header_field_info hfi_vlan_cfi VLAN_HFI_INIT = {
166         "CFI", "vlan.cfi", FT_BOOLEAN, 16,
167         TFS(&tfs_noncanonical_canonical), 0x1000, "Canonical Format Identifier", HFILL };
168
169 static const true_false_string tfs_eligible_ineligible = { "Eligible", "Ineligible" };
170
171 static header_field_info hfi_vlan_dei VLAN_HFI_INIT = {
172         "DEI", "vlan.dei", FT_BOOLEAN, 16,
173         TFS(&tfs_eligible_ineligible), 0x1000, "Drop Eligible Indicator", HFILL };
174
175 static header_field_info hfi_vlan_id VLAN_HFI_INIT = {
176         "ID", "vlan.id", FT_UINT16, BASE_DEC,
177         NULL, 0x0FFF, "VLAN ID", HFILL };
178
179 static header_field_info hfi_vlan_id_name VLAN_HFI_INIT = {
180         "Name", "vlan.id_name", FT_STRING, STR_UNICODE,
181         NULL, 0x0, "VLAN ID Name", HFILL };
182
183 static header_field_info hfi_vlan_etype VLAN_HFI_INIT = {
184         "Type", "vlan.etype", FT_UINT16, BASE_HEX,
185         VALS(etype_vals), 0x0, "Ethertype", HFILL };
186
187 static header_field_info hfi_vlan_len VLAN_HFI_INIT = {
188         "Length", "vlan.len", FT_UINT16, BASE_DEC,
189         NULL, 0x0, NULL, HFILL };
190
191 static header_field_info hfi_vlan_trailer VLAN_HFI_INIT = {
192         "Trailer", "vlan.trailer", FT_BYTES, BASE_NONE,
193         NULL, 0x0, "VLAN Trailer", HFILL };
194
195
196 static gint ett_vlan = -1;
197
198 static expert_field ei_vlan_len = EI_INIT;
199
200 static gboolean
201 capture_vlan(const guchar *pd, int offset, int len, capture_packet_info_t *cpinfo, const union wtap_pseudo_header *pseudo_header _U_ ) {
202   guint16 encap_proto;
203   if ( !BYTES_ARE_IN_FRAME(offset,len,5) )
204     return FALSE;
205
206   encap_proto = pntoh16( &pd[offset+2] );
207   if ( encap_proto <= IEEE_802_3_MAX_LEN) {
208     if ( pd[offset+4] == 0xff && pd[offset+5] == 0xff ) {
209       return call_capture_dissector(ipx_cap_handle, pd,offset+4,len, cpinfo, pseudo_header);
210     } else {
211       return call_capture_dissector(llc_cap_handle, pd,offset+4,len, cpinfo, pseudo_header);
212     }
213   }
214
215   return try_capture_dissector("ethertype", encap_proto, pd, offset+4, len, cpinfo, pseudo_header);
216 }
217
218 static void
219 columns_set_vlan(column_info *cinfo, guint16 tci)
220 {
221   char id_str[16];
222
223   guint32_to_str_buf(tci & 0xFFF, id_str, sizeof(id_str));
224
225   if (vlan_version < IEEE_8021Q_2011) {
226     col_add_fstr(cinfo, COL_INFO,
227                  "PRI: %d  CFI: %d  ID: %s",
228                  (tci >> 13), ((tci >> 12) & 1), id_str);
229   } else {
230     col_add_fstr(cinfo, COL_INFO,
231                  "PRI: %d  DEI: %d  ID: %s",
232                  (tci >> 13), ((tci >> 12) & 1), id_str);
233   }
234   col_add_str(cinfo, COL_8021Q_VLAN_ID, id_str);
235 }
236
237 static int
238 dissect_vlan(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
239 {
240   proto_item *ti;
241   guint16 tci, vlan_id;
242   guint16 encap_proto;
243   gboolean is_802_2;
244   proto_tree *vlan_tree;
245   proto_item *item;
246
247   col_set_str(pinfo->cinfo, COL_PROTOCOL, "VLAN");
248   col_clear(pinfo->cinfo, COL_INFO);
249
250   tci = tvb_get_ntohs( tvb, 0 );
251   vlan_id = tci & 0xFFF;
252   /* Add the VLAN Id if it's the first one*/
253   if (pinfo->vlan_id == 0) {
254       pinfo->vlan_id = vlan_id;
255   }
256
257   columns_set_vlan(pinfo->cinfo, tci);
258
259   vlan_tree = NULL;
260
261   if (tree) {
262     ti = proto_tree_add_item(tree, hfi_vlan, tvb, 0, 4, ENC_NA);
263
264     if (vlan_summary_in_tree) {
265       if (vlan_version < IEEE_8021Q_2011) {
266         proto_item_append_text(ti, ", PRI: %u, CFI: %u, ID: %u",
267                 (tci >> 13), ((tci >> 12) & 1), vlan_id);
268       } else {
269         proto_item_append_text(ti, ", PRI: %u, DEI: %u, ID: %u",
270                 (tci >> 13), ((tci >> 12) & 1), vlan_id);
271       }
272     }
273
274     vlan_tree = proto_item_add_subtree(ti, ett_vlan);
275
276     if (vlan_version == IEEE_8021Q_1998) {
277         proto_tree_add_item(vlan_tree, &hfi_vlan_priority_old, tvb, 0, 2, ENC_BIG_ENDIAN);
278         proto_tree_add_item(vlan_tree, &hfi_vlan_cfi, tvb, 0, 2, ENC_BIG_ENDIAN);
279     } else {
280       switch (vlan_priority_drop) {
281
282         case Priority_Drop_8P0D:
283           proto_tree_add_item(vlan_tree, &hfi_vlan_priority, tvb, 0, 2, ENC_BIG_ENDIAN);
284           break;
285
286         case Priority_Drop_7P1D:
287           proto_tree_add_item(vlan_tree, &hfi_vlan_priority_7, tvb, 0, 2, ENC_BIG_ENDIAN);
288           break;
289
290         case Priority_Drop_6P2D:
291           proto_tree_add_item(vlan_tree, &hfi_vlan_priority_6, tvb, 0, 2, ENC_BIG_ENDIAN);
292           break;
293
294         case Priority_Drop_5P3D:
295           proto_tree_add_item(vlan_tree, &hfi_vlan_priority_5, tvb, 0, 2, ENC_BIG_ENDIAN);
296           break;
297       }
298       if (vlan_version == IEEE_8021Q_2005) {
299         proto_tree_add_item(vlan_tree, &hfi_vlan_cfi, tvb, 0, 2, ENC_BIG_ENDIAN);
300       } else {
301         proto_tree_add_item(vlan_tree, &hfi_vlan_dei, tvb, 0, 2, ENC_BIG_ENDIAN);
302       }
303     }
304     proto_tree_add_item(vlan_tree, &hfi_vlan_id, tvb, 0, 2, ENC_BIG_ENDIAN);
305     if (gbl_resolv_flags.vlan_name) {
306       item = proto_tree_add_string(vlan_tree, &hfi_vlan_id_name, tvb, 0, 2,
307                                    get_vlan_name(wmem_packet_scope(), vlan_id));
308       PROTO_ITEM_SET_GENERATED(item);
309
310     }
311
312     /* TODO: If the CFI is set on Ethernet (or FDDI MAC and not source routed,
313      * i.e. the RII bit in the source MAC address is 0, then a E-RIF follows.
314      * Only true before version 2011 since the CFI was replaced with DEI
315      * (Since who needs VLANs that bridge Token Ring and FDDI these days?)  */
316   }
317
318   encap_proto = tvb_get_ntohs(tvb, 2);
319   if (encap_proto <= IEEE_802_3_MAX_LEN) {
320     /* Is there an 802.2 layer? I can tell by looking at the first 2
321        bytes after the VLAN header. If they are 0xffff, then what
322        follows the VLAN header is an IPX payload, meaning no 802.2.
323        (IPX/SPX is they only thing that can be contained inside a
324        straight 802.3 packet, so presumably the same applies for
325        Ethernet VLAN packets). A non-0xffff value means that there's an
326        802.2 layer inside the VLAN layer */
327     is_802_2 = TRUE;
328
329     /* Don't throw an exception for this check (even a BoundsError) */
330     if (tvb_captured_length_remaining(tvb, 4) >= 2) {
331       if (tvb_get_ntohs(tvb, 4) == 0xffff) {
332         is_802_2 = FALSE;
333       }
334     }
335
336     dissect_802_3(encap_proto, is_802_2, tvb, 4, pinfo, tree, vlan_tree,
337                   hfi_vlan_len.id, hfi_vlan_trailer.id, &ei_vlan_len, 0);
338   } else {
339     ethertype_data_t ethertype_data;
340
341     ethertype_data.etype = encap_proto;
342     ethertype_data.offset_after_ethertype = 4;
343     ethertype_data.fh_tree = vlan_tree;
344     ethertype_data.etype_id = hfi_vlan_etype.id;
345     ethertype_data.trailer_id = hfi_vlan_trailer.id;
346     ethertype_data.fcs_len = 0;
347
348     call_dissector_with_data(ethertype_handle, tvb, pinfo, tree, &ethertype_data);
349   }
350   return tvb_captured_length(tvb);
351 }
352
353 void
354 proto_register_vlan(void)
355 {
356 #ifndef HAVE_HFI_SECTION_INIT
357   static header_field_info *hfi[] = {
358     &hfi_vlan_priority_old,
359     &hfi_vlan_priority,
360     &hfi_vlan_priority_7,
361     &hfi_vlan_priority_6,
362     &hfi_vlan_priority_5,
363     &hfi_vlan_cfi,
364     &hfi_vlan_dei,
365     &hfi_vlan_id,
366     &hfi_vlan_id_name,
367     &hfi_vlan_etype,
368     &hfi_vlan_len,
369     &hfi_vlan_trailer,
370   };
371 #endif /* HAVE_HFI_SECTION_INIT */
372
373   static gint *ett[] = {
374     &ett_vlan
375   };
376
377   static ei_register_info ei[] = {
378      { &ei_vlan_len, { "vlan.len.past_end", PI_MALFORMED, PI_ERROR, "Length field value goes past the end of the payload", EXPFILL }},
379   };
380
381   static const enum_val_t version_vals[] = {
382     {"1998", "IEEE 802.1Q-1998", IEEE_8021Q_1998},
383     {"2005", "IEEE 802.1Q-2005", IEEE_8021Q_2005},
384     {"2011", "IEEE 802.1Q-2011", IEEE_8021Q_2011},
385     {NULL, NULL, -1}
386   };
387
388   static const enum_val_t priority_drop_vals[] = {
389     {"8p0d", "8 Priorities, 0 Drop Eligible", Priority_Drop_8P0D},
390     {"7p1d", "7 Priorities, 1 Drop Eligible", Priority_Drop_7P1D},
391     {"6p2d", "6 Priorities, 2 Drop Eligible", Priority_Drop_6P2D},
392     {"5p3d", "5 Priorities, 3 Drop Eligible", Priority_Drop_5P3D},
393     {NULL, NULL, -1}
394   };
395
396   module_t *vlan_module;
397   expert_module_t* expert_vlan;
398   int proto_vlan;
399
400   proto_vlan = proto_register_protocol("802.1Q Virtual LAN", "VLAN", "vlan");
401   hfi_vlan = proto_registrar_get_nth(proto_vlan);
402
403   proto_register_fields(proto_vlan, hfi, array_length(hfi));
404   proto_register_subtree_array(ett, array_length(ett));
405   expert_vlan = expert_register_protocol(proto_vlan);
406   expert_register_field_array(expert_vlan, ei, array_length(ei));
407
408   vlan_module = prefs_register_protocol(proto_vlan, proto_reg_handoff_vlan);
409   prefs_register_bool_preference(vlan_module, "summary_in_tree",
410         "Show vlan summary in protocol tree",
411         "Whether the vlan summary line should be shown in the protocol tree",
412         &vlan_summary_in_tree);
413   prefs_register_uint_preference(vlan_module, "qinq_ethertype",
414         "802.1QinQ Ethertype (in hex)",
415         "The (hexadecimal) Ethertype used to indicate 802.1QinQ VLAN in VLAN tunneling.",
416         16, &q_in_q_ethertype);
417   prefs_register_enum_preference(vlan_module, "version",
418         "IEEE 802.1Q version",
419         "IEEE 802.1Q specification version used (802.1Q-1998 uses 802.1D-2004 for PRI values)",
420         &vlan_version, version_vals, TRUE);
421   prefs_register_enum_preference(vlan_module, "priority_drop",
422         "Priorities and drop eligibility",
423         "Number of priorities supported, and number of those drop eligible (not used for 802.1Q-1998)",
424         &vlan_priority_drop, priority_drop_vals, FALSE);
425   vlan_handle = create_dissector_handle(dissect_vlan, proto_vlan);
426 }
427
428 void
429 proto_reg_handoff_vlan(void)
430 {
431   static gboolean prefs_initialized = FALSE;
432   static unsigned int old_q_in_q_ethertype;
433   capture_dissector_handle_t vlan_cap_handle;
434
435   if (!prefs_initialized)
436   {
437     dissector_add_uint("ethertype", ETHERTYPE_VLAN, vlan_handle);
438     vlan_cap_handle = create_capture_dissector_handle(capture_vlan, hfi_vlan->id);
439     capture_dissector_add_uint("ethertype", ETHERTYPE_VLAN, vlan_cap_handle);
440
441     prefs_initialized = TRUE;
442   }
443   else
444   {
445     dissector_delete_uint("ethertype", old_q_in_q_ethertype, vlan_handle);
446   }
447
448   old_q_in_q_ethertype = q_in_q_ethertype;
449   ethertype_handle = find_dissector_add_dependency("ethertype", hfi_vlan->id);
450
451   dissector_add_uint("ethertype", q_in_q_ethertype, vlan_handle);
452
453   llc_cap_handle = find_capture_dissector("llc");
454   ipx_cap_handle = find_capture_dissector("ipx");
455 }
456
457 /*
458  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
459  *
460  * Local Variables:
461  * c-basic-offset: 2
462  * tab-width: 8
463  * indent-tabs-mode: nil
464  * End:
465  *
466  * ex: set shiftwidth=2 tabstop=8 expandtab:
467  * :indentSize=2:tabSize=8:noTabs=true:
468  */