6b2c2bf5b6fb8a671800911e3a16214f07832a59
[strongswan.git] / src / libcharon / network / receiver.c
1 /*
2 * Copyright (C) 2008-2012 Tobias Brunner
3 * Copyright (C) 2005-2006 Martin Willi
4 * Copyright (C) 2005 Jan Hutter
5 * Hochschule fuer Technik Rapperswil
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * for more details.
16 */
17
18 #include <stdlib.h>
19 #include <unistd.h>
20
21 #include "receiver.h"
22
23 #include <hydra.h>
24 #include <daemon.h>
25 #include <network/socket.h>
26 #include <processing/jobs/job.h>
27 #include <processing/jobs/process_message_job.h>
28 #include <processing/jobs/callback_job.h>
29 #include <crypto/hashers/hasher.h>
30 #include <threading/mutex.h>
31 #include <networking/packet.h>
32
33 /** lifetime of a cookie, in seconds */
34 #define COOKIE_LIFETIME 10
35 /** time we wait before disabling cookies */
36 #define COOKIE_CALMDOWN_DELAY 10
37 /** how many times to reuse the secret */
38 #define COOKIE_REUSE 10000
39 /** default value for private_receiver_t.cookie_threshold */
40 #define COOKIE_THRESHOLD_DEFAULT 10
41 /** default value for private_receiver_t.block_threshold */
42 #define BLOCK_THRESHOLD_DEFAULT 5
43 /** length of the secret to use for cookie calculation */
44 #define SECRET_LENGTH 16
45 /** Length of a notify payload header */
46 #define NOTIFY_PAYLOAD_HEADER_LENGTH 8
47
48 typedef struct private_receiver_t private_receiver_t;
49
50 /**
51 * Private data of a receiver_t object.
52 */
53 struct private_receiver_t {
54 /**
55 * Public part of a receiver_t object.
56 */
57 receiver_t public;
58
59 /**
60 * Registered callback for ESP packets
61 */
62 struct {
63 receiver_esp_cb_t cb;
64 void *data;
65 } esp_cb;
66
67 /**
68 * Mutex for ESP callback
69 */
70 mutex_t *esp_cb_mutex;
71
72 /**
73 * current secret to use for cookie calculation
74 */
75 char secret[SECRET_LENGTH];
76
77 /**
78 * previous secret used to verify older cookies
79 */
80 char secret_old[SECRET_LENGTH];
81
82 /**
83 * how many times we have used "secret" so far
84 */
85 u_int32_t secret_used;
86
87 /**
88 * time we did the cookie switch
89 */
90 u_int32_t secret_switch;
91
92 /**
93 * time offset to use, hides our system time
94 */
95 u_int32_t secret_offset;
96
97 /**
98 * the RNG to use for secret generation
99 */
100 rng_t *rng;
101
102 /**
103 * hasher to use for cookie calculation
104 */
105 hasher_t *hasher;
106
107 /**
108 * require cookies after this many half open IKE_SAs
109 */
110 u_int32_t cookie_threshold;
111
112 /**
113 * timestamp of last cookie requested
114 */
115 time_t last_cookie;
116
117 /**
118 * how many half open IKE_SAs per peer before blocking
119 */
120 u_int32_t block_threshold;
121
122 /**
123 * Drop IKE_SA_INIT requests if processor job load exceeds this limit
124 */
125 u_int init_limit_job_load;
126
127 /**
128 * Drop IKE_SA_INIT requests if half open IKE_SA count exceeds this limit
129 */
130 u_int init_limit_half_open;
131
132 /**
133 * Delay for receiving incoming packets, to simulate larger RTT
134 */
135 int receive_delay;
136
137 /**
138 * Specific message type to delay, 0 for any
139 */
140 int receive_delay_type;
141
142 /**
143 * Delay request messages?
144 */
145 bool receive_delay_request;
146
147 /**
148 * Delay response messages?
149 */
150 bool receive_delay_response;
151 };
152
153 /**
154 * send a notify back to the sender
155 */
156 static void send_notify(message_t *request, int major, exchange_type_t exchange,
157 notify_type_t type, chunk_t data)
158 {
159 ike_sa_id_t *ike_sa_id;
160 message_t *response;
161 host_t *src, *dst;
162 packet_t *packet;
163
164 response = message_create(major, 0);
165 response->set_exchange_type(response, exchange);
166 response->add_notify(response, FALSE, type, data);
167 dst = request->get_source(request);
168 src = request->get_destination(request);
169 response->set_source(response, src->clone(src));
170 response->set_destination(response, dst->clone(dst));
171 if (major == IKEV2_MAJOR_VERSION)
172 {
173 response->set_request(response, FALSE);
174 }
175 response->set_message_id(response, 0);
176 ike_sa_id = request->get_ike_sa_id(request);
177 ike_sa_id->switch_initiator(ike_sa_id);
178 response->set_ike_sa_id(response, ike_sa_id);
179 if (response->generate(response, NULL, &packet) == SUCCESS)
180 {
181 charon->sender->send(charon->sender, packet);
182 }
183 response->destroy(response);
184 }
185
186 /**
187 * build a cookie
188 */
189 static bool cookie_build(private_receiver_t *this, message_t *message,
190 u_int32_t t, chunk_t secret, chunk_t *cookie)
191 {
192 u_int64_t spi = message->get_initiator_spi(message);
193 host_t *ip = message->get_source(message);
194 chunk_t input, hash;
195
196 /* COOKIE = t | sha1( IPi | SPIi | t | secret ) */
197 input = chunk_cata("cccc", ip->get_address(ip), chunk_from_thing(spi),
198 chunk_from_thing(t), secret);
199 hash = chunk_alloca(this->hasher->get_hash_size(this->hasher));
200 if (!this->hasher->get_hash(this->hasher, input, hash.ptr))
201 {
202 return FALSE;
203 }
204 *cookie = chunk_cat("cc", chunk_from_thing(t), hash);
205 return TRUE;
206 }
207
208 /**
209 * verify a received cookie
210 */
211 static bool cookie_verify(private_receiver_t *this, message_t *message,
212 chunk_t cookie)
213 {
214 u_int32_t t, now;
215 chunk_t reference;
216 chunk_t secret;
217
218 now = time_monotonic(NULL);
219 t = *(u_int32_t*)cookie.ptr;
220
221 if (cookie.len != sizeof(u_int32_t) +
222 this->hasher->get_hash_size(this->hasher) ||
223 t < now - this->secret_offset - COOKIE_LIFETIME)
224 {
225 DBG2(DBG_NET, "received cookie lifetime expired, rejecting");
226 return FALSE;
227 }
228
229 /* check if cookie is derived from old_secret */
230 if (t + this->secret_offset > this->secret_switch)
231 {
232 secret = chunk_from_thing(this->secret);
233 }
234 else
235 {
236 secret = chunk_from_thing(this->secret_old);
237 }
238
239 /* compare own calculation against received */
240 if (!cookie_build(this, message, t, secret, &reference))
241 {
242 return FALSE;
243 }
244 if (chunk_equals(reference, cookie))
245 {
246 chunk_free(&reference);
247 return TRUE;
248 }
249 chunk_free(&reference);
250 return FALSE;
251 }
252
253 /**
254 * Check if a valid cookie found
255 */
256 static bool check_cookie(private_receiver_t *this, message_t *message)
257 {
258 packet_t *packet;
259 chunk_t data;
260
261 /* check for a cookie. We don't use our parser here and do it
262 * quick and dirty for performance reasons.
263 * we assume the cookie is the first payload (which is a MUST), and
264 * the cookie's SPI length is zero. */
265 packet = message->get_packet(message);
266 data = packet->get_data(packet);
267 if (data.len <
268 IKE_HEADER_LENGTH + NOTIFY_PAYLOAD_HEADER_LENGTH +
269 sizeof(u_int32_t) + this->hasher->get_hash_size(this->hasher) ||
270 *(data.ptr + 16) != NOTIFY ||
271 *(u_int16_t*)(data.ptr + IKE_HEADER_LENGTH + 6) != htons(COOKIE))
272 {
273 /* no cookie found */
274 packet->destroy(packet);
275 return FALSE;
276 }
277 data.ptr += IKE_HEADER_LENGTH + NOTIFY_PAYLOAD_HEADER_LENGTH;
278 data.len = sizeof(u_int32_t) + this->hasher->get_hash_size(this->hasher);
279 if (!cookie_verify(this, message, data))
280 {
281 DBG2(DBG_NET, "found cookie, but content invalid");
282 packet->destroy(packet);
283 return FALSE;
284 }
285 return TRUE;
286 }
287
288 /**
289 * Check if we currently require cookies
290 */
291 static bool cookie_required(private_receiver_t *this,
292 u_int half_open, u_int32_t now)
293 {
294 if (this->cookie_threshold && half_open >= this->cookie_threshold)
295 {
296 this->last_cookie = now;
297 return TRUE;
298 }
299 if (this->last_cookie && now < this->last_cookie + COOKIE_CALMDOWN_DELAY)
300 {
301 /* We don't disable cookies unless we haven't seen IKE_SA_INITs
302 * for COOKIE_CALMDOWN_DELAY seconds. This avoids jittering between
303 * cookie on / cookie off states, which is problematic. Consider the
304 * following: A legitimiate initiator sends a IKE_SA_INIT while we
305 * are under a DoS attack. If we toggle our cookie behavior,
306 * multiple retransmits of this IKE_SA_INIT might get answered with
307 * and without cookies. The initiator goes on and retries with
308 * a cookie, but it can't know if the completing IKE_SA_INIT response
309 * is to its IKE_SA_INIT request with or without cookies. This is
310 * problematic, as the cookie is part of AUTH payload data.
311 */
312 this->last_cookie = now;
313 return TRUE;
314 }
315 return FALSE;
316 }
317
318 /**
319 * Check if we should drop IKE_SA_INIT because of cookie/overload checking
320 */
321 static bool drop_ike_sa_init(private_receiver_t *this, message_t *message)
322 {
323 u_int half_open;
324 u_int32_t now;
325
326 now = time_monotonic(NULL);
327 half_open = charon->ike_sa_manager->get_half_open_count(
328 charon->ike_sa_manager, NULL);
329
330 /* check for cookies in IKEv2 */
331 if (message->get_major_version(message) == IKEV2_MAJOR_VERSION &&
332 cookie_required(this, half_open, now) && !check_cookie(this, message))
333 {
334 chunk_t cookie;
335
336 DBG2(DBG_NET, "received packet from: %#H to %#H",
337 message->get_source(message),
338 message->get_destination(message));
339 if (!cookie_build(this, message, now - this->secret_offset,
340 chunk_from_thing(this->secret), &cookie))
341 {
342 return TRUE;
343 }
344 DBG2(DBG_NET, "sending COOKIE notify to %H",
345 message->get_source(message));
346 send_notify(message, IKEV2_MAJOR_VERSION, IKE_SA_INIT, COOKIE, cookie);
347 chunk_free(&cookie);
348 if (++this->secret_used > COOKIE_REUSE)
349 {
350 char secret[SECRET_LENGTH];
351
352 DBG1(DBG_NET, "generating new cookie secret after %d uses",
353 this->secret_used);
354 if (this->rng->get_bytes(this->rng, SECRET_LENGTH, secret))
355 {
356 memcpy(this->secret_old, this->secret, SECRET_LENGTH);
357 memcpy(this->secret, secret, SECRET_LENGTH);
358 memwipe(secret, SECRET_LENGTH);
359 this->secret_switch = now;
360 this->secret_used = 0;
361 }
362 else
363 {
364 DBG1(DBG_NET, "failed to allocated cookie secret, keeping old");
365 }
366 }
367 return TRUE;
368 }
369
370 /* check if peer has too many IKE_SAs half open */
371 if (this->block_threshold &&
372 charon->ike_sa_manager->get_half_open_count(charon->ike_sa_manager,
373 message->get_source(message)) >= this->block_threshold)
374 {
375 DBG1(DBG_NET, "ignoring IKE_SA setup from %H, "
376 "peer too aggressive", message->get_source(message));
377 return TRUE;
378 }
379
380 /* check if global half open IKE_SA limit reached */
381 if (this->init_limit_half_open &&
382 half_open >= this->init_limit_half_open)
383 {
384 DBG1(DBG_NET, "ignoring IKE_SA setup from %H, half open IKE_SA "
385 "count of %d exceeds limit of %d", message->get_source(message),
386 half_open, this->init_limit_half_open);
387 return TRUE;
388 }
389
390 /* check if job load acceptable */
391 if (this->init_limit_job_load)
392 {
393 u_int jobs = 0, i;
394
395 for (i = 0; i < JOB_PRIO_MAX; i++)
396 {
397 jobs += lib->processor->get_job_load(lib->processor, i);
398 }
399 if (jobs > this->init_limit_job_load)
400 {
401 DBG1(DBG_NET, "ignoring IKE_SA setup from %H, job load of %d "
402 "exceeds limit of %d", message->get_source(message),
403 jobs, this->init_limit_job_load);
404 return TRUE;
405 }
406 }
407 return FALSE;
408 }
409
410 /**
411 * Job callback to receive packets
412 */
413 static job_requeue_t receive_packets(private_receiver_t *this)
414 {
415 ike_sa_id_t *id;
416 packet_t *packet;
417 message_t *message;
418 host_t *src, *dst;
419 status_t status;
420 bool supported = TRUE;
421 chunk_t data, marker = chunk_from_chars(0x00, 0x00, 0x00, 0x00);
422
423 /* read in a packet */
424 status = charon->socket->receive(charon->socket, &packet);
425 if (status == NOT_SUPPORTED)
426 {
427 return JOB_REQUEUE_NONE;
428 }
429 else if (status != SUCCESS)
430 {
431 DBG2(DBG_NET, "receiving from socket failed!");
432 return JOB_REQUEUE_FAIR;
433 }
434
435 data = packet->get_data(packet);
436 if (data.len == 1 && data.ptr[0] == 0xFF)
437 { /* silently drop NAT-T keepalives */
438 packet->destroy(packet);
439 return JOB_REQUEUE_DIRECT;
440 }
441 else if (data.len < marker.len)
442 { /* drop packets that are too small */
443 DBG3(DBG_NET, "received packet is too short (%d bytes)", data.len);
444 packet->destroy(packet);
445 return JOB_REQUEUE_DIRECT;
446 }
447
448 dst = packet->get_destination(packet);
449 src = packet->get_source(packet);
450 if (!hydra->kernel_interface->all_interfaces_usable(hydra->kernel_interface)
451 && !hydra->kernel_interface->get_interface(hydra->kernel_interface,
452 dst, NULL))
453 {
454 DBG3(DBG_NET, "received packet from %#H to %#H on ignored interface",
455 src, dst);
456 packet->destroy(packet);
457 return JOB_REQUEUE_DIRECT;
458 }
459
460 /* if neither source nor destination port is 500 we assume an IKE packet
461 * with Non-ESP marker or an ESP packet */
462 if (dst->get_port(dst) != IKEV2_UDP_PORT &&
463 src->get_port(src) != IKEV2_UDP_PORT)
464 {
465 if (memeq(data.ptr, marker.ptr, marker.len))
466 { /* remove Non-ESP marker */
467 packet->skip_bytes(packet, marker.len);
468 }
469 else
470 { /* this seems to be an ESP packet */
471 this->esp_cb_mutex->lock(this->esp_cb_mutex);
472 if (this->esp_cb.cb)
473 {
474 this->esp_cb.cb(this->esp_cb.data, packet);
475 }
476 else
477 {
478 packet->destroy(packet);
479 }
480 this->esp_cb_mutex->unlock(this->esp_cb_mutex);
481 return JOB_REQUEUE_DIRECT;
482 }
483 }
484
485 /* parse message header */
486 message = message_create_from_packet(packet);
487 if (message->parse_header(message) != SUCCESS)
488 {
489 DBG1(DBG_NET, "received invalid IKE header from %H - ignored",
490 packet->get_source(packet));
491 charon->bus->alert(charon->bus, ALERT_PARSE_ERROR_HEADER, message);
492 message->destroy(message);
493 return JOB_REQUEUE_DIRECT;
494 }
495
496 /* check IKE major version */
497 switch (message->get_major_version(message))
498 {
499 case IKEV2_MAJOR_VERSION:
500 #ifndef USE_IKEV2
501 if (message->get_exchange_type(message) == IKE_SA_INIT &&
502 message->get_request(message))
503 {
504 send_notify(message, IKEV1_MAJOR_VERSION, INFORMATIONAL_V1,
505 INVALID_MAJOR_VERSION, chunk_empty);
506 supported = FALSE;
507 }
508 #endif /* USE_IKEV2 */
509 break;
510 case IKEV1_MAJOR_VERSION:
511 #ifndef USE_IKEV1
512 if (message->get_exchange_type(message) == ID_PROT ||
513 message->get_exchange_type(message) == AGGRESSIVE)
514 {
515 send_notify(message, IKEV2_MAJOR_VERSION, INFORMATIONAL,
516 INVALID_MAJOR_VERSION, chunk_empty);
517 supported = FALSE;
518 }
519 #endif /* USE_IKEV1 */
520 break;
521 default:
522 #ifdef USE_IKEV2
523 send_notify(message, IKEV2_MAJOR_VERSION, INFORMATIONAL,
524 INVALID_MAJOR_VERSION, chunk_empty);
525 #endif /* USE_IKEV2 */
526 #ifdef USE_IKEV1
527 send_notify(message, IKEV1_MAJOR_VERSION, INFORMATIONAL_V1,
528 INVALID_MAJOR_VERSION, chunk_empty);
529 #endif /* USE_IKEV1 */
530 supported = FALSE;
531 break;
532 }
533 if (!supported)
534 {
535 DBG1(DBG_NET, "received unsupported IKE version %d.%d from %H, sending "
536 "INVALID_MAJOR_VERSION", message->get_major_version(message),
537 message->get_minor_version(message), packet->get_source(packet));
538 message->destroy(message);
539 return JOB_REQUEUE_DIRECT;
540 }
541 if (message->get_request(message) &&
542 message->get_exchange_type(message) == IKE_SA_INIT)
543 {
544 if (drop_ike_sa_init(this, message))
545 {
546 message->destroy(message);
547 return JOB_REQUEUE_DIRECT;
548 }
549 }
550 if (message->get_exchange_type(message) == ID_PROT ||
551 message->get_exchange_type(message) == AGGRESSIVE)
552 {
553 id = message->get_ike_sa_id(message);
554 if (id->get_responder_spi(id) == 0 &&
555 drop_ike_sa_init(this, message))
556 {
557 message->destroy(message);
558 return JOB_REQUEUE_DIRECT;
559 }
560 }
561
562 if (this->receive_delay)
563 {
564 if (this->receive_delay_type == 0 ||
565 this->receive_delay_type == message->get_exchange_type(message))
566 {
567 if ((message->get_request(message) && this->receive_delay_request) ||
568 (!message->get_request(message) && this->receive_delay_response))
569 {
570 DBG1(DBG_NET, "using receive delay: %dms",
571 this->receive_delay);
572 lib->scheduler->schedule_job_ms(lib->scheduler,
573 (job_t*)process_message_job_create(message),
574 this->receive_delay);
575 return JOB_REQUEUE_DIRECT;
576 }
577 }
578 }
579 lib->processor->queue_job(lib->processor,
580 (job_t*)process_message_job_create(message));
581 return JOB_REQUEUE_DIRECT;
582 }
583
584 METHOD(receiver_t, add_esp_cb, void,
585 private_receiver_t *this, receiver_esp_cb_t callback, void *data)
586 {
587 this->esp_cb_mutex->lock(this->esp_cb_mutex);
588 this->esp_cb.cb = callback;
589 this->esp_cb.data = data;
590 this->esp_cb_mutex->unlock(this->esp_cb_mutex);
591 }
592
593 METHOD(receiver_t, del_esp_cb, void,
594 private_receiver_t *this, receiver_esp_cb_t callback)
595 {
596 this->esp_cb_mutex->lock(this->esp_cb_mutex);
597 if (this->esp_cb.cb == callback)
598 {
599 this->esp_cb.cb = NULL;
600 this->esp_cb.data = NULL;
601 }
602 this->esp_cb_mutex->unlock(this->esp_cb_mutex);
603 }
604
605 METHOD(receiver_t, destroy, void,
606 private_receiver_t *this)
607 {
608 this->rng->destroy(this->rng);
609 this->hasher->destroy(this->hasher);
610 this->esp_cb_mutex->destroy(this->esp_cb_mutex);
611 free(this);
612 }
613
614 /*
615 * Described in header.
616 */
617 receiver_t *receiver_create()
618 {
619 private_receiver_t *this;
620 u_int32_t now = time_monotonic(NULL);
621
622 INIT(this,
623 .public = {
624 .add_esp_cb = _add_esp_cb,
625 .del_esp_cb = _del_esp_cb,
626 .destroy = _destroy,
627 },
628 .esp_cb_mutex = mutex_create(MUTEX_TYPE_DEFAULT),
629 .secret_switch = now,
630 .secret_offset = random() % now,
631 );
632
633 if (lib->settings->get_bool(lib->settings,
634 "%s.dos_protection", TRUE, charon->name))
635 {
636 this->cookie_threshold = lib->settings->get_int(lib->settings,
637 "%s.cookie_threshold", COOKIE_THRESHOLD_DEFAULT, charon->name);
638 this->block_threshold = lib->settings->get_int(lib->settings,
639 "%s.block_threshold", BLOCK_THRESHOLD_DEFAULT, charon->name);
640 }
641 this->init_limit_job_load = lib->settings->get_int(lib->settings,
642 "%s.init_limit_job_load", 0, charon->name);
643 this->init_limit_half_open = lib->settings->get_int(lib->settings,
644 "%s.init_limit_half_open", 0, charon->name);
645 this->receive_delay = lib->settings->get_int(lib->settings,
646 "%s.receive_delay", 0, charon->name);
647 this->receive_delay_type = lib->settings->get_int(lib->settings,
648 "%s.receive_delay_type", 0, charon->name),
649 this->receive_delay_request = lib->settings->get_bool(lib->settings,
650 "%s.receive_delay_request", TRUE, charon->name),
651 this->receive_delay_response = lib->settings->get_bool(lib->settings,
652 "%s.receive_delay_response", TRUE, charon->name),
653
654 this->hasher = lib->crypto->create_hasher(lib->crypto, HASH_PREFERRED);
655 if (!this->hasher)
656 {
657 DBG1(DBG_NET, "creating cookie hasher failed, no hashers supported");
658 free(this);
659 return NULL;
660 }
661 this->rng = lib->crypto->create_rng(lib->crypto, RNG_STRONG);
662 if (!this->rng)
663 {
664 DBG1(DBG_NET, "creating cookie RNG failed, no RNG supported");
665 this->hasher->destroy(this->hasher);
666 free(this);
667 return NULL;
668 }
669 if (!this->rng->get_bytes(this->rng, SECRET_LENGTH, this->secret))
670 {
671 DBG1(DBG_NET, "creating cookie secret failed");
672 destroy(this);
673 return NULL;
674 }
675 memcpy(this->secret_old, this->secret, SECRET_LENGTH);
676
677 lib->processor->queue_job(lib->processor,
678 (job_t*)callback_job_create_with_prio((callback_job_cb_t)receive_packets,
679 this, NULL, (callback_job_cancel_t)return_false, JOB_PRIO_CRITICAL));
680
681 return &this->public;
682 }
683