Have "proto_register_protocol()" build a list of data structures for
[obnox/wireshark/wip.git] / packet-auto_rp.c
1 /* packet-auto_rp.c
2  * Routines for the Cisco Auto-RP protocol
3  * ftp://ftpeng.cisco.com/ftp/ipmulticast/specs/pim-autorp-spec01.txt
4  *
5  * Heikki Vatiainen <hessu@cs.tut.fi>
6  *
7  * $Id: packet-auto_rp.c,v 1.11 2001/01/03 06:55:27 guy Exp $
8  *
9  * Ethereal - Network traffic analyzer
10  * By Gerald Combs <gerald@zing.org>
11  * Copyright 1998 Gerald Combs
12  *
13  * 
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License
16  * as published by the Free Software Foundation; either version 2
17  * of the License, or (at your option) any later version.
18  * 
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  * 
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
27  */
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #ifdef HAVE_SYS_TYPES_H
34 # include <sys/types.h>
35 #endif
36
37 #ifdef HAVE_NETINET_IN_H
38 #include <netinet/in.h>
39 #endif
40
41 #include <string.h>
42 #include <glib.h>
43 #include "packet.h"
44 #include "resolv.h"
45
46 static gint proto_auto_rp = -1;
47 static gint ett_auto_rp = -1;
48 static gint ett_auto_rp_ver_type = -1;
49 static gint ett_auto_rp_map = -1;
50 static gint ett_auto_rp_group = -1;
51
52 static gint hf_auto_rp_version = -1;
53 static gint hf_auto_rp_type = -1;
54 static gint hf_auto_rp_count = -1;
55 static gint hf_auto_rp_holdtime = -1;
56 static gint hf_auto_rp_pim_ver = -1;
57 static gint hf_auto_rp_rp_addr = -1;
58 static gint hf_auto_rp_prefix_sgn = -1;
59 static gint hf_auto_rp_mask_len = -1;
60 static gint hf_auto_rp_group_prefix = -1;
61
62 #define UDP_PORT_PIM_RP_DISC 496
63
64 struct auto_rp_fixed_hdr {
65 #define AUTO_RP_VERSION_MASK 0xf0
66 #define AUTO_RP_TYPE_MASK    0x0f
67         guint8  ver_type;       /* pim-autorp-spec01.txt defines version 1+ */
68         guint8  rp_count;       /* Number of struct auto_rp_maps that follow the this header */
69         guint16 holdtime;       /* Time in seconds this announcement is valid. 0 equals forever */
70         guint32 reserved;
71 };
72
73 struct auto_rp_map_hdr {
74         guint32 rp_address;       /* The unicast IPv4 address of this RP */
75 #define AUTO_RP_PIM_VER_MASK 0x03
76         guint8  pim_version;      /* RP's highest PIM version. 2-bit field */
77         guint8  group_count;      /* Number of encoded group addresses that follow this header */
78 };
79
80 struct auto_rp_enc_grp_hdr {   /* Encoded group address */
81 #define AUTO_RP_SIGN_MASK 0x01
82         guint8  prefix_sgn;    /* 0 positive, 1 negative group prefix */
83         guint8  mask_len;      /* Length of group prefix */
84         guint32 addr;          /* Group prefix */
85 };
86
87 #define AUTO_RP_VER_1PLUS 1
88 static const value_string auto_rp_ver_vals[] = {
89         {AUTO_RP_VER_1PLUS, "1 or 1+"},
90         {0,                 NULL}
91 };
92
93 #define AUTO_RP_TYPE_ANNOUNCEMENT 1
94 #define AUTO_RP_TYPE_MAPPING      2
95 static const value_string auto_rp_type_vals[] = {
96         {AUTO_RP_TYPE_ANNOUNCEMENT, "RP announcement"},
97         {AUTO_RP_TYPE_MAPPING,      "RP mapping"},
98         {0,                         NULL}
99 };
100
101 #define AUTO_RP_PIM_VERSION_UNKNOWN 0x00
102 #define AUTO_RP_PIM_VERSION_1       0x01
103 #define AUTO_RP_PIM_VERSION_2       0x02
104 #define AUTO_RP_PIM_VERSION_DUAL    0x03
105 static const value_string auto_rp_pim_ver_vals[] = {
106         {AUTO_RP_PIM_VERSION_UNKNOWN, "Version unknown"},
107         {AUTO_RP_PIM_VERSION_1,       "Version 1"},
108         {AUTO_RP_PIM_VERSION_2,       "Version 2"},
109         {AUTO_RP_PIM_VERSION_DUAL,    "Dual version 1 and 2"},
110         {0,                           NULL}
111 };
112
113 #define AUTO_RP_GROUP_MASK_SIGN_POS 0
114 #define AUTO_RP_GROUP_MASK_SIGN_NEG 1
115 static const value_string auto_rp_mask_sign_vals[] = {
116         {AUTO_RP_GROUP_MASK_SIGN_POS,  "Positive group prefix"},
117         {AUTO_RP_GROUP_MASK_SIGN_NEG,  "Negative group prefix"},
118         {0,                            NULL}
119 };
120
121 static int do_auto_rp_map(tvbuff_t *tvb, int offset, proto_tree *auto_rp_tree);
122
123 static void dissect_auto_rp(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
124 {
125         guint8 ver_type, rp_count;
126
127         CHECK_DISPLAY_AS_DATA(proto_auto_rp, tvb, pinfo, tree);
128
129         pinfo->current_proto = "Auto-RP";
130
131         if (check_col(pinfo->fd, COL_PROTOCOL))
132                 col_set_str(pinfo->fd, COL_PROTOCOL, "Auto-RP");
133         
134         ver_type = tvb_get_guint8(tvb, 0);
135         rp_count = tvb_get_guint8(tvb, 1);
136         if (check_col(pinfo->fd, COL_INFO))
137                 col_add_fstr(pinfo->fd, COL_INFO, "%s (v%s) for %u RP%s",
138                              val_to_str(lo_nibble(ver_type), auto_rp_type_vals, "Unknown"),
139                              val_to_str(hi_nibble(ver_type), auto_rp_ver_vals, "Unknown"),
140                              rp_count, plurality(rp_count, "", "s"));
141
142         if (tree) {
143                 proto_item *ti, *tv;
144                 proto_tree *auto_rp_tree, *ver_type_tree;
145                 int i, offset;
146                 guint16 holdtime;
147
148                 offset = 0;
149                 ti = proto_tree_add_item(tree, proto_auto_rp, tvb, offset, tvb_length(tvb), FALSE);
150                 auto_rp_tree = proto_item_add_subtree(ti, ett_auto_rp);
151
152                 tv = proto_tree_add_text(auto_rp_tree, tvb, offset, 1, "Version: %s, Packet type: %s",
153                                          val_to_str(hi_nibble(ver_type), auto_rp_ver_vals, "Unknown"),
154                                          val_to_str(lo_nibble(ver_type), auto_rp_type_vals, "Unknown"));
155                 ver_type_tree = proto_item_add_subtree(tv, ett_auto_rp_ver_type);
156                 proto_tree_add_uint(ver_type_tree, hf_auto_rp_version, tvb, offset, 1, ver_type);
157                 proto_tree_add_uint(ver_type_tree, hf_auto_rp_type, tvb, offset, 1, ver_type);
158                 offset++;
159
160                 proto_tree_add_uint(auto_rp_tree, hf_auto_rp_count, tvb, offset, 1, rp_count);
161                 offset++;
162
163                 holdtime = tvb_get_ntohs(tvb, offset);
164                 proto_tree_add_uint_format(auto_rp_tree, hf_auto_rp_holdtime, tvb, offset, 2, holdtime,
165                                            "Holdtime: %u second%s", holdtime, plurality(holdtime, "", "s"));
166                 offset+=2;
167
168                 proto_tree_add_text(auto_rp_tree, tvb, offset, 4, "Reserved: 0x%x", tvb_get_ntohs(tvb, offset));
169                 offset+=4;
170
171                 for (i = 0; i < rp_count; i++)
172                         offset = do_auto_rp_map(tvb, offset, auto_rp_tree);
173
174                 if (tvb_length_remaining(tvb, offset) > 0)
175                         proto_tree_add_text(tree, tvb, offset, tvb_length_remaining(tvb, offset), "Trailing junk");
176         }
177
178         return;
179 }
180
181 void proto_register_auto_rp(void)
182 {
183         static hf_register_info hf[] = {
184                 { &hf_auto_rp_version,
185                   {"Protocol version", "auto_rp.version",
186                    FT_UINT8, BASE_DEC, VALS(auto_rp_ver_vals), AUTO_RP_VERSION_MASK,
187                    "Auto-RP protocol version"}},
188
189                 { &hf_auto_rp_type,
190                   {"Packet type", "auto_rp.type",
191                    FT_UINT8, BASE_DEC, VALS(auto_rp_type_vals), AUTO_RP_TYPE_MASK,
192                    "Auto-RP packet type"}},
193
194                 { &hf_auto_rp_count,
195                   {"RP count", "auto_rp.rp_count",
196                    FT_UINT8, BASE_DEC, NULL, 0,
197                    "The number of RP addresses contained in this message"}},
198
199                 { &hf_auto_rp_holdtime,
200                   {"Holdtime", "auto_rp.holdtime",
201                    FT_UINT16, BASE_DEC, NULL, 0,
202                    "The amount of time in seconds this announcement is valid"}},
203
204                 { &hf_auto_rp_pim_ver,
205                   {"Version", "auto_rp.pim_ver",
206                    FT_UINT8, BASE_DEC, VALS(auto_rp_pim_ver_vals), AUTO_RP_PIM_VER_MASK,
207                    "RP's highest PIM version"}},
208
209                 { &hf_auto_rp_rp_addr,
210                   {"RP address", "auto_rp.rp_addr",
211                    FT_IPv4, 0, NULL, 0,
212                    "The unicast IP address of the RP"}},
213
214                 { &hf_auto_rp_prefix_sgn,
215                   {"Sign", "auto_rp.prefix_sign",
216                    FT_UINT8, BASE_DEC, VALS(auto_rp_mask_sign_vals), AUTO_RP_SIGN_MASK,
217                    "Group prefix sign"}},
218
219                 { &hf_auto_rp_mask_len,
220                   {"Mask length", "auto_rp.mask_len",
221                    FT_UINT8, BASE_BIN, NULL, 0x0,
222                    "Length of group prefix"}},
223
224                 { &hf_auto_rp_group_prefix,
225                   {"Prefix", "auto_rp.group_prefix",
226                    FT_IPv4, 0, NULL, 0,
227                    "Group prefix"}}
228         };
229
230         static gint *ett[] = {
231                 &ett_auto_rp,
232                 &ett_auto_rp_ver_type,
233                 &ett_auto_rp_map,
234                 &ett_auto_rp_group
235         };
236
237         proto_auto_rp = proto_register_protocol("Cisco Auto-RP",
238             "Auto-RP", "auto_rp");
239         proto_register_field_array(proto_auto_rp, hf, array_length(hf));
240         proto_register_subtree_array(ett, array_length(ett));
241
242         return;
243 }
244
245 void
246 proto_reg_handoff_auto_rp(void)
247 {
248         dissector_add("udp.port", UDP_PORT_PIM_RP_DISC, dissect_auto_rp);
249 }
250
251 /*
252  * Handles one Auto-RP map entry. Returns the new offset.
253  */
254 static int do_auto_rp_map(tvbuff_t *tvb, int offset, proto_tree *auto_rp_tree)
255 {
256         proto_item *ti;
257         proto_tree *map_tree;
258         guint8 group_count;
259         guint32 rp_addr;      /* In network byte order */
260         int i;
261
262         tvb_memcpy(tvb, (guint8 *)&rp_addr, offset, 4);
263         group_count = tvb_get_guint8(tvb, offset + 5);
264
265                                /* sizeof map header + n * sizeof encoded group addresses */
266         ti = proto_tree_add_text(auto_rp_tree, tvb, offset, 6 + group_count * 6,
267                                  "RP %s: %u group%s", ip_to_str((void *)&rp_addr),
268                                  group_count, plurality(group_count, "", "s"));
269         map_tree = proto_item_add_subtree(ti, ett_auto_rp_map);
270
271         proto_tree_add_ipv4(map_tree, hf_auto_rp_rp_addr, tvb, offset, 4, rp_addr);
272         offset += 4;
273         proto_tree_add_uint(map_tree, hf_auto_rp_pim_ver, tvb, offset, 1, tvb_get_guint8(tvb, offset));
274         offset++;
275         proto_tree_add_text(map_tree, tvb, offset, 1, "Number of groups this RP maps to: %u", group_count);
276         offset++;
277
278         for (i = 0; i < group_count; i++) {
279                 proto_item *gi;
280                 proto_tree *grp_tree;
281                 guint8 sign, mask_len;
282                 guint32 group_addr;     /* In network byte order */
283
284                 sign = tvb_get_guint8(tvb, offset);
285                 mask_len = tvb_get_guint8(tvb, offset + 1);
286                 tvb_memcpy(tvb, (guint8 *)&group_addr, offset + 2, 4);
287                 gi = proto_tree_add_text(map_tree, tvb, offset, 6, "Group %s/%u (%s)",
288                                          ip_to_str((void *)&group_addr), mask_len,
289                                          val_to_str(sign&AUTO_RP_SIGN_MASK, auto_rp_mask_sign_vals, ""));
290                 grp_tree = proto_item_add_subtree(gi, ett_auto_rp_group);
291
292                 proto_tree_add_uint(grp_tree, hf_auto_rp_prefix_sgn, tvb, offset, 1, sign);
293                 offset++;
294                 proto_tree_add_uint(grp_tree, hf_auto_rp_mask_len, tvb, offset, 1, mask_len);
295                 offset++;
296                 proto_tree_add_ipv4(grp_tree, hf_auto_rp_group_prefix, tvb, offset, 4, group_addr);
297                 offset += 4;
298          
299         }
300
301         return offset;
302 }