2 * Syncookies implementation for the Linux kernel
4 * Copyright (C) 1997 Andi Kleen
5 * Based on ideas by D.J.Bernstein and Eric Schenk.
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.
13 #include <linux/tcp.h>
14 #include <linux/slab.h>
15 #include <linux/random.h>
16 #include <linux/siphash.h>
17 #include <linux/kernel.h>
18 #include <linux/export.h>
19 #include <net/secure_seq.h>
21 #include <net/route.h>
23 static siphash_key_t syncookie_secret
[2] __read_mostly
;
25 #define COOKIEBITS 24 /* Upper bits store count */
26 #define COOKIEMASK (((__u32)1 << COOKIEBITS) - 1)
28 /* TCP Timestamp: 6 lowest bits of timestamp sent in the cookie SYN-ACK
32 * | 31 ... 6 | 5 | 4 | 3 2 1 0 |
33 * | Timestamp | ECN | SACK | WScale |
35 * When we receive a valid cookie-ACK, we look at the echoed tsval (if
36 * any) to figure out which TCP options we should use for the rebuilt
39 * A WScale setting of '0xf' (which is an invalid scaling value)
40 * means that original syn did not include the TCP window scaling option.
42 #define TS_OPT_WSCALE_MASK 0xf
43 #define TS_OPT_SACK BIT(4)
44 #define TS_OPT_ECN BIT(5)
45 /* There is no TS_OPT_TIMESTAMP:
46 * if ACK contains timestamp option, we already know it was
47 * requested/supported by the syn/synack exchange.
50 #define TSMASK (((__u32)1 << TSBITS) - 1)
52 static u32
cookie_hash(__be32 saddr
, __be32 daddr
, __be16 sport
, __be16 dport
,
55 net_get_random_once(syncookie_secret
, sizeof(syncookie_secret
));
56 return siphash_4u32((__force u32
)saddr
, (__force u32
)daddr
,
57 (__force u32
)sport
<< 16 | (__force u32
)dport
,
58 count
, &syncookie_secret
[c
]);
63 * when syncookies are in effect and tcp timestamps are enabled we encode
64 * tcp options in the lower bits of the timestamp value that will be
65 * sent in the syn-ack.
66 * Since subsequent timestamps use the normal tcp_time_stamp value, we
67 * must make sure that the resulting initial timestamp is <= tcp_time_stamp.
69 u64
cookie_init_timestamp(struct request_sock
*req
)
71 struct inet_request_sock
*ireq
;
72 u32 ts
, ts_now
= tcp_time_stamp_raw();
77 options
= ireq
->wscale_ok
? ireq
->snd_wscale
: TS_OPT_WSCALE_MASK
;
79 options
|= TS_OPT_SACK
;
81 options
|= TS_OPT_ECN
;
83 ts
= ts_now
& ~TSMASK
;
91 return (u64
)ts
* (USEC_PER_SEC
/ TCP_TS_HZ
);
95 static __u32
secure_tcp_syn_cookie(__be32 saddr
, __be32 daddr
, __be16 sport
,
96 __be16 dport
, __u32 sseq
, __u32 data
)
99 * Compute the secure sequence number.
100 * The output should be:
101 * HASH(sec1,saddr,sport,daddr,dport,sec1) + sseq + (count * 2^24)
102 * + (HASH(sec2,saddr,sport,daddr,dport,count,sec2) % 2^24).
103 * Where sseq is their sequence number and count increases every
105 * As an extra hack, we add a small "data" value that encodes the
106 * MSS into the second hash value.
108 u32 count
= tcp_cookie_time();
109 return (cookie_hash(saddr
, daddr
, sport
, dport
, 0, 0) +
110 sseq
+ (count
<< COOKIEBITS
) +
111 ((cookie_hash(saddr
, daddr
, sport
, dport
, count
, 1) + data
)
116 * This retrieves the small "data" value from the syncookie.
117 * If the syncookie is bad, the data returned will be out of
118 * range. This must be checked by the caller.
120 * The count value used to generate the cookie must be less than
121 * MAX_SYNCOOKIE_AGE minutes in the past.
122 * The return value (__u32)-1 if this test fails.
124 static __u32
check_tcp_syn_cookie(__u32 cookie
, __be32 saddr
, __be32 daddr
,
125 __be16 sport
, __be16 dport
, __u32 sseq
)
127 u32 diff
, count
= tcp_cookie_time();
129 /* Strip away the layers from the cookie */
130 cookie
-= cookie_hash(saddr
, daddr
, sport
, dport
, 0, 0) + sseq
;
132 /* Cookie is now reduced to (count * 2^24) ^ (hash % 2^24) */
133 diff
= (count
- (cookie
>> COOKIEBITS
)) & ((__u32
) -1 >> COOKIEBITS
);
134 if (diff
>= MAX_SYNCOOKIE_AGE
)
138 cookie_hash(saddr
, daddr
, sport
, dport
, count
- diff
, 1))
139 & COOKIEMASK
; /* Leaving the data behind */
143 * MSS Values are chosen based on the 2011 paper
144 * 'An Analysis of TCP Maximum Segement Sizes' by S. Alcock and R. Nelson.
146 * .. lower than 536 are rare (< 0.2%)
147 * .. between 537 and 1299 account for less than < 1.5% of observed values
148 * .. in the 1300-1349 range account for about 15 to 20% of observed mss values
149 * .. exceeding 1460 are very rare (< 0.04%)
151 * 1460 is the single most frequently announced mss value (30 to 46% depending
152 * on monitor location). Table must be sorted.
154 static __u16
const msstab
[] = {
157 1440, /* 1440, 1452: PPPoE */
162 * Generate a syncookie. mssp points to the mss, which is returned
163 * rounded down to the value encoded in the cookie.
165 u32
__cookie_v4_init_sequence(const struct iphdr
*iph
, const struct tcphdr
*th
,
169 const __u16 mss
= *mssp
;
171 for (mssind
= ARRAY_SIZE(msstab
) - 1; mssind
; mssind
--)
172 if (mss
>= msstab
[mssind
])
174 *mssp
= msstab
[mssind
];
176 return secure_tcp_syn_cookie(iph
->saddr
, iph
->daddr
,
177 th
->source
, th
->dest
, ntohl(th
->seq
),
180 EXPORT_SYMBOL_GPL(__cookie_v4_init_sequence
);
182 __u32
cookie_v4_init_sequence(const struct sk_buff
*skb
, __u16
*mssp
)
184 const struct iphdr
*iph
= ip_hdr(skb
);
185 const struct tcphdr
*th
= tcp_hdr(skb
);
187 return __cookie_v4_init_sequence(iph
, th
, mssp
);
191 * Check if a ack sequence number is a valid syncookie.
192 * Return the decoded mss if it is, or 0 if not.
194 int __cookie_v4_check(const struct iphdr
*iph
, const struct tcphdr
*th
,
197 __u32 seq
= ntohl(th
->seq
) - 1;
198 __u32 mssind
= check_tcp_syn_cookie(cookie
, iph
->saddr
, iph
->daddr
,
199 th
->source
, th
->dest
, seq
);
201 return mssind
< ARRAY_SIZE(msstab
) ? msstab
[mssind
] : 0;
203 EXPORT_SYMBOL_GPL(__cookie_v4_check
);
205 struct sock
*tcp_get_cookie_sock(struct sock
*sk
, struct sk_buff
*skb
,
206 struct request_sock
*req
,
207 struct dst_entry
*dst
, u32 tsoff
)
209 struct inet_connection_sock
*icsk
= inet_csk(sk
);
213 child
= icsk
->icsk_af_ops
->syn_recv_sock(sk
, skb
, req
, dst
,
216 refcount_set(&req
->rsk_refcnt
, 1);
217 tcp_sk(child
)->tsoffset
= tsoff
;
218 sock_rps_save_rxhash(child
, skb
);
219 inet_csk_reqsk_queue_add(sk
, req
, child
);
225 EXPORT_SYMBOL(tcp_get_cookie_sock
);
228 * when syncookies are in effect and tcp timestamps are enabled we stored
229 * additional tcp options in the timestamp.
230 * This extracts these options from the timestamp echo.
232 * return false if we decode a tcp option that is disabled
235 bool cookie_timestamp_decode(const struct net
*net
,
236 struct tcp_options_received
*tcp_opt
)
238 /* echoed timestamp, lowest bits contain options */
239 u32 options
= tcp_opt
->rcv_tsecr
;
241 if (!tcp_opt
->saw_tstamp
) {
242 tcp_clear_options(tcp_opt
);
246 if (!net
->ipv4
.sysctl_tcp_timestamps
)
249 tcp_opt
->sack_ok
= (options
& TS_OPT_SACK
) ? TCP_SACK_SEEN
: 0;
251 if (tcp_opt
->sack_ok
&& !net
->ipv4
.sysctl_tcp_sack
)
254 if ((options
& TS_OPT_WSCALE_MASK
) == TS_OPT_WSCALE_MASK
)
255 return true; /* no window scaling */
257 tcp_opt
->wscale_ok
= 1;
258 tcp_opt
->snd_wscale
= options
& TS_OPT_WSCALE_MASK
;
260 return net
->ipv4
.sysctl_tcp_window_scaling
!= 0;
262 EXPORT_SYMBOL(cookie_timestamp_decode
);
264 bool cookie_ecn_ok(const struct tcp_options_received
*tcp_opt
,
265 const struct net
*net
, const struct dst_entry
*dst
)
267 bool ecn_ok
= tcp_opt
->rcv_tsecr
& TS_OPT_ECN
;
272 if (net
->ipv4
.sysctl_tcp_ecn
)
275 return dst_feature(dst
, RTAX_FEATURE_ECN
);
277 EXPORT_SYMBOL(cookie_ecn_ok
);
279 /* On input, sk is a listener.
280 * Output is listener if incoming packet would not create a child
281 * NULL if memory could not be allocated.
283 struct sock
*cookie_v4_check(struct sock
*sk
, struct sk_buff
*skb
)
285 struct ip_options
*opt
= &TCP_SKB_CB(skb
)->header
.h4
.opt
;
286 struct tcp_options_received tcp_opt
;
287 struct inet_request_sock
*ireq
;
288 struct tcp_request_sock
*treq
;
289 struct tcp_sock
*tp
= tcp_sk(sk
);
290 const struct tcphdr
*th
= tcp_hdr(skb
);
291 __u32 cookie
= ntohl(th
->ack_seq
) - 1;
292 struct sock
*ret
= sk
;
293 struct request_sock
*req
;
300 if (!sock_net(sk
)->ipv4
.sysctl_tcp_syncookies
|| !th
->ack
|| th
->rst
)
303 if (tcp_synq_no_recent_overflow(sk
))
306 mss
= __cookie_v4_check(ip_hdr(skb
), th
, cookie
);
308 __NET_INC_STATS(sock_net(sk
), LINUX_MIB_SYNCOOKIESFAILED
);
312 __NET_INC_STATS(sock_net(sk
), LINUX_MIB_SYNCOOKIESRECV
);
314 /* check for timestamp cookie support */
315 memset(&tcp_opt
, 0, sizeof(tcp_opt
));
316 tcp_parse_options(sock_net(sk
), skb
, &tcp_opt
, 0, NULL
);
318 if (tcp_opt
.saw_tstamp
&& tcp_opt
.rcv_tsecr
) {
319 tsoff
= secure_tcp_ts_off(sock_net(sk
),
322 tcp_opt
.rcv_tsecr
-= tsoff
;
325 if (!cookie_timestamp_decode(sock_net(sk
), &tcp_opt
))
329 req
= inet_reqsk_alloc(&tcp_request_sock_ops
, sk
, false); /* for safety */
333 ireq
= inet_rsk(req
);
335 treq
->rcv_isn
= ntohl(th
->seq
) - 1;
336 treq
->snt_isn
= cookie
;
338 treq
->txhash
= net_tx_rndhash();
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
= 0;
351 treq
->tfo_listener
= false;
352 if (IS_ENABLED(CONFIG_SMC
))
355 ireq
->ir_iif
= inet_request_bound_dev_if(sk
, skb
);
357 /* We throwed the options of the initial SYN away, so we hope
358 * the ACK carries the same options again (see RFC1122 4.2.3.8)
360 RCU_INIT_POINTER(ireq
->ireq_opt
, tcp_v4_save_options(sock_net(sk
), skb
));
362 if (security_inet_conn_request(sk
, skb
, req
)) {
367 req
->num_retrans
= 0;
370 * We need to lookup the route here to get at the correct
371 * window size. We should better make sure that the window size
372 * hasn't changed since we received the original syn, but I see
373 * no easy way to do this.
375 flowi4_init_output(&fl4
, ireq
->ir_iif
, ireq
->ir_mark
,
376 RT_CONN_FLAGS(sk
), RT_SCOPE_UNIVERSE
, IPPROTO_TCP
,
377 inet_sk_flowi_flags(sk
),
378 opt
->srr
? opt
->faddr
: ireq
->ir_rmt_addr
,
379 ireq
->ir_loc_addr
, th
->source
, th
->dest
, sk
->sk_uid
);
380 security_req_classify_flow(req
, flowi4_to_flowi(&fl4
));
381 rt
= ip_route_output_key(sock_net(sk
), &fl4
);
387 /* Try to redo what tcp_v4_send_synack did. */
388 req
->rsk_window_clamp
= tp
->window_clamp
? :dst_metric(&rt
->dst
, RTAX_WINDOW
);
390 tcp_select_initial_window(sk
, tcp_full_space(sk
), req
->mss
,
391 &req
->rsk_rcv_wnd
, &req
->rsk_window_clamp
,
392 ireq
->wscale_ok
, &rcv_wscale
,
393 dst_metric(&rt
->dst
, RTAX_INITRWND
));
395 ireq
->rcv_wscale
= rcv_wscale
;
396 ireq
->ecn_ok
= cookie_ecn_ok(&tcp_opt
, sock_net(sk
), &rt
->dst
);
398 ret
= tcp_get_cookie_sock(sk
, skb
, req
, &rt
->dst
, tsoff
);
399 /* ip_queue_xmit() depends on our flow being setup
400 * Normal sockets get it right from inet_csk_route_child_sock()
403 inet_sk(ret
)->cork
.fl
.u
.ip4
= fl4
;