* SUCH DAMAGE.
*/
+/* \summary: Multipath TCP (MPTCP) printer */
+
+/* specification: RFC 6824 */
+
#ifdef HAVE_CONFIG_H
-#include "config.h"
+#include <config.h>
#endif
-#include <tcpdump-stdinc.h>
+#include "netdissect-stdinc.h"
-#include <stdio.h>
-#include <string.h>
-
-#include "interface.h"
+#include "netdissect.h"
#include "extract.h"
#include "addrtoname.h"
-#include "ipproto.h"
#include "tcp.h"
#define MPTCP_SUB_CAPABLE 0x0
#define MPTCP_SUB_PRIO 0x5
#define MPTCP_SUB_FAIL 0x6
#define MPTCP_SUB_FCLOSE 0x7
+#define MPTCP_SUB_TCPRST 0x8
struct mptcp_option {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub_etc; /* subtype upper 4 bits, other stuff lower 4 bits */
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub_etc; /* subtype upper 4 bits, other stuff lower 4 bits */
};
#define MPTCP_OPT_SUBTYPE(sub_etc) (((sub_etc) >> 4) & 0xF)
+#define MP_CAPABLE_A 0x80
+
+static const struct tok mp_capable_flags[] = {
+ { MP_CAPABLE_A, "A" },
+ { 0x40, "B" },
+ { 0x20, "C" },
+ { 0x10, "D" },
+ { 0x08, "E" },
+ { 0x04, "F" },
+ { 0x02, "G" },
+ { 0x01, "H" },
+ { 0, NULL }
+};
+
struct mp_capable {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub_ver;
- u_int8_t flags;
- u_int8_t sender_key[8];
- u_int8_t receiver_key[8];
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub_ver;
+ nd_uint8_t flags;
+ nd_uint64_t sender_key;
+ nd_uint64_t receiver_key;
+ nd_uint16_t data_len;
};
#define MP_CAPABLE_OPT_VERSION(sub_ver) (((sub_ver) >> 0) & 0xF)
-#define MP_CAPABLE_C 0x80
-#define MP_CAPABLE_S 0x01
struct mp_join {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub_b;
- u_int8_t addr_id;
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub_b;
+ nd_uint8_t addr_id;
union {
struct {
- u_int8_t token[4];
- u_int8_t nonce[4];
+ nd_uint32_t token;
+ nd_uint32_t nonce;
} syn;
struct {
- u_int8_t mac[8];
- u_int8_t nonce[4];
+ nd_uint64_t mac;
+ nd_uint32_t nonce;
} synack;
struct {
- u_int8_t mac[20];
+ nd_byte mac[20];
} ack;
} u;
};
#define MP_JOIN_B 0x01
struct mp_dss {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub;
- u_int8_t flags;
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub;
+ nd_uint8_t flags;
};
#define MP_DSS_F 0x10
#define MP_DSS_a 0x02
#define MP_DSS_A 0x01
+static const struct tok mptcp_addr_subecho_bits[] = {
+ { 0x6, "v0-ip6" },
+ { 0x4, "v0-ip4" },
+ { 0x1, "v1-echo" },
+ { 0x0, "v1" },
+ { 0, NULL }
+};
+
struct mp_add_addr {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub_ipver;
- u_int8_t addr_id;
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub_echo;
+ nd_uint8_t addr_id;
union {
struct {
- u_int8_t addr[4];
- u_int8_t port[2];
+ nd_ipv4 addr;
+ nd_uint16_t port;
+ nd_uint64_t mac;
} v4;
struct {
- u_int8_t addr[16];
- u_int8_t port[2];
+ nd_ipv4 addr;
+ nd_uint64_t mac;
+ } v4np;
+ struct {
+ nd_ipv6 addr;
+ nd_uint16_t port;
+ nd_uint64_t mac;
} v6;
+ struct {
+ nd_ipv6 addr;
+ nd_uint64_t mac;
+ } v6np;
} u;
};
-#define MP_ADD_ADDR_IPVER(sub_ipver) (((sub_ipver) >> 0) & 0xF)
-
struct mp_remove_addr {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub;
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub;
/* list of addr_id */
- u_int8_t addrs_id;
+ nd_uint8_t addrs_id[1];
};
struct mp_fail {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub;
- u_int8_t resv;
- u_int8_t data_seq[8];
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub;
+ nd_uint8_t resv;
+ nd_uint64_t data_seq;
};
struct mp_close {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub;
- u_int8_t rsv;
- u_int8_t key[8];
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub;
+ nd_uint8_t rsv;
+ nd_byte key[8];
};
struct mp_prio {
- u_int8_t kind;
- u_int8_t len;
- u_int8_t sub_b;
- u_int8_t addr_id;
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub_b;
+ nd_uint8_t addr_id;
};
#define MP_PRIO_B 0x01
-static int dummy_print(const u_char *opt _U_, u_int opt_len _U_, u_char flags _U_)
+static const struct tok mp_tcprst_flags[] = {
+ { 0x08, "U" },
+ { 0x04, "V" },
+ { 0x02, "W" },
+ { 0x01, "T" },
+ { 0, NULL }
+};
+
+static const struct tok mp_tcprst_reasons[] = {
+ { 0x06, "Middlebox interference" },
+ { 0x05, "Unacceptable performance" },
+ { 0x04, "Too much outstanding data" },
+ { 0x03, "Administratively prohibited" },
+ { 0x02, "Lack of resources" },
+ { 0x01, "MPTCP-specific error" },
+ { 0x00, "Unspecified error" },
+ { 0, NULL }
+};
+
+struct mp_tcprst {
+ nd_uint8_t kind;
+ nd_uint8_t len;
+ nd_uint8_t sub_b;
+ nd_uint8_t reason;
+};
+
+static int
+dummy_print(netdissect_options *ndo _U_,
+ const u_char *opt _U_, u_int opt_len _U_, u_char flags _U_)
{
return 1;
}
-static int mp_capable_print(const u_char *opt, u_int opt_len, u_char flags)
+static int
+mp_capable_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags)
{
- struct mp_capable *mpc = (struct mp_capable *) opt;
+ const struct mp_capable *mpc = (const struct mp_capable *) opt;
+ uint8_t version, csum_enabled;
- if (!(opt_len == 12 && flags & TH_SYN) &&
- !(opt_len == 20 && (flags & (TH_SYN | TH_ACK)) == TH_ACK))
+ if (!((opt_len == 12 || opt_len == 4) && flags & TH_SYN) &&
+ !((opt_len == 20 || opt_len == 22 || opt_len == 24) && (flags & (TH_SYN | TH_ACK)) ==
+ TH_ACK))
return 0;
- if (MP_CAPABLE_OPT_VERSION(mpc->sub_ver) != 0) {
- printf(" Unknown Version (%d)", MP_CAPABLE_OPT_VERSION(mpc->sub_ver));
- return 1;
+ version = MP_CAPABLE_OPT_VERSION(GET_U_1(mpc->sub_ver));
+ switch (version) {
+ case 0: /* fall through */
+ case 1:
+ ND_PRINT(" v%u", version);
+ break;
+ default:
+ ND_PRINT(" Unknown Version (%u)", version);
+ return 1;
}
- if (mpc->flags & MP_CAPABLE_C)
- printf(" csum");
- printf(" {0x%" PRIx64, EXTRACT_64BITS(mpc->sender_key));
- if (opt_len == 20) /* ACK */
- printf(",0x%" PRIx64, EXTRACT_64BITS(mpc->receiver_key));
- printf("}");
+ ND_PRINT(" flags [%s]", bittok2str_nosep(mp_capable_flags, "none",
+ GET_U_1(mpc->flags)));
+
+ csum_enabled = GET_U_1(mpc->flags) & MP_CAPABLE_A;
+ if (csum_enabled)
+ ND_PRINT(" csum");
+ if (opt_len == 12 || opt_len >= 20) {
+ ND_PRINT(" {0x%" PRIx64, GET_BE_U_8(mpc->sender_key));
+ if (opt_len >= 20)
+ ND_PRINT(",0x%" PRIx64, GET_BE_U_8(mpc->receiver_key));
+
+ /* RFC 8684 Section 3.1 */
+ if ((opt_len == 22 && !csum_enabled) || opt_len == 24)
+ ND_PRINT(",data_len=%u", GET_BE_U_2(mpc->data_len));
+ ND_PRINT("}");
+ }
return 1;
}
-static int mp_join_print(const u_char *opt, u_int opt_len, u_char flags)
+static int
+mp_join_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags)
{
- struct mp_join *mpj = (struct mp_join *) opt;
+ const struct mp_join *mpj = (const struct mp_join *) opt;
- if (!(opt_len == 12 && flags & TH_SYN) &&
+ if (!(opt_len == 12 && (flags & TH_SYN)) &&
!(opt_len == 16 && (flags & (TH_SYN | TH_ACK)) == (TH_SYN | TH_ACK)) &&
- !(opt_len == 24 && flags & TH_ACK))
+ !(opt_len == 24 && (flags & TH_ACK)))
return 0;
if (opt_len != 24) {
- if (mpj->sub_b & MP_JOIN_B)
- printf(" backup");
- printf(" id %u", mpj->addr_id);
+ if (GET_U_1(mpj->sub_b) & MP_JOIN_B)
+ ND_PRINT(" backup");
+ ND_PRINT(" id %u", GET_U_1(mpj->addr_id));
}
switch (opt_len) {
case 12: /* SYN */
- printf(" token 0x%x" " nonce 0x%x",
- EXTRACT_32BITS(mpj->u.syn.token),
- EXTRACT_32BITS(mpj->u.syn.nonce));
+ ND_PRINT(" token 0x%x" " nonce 0x%x",
+ GET_BE_U_4(mpj->u.syn.token),
+ GET_BE_U_4(mpj->u.syn.nonce));
break;
case 16: /* SYN/ACK */
- printf(" hmac 0x%" PRIx64 " nonce 0x%x",
- EXTRACT_64BITS(mpj->u.synack.mac),
- EXTRACT_32BITS(mpj->u.synack.nonce));
+ ND_PRINT(" hmac 0x%" PRIx64 " nonce 0x%x",
+ GET_BE_U_8(mpj->u.synack.mac),
+ GET_BE_U_4(mpj->u.synack.nonce));
break;
case 24: {/* ACK */
size_t i;
- printf(" hmac 0x");
+ ND_PRINT(" hmac 0x");
for (i = 0; i < sizeof(mpj->u.ack.mac); ++i)
- printf("%02x", mpj->u.ack.mac[i]);
+ ND_PRINT("%02x", mpj->u.ack.mac[i]);
}
default:
break;
return 1;
}
-static u_int mp_dss_len(struct mp_dss *m, int csum)
+static int
+mp_dss_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags)
{
- u_int len;
-
- len = 4;
- if (m->flags & MP_DSS_A) {
- /* Ack present - 4 or 8 octets */
- len += (m->flags & MP_DSS_a) ? 8 : 4;
- }
- if (m->flags & MP_DSS_M) {
- /*
- * Data Sequence Number (DSN), Subflow Sequence Number (SSN),
- * Data-Level Length present, and Checksum possibly present.
- * All but the Checksum are 10 bytes if the m flag is
- * clear (4-byte DSN) and 14 bytes if the m flag is set
- * (8-byte DSN).
- */
- len += (m->flags & MP_DSS_m) ? 14 : 10;
+ const struct mp_dss *mdss = (const struct mp_dss *) opt;
+ uint8_t mdss_flags;
- /*
- * The Checksum is present only if negotiated.
- */
- if (csum)
- len += 2;
- }
- return len;
-}
-
-static int mp_dss_print(const u_char *opt, u_int opt_len, u_char flags)
-{
- struct mp_dss *mdss = (struct mp_dss *) opt;
+ /* We need the flags, at a minimum. */
+ if (opt_len < 4)
+ return 0;
- if ((opt_len != mp_dss_len(mdss, 1) &&
- opt_len != mp_dss_len(mdss, 0)) || flags & TH_SYN)
+ if (flags & TH_SYN)
return 0;
- if (mdss->flags & MP_DSS_F)
- printf(" fin");
+ mdss_flags = GET_U_1(mdss->flags);
+ if (mdss_flags & MP_DSS_F)
+ ND_PRINT(" fin");
opt += 4;
- if (mdss->flags & MP_DSS_A) {
- printf(" ack ");
- if (mdss->flags & MP_DSS_a) {
- printf("%" PRIu64, EXTRACT_64BITS(opt));
+ opt_len -= 4;
+ if (mdss_flags & MP_DSS_A) {
+ /* Ack present */
+ ND_PRINT(" ack ");
+ /*
+ * If the a flag is set, we have an 8-byte ack; if it's
+ * clear, we have a 4-byte ack.
+ */
+ if (mdss_flags & MP_DSS_a) {
+ if (opt_len < 8)
+ return 0;
+ ND_PRINT("%" PRIu64, GET_BE_U_8(opt));
opt += 8;
+ opt_len -= 8;
} else {
- printf("%u", EXTRACT_32BITS(opt));
+ if (opt_len < 4)
+ return 0;
+ ND_PRINT("%u", GET_BE_U_4(opt));
opt += 4;
+ opt_len -= 4;
}
}
- if (mdss->flags & MP_DSS_M) {
- printf(" seq ");
- if (mdss->flags & MP_DSS_m) {
- printf("%" PRIu64, EXTRACT_64BITS(opt));
+ if (mdss_flags & MP_DSS_M) {
+ /*
+ * Data Sequence Number (DSN), Subflow Sequence Number (SSN),
+ * Data-Level Length present, and Checksum possibly present.
+ */
+ ND_PRINT(" seq ");
+ /*
+ * If the m flag is set, we have an 8-byte NDS; if it's clear,
+ * we have a 4-byte DSN.
+ */
+ if (mdss_flags & MP_DSS_m) {
+ if (opt_len < 8)
+ return 0;
+ ND_PRINT("%" PRIu64, GET_BE_U_8(opt));
opt += 8;
+ opt_len -= 8;
} else {
- printf("%u", EXTRACT_32BITS(opt));
+ if (opt_len < 4)
+ return 0;
+ ND_PRINT("%u", GET_BE_U_4(opt));
opt += 4;
+ opt_len -= 4;
}
- printf(" subseq %u", EXTRACT_32BITS(opt));
+ if (opt_len < 4)
+ return 0;
+ ND_PRINT(" subseq %u", GET_BE_U_4(opt));
opt += 4;
- printf(" len %u", EXTRACT_16BITS(opt));
+ opt_len -= 4;
+ if (opt_len < 2)
+ return 0;
+ ND_PRINT(" len %u", GET_BE_U_2(opt));
opt += 2;
+ opt_len -= 2;
- if (opt_len == mp_dss_len(mdss, 1))
- printf(" csum 0x%x", EXTRACT_16BITS(opt));
+ /*
+ * The Checksum is present only if negotiated.
+ * If there are at least 2 bytes left, process the next 2
+ * bytes as the Checksum.
+ */
+ if (opt_len >= 2) {
+ ND_PRINT(" csum 0x%x", GET_BE_U_2(opt));
+ opt_len -= 2;
+ }
}
+ if (opt_len != 0)
+ return 0;
return 1;
}
-static int add_addr_print(const u_char *opt, u_int opt_len, u_char flags _U_)
+static int
+add_addr_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags _U_)
{
- struct mp_add_addr *add_addr = (struct mp_add_addr *) opt;
- u_int ipver = MP_ADD_ADDR_IPVER(add_addr->sub_ipver);
+ const struct mp_add_addr *add_addr = (const struct mp_add_addr *) opt;
- if (!((opt_len == 8 || opt_len == 10) && ipver == 4) &&
- !((opt_len == 20 || opt_len == 22) && ipver == 6))
+ if (!(opt_len == 8 || opt_len == 10 || opt_len == 16 || opt_len == 18 ||
+ opt_len == 20 || opt_len == 22 || opt_len == 28 || opt_len == 30))
return 0;
- printf(" id %u", add_addr->addr_id);
- switch (ipver) {
- case 4:
- printf(" %s", ipaddr_string(add_addr->u.v4.addr));
- if (opt_len == 10)
- printf(":%u", EXTRACT_16BITS(add_addr->u.v4.port));
- break;
- case 6:
-#ifdef INET6
- printf(" %s", ip6addr_string(add_addr->u.v6.addr));
-#endif
- if (opt_len == 22)
- printf(":%u", EXTRACT_16BITS(add_addr->u.v6.port));
- break;
- default:
- return 0;
+ ND_PRINT(" %s",
+ tok2str(mptcp_addr_subecho_bits, "[bad version/echo]",
+ GET_U_1(add_addr->sub_echo) & 0xF));
+ ND_PRINT(" id %u", GET_U_1(add_addr->addr_id));
+ if (opt_len == 8 || opt_len == 10 || opt_len == 16 || opt_len == 18) {
+ ND_PRINT(" %s", GET_IPADDR_STRING(add_addr->u.v4.addr));
+ if (opt_len == 10 || opt_len == 18)
+ ND_PRINT(":%u", GET_BE_U_2(add_addr->u.v4.port));
+ if (opt_len == 16)
+ ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v4np.mac));
+ if (opt_len == 18)
+ ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v4.mac));
+ }
+
+ if (opt_len == 20 || opt_len == 22 || opt_len == 28 || opt_len == 30) {
+ ND_PRINT(" %s", GET_IP6ADDR_STRING(add_addr->u.v6.addr));
+ if (opt_len == 22 || opt_len == 30)
+ ND_PRINT(":%u", GET_BE_U_2(add_addr->u.v6.port));
+ if (opt_len == 28)
+ ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v6np.mac));
+ if (opt_len == 30)
+ ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v6.mac));
}
return 1;
}
-static int remove_addr_print(const u_char *opt, u_int opt_len, u_char flags _U_)
+static int
+remove_addr_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags _U_)
{
- struct mp_remove_addr *remove_addr = (struct mp_remove_addr *) opt;
- u_int8_t *addr_id = &remove_addr->addrs_id;
+ const struct mp_remove_addr *remove_addr = (const struct mp_remove_addr *) opt;
+ u_int i;
if (opt_len < 4)
return 0;
opt_len -= 3;
- printf(" id");
- while (opt_len--)
- printf(" %u", *addr_id++);
+ ND_PRINT(" id");
+ for (i = 0; i < opt_len; i++)
+ ND_PRINT(" %u", GET_U_1(remove_addr->addrs_id[i]));
return 1;
}
-static int mp_prio_print(const u_char *opt, u_int opt_len, u_char flags _U_)
+static int
+mp_prio_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags _U_)
{
- struct mp_prio *mpp = (struct mp_prio *) opt;
+ const struct mp_prio *mpp = (const struct mp_prio *) opt;
if (opt_len != 3 && opt_len != 4)
return 0;
- if (mpp->sub_b & MP_PRIO_B)
- printf(" backup");
+ if (GET_U_1(mpp->sub_b) & MP_PRIO_B)
+ ND_PRINT(" backup");
else
- printf(" non-backup");
+ ND_PRINT(" non-backup");
if (opt_len == 4)
- printf(" id %u", mpp->addr_id);
+ ND_PRINT(" id %u", GET_U_1(mpp->addr_id));
return 1;
}
-static int mp_fail_print(const u_char *opt, u_int opt_len, u_char flags _U_)
+static int
+mp_fail_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags _U_)
{
if (opt_len != 12)
return 0;
- printf(" seq %" PRIu64, EXTRACT_64BITS(opt + 4));
+ ND_PRINT(" seq %" PRIu64, GET_BE_U_8(opt + 4));
return 1;
}
-static int mp_fast_close_print(const u_char *opt, u_int opt_len, u_char flags _U_)
+static int
+mp_fast_close_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags _U_)
{
if (opt_len != 12)
return 0;
- printf(" key 0x%" PRIx64, EXTRACT_64BITS(opt + 4));
+ ND_PRINT(" key 0x%" PRIx64, GET_BE_U_8(opt + 4));
+ return 1;
+}
+
+static int
+mp_tcprst_print(netdissect_options *ndo,
+ const u_char *opt, u_int opt_len, u_char flags _U_)
+{
+ const struct mp_tcprst *mpr = (const struct mp_tcprst *)opt;
+
+ if (opt_len != 4)
+ return 0;
+
+ ND_PRINT(" flags [%s]", bittok2str_nosep(mp_tcprst_flags, "none",
+ GET_U_1(mpr->sub_b)));
+
+ ND_PRINT(" reason %s", tok2str(mp_tcprst_reasons, "unknown (0x%02x)",
+ GET_U_1(mpr->reason)));
return 1;
}
static const struct {
const char *name;
- int (*print)(const u_char *, u_int, u_char);
+ int (*print)(netdissect_options *, const u_char *, u_int, u_char);
} mptcp_options[] = {
- { "capable", mp_capable_print},
+ { "capable", mp_capable_print },
{ "join", mp_join_print },
{ "dss", mp_dss_print },
{ "add-addr", add_addr_print },
{ "prio", mp_prio_print },
{ "fail", mp_fail_print },
{ "fast-close", mp_fast_close_print },
+ { "tcprst", mp_tcprst_print },
{ "unknown", dummy_print },
};
-int mptcp_print(const u_char *cp, u_int len, u_char flags)
+int
+mptcp_print(netdissect_options *ndo,
+ const u_char *cp, u_int len, u_char flags)
{
- struct mptcp_option *opt;
+ const struct mptcp_option *opt;
u_int subtype;
+ ndo->ndo_protocol = "mptcp";
if (len < 3)
return 0;
- opt = (struct mptcp_option *) cp;
- subtype = min(MPTCP_OPT_SUBTYPE(opt->sub_etc), MPTCP_SUB_FCLOSE + 1);
+ opt = (const struct mptcp_option *) cp;
+ subtype = MPTCP_OPT_SUBTYPE(GET_U_1(opt->sub_etc));
+ subtype = ND_MIN(subtype, MPTCP_SUB_TCPRST + 1);
+
+ ND_PRINT(" %u", len);
- printf(" %s", mptcp_options[subtype].name);
- return mptcp_options[subtype].print(cp, len, flags);
+ ND_PRINT(" %s", mptcp_options[subtype].name);
+ return mptcp_options[subtype].print(ndo, cp, len, flags);
}