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.2 2000/01/07 22:05:29 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_ver_type = -1;
  53 static gint hf_auto_rp_version = -1;
  54 static gint hf_auto_rp_type = -1;
  55 static gint hf_auto_rp_map = -1;
  56 static gint hf_auto_rp_pim_ver = -1;
  57 static gint hf_auto_rp_group = -1;
  58 static gint hf_auto_rp_mask_sgn = -1;
  59
  60 struct auto_rp_fixed_hdr {
  61 #define AUTO_RP_VERSION_MASK 0xf0
  62 #define AUTO_RP_TYPE_MASK    0x0f
  63         guint8  ver_type;       /* pim-autorp-spec01.txt defines version 1+ */
  64         guint8  rp_count;       /* Number of struct auto_rp_maps that follow the this header */
  65         guint16 holdtime;       /* Time in seconds this announcement is valid. 0 equals forever */
  66         guint32 reserved;
  67 };
  68
  69 struct auto_rp_map_hdr {
  70         guint32 rp_address;       /* The unicast IPv4 address of this RP */
  71 #define AUTO_RP_PIM_VER_MASK 0x03
  72         guint8  pim_version;      /* RP's highest PIM version. 2-bit field */
  73         guint8  group_count;      /* Number of encoded group addresses that follow this header */
  74 };
  75
  76 struct auto_rp_enc_grp_hdr {   /* Encoded group address */
  77 #define AUTO_RP_SIGN_MASK 0x01
  78         guint8  prefix_sgn;    /* 0 positive, 1 negative group prefix */
  79         guint8  mask_len;      /* Length of group prefix */
  80         guint32 addr;          /* Group prefix */
  81 };
  82
  83 #define AUTO_RP_VER_1PLUS 1
  84 static const value_string auto_rp_ver_vals[] = {
  85         {AUTO_RP_VER_1PLUS, "1 or 1+"},
  86         {0,                 NULL}
  87 };
  88
  89 #define AUTO_RP_TYPE_ANNOUNCEMENT 1
  90 #define AUTO_RP_TYPE_MAPPING      2
  91 static const value_string auto_rp_type_vals[] = {
  92         {AUTO_RP_TYPE_ANNOUNCEMENT, "RP announcement"},
  93         {AUTO_RP_TYPE_MAPPING,      "RP mapping"},
  94         {0,                         NULL}
  95 };
  96
  97 #define AUTO_RP_PIM_VERSION_UNKNOWN 0x00
  98 #define AUTO_RP_PIM_VERSION_1       0x01
  99 #define AUTO_RP_PIM_VERSION_2       0x02
 100 #define AUTO_RP_PIM_VERSION_DUAL    0x03
 101 static const value_string auto_rp_pim_ver_vals[] = {
 102         {AUTO_RP_PIM_VERSION_UNKNOWN, "Version unknown"},
 103         {AUTO_RP_PIM_VERSION_1,       "Version 1"},
 104         {AUTO_RP_PIM_VERSION_2,       "Version 2"},
 105         {AUTO_RP_PIM_VERSION_DUAL,    "Dual version 1 and 2"},
 106         {0,                           NULL}
 107 };
 108
 109 #define AUTO_RP_GROUP_MASK_SIGN_POS 0
 110 #define AUTO_RP_GROUP_MASK_SIGN_NEG 1
 111 static const value_string auto_rp_mask_sign_vals[] = {
 112         {AUTO_RP_GROUP_MASK_SIGN_POS,  "Positive group prefix"},
 113         {AUTO_RP_GROUP_MASK_SIGN_NEG,  "Negative group prefix"},
 114         {0,                            NULL}
 115 };
 116
 117 static int do_auto_rp_map(const u_char *pd, int offset, frame_data *fd, proto_tree *auto_rp_tree);
 118
 119 void dissect_auto_rp(const u_char *pd, int offset, frame_data *fd, proto_tree *tree)
 120 {
 121         struct auto_rp_fixed_hdr arh;
 122         gboolean short_hdr = FALSE;
 123
 124         if (sizeof(struct auto_rp_fixed_hdr) > END_OF_FRAME)
 125                 short_hdr = TRUE;
 126         else
 127                 memcpy(&arh, pd + offset, sizeof(struct auto_rp_fixed_hdr));
 128
 129         if (check_col(fd, COL_PROTOCOL))
 130                 col_add_str(fd, COL_PROTOCOL, "Auto-RP");
 131
 132         if (check_col(fd, COL_INFO)) {
 133                 if (short_hdr)
 134                         col_add_fstr(fd, COL_INFO, "Short packet header, length %u", END_OF_FRAME);
 135                 else
 136                         col_add_fstr(fd, COL_INFO, "%s (v%s) for %u RP%s",
 137                                      val_to_str(lo_nibble(arh.ver_type), auto_rp_type_vals, "Unknown"),
 138                                      val_to_str(hi_nibble(arh.ver_type), auto_rp_ver_vals, "Unknown"),
 139                                      arh.rp_count, plurality(arh.rp_count, "", "s"));
 140         }
 141
 142         if (tree) {
 143                 proto_item *ti, *tv;
 144                 proto_tree *auto_rp_tree, *ver_type_tree;
 145                 int i;
 146
 147                 if (short_hdr) {
 148                         dissect_data(pd, offset, fd, tree);
 149                         return;
 150                 }
 151
 152                 ti = proto_tree_add_item(tree, proto_auto_rp, offset, END_OF_FRAME, NULL);
 153                 auto_rp_tree = proto_item_add_subtree(ti, ett_auto_rp);
 154
 155                 tv = proto_tree_add_item_format(auto_rp_tree, hf_auto_rp_ver_type, offset, 1,
 156                                                 arh.ver_type, "Version: %s, Packet type: %s",
 157                                                 val_to_str(hi_nibble(arh.ver_type), auto_rp_ver_vals, "Unknown"),
 158                                                 val_to_str(lo_nibble(arh.ver_type), auto_rp_type_vals, "Unknown"));
 159                 ver_type_tree = proto_item_add_subtree(tv, ett_auto_rp_ver_type);
 160                 proto_tree_add_item(ver_type_tree, hf_auto_rp_version, offset, 1, arh.ver_type);
 161                 proto_tree_add_item(ver_type_tree, hf_auto_rp_type, offset, 1, arh.ver_type);
 162                 offset++;
 163
 164                 proto_tree_add_text(auto_rp_tree, offset++, 1, "RP Count: %u", arh.rp_count);
 165                 proto_tree_add_text(auto_rp_tree, offset, 2, "Holdtime: %u second%s",
 166                                     ntohs(arh.holdtime),
 167                                     plurality(ntohs(arh.holdtime), "", "s"));
 168                 offset+=2;
 169                 proto_tree_add_text(auto_rp_tree, offset, 4, "Reserved: 0x%x", arh.reserved);
 170                 offset+=4;
 171
 172                 for (i = 0; i < arh.rp_count; i++) {
 173                         int ret;
 174                         if (sizeof(struct auto_rp_map_hdr) > END_OF_FRAME)
 175                                 break;
 176                         ret = do_auto_rp_map(pd, offset, fd, auto_rp_tree);
 177                         if (ret < 0)
 178                                 break;
 179                         offset += ret;
 180                 }
 181
 182                 if (END_OF_FRAME > 0)
 183                         dissect_data(pd, offset, fd, tree);
 184         }
 185
 186         return;
 187 }
 188
 189 void proto_register_auto_rp(void)
 190 {
 191         static hf_register_info hf[] = {
 192                 { &hf_auto_rp_ver_type,
 193                   {"Auto-RP message version and type", "auto_rp.typever",
 194                    FT_UINT8, BASE_DEC, NULL, 0x0,
 195                    "Auto-RP version and type"}},
 196
 197                 { &hf_auto_rp_version,
 198                   {"Auto-RP protocol version", "auto_rp.version",
 199                    FT_UINT8, BASE_DEC, VALS(auto_rp_ver_vals), AUTO_RP_VERSION_MASK,
 200                    "Auto-RP version"}},
 201
 202                 { &hf_auto_rp_type,
 203                   {"Auto-RP packet type", "auto_rp.type",
 204                    FT_UINT8, BASE_DEC, VALS(auto_rp_type_vals), AUTO_RP_TYPE_MASK,
 205                    "Auto-RP type"}},
 206
 207                 { &hf_auto_rp_map,
 208                   {"Auto-RP address map", "auto_rp.map",
 209                    FT_UINT8, BASE_DEC, NULL, 0x0,
 210                    "Auto-RP mapping"}},
 211
 212                 { &hf_auto_rp_pim_ver,
 213                   {"RP's highest PIM version", "auto_rp.pim_ver",
 214                    FT_UINT8, BASE_DEC, VALS(auto_rp_pim_ver_vals), AUTO_RP_PIM_VER_MASK,
 215                    "Auto-RP PIM version"}},
 216
 217                 { &hf_auto_rp_group,
 218                   {"Group mapping to this RP", "auto_rp.grp",
 219                    FT_UINT8, BASE_DEC, NULL, 0x0,
 220                    "RP's group"}},
 221
 222                 { &hf_auto_rp_mask_sgn,
 223                   {"Group prefix sign", "auto_rp.mask_sgn",
 224                    FT_UINT8, BASE_DEC, VALS(auto_rp_mask_sign_vals), AUTO_RP_SIGN_MASK,
 225                    "Prefix sign"}}
 226         };
 227
 228         static gint *ett[] = {
 229                 &ett_auto_rp,
 230                 &ett_auto_rp_ver_type,
 231                 &ett_auto_rp_map,
 232                 &ett_auto_rp_group
 233         };
 234
 235         proto_auto_rp = proto_register_protocol("Cisco Auto-RP", "auto_rp");
 236         proto_register_field_array(proto_auto_rp, hf, array_length(hf));
 237         proto_register_subtree_array(ett, array_length(ett));
 238
 239         return;
 240 }
 241
 242 /*
 243  * Handles one Auto-RP map entry. Returns the number of bytes in the map entry or < 0 for error.
 244  */
 245 static int do_auto_rp_map(const u_char *pd, int offset, frame_data *fd, proto_tree *auto_rp_tree)
 246 {
 247         struct auto_rp_map_hdr m;
 248         proto_item *ti;
 249         proto_tree *map_tree;
 250         struct auto_rp_enc_grp_hdr g;
 251         int i;
 252
 253         if (sizeof(struct auto_rp_map_hdr) > END_OF_FRAME)
 254                 return -1;
 255         memcpy(&m, pd+offset, sizeof(struct auto_rp_map_hdr));
 256
 257         ti = proto_tree_add_item_format(auto_rp_tree, hf_auto_rp_map, offset,
 258                                         MIN(sizeof(m) + m.group_count*sizeof(g), END_OF_FRAME), 1,
 259                                         "RP %s: %u group%s", ip_to_str((void *)&m.rp_address),
 260                                         m.group_count, plurality(m.group_count, "", "s"));
 261         map_tree = proto_item_add_subtree(ti, ett_auto_rp_map);
 262         proto_tree_add_text(map_tree, offset, 4, "Unicast IP address of this RP: %s (%s)",
 263                             ip_to_str((void *)&m.rp_address), get_hostname(m.rp_address));
 264         offset +=4;
 265         proto_tree_add_item(map_tree, hf_auto_rp_pim_ver, offset, 1, pd[offset]);
 266         offset++;
 267         proto_tree_add_text(map_tree, offset, 1, "Number of groups this RP maps to: %u", m.group_count);
 268         offset++;
 269
 270         for (i = 0; i < m.group_count; i++) {
 271                 proto_item *gi;
 272                 proto_tree *grp_tree;
 273                 if (2*sizeof(guint8) + sizeof(guint32) > END_OF_FRAME) /* struct auto_rp_enc_grp_hdr */
 274                         return -1;
 275
 276                 gi = proto_tree_add_item_format(map_tree, hf_auto_rp_group, offset, 6, 1,
 277                                                 "group %s/%u (%s)", ip_to_str(pd + offset + 2),
 278                                                 pd[offset + 1],
 279                                                 val_to_str(pd[offset]&AUTO_RP_SIGN_MASK, auto_rp_mask_sign_vals, ""));
 280                 grp_tree = proto_item_add_subtree(gi, ett_auto_rp_group);
 281
 282                 proto_tree_add_item(grp_tree, hf_auto_rp_mask_sgn, offset, 1, pd[offset]);
 283                 offset++;
 284                 proto_tree_add_text(grp_tree, offset, 1, "Group mask length: %u", pd[offset]);
 285                 offset++;
 286                 proto_tree_add_text(grp_tree, offset, 4, "Group prefix: %s", ip_to_str(pd + offset));
 287                 offset +=4;
 288
 289         }
 290
 291         return offset;
 292 }
 293