net/ipv4/tcp_fastopen.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/crypto.h>
   3 #include <linux/err.h>
   4 #include <linux/init.h>
   5 #include <linux/kernel.h>
   6 #include <linux/list.h>
   7 #include <linux/tcp.h>
   8 #include <linux/rcupdate.h>
   9 #include <linux/rculist.h>
  10 #include <net/inetpeer.h>
  11 #include <net/tcp.h>
  12
  13 int sysctl_tcp_fastopen __read_mostly = TFO_CLIENT_ENABLE;
  14
  15 struct tcp_fastopen_context __rcu *tcp_fastopen_ctx;
  16
  17 static DEFINE_SPINLOCK(tcp_fastopen_ctx_lock);
  18
  19 void tcp_fastopen_init_key_once(bool publish)
  20 {
  21         static u8 key[TCP_FASTOPEN_KEY_LENGTH];
  22
  23         /* tcp_fastopen_reset_cipher publishes the new context
  24          * atomically, so we allow this race happening here.
  25          *
  26          * All call sites of tcp_fastopen_cookie_gen also check
  27          * for a valid cookie, so this is an acceptable risk.
  28          */
  29         if (net_get_random_once(key, sizeof(key)) && publish)
  30                 tcp_fastopen_reset_cipher(key, sizeof(key));
  31 }
  32
  33 static void tcp_fastopen_ctx_free(struct rcu_head *head)
  34 {
  35         struct tcp_fastopen_context *ctx =
  36             container_of(head, struct tcp_fastopen_context, rcu);
  37         crypto_free_cipher(ctx->tfm);
  38         kfree(ctx);
  39 }
  40
  41 int tcp_fastopen_reset_cipher(void *key, unsigned int len)
  42 {
  43         int err;
  44         struct tcp_fastopen_context *ctx, *octx;
  45
  46         ctx = kmalloc(sizeof(*ctx), GFP_KERNEL);
  47         if (!ctx)
  48                 return -ENOMEM;
  49         ctx->tfm = crypto_alloc_cipher("aes", 0, 0);
  50
  51         if (IS_ERR(ctx->tfm)) {
  52                 err = PTR_ERR(ctx->tfm);
  53 error:          kfree(ctx);
  54                 pr_err("TCP: TFO aes cipher alloc error: %d\n", err);
  55                 return err;
  56         }
  57         err = crypto_cipher_setkey(ctx->tfm, key, len);
  58         if (err) {
  59                 pr_err("TCP: TFO cipher key error: %d\n", err);
  60                 crypto_free_cipher(ctx->tfm);
  61                 goto error;
  62         }
  63         memcpy(ctx->key, key, len);
  64
  65         spin_lock(&tcp_fastopen_ctx_lock);
  66
  67         octx = rcu_dereference_protected(tcp_fastopen_ctx,
  68                                 lockdep_is_held(&tcp_fastopen_ctx_lock));
  69         rcu_assign_pointer(tcp_fastopen_ctx, ctx);
  70         spin_unlock(&tcp_fastopen_ctx_lock);
  71
  72         if (octx)
  73                 call_rcu(&octx->rcu, tcp_fastopen_ctx_free);
  74         return err;
  75 }
  76
  77 static bool __tcp_fastopen_cookie_gen(const void *path,
  78                                       struct tcp_fastopen_cookie *foc)
  79 {
  80         struct tcp_fastopen_context *ctx;
  81         bool ok = false;
  82
  83         rcu_read_lock();
  84         ctx = rcu_dereference(tcp_fastopen_ctx);
  85         if (ctx) {
  86                 crypto_cipher_encrypt_one(ctx->tfm, foc->val, path);
  87                 foc->len = TCP_FASTOPEN_COOKIE_SIZE;
  88                 ok = true;
  89         }
  90         rcu_read_unlock();
  91         return ok;
  92 }
  93
  94 /* Generate the fastopen cookie by doing aes128 encryption on both
  95  * the source and destination addresses. Pad 0s for IPv4 or IPv4-mapped-IPv6
  96  * addresses. For the longer IPv6 addresses use CBC-MAC.
  97  *
  98  * XXX (TFO) - refactor when TCP_FASTOPEN_COOKIE_SIZE != AES_BLOCK_SIZE.
  99  */
 100 static bool tcp_fastopen_cookie_gen(struct request_sock *req,
 101                                     struct sk_buff *syn,
 102                                     struct tcp_fastopen_cookie *foc)
 103 {
 104         if (req->rsk_ops->family == AF_INET) {
 105                 const struct iphdr *iph = ip_hdr(syn);
 106
 107                 __be32 path[4] = { iph->saddr, iph->daddr, 0, 0 };
 108                 return __tcp_fastopen_cookie_gen(path, foc);
 109         }
 110
 111 #if IS_ENABLED(CONFIG_IPV6)
 112         if (req->rsk_ops->family == AF_INET6) {
 113                 const struct ipv6hdr *ip6h = ipv6_hdr(syn);
 114                 struct tcp_fastopen_cookie tmp;
 115
 116                 if (__tcp_fastopen_cookie_gen(&ip6h->saddr, &tmp)) {
 117                         struct in6_addr *buf = &tmp.addr;
 118                         int i;
 119
 120                         for (i = 0; i < 4; i++)
 121                                 buf->s6_addr32[i] ^= ip6h->daddr.s6_addr32[i];
 122                         return __tcp_fastopen_cookie_gen(buf, foc);
 123                 }
 124         }
 125 #endif
 126         return false;
 127 }
 128
 129
 130 /* If an incoming SYN or SYNACK frame contains a payload and/or FIN,
 131  * queue this additional data / FIN.
 132  */
 133 void tcp_fastopen_add_skb(struct sock *sk, struct sk_buff *skb)
 134 {
 135         struct tcp_sock *tp = tcp_sk(sk);
 136
 137         if (TCP_SKB_CB(skb)->end_seq == tp->rcv_nxt)
 138                 return;
 139
 140         skb = skb_clone(skb, GFP_ATOMIC);
 141         if (!skb)
 142                 return;
 143
 144         skb_dst_drop(skb);
 145         /* segs_in has been initialized to 1 in tcp_create_openreq_child().
 146          * Hence, reset segs_in to 0 before calling tcp_segs_in()
 147          * to avoid double counting.  Also, tcp_segs_in() expects
 148          * skb->len to include the tcp_hdrlen.  Hence, it should
 149          * be called before __skb_pull().
 150          */
 151         tp->segs_in = 0;
 152         tcp_segs_in(tp, skb);
 153         __skb_pull(skb, tcp_hdrlen(skb));
 154         sk_forced_mem_schedule(sk, skb->truesize);
 155         skb_set_owner_r(skb, sk);
 156
 157         TCP_SKB_CB(skb)->seq++;
 158         TCP_SKB_CB(skb)->tcp_flags &= ~TCPHDR_SYN;
 159
 160         tp->rcv_nxt = TCP_SKB_CB(skb)->end_seq;
 161         __skb_queue_tail(&sk->sk_receive_queue, skb);
 162         tp->syn_data_acked = 1;
 163
 164         /* u64_stats_update_begin(&tp->syncp) not needed here,
 165          * as we certainly are not changing upper 32bit value (0)
 166          */
 167         tp->bytes_received = skb->len;
 168
 169         if (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN)
 170                 tcp_fin(sk);
 171 }
 172
 173 static struct sock *tcp_fastopen_create_child(struct sock *sk,
 174                                               struct sk_buff *skb,
 175                                               struct request_sock *req)
 176 {
 177         struct tcp_sock *tp;
 178         struct request_sock_queue *queue = &inet_csk(sk)->icsk_accept_queue;
 179         struct sock *child;
 180         bool own_req;
 181
 182         req->num_retrans = 0;
 183         req->num_timeout = 0;
 184         req->sk = NULL;
 185
 186         child = inet_csk(sk)->icsk_af_ops->syn_recv_sock(sk, skb, req, NULL,
 187                                                          NULL, &own_req);
 188         if (!child)
 189                 return NULL;
 190
 191         spin_lock(&queue->fastopenq.lock);
 192         queue->fastopenq.qlen++;
 193         spin_unlock(&queue->fastopenq.lock);
 194
 195         /* Initialize the child socket. Have to fix some values to take
 196          * into account the child is a Fast Open socket and is created
 197          * only out of the bits carried in the SYN packet.
 198          */
 199         tp = tcp_sk(child);
 200
 201         tp->fastopen_rsk = req;
 202         tcp_rsk(req)->tfo_listener = true;
 203
 204         /* RFC1323: The window in SYN & SYN/ACK segments is never
 205          * scaled. So correct it appropriately.
 206          */
 207         tp->snd_wnd = ntohs(tcp_hdr(skb)->window);
 208         tp->max_window = tp->snd_wnd;
 209
 210         /* Activate the retrans timer so that SYNACK can be retransmitted.
 211          * The request socket is not added to the ehash
 212          * because it's been added to the accept queue directly.
 213          */
 214         inet_csk_reset_xmit_timer(child, ICSK_TIME_RETRANS,
 215                                   TCP_TIMEOUT_INIT, TCP_RTO_MAX);
 216
 217         refcount_set(&req->rsk_refcnt, 2);
 218
 219         /* Now finish processing the fastopen child socket. */
 220         inet_csk(child)->icsk_af_ops->rebuild_header(child);
 221         tcp_init_congestion_control(child);
 222         tcp_mtup_init(child);
 223         tcp_init_metrics(child);
 224         tcp_call_bpf(child, BPF_SOCK_OPS_PASSIVE_ESTABLISHED_CB);
 225         tcp_init_buffer_space(child);
 226
 227         tp->rcv_nxt = TCP_SKB_CB(skb)->seq + 1;
 228
 229         tcp_fastopen_add_skb(child, skb);
 230
 231         tcp_rsk(req)->rcv_nxt = tp->rcv_nxt;
 232         tp->rcv_wup = tp->rcv_nxt;
 233         /* tcp_conn_request() is sending the SYNACK,
 234          * and queues the child into listener accept queue.
 235          */
 236         return child;
 237 }
 238
 239 static bool tcp_fastopen_queue_check(struct sock *sk)
 240 {
 241         struct fastopen_queue *fastopenq;
 242         int max_qlen;
 243
 244         /* Make sure the listener has enabled fastopen, and we don't
 245          * exceed the max # of pending TFO requests allowed before trying
 246          * to validating the cookie in order to avoid burning CPU cycles
 247          * unnecessarily.
 248          *
 249          * XXX (TFO) - The implication of checking the max_qlen before
 250          * processing a cookie request is that clients can't differentiate
 251          * between qlen overflow causing Fast Open to be disabled
 252          * temporarily vs a server not supporting Fast Open at all.
 253          */
 254         fastopenq = &inet_csk(sk)->icsk_accept_queue.fastopenq;
 255         max_qlen = READ_ONCE(fastopenq->max_qlen);
 256         if (max_qlen == 0)
 257                 return false;
 258
 259         if (fastopenq->qlen >= max_qlen) {
 260                 struct request_sock *req1;
 261                 spin_lock(&fastopenq->lock);
 262                 req1 = fastopenq->rskq_rst_head;
 263                 if (!req1 || time_after(req1->rsk_timer.expires, jiffies)) {
 264                         __NET_INC_STATS(sock_net(sk),
 265                                         LINUX_MIB_TCPFASTOPENLISTENOVERFLOW);
 266                         spin_unlock(&fastopenq->lock);
 267                         return false;
 268                 }
 269                 fastopenq->rskq_rst_head = req1->dl_next;
 270                 fastopenq->qlen--;
 271                 spin_unlock(&fastopenq->lock);
 272                 reqsk_put(req1);
 273         }
 274         return true;
 275 }
 276
 277 /* Returns true if we should perform Fast Open on the SYN. The cookie (foc)
 278  * may be updated and return the client in the SYN-ACK later. E.g., Fast Open
 279  * cookie request (foc->len == 0).
 280  */
 281 struct sock *tcp_try_fastopen(struct sock *sk, struct sk_buff *skb,
 282                               struct request_sock *req,
 283                               struct tcp_fastopen_cookie *foc)
 284 {
 285         struct tcp_fastopen_cookie valid_foc = { .len = -1 };
 286         bool syn_data = TCP_SKB_CB(skb)->end_seq != TCP_SKB_CB(skb)->seq + 1;
 287         struct sock *child;
 288
 289         if (foc->len == 0) /* Client requests a cookie */
 290                 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPFASTOPENCOOKIEREQD);
 291
 292         if (!((sysctl_tcp_fastopen & TFO_SERVER_ENABLE) &&
 293               (syn_data || foc->len >= 0) &&
 294               tcp_fastopen_queue_check(sk))) {
 295                 foc->len = -1;
 296                 return NULL;
 297         }
 298
 299         if (syn_data && (sysctl_tcp_fastopen & TFO_SERVER_COOKIE_NOT_REQD))
 300                 goto fastopen;
 301
 302         if (foc->len >= 0 &&  /* Client presents or requests a cookie */
 303             tcp_fastopen_cookie_gen(req, skb, &valid_foc) &&
 304             foc->len == TCP_FASTOPEN_COOKIE_SIZE &&
 305             foc->len == valid_foc.len &&
 306             !memcmp(foc->val, valid_foc.val, foc->len)) {
 307                 /* Cookie is valid. Create a (full) child socket to accept
 308                  * the data in SYN before returning a SYN-ACK to ack the
 309                  * data. If we fail to create the socket, fall back and
 310                  * ack the ISN only but includes the same cookie.
 311                  *
 312                  * Note: Data-less SYN with valid cookie is allowed to send
 313                  * data in SYN_RECV state.
 314                  */
 315 fastopen:
 316                 child = tcp_fastopen_create_child(sk, skb, req);
 317                 if (child) {
 318                         foc->len = -1;
 319                         NET_INC_STATS(sock_net(sk),
 320                                       LINUX_MIB_TCPFASTOPENPASSIVE);
 321                         return child;
 322                 }
 323                 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPFASTOPENPASSIVEFAIL);
 324         } else if (foc->len > 0) /* Client presents an invalid cookie */
 325                 NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPFASTOPENPASSIVEFAIL);
 326
 327         valid_foc.exp = foc->exp;
 328         *foc = valid_foc;
 329         return NULL;
 330 }
 331
 332 bool tcp_fastopen_cookie_check(struct sock *sk, u16 *mss,
 333                                struct tcp_fastopen_cookie *cookie)
 334 {
 335         unsigned long last_syn_loss = 0;
 336         int syn_loss = 0;
 337
 338         tcp_fastopen_cache_get(sk, mss, cookie, &syn_loss, &last_syn_loss);
 339
 340         /* Recurring FO SYN losses: no cookie or data in SYN */
 341         if (syn_loss > 1 &&
 342             time_before(jiffies, last_syn_loss + (60*HZ << syn_loss))) {
 343                 cookie->len = -1;
 344                 return false;
 345         }
 346
 347         /* Firewall blackhole issue check */
 348         if (tcp_fastopen_active_should_disable(sk)) {
 349                 cookie->len = -1;
 350                 return false;
 351         }
 352
 353         if (sysctl_tcp_fastopen & TFO_CLIENT_NO_COOKIE) {
 354                 cookie->len = -1;
 355                 return true;
 356         }
 357         return cookie->len > 0;
 358 }
 359
 360 /* This function checks if we want to defer sending SYN until the first
 361  * write().  We defer under the following conditions:
 362  * 1. fastopen_connect sockopt is set
 363  * 2. we have a valid cookie
 364  * Return value: return true if we want to defer until application writes data
 365  *               return false if we want to send out SYN immediately
 366  */
 367 bool tcp_fastopen_defer_connect(struct sock *sk, int *err)
 368 {
 369         struct tcp_fastopen_cookie cookie = { .len = 0 };
 370         struct tcp_sock *tp = tcp_sk(sk);
 371         u16 mss;
 372
 373         if (tp->fastopen_connect && !tp->fastopen_req) {
 374                 if (tcp_fastopen_cookie_check(sk, &mss, &cookie)) {
 375                         inet_sk(sk)->defer_connect = 1;
 376                         return true;
 377                 }
 378
 379                 /* Alloc fastopen_req in order for FO option to be included
 380                  * in SYN
 381                  */
 382                 tp->fastopen_req = kzalloc(sizeof(*tp->fastopen_req),
 383                                            sk->sk_allocation);
 384                 if (tp->fastopen_req)
 385                         tp->fastopen_req->cookie = cookie;
 386                 else
 387                         *err = -ENOBUFS;
 388         }
 389         return false;
 390 }
 391 EXPORT_SYMBOL(tcp_fastopen_defer_connect);
 392
 393 /*
 394  * The following code block is to deal with middle box issues with TFO:
 395  * Middlebox firewall issues can potentially cause server's data being
 396  * blackholed after a successful 3WHS using TFO.
 397  * The proposed solution is to disable active TFO globally under the
 398  * following circumstances:
 399  *   1. client side TFO socket receives out of order FIN
 400  *   2. client side TFO socket receives out of order RST
 401  * We disable active side TFO globally for 1hr at first. Then if it
 402  * happens again, we disable it for 2h, then 4h, 8h, ...
 403  * And we reset the timeout back to 1hr when we see a successful active
 404  * TFO connection with data exchanges.
 405  */
 406
 407 /* Default to 1hr */
 408 unsigned int sysctl_tcp_fastopen_blackhole_timeout __read_mostly = 60 * 60;
 409 static atomic_t tfo_active_disable_times __read_mostly = ATOMIC_INIT(0);
 410 static unsigned long tfo_active_disable_stamp __read_mostly;
 411
 412 /* Disable active TFO and record current jiffies and
 413  * tfo_active_disable_times
 414  */
 415 void tcp_fastopen_active_disable(struct sock *sk)
 416 {
 417         atomic_inc(&tfo_active_disable_times);
 418         tfo_active_disable_stamp = jiffies;
 419         NET_INC_STATS(sock_net(sk), LINUX_MIB_TCPFASTOPENBLACKHOLE);
 420 }
 421
 422 /* Reset tfo_active_disable_times to 0 */
 423 void tcp_fastopen_active_timeout_reset(void)
 424 {
 425         atomic_set(&tfo_active_disable_times, 0);
 426 }
 427
 428 /* Calculate timeout for tfo active disable
 429  * Return true if we are still in the active TFO disable period
 430  * Return false if timeout already expired and we should use active TFO
 431  */
 432 bool tcp_fastopen_active_should_disable(struct sock *sk)
 433 {
 434         int tfo_da_times = atomic_read(&tfo_active_disable_times);
 435         int multiplier;
 436         unsigned long timeout;
 437
 438         if (!tfo_da_times)
 439                 return false;
 440
 441         /* Limit timout to max: 2^6 * initial timeout */
 442         multiplier = 1 << min(tfo_da_times - 1, 6);
 443         timeout = multiplier * sysctl_tcp_fastopen_blackhole_timeout * HZ;
 444         if (time_before(jiffies, tfo_active_disable_stamp + timeout))
 445                 return true;
 446
 447         /* Mark check bit so we can check for successful active TFO
 448          * condition and reset tfo_active_disable_times
 449          */
 450         tcp_sk(sk)->syn_fastopen_ch = 1;
 451         return false;
 452 }
 453
 454 /* Disable active TFO if FIN is the only packet in the ofo queue
 455  * and no data is received.
 456  * Also check if we can reset tfo_active_disable_times if data is
 457  * received successfully on a marked active TFO sockets opened on
 458  * a non-loopback interface
 459  */
 460 void tcp_fastopen_active_disable_ofo_check(struct sock *sk)
 461 {
 462         struct tcp_sock *tp = tcp_sk(sk);
 463         struct dst_entry *dst;
 464         struct sk_buff *skb;
 465
 466         if (!tp->syn_fastopen)
 467                 return;
 468
 469         if (!tp->data_segs_in) {
 470                 skb = skb_rb_first(&tp->out_of_order_queue);
 471                 if (skb && !skb_rb_next(skb)) {
 472                         if (TCP_SKB_CB(skb)->tcp_flags & TCPHDR_FIN) {
 473                                 tcp_fastopen_active_disable(sk);
 474                                 return;
 475                         }
 476                 }
 477         } else if (tp->syn_fastopen_ch &&
 478                    atomic_read(&tfo_active_disable_times)) {
 479                 dst = sk_dst_get(sk);
 480                 if (!(dst && dst->dev && (dst->dev->flags & IFF_LOOPBACK)))
 481                         tcp_fastopen_active_timeout_reset();
 482                 dst_release(dst);
 483         }
 484 }