2 * Copyright (c) 2016 Antonin Décimo, Jean-Raphaël Gaglione
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the project nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 /* \summary: Home Networking Control Protocol (HNCP) printer */
35 #include "netdissect-stdinc.h"
39 #include "netdissect.h"
40 #include "addrtoname.h"
44 hncp_print_rec(netdissect_options *ndo,
45 const u_char *cp, u_int length, int indent);
48 hncp_print(netdissect_options *ndo,
49 const u_char *cp, u_int length)
51 ndo->ndo_protocol = "hncp";
52 ND_PRINT("hncp (%u)", length);
53 hncp_print_rec(ndo, cp, length, 1);
57 #define DNCP_REQUEST_NETWORK_STATE 1
58 #define DNCP_REQUEST_NODE_STATE 2
59 #define DNCP_NODE_ENDPOINT 3
60 #define DNCP_NETWORK_STATE 4
61 #define DNCP_NODE_STATE 5
63 #define DNCP_KEEP_ALIVE_INTERVAL 9
64 #define DNCP_TRUST_VERDICT 10
67 #define HNCP_HNCP_VERSION 32
68 #define HNCP_EXTERNAL_CONNECTION 33
69 #define HNCP_DELEGATED_PREFIX 34
70 #define HNCP_PREFIX_POLICY 43
71 #define HNCP_DHCPV4_DATA 37 /* This is correct, see RFC 7788 Errata ID 5113. */
72 #define HNCP_DHCPV6_DATA 38 /* idem */
73 #define HNCP_ASSIGNED_PREFIX 35
74 #define HNCP_NODE_ADDRESS 36
75 #define HNCP_DNS_DELEGATED_ZONE 39
76 #define HNCP_DOMAIN_NAME 40
77 #define HNCP_NODE_NAME 41
78 #define HNCP_MANAGED_PSK 42
80 /* See type_mask in hncp_print_rec below */
81 #define RANGE_DNCP_RESERVED 0x10000
82 #define RANGE_HNCP_UNASSIGNED 0x10001
83 #define RANGE_DNCP_PRIVATE_USE 0x10002
84 #define RANGE_DNCP_FUTURE_USE 0x10003
86 static const struct tok type_values[] = {
87 { DNCP_REQUEST_NETWORK_STATE, "Request network state" },
88 { DNCP_REQUEST_NODE_STATE, "Request node state" },
89 { DNCP_NODE_ENDPOINT, "Node endpoint" },
90 { DNCP_NETWORK_STATE, "Network state" },
91 { DNCP_NODE_STATE, "Node state" },
92 { DNCP_PEER, "Peer" },
93 { DNCP_KEEP_ALIVE_INTERVAL, "Keep-alive interval" },
94 { DNCP_TRUST_VERDICT, "Trust-Verdict" },
96 { HNCP_HNCP_VERSION, "HNCP-Version" },
97 { HNCP_EXTERNAL_CONNECTION, "External-Connection" },
98 { HNCP_DELEGATED_PREFIX, "Delegated-Prefix" },
99 { HNCP_PREFIX_POLICY, "Prefix-Policy" },
100 { HNCP_DHCPV4_DATA, "DHCPv4-Data" },
101 { HNCP_DHCPV6_DATA, "DHCPv6-Data" },
102 { HNCP_ASSIGNED_PREFIX, "Assigned-Prefix" },
103 { HNCP_NODE_ADDRESS, "Node-Address" },
104 { HNCP_DNS_DELEGATED_ZONE, "DNS-Delegated-Zone" },
105 { HNCP_DOMAIN_NAME, "Domain-Name" },
106 { HNCP_NODE_NAME, "Node-Name" },
107 { HNCP_MANAGED_PSK, "Managed-PSK" },
109 { RANGE_DNCP_RESERVED, "Reserved" },
110 { RANGE_HNCP_UNASSIGNED, "Unassigned" },
111 { RANGE_DNCP_PRIVATE_USE, "Private use" },
112 { RANGE_DNCP_FUTURE_USE, "Future use" },
117 #define DH4OPT_DNS_SERVERS 6 /* RFC2132 */
118 #define DH4OPT_NTP_SERVERS 42 /* RFC2132 */
119 #define DH4OPT_DOMAIN_SEARCH 119 /* RFC3397 */
121 static const struct tok dh4opt_str[] = {
122 { DH4OPT_DNS_SERVERS, "DNS-server" },
123 { DH4OPT_NTP_SERVERS, "NTP-server"},
124 { DH4OPT_DOMAIN_SEARCH, "DNS-search" },
128 #define DH6OPT_DNS_SERVERS 23 /* RFC3646 */
129 #define DH6OPT_DOMAIN_LIST 24 /* RFC3646 */
130 #define DH6OPT_SNTP_SERVERS 31 /* RFC4075 */
132 static const struct tok dh6opt_str[] = {
133 { DH6OPT_DNS_SERVERS, "DNS-server" },
134 { DH6OPT_DOMAIN_LIST, "DNS-search-list" },
135 { DH6OPT_SNTP_SERVERS, "SNTP-servers" },
140 * For IPv4-mapped IPv6 addresses, length of the prefix that precedes
141 * the 4 bytes of IPv4 address at the end of the IPv6 address.
143 #define IPV4_MAPPED_HEADING_LEN 12
146 * Is an IPv6 address an IPv4-mapped address?
149 is_ipv4_mapped_address(const u_char *addr)
151 /* The value of the prefix */
152 static const u_char ipv4_mapped_heading[IPV4_MAPPED_HEADING_LEN] =
153 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0xFF, 0xFF };
155 return memcmp(addr, ipv4_mapped_heading, IPV4_MAPPED_HEADING_LEN) == 0;
159 format_nid(netdissect_options *ndo, const u_char *data)
161 static char buf[4][sizeof("01:01:01:01")];
164 snprintf(buf[i], sizeof(buf[i]), "%02x:%02x:%02x:%02x",
165 GET_U_1(data), GET_U_1(data + 1), GET_U_1(data + 2),
171 format_256(netdissect_options *ndo, const u_char *data)
173 static char buf[4][sizeof("0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef")];
176 snprintf(buf[i], sizeof(buf[i]), "%016" PRIx64 "%016" PRIx64 "%016" PRIx64 "%016" PRIx64,
178 GET_BE_U_8(data + 8),
179 GET_BE_U_8(data + 16),
180 GET_BE_U_8(data + 24)
186 format_interval(const uint32_t n)
188 static char buf[4][sizeof("0000000.000s")];
191 snprintf(buf[i], sizeof(buf[i]), "%u.%03us", n / 1000, n % 1000);
196 format_ip6addr(netdissect_options *ndo, const u_char *cp)
198 if (is_ipv4_mapped_address(cp))
199 return GET_IPADDR_STRING(cp + IPV4_MAPPED_HEADING_LEN);
201 return GET_IP6ADDR_STRING(cp);
205 print_prefix(netdissect_options *ndo, const u_char *prefix, u_int max_length)
208 char buf[sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx::/128")];
210 if (GET_U_1(prefix) >= 96 && max_length >= IPV4_MAPPED_HEADING_LEN + 1 &&
211 is_ipv4_mapped_address(prefix + 1)) {
215 plen = GET_U_1(prefix) - 96;
220 memset(&addr, 0, sizeof(addr));
221 plenbytes = (plen + 7) / 8;
222 if (max_length < (u_int)plenbytes + IPV4_MAPPED_HEADING_LEN)
224 memcpy(&addr, prefix + IPV4_MAPPED_HEADING_LEN + 1, plenbytes);
226 ((u_char *)&addr)[plenbytes - 1] &=
227 ((0xff00 >> (plen % 8)) & 0xff);
229 snprintf(buf, sizeof(buf), "%s/%u", ipaddr_string(ndo, (const u_char *)&addr), plen); /* local buffer, not packet data; don't use GET_IPADDR_STRING() */
230 plenbytes += 1 + IPV4_MAPPED_HEADING_LEN;
232 plenbytes = decode_prefix6(ndo, prefix, max_length, buf, sizeof(buf));
242 print_dns_label(netdissect_options *ndo,
243 const u_char *cp, u_int max_length, int print)
246 while (length < max_length) {
247 u_int lab_length = GET_U_1(cp + length);
251 if (length > 1 && print)
253 if (length+lab_length > max_length) {
255 nd_printjnp(ndo, cp+length, max_length-length);
259 nd_printjnp(ndo, cp+length, lab_length);
260 length += lab_length;
268 dhcpv4_print(netdissect_options *ndo,
269 const u_char *cp, u_int length, int indent)
272 const uint8_t *tlv, *value;
273 uint8_t type, optlen;
281 optlen = GET_U_1(tlv + 1);
285 for (t = indent; t > 0; t--)
288 ND_PRINT("%s", tok2str(dh4opt_str, "Unknown", type));
289 ND_PRINT(" (%u)", optlen + 2 );
290 if (i + 2 + optlen > length)
294 case DH4OPT_DNS_SERVERS:
295 case DH4OPT_NTP_SERVERS: {
296 if (optlen < 4 || optlen % 4 != 0) {
299 for (t = 0; t < optlen; t += 4)
300 ND_PRINT(" %s", GET_IPADDR_STRING(value + t));
303 case DH4OPT_DOMAIN_SEARCH: {
304 const u_char *tp = value;
305 while (tp < value + optlen) {
307 if ((tp = fqdn_print(ndo, tp, value + optlen)) == NULL)
320 dhcpv6_print(netdissect_options *ndo,
321 const u_char *cp, u_int length, int indent)
324 const u_char *tlv, *value;
325 uint16_t type, optlen;
332 type = GET_BE_U_2(tlv);
333 optlen = GET_BE_U_2(tlv + 2);
337 for (t = indent; t > 0; t--)
340 ND_PRINT("%s", tok2str(dh6opt_str, "Unknown", type));
341 ND_PRINT(" (%u)", optlen + 4 );
342 if (i + 4 + optlen > length)
346 case DH6OPT_DNS_SERVERS:
347 case DH6OPT_SNTP_SERVERS: {
348 if (optlen % 16 != 0) {
349 nd_print_invalid(ndo);
352 for (t = 0; t < optlen; t += 16)
353 ND_PRINT(" %s", GET_IP6ADDR_STRING(value + t));
356 case DH6OPT_DOMAIN_LIST: {
357 const u_char *tp = value;
358 while (tp < value + optlen) {
360 if ((tp = fqdn_print(ndo, tp, value + optlen)) == NULL)
372 /* Determine in-line mode */
374 is_in_line(netdissect_options *ndo, int indent)
376 return indent - 1 >= ndo->ndo_vflag && ndo->ndo_vflag < 3;
380 print_type_in_line(netdissect_options *ndo,
381 uint32_t type, int count, int indent, int *first_one)
389 for (t = indent; t > 0; t--)
397 ND_PRINT("%s", tok2str(type_values, "Easter Egg", type));
399 ND_PRINT(" (x%d)", count);
404 hncp_print_rec(netdissect_options *ndo,
405 const u_char *cp, u_int length, int indent)
407 const int in_line = is_in_line(ndo, indent);
412 uint32_t last_type_mask = 0xffffffffU;
413 int last_type_count = -1;
415 const uint8_t *tlv, *value;
416 uint16_t type, bodylen;
425 for (t = indent; t > 0; t--)
433 type = GET_BE_U_2(tlv);
434 bodylen = GET_BE_U_2(tlv + 2);
436 ND_TCHECK_LEN(value, bodylen);
437 if (i + bodylen + 4 > length)
441 (type == 0) ? RANGE_DNCP_RESERVED:
442 (44 <= type && type <= 511) ? RANGE_HNCP_UNASSIGNED:
443 (768 <= type && type <= 1023) ? RANGE_DNCP_PRIVATE_USE:
444 RANGE_DNCP_FUTURE_USE;
445 if (type == 6 || type == 7)
446 type_mask = RANGE_DNCP_FUTURE_USE;
452 u_int key = type_values[t++].v;
463 if (last_type_mask == type_mask) {
466 print_type_in_line(ndo, last_type_mask, last_type_count, indent, &first_one);
467 last_type_mask = type_mask;
474 ND_PRINT("%s", tok2str(type_values, "Easter Egg (42)", type_mask) );
475 if (type_mask > 0xffff)
476 ND_PRINT(": type=%u", type );
477 ND_PRINT(" (%u)", bodylen + 4 );
481 case DNCP_REQUEST_NETWORK_STATE: {
483 nd_print_invalid(ndo);
487 case DNCP_REQUEST_NODE_STATE: {
488 const char *node_identifier;
490 nd_print_invalid(ndo);
493 node_identifier = format_nid(ndo, value);
494 ND_PRINT(" NID: %s", node_identifier);
498 case DNCP_NODE_ENDPOINT: {
499 const char *node_identifier;
500 uint32_t endpoint_identifier;
502 nd_print_invalid(ndo);
505 node_identifier = format_nid(ndo, value);
506 endpoint_identifier = GET_BE_U_4(value + 4);
507 ND_PRINT(" NID: %s EPID: %08x",
514 case DNCP_NETWORK_STATE: {
517 nd_print_invalid(ndo);
520 hash = GET_BE_U_8(value);
521 ND_PRINT(" hash: %016" PRIx64, hash);
525 case DNCP_NODE_STATE: {
526 const char *node_identifier, *interval;
527 uint32_t sequence_number;
530 nd_print_invalid(ndo);
533 node_identifier = format_nid(ndo, value);
534 sequence_number = GET_BE_U_4(value + 4);
535 interval = format_interval(GET_BE_U_4(value + 8));
536 hash = GET_BE_U_8(value + 12);
537 ND_PRINT(" NID: %s seqno: %u %s hash: %016" PRIx64,
543 hncp_print_rec(ndo, value+20, bodylen-20, indent+1);
548 const char *peer_node_identifier;
549 uint32_t peer_endpoint_identifier, endpoint_identifier;
551 nd_print_invalid(ndo);
554 peer_node_identifier = format_nid(ndo, value);
555 peer_endpoint_identifier = GET_BE_U_4(value + 4);
556 endpoint_identifier = GET_BE_U_4(value + 8);
557 ND_PRINT(" Peer-NID: %s Peer-EPID: %08x Local-EPID: %08x",
558 peer_node_identifier,
559 peer_endpoint_identifier,
565 case DNCP_KEEP_ALIVE_INTERVAL: {
566 uint32_t endpoint_identifier;
567 const char *interval;
569 nd_print_invalid(ndo);
572 endpoint_identifier = GET_BE_U_4(value);
573 interval = format_interval(GET_BE_U_4(value + 4));
574 ND_PRINT(" EPID: %08x Interval: %s",
581 case DNCP_TRUST_VERDICT: {
583 nd_print_invalid(ndo);
586 ND_PRINT(" Verdict: %u Fingerprint: %s Common Name: ",
588 format_256(ndo, value + 4));
589 nd_printjnp(ndo, value + 36, bodylen - 36);
593 case HNCP_HNCP_VERSION: {
594 uint16_t capabilities;
597 nd_print_invalid(ndo);
600 capabilities = GET_BE_U_2(value + 2);
601 M = (uint8_t)((capabilities >> 12) & 0xf);
602 P = (uint8_t)((capabilities >> 8) & 0xf);
603 H = (uint8_t)((capabilities >> 4) & 0xf);
604 L = (uint8_t)(capabilities & 0xf);
605 ND_PRINT(" M: %u P: %u H: %u L: %u User-agent: ",
608 nd_printjnp(ndo, value + 4, bodylen - 4);
612 case HNCP_EXTERNAL_CONNECTION: {
614 hncp_print_rec(ndo, value, bodylen, indent+1);
618 case HNCP_DELEGATED_PREFIX: {
620 if (bodylen < 9 || bodylen < 9 + (GET_U_1(value + 8) + 7) / 8) {
621 nd_print_invalid(ndo);
624 ND_PRINT(" VLSO: %s PLSO: %s Prefix: ",
625 format_interval(GET_BE_U_4(value)),
626 format_interval(GET_BE_U_4(value + 4))
628 l = print_prefix(ndo, value + 8, bodylen - 8);
630 ND_PRINT("(length is invalid)");
635 * We've already checked that we've captured the
636 * entire TLV, based on its length, so this will
637 * either be -1, meaning "the prefix length is
638 * greater than the longest possible address of
639 * that type" (i.e., > 32 for IPv4 or > 128 for
640 * IPv6", or -3, meaning "the prefix runs past
641 * the end of the TLV".
643 nd_print_invalid(ndo);
649 hncp_print_rec(ndo, value + l, bodylen - l, indent+1);
653 case HNCP_PREFIX_POLICY: {
657 nd_print_invalid(ndo);
660 policy = GET_U_1(value);
664 nd_print_invalid(ndo);
667 ND_PRINT("Internet connectivity");
668 } else if (policy >= 1 && policy <= 128) {
669 ND_PRINT("Dest-Prefix: ");
670 l = print_prefix(ndo, value, bodylen);
672 ND_PRINT("(length is invalid)");
677 * We've already checked that we've captured the
678 * entire TLV, based on its length, so this will
679 * either be -1, meaning "the prefix length is
680 * greater than the longest possible address of
681 * that type" (i.e., > 32 for IPv4 or > 128 for
682 * IPv6", or -3, meaning "the prefix runs past
683 * the end of the TLV".
685 nd_print_invalid(ndo);
688 } else if (policy == 129) {
689 ND_PRINT("DNS domain: ");
690 print_dns_label(ndo, value+1, bodylen-1, 1);
691 } else if (policy == 130) {
692 ND_PRINT("Opaque UTF-8: ");
693 nd_printjnp(ndo, value + 1, bodylen - 1);
694 } else if (policy == 131) {
696 nd_print_invalid(ndo);
699 ND_PRINT("Restrictive assignment");
700 } else if (policy >= 132) {
701 ND_PRINT("Unknown (%u)", policy); /* Reserved for future additions */
706 case HNCP_DHCPV4_DATA: {
708 nd_print_invalid(ndo);
711 if (dhcpv4_print(ndo, value, bodylen, indent+1) != 0)
716 case HNCP_DHCPV6_DATA: {
718 nd_print_invalid(ndo);
721 if (dhcpv6_print(ndo, value, bodylen, indent+1) != 0) {
722 nd_print_invalid(ndo);
728 case HNCP_ASSIGNED_PREFIX: {
731 if (bodylen < 6 || bodylen < 6 + (GET_U_1(value + 5) + 7) / 8) {
732 nd_print_invalid(ndo);
735 prty = GET_U_1(value + 4) & 0xf;
736 ND_PRINT(" EPID: %08x Prty: %u",
740 ND_PRINT(" Prefix: ");
741 if ((l = print_prefix(ndo, value + 5, bodylen - 5)) < 0) {
742 nd_print_invalid(ndo);
749 hncp_print_rec(ndo, value + l, bodylen - l, indent+1);
753 case HNCP_NODE_ADDRESS: {
754 uint32_t endpoint_identifier;
755 const char *ip_address;
757 nd_print_invalid(ndo);
760 endpoint_identifier = GET_BE_U_4(value);
761 ip_address = format_ip6addr(ndo, value + 4);
762 ND_PRINT(" EPID: %08x IP Address: %s",
767 hncp_print_rec(ndo, value + 20, bodylen - 20, indent+1);
771 case HNCP_DNS_DELEGATED_ZONE: {
772 const char *ip_address;
775 nd_print_invalid(ndo);
778 ip_address = format_ip6addr(ndo, value);
779 ND_PRINT(" IP-Address: %s %c%c%c ",
781 (GET_U_1(value + 16) & 4) ? 'l' : '-',
782 (GET_U_1(value + 16) & 2) ? 'b' : '-',
783 (GET_U_1(value + 16) & 1) ? 's' : '-'
785 len = print_dns_label(ndo, value+17, bodylen-17, 1);
787 nd_print_invalid(ndo);
793 hncp_print_rec(ndo, value+len, bodylen-len, indent+1);
797 case HNCP_DOMAIN_NAME: {
799 nd_print_invalid(ndo);
802 ND_PRINT(" Domain: ");
803 print_dns_label(ndo, value, bodylen, 1);
807 case HNCP_NODE_NAME: {
810 nd_print_invalid(ndo);
813 l = GET_U_1(value + 16);
814 if (bodylen < 17 + l) {
815 nd_print_invalid(ndo);
818 ND_PRINT(" IP-Address: %s Name: ",
819 format_ip6addr(ndo, value)
823 nd_printjnp(ndo, value + 17, l);
826 nd_print_invalid(ndo);
831 hncp_print_rec(ndo, value + l, bodylen - l, indent+1);
835 case HNCP_MANAGED_PSK: {
837 nd_print_invalid(ndo);
840 ND_PRINT(" PSK: %s", format_256(ndo, value));
841 hncp_print_rec(ndo, value + 32, bodylen - 32, indent+1);
845 case RANGE_DNCP_RESERVED:
846 case RANGE_HNCP_UNASSIGNED:
847 case RANGE_DNCP_PRIVATE_USE:
848 case RANGE_DNCP_FUTURE_USE:
854 i += 4 + roundup2(bodylen, 4);
856 print_type_in_line(ndo, last_type_mask, last_type_count, indent, &first_one);
865 nd_print_invalid(ndo);