2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that: (1) source code
4 * distributions retain the above copyright notice and this paragraph
5 * in its entirety, and (2) distributions including binary code include
6 * the above copyright notice and this paragraph in its entirety in
7 * the documentation or other materials provided with the distribution.
8 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
9 * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
10 * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
11 * FOR A PARTICULAR PURPOSE.
13 * Original code by Andy Heffernan (ahh@juniper.net)
16 /* \summary: Pragmatic General Multicast (PGM) printer */
22 #include <netdissect-stdinc.h>
24 #include "netdissect.h"
26 #include "addrtoname.h"
27 #include "addrtostr.h"
35 * PGM header (RFC 3208)
49 uint32_t pgms_trailseq;
50 uint32_t pgms_leadseq;
51 uint16_t pgms_nla_afi;
52 uint16_t pgms_reserved;
53 /* ... uint8_t pgms_nla[0]; */
59 uint16_t pgmn_source_afi;
60 uint16_t pgmn_reserved;
61 /* ... uint8_t pgmn_source[0]; */
62 /* ... uint16_t pgmn_group_afi */
63 /* ... uint16_t pgmn_reserved2; */
64 /* ... uint8_t pgmn_group[0]; */
69 uint32_t pgma_rx_max_seq;
77 uint16_t pgmp_reserved;
84 uint16_t pgmp_subtype;
85 uint16_t pgmp_nla_afi;
86 uint16_t pgmp_reserved;
87 /* ... uint8_t pgmp_nla[0]; */
93 uint32_t pgmd_trailseq;
97 typedef enum _pgm_type {
98 PGM_SPM = 0, /* source path message */
99 PGM_POLL = 1, /* POLL Request */
100 PGM_POLR = 2, /* POLL Response */
101 PGM_ODATA = 4, /* original data */
102 PGM_RDATA = 5, /* repair data */
103 PGM_NAK = 8, /* NAK */
104 PGM_NULLNAK = 9, /* Null NAK */
105 PGM_NCF = 10, /* NAK Confirmation */
106 PGM_ACK = 11, /* ACK for congestion control */
107 PGM_SPMR = 12, /* SPM request */
111 #define PGM_OPT_BIT_PRESENT 0x01
112 #define PGM_OPT_BIT_NETWORK 0x02
113 #define PGM_OPT_BIT_VAR_PKTLEN 0x40
114 #define PGM_OPT_BIT_PARITY 0x80
116 #define PGM_OPT_LENGTH 0x00
117 #define PGM_OPT_FRAGMENT 0x01
118 #define PGM_OPT_NAK_LIST 0x02
119 #define PGM_OPT_JOIN 0x03
120 #define PGM_OPT_NAK_BO_IVL 0x04
121 #define PGM_OPT_NAK_BO_RNG 0x05
123 #define PGM_OPT_REDIRECT 0x07
124 #define PGM_OPT_PARITY_PRM 0x08
125 #define PGM_OPT_PARITY_GRP 0x09
126 #define PGM_OPT_CURR_TGSIZE 0x0A
127 #define PGM_OPT_NBR_UNREACH 0x0B
128 #define PGM_OPT_PATH_NLA 0x0C
130 #define PGM_OPT_SYN 0x0D
131 #define PGM_OPT_FIN 0x0E
132 #define PGM_OPT_RST 0x0F
133 #define PGM_OPT_CR 0x10
134 #define PGM_OPT_CRQST 0x11
136 #define PGM_OPT_PGMCC_DATA 0x12
137 #define PGM_OPT_PGMCC_FEEDBACK 0x13
139 #define PGM_OPT_MASK 0x7f
141 #define PGM_OPT_END 0x80 /* end of options marker */
143 #define PGM_MIN_OPT_LEN 4
146 pgm_print(netdissect_options *ndo,
147 register const u_char *bp, register u_int length,
148 register const u_char *bp2)
150 register const struct pgm_header *pgm;
151 register const struct ip *ip;
153 uint16_t sport, dport;
155 char nla_buf[INET6_ADDRSTRLEN];
156 register const struct ip6_hdr *ip6;
157 uint8_t opt_type, opt_len;
158 uint32_t seq, opts_len, len, offset;
160 pgm = (const struct pgm_header *)bp;
161 ip = (const struct ip *)bp2;
163 ip6 = (const struct ip6_hdr *)bp2;
167 if (!ND_TTEST(pgm->pgm_dport)) {
169 ND_PRINT((ndo, "%s > %s: [|pgm]",
170 ip6addr_string(ndo, &ip6->ip6_src),
171 ip6addr_string(ndo, &ip6->ip6_dst)));
174 ND_PRINT((ndo, "%s > %s: [|pgm]",
175 ipaddr_string(ndo, &ip->ip_src),
176 ipaddr_string(ndo, &ip->ip_dst)));
181 sport = EXTRACT_16BITS(&pgm->pgm_sport);
182 dport = EXTRACT_16BITS(&pgm->pgm_dport);
185 if (ip6->ip6_nxt == IPPROTO_PGM) {
186 ND_PRINT((ndo, "%s.%s > %s.%s: ",
187 ip6addr_string(ndo, &ip6->ip6_src),
188 tcpport_string(ndo, sport),
189 ip6addr_string(ndo, &ip6->ip6_dst),
190 tcpport_string(ndo, dport)));
192 ND_PRINT((ndo, "%s > %s: ",
193 tcpport_string(ndo, sport), tcpport_string(ndo, dport)));
196 if (ip->ip_p == IPPROTO_PGM) {
197 ND_PRINT((ndo, "%s.%s > %s.%s: ",
198 ipaddr_string(ndo, &ip->ip_src),
199 tcpport_string(ndo, sport),
200 ipaddr_string(ndo, &ip->ip_dst),
201 tcpport_string(ndo, dport)));
203 ND_PRINT((ndo, "%s > %s: ",
204 tcpport_string(ndo, sport), tcpport_string(ndo, dport)));
210 ND_PRINT((ndo, "PGM, length %u", EXTRACT_16BITS(&pgm->pgm_length)));
215 ND_PRINT((ndo, " 0x%02x%02x%02x%02x%02x%02x ",
222 switch (pgm->pgm_type) {
224 const struct pgm_spm *spm;
226 spm = (const struct pgm_spm *)(pgm + 1);
228 bp = (const u_char *) (spm + 1);
230 switch (EXTRACT_16BITS(&spm->pgms_nla_afi)) {
232 ND_TCHECK2(*bp, sizeof(struct in_addr));
233 addrtostr(bp, nla_buf, sizeof(nla_buf));
234 bp += sizeof(struct in_addr);
237 ND_TCHECK2(*bp, sizeof(struct in6_addr));
238 addrtostr6(bp, nla_buf, sizeof(nla_buf));
239 bp += sizeof(struct in6_addr);
246 ND_PRINT((ndo, "SPM seq %u trail %u lead %u nla %s",
247 EXTRACT_32BITS(&spm->pgms_seq),
248 EXTRACT_32BITS(&spm->pgms_trailseq),
249 EXTRACT_32BITS(&spm->pgms_leadseq),
255 const struct pgm_poll *poll_msg;
257 poll_msg = (const struct pgm_poll *)(pgm + 1);
258 ND_TCHECK(*poll_msg);
259 ND_PRINT((ndo, "POLL seq %u round %u",
260 EXTRACT_32BITS(&poll_msg->pgmp_seq),
261 EXTRACT_16BITS(&poll_msg->pgmp_round)));
262 bp = (const u_char *) (poll_msg + 1);
266 const struct pgm_polr *polr;
267 uint32_t ivl, rnd, mask;
269 polr = (const struct pgm_polr *)(pgm + 1);
271 bp = (const u_char *) (polr + 1);
273 switch (EXTRACT_16BITS(&polr->pgmp_nla_afi)) {
275 ND_TCHECK2(*bp, sizeof(struct in_addr));
276 addrtostr(bp, nla_buf, sizeof(nla_buf));
277 bp += sizeof(struct in_addr);
280 ND_TCHECK2(*bp, sizeof(struct in6_addr));
281 addrtostr6(bp, nla_buf, sizeof(nla_buf));
282 bp += sizeof(struct in6_addr);
289 ND_TCHECK2(*bp, sizeof(uint32_t));
290 ivl = EXTRACT_32BITS(bp);
291 bp += sizeof(uint32_t);
293 ND_TCHECK2(*bp, sizeof(uint32_t));
294 rnd = EXTRACT_32BITS(bp);
295 bp += sizeof(uint32_t);
297 ND_TCHECK2(*bp, sizeof(uint32_t));
298 mask = EXTRACT_32BITS(bp);
299 bp += sizeof(uint32_t);
301 ND_PRINT((ndo, "POLR seq %u round %u nla %s ivl %u rnd 0x%08x "
302 "mask 0x%08x", EXTRACT_32BITS(&polr->pgmp_seq),
303 EXTRACT_16BITS(&polr->pgmp_round), nla_buf, ivl, rnd, mask));
307 const struct pgm_data *odata;
309 odata = (const struct pgm_data *)(pgm + 1);
311 ND_PRINT((ndo, "ODATA trail %u seq %u",
312 EXTRACT_32BITS(&odata->pgmd_trailseq),
313 EXTRACT_32BITS(&odata->pgmd_seq)));
314 bp = (const u_char *) (odata + 1);
319 const struct pgm_data *rdata;
321 rdata = (const struct pgm_data *)(pgm + 1);
323 ND_PRINT((ndo, "RDATA trail %u seq %u",
324 EXTRACT_32BITS(&rdata->pgmd_trailseq),
325 EXTRACT_32BITS(&rdata->pgmd_seq)));
326 bp = (const u_char *) (rdata + 1);
333 const struct pgm_nak *nak;
334 char source_buf[INET6_ADDRSTRLEN], group_buf[INET6_ADDRSTRLEN];
336 nak = (const struct pgm_nak *)(pgm + 1);
338 bp = (const u_char *) (nak + 1);
341 * Skip past the source, saving info along the way
342 * and stopping if we don't have enough.
344 switch (EXTRACT_16BITS(&nak->pgmn_source_afi)) {
346 ND_TCHECK2(*bp, sizeof(struct in_addr));
347 addrtostr(bp, source_buf, sizeof(source_buf));
348 bp += sizeof(struct in_addr);
351 ND_TCHECK2(*bp, sizeof(struct in6_addr));
352 addrtostr6(bp, source_buf, sizeof(source_buf));
353 bp += sizeof(struct in6_addr);
361 * Skip past the group, saving info along the way
362 * and stopping if we don't have enough.
364 bp += (2 * sizeof(uint16_t));
365 switch (EXTRACT_16BITS(bp)) {
367 ND_TCHECK2(*bp, sizeof(struct in_addr));
368 addrtostr(bp, group_buf, sizeof(group_buf));
369 bp += sizeof(struct in_addr);
372 ND_TCHECK2(*bp, sizeof(struct in6_addr));
373 addrtostr6(bp, group_buf, sizeof(group_buf));
374 bp += sizeof(struct in6_addr);
382 * Options decoding can go here.
384 switch (pgm->pgm_type) {
386 ND_PRINT((ndo, "NAK "));
389 ND_PRINT((ndo, "NNAK "));
392 ND_PRINT((ndo, "NCF "));
397 ND_PRINT((ndo, "(%s -> %s), seq %u",
398 source_buf, group_buf, EXTRACT_32BITS(&nak->pgmn_seq)));
403 const struct pgm_ack *ack;
405 ack = (const struct pgm_ack *)(pgm + 1);
407 ND_PRINT((ndo, "ACK seq %u",
408 EXTRACT_32BITS(&ack->pgma_rx_max_seq)));
409 bp = (const u_char *) (ack + 1);
414 ND_PRINT((ndo, "SPMR"));
418 ND_PRINT((ndo, "UNKNOWN type 0x%02x", pgm->pgm_type));
422 if (pgm->pgm_options & PGM_OPT_BIT_PRESENT) {
425 * make sure there's enough for the first option header
427 if (!ND_TTEST2(*bp, PGM_MIN_OPT_LEN)) {
428 ND_PRINT((ndo, "[|OPT]"));
433 * That option header MUST be an OPT_LENGTH option
434 * (see the first paragraph of section 9.1 in RFC 3208).
437 if ((opt_type & PGM_OPT_MASK) != PGM_OPT_LENGTH) {
438 ND_PRINT((ndo, "[First option bad, should be PGM_OPT_LENGTH, is %u]", opt_type & PGM_OPT_MASK));
443 ND_PRINT((ndo, "[Bad OPT_LENGTH option, length %u != 4]", opt_len));
446 opts_len = EXTRACT_16BITS(bp);
448 ND_PRINT((ndo, "[Bad total option length %u < 4]", opts_len));
451 bp += sizeof(uint16_t);
452 ND_PRINT((ndo, " OPTS LEN %d", opts_len));
456 if (opts_len < PGM_MIN_OPT_LEN) {
457 ND_PRINT((ndo, "[Total option length leaves no room for final option]"));
462 if (opt_len < PGM_MIN_OPT_LEN) {
463 ND_PRINT((ndo, "[Bad option, length %u < %u]", opt_len,
467 if (opts_len < opt_len) {
468 ND_PRINT((ndo, "[Total option length leaves no room for final option]"));
471 if (!ND_TTEST2(*bp, opt_len - 2)) {
472 ND_PRINT((ndo, " [|OPT]"));
476 switch (opt_type & PGM_OPT_MASK) {
479 ND_PRINT((ndo, "[Bad OPT_LENGTH option, length %u != 4]", opt_len));
482 ND_PRINT((ndo, " OPTS LEN (extra?) %d", EXTRACT_16BITS(bp)));
483 bp += sizeof(uint16_t);
487 case PGM_OPT_FRAGMENT:
489 ND_PRINT((ndo, "[Bad OPT_FRAGMENT option, length %u != 16]", opt_len));
493 seq = EXTRACT_32BITS(bp);
494 bp += sizeof(uint32_t);
495 offset = EXTRACT_32BITS(bp);
496 bp += sizeof(uint32_t);
497 len = EXTRACT_32BITS(bp);
498 bp += sizeof(uint32_t);
499 ND_PRINT((ndo, " FRAG seq %u off %u len %u", seq, offset, len));
503 case PGM_OPT_NAK_LIST:
505 opt_len -= sizeof(uint32_t); /* option header */
506 ND_PRINT((ndo, " NAK LIST"));
508 if (opt_len < sizeof(uint32_t)) {
509 ND_PRINT((ndo, "[Option length not a multiple of 4]"));
512 ND_TCHECK2(*bp, sizeof(uint32_t));
513 ND_PRINT((ndo, " %u", EXTRACT_32BITS(bp)));
514 bp += sizeof(uint32_t);
515 opt_len -= sizeof(uint32_t);
516 opts_len -= sizeof(uint32_t);
522 ND_PRINT((ndo, "[Bad OPT_JOIN option, length %u != 8]", opt_len));
526 seq = EXTRACT_32BITS(bp);
527 bp += sizeof(uint32_t);
528 ND_PRINT((ndo, " JOIN %u", seq));
532 case PGM_OPT_NAK_BO_IVL:
534 ND_PRINT((ndo, "[Bad OPT_NAK_BO_IVL option, length %u != 12]", opt_len));
538 offset = EXTRACT_32BITS(bp);
539 bp += sizeof(uint32_t);
540 seq = EXTRACT_32BITS(bp);
541 bp += sizeof(uint32_t);
542 ND_PRINT((ndo, " BACKOFF ivl %u ivlseq %u", offset, seq));
546 case PGM_OPT_NAK_BO_RNG:
548 ND_PRINT((ndo, "[Bad OPT_NAK_BO_RNG option, length %u != 12]", opt_len));
552 offset = EXTRACT_32BITS(bp);
553 bp += sizeof(uint32_t);
554 seq = EXTRACT_32BITS(bp);
555 bp += sizeof(uint32_t);
556 ND_PRINT((ndo, " BACKOFF max %u min %u", offset, seq));
560 case PGM_OPT_REDIRECT:
562 nla_afnum = EXTRACT_16BITS(bp);
563 bp += (2 * sizeof(uint16_t));
566 if (opt_len != 4 + sizeof(struct in_addr)) {
567 ND_PRINT((ndo, "[Bad OPT_REDIRECT option, length %u != 4 + address size]", opt_len));
570 ND_TCHECK2(*bp, sizeof(struct in_addr));
571 addrtostr(bp, nla_buf, sizeof(nla_buf));
572 bp += sizeof(struct in_addr);
573 opts_len -= 4 + sizeof(struct in_addr);
576 if (opt_len != 4 + sizeof(struct in6_addr)) {
577 ND_PRINT((ndo, "[Bad OPT_REDIRECT option, length %u != 4 + address size]", opt_len));
580 ND_TCHECK2(*bp, sizeof(struct in6_addr));
581 addrtostr6(bp, nla_buf, sizeof(nla_buf));
582 bp += sizeof(struct in6_addr);
583 opts_len -= 4 + sizeof(struct in6_addr);
590 ND_PRINT((ndo, " REDIRECT %s", nla_buf));
593 case PGM_OPT_PARITY_PRM:
595 ND_PRINT((ndo, "[Bad OPT_PARITY_PRM option, length %u != 8]", opt_len));
599 len = EXTRACT_32BITS(bp);
600 bp += sizeof(uint32_t);
601 ND_PRINT((ndo, " PARITY MAXTGS %u", len));
605 case PGM_OPT_PARITY_GRP:
607 ND_PRINT((ndo, "[Bad OPT_PARITY_GRP option, length %u != 8]", opt_len));
611 seq = EXTRACT_32BITS(bp);
612 bp += sizeof(uint32_t);
613 ND_PRINT((ndo, " PARITY GROUP %u", seq));
617 case PGM_OPT_CURR_TGSIZE:
619 ND_PRINT((ndo, "[Bad OPT_CURR_TGSIZE option, length %u != 8]", opt_len));
623 len = EXTRACT_32BITS(bp);
624 bp += sizeof(uint32_t);
625 ND_PRINT((ndo, " PARITY ATGS %u", len));
629 case PGM_OPT_NBR_UNREACH:
631 ND_PRINT((ndo, "[Bad OPT_NBR_UNREACH option, length %u != 4]", opt_len));
635 ND_PRINT((ndo, " NBR_UNREACH"));
639 case PGM_OPT_PATH_NLA:
640 ND_PRINT((ndo, " PATH_NLA [%d]", opt_len));
647 ND_PRINT((ndo, "[Bad OPT_SYN option, length %u != 4]", opt_len));
651 ND_PRINT((ndo, " SYN"));
657 ND_PRINT((ndo, "[Bad OPT_FIN option, length %u != 4]", opt_len));
661 ND_PRINT((ndo, " FIN"));
667 ND_PRINT((ndo, "[Bad OPT_RST option, length %u != 4]", opt_len));
671 ND_PRINT((ndo, " RST"));
676 ND_PRINT((ndo, " CR"));
683 ND_PRINT((ndo, "[Bad OPT_CRQST option, length %u != 4]", opt_len));
687 ND_PRINT((ndo, " CRQST"));
691 case PGM_OPT_PGMCC_DATA:
693 offset = EXTRACT_32BITS(bp);
694 bp += sizeof(uint32_t);
695 nla_afnum = EXTRACT_16BITS(bp);
696 bp += (2 * sizeof(uint16_t));
699 if (opt_len != 12 + sizeof(struct in_addr)) {
700 ND_PRINT((ndo, "[Bad OPT_PGMCC_DATA option, length %u != 12 + address size]", opt_len));
703 ND_TCHECK2(*bp, sizeof(struct in_addr));
704 addrtostr(bp, nla_buf, sizeof(nla_buf));
705 bp += sizeof(struct in_addr);
706 opts_len -= 12 + sizeof(struct in_addr);
709 if (opt_len != 12 + sizeof(struct in6_addr)) {
710 ND_PRINT((ndo, "[Bad OPT_PGMCC_DATA option, length %u != 12 + address size]", opt_len));
713 ND_TCHECK2(*bp, sizeof(struct in6_addr));
714 addrtostr6(bp, nla_buf, sizeof(nla_buf));
715 bp += sizeof(struct in6_addr);
716 opts_len -= 12 + sizeof(struct in6_addr);
723 ND_PRINT((ndo, " PGMCC DATA %u %s", offset, nla_buf));
726 case PGM_OPT_PGMCC_FEEDBACK:
728 offset = EXTRACT_32BITS(bp);
729 bp += sizeof(uint32_t);
730 nla_afnum = EXTRACT_16BITS(bp);
731 bp += (2 * sizeof(uint16_t));
734 if (opt_len != 12 + sizeof(struct in_addr)) {
735 ND_PRINT((ndo, "[Bad OPT_PGMCC_DATA option, length %u != 12 + address size]", opt_len));
738 ND_TCHECK2(*bp, sizeof(struct in_addr));
739 addrtostr(bp, nla_buf, sizeof(nla_buf));
740 bp += sizeof(struct in_addr);
741 opts_len -= 12 + sizeof(struct in_addr);
744 if (opt_len != 12 + sizeof(struct in6_addr)) {
745 ND_PRINT((ndo, "[Bad OPT_PGMCC_DATA option, length %u != 12 + address size]", opt_len));
748 ND_TCHECK2(*bp, sizeof(struct in6_addr));
749 addrtostr6(bp, nla_buf, sizeof(nla_buf));
750 bp += sizeof(struct in6_addr);
751 opts_len -= 12 + sizeof(struct in6_addr);
758 ND_PRINT((ndo, " PGMCC FEEDBACK %u %s", offset, nla_buf));
762 ND_PRINT((ndo, " OPT_%02X [%d] ", opt_type, opt_len));
768 if (opt_type & PGM_OPT_END)
773 ND_PRINT((ndo, " [%u]", length));
774 if (ndo->ndo_packettype == PT_PGM_ZMTP1 &&
775 (pgm->pgm_type == PGM_ODATA || pgm->pgm_type == PGM_RDATA))
776 zmtp1_print_datagram(ndo, bp, EXTRACT_16BITS(&pgm->pgm_length));
781 ND_PRINT((ndo, "[|pgm]"));
783 ND_PRINT((ndo, ">"));