1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2015-2019 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
5 * This contains some basic static unit tests for the allowedips data structure.
6 * It also has two additional modes that are disabled and meant to be used by
7 * folks directly playing with this file. If you define the macro
8 * DEBUG_PRINT_TRIE_GRAPHVIZ to be 1, then every time there's a full tree in
9 * memory, it will be printed out as KERN_DEBUG in a format that can be passed
10 * to graphviz (the dot command) to visualize it. If you define the macro
11 * DEBUG_RANDOM_TRIE to be 1, then there will be an extremely costly set of
12 * randomized tests done against a trivial implementation, which may take
13 * upwards of a half-hour to complete. There's no set of users who should be
14 * enabling these, and the only developers that should go anywhere near these
15 * nobs are the ones who are reading this comment.
20 #include <linux/siphash.h>
22 static __init
void swap_endian_and_apply_cidr(u8
*dst
, const u8
*src
, u8 bits
,
25 swap_endian(dst
, src
, bits
);
26 memset(dst
+ (cidr
+ 7) / 8, 0, bits
/ 8 - (cidr
+ 7) / 8);
28 dst
[(cidr
+ 7) / 8 - 1] &= ~0U << ((8 - (cidr
% 8)) % 8);
31 static __init
void print_node(struct allowedips_node
*node
, u8 bits
)
33 char *fmt_connection
= KERN_DEBUG
"\t\"%p/%d\" -> \"%p/%d\";\n";
34 char *fmt_declaration
= KERN_DEBUG
35 "\t\"%p/%d\"[style=%s, color=\"#%06x\"];\n";
36 char *style
= "dotted";
41 fmt_connection
= KERN_DEBUG
"\t\"%pI4/%d\" -> \"%pI4/%d\";\n";
42 fmt_declaration
= KERN_DEBUG
43 "\t\"%pI4/%d\"[style=%s, color=\"#%06x\"];\n";
44 } else if (bits
== 128) {
45 fmt_connection
= KERN_DEBUG
"\t\"%pI6/%d\" -> \"%pI6/%d\";\n";
46 fmt_declaration
= KERN_DEBUG
47 "\t\"%pI6/%d\"[style=%s, color=\"#%06x\"];\n";
50 hsiphash_key_t key
= { { 0 } };
52 memcpy(&key
, &node
->peer
, sizeof(node
->peer
));
53 color
= hsiphash_1u32(0xdeadbeef, &key
) % 200 << 16 |
54 hsiphash_1u32(0xbabecafe, &key
) % 200 << 8 |
55 hsiphash_1u32(0xabad1dea, &key
) % 200;
58 swap_endian_and_apply_cidr(ip1
, node
->bits
, bits
, node
->cidr
);
59 printk(fmt_declaration
, ip1
, node
->cidr
, style
, color
);
61 swap_endian_and_apply_cidr(ip2
,
62 rcu_dereference_raw(node
->bit
[0])->bits
, bits
,
64 printk(fmt_connection
, ip1
, node
->cidr
, ip2
,
65 rcu_dereference_raw(node
->bit
[0])->cidr
);
66 print_node(rcu_dereference_raw(node
->bit
[0]), bits
);
69 swap_endian_and_apply_cidr(ip2
,
70 rcu_dereference_raw(node
->bit
[1])->bits
,
72 printk(fmt_connection
, ip1
, node
->cidr
, ip2
,
73 rcu_dereference_raw(node
->bit
[1])->cidr
);
74 print_node(rcu_dereference_raw(node
->bit
[1]), bits
);
78 static __init
void print_tree(struct allowedips_node __rcu
*top
, u8 bits
)
80 printk(KERN_DEBUG
"digraph trie {\n");
81 print_node(rcu_dereference_raw(top
), bits
);
82 printk(KERN_DEBUG
"}\n");
87 NUM_RAND_ROUTES
= 400,
88 NUM_MUTATED_ROUTES
= 100,
89 NUM_QUERIES
= NUM_RAND_ROUTES
* NUM_MUTATED_ROUTES
* 30
92 struct horrible_allowedips
{
93 struct hlist_head head
;
96 struct horrible_allowedips_node
{
97 struct hlist_node table
;
98 union nf_inet_addr ip
;
99 union nf_inet_addr mask
;
104 static __init
void horrible_allowedips_init(struct horrible_allowedips
*table
)
106 INIT_HLIST_HEAD(&table
->head
);
109 static __init
void horrible_allowedips_free(struct horrible_allowedips
*table
)
111 struct horrible_allowedips_node
*node
;
112 struct hlist_node
*h
;
114 hlist_for_each_entry_safe(node
, h
, &table
->head
, table
) {
115 hlist_del(&node
->table
);
120 static __init
inline union nf_inet_addr
horrible_cidr_to_mask(u8 cidr
)
122 union nf_inet_addr mask
;
124 memset(&mask
, 0x00, 128 / 8);
125 memset(&mask
, 0xff, cidr
/ 8);
127 mask
.all
[cidr
/ 32] = (__force u32
)htonl(
128 (0xFFFFFFFFUL
<< (32 - (cidr
% 32))) & 0xFFFFFFFFUL
);
132 static __init
inline u8
horrible_mask_to_cidr(union nf_inet_addr subnet
)
134 return hweight32(subnet
.all
[0]) + hweight32(subnet
.all
[1]) +
135 hweight32(subnet
.all
[2]) + hweight32(subnet
.all
[3]);
138 static __init
inline void
139 horrible_mask_self(struct horrible_allowedips_node
*node
)
141 if (node
->ip_version
== 4) {
142 node
->ip
.ip
&= node
->mask
.ip
;
143 } else if (node
->ip_version
== 6) {
144 node
->ip
.ip6
[0] &= node
->mask
.ip6
[0];
145 node
->ip
.ip6
[1] &= node
->mask
.ip6
[1];
146 node
->ip
.ip6
[2] &= node
->mask
.ip6
[2];
147 node
->ip
.ip6
[3] &= node
->mask
.ip6
[3];
151 static __init
inline bool
152 horrible_match_v4(const struct horrible_allowedips_node
*node
,
155 return (ip
->s_addr
& node
->mask
.ip
) == node
->ip
.ip
;
158 static __init
inline bool
159 horrible_match_v6(const struct horrible_allowedips_node
*node
,
162 return (ip
->in6_u
.u6_addr32
[0] & node
->mask
.ip6
[0]) ==
164 (ip
->in6_u
.u6_addr32
[1] & node
->mask
.ip6
[1]) ==
166 (ip
->in6_u
.u6_addr32
[2] & node
->mask
.ip6
[2]) ==
168 (ip
->in6_u
.u6_addr32
[3] & node
->mask
.ip6
[3]) == node
->ip
.ip6
[3];
172 horrible_insert_ordered(struct horrible_allowedips
*table
,
173 struct horrible_allowedips_node
*node
)
175 struct horrible_allowedips_node
*other
= NULL
, *where
= NULL
;
176 u8 my_cidr
= horrible_mask_to_cidr(node
->mask
);
178 hlist_for_each_entry(other
, &table
->head
, table
) {
179 if (!memcmp(&other
->mask
, &node
->mask
,
180 sizeof(union nf_inet_addr
)) &&
181 !memcmp(&other
->ip
, &node
->ip
,
182 sizeof(union nf_inet_addr
)) &&
183 other
->ip_version
== node
->ip_version
) {
184 other
->value
= node
->value
;
189 if (horrible_mask_to_cidr(other
->mask
) <= my_cidr
)
192 if (!other
&& !where
)
193 hlist_add_head(&node
->table
, &table
->head
);
195 hlist_add_behind(&node
->table
, &where
->table
);
197 hlist_add_before(&node
->table
, &where
->table
);
201 horrible_allowedips_insert_v4(struct horrible_allowedips
*table
,
202 struct in_addr
*ip
, u8 cidr
, void *value
)
204 struct horrible_allowedips_node
*node
= kzalloc(sizeof(*node
),
210 node
->mask
= horrible_cidr_to_mask(cidr
);
211 node
->ip_version
= 4;
213 horrible_mask_self(node
);
214 horrible_insert_ordered(table
, node
);
219 horrible_allowedips_insert_v6(struct horrible_allowedips
*table
,
220 struct in6_addr
*ip
, u8 cidr
, void *value
)
222 struct horrible_allowedips_node
*node
= kzalloc(sizeof(*node
),
228 node
->mask
= horrible_cidr_to_mask(cidr
);
229 node
->ip_version
= 6;
231 horrible_mask_self(node
);
232 horrible_insert_ordered(table
, node
);
237 horrible_allowedips_lookup_v4(struct horrible_allowedips
*table
,
240 struct horrible_allowedips_node
*node
;
243 hlist_for_each_entry(node
, &table
->head
, table
) {
244 if (node
->ip_version
!= 4)
246 if (horrible_match_v4(node
, ip
)) {
255 horrible_allowedips_lookup_v6(struct horrible_allowedips
*table
,
258 struct horrible_allowedips_node
*node
;
261 hlist_for_each_entry(node
, &table
->head
, table
) {
262 if (node
->ip_version
!= 6)
264 if (horrible_match_v6(node
, ip
)) {
272 static __init
bool randomized_test(void)
274 unsigned int i
, j
, k
, mutate_amount
, cidr
;
275 u8 ip
[16], mutate_mask
[16], mutated
[16];
276 struct wg_peer
**peers
, *peer
;
277 struct horrible_allowedips h
;
284 wg_allowedips_init(&t
);
285 horrible_allowedips_init(&h
);
287 peers
= kcalloc(NUM_PEERS
, sizeof(*peers
), GFP_KERNEL
);
288 if (unlikely(!peers
)) {
289 pr_err("allowedips random self-test malloc: FAIL\n");
292 for (i
= 0; i
< NUM_PEERS
; ++i
) {
293 peers
[i
] = kzalloc(sizeof(*peers
[i
]), GFP_KERNEL
);
294 if (unlikely(!peers
[i
])) {
295 pr_err("allowedips random self-test malloc: FAIL\n");
298 kref_init(&peers
[i
]->refcount
);
303 for (i
= 0; i
< NUM_RAND_ROUTES
; ++i
) {
304 prandom_bytes(ip
, 4);
305 cidr
= prandom_u32_max(32) + 1;
306 peer
= peers
[prandom_u32_max(NUM_PEERS
)];
307 if (wg_allowedips_insert_v4(&t
, (struct in_addr
*)ip
, cidr
,
309 pr_err("allowedips random self-test malloc: FAIL\n");
312 if (horrible_allowedips_insert_v4(&h
, (struct in_addr
*)ip
,
314 pr_err("allowedips random self-test malloc: FAIL\n");
317 for (j
= 0; j
< NUM_MUTATED_ROUTES
; ++j
) {
318 memcpy(mutated
, ip
, 4);
319 prandom_bytes(mutate_mask
, 4);
320 mutate_amount
= prandom_u32_max(32);
321 for (k
= 0; k
< mutate_amount
/ 8; ++k
)
322 mutate_mask
[k
] = 0xff;
323 mutate_mask
[k
] = 0xff
324 << ((8 - (mutate_amount
% 8)) % 8);
327 for (k
= 0; k
< 4; ++k
)
328 mutated
[k
] = (mutated
[k
] & mutate_mask
[k
]) |
330 prandom_u32_max(256));
331 cidr
= prandom_u32_max(32) + 1;
332 peer
= peers
[prandom_u32_max(NUM_PEERS
)];
333 if (wg_allowedips_insert_v4(&t
,
334 (struct in_addr
*)mutated
,
335 cidr
, peer
, &mutex
) < 0) {
336 pr_err("allowedips random malloc: FAIL\n");
339 if (horrible_allowedips_insert_v4(&h
,
340 (struct in_addr
*)mutated
, cidr
, peer
)) {
341 pr_err("allowedips random self-test malloc: FAIL\n");
347 for (i
= 0; i
< NUM_RAND_ROUTES
; ++i
) {
348 prandom_bytes(ip
, 16);
349 cidr
= prandom_u32_max(128) + 1;
350 peer
= peers
[prandom_u32_max(NUM_PEERS
)];
351 if (wg_allowedips_insert_v6(&t
, (struct in6_addr
*)ip
, cidr
,
353 pr_err("allowedips random self-test malloc: FAIL\n");
356 if (horrible_allowedips_insert_v6(&h
, (struct in6_addr
*)ip
,
358 pr_err("allowedips random self-test malloc: FAIL\n");
361 for (j
= 0; j
< NUM_MUTATED_ROUTES
; ++j
) {
362 memcpy(mutated
, ip
, 16);
363 prandom_bytes(mutate_mask
, 16);
364 mutate_amount
= prandom_u32_max(128);
365 for (k
= 0; k
< mutate_amount
/ 8; ++k
)
366 mutate_mask
[k
] = 0xff;
367 mutate_mask
[k
] = 0xff
368 << ((8 - (mutate_amount
% 8)) % 8);
371 for (k
= 0; k
< 4; ++k
)
372 mutated
[k
] = (mutated
[k
] & mutate_mask
[k
]) |
374 prandom_u32_max(256));
375 cidr
= prandom_u32_max(128) + 1;
376 peer
= peers
[prandom_u32_max(NUM_PEERS
)];
377 if (wg_allowedips_insert_v6(&t
,
378 (struct in6_addr
*)mutated
,
379 cidr
, peer
, &mutex
) < 0) {
380 pr_err("allowedips random self-test malloc: FAIL\n");
383 if (horrible_allowedips_insert_v6(
384 &h
, (struct in6_addr
*)mutated
, cidr
,
386 pr_err("allowedips random self-test malloc: FAIL\n");
392 mutex_unlock(&mutex
);
394 if (IS_ENABLED(DEBUG_PRINT_TRIE_GRAPHVIZ
)) {
395 print_tree(t
.root4
, 32);
396 print_tree(t
.root6
, 128);
399 for (i
= 0; i
< NUM_QUERIES
; ++i
) {
400 prandom_bytes(ip
, 4);
401 if (lookup(t
.root4
, 32, ip
) !=
402 horrible_allowedips_lookup_v4(&h
, (struct in_addr
*)ip
)) {
403 pr_err("allowedips random self-test: FAIL\n");
408 for (i
= 0; i
< NUM_QUERIES
; ++i
) {
409 prandom_bytes(ip
, 16);
410 if (lookup(t
.root6
, 128, ip
) !=
411 horrible_allowedips_lookup_v6(&h
, (struct in6_addr
*)ip
)) {
412 pr_err("allowedips random self-test: FAIL\n");
421 wg_allowedips_free(&t
, &mutex
);
422 mutex_unlock(&mutex
);
423 horrible_allowedips_free(&h
);
425 for (i
= 0; i
< NUM_PEERS
; ++i
)
432 static __init
inline struct in_addr
*ip4(u8 a
, u8 b
, u8 c
, u8 d
)
434 static struct in_addr ip
;
435 u8
*split
= (u8
*)&ip
;
444 static __init
inline struct in6_addr
*ip6(u32 a
, u32 b
, u32 c
, u32 d
)
446 static struct in6_addr ip
;
447 __be32
*split
= (__be32
*)&ip
;
449 split
[0] = cpu_to_be32(a
);
450 split
[1] = cpu_to_be32(b
);
451 split
[2] = cpu_to_be32(c
);
452 split
[3] = cpu_to_be32(d
);
456 static __init
struct wg_peer
*init_peer(void)
458 struct wg_peer
*peer
= kzalloc(sizeof(*peer
), GFP_KERNEL
);
462 kref_init(&peer
->refcount
);
463 INIT_LIST_HEAD(&peer
->allowedips_list
);
467 #define insert(version, mem, ipa, ipb, ipc, ipd, cidr) \
468 wg_allowedips_insert_v##version(&t, ip##version(ipa, ipb, ipc, ipd), \
471 #define maybe_fail() do { \
474 pr_info("allowedips self-test %zu: FAIL\n", i); \
479 #define test(version, mem, ipa, ipb, ipc, ipd) do { \
480 bool _s = lookup(t.root##version, (version) == 4 ? 32 : 128, \
481 ip##version(ipa, ipb, ipc, ipd)) == (mem); \
485 #define test_negative(version, mem, ipa, ipb, ipc, ipd) do { \
486 bool _s = lookup(t.root##version, (version) == 4 ? 32 : 128, \
487 ip##version(ipa, ipb, ipc, ipd)) != (mem); \
491 #define test_boolean(cond) do { \
496 bool __init
wg_allowedips_selftest(void)
498 bool found_a
= false, found_b
= false, found_c
= false, found_d
= false,
499 found_e
= false, found_other
= false;
500 struct wg_peer
*a
= init_peer(), *b
= init_peer(), *c
= init_peer(),
501 *d
= init_peer(), *e
= init_peer(), *f
= init_peer(),
502 *g
= init_peer(), *h
= init_peer();
503 struct allowedips_node
*iter_node
;
504 bool success
= false;
508 size_t i
= 0, count
= 0;
513 wg_allowedips_init(&t
);
515 if (!a
|| !b
|| !c
|| !d
|| !e
|| !f
|| !g
|| !h
) {
516 pr_err("allowedips self-test malloc: FAIL\n");
520 insert(4, a
, 192, 168, 4, 0, 24);
521 insert(4, b
, 192, 168, 4, 4, 32);
522 insert(4, c
, 192, 168, 0, 0, 16);
523 insert(4, d
, 192, 95, 5, 64, 27);
524 /* replaces previous entry, and maskself is required */
525 insert(4, c
, 192, 95, 5, 65, 27);
526 insert(6, d
, 0x26075300, 0x60006b00, 0, 0xc05f0543, 128);
527 insert(6, c
, 0x26075300, 0x60006b00, 0, 0, 64);
528 insert(4, e
, 0, 0, 0, 0, 0);
529 insert(6, e
, 0, 0, 0, 0, 0);
530 /* replaces previous entry */
531 insert(6, f
, 0, 0, 0, 0, 0);
532 insert(6, g
, 0x24046800, 0, 0, 0, 32);
533 /* maskself is required */
534 insert(6, h
, 0x24046800, 0x40040800, 0xdeadbeef, 0xdeadbeef, 64);
535 insert(6, a
, 0x24046800, 0x40040800, 0xdeadbeef, 0xdeadbeef, 128);
536 insert(6, c
, 0x24446800, 0x40e40800, 0xdeaebeef, 0xdefbeef, 128);
537 insert(6, b
, 0x24446800, 0xf0e40800, 0xeeaebeef, 0, 98);
538 insert(4, g
, 64, 15, 112, 0, 20);
539 /* maskself is required */
540 insert(4, h
, 64, 15, 123, 211, 25);
541 insert(4, a
, 10, 0, 0, 0, 25);
542 insert(4, b
, 10, 0, 0, 128, 25);
543 insert(4, a
, 10, 1, 0, 0, 30);
544 insert(4, b
, 10, 1, 0, 4, 30);
545 insert(4, c
, 10, 1, 0, 8, 29);
546 insert(4, d
, 10, 1, 0, 16, 29);
548 if (IS_ENABLED(DEBUG_PRINT_TRIE_GRAPHVIZ
)) {
549 print_tree(t
.root4
, 32);
550 print_tree(t
.root6
, 128);
555 test(4, a
, 192, 168, 4, 20);
556 test(4, a
, 192, 168, 4, 0);
557 test(4, b
, 192, 168, 4, 4);
558 test(4, c
, 192, 168, 200, 182);
559 test(4, c
, 192, 95, 5, 68);
560 test(4, e
, 192, 95, 5, 96);
561 test(6, d
, 0x26075300, 0x60006b00, 0, 0xc05f0543);
562 test(6, c
, 0x26075300, 0x60006b00, 0, 0xc02e01ee);
563 test(6, f
, 0x26075300, 0x60006b01, 0, 0);
564 test(6, g
, 0x24046800, 0x40040806, 0, 0x1006);
565 test(6, g
, 0x24046800, 0x40040806, 0x1234, 0x5678);
566 test(6, f
, 0x240467ff, 0x40040806, 0x1234, 0x5678);
567 test(6, f
, 0x24046801, 0x40040806, 0x1234, 0x5678);
568 test(6, h
, 0x24046800, 0x40040800, 0x1234, 0x5678);
569 test(6, h
, 0x24046800, 0x40040800, 0, 0);
570 test(6, h
, 0x24046800, 0x40040800, 0x10101010, 0x10101010);
571 test(6, a
, 0x24046800, 0x40040800, 0xdeadbeef, 0xdeadbeef);
572 test(4, g
, 64, 15, 116, 26);
573 test(4, g
, 64, 15, 127, 3);
574 test(4, g
, 64, 15, 123, 1);
575 test(4, h
, 64, 15, 123, 128);
576 test(4, h
, 64, 15, 123, 129);
577 test(4, a
, 10, 0, 0, 52);
578 test(4, b
, 10, 0, 0, 220);
579 test(4, a
, 10, 1, 0, 2);
580 test(4, b
, 10, 1, 0, 6);
581 test(4, c
, 10, 1, 0, 10);
582 test(4, d
, 10, 1, 0, 20);
584 insert(4, a
, 1, 0, 0, 0, 32);
585 insert(4, a
, 64, 0, 0, 0, 32);
586 insert(4, a
, 128, 0, 0, 0, 32);
587 insert(4, a
, 192, 0, 0, 0, 32);
588 insert(4, a
, 255, 0, 0, 0, 32);
589 wg_allowedips_remove_by_peer(&t
, a
, &mutex
);
590 test_negative(4, a
, 1, 0, 0, 0);
591 test_negative(4, a
, 64, 0, 0, 0);
592 test_negative(4, a
, 128, 0, 0, 0);
593 test_negative(4, a
, 192, 0, 0, 0);
594 test_negative(4, a
, 255, 0, 0, 0);
596 wg_allowedips_free(&t
, &mutex
);
597 wg_allowedips_init(&t
);
598 insert(4, a
, 192, 168, 0, 0, 16);
599 insert(4, a
, 192, 168, 0, 0, 24);
600 wg_allowedips_remove_by_peer(&t
, a
, &mutex
);
601 test_negative(4, a
, 192, 168, 0, 1);
603 /* These will hit the WARN_ON(len >= 128) in free_node if something
606 for (i
= 0; i
< 128; ++i
) {
607 part
= cpu_to_be64(~(1LLU << (i
% 64)));
608 memset(&ip
, 0xff, 16);
609 memcpy((u8
*)&ip
+ (i
< 64) * 8, &part
, 8);
610 wg_allowedips_insert_v6(&t
, &ip
, 128, a
, &mutex
);
613 wg_allowedips_free(&t
, &mutex
);
615 wg_allowedips_init(&t
);
616 insert(4, a
, 192, 95, 5, 93, 27);
617 insert(6, a
, 0x26075300, 0x60006b00, 0, 0xc05f0543, 128);
618 insert(4, a
, 10, 1, 0, 20, 29);
619 insert(6, a
, 0x26075300, 0x6d8a6bf8, 0xdab1f1df, 0xc05f1523, 83);
620 insert(6, a
, 0x26075300, 0x6d8a6bf8, 0xdab1f1df, 0xc05f1523, 21);
621 list_for_each_entry(iter_node
, &a
->allowedips_list
, peer_list
) {
622 u8 cidr
, ip
[16] __aligned(__alignof(u64
));
623 int family
= wg_allowedips_read_node(iter_node
, ip
, &cidr
);
627 if (cidr
== 27 && family
== AF_INET
&&
628 !memcmp(ip
, ip4(192, 95, 5, 64), sizeof(struct in_addr
)))
630 else if (cidr
== 128 && family
== AF_INET6
&&
631 !memcmp(ip
, ip6(0x26075300, 0x60006b00, 0, 0xc05f0543),
632 sizeof(struct in6_addr
)))
634 else if (cidr
== 29 && family
== AF_INET
&&
635 !memcmp(ip
, ip4(10, 1, 0, 16), sizeof(struct in_addr
)))
637 else if (cidr
== 83 && family
== AF_INET6
&&
638 !memcmp(ip
, ip6(0x26075300, 0x6d8a6bf8, 0xdab1e000, 0),
639 sizeof(struct in6_addr
)))
641 else if (cidr
== 21 && family
== AF_INET6
&&
642 !memcmp(ip
, ip6(0x26075000, 0, 0, 0),
643 sizeof(struct in6_addr
)))
648 test_boolean(count
== 5);
649 test_boolean(found_a
);
650 test_boolean(found_b
);
651 test_boolean(found_c
);
652 test_boolean(found_d
);
653 test_boolean(found_e
);
654 test_boolean(!found_other
);
656 if (IS_ENABLED(DEBUG_RANDOM_TRIE
) && success
)
657 success
= randomized_test();
660 pr_info("allowedips self-tests: pass\n");
663 wg_allowedips_free(&t
, &mutex
);
672 mutex_unlock(&mutex
);