net/ipv4/syncookies.c

   1 /*
   2  *  Syncookies implementation for the Linux kernel
   3  *
   4  *  Copyright (C) 1997 Andi Kleen
   5  *  Based on ideas by D.J.Bernstein and Eric Schenk.
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License
   9  *      as published by the Free Software Foundation; either version
  10  *      2 of the License, or (at your option) any later version.
  11  */
  12
  13 #include <linux/tcp.h>
  14 #include <linux/slab.h>
  15 #include <linux/random.h>
  16 #include <linux/cryptohash.h>
  17 #include <linux/kernel.h>
  18 #include <linux/export.h>
  19 #include <net/tcp.h>
  20 #include <net/route.h>
  21
  22 extern int sysctl_tcp_syncookies;
  23
  24 static u32 syncookie_secret[2][16-4+SHA_DIGEST_WORDS] __read_mostly;
  25
  26 #define COOKIEBITS 24   /* Upper bits store count */
  27 #define COOKIEMASK (((__u32)1 << COOKIEBITS) - 1)
  28
  29 /* TCP Timestamp: 6 lowest bits of timestamp sent in the cookie SYN-ACK
  30  * stores TCP options:
  31  *
  32  * MSB                               LSB
  33  * | 31 ...   6 |  5  |  4   | 3 2 1 0 |
  34  * |  Timestamp | ECN | SACK | WScale  |
  35  *
  36  * When we receive a valid cookie-ACK, we look at the echoed tsval (if
  37  * any) to figure out which TCP options we should use for the rebuilt
  38  * connection.
  39  *
  40  * A WScale setting of '0xf' (which is an invalid scaling value)
  41  * means that original syn did not include the TCP window scaling option.
  42  */
  43 #define TS_OPT_WSCALE_MASK      0xf
  44 #define TS_OPT_SACK             BIT(4)
  45 #define TS_OPT_ECN              BIT(5)
  46 /* There is no TS_OPT_TIMESTAMP:
  47  * if ACK contains timestamp option, we already know it was
  48  * requested/supported by the syn/synack exchange.
  49  */
  50 #define TSBITS  6
  51 #define TSMASK  (((__u32)1 << TSBITS) - 1)
  52
  53 static DEFINE_PER_CPU(__u32 [16 + 5 + SHA_WORKSPACE_WORDS], ipv4_cookie_scratch);
  54
  55 static u32 cookie_hash(__be32 saddr, __be32 daddr, __be16 sport, __be16 dport,
  56                        u32 count, int c)
  57 {
  58         __u32 *tmp;
  59
  60         net_get_random_once(syncookie_secret, sizeof(syncookie_secret));
  61
  62         tmp  = this_cpu_ptr(ipv4_cookie_scratch);
  63         memcpy(tmp + 4, syncookie_secret[c], sizeof(syncookie_secret[c]));
  64         tmp[0] = (__force u32)saddr;
  65         tmp[1] = (__force u32)daddr;
  66         tmp[2] = ((__force u32)sport << 16) + (__force u32)dport;
  67         tmp[3] = count;
  68         sha_transform(tmp + 16, (__u8 *)tmp, tmp + 16 + 5);
  69
  70         return tmp[17];
  71 }
  72
  73
  74 /*
  75  * when syncookies are in effect and tcp timestamps are enabled we encode
  76  * tcp options in the lower bits of the timestamp value that will be
  77  * sent in the syn-ack.
  78  * Since subsequent timestamps use the normal tcp_time_stamp value, we
  79  * must make sure that the resulting initial timestamp is <= tcp_time_stamp.
  80  */
  81 __u32 cookie_init_timestamp(struct request_sock *req)
  82 {
  83         struct inet_request_sock *ireq;
  84         u32 ts, ts_now = tcp_time_stamp;
  85         u32 options = 0;
  86
  87         ireq = inet_rsk(req);
  88
  89         options = ireq->wscale_ok ? ireq->snd_wscale : TS_OPT_WSCALE_MASK;
  90         if (ireq->sack_ok)
  91                 options |= TS_OPT_SACK;
  92         if (ireq->ecn_ok)
  93                 options |= TS_OPT_ECN;
  94
  95         ts = ts_now & ~TSMASK;
  96         ts |= options;
  97         if (ts > ts_now) {
  98                 ts >>= TSBITS;
  99                 ts--;
 100                 ts <<= TSBITS;
 101                 ts |= options;
 102         }
 103         return ts;
 104 }
 105
 106
 107 static __u32 secure_tcp_syn_cookie(__be32 saddr, __be32 daddr, __be16 sport,
 108                                    __be16 dport, __u32 sseq, __u32 data)
 109 {
 110         /*
 111          * Compute the secure sequence number.
 112          * The output should be:
 113          *   HASH(sec1,saddr,sport,daddr,dport,sec1) + sseq + (count * 2^24)
 114          *      + (HASH(sec2,saddr,sport,daddr,dport,count,sec2) % 2^24).
 115          * Where sseq is their sequence number and count increases every
 116          * minute by 1.
 117          * As an extra hack, we add a small "data" value that encodes the
 118          * MSS into the second hash value.
 119          */
 120         u32 count = tcp_cookie_time();
 121         return (cookie_hash(saddr, daddr, sport, dport, 0, 0) +
 122                 sseq + (count << COOKIEBITS) +
 123                 ((cookie_hash(saddr, daddr, sport, dport, count, 1) + data)
 124                  & COOKIEMASK));
 125 }
 126
 127 /*
 128  * This retrieves the small "data" value from the syncookie.
 129  * If the syncookie is bad, the data returned will be out of
 130  * range.  This must be checked by the caller.
 131  *
 132  * The count value used to generate the cookie must be less than
 133  * MAX_SYNCOOKIE_AGE minutes in the past.
 134  * The return value (__u32)-1 if this test fails.
 135  */
 136 static __u32 check_tcp_syn_cookie(__u32 cookie, __be32 saddr, __be32 daddr,
 137                                   __be16 sport, __be16 dport, __u32 sseq)
 138 {
 139         u32 diff, count = tcp_cookie_time();
 140
 141         /* Strip away the layers from the cookie */
 142         cookie -= cookie_hash(saddr, daddr, sport, dport, 0, 0) + sseq;
 143
 144         /* Cookie is now reduced to (count * 2^24) ^ (hash % 2^24) */
 145         diff = (count - (cookie >> COOKIEBITS)) & ((__u32) -1 >> COOKIEBITS);
 146         if (diff >= MAX_SYNCOOKIE_AGE)
 147                 return (__u32)-1;
 148
 149         return (cookie -
 150                 cookie_hash(saddr, daddr, sport, dport, count - diff, 1))
 151                 & COOKIEMASK;   /* Leaving the data behind */
 152 }
 153
 154 /*
 155  * MSS Values are chosen based on the 2011 paper
 156  * 'An Analysis of TCP Maximum Segement Sizes' by S. Alcock and R. Nelson.
 157  * Values ..
 158  *  .. lower than 536 are rare (< 0.2%)
 159  *  .. between 537 and 1299 account for less than < 1.5% of observed values
 160  *  .. in the 1300-1349 range account for about 15 to 20% of observed mss values
 161  *  .. exceeding 1460 are very rare (< 0.04%)
 162  *
 163  *  1460 is the single most frequently announced mss value (30 to 46% depending
 164  *  on monitor location).  Table must be sorted.
 165  */
 166 static __u16 const msstab[] = {
 167         536,
 168         1300,
 169         1440,   /* 1440, 1452: PPPoE */
 170         1460,
 171 };
 172
 173 /*
 174  * Generate a syncookie.  mssp points to the mss, which is returned
 175  * rounded down to the value encoded in the cookie.
 176  */
 177 u32 __cookie_v4_init_sequence(const struct iphdr *iph, const struct tcphdr *th,
 178                               u16 *mssp)
 179 {
 180         int mssind;
 181         const __u16 mss = *mssp;
 182
 183         for (mssind = ARRAY_SIZE(msstab) - 1; mssind ; mssind--)
 184                 if (mss >= msstab[mssind])
 185                         break;
 186         *mssp = msstab[mssind];
 187
 188         return secure_tcp_syn_cookie(iph->saddr, iph->daddr,
 189                                      th->source, th->dest, ntohl(th->seq),
 190                                      mssind);
 191 }
 192 EXPORT_SYMBOL_GPL(__cookie_v4_init_sequence);
 193
 194 __u32 cookie_v4_init_sequence(const struct sk_buff *skb, __u16 *mssp)
 195 {
 196         const struct iphdr *iph = ip_hdr(skb);
 197         const struct tcphdr *th = tcp_hdr(skb);
 198
 199         return __cookie_v4_init_sequence(iph, th, mssp);
 200 }
 201
 202 /*
 203  * Check if a ack sequence number is a valid syncookie.
 204  * Return the decoded mss if it is, or 0 if not.
 205  */
 206 int __cookie_v4_check(const struct iphdr *iph, const struct tcphdr *th,
 207                       u32 cookie)
 208 {
 209         __u32 seq = ntohl(th->seq) - 1;
 210         __u32 mssind = check_tcp_syn_cookie(cookie, iph->saddr, iph->daddr,
 211                                             th->source, th->dest, seq);
 212
 213         return mssind < ARRAY_SIZE(msstab) ? msstab[mssind] : 0;
 214 }
 215 EXPORT_SYMBOL_GPL(__cookie_v4_check);
 216
 217 struct sock *tcp_get_cookie_sock(struct sock *sk, struct sk_buff *skb,
 218                                  struct request_sock *req,
 219                                  struct dst_entry *dst)
 220 {
 221         struct inet_connection_sock *icsk = inet_csk(sk);
 222         struct sock *child;
 223         bool own_req;
 224
 225         child = icsk->icsk_af_ops->syn_recv_sock(sk, skb, req, dst,
 226                                                  NULL, &own_req);
 227         if (child) {
 228                 atomic_set(&req->rsk_refcnt, 1);
 229                 sock_rps_save_rxhash(child, skb);
 230                 inet_csk_reqsk_queue_add(sk, req, child);
 231         } else {
 232                 reqsk_free(req);
 233         }
 234         return child;
 235 }
 236 EXPORT_SYMBOL(tcp_get_cookie_sock);
 237
 238 /*
 239  * when syncookies are in effect and tcp timestamps are enabled we stored
 240  * additional tcp options in the timestamp.
 241  * This extracts these options from the timestamp echo.
 242  *
 243  * return false if we decode a tcp option that is disabled
 244  * on the host.
 245  */
 246 bool cookie_timestamp_decode(struct tcp_options_received *tcp_opt)
 247 {
 248         /* echoed timestamp, lowest bits contain options */
 249         u32 options = tcp_opt->rcv_tsecr;
 250
 251         if (!tcp_opt->saw_tstamp)  {
 252                 tcp_clear_options(tcp_opt);
 253                 return true;
 254         }
 255
 256         if (!sysctl_tcp_timestamps)
 257                 return false;
 258
 259         tcp_opt->sack_ok = (options & TS_OPT_SACK) ? TCP_SACK_SEEN : 0;
 260
 261         if (tcp_opt->sack_ok && !sysctl_tcp_sack)
 262                 return false;
 263
 264         if ((options & TS_OPT_WSCALE_MASK) == TS_OPT_WSCALE_MASK)
 265                 return true; /* no window scaling */
 266
 267         tcp_opt->wscale_ok = 1;
 268         tcp_opt->snd_wscale = options & TS_OPT_WSCALE_MASK;
 269
 270         return sysctl_tcp_window_scaling != 0;
 271 }
 272 EXPORT_SYMBOL(cookie_timestamp_decode);
 273
 274 bool cookie_ecn_ok(const struct tcp_options_received *tcp_opt,
 275                    const struct net *net, const struct dst_entry *dst)
 276 {
 277         bool ecn_ok = tcp_opt->rcv_tsecr & TS_OPT_ECN;
 278
 279         if (!ecn_ok)
 280                 return false;
 281
 282         if (net->ipv4.sysctl_tcp_ecn)
 283                 return true;
 284
 285         return dst_feature(dst, RTAX_FEATURE_ECN);
 286 }
 287 EXPORT_SYMBOL(cookie_ecn_ok);
 288
 289 /* On input, sk is a listener.
 290  * Output is listener if incoming packet would not create a child
 291  *           NULL if memory could not be allocated.
 292  */
 293 struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb)
 294 {
 295         struct ip_options *opt = &TCP_SKB_CB(skb)->header.h4.opt;
 296         struct tcp_options_received tcp_opt;
 297         struct inet_request_sock *ireq;
 298         struct tcp_request_sock *treq;
 299         struct tcp_sock *tp = tcp_sk(sk);
 300         const struct tcphdr *th = tcp_hdr(skb);
 301         __u32 cookie = ntohl(th->ack_seq) - 1;
 302         struct sock *ret = sk;
 303         struct request_sock *req;
 304         int mss;
 305         struct rtable *rt;
 306         __u8 rcv_wscale;
 307         struct flowi4 fl4;
 308
 309         if (!sysctl_tcp_syncookies || !th->ack || th->rst)
 310                 goto out;
 311
 312         if (tcp_synq_no_recent_overflow(sk))
 313                 goto out;
 314
 315         mss = __cookie_v4_check(ip_hdr(skb), th, cookie);
 316         if (mss == 0) {
 317                 NET_INC_STATS_BH(sock_net(sk), LINUX_MIB_SYNCOOKIESFAILED);
 318                 goto out;
 319         }
 320
 321         NET_INC_STATS_BH(sock_net(sk), LINUX_MIB_SYNCOOKIESRECV);
 322
 323         /* check for timestamp cookie support */
 324         memset(&tcp_opt, 0, sizeof(tcp_opt));
 325         tcp_parse_options(skb, &tcp_opt, 0, NULL);
 326
 327         if (!cookie_timestamp_decode(&tcp_opt))
 328                 goto out;
 329
 330         ret = NULL;
 331         req = inet_reqsk_alloc(&tcp_request_sock_ops, sk, false); /* for safety */
 332         if (!req)
 333                 goto out;
 334
 335         ireq = inet_rsk(req);
 336         treq = tcp_rsk(req);
 337         treq->rcv_isn           = ntohl(th->seq) - 1;
 338         treq->snt_isn           = cookie;
 339         req->mss                = mss;
 340         ireq->ir_num            = ntohs(th->dest);
 341         ireq->ir_rmt_port       = th->source;
 342         sk_rcv_saddr_set(req_to_sk(req), ip_hdr(skb)->daddr);
 343         sk_daddr_set(req_to_sk(req), ip_hdr(skb)->saddr);
 344         ireq->ir_mark           = inet_request_mark(sk, skb);
 345         ireq->snd_wscale        = tcp_opt.snd_wscale;
 346         ireq->sack_ok           = tcp_opt.sack_ok;
 347         ireq->wscale_ok         = tcp_opt.wscale_ok;
 348         ireq->tstamp_ok         = tcp_opt.saw_tstamp;
 349         req->ts_recent          = tcp_opt.saw_tstamp ? tcp_opt.rcv_tsval : 0;
 350         treq->snt_synack.v64    = 0;
 351         treq->tfo_listener      = false;
 352
 353         ireq->ir_iif = inet_request_bound_dev_if(sk, skb);
 354
 355         /* We throwed the options of the initial SYN away, so we hope
 356          * the ACK carries the same options again (see RFC1122 4.2.3.8)
 357          */
 358         ireq->opt = tcp_v4_save_options(skb);
 359
 360         if (security_inet_conn_request(sk, skb, req)) {
 361                 reqsk_free(req);
 362                 goto out;
 363         }
 364
 365         req->num_retrans = 0;
 366
 367         /*
 368          * We need to lookup the route here to get at the correct
 369          * window size. We should better make sure that the window size
 370          * hasn't changed since we received the original syn, but I see
 371          * no easy way to do this.
 372          */
 373         flowi4_init_output(&fl4, ireq->ir_iif, ireq->ir_mark,
 374                            RT_CONN_FLAGS(sk), RT_SCOPE_UNIVERSE, IPPROTO_TCP,
 375                            inet_sk_flowi_flags(sk),
 376                            opt->srr ? opt->faddr : ireq->ir_rmt_addr,
 377                            ireq->ir_loc_addr, th->source, th->dest);
 378         security_req_classify_flow(req, flowi4_to_flowi(&fl4));
 379         rt = ip_route_output_key(sock_net(sk), &fl4);
 380         if (IS_ERR(rt)) {
 381                 reqsk_free(req);
 382                 goto out;
 383         }
 384
 385         /* Try to redo what tcp_v4_send_synack did. */
 386         req->rsk_window_clamp = tp->window_clamp ? :dst_metric(&rt->dst, RTAX_WINDOW);
 387
 388         tcp_select_initial_window(tcp_full_space(sk), req->mss,
 389                                   &req->rsk_rcv_wnd, &req->rsk_window_clamp,
 390                                   ireq->wscale_ok, &rcv_wscale,
 391                                   dst_metric(&rt->dst, RTAX_INITRWND));
 392
 393         ireq->rcv_wscale  = rcv_wscale;
 394         ireq->ecn_ok = cookie_ecn_ok(&tcp_opt, sock_net(sk), &rt->dst);
 395
 396         ret = tcp_get_cookie_sock(sk, skb, req, &rt->dst);
 397         /* ip_queue_xmit() depends on our flow being setup
 398          * Normal sockets get it right from inet_csk_route_child_sock()
 399          */
 400         if (ret)
 401                 inet_sk(ret)->cork.fl.u.ip4 = fl4;
 402 out:    return ret;
 403 }