Merge git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net
[linux-2.6-microblaze.git] / net / mptcp / options.c
1 // SPDX-License-Identifier: GPL-2.0
2 /* Multipath TCP
3  *
4  * Copyright (c) 2017 - 2019, Intel Corporation.
5  */
6
7 #define pr_fmt(fmt) "MPTCP: " fmt
8
9 #include <linux/kernel.h>
10 #include <crypto/sha.h>
11 #include <net/tcp.h>
12 #include <net/mptcp.h>
13 #include "protocol.h"
14
15 static bool mptcp_cap_flag_sha256(u8 flags)
16 {
17         return (flags & MPTCP_CAP_FLAG_MASK) == MPTCP_CAP_HMAC_SHA256;
18 }
19
20 static void mptcp_parse_option(const struct sk_buff *skb,
21                                const unsigned char *ptr, int opsize,
22                                struct mptcp_options_received *mp_opt)
23 {
24         u8 subtype = *ptr >> 4;
25         int expected_opsize;
26         u8 version;
27         u8 flags;
28
29         switch (subtype) {
30         case MPTCPOPT_MP_CAPABLE:
31                 /* strict size checking */
32                 if (!(TCP_SKB_CB(skb)->tcp_flags & TCPHDR_SYN)) {
33                         if (skb->len > tcp_hdr(skb)->doff << 2)
34                                 expected_opsize = TCPOLEN_MPTCP_MPC_ACK_DATA;
35                         else
36                                 expected_opsize = TCPOLEN_MPTCP_MPC_ACK;
37                 } else {
38                         if (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_ACK)
39                                 expected_opsize = TCPOLEN_MPTCP_MPC_SYNACK;
40                         else
41                                 expected_opsize = TCPOLEN_MPTCP_MPC_SYN;
42                 }
43                 if (opsize != expected_opsize)
44                         break;
45
46                 /* try to be gentle vs future versions on the initial syn */
47                 version = *ptr++ & MPTCP_VERSION_MASK;
48                 if (opsize != TCPOLEN_MPTCP_MPC_SYN) {
49                         if (version != MPTCP_SUPPORTED_VERSION)
50                                 break;
51                 } else if (version < MPTCP_SUPPORTED_VERSION) {
52                         break;
53                 }
54
55                 flags = *ptr++;
56                 if (!mptcp_cap_flag_sha256(flags) ||
57                     (flags & MPTCP_CAP_EXTENSIBILITY))
58                         break;
59
60                 /* RFC 6824, Section 3.1:
61                  * "For the Checksum Required bit (labeled "A"), if either
62                  * host requires the use of checksums, checksums MUST be used.
63                  * In other words, the only way for checksums not to be used
64                  * is if both hosts in their SYNs set A=0."
65                  *
66                  * Section 3.3.0:
67                  * "If a checksum is not present when its use has been
68                  * negotiated, the receiver MUST close the subflow with a RST as
69                  * it is considered broken."
70                  *
71                  * We don't implement DSS checksum - fall back to TCP.
72                  */
73                 if (flags & MPTCP_CAP_CHECKSUM_REQD)
74                         break;
75
76                 mp_opt->mp_capable = 1;
77                 if (opsize >= TCPOLEN_MPTCP_MPC_SYNACK) {
78                         mp_opt->sndr_key = get_unaligned_be64(ptr);
79                         ptr += 8;
80                 }
81                 if (opsize >= TCPOLEN_MPTCP_MPC_ACK) {
82                         mp_opt->rcvr_key = get_unaligned_be64(ptr);
83                         ptr += 8;
84                 }
85                 if (opsize == TCPOLEN_MPTCP_MPC_ACK_DATA) {
86                         /* Section 3.1.:
87                          * "the data parameters in a MP_CAPABLE are semantically
88                          * equivalent to those in a DSS option and can be used
89                          * interchangeably."
90                          */
91                         mp_opt->dss = 1;
92                         mp_opt->use_map = 1;
93                         mp_opt->mpc_map = 1;
94                         mp_opt->data_len = get_unaligned_be16(ptr);
95                         ptr += 2;
96                 }
97                 pr_debug("MP_CAPABLE version=%x, flags=%x, optlen=%d sndr=%llu, rcvr=%llu len=%d",
98                          version, flags, opsize, mp_opt->sndr_key,
99                          mp_opt->rcvr_key, mp_opt->data_len);
100                 break;
101
102         case MPTCPOPT_MP_JOIN:
103                 mp_opt->mp_join = 1;
104                 if (opsize == TCPOLEN_MPTCP_MPJ_SYN) {
105                         mp_opt->backup = *ptr++ & MPTCPOPT_BACKUP;
106                         mp_opt->join_id = *ptr++;
107                         mp_opt->token = get_unaligned_be32(ptr);
108                         ptr += 4;
109                         mp_opt->nonce = get_unaligned_be32(ptr);
110                         ptr += 4;
111                         pr_debug("MP_JOIN bkup=%u, id=%u, token=%u, nonce=%u",
112                                  mp_opt->backup, mp_opt->join_id,
113                                  mp_opt->token, mp_opt->nonce);
114                 } else if (opsize == TCPOLEN_MPTCP_MPJ_SYNACK) {
115                         mp_opt->backup = *ptr++ & MPTCPOPT_BACKUP;
116                         mp_opt->join_id = *ptr++;
117                         mp_opt->thmac = get_unaligned_be64(ptr);
118                         ptr += 8;
119                         mp_opt->nonce = get_unaligned_be32(ptr);
120                         ptr += 4;
121                         pr_debug("MP_JOIN bkup=%u, id=%u, thmac=%llu, nonce=%u",
122                                  mp_opt->backup, mp_opt->join_id,
123                                  mp_opt->thmac, mp_opt->nonce);
124                 } else if (opsize == TCPOLEN_MPTCP_MPJ_ACK) {
125                         ptr += 2;
126                         memcpy(mp_opt->hmac, ptr, MPTCPOPT_HMAC_LEN);
127                         pr_debug("MP_JOIN hmac");
128                 } else {
129                         pr_warn("MP_JOIN bad option size");
130                         mp_opt->mp_join = 0;
131                 }
132                 break;
133
134         case MPTCPOPT_DSS:
135                 pr_debug("DSS");
136                 ptr++;
137
138                 /* we must clear 'mpc_map' be able to detect MP_CAPABLE
139                  * map vs DSS map in mptcp_incoming_options(), and reconstruct
140                  * map info accordingly
141                  */
142                 mp_opt->mpc_map = 0;
143                 flags = (*ptr++) & MPTCP_DSS_FLAG_MASK;
144                 mp_opt->data_fin = (flags & MPTCP_DSS_DATA_FIN) != 0;
145                 mp_opt->dsn64 = (flags & MPTCP_DSS_DSN64) != 0;
146                 mp_opt->use_map = (flags & MPTCP_DSS_HAS_MAP) != 0;
147                 mp_opt->ack64 = (flags & MPTCP_DSS_ACK64) != 0;
148                 mp_opt->use_ack = (flags & MPTCP_DSS_HAS_ACK);
149
150                 pr_debug("data_fin=%d dsn64=%d use_map=%d ack64=%d use_ack=%d",
151                          mp_opt->data_fin, mp_opt->dsn64,
152                          mp_opt->use_map, mp_opt->ack64,
153                          mp_opt->use_ack);
154
155                 expected_opsize = TCPOLEN_MPTCP_DSS_BASE;
156
157                 if (mp_opt->use_ack) {
158                         if (mp_opt->ack64)
159                                 expected_opsize += TCPOLEN_MPTCP_DSS_ACK64;
160                         else
161                                 expected_opsize += TCPOLEN_MPTCP_DSS_ACK32;
162                 }
163
164                 if (mp_opt->use_map) {
165                         if (mp_opt->dsn64)
166                                 expected_opsize += TCPOLEN_MPTCP_DSS_MAP64;
167                         else
168                                 expected_opsize += TCPOLEN_MPTCP_DSS_MAP32;
169                 }
170
171                 /* RFC 6824, Section 3.3:
172                  * If a checksum is present, but its use had
173                  * not been negotiated in the MP_CAPABLE handshake,
174                  * the checksum field MUST be ignored.
175                  */
176                 if (opsize != expected_opsize &&
177                     opsize != expected_opsize + TCPOLEN_MPTCP_DSS_CHECKSUM)
178                         break;
179
180                 mp_opt->dss = 1;
181
182                 if (mp_opt->use_ack) {
183                         if (mp_opt->ack64) {
184                                 mp_opt->data_ack = get_unaligned_be64(ptr);
185                                 ptr += 8;
186                         } else {
187                                 mp_opt->data_ack = get_unaligned_be32(ptr);
188                                 ptr += 4;
189                         }
190
191                         pr_debug("data_ack=%llu", mp_opt->data_ack);
192                 }
193
194                 if (mp_opt->use_map) {
195                         if (mp_opt->dsn64) {
196                                 mp_opt->data_seq = get_unaligned_be64(ptr);
197                                 ptr += 8;
198                         } else {
199                                 mp_opt->data_seq = get_unaligned_be32(ptr);
200                                 ptr += 4;
201                         }
202
203                         mp_opt->subflow_seq = get_unaligned_be32(ptr);
204                         ptr += 4;
205
206                         mp_opt->data_len = get_unaligned_be16(ptr);
207                         ptr += 2;
208
209                         pr_debug("data_seq=%llu subflow_seq=%u data_len=%u",
210                                  mp_opt->data_seq, mp_opt->subflow_seq,
211                                  mp_opt->data_len);
212                 }
213
214                 break;
215
216         case MPTCPOPT_ADD_ADDR:
217                 mp_opt->echo = (*ptr++) & MPTCP_ADDR_ECHO;
218                 if (!mp_opt->echo) {
219                         if (opsize == TCPOLEN_MPTCP_ADD_ADDR ||
220                             opsize == TCPOLEN_MPTCP_ADD_ADDR_PORT)
221                                 mp_opt->family = MPTCP_ADDR_IPVERSION_4;
222 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
223                         else if (opsize == TCPOLEN_MPTCP_ADD_ADDR6 ||
224                                  opsize == TCPOLEN_MPTCP_ADD_ADDR6_PORT)
225                                 mp_opt->family = MPTCP_ADDR_IPVERSION_6;
226 #endif
227                         else
228                                 break;
229                 } else {
230                         if (opsize == TCPOLEN_MPTCP_ADD_ADDR_BASE ||
231                             opsize == TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT)
232                                 mp_opt->family = MPTCP_ADDR_IPVERSION_4;
233 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
234                         else if (opsize == TCPOLEN_MPTCP_ADD_ADDR6_BASE ||
235                                  opsize == TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT)
236                                 mp_opt->family = MPTCP_ADDR_IPVERSION_6;
237 #endif
238                         else
239                                 break;
240                 }
241
242                 mp_opt->add_addr = 1;
243                 mp_opt->port = 0;
244                 mp_opt->addr_id = *ptr++;
245                 pr_debug("ADD_ADDR: id=%d", mp_opt->addr_id);
246                 if (mp_opt->family == MPTCP_ADDR_IPVERSION_4) {
247                         memcpy((u8 *)&mp_opt->addr.s_addr, (u8 *)ptr, 4);
248                         ptr += 4;
249                         if (opsize == TCPOLEN_MPTCP_ADD_ADDR_PORT ||
250                             opsize == TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT) {
251                                 mp_opt->port = get_unaligned_be16(ptr);
252                                 ptr += 2;
253                         }
254                 }
255 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
256                 else {
257                         memcpy(mp_opt->addr6.s6_addr, (u8 *)ptr, 16);
258                         ptr += 16;
259                         if (opsize == TCPOLEN_MPTCP_ADD_ADDR6_PORT ||
260                             opsize == TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT) {
261                                 mp_opt->port = get_unaligned_be16(ptr);
262                                 ptr += 2;
263                         }
264                 }
265 #endif
266                 if (!mp_opt->echo) {
267                         mp_opt->ahmac = get_unaligned_be64(ptr);
268                         ptr += 8;
269                 }
270                 break;
271
272         case MPTCPOPT_RM_ADDR:
273                 if (opsize != TCPOLEN_MPTCP_RM_ADDR_BASE)
274                         break;
275
276                 ptr++;
277
278                 mp_opt->rm_addr = 1;
279                 mp_opt->rm_id = *ptr++;
280                 pr_debug("RM_ADDR: id=%d", mp_opt->rm_id);
281                 break;
282
283         default:
284                 break;
285         }
286 }
287
288 void mptcp_get_options(const struct sk_buff *skb,
289                        struct mptcp_options_received *mp_opt)
290 {
291         const struct tcphdr *th = tcp_hdr(skb);
292         const unsigned char *ptr;
293         int length;
294
295         /* initialize option status */
296         mp_opt->mp_capable = 0;
297         mp_opt->mp_join = 0;
298         mp_opt->add_addr = 0;
299         mp_opt->rm_addr = 0;
300         mp_opt->dss = 0;
301
302         length = (th->doff * 4) - sizeof(struct tcphdr);
303         ptr = (const unsigned char *)(th + 1);
304
305         while (length > 0) {
306                 int opcode = *ptr++;
307                 int opsize;
308
309                 switch (opcode) {
310                 case TCPOPT_EOL:
311                         return;
312                 case TCPOPT_NOP:        /* Ref: RFC 793 section 3.1 */
313                         length--;
314                         continue;
315                 default:
316                         opsize = *ptr++;
317                         if (opsize < 2) /* "silly options" */
318                                 return;
319                         if (opsize > length)
320                                 return; /* don't parse partial options */
321                         if (opcode == TCPOPT_MPTCP)
322                                 mptcp_parse_option(skb, ptr, opsize, mp_opt);
323                         ptr += opsize - 2;
324                         length -= opsize;
325                 }
326         }
327 }
328
329 bool mptcp_syn_options(struct sock *sk, const struct sk_buff *skb,
330                        unsigned int *size, struct mptcp_out_options *opts)
331 {
332         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
333
334         /* we will use snd_isn to detect first pkt [re]transmission
335          * in mptcp_established_options_mp()
336          */
337         subflow->snd_isn = TCP_SKB_CB(skb)->end_seq;
338         if (subflow->request_mptcp) {
339                 opts->suboptions = OPTION_MPTCP_MPC_SYN;
340                 *size = TCPOLEN_MPTCP_MPC_SYN;
341                 return true;
342         } else if (subflow->request_join) {
343                 pr_debug("remote_token=%u, nonce=%u", subflow->remote_token,
344                          subflow->local_nonce);
345                 opts->suboptions = OPTION_MPTCP_MPJ_SYN;
346                 opts->join_id = subflow->local_id;
347                 opts->token = subflow->remote_token;
348                 opts->nonce = subflow->local_nonce;
349                 opts->backup = subflow->request_bkup;
350                 *size = TCPOLEN_MPTCP_MPJ_SYN;
351                 return true;
352         }
353         return false;
354 }
355
356 /* MP_JOIN client subflow must wait for 4th ack before sending any data:
357  * TCP can't schedule delack timer before the subflow is fully established.
358  * MPTCP uses the delack timer to do 3rd ack retransmissions
359  */
360 static void schedule_3rdack_retransmission(struct sock *sk)
361 {
362         struct inet_connection_sock *icsk = inet_csk(sk);
363         struct tcp_sock *tp = tcp_sk(sk);
364         unsigned long timeout;
365
366         /* reschedule with a timeout above RTT, as we must look only for drop */
367         if (tp->srtt_us)
368                 timeout = tp->srtt_us << 1;
369         else
370                 timeout = TCP_TIMEOUT_INIT;
371
372         WARN_ON_ONCE(icsk->icsk_ack.pending & ICSK_ACK_TIMER);
373         icsk->icsk_ack.pending |= ICSK_ACK_SCHED | ICSK_ACK_TIMER;
374         icsk->icsk_ack.timeout = timeout;
375         sk_reset_timer(sk, &icsk->icsk_delack_timer, timeout);
376 }
377
378 static void clear_3rdack_retransmission(struct sock *sk)
379 {
380         struct inet_connection_sock *icsk = inet_csk(sk);
381
382         sk_stop_timer(sk, &icsk->icsk_delack_timer);
383         icsk->icsk_ack.timeout = 0;
384         icsk->icsk_ack.ato = 0;
385         icsk->icsk_ack.pending &= ~(ICSK_ACK_SCHED | ICSK_ACK_TIMER);
386 }
387
388 static bool mptcp_established_options_mp(struct sock *sk, struct sk_buff *skb,
389                                          unsigned int *size,
390                                          unsigned int remaining,
391                                          struct mptcp_out_options *opts)
392 {
393         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
394         struct mptcp_ext *mpext;
395         unsigned int data_len;
396
397         /* When skb is not available, we better over-estimate the emitted
398          * options len. A full DSS option (28 bytes) is longer than
399          * TCPOLEN_MPTCP_MPC_ACK_DATA(22) or TCPOLEN_MPTCP_MPJ_ACK(24), so
400          * tell the caller to defer the estimate to
401          * mptcp_established_options_dss(), which will reserve enough space.
402          */
403         if (!skb)
404                 return false;
405
406         /* MPC/MPJ needed only on 3rd ack packet */
407         if (subflow->fully_established ||
408             subflow->snd_isn != TCP_SKB_CB(skb)->seq)
409                 return false;
410
411         if (subflow->mp_capable) {
412                 mpext = mptcp_get_ext(skb);
413                 data_len = mpext ? mpext->data_len : 0;
414
415                 /* we will check ext_copy.data_len in mptcp_write_options() to
416                  * discriminate between TCPOLEN_MPTCP_MPC_ACK_DATA and
417                  * TCPOLEN_MPTCP_MPC_ACK
418                  */
419                 opts->ext_copy.data_len = data_len;
420                 opts->suboptions = OPTION_MPTCP_MPC_ACK;
421                 opts->sndr_key = subflow->local_key;
422                 opts->rcvr_key = subflow->remote_key;
423
424                 /* Section 3.1.
425                  * The MP_CAPABLE option is carried on the SYN, SYN/ACK, and ACK
426                  * packets that start the first subflow of an MPTCP connection,
427                  * as well as the first packet that carries data
428                  */
429                 if (data_len > 0)
430                         *size = ALIGN(TCPOLEN_MPTCP_MPC_ACK_DATA, 4);
431                 else
432                         *size = TCPOLEN_MPTCP_MPC_ACK;
433
434                 pr_debug("subflow=%p, local_key=%llu, remote_key=%llu map_len=%d",
435                          subflow, subflow->local_key, subflow->remote_key,
436                          data_len);
437
438                 return true;
439         } else if (subflow->mp_join) {
440                 opts->suboptions = OPTION_MPTCP_MPJ_ACK;
441                 memcpy(opts->hmac, subflow->hmac, MPTCPOPT_HMAC_LEN);
442                 *size = TCPOLEN_MPTCP_MPJ_ACK;
443                 pr_debug("subflow=%p", subflow);
444
445                 schedule_3rdack_retransmission(sk);
446                 return true;
447         }
448         return false;
449 }
450
451 static void mptcp_write_data_fin(struct mptcp_subflow_context *subflow,
452                                  struct sk_buff *skb, struct mptcp_ext *ext)
453 {
454         if (!ext->use_map || !skb->len) {
455                 /* RFC6824 requires a DSS mapping with specific values
456                  * if DATA_FIN is set but no data payload is mapped
457                  */
458                 ext->data_fin = 1;
459                 ext->use_map = 1;
460                 ext->dsn64 = 1;
461                 ext->data_seq = subflow->data_fin_tx_seq;
462                 ext->subflow_seq = 0;
463                 ext->data_len = 1;
464         } else if (ext->data_seq + ext->data_len == subflow->data_fin_tx_seq) {
465                 /* If there's an existing DSS mapping and it is the
466                  * final mapping, DATA_FIN consumes 1 additional byte of
467                  * mapping space.
468                  */
469                 ext->data_fin = 1;
470                 ext->data_len++;
471         }
472 }
473
474 static bool mptcp_established_options_dss(struct sock *sk, struct sk_buff *skb,
475                                           unsigned int *size,
476                                           unsigned int remaining,
477                                           struct mptcp_out_options *opts)
478 {
479         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
480         unsigned int dss_size = 0;
481         struct mptcp_ext *mpext;
482         struct mptcp_sock *msk;
483         unsigned int ack_size;
484         bool ret = false;
485         u8 tcp_fin;
486
487         if (skb) {
488                 mpext = mptcp_get_ext(skb);
489                 tcp_fin = TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN;
490         } else {
491                 mpext = NULL;
492                 tcp_fin = 0;
493         }
494
495         if (!skb || (mpext && mpext->use_map) || tcp_fin) {
496                 unsigned int map_size;
497
498                 map_size = TCPOLEN_MPTCP_DSS_BASE + TCPOLEN_MPTCP_DSS_MAP64;
499
500                 remaining -= map_size;
501                 dss_size = map_size;
502                 if (mpext)
503                         opts->ext_copy = *mpext;
504
505                 if (skb && tcp_fin && subflow->data_fin_tx_enable)
506                         mptcp_write_data_fin(subflow, skb, &opts->ext_copy);
507                 ret = true;
508         }
509
510         /* passive sockets msk will set the 'can_ack' after accept(), even
511          * if the first subflow may have the already the remote key handy
512          */
513         opts->ext_copy.use_ack = 0;
514         msk = mptcp_sk(subflow->conn);
515         if (!READ_ONCE(msk->can_ack)) {
516                 *size = ALIGN(dss_size, 4);
517                 return ret;
518         }
519
520         if (subflow->use_64bit_ack) {
521                 ack_size = TCPOLEN_MPTCP_DSS_ACK64;
522                 opts->ext_copy.data_ack = msk->ack_seq;
523                 opts->ext_copy.ack64 = 1;
524         } else {
525                 ack_size = TCPOLEN_MPTCP_DSS_ACK32;
526                 opts->ext_copy.data_ack32 = (uint32_t)(msk->ack_seq);
527                 opts->ext_copy.ack64 = 0;
528         }
529         opts->ext_copy.use_ack = 1;
530
531         /* Add kind/length/subtype/flag overhead if mapping is not populated */
532         if (dss_size == 0)
533                 ack_size += TCPOLEN_MPTCP_DSS_BASE;
534
535         dss_size += ack_size;
536
537         *size = ALIGN(dss_size, 4);
538         return true;
539 }
540
541 static u64 add_addr_generate_hmac(u64 key1, u64 key2, u8 addr_id,
542                                   struct in_addr *addr)
543 {
544         u8 hmac[SHA256_DIGEST_SIZE];
545         u8 msg[7];
546
547         msg[0] = addr_id;
548         memcpy(&msg[1], &addr->s_addr, 4);
549         msg[5] = 0;
550         msg[6] = 0;
551
552         mptcp_crypto_hmac_sha(key1, key2, msg, 7, hmac);
553
554         return get_unaligned_be64(&hmac[SHA256_DIGEST_SIZE - sizeof(u64)]);
555 }
556
557 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
558 static u64 add_addr6_generate_hmac(u64 key1, u64 key2, u8 addr_id,
559                                    struct in6_addr *addr)
560 {
561         u8 hmac[SHA256_DIGEST_SIZE];
562         u8 msg[19];
563
564         msg[0] = addr_id;
565         memcpy(&msg[1], &addr->s6_addr, 16);
566         msg[17] = 0;
567         msg[18] = 0;
568
569         mptcp_crypto_hmac_sha(key1, key2, msg, 19, hmac);
570
571         return get_unaligned_be64(&hmac[SHA256_DIGEST_SIZE - sizeof(u64)]);
572 }
573 #endif
574
575 static bool mptcp_established_options_addr(struct sock *sk,
576                                            unsigned int *size,
577                                            unsigned int remaining,
578                                            struct mptcp_out_options *opts)
579 {
580         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
581         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
582         struct mptcp_addr_info saddr;
583         int len;
584
585         if (!mptcp_pm_should_signal(msk) ||
586             !(mptcp_pm_addr_signal(msk, remaining, &saddr)))
587                 return false;
588
589         len = mptcp_add_addr_len(saddr.family);
590         if (remaining < len)
591                 return false;
592
593         *size = len;
594         opts->addr_id = saddr.id;
595         if (saddr.family == AF_INET) {
596                 opts->suboptions |= OPTION_MPTCP_ADD_ADDR;
597                 opts->addr = saddr.addr;
598                 opts->ahmac = add_addr_generate_hmac(msk->local_key,
599                                                      msk->remote_key,
600                                                      opts->addr_id,
601                                                      &opts->addr);
602         }
603 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
604         else if (saddr.family == AF_INET6) {
605                 opts->suboptions |= OPTION_MPTCP_ADD_ADDR6;
606                 opts->addr6 = saddr.addr6;
607                 opts->ahmac = add_addr6_generate_hmac(msk->local_key,
608                                                       msk->remote_key,
609                                                       opts->addr_id,
610                                                       &opts->addr6);
611         }
612 #endif
613         pr_debug("addr_id=%d, ahmac=%llu", opts->addr_id, opts->ahmac);
614
615         return true;
616 }
617
618 bool mptcp_established_options(struct sock *sk, struct sk_buff *skb,
619                                unsigned int *size, unsigned int remaining,
620                                struct mptcp_out_options *opts)
621 {
622         unsigned int opt_size = 0;
623         bool ret = false;
624
625         opts->suboptions = 0;
626
627         if (unlikely(mptcp_check_fallback(sk)))
628                 return false;
629
630         if (mptcp_established_options_mp(sk, skb, &opt_size, remaining, opts))
631                 ret = true;
632         else if (mptcp_established_options_dss(sk, skb, &opt_size, remaining,
633                                                opts))
634                 ret = true;
635
636         /* we reserved enough space for the above options, and exceeding the
637          * TCP option space would be fatal
638          */
639         if (WARN_ON_ONCE(opt_size > remaining))
640                 return false;
641
642         *size += opt_size;
643         remaining -= opt_size;
644         if (mptcp_established_options_addr(sk, &opt_size, remaining, opts)) {
645                 *size += opt_size;
646                 remaining -= opt_size;
647                 ret = true;
648         }
649
650         return ret;
651 }
652
653 bool mptcp_synack_options(const struct request_sock *req, unsigned int *size,
654                           struct mptcp_out_options *opts)
655 {
656         struct mptcp_subflow_request_sock *subflow_req = mptcp_subflow_rsk(req);
657
658         if (subflow_req->mp_capable) {
659                 opts->suboptions = OPTION_MPTCP_MPC_SYNACK;
660                 opts->sndr_key = subflow_req->local_key;
661                 *size = TCPOLEN_MPTCP_MPC_SYNACK;
662                 pr_debug("subflow_req=%p, local_key=%llu",
663                          subflow_req, subflow_req->local_key);
664                 return true;
665         } else if (subflow_req->mp_join) {
666                 opts->suboptions = OPTION_MPTCP_MPJ_SYNACK;
667                 opts->backup = subflow_req->backup;
668                 opts->join_id = subflow_req->local_id;
669                 opts->thmac = subflow_req->thmac;
670                 opts->nonce = subflow_req->local_nonce;
671                 pr_debug("req=%p, bkup=%u, id=%u, thmac=%llu, nonce=%u",
672                          subflow_req, opts->backup, opts->join_id,
673                          opts->thmac, opts->nonce);
674                 *size = TCPOLEN_MPTCP_MPJ_SYNACK;
675                 return true;
676         }
677         return false;
678 }
679
680 static bool check_fully_established(struct mptcp_sock *msk, struct sock *sk,
681                                     struct mptcp_subflow_context *subflow,
682                                     struct sk_buff *skb,
683                                     struct mptcp_options_received *mp_opt)
684 {
685         /* here we can process OoO, in-window pkts, only in-sequence 4th ack
686          * will make the subflow fully established
687          */
688         if (likely(subflow->fully_established)) {
689                 /* on passive sockets, check for 3rd ack retransmission
690                  * note that msk is always set by subflow_syn_recv_sock()
691                  * for mp_join subflows
692                  */
693                 if (TCP_SKB_CB(skb)->seq == subflow->ssn_offset + 1 &&
694                     TCP_SKB_CB(skb)->end_seq == TCP_SKB_CB(skb)->seq &&
695                     subflow->mp_join && mp_opt->mp_join &&
696                     READ_ONCE(msk->pm.server_side))
697                         tcp_send_ack(sk);
698                 goto fully_established;
699         }
700
701         /* we should process OoO packets before the first subflow is fully
702          * established, but not expected for MP_JOIN subflows
703          */
704         if (TCP_SKB_CB(skb)->seq != subflow->ssn_offset + 1)
705                 return subflow->mp_capable;
706
707         if (mp_opt->dss && mp_opt->use_ack) {
708                 /* subflows are fully established as soon as we get any
709                  * additional ack.
710                  */
711                 subflow->fully_established = 1;
712                 goto fully_established;
713         }
714
715         /* If the first established packet does not contain MP_CAPABLE + data
716          * then fallback to TCP
717          */
718         if (!mp_opt->mp_capable) {
719                 subflow->mp_capable = 0;
720                 pr_fallback(msk);
721                 __mptcp_do_fallback(msk);
722                 return false;
723         }
724
725         if (unlikely(!READ_ONCE(msk->pm.server_side)))
726                 pr_warn_once("bogus mpc option on established client sk");
727         subflow->fully_established = 1;
728         subflow->remote_key = mp_opt->sndr_key;
729         subflow->can_ack = 1;
730
731 fully_established:
732         if (likely(subflow->pm_notified))
733                 return true;
734
735         subflow->pm_notified = 1;
736         if (subflow->mp_join) {
737                 clear_3rdack_retransmission(sk);
738                 mptcp_pm_subflow_established(msk, subflow);
739         } else {
740                 mptcp_pm_fully_established(msk);
741         }
742         return true;
743 }
744
745 static u64 expand_ack(u64 old_ack, u64 cur_ack, bool use_64bit)
746 {
747         u32 old_ack32, cur_ack32;
748
749         if (use_64bit)
750                 return cur_ack;
751
752         old_ack32 = (u32)old_ack;
753         cur_ack32 = (u32)cur_ack;
754         cur_ack = (old_ack & GENMASK_ULL(63, 32)) + cur_ack32;
755         if (unlikely(before(cur_ack32, old_ack32)))
756                 return cur_ack + (1LL << 32);
757         return cur_ack;
758 }
759
760 static void update_una(struct mptcp_sock *msk,
761                        struct mptcp_options_received *mp_opt)
762 {
763         u64 new_snd_una, snd_una, old_snd_una = atomic64_read(&msk->snd_una);
764         u64 write_seq = READ_ONCE(msk->write_seq);
765
766         /* avoid ack expansion on update conflict, to reduce the risk of
767          * wrongly expanding to a future ack sequence number, which is way
768          * more dangerous than missing an ack
769          */
770         new_snd_una = expand_ack(old_snd_una, mp_opt->data_ack, mp_opt->ack64);
771
772         /* ACK for data not even sent yet? Ignore. */
773         if (after64(new_snd_una, write_seq))
774                 new_snd_una = old_snd_una;
775
776         while (after64(new_snd_una, old_snd_una)) {
777                 snd_una = old_snd_una;
778                 old_snd_una = atomic64_cmpxchg(&msk->snd_una, snd_una,
779                                                new_snd_una);
780                 if (old_snd_una == snd_una) {
781                         mptcp_data_acked((struct sock *)msk);
782                         break;
783                 }
784         }
785 }
786
787 static bool add_addr_hmac_valid(struct mptcp_sock *msk,
788                                 struct mptcp_options_received *mp_opt)
789 {
790         u64 hmac = 0;
791
792         if (mp_opt->echo)
793                 return true;
794
795         if (mp_opt->family == MPTCP_ADDR_IPVERSION_4)
796                 hmac = add_addr_generate_hmac(msk->remote_key,
797                                               msk->local_key,
798                                               mp_opt->addr_id, &mp_opt->addr);
799 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
800         else
801                 hmac = add_addr6_generate_hmac(msk->remote_key,
802                                                msk->local_key,
803                                                mp_opt->addr_id, &mp_opt->addr6);
804 #endif
805
806         pr_debug("msk=%p, ahmac=%llu, mp_opt->ahmac=%llu\n",
807                  msk, (unsigned long long)hmac,
808                  (unsigned long long)mp_opt->ahmac);
809
810         return hmac == mp_opt->ahmac;
811 }
812
813 void mptcp_incoming_options(struct sock *sk, struct sk_buff *skb,
814                             struct tcp_options_received *opt_rx)
815 {
816         struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
817         struct mptcp_sock *msk = mptcp_sk(subflow->conn);
818         struct mptcp_options_received mp_opt;
819         struct mptcp_ext *mpext;
820
821         if (__mptcp_check_fallback(msk))
822                 return;
823
824         mptcp_get_options(skb, &mp_opt);
825         if (!check_fully_established(msk, sk, subflow, skb, &mp_opt))
826                 return;
827
828         if (mp_opt.add_addr && add_addr_hmac_valid(msk, &mp_opt)) {
829                 struct mptcp_addr_info addr;
830
831                 addr.port = htons(mp_opt.port);
832                 addr.id = mp_opt.addr_id;
833                 if (mp_opt.family == MPTCP_ADDR_IPVERSION_4) {
834                         addr.family = AF_INET;
835                         addr.addr = mp_opt.addr;
836                 }
837 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
838                 else if (mp_opt.family == MPTCP_ADDR_IPVERSION_6) {
839                         addr.family = AF_INET6;
840                         addr.addr6 = mp_opt.addr6;
841                 }
842 #endif
843                 if (!mp_opt.echo)
844                         mptcp_pm_add_addr_received(msk, &addr);
845                 mp_opt.add_addr = 0;
846         }
847
848         if (!mp_opt.dss)
849                 return;
850
851         /* we can't wait for recvmsg() to update the ack_seq, otherwise
852          * monodirectional flows will stuck
853          */
854         if (mp_opt.use_ack)
855                 update_una(msk, &mp_opt);
856
857         mpext = skb_ext_add(skb, SKB_EXT_MPTCP);
858         if (!mpext)
859                 return;
860
861         memset(mpext, 0, sizeof(*mpext));
862
863         if (mp_opt.use_map) {
864                 if (mp_opt.mpc_map) {
865                         /* this is an MP_CAPABLE carrying MPTCP data
866                          * we know this map the first chunk of data
867                          */
868                         mptcp_crypto_key_sha(subflow->remote_key, NULL,
869                                              &mpext->data_seq);
870                         mpext->data_seq++;
871                         mpext->subflow_seq = 1;
872                         mpext->dsn64 = 1;
873                         mpext->mpc_map = 1;
874                         mpext->data_fin = 0;
875                 } else {
876                         mpext->data_seq = mp_opt.data_seq;
877                         mpext->subflow_seq = mp_opt.subflow_seq;
878                         mpext->dsn64 = mp_opt.dsn64;
879                         mpext->data_fin = mp_opt.data_fin;
880                 }
881                 mpext->data_len = mp_opt.data_len;
882                 mpext->use_map = 1;
883         }
884 }
885
886 void mptcp_write_options(__be32 *ptr, struct mptcp_out_options *opts)
887 {
888         if ((OPTION_MPTCP_MPC_SYN | OPTION_MPTCP_MPC_SYNACK |
889              OPTION_MPTCP_MPC_ACK) & opts->suboptions) {
890                 u8 len;
891
892                 if (OPTION_MPTCP_MPC_SYN & opts->suboptions)
893                         len = TCPOLEN_MPTCP_MPC_SYN;
894                 else if (OPTION_MPTCP_MPC_SYNACK & opts->suboptions)
895                         len = TCPOLEN_MPTCP_MPC_SYNACK;
896                 else if (opts->ext_copy.data_len)
897                         len = TCPOLEN_MPTCP_MPC_ACK_DATA;
898                 else
899                         len = TCPOLEN_MPTCP_MPC_ACK;
900
901                 *ptr++ = mptcp_option(MPTCPOPT_MP_CAPABLE, len,
902                                       MPTCP_SUPPORTED_VERSION,
903                                       MPTCP_CAP_HMAC_SHA256);
904
905                 if (!((OPTION_MPTCP_MPC_SYNACK | OPTION_MPTCP_MPC_ACK) &
906                     opts->suboptions))
907                         goto mp_capable_done;
908
909                 put_unaligned_be64(opts->sndr_key, ptr);
910                 ptr += 2;
911                 if (!((OPTION_MPTCP_MPC_ACK) & opts->suboptions))
912                         goto mp_capable_done;
913
914                 put_unaligned_be64(opts->rcvr_key, ptr);
915                 ptr += 2;
916                 if (!opts->ext_copy.data_len)
917                         goto mp_capable_done;
918
919                 put_unaligned_be32(opts->ext_copy.data_len << 16 |
920                                    TCPOPT_NOP << 8 | TCPOPT_NOP, ptr);
921                 ptr += 1;
922         }
923
924 mp_capable_done:
925         if (OPTION_MPTCP_ADD_ADDR & opts->suboptions) {
926                 if (opts->ahmac)
927                         *ptr++ = mptcp_option(MPTCPOPT_ADD_ADDR,
928                                               TCPOLEN_MPTCP_ADD_ADDR, 0,
929                                               opts->addr_id);
930                 else
931                         *ptr++ = mptcp_option(MPTCPOPT_ADD_ADDR,
932                                               TCPOLEN_MPTCP_ADD_ADDR_BASE,
933                                               MPTCP_ADDR_ECHO,
934                                               opts->addr_id);
935                 memcpy((u8 *)ptr, (u8 *)&opts->addr.s_addr, 4);
936                 ptr += 1;
937                 if (opts->ahmac) {
938                         put_unaligned_be64(opts->ahmac, ptr);
939                         ptr += 2;
940                 }
941         }
942
943 #if IS_ENABLED(CONFIG_MPTCP_IPV6)
944         if (OPTION_MPTCP_ADD_ADDR6 & opts->suboptions) {
945                 if (opts->ahmac)
946                         *ptr++ = mptcp_option(MPTCPOPT_ADD_ADDR,
947                                               TCPOLEN_MPTCP_ADD_ADDR6, 0,
948                                               opts->addr_id);
949                 else
950                         *ptr++ = mptcp_option(MPTCPOPT_ADD_ADDR,
951                                               TCPOLEN_MPTCP_ADD_ADDR6_BASE,
952                                               MPTCP_ADDR_ECHO,
953                                               opts->addr_id);
954                 memcpy((u8 *)ptr, opts->addr6.s6_addr, 16);
955                 ptr += 4;
956                 if (opts->ahmac) {
957                         put_unaligned_be64(opts->ahmac, ptr);
958                         ptr += 2;
959                 }
960         }
961 #endif
962
963         if (OPTION_MPTCP_RM_ADDR & opts->suboptions) {
964                 *ptr++ = mptcp_option(MPTCPOPT_RM_ADDR,
965                                       TCPOLEN_MPTCP_RM_ADDR_BASE,
966                                       0, opts->rm_id);
967         }
968
969         if (OPTION_MPTCP_MPJ_SYN & opts->suboptions) {
970                 *ptr++ = mptcp_option(MPTCPOPT_MP_JOIN,
971                                       TCPOLEN_MPTCP_MPJ_SYN,
972                                       opts->backup, opts->join_id);
973                 put_unaligned_be32(opts->token, ptr);
974                 ptr += 1;
975                 put_unaligned_be32(opts->nonce, ptr);
976                 ptr += 1;
977         }
978
979         if (OPTION_MPTCP_MPJ_SYNACK & opts->suboptions) {
980                 *ptr++ = mptcp_option(MPTCPOPT_MP_JOIN,
981                                       TCPOLEN_MPTCP_MPJ_SYNACK,
982                                       opts->backup, opts->join_id);
983                 put_unaligned_be64(opts->thmac, ptr);
984                 ptr += 2;
985                 put_unaligned_be32(opts->nonce, ptr);
986                 ptr += 1;
987         }
988
989         if (OPTION_MPTCP_MPJ_ACK & opts->suboptions) {
990                 *ptr++ = mptcp_option(MPTCPOPT_MP_JOIN,
991                                       TCPOLEN_MPTCP_MPJ_ACK, 0, 0);
992                 memcpy(ptr, opts->hmac, MPTCPOPT_HMAC_LEN);
993                 ptr += 5;
994         }
995
996         if (opts->ext_copy.use_ack || opts->ext_copy.use_map) {
997                 struct mptcp_ext *mpext = &opts->ext_copy;
998                 u8 len = TCPOLEN_MPTCP_DSS_BASE;
999                 u8 flags = 0;
1000
1001                 if (mpext->use_ack) {
1002                         flags = MPTCP_DSS_HAS_ACK;
1003                         if (mpext->ack64) {
1004                                 len += TCPOLEN_MPTCP_DSS_ACK64;
1005                                 flags |= MPTCP_DSS_ACK64;
1006                         } else {
1007                                 len += TCPOLEN_MPTCP_DSS_ACK32;
1008                         }
1009                 }
1010
1011                 if (mpext->use_map) {
1012                         len += TCPOLEN_MPTCP_DSS_MAP64;
1013
1014                         /* Use only 64-bit mapping flags for now, add
1015                          * support for optional 32-bit mappings later.
1016                          */
1017                         flags |= MPTCP_DSS_HAS_MAP | MPTCP_DSS_DSN64;
1018                         if (mpext->data_fin)
1019                                 flags |= MPTCP_DSS_DATA_FIN;
1020                 }
1021
1022                 *ptr++ = mptcp_option(MPTCPOPT_DSS, len, 0, flags);
1023
1024                 if (mpext->use_ack) {
1025                         if (mpext->ack64) {
1026                                 put_unaligned_be64(mpext->data_ack, ptr);
1027                                 ptr += 2;
1028                         } else {
1029                                 put_unaligned_be32(mpext->data_ack32, ptr);
1030                                 ptr += 1;
1031                         }
1032                 }
1033
1034                 if (mpext->use_map) {
1035                         put_unaligned_be64(mpext->data_seq, ptr);
1036                         ptr += 2;
1037                         put_unaligned_be32(mpext->subflow_seq, ptr);
1038                         ptr += 1;
1039                         put_unaligned_be32(mpext->data_len << 16 |
1040                                            TCPOPT_NOP << 8 | TCPOPT_NOP, ptr);
1041                 }
1042         }
1043 }