4 * Gregory Detal <gregory.detal@uclouvain.be>
5 * Christoph Paasch <christoph.paasch@uclouvain.be>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor of the Laboratory may be used
19 * to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 /* \summary: Multipath TCP (MPTCP) printer */
37 /* specification: RFC 6824 */
43 #include "netdissect-stdinc.h"
45 #include "netdissect.h"
47 #include "addrtoname.h"
51 #define MPTCP_SUB_CAPABLE 0x0
52 #define MPTCP_SUB_JOIN 0x1
53 #define MPTCP_SUB_DSS 0x2
54 #define MPTCP_SUB_ADD_ADDR 0x3
55 #define MPTCP_SUB_REMOVE_ADDR 0x4
56 #define MPTCP_SUB_PRIO 0x5
57 #define MPTCP_SUB_FAIL 0x6
58 #define MPTCP_SUB_FCLOSE 0x7
63 nd_uint8_t sub_etc; /* subtype upper 4 bits, other stuff lower 4 bits */
66 #define MPTCP_OPT_SUBTYPE(sub_etc) (((sub_etc) >> 4) & 0xF)
73 nd_uint64_t sender_key;
74 nd_uint64_t receiver_key;
77 #define MP_CAPABLE_OPT_VERSION(sub_ver) (((sub_ver) >> 0) & 0xF)
78 #define MP_CAPABLE_C 0x80
79 #define MP_CAPABLE_S 0x01
101 #define MP_JOIN_B 0x01
110 #define MP_DSS_F 0x10
111 #define MP_DSS_m 0x08
112 #define MP_DSS_M 0x04
113 #define MP_DSS_a 0x02
114 #define MP_DSS_A 0x01
116 static const struct tok mptcp_addr_subecho_bits[] = {
151 struct mp_remove_addr {
155 /* list of addr_id */
156 nd_uint8_t addrs_id[1];
164 nd_uint64_t data_seq;
182 #define MP_PRIO_B 0x01
185 dummy_print(netdissect_options *ndo _U_,
186 const u_char *opt _U_, u_int opt_len _U_, u_char flags _U_)
192 mp_capable_print(netdissect_options *ndo,
193 const u_char *opt, u_int opt_len, u_char flags)
195 const struct mp_capable *mpc = (const struct mp_capable *) opt;
198 if (!((opt_len == 12 || opt_len == 4) && flags & TH_SYN) &&
199 !((opt_len == 20 || opt_len == 22) && (flags & (TH_SYN | TH_ACK)) ==
203 version = MP_CAPABLE_OPT_VERSION(GET_U_1(mpc->sub_ver));
205 case 0: /* fall through */
207 ND_PRINT(" v%u", version);
210 ND_PRINT(" Unknown Version (%u)", version);
214 if (GET_U_1(mpc->flags) & MP_CAPABLE_C)
216 if (opt_len == 12 || opt_len >= 20) {
217 ND_PRINT(" {0x%" PRIx64, GET_BE_U_8(mpc->sender_key));
219 ND_PRINT(",0x%" PRIx64, GET_BE_U_8(mpc->receiver_key));
226 mp_join_print(netdissect_options *ndo,
227 const u_char *opt, u_int opt_len, u_char flags)
229 const struct mp_join *mpj = (const struct mp_join *) opt;
231 if (!(opt_len == 12 && (flags & TH_SYN)) &&
232 !(opt_len == 16 && (flags & (TH_SYN | TH_ACK)) == (TH_SYN | TH_ACK)) &&
233 !(opt_len == 24 && (flags & TH_ACK)))
237 if (GET_U_1(mpj->sub_b) & MP_JOIN_B)
239 ND_PRINT(" id %u", GET_U_1(mpj->addr_id));
244 ND_PRINT(" token 0x%x" " nonce 0x%x",
245 GET_BE_U_4(mpj->u.syn.token),
246 GET_BE_U_4(mpj->u.syn.nonce));
248 case 16: /* SYN/ACK */
249 ND_PRINT(" hmac 0x%" PRIx64 " nonce 0x%x",
250 GET_BE_U_8(mpj->u.synack.mac),
251 GET_BE_U_4(mpj->u.synack.nonce));
255 ND_PRINT(" hmac 0x");
256 for (i = 0; i < sizeof(mpj->u.ack.mac); ++i)
257 ND_PRINT("%02x", mpj->u.ack.mac[i]);
266 mp_dss_print(netdissect_options *ndo,
267 const u_char *opt, u_int opt_len, u_char flags)
269 const struct mp_dss *mdss = (const struct mp_dss *) opt;
272 /* We need the flags, at a minimum. */
279 mdss_flags = GET_U_1(mdss->flags);
280 if (mdss_flags & MP_DSS_F)
285 if (mdss_flags & MP_DSS_A) {
289 * If the a flag is set, we have an 8-byte ack; if it's
290 * clear, we have a 4-byte ack.
292 if (mdss_flags & MP_DSS_a) {
295 ND_PRINT("%" PRIu64, GET_BE_U_8(opt));
301 ND_PRINT("%u", GET_BE_U_4(opt));
307 if (mdss_flags & MP_DSS_M) {
309 * Data Sequence Number (DSN), Subflow Sequence Number (SSN),
310 * Data-Level Length present, and Checksum possibly present.
314 * If the m flag is set, we have an 8-byte NDS; if it's clear,
315 * we have a 4-byte DSN.
317 if (mdss_flags & MP_DSS_m) {
320 ND_PRINT("%" PRIu64, GET_BE_U_8(opt));
326 ND_PRINT("%u", GET_BE_U_4(opt));
332 ND_PRINT(" subseq %u", GET_BE_U_4(opt));
337 ND_PRINT(" len %u", GET_BE_U_2(opt));
342 * The Checksum is present only if negotiated.
343 * If there are at least 2 bytes left, process the next 2
344 * bytes as the Checksum.
347 ND_PRINT(" csum 0x%x", GET_BE_U_2(opt));
357 add_addr_print(netdissect_options *ndo,
358 const u_char *opt, u_int opt_len, u_char flags _U_)
360 const struct mp_add_addr *add_addr = (const struct mp_add_addr *) opt;
362 if (!(opt_len == 8 || opt_len == 10 || opt_len == 16 || opt_len == 18 ||
363 opt_len == 20 || opt_len == 22 || opt_len == 28 || opt_len == 30))
367 tok2str(mptcp_addr_subecho_bits, "[bad version/echo]",
368 GET_U_1(add_addr->sub_echo) & 0xF));
369 ND_PRINT(" id %u", GET_U_1(add_addr->addr_id));
370 if (opt_len == 8 || opt_len == 10 || opt_len == 16 || opt_len == 18) {
371 ND_PRINT(" %s", GET_IPADDR_STRING(add_addr->u.v4.addr));
372 if (opt_len == 10 || opt_len == 18)
373 ND_PRINT(":%u", GET_BE_U_2(add_addr->u.v4.port));
375 ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v4np.mac));
377 ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v4.mac));
380 if (opt_len == 20 || opt_len == 22 || opt_len == 28 || opt_len == 30) {
381 ND_PRINT(" %s", GET_IP6ADDR_STRING(add_addr->u.v6.addr));
382 if (opt_len == 22 || opt_len == 30)
383 ND_PRINT(":%u", GET_BE_U_2(add_addr->u.v6.port));
385 ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v6np.mac));
387 ND_PRINT(" hmac 0x%" PRIx64, GET_BE_U_8(add_addr->u.v6.mac));
394 remove_addr_print(netdissect_options *ndo,
395 const u_char *opt, u_int opt_len, u_char flags _U_)
397 const struct mp_remove_addr *remove_addr = (const struct mp_remove_addr *) opt;
405 for (i = 0; i < opt_len; i++)
406 ND_PRINT(" %u", GET_U_1(remove_addr->addrs_id[i]));
411 mp_prio_print(netdissect_options *ndo,
412 const u_char *opt, u_int opt_len, u_char flags _U_)
414 const struct mp_prio *mpp = (const struct mp_prio *) opt;
416 if (opt_len != 3 && opt_len != 4)
419 if (GET_U_1(mpp->sub_b) & MP_PRIO_B)
422 ND_PRINT(" non-backup");
424 ND_PRINT(" id %u", GET_U_1(mpp->addr_id));
430 mp_fail_print(netdissect_options *ndo,
431 const u_char *opt, u_int opt_len, u_char flags _U_)
436 ND_PRINT(" seq %" PRIu64, GET_BE_U_8(opt + 4));
441 mp_fast_close_print(netdissect_options *ndo,
442 const u_char *opt, u_int opt_len, u_char flags _U_)
447 ND_PRINT(" key 0x%" PRIx64, GET_BE_U_8(opt + 4));
451 static const struct {
453 int (*print)(netdissect_options *, const u_char *, u_int, u_char);
454 } mptcp_options[] = {
455 { "capable", mp_capable_print },
456 { "join", mp_join_print },
457 { "dss", mp_dss_print },
458 { "add-addr", add_addr_print },
459 { "rem-addr", remove_addr_print },
460 { "prio", mp_prio_print },
461 { "fail", mp_fail_print },
462 { "fast-close", mp_fast_close_print },
463 { "unknown", dummy_print },
467 mptcp_print(netdissect_options *ndo,
468 const u_char *cp, u_int len, u_char flags)
470 const struct mptcp_option *opt;
473 ndo->ndo_protocol = "mptcp";
477 opt = (const struct mptcp_option *) cp;
478 subtype = MPTCP_OPT_SUBTYPE(GET_U_1(opt->sub_etc));
479 subtype = ND_MIN(subtype, MPTCP_SUB_FCLOSE + 1);
481 ND_PRINT(" %u", len);
483 ND_PRINT(" %s", mptcp_options[subtype].name);
484 return mptcp_options[subtype].print(ndo, cp, len, flags);