Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Syncookies implementation for the Linux kernel | |
3 | * | |
4 | * Copyright (C) 1997 Andi Kleen | |
e905a9ed | 5 | * Based on ideas by D.J.Bernstein and Eric Schenk. |
1da177e4 LT |
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. | |
1da177e4 LT |
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 <net/tcp.h> | |
86b08d86 | 19 | #include <net/route.h> |
1da177e4 | 20 | |
734f614b | 21 | /* Timestamps: lowest bits store TCP options */ |
172d69e6 | 22 | #define TSBITS 6 |
4dfc2817 FW |
23 | #define TSMASK (((__u32)1 << TSBITS) - 1) |
24 | ||
1da177e4 LT |
25 | extern int sysctl_tcp_syncookies; |
26 | ||
2051f11f | 27 | __u32 syncookie_secret[2][16-4+SHA_DIGEST_WORDS]; |
c6aefafb | 28 | EXPORT_SYMBOL(syncookie_secret); |
1da177e4 LT |
29 | |
30 | static __init int init_syncookies(void) | |
31 | { | |
32 | get_random_bytes(syncookie_secret, sizeof(syncookie_secret)); | |
33 | return 0; | |
34 | } | |
c6aefafb | 35 | __initcall(init_syncookies); |
1da177e4 LT |
36 | |
37 | #define COOKIEBITS 24 /* Upper bits store count */ | |
38 | #define COOKIEMASK (((__u32)1 << COOKIEBITS) - 1) | |
39 | ||
245b2e70 TH |
40 | static DEFINE_PER_CPU(__u32 [16 + 5 + SHA_WORKSPACE_WORDS], |
41 | ipv4_cookie_scratch); | |
11baab7a | 42 | |
714e85be | 43 | static u32 cookie_hash(__be32 saddr, __be32 daddr, __be16 sport, __be16 dport, |
1da177e4 LT |
44 | u32 count, int c) |
45 | { | |
245b2e70 | 46 | __u32 *tmp = __get_cpu_var(ipv4_cookie_scratch); |
1da177e4 | 47 | |
2051f11f | 48 | memcpy(tmp + 4, syncookie_secret[c], sizeof(syncookie_secret[c])); |
714e85be AV |
49 | tmp[0] = (__force u32)saddr; |
50 | tmp[1] = (__force u32)daddr; | |
51 | tmp[2] = ((__force u32)sport << 16) + (__force u32)dport; | |
1da177e4 LT |
52 | tmp[3] = count; |
53 | sha_transform(tmp + 16, (__u8 *)tmp, tmp + 16 + 5); | |
54 | ||
55 | return tmp[17]; | |
56 | } | |
57 | ||
4dfc2817 FW |
58 | |
59 | /* | |
60 | * when syncookies are in effect and tcp timestamps are enabled we encode | |
734f614b | 61 | * tcp options in the lower bits of the timestamp value that will be |
4dfc2817 FW |
62 | * sent in the syn-ack. |
63 | * Since subsequent timestamps use the normal tcp_time_stamp value, we | |
64 | * must make sure that the resulting initial timestamp is <= tcp_time_stamp. | |
65 | */ | |
66 | __u32 cookie_init_timestamp(struct request_sock *req) | |
67 | { | |
68 | struct inet_request_sock *ireq; | |
69 | u32 ts, ts_now = tcp_time_stamp; | |
70 | u32 options = 0; | |
71 | ||
72 | ireq = inet_rsk(req); | |
734f614b FW |
73 | |
74 | options = ireq->wscale_ok ? ireq->snd_wscale : 0xf; | |
75 | options |= ireq->sack_ok << 4; | |
172d69e6 | 76 | options |= ireq->ecn_ok << 5; |
4dfc2817 FW |
77 | |
78 | ts = ts_now & ~TSMASK; | |
79 | ts |= options; | |
80 | if (ts > ts_now) { | |
81 | ts >>= TSBITS; | |
82 | ts--; | |
83 | ts <<= TSBITS; | |
84 | ts |= options; | |
85 | } | |
86 | return ts; | |
87 | } | |
88 | ||
89 | ||
714e85be AV |
90 | static __u32 secure_tcp_syn_cookie(__be32 saddr, __be32 daddr, __be16 sport, |
91 | __be16 dport, __u32 sseq, __u32 count, | |
1da177e4 LT |
92 | __u32 data) |
93 | { | |
94 | /* | |
95 | * Compute the secure sequence number. | |
96 | * The output should be: | |
e905a9ed | 97 | * HASH(sec1,saddr,sport,daddr,dport,sec1) + sseq + (count * 2^24) |
1da177e4 LT |
98 | * + (HASH(sec2,saddr,sport,daddr,dport,count,sec2) % 2^24). |
99 | * Where sseq is their sequence number and count increases every | |
100 | * minute by 1. | |
101 | * As an extra hack, we add a small "data" value that encodes the | |
102 | * MSS into the second hash value. | |
103 | */ | |
104 | ||
105 | return (cookie_hash(saddr, daddr, sport, dport, 0, 0) + | |
106 | sseq + (count << COOKIEBITS) + | |
107 | ((cookie_hash(saddr, daddr, sport, dport, count, 1) + data) | |
108 | & COOKIEMASK)); | |
109 | } | |
110 | ||
111 | /* | |
112 | * This retrieves the small "data" value from the syncookie. | |
113 | * If the syncookie is bad, the data returned will be out of | |
114 | * range. This must be checked by the caller. | |
115 | * | |
116 | * The count value used to generate the cookie must be within | |
117 | * "maxdiff" if the current (passed-in) "count". The return value | |
118 | * is (__u32)-1 if this test fails. | |
119 | */ | |
714e85be AV |
120 | static __u32 check_tcp_syn_cookie(__u32 cookie, __be32 saddr, __be32 daddr, |
121 | __be16 sport, __be16 dport, __u32 sseq, | |
1da177e4 LT |
122 | __u32 count, __u32 maxdiff) |
123 | { | |
124 | __u32 diff; | |
125 | ||
126 | /* Strip away the layers from the cookie */ | |
127 | cookie -= cookie_hash(saddr, daddr, sport, dport, 0, 0) + sseq; | |
128 | ||
129 | /* Cookie is now reduced to (count * 2^24) ^ (hash % 2^24) */ | |
130 | diff = (count - (cookie >> COOKIEBITS)) & ((__u32) - 1 >> COOKIEBITS); | |
131 | if (diff >= maxdiff) | |
132 | return (__u32)-1; | |
133 | ||
134 | return (cookie - | |
135 | cookie_hash(saddr, daddr, sport, dport, count - diff, 1)) | |
136 | & COOKIEMASK; /* Leaving the data behind */ | |
137 | } | |
138 | ||
e905a9ed | 139 | /* |
5918e2fb FW |
140 | * MSS Values are taken from the 2009 paper |
141 | * 'Measuring TCP Maximum Segment Size' by S. Alcock and R. Nelson: | |
142 | * - values 1440 to 1460 accounted for 80% of observed mss values | |
143 | * - values outside the 536-1460 range are rare (<0.2%). | |
144 | * | |
145 | * Table must be sorted. | |
1da177e4 LT |
146 | */ |
147 | static __u16 const msstab[] = { | |
5918e2fb FW |
148 | 64, |
149 | 512, | |
150 | 536, | |
151 | 1024, | |
152 | 1440, | |
153 | 1460, | |
154 | 4312, | |
155 | 8960, | |
1da177e4 | 156 | }; |
1da177e4 LT |
157 | |
158 | /* | |
159 | * Generate a syncookie. mssp points to the mss, which is returned | |
160 | * rounded down to the value encoded in the cookie. | |
161 | */ | |
162 | __u32 cookie_v4_init_sequence(struct sock *sk, struct sk_buff *skb, __u16 *mssp) | |
163 | { | |
aa8223c7 ACM |
164 | const struct iphdr *iph = ip_hdr(skb); |
165 | const struct tcphdr *th = tcp_hdr(skb); | |
1da177e4 LT |
166 | int mssind; |
167 | const __u16 mss = *mssp; | |
168 | ||
a0f82f64 | 169 | tcp_synq_overflow(sk); |
1da177e4 | 170 | |
5918e2fb FW |
171 | for (mssind = ARRAY_SIZE(msstab) - 1; mssind ; mssind--) |
172 | if (mss >= msstab[mssind]) | |
173 | break; | |
174 | *mssp = msstab[mssind]; | |
1da177e4 | 175 | |
de0744af | 176 | NET_INC_STATS_BH(sock_net(sk), LINUX_MIB_SYNCOOKIESSENT); |
1da177e4 | 177 | |
aa8223c7 ACM |
178 | return secure_tcp_syn_cookie(iph->saddr, iph->daddr, |
179 | th->source, th->dest, ntohl(th->seq), | |
1da177e4 LT |
180 | jiffies / (HZ * 60), mssind); |
181 | } | |
182 | ||
e905a9ed | 183 | /* |
1da177e4 LT |
184 | * This (misnamed) value is the age of syncookie which is permitted. |
185 | * Its ideal value should be dependent on TCP_TIMEOUT_INIT and | |
186 | * sysctl_tcp_retries1. It's a rather complicated formula (exponential | |
187 | * backoff) to compute at runtime so it's currently hardcoded here. | |
188 | */ | |
189 | #define COUNTER_TRIES 4 | |
e905a9ed YH |
190 | /* |
191 | * Check if a ack sequence number is a valid syncookie. | |
1da177e4 LT |
192 | * Return the decoded mss if it is, or 0 if not. |
193 | */ | |
194 | static inline int cookie_check(struct sk_buff *skb, __u32 cookie) | |
195 | { | |
aa8223c7 ACM |
196 | const struct iphdr *iph = ip_hdr(skb); |
197 | const struct tcphdr *th = tcp_hdr(skb); | |
198 | __u32 seq = ntohl(th->seq) - 1; | |
199 | __u32 mssind = check_tcp_syn_cookie(cookie, iph->saddr, iph->daddr, | |
200 | th->source, th->dest, seq, | |
201 | jiffies / (HZ * 60), | |
202 | COUNTER_TRIES); | |
1da177e4 | 203 | |
5918e2fb | 204 | return mssind < ARRAY_SIZE(msstab) ? msstab[mssind] : 0; |
1da177e4 LT |
205 | } |
206 | ||
1da177e4 | 207 | static inline struct sock *get_cookie_sock(struct sock *sk, struct sk_buff *skb, |
60236fdd | 208 | struct request_sock *req, |
1da177e4 LT |
209 | struct dst_entry *dst) |
210 | { | |
8292a17a | 211 | struct inet_connection_sock *icsk = inet_csk(sk); |
1da177e4 LT |
212 | struct sock *child; |
213 | ||
8292a17a | 214 | child = icsk->icsk_af_ops->syn_recv_sock(sk, skb, req, dst); |
1da177e4 | 215 | if (child) |
463c84b9 | 216 | inet_csk_reqsk_queue_add(sk, req, child); |
1da177e4 | 217 | else |
60236fdd | 218 | reqsk_free(req); |
1da177e4 LT |
219 | |
220 | return child; | |
221 | } | |
222 | ||
4dfc2817 FW |
223 | |
224 | /* | |
225 | * when syncookies are in effect and tcp timestamps are enabled we stored | |
226 | * additional tcp options in the timestamp. | |
227 | * This extracts these options from the timestamp echo. | |
228 | * | |
734f614b | 229 | * The lowest 4 bits store snd_wscale. |
172d69e6 | 230 | * next 2 bits indicate SACK and ECN support. |
8c763681 FW |
231 | * |
232 | * return false if we decode an option that should not be. | |
4dfc2817 | 233 | */ |
172d69e6 | 234 | bool cookie_check_timestamp(struct tcp_options_received *tcp_opt, bool *ecn_ok) |
4dfc2817 | 235 | { |
734f614b | 236 | /* echoed timestamp, lowest bits contain options */ |
4dfc2817 FW |
237 | u32 options = tcp_opt->rcv_tsecr & TSMASK; |
238 | ||
8c763681 FW |
239 | if (!tcp_opt->saw_tstamp) { |
240 | tcp_clear_options(tcp_opt); | |
241 | return true; | |
242 | } | |
243 | ||
244 | if (!sysctl_tcp_timestamps) | |
245 | return false; | |
246 | ||
4dfc2817 | 247 | tcp_opt->sack_ok = (options >> 4) & 0x1; |
172d69e6 FW |
248 | *ecn_ok = (options >> 5) & 1; |
249 | if (*ecn_ok && !sysctl_tcp_ecn) | |
250 | return false; | |
4dfc2817 | 251 | |
8c763681 FW |
252 | if (tcp_opt->sack_ok && !sysctl_tcp_sack) |
253 | return false; | |
4dfc2817 | 254 | |
734f614b FW |
255 | if ((options & 0xf) == 0xf) |
256 | return true; /* no window scaling */ | |
257 | ||
258 | tcp_opt->wscale_ok = 1; | |
259 | tcp_opt->snd_wscale = options & 0xf; | |
260 | return sysctl_tcp_window_scaling != 0; | |
4dfc2817 FW |
261 | } |
262 | EXPORT_SYMBOL(cookie_check_timestamp); | |
263 | ||
1da177e4 LT |
264 | struct sock *cookie_v4_check(struct sock *sk, struct sk_buff *skb, |
265 | struct ip_options *opt) | |
266 | { | |
4957faad | 267 | struct tcp_options_received tcp_opt; |
cf533ea5 | 268 | const u8 *hash_location; |
2e6599cb ACM |
269 | struct inet_request_sock *ireq; |
270 | struct tcp_request_sock *treq; | |
1da177e4 | 271 | struct tcp_sock *tp = tcp_sk(sk); |
aa8223c7 ACM |
272 | const struct tcphdr *th = tcp_hdr(skb); |
273 | __u32 cookie = ntohl(th->ack_seq) - 1; | |
1da177e4 | 274 | struct sock *ret = sk; |
e905a9ed YH |
275 | struct request_sock *req; |
276 | int mss; | |
277 | struct rtable *rt; | |
1da177e4 | 278 | __u8 rcv_wscale; |
f0e3d068 | 279 | bool ecn_ok = false; |
1da177e4 | 280 | |
af9b4738 | 281 | if (!sysctl_tcp_syncookies || !th->ack || th->rst) |
1da177e4 LT |
282 | goto out; |
283 | ||
a0f82f64 | 284 | if (tcp_synq_no_recent_overflow(sk) || |
1da177e4 | 285 | (mss = cookie_check(skb, cookie)) == 0) { |
de0744af | 286 | NET_INC_STATS_BH(sock_net(sk), LINUX_MIB_SYNCOOKIESFAILED); |
1da177e4 LT |
287 | goto out; |
288 | } | |
289 | ||
de0744af | 290 | NET_INC_STATS_BH(sock_net(sk), LINUX_MIB_SYNCOOKIESRECV); |
1da177e4 | 291 | |
bb5b7c11 DM |
292 | /* check for timestamp cookie support */ |
293 | memset(&tcp_opt, 0, sizeof(tcp_opt)); | |
294 | tcp_parse_options(skb, &tcp_opt, &hash_location, 0); | |
295 | ||
172d69e6 | 296 | if (!cookie_check_timestamp(&tcp_opt, &ecn_ok)) |
8c763681 | 297 | goto out; |
bb5b7c11 | 298 | |
1da177e4 | 299 | ret = NULL; |
ce4a7d0d | 300 | req = inet_reqsk_alloc(&tcp_request_sock_ops); /* for safety */ |
1da177e4 LT |
301 | if (!req) |
302 | goto out; | |
303 | ||
2e6599cb ACM |
304 | ireq = inet_rsk(req); |
305 | treq = tcp_rsk(req); | |
aa8223c7 | 306 | treq->rcv_isn = ntohl(th->seq) - 1; |
e905a9ed | 307 | treq->snt_isn = cookie; |
1da177e4 | 308 | req->mss = mss; |
a3116ac5 | 309 | ireq->loc_port = th->dest; |
aa8223c7 | 310 | ireq->rmt_port = th->source; |
eddc9ec5 ACM |
311 | ireq->loc_addr = ip_hdr(skb)->daddr; |
312 | ireq->rmt_addr = ip_hdr(skb)->saddr; | |
172d69e6 | 313 | ireq->ecn_ok = ecn_ok; |
bb5b7c11 | 314 | ireq->snd_wscale = tcp_opt.snd_wscale; |
bb5b7c11 DM |
315 | ireq->sack_ok = tcp_opt.sack_ok; |
316 | ireq->wscale_ok = tcp_opt.wscale_ok; | |
317 | ireq->tstamp_ok = tcp_opt.saw_tstamp; | |
318 | req->ts_recent = tcp_opt.saw_tstamp ? tcp_opt.rcv_tsval : 0; | |
9ad7c049 | 319 | treq->snt_synack = tcp_opt.saw_tstamp ? tcp_opt.rcv_tsecr : 0; |
1da177e4 LT |
320 | |
321 | /* We throwed the options of the initial SYN away, so we hope | |
322 | * the ACK carries the same options again (see RFC1122 4.2.3.8) | |
323 | */ | |
324 | if (opt && opt->optlen) { | |
f6d8bd05 | 325 | int opt_size = sizeof(struct ip_options_rcu) + opt->optlen; |
1da177e4 | 326 | |
2e6599cb | 327 | ireq->opt = kmalloc(opt_size, GFP_ATOMIC); |
f6d8bd05 | 328 | if (ireq->opt != NULL && ip_options_echo(&ireq->opt->opt, skb)) { |
2e6599cb ACM |
329 | kfree(ireq->opt); |
330 | ireq->opt = NULL; | |
1da177e4 LT |
331 | } |
332 | } | |
333 | ||
284904aa PM |
334 | if (security_inet_conn_request(sk, skb, req)) { |
335 | reqsk_free(req); | |
336 | goto out; | |
337 | } | |
338 | ||
e905a9ed YH |
339 | req->expires = 0UL; |
340 | req->retrans = 0; | |
341 | ||
1da177e4 LT |
342 | /* |
343 | * We need to lookup the route here to get at the correct | |
344 | * window size. We should better make sure that the window size | |
345 | * hasn't changed since we received the original syn, but I see | |
e905a9ed | 346 | * no easy way to do this. |
1da177e4 LT |
347 | */ |
348 | { | |
1bba6ffe DM |
349 | struct flowi4 fl4; |
350 | ||
351 | flowi4_init_output(&fl4, 0, sk->sk_mark, RT_CONN_FLAGS(sk), | |
352 | RT_SCOPE_UNIVERSE, IPPROTO_TCP, | |
353 | inet_sk_flowi_flags(sk), | |
354 | (opt && opt->srr) ? opt->faddr : ireq->rmt_addr, | |
355 | ireq->loc_addr, th->source, th->dest); | |
9d6ec938 DM |
356 | security_req_classify_flow(req, flowi4_to_flowi(&fl4)); |
357 | rt = ip_route_output_key(sock_net(sk), &fl4); | |
b23dd4fe | 358 | if (IS_ERR(rt)) { |
60236fdd | 359 | reqsk_free(req); |
e905a9ed | 360 | goto out; |
1da177e4 LT |
361 | } |
362 | } | |
363 | ||
364 | /* Try to redo what tcp_v4_send_synack did. */ | |
d8d1f30b | 365 | req->window_clamp = tp->window_clamp ? :dst_metric(&rt->dst, RTAX_WINDOW); |
4dfc2817 | 366 | |
1da177e4 | 367 | tcp_select_initial_window(tcp_full_space(sk), req->mss, |
e905a9ed | 368 | &req->rcv_wnd, &req->window_clamp, |
31d12926 | 369 | ireq->wscale_ok, &rcv_wscale, |
d8d1f30b | 370 | dst_metric(&rt->dst, RTAX_INITRWND)); |
4dfc2817 | 371 | |
e905a9ed | 372 | ireq->rcv_wscale = rcv_wscale; |
1da177e4 | 373 | |
d8d1f30b | 374 | ret = get_cookie_sock(sk, skb, req, &rt->dst); |
1da177e4 LT |
375 | out: return ret; |
376 | } |