xref: /linux/tools/testing/selftests/net/tcp_ao/key-management.c (revision 5eb0cfedb2588650b63f0a65963ad64272df938d)
1 // SPDX-License-Identifier: GPL-2.0
2 /* Author: Dmitry Safonov <dima@arista.com> */
3 #include <inttypes.h>
4 #include "../../../../include/linux/kernel.h"
5 #include "aolib.h"
6 
7 const size_t nr_packets = 20;
8 const size_t msg_len = 100;
9 const size_t quota = nr_packets * msg_len;
10 union tcp_addr wrong_addr;
11 #define SECOND_PASSWORD	"at all times sincere friends of freedom have been rare"
12 #define fault(type)	(inj == FAULT_ ## type)
13 
14 static const int test_vrf_ifindex = 200;
15 static const uint8_t test_vrf_tabid = 42;
16 static void setup_vrfs(void)
17 {
18 	int err;
19 
20 	if (!kernel_config_has(KCONFIG_NET_VRF))
21 		return;
22 
23 	err = add_vrf("ksft-vrf", test_vrf_tabid, test_vrf_ifindex, -1);
24 	if (err)
25 		test_error("Failed to add a VRF: %d", err);
26 
27 	err = link_set_up("ksft-vrf");
28 	if (err)
29 		test_error("Failed to bring up a VRF");
30 
31 	err = ip_route_add_vrf(veth_name, TEST_FAMILY,
32 			       this_ip_addr, this_ip_dest, test_vrf_tabid);
33 	if (err)
34 		test_error("Failed to add a route to VRF");
35 }
36 
37 
38 static int prepare_sk(union tcp_addr *addr, uint8_t sndid, uint8_t rcvid)
39 {
40 	int sk = socket(test_family, SOCK_STREAM, IPPROTO_TCP);
41 
42 	if (sk < 0)
43 		test_error("socket()");
44 
45 	if (test_add_key(sk, DEFAULT_TEST_PASSWORD, this_ip_dest,
46 			 DEFAULT_TEST_PREFIX, 100, 100))
47 		test_error("test_add_key()");
48 
49 	if (addr && test_add_key(sk, SECOND_PASSWORD, *addr,
50 				 DEFAULT_TEST_PREFIX, sndid, rcvid))
51 		test_error("test_add_key()");
52 
53 	return sk;
54 }
55 
56 static int prepare_lsk(union tcp_addr *addr, uint8_t sndid, uint8_t rcvid)
57 {
58 	int sk = prepare_sk(addr, sndid, rcvid);
59 
60 	if (listen(sk, 10))
61 		test_error("listen()");
62 
63 	return sk;
64 }
65 
66 static int test_del_key(int sk, uint8_t sndid, uint8_t rcvid, bool async,
67 			int current_key, int rnext_key)
68 {
69 	struct tcp_ao_info_opt ao_info = {};
70 	struct tcp_ao_getsockopt key = {};
71 	struct tcp_ao_del del = {};
72 	sockaddr_af sockaddr;
73 	int err;
74 
75 	tcp_addr_to_sockaddr_in(&del.addr, &this_ip_dest, 0);
76 	del.prefix = DEFAULT_TEST_PREFIX;
77 	del.sndid = sndid;
78 	del.rcvid = rcvid;
79 
80 	if (current_key >= 0) {
81 		del.set_current = 1;
82 		del.current_key = (uint8_t)current_key;
83 	}
84 	if (rnext_key >= 0) {
85 		del.set_rnext = 1;
86 		del.rnext = (uint8_t)rnext_key;
87 	}
88 
89 	err = setsockopt(sk, IPPROTO_TCP, TCP_AO_DEL_KEY, &del, sizeof(del));
90 	if (err < 0)
91 		return -errno;
92 
93 	if (async)
94 		return 0;
95 
96 	tcp_addr_to_sockaddr_in(&sockaddr, &this_ip_dest, 0);
97 	err = test_get_one_ao(sk, &key, &sockaddr, sizeof(sockaddr),
98 			      DEFAULT_TEST_PREFIX, sndid, rcvid);
99 	if (!err)
100 		return -EEXIST;
101 	if (err != -E2BIG)
102 		test_error("getsockopt()");
103 	if (current_key < 0 && rnext_key < 0)
104 		return 0;
105 	if (test_get_ao_info(sk, &ao_info))
106 		test_error("getsockopt(TCP_AO_INFO) failed");
107 	if (current_key >= 0 && ao_info.current_key != (uint8_t)current_key)
108 		return -ENOTRECOVERABLE;
109 	if (rnext_key >= 0 && ao_info.rnext != (uint8_t)rnext_key)
110 		return -ENOTRECOVERABLE;
111 	return 0;
112 }
113 
114 static void try_delete_key(char *tst_name, int sk, uint8_t sndid, uint8_t rcvid,
115 			   bool async, int current_key, int rnext_key,
116 			   fault_t inj)
117 {
118 	int err;
119 
120 	err = test_del_key(sk, sndid, rcvid, async, current_key, rnext_key);
121 	if ((err == -EBUSY && fault(BUSY)) || (err == -EINVAL && fault(CURRNEXT))) {
122 		test_ok("%s: key deletion was prevented", tst_name);
123 		return;
124 	}
125 	if (err && fault(FIXME)) {
126 		test_xfail("%s: failed to delete the key %u:%u %d",
127 			   tst_name, sndid, rcvid, err);
128 		return;
129 	}
130 	if (!err) {
131 		if (fault(BUSY) || fault(CURRNEXT)) {
132 			test_fail("%s: the key was deleted %u:%u %d", tst_name,
133 				  sndid, rcvid, err);
134 		} else {
135 			test_ok("%s: the key was deleted", tst_name);
136 		}
137 		return;
138 	}
139 	test_fail("%s: can't delete the key %u:%u %d", tst_name, sndid, rcvid, err);
140 }
141 
142 static int test_set_key(int sk, int current_keyid, int rnext_keyid)
143 {
144 	struct tcp_ao_info_opt ao_info = {};
145 	int err;
146 
147 	if (current_keyid >= 0) {
148 		ao_info.set_current = 1;
149 		ao_info.current_key = (uint8_t)current_keyid;
150 	}
151 	if (rnext_keyid >= 0) {
152 		ao_info.set_rnext = 1;
153 		ao_info.rnext = (uint8_t)rnext_keyid;
154 	}
155 
156 	err = test_set_ao_info(sk, &ao_info);
157 	if (err)
158 		return err;
159 	if (test_get_ao_info(sk, &ao_info))
160 		test_error("getsockopt(TCP_AO_INFO) failed");
161 	if (current_keyid >= 0 && ao_info.current_key != (uint8_t)current_keyid)
162 		return -ENOTRECOVERABLE;
163 	if (rnext_keyid >= 0 && ao_info.rnext != (uint8_t)rnext_keyid)
164 		return -ENOTRECOVERABLE;
165 	return 0;
166 }
167 
168 static int test_add_current_rnext_key(int sk, const char *key, uint8_t keyflags,
169 				      union tcp_addr in_addr, uint8_t prefix,
170 				      bool set_current, bool set_rnext,
171 				      uint8_t sndid, uint8_t rcvid)
172 {
173 	struct tcp_ao_add tmp = {};
174 	int err;
175 
176 	err = test_prepare_key(&tmp, DEFAULT_TEST_ALGO, in_addr,
177 			       set_current, set_rnext,
178 			       prefix, 0, sndid, rcvid, 0, keyflags,
179 			       strlen(key), key);
180 	if (err)
181 		return err;
182 
183 
184 	err = setsockopt(sk, IPPROTO_TCP, TCP_AO_ADD_KEY, &tmp, sizeof(tmp));
185 	if (err < 0)
186 		return -errno;
187 
188 	return test_verify_socket_key(sk, &tmp);
189 }
190 
191 static int __try_add_current_rnext_key(int sk, const char *key, uint8_t keyflags,
192 				       union tcp_addr in_addr, uint8_t prefix,
193 				       bool set_current, bool set_rnext,
194 				       uint8_t sndid, uint8_t rcvid)
195 {
196 	struct tcp_ao_info_opt ao_info = {};
197 	int err;
198 
199 	err = test_add_current_rnext_key(sk, key, keyflags, in_addr, prefix,
200 					 set_current, set_rnext, sndid, rcvid);
201 	if (err)
202 		return err;
203 
204 	if (test_get_ao_info(sk, &ao_info))
205 		test_error("getsockopt(TCP_AO_INFO) failed");
206 	if (set_current && ao_info.current_key != sndid)
207 		return -ENOTRECOVERABLE;
208 	if (set_rnext && ao_info.rnext != rcvid)
209 		return -ENOTRECOVERABLE;
210 	return 0;
211 }
212 
213 static void try_add_current_rnext_key(char *tst_name, int sk, const char *key,
214 				     uint8_t keyflags,
215 				     union tcp_addr in_addr, uint8_t prefix,
216 				     bool set_current, bool set_rnext,
217 				     uint8_t sndid, uint8_t rcvid, fault_t inj)
218 {
219 	int err;
220 
221 	err = __try_add_current_rnext_key(sk, key, keyflags, in_addr, prefix,
222 					  set_current, set_rnext, sndid, rcvid);
223 	if (!err && !fault(CURRNEXT)) {
224 		test_ok("%s", tst_name);
225 		return;
226 	}
227 	if (err == -EINVAL && fault(CURRNEXT)) {
228 		test_ok("%s", tst_name);
229 		return;
230 	}
231 	test_fail("%s", tst_name);
232 }
233 
234 static void check_closed_socket(void)
235 {
236 	int sk;
237 
238 	sk = prepare_sk(&this_ip_dest, 200, 200);
239 	try_delete_key("closed socket, delete a key", sk, 200, 200, 0, -1, -1, 0);
240 	try_delete_key("closed socket, delete all keys", sk, 100, 100, 0, -1, -1, 0);
241 	close(sk);
242 
243 	sk = prepare_sk(&this_ip_dest, 200, 200);
244 	if (test_set_key(sk, 100, 200))
245 		test_error("failed to set current/rnext keys");
246 	try_delete_key("closed socket, delete current key", sk, 100, 100, 0, -1, -1, FAULT_BUSY);
247 	try_delete_key("closed socket, delete rnext key", sk, 200, 200, 0, -1, -1, FAULT_BUSY);
248 	close(sk);
249 
250 	sk = prepare_sk(&this_ip_dest, 200, 200);
251 	if (test_add_key(sk, "Glory to heros!", this_ip_dest,
252 			 DEFAULT_TEST_PREFIX, 10, 11))
253 		test_error("test_add_key()");
254 	if (test_add_key(sk, "Glory to Ukraine!", this_ip_dest,
255 			 DEFAULT_TEST_PREFIX, 12, 13))
256 		test_error("test_add_key()");
257 	try_delete_key("closed socket, delete a key + set current/rnext", sk, 100, 100, 0, 10, 13, 0);
258 	try_delete_key("closed socket, force-delete current key", sk, 10, 11, 0, 200, -1, 0);
259 	try_delete_key("closed socket, force-delete rnext key", sk, 12, 13, 0, -1, 200, 0);
260 	try_delete_key("closed socket, delete current+rnext key", sk, 200, 200, 0, -1, -1, FAULT_BUSY);
261 	close(sk);
262 
263 	sk = prepare_sk(&this_ip_dest, 200, 200);
264 	if (test_set_key(sk, 100, 200))
265 		test_error("failed to set current/rnext keys");
266 	try_add_current_rnext_key("closed socket, add + change current key",
267 				  sk, "Laaaa! Lalala-la-la-lalala...", 0,
268 				  this_ip_dest, DEFAULT_TEST_PREFIX,
269 				  true, false, 10, 20, 0);
270 	try_add_current_rnext_key("closed socket, add + change rnext key",
271 				  sk, "Laaaa! Lalala-la-la-lalala...", 0,
272 				  this_ip_dest, DEFAULT_TEST_PREFIX,
273 				  false, true, 20, 10, 0);
274 	close(sk);
275 }
276 
277 static void assert_no_current_rnext(const char *tst_msg, int sk)
278 {
279 	struct tcp_ao_info_opt ao_info = {};
280 
281 	if (test_get_ao_info(sk, &ao_info))
282 		test_error("getsockopt(TCP_AO_INFO) failed");
283 
284 	errno = 0;
285 	if (ao_info.set_current || ao_info.set_rnext) {
286 		test_xfail("%s: the socket has current/rnext keys: %d:%d",
287 			   tst_msg,
288 			   (ao_info.set_current) ? ao_info.current_key : -1,
289 			   (ao_info.set_rnext) ? ao_info.rnext : -1);
290 	} else {
291 		test_ok("%s: the socket has no current/rnext keys", tst_msg);
292 	}
293 }
294 
295 static void assert_no_tcp_repair(void)
296 {
297 	struct tcp_ao_repair ao_img = {};
298 	socklen_t len = sizeof(ao_img);
299 	int sk, err;
300 
301 	sk = prepare_sk(&this_ip_dest, 200, 200);
302 	test_enable_repair(sk);
303 	if (listen(sk, 10))
304 		test_error("listen()");
305 	errno = 0;
306 	err = getsockopt(sk, SOL_TCP, TCP_AO_REPAIR, &ao_img, &len);
307 	if (err && errno == EPERM)
308 		test_ok("listen socket, getsockopt(TCP_AO_REPAIR) is restricted");
309 	else
310 		test_fail("listen socket, getsockopt(TCP_AO_REPAIR) works");
311 	errno = 0;
312 	err = setsockopt(sk, SOL_TCP, TCP_AO_REPAIR, &ao_img, sizeof(ao_img));
313 	if (err && errno == EPERM)
314 		test_ok("listen socket, setsockopt(TCP_AO_REPAIR) is restricted");
315 	else
316 		test_fail("listen socket, setsockopt(TCP_AO_REPAIR) works");
317 	close(sk);
318 }
319 
320 static void check_listen_socket(void)
321 {
322 	int sk, err;
323 
324 	sk = prepare_lsk(&this_ip_dest, 200, 200);
325 	try_delete_key("listen socket, delete a key", sk, 200, 200, 0, -1, -1, 0);
326 	try_delete_key("listen socket, delete all keys", sk, 100, 100, 0, -1, -1, 0);
327 	close(sk);
328 
329 	sk = prepare_lsk(&this_ip_dest, 200, 200);
330 	err = test_set_key(sk, 100, -1);
331 	if (err == -EINVAL)
332 		test_ok("listen socket, setting current key not allowed");
333 	else
334 		test_fail("listen socket, set current key");
335 	err = test_set_key(sk, -1, 200);
336 	if (err == -EINVAL)
337 		test_ok("listen socket, setting rnext key not allowed");
338 	else
339 		test_fail("listen socket, set rnext key");
340 	close(sk);
341 
342 	sk = prepare_sk(&this_ip_dest, 200, 200);
343 	if (test_set_key(sk, 100, 200))
344 		test_error("failed to set current/rnext keys");
345 	if (listen(sk, 10))
346 		test_error("listen()");
347 	assert_no_current_rnext("listen() after current/rnext keys set", sk);
348 	try_delete_key("listen socket, delete current key from before listen()", sk, 100, 100, 0, -1, -1, FAULT_FIXME);
349 	try_delete_key("listen socket, delete rnext key from before listen()", sk, 200, 200, 0, -1, -1, FAULT_FIXME);
350 	close(sk);
351 
352 	assert_no_tcp_repair();
353 
354 	sk = prepare_lsk(&this_ip_dest, 200, 200);
355 	if (test_add_key(sk, "Glory to heros!", this_ip_dest,
356 			 DEFAULT_TEST_PREFIX, 10, 11))
357 		test_error("test_add_key()");
358 	if (test_add_key(sk, "Glory to Ukraine!", this_ip_dest,
359 			 DEFAULT_TEST_PREFIX, 12, 13))
360 		test_error("test_add_key()");
361 	try_delete_key("listen socket, delete a key + set current/rnext", sk,
362 		       100, 100, 0, 10, 13, FAULT_CURRNEXT);
363 	try_delete_key("listen socket, force-delete current key", sk,
364 		       10, 11, 0, 200, -1, FAULT_CURRNEXT);
365 	try_delete_key("listen socket, force-delete rnext key", sk,
366 		       12, 13, 0, -1, 200, FAULT_CURRNEXT);
367 	try_delete_key("listen socket, delete a key", sk,
368 		       200, 200, 0, -1, -1, 0);
369 	close(sk);
370 
371 	sk = prepare_lsk(&this_ip_dest, 200, 200);
372 	try_add_current_rnext_key("listen socket, add + change current key",
373 				  sk, "Laaaa! Lalala-la-la-lalala...", 0,
374 				  this_ip_dest, DEFAULT_TEST_PREFIX,
375 				  true, false, 10, 20, FAULT_CURRNEXT);
376 	try_add_current_rnext_key("listen socket, add + change rnext key",
377 				  sk, "Laaaa! Lalala-la-la-lalala...", 0,
378 				  this_ip_dest, DEFAULT_TEST_PREFIX,
379 				  false, true, 20, 10, FAULT_CURRNEXT);
380 	close(sk);
381 }
382 
383 struct test_key {
384 	char password[TCP_AO_MAXKEYLEN];
385 	const char *alg;
386 	unsigned int len;
387 	uint8_t client_keyid;
388 	uint8_t server_keyid;
389 	uint8_t maclen;
390 	uint8_t matches_client		: 1,
391 		matches_server		: 1,
392 		matches_vrf		: 1,
393 		is_current		: 1,
394 		is_rnext		: 1,
395 		used_on_server_tx	: 1,
396 		used_on_client_tx	: 1,
397 		skip_counters_checks	: 1;
398 };
399 
400 struct key_collection {
401 	unsigned int nr_keys;
402 	struct test_key *keys;
403 };
404 
405 static struct key_collection collection;
406 
407 #define TEST_MAX_MACLEN		16
408 const char *test_algos[] = { "cmac(aes128)", "hmac(sha1)", "hmac(sha256)" };
409 const unsigned int test_maclens[] = { 1, 4, 12, 16 };
410 #define MACLEN_SHIFT		2
411 #define ALGOS_SHIFT		4
412 
413 static unsigned int make_mask(unsigned int shift, unsigned int prev_shift)
414 {
415 	unsigned int ret = BIT(shift) - 1;
416 
417 	return ret << prev_shift;
418 }
419 
420 static void init_key_in_collection(unsigned int index, bool randomized)
421 {
422 	struct test_key *key = &collection.keys[index];
423 	unsigned int algos_index;
424 
425 	/* Same for randomized and non-randomized test flows */
426 	key->client_keyid = index;
427 	key->server_keyid = 127 + index;
428 	key->matches_client = 1;
429 	key->matches_server = 1;
430 	key->matches_vrf = 1;
431 	/* not really even random, but good enough for a test */
432 	key->len = rand() % (TCP_AO_MAXKEYLEN - TEST_TCP_AO_MINKEYLEN);
433 	key->len += TEST_TCP_AO_MINKEYLEN;
434 	randomize_buffer(key->password, key->len);
435 
436 	if (randomized) {
437 		key->maclen = (rand() % TEST_MAX_MACLEN) + 1;
438 		algos_index = rand();
439 	} else {
440 		unsigned int shift = MACLEN_SHIFT;
441 
442 		key->maclen = test_maclens[index & make_mask(shift, 0)];
443 		algos_index = index & make_mask(ALGOS_SHIFT, shift);
444 	}
445 	key->alg = test_algos[algos_index % ARRAY_SIZE(test_algos)];
446 }
447 
448 static int init_default_key_collection(unsigned int nr_keys, bool randomized)
449 {
450 	size_t key_sz = sizeof(collection.keys[0]);
451 
452 	if (!nr_keys) {
453 		free(collection.keys);
454 		collection.keys = NULL;
455 		return 0;
456 	}
457 
458 	/*
459 	 * All keys have uniq sndid/rcvid and sndid != rcvid in order to
460 	 * check for any bugs/issues for different keyids, visible to both
461 	 * peers. Keyid == 254 is unused.
462 	 */
463 	if (nr_keys > 127)
464 		test_error("Test requires too many keys, correct the source");
465 
466 	collection.keys = reallocarray(collection.keys, nr_keys, key_sz);
467 	if (!collection.keys)
468 		return -ENOMEM;
469 
470 	memset(collection.keys, 0, nr_keys * key_sz);
471 	collection.nr_keys = nr_keys;
472 	while (nr_keys--)
473 		init_key_in_collection(nr_keys, randomized);
474 
475 	return 0;
476 }
477 
478 static void test_key_error(const char *msg, struct test_key *key)
479 {
480 	test_error("%s: key: { %s, %u:%u, %u, %u:%u:%u:%u:%u (%u)}",
481 		   msg, key->alg, key->client_keyid, key->server_keyid,
482 		   key->maclen, key->matches_client, key->matches_server,
483 		   key->matches_vrf, key->is_current, key->is_rnext, key->len);
484 }
485 
486 static int test_add_key_cr(int sk, const char *pwd, unsigned int pwd_len,
487 			   union tcp_addr addr, uint8_t vrf,
488 			   uint8_t sndid, uint8_t rcvid,
489 			   uint8_t maclen, const char *alg,
490 			   bool set_current, bool set_rnext)
491 {
492 	struct tcp_ao_add tmp = {};
493 	uint8_t keyflags = 0;
494 	int err;
495 
496 	if (!alg)
497 		alg = DEFAULT_TEST_ALGO;
498 
499 	if (vrf)
500 		keyflags |= TCP_AO_KEYF_IFINDEX;
501 	err = test_prepare_key(&tmp, alg, addr, set_current, set_rnext,
502 			       DEFAULT_TEST_PREFIX, vrf, sndid, rcvid, maclen,
503 			       keyflags, pwd_len, pwd);
504 	if (err)
505 		return err;
506 
507 	err = setsockopt(sk, IPPROTO_TCP, TCP_AO_ADD_KEY, &tmp, sizeof(tmp));
508 	if (err < 0)
509 		return -errno;
510 
511 	return test_verify_socket_key(sk, &tmp);
512 }
513 
514 static void verify_current_rnext(const char *tst, int sk,
515 				 int current_keyid, int rnext_keyid)
516 {
517 	struct tcp_ao_info_opt ao_info = {};
518 
519 	if (test_get_ao_info(sk, &ao_info))
520 		test_error("getsockopt(TCP_AO_INFO) failed");
521 
522 	errno = 0;
523 	if (current_keyid >= 0) {
524 		if (!ao_info.set_current)
525 			test_fail("%s: the socket doesn't have current key", tst);
526 		else if (ao_info.current_key != current_keyid)
527 			test_fail("%s: current key is not the expected one %d != %u",
528 				  tst, current_keyid, ao_info.current_key);
529 		else
530 			test_ok("%s: current key %u as expected",
531 				tst, ao_info.current_key);
532 	}
533 	if (rnext_keyid >= 0) {
534 		if (!ao_info.set_rnext)
535 			test_fail("%s: the socket doesn't have rnext key", tst);
536 		else if (ao_info.rnext != rnext_keyid)
537 			test_fail("%s: rnext key is not the expected one %d != %u",
538 				  tst, rnext_keyid, ao_info.rnext);
539 		else
540 			test_ok("%s: rnext key %u as expected", tst, ao_info.rnext);
541 	}
542 }
543 
544 
545 static int key_collection_socket(bool server, unsigned int port)
546 {
547 	unsigned int i;
548 	int sk;
549 
550 	if (server)
551 		sk = test_listen_socket(this_ip_addr, port, 1);
552 	else
553 		sk = socket(test_family, SOCK_STREAM, IPPROTO_TCP);
554 	if (sk < 0)
555 		test_error("socket()");
556 
557 	for (i = 0; i < collection.nr_keys; i++) {
558 		struct test_key *key = &collection.keys[i];
559 		union tcp_addr *addr = &wrong_addr;
560 		uint8_t sndid, rcvid, vrf;
561 		bool set_current = false, set_rnext = false;
562 
563 		if (key->matches_vrf)
564 			vrf = 0;
565 		else
566 			vrf = test_vrf_ifindex;
567 		if (server) {
568 			if (key->matches_client)
569 				addr = &this_ip_dest;
570 			sndid = key->server_keyid;
571 			rcvid = key->client_keyid;
572 		} else {
573 			if (key->matches_server)
574 				addr = &this_ip_dest;
575 			sndid = key->client_keyid;
576 			rcvid = key->server_keyid;
577 			key->used_on_client_tx = set_current = key->is_current;
578 			key->used_on_server_tx = set_rnext = key->is_rnext;
579 		}
580 
581 		if (test_add_key_cr(sk, key->password, key->len,
582 				    *addr, vrf, sndid, rcvid, key->maclen,
583 				    key->alg, set_current, set_rnext))
584 			test_key_error("setsockopt(TCP_AO_ADD_KEY)", key);
585 #ifdef DEBUG
586 		test_print("%s [%u/%u] key: { %s, %u:%u, %u, %u:%u:%u:%u (%u)}",
587 			   server ? "server" : "client", i, collection.nr_keys,
588 			   key->alg, rcvid, sndid, key->maclen,
589 			   key->matches_client, key->matches_server,
590 			   key->is_current, key->is_rnext, key->len);
591 #endif
592 	}
593 	return sk;
594 }
595 
596 static void verify_counters(const char *tst_name, bool is_listen_sk, bool server,
597 			    struct tcp_counters *a, struct tcp_counters *b)
598 {
599 	unsigned int i;
600 
601 	test_assert_counters_sk(tst_name, a, b, TEST_CNT_GOOD);
602 
603 	for (i = 0; i < collection.nr_keys; i++) {
604 		struct test_key *key = &collection.keys[i];
605 		uint8_t sndid, rcvid;
606 		bool rx_cnt_expected;
607 
608 		if (key->skip_counters_checks)
609 			continue;
610 		if (server) {
611 			sndid = key->server_keyid;
612 			rcvid = key->client_keyid;
613 			rx_cnt_expected = key->used_on_client_tx;
614 		} else {
615 			sndid = key->client_keyid;
616 			rcvid = key->server_keyid;
617 			rx_cnt_expected = key->used_on_server_tx;
618 		}
619 
620 		test_assert_counters_key(tst_name, &a->ao, &b->ao,
621 					 rx_cnt_expected ? TEST_CNT_KEY_GOOD : 0,
622 					 sndid, rcvid);
623 	}
624 	test_tcp_counters_free(a);
625 	test_tcp_counters_free(b);
626 	test_ok("%s: passed counters checks", tst_name);
627 }
628 
629 static struct tcp_ao_getsockopt *lookup_key(struct tcp_ao_getsockopt *buf,
630 					    size_t len, int sndid, int rcvid)
631 {
632 	size_t i;
633 
634 	for (i = 0; i < len; i++) {
635 		if (sndid >= 0 && buf[i].sndid != sndid)
636 			continue;
637 		if (rcvid >= 0 && buf[i].rcvid != rcvid)
638 			continue;
639 		return &buf[i];
640 	}
641 	return NULL;
642 }
643 
644 static void verify_keys(const char *tst_name, int sk,
645 			bool is_listen_sk, bool server)
646 {
647 	socklen_t len = sizeof(struct tcp_ao_getsockopt);
648 	struct tcp_ao_getsockopt *keys;
649 	bool passed_test = true;
650 	unsigned int i;
651 
652 	keys = calloc(collection.nr_keys, len);
653 	if (!keys)
654 		test_error("calloc()");
655 
656 	keys->nkeys = collection.nr_keys;
657 	keys->get_all = 1;
658 
659 	if (getsockopt(sk, IPPROTO_TCP, TCP_AO_GET_KEYS, keys, &len)) {
660 		free(keys);
661 		test_error("getsockopt(TCP_AO_GET_KEYS)");
662 	}
663 
664 	for (i = 0; i < collection.nr_keys; i++) {
665 		struct test_key *key = &collection.keys[i];
666 		struct tcp_ao_getsockopt *dump_key;
667 		bool is_kdf_aes_128_cmac = false;
668 		bool is_cmac_aes = false;
669 		uint8_t sndid, rcvid;
670 		bool matches = false;
671 
672 		if (server) {
673 			if (key->matches_client)
674 				matches = true;
675 			sndid = key->server_keyid;
676 			rcvid = key->client_keyid;
677 		} else {
678 			if (key->matches_server)
679 				matches = true;
680 			sndid = key->client_keyid;
681 			rcvid = key->server_keyid;
682 		}
683 		if (!key->matches_vrf)
684 			matches = false;
685 		/* no keys get removed on the original listener socket */
686 		if (is_listen_sk)
687 			matches = true;
688 
689 		dump_key = lookup_key(keys, keys->nkeys, sndid, rcvid);
690 		if (matches != !!dump_key) {
691 			test_fail("%s: key %u:%u %s%s on the socket",
692 				  tst_name, sndid, rcvid,
693 				  key->matches_vrf ? "" : "[vrf] ",
694 				  matches ? "disappeared" : "yet present");
695 			passed_test = false;
696 			goto out;
697 		}
698 		if (!dump_key)
699 			continue;
700 
701 		if (!strcmp("cmac(aes128)", key->alg)) {
702 			is_kdf_aes_128_cmac = (key->len != 16);
703 			is_cmac_aes = true;
704 		}
705 
706 		if (is_cmac_aes) {
707 			if (strcmp(dump_key->alg_name, "cmac(aes)")) {
708 				test_fail("%s: key %u:%u cmac(aes) has unexpected alg %s",
709 					  tst_name, sndid, rcvid,
710 					  dump_key->alg_name);
711 				passed_test = false;
712 				continue;
713 			}
714 		} else if (strcmp(dump_key->alg_name, key->alg)) {
715 			test_fail("%s: key %u:%u has unexpected alg %s != %s",
716 				  tst_name, sndid, rcvid,
717 				  dump_key->alg_name, key->alg);
718 			passed_test = false;
719 			continue;
720 		}
721 		if (is_kdf_aes_128_cmac) {
722 			if (dump_key->keylen != 16) {
723 				test_fail("%s: key %u:%u cmac(aes128) has unexpected len %u",
724 					  tst_name, sndid, rcvid,
725 					  dump_key->keylen);
726 				continue;
727 			}
728 		} else if (dump_key->keylen != key->len) {
729 			test_fail("%s: key %u:%u changed password len %u != %u",
730 				  tst_name, sndid, rcvid,
731 				  dump_key->keylen, key->len);
732 			passed_test = false;
733 			continue;
734 		}
735 		if (!is_kdf_aes_128_cmac &&
736 		    memcmp(dump_key->key, key->password, key->len)) {
737 			test_fail("%s: key %u:%u has different password",
738 				  tst_name, sndid, rcvid);
739 			passed_test = false;
740 			continue;
741 		}
742 		if (dump_key->maclen != key->maclen) {
743 			test_fail("%s: key %u:%u changed maclen %u != %u",
744 				  tst_name, sndid, rcvid,
745 				  dump_key->maclen, key->maclen);
746 			passed_test = false;
747 			continue;
748 		}
749 	}
750 
751 	if (passed_test)
752 		test_ok("%s: The socket keys are consistent with the expectations",
753 			tst_name);
754 out:
755 	free(keys);
756 }
757 
758 static int start_server(const char *tst_name, unsigned int port, size_t quota,
759 			struct tcp_counters *begin,
760 			unsigned int current_index, unsigned int rnext_index)
761 {
762 	struct tcp_counters lsk_c1, lsk_c2;
763 	ssize_t bytes;
764 	int sk, lsk;
765 
766 	synchronize_threads(); /* 1: key collection initialized */
767 	lsk = key_collection_socket(true, port);
768 	if (test_get_tcp_counters(lsk, &lsk_c1))
769 		test_error("test_get_tcp_counters()");
770 	synchronize_threads(); /* 2: MKTs added => connect() */
771 	if (test_wait_fd(lsk, TEST_TIMEOUT_SEC, 0))
772 		test_error("test_wait_fd()");
773 
774 	sk = accept(lsk, NULL, NULL);
775 	if (sk < 0)
776 		test_error("accept()");
777 	if (test_get_tcp_counters(sk, begin))
778 		test_error("test_get_tcp_counters()");
779 
780 	synchronize_threads(); /* 3: accepted => send data */
781 	if (test_get_tcp_counters(lsk, &lsk_c2))
782 		test_error("test_get_tcp_counters()");
783 	verify_keys(tst_name, lsk, true, true);
784 	close(lsk);
785 
786 	bytes = test_server_run(sk, quota, TEST_TIMEOUT_SEC);
787 	if (bytes != quota)
788 		test_fail("%s: server served: %zd", tst_name, bytes);
789 	else
790 		test_ok("%s: server alive", tst_name);
791 
792 	verify_counters(tst_name, true, true, &lsk_c1, &lsk_c2);
793 
794 	return sk;
795 }
796 
797 static void end_server(const char *tst_name, int sk,
798 		       struct tcp_counters *begin)
799 {
800 	struct tcp_counters end;
801 
802 	if (test_get_tcp_counters(sk, &end))
803 		test_error("test_get_tcp_counters()");
804 	verify_keys(tst_name, sk, false, true);
805 
806 	synchronize_threads(); /* 4: verified => closed */
807 	close(sk);
808 
809 	verify_counters(tst_name, false, true, begin, &end);
810 	synchronize_threads(); /* 5: counters */
811 }
812 
813 static void try_server_run(const char *tst_name, unsigned int port, size_t quota,
814 			   unsigned int current_index, unsigned int rnext_index)
815 {
816 	struct tcp_counters tmp;
817 	int sk;
818 
819 	sk = start_server(tst_name, port, quota, &tmp,
820 			  current_index, rnext_index);
821 	end_server(tst_name, sk, &tmp);
822 }
823 
824 static void server_rotations(const char *tst_name, unsigned int port,
825 			     size_t quota, unsigned int rotations,
826 			     unsigned int current_index, unsigned int rnext_index)
827 {
828 	struct tcp_counters tmp;
829 	unsigned int i;
830 	int sk;
831 
832 	sk = start_server(tst_name, port, quota, &tmp,
833 			  current_index, rnext_index);
834 
835 	for (i = current_index + 1; rotations > 0; i++, rotations--) {
836 		ssize_t bytes;
837 
838 		if (i >= collection.nr_keys)
839 			i = 0;
840 		bytes = test_server_run(sk, quota, TEST_TIMEOUT_SEC);
841 		if (bytes != quota) {
842 			test_fail("%s: server served: %zd", tst_name, bytes);
843 			return;
844 		}
845 		verify_current_rnext(tst_name, sk,
846 				     collection.keys[i].server_keyid, -1);
847 		synchronize_threads(); /* verify current/rnext */
848 	}
849 	end_server(tst_name, sk, &tmp);
850 }
851 
852 static int run_client(const char *tst_name, unsigned int port,
853 		      unsigned int nr_keys, int current_index, int rnext_index,
854 		      struct tcp_counters *before,
855 		      const size_t msg_sz, const size_t msg_nr)
856 {
857 	int sk;
858 
859 	synchronize_threads(); /* 1: key collection initialized */
860 	sk = key_collection_socket(false, port);
861 
862 	if (current_index >= 0 || rnext_index >= 0) {
863 		int sndid = -1, rcvid = -1;
864 
865 		if (current_index >= 0)
866 			sndid = collection.keys[current_index].client_keyid;
867 		if (rnext_index >= 0)
868 			rcvid = collection.keys[rnext_index].server_keyid;
869 		if (test_set_key(sk, sndid, rcvid))
870 			test_error("failed to set current/rnext keys");
871 	}
872 	if (before && test_get_tcp_counters(sk, before))
873 		test_error("test_get_tcp_counters()");
874 
875 	synchronize_threads(); /* 2: MKTs added => connect() */
876 	if (test_connect_socket(sk, this_ip_dest, port++) <= 0)
877 		test_error("failed to connect()");
878 	if (current_index < 0)
879 		current_index = nr_keys - 1;
880 	if (rnext_index < 0)
881 		rnext_index = nr_keys - 1;
882 	collection.keys[current_index].used_on_client_tx = 1;
883 	collection.keys[rnext_index].used_on_server_tx = 1;
884 
885 	synchronize_threads(); /* 3: accepted => send data */
886 	if (test_client_verify(sk, msg_sz, msg_nr)) {
887 		test_fail("verify failed");
888 		close(sk);
889 		if (before)
890 			test_tcp_counters_free(before);
891 		return -1;
892 	}
893 
894 	return sk;
895 }
896 
897 static int start_client(const char *tst_name, unsigned int port,
898 			unsigned int nr_keys, int current_index, int rnext_index,
899 			struct tcp_counters *before,
900 			const size_t msg_sz, const size_t msg_nr)
901 {
902 	if (init_default_key_collection(nr_keys, true))
903 		test_error("Failed to init the key collection");
904 
905 	return run_client(tst_name, port, nr_keys, current_index,
906 			  rnext_index, before, msg_sz, msg_nr);
907 }
908 
909 static void end_client(const char *tst_name, int sk, unsigned int nr_keys,
910 		       int current_index, int rnext_index,
911 		       struct tcp_counters *start)
912 {
913 	struct tcp_counters end;
914 
915 	/* Some application may become dependent on this kernel choice */
916 	if (current_index < 0)
917 		current_index = nr_keys - 1;
918 	if (rnext_index < 0)
919 		rnext_index = nr_keys - 1;
920 	verify_current_rnext(tst_name, sk,
921 			     collection.keys[current_index].client_keyid,
922 			     collection.keys[rnext_index].server_keyid);
923 	if (start && test_get_tcp_counters(sk, &end))
924 		test_error("test_get_tcp_counters()");
925 	verify_keys(tst_name, sk, false, false);
926 	synchronize_threads(); /* 4: verify => closed */
927 	close(sk);
928 	if (start)
929 		verify_counters(tst_name, false, false, start, &end);
930 	synchronize_threads(); /* 5: counters */
931 }
932 
933 static void try_unmatched_keys(int sk, int *rnext_index, unsigned int port)
934 {
935 	struct test_key *key;
936 	unsigned int i = 0;
937 	int err;
938 
939 	do {
940 		key = &collection.keys[i];
941 		if (!key->matches_server)
942 			break;
943 	} while (++i < collection.nr_keys);
944 	if (key->matches_server)
945 		test_error("all keys on client match the server");
946 
947 	err = test_add_key_cr(sk, key->password, key->len, wrong_addr,
948 			      0, key->client_keyid, key->server_keyid,
949 			      key->maclen, key->alg, 0, 0);
950 	if (!err) {
951 		test_fail("Added a key with non-matching ip-address for established sk");
952 		return;
953 	}
954 	if (err == -EINVAL)
955 		test_ok("Can't add a key with non-matching ip-address for established sk");
956 	else
957 		test_error("Failed to add a key");
958 
959 	err = test_add_key_cr(sk, key->password, key->len, this_ip_dest,
960 			      test_vrf_ifindex,
961 			      key->client_keyid, key->server_keyid,
962 			      key->maclen, key->alg, 0, 0);
963 	if (!err) {
964 		test_fail("Added a key with non-matching VRF for established sk");
965 		return;
966 	}
967 	if (err == -EINVAL)
968 		test_ok("Can't add a key with non-matching VRF for established sk");
969 	else
970 		test_error("Failed to add a key");
971 
972 	for (i = 0; i < collection.nr_keys; i++) {
973 		key = &collection.keys[i];
974 		if (!key->matches_client)
975 			break;
976 	}
977 	if (key->matches_client)
978 		test_error("all keys on server match the client");
979 	if (test_set_key(sk, -1, key->server_keyid))
980 		test_error("Can't change the current key");
981 	trace_ao_event_expect(TCP_AO_RNEXT_REQUEST, this_ip_addr, this_ip_dest,
982 			      -1, port, 0, -1, -1, -1, -1, -1,
983 			      -1, key->server_keyid, -1);
984 	if (test_client_verify(sk, msg_len, nr_packets))
985 		test_fail("verify failed");
986 	*rnext_index = i;
987 }
988 
989 static int client_non_matching(const char *tst_name, unsigned int port,
990 			       unsigned int nr_keys,
991 			       int current_index, int rnext_index,
992 			       const size_t msg_sz, const size_t msg_nr)
993 {
994 	unsigned int i;
995 
996 	if (init_default_key_collection(nr_keys, true))
997 		test_error("Failed to init the key collection");
998 
999 	for (i = 0; i < nr_keys; i++) {
1000 		/* key (0, 0) matches */
1001 		collection.keys[i].matches_client = !!((i + 3) % 4);
1002 		collection.keys[i].matches_server = !!((i + 2) % 4);
1003 		if (kernel_config_has(KCONFIG_NET_VRF))
1004 			collection.keys[i].matches_vrf = !!((i + 1) % 4);
1005 	}
1006 
1007 	return run_client(tst_name, port, nr_keys, current_index,
1008 			  rnext_index, NULL, msg_sz, msg_nr);
1009 }
1010 
1011 static void check_current_back(const char *tst_name, unsigned int port,
1012 			       unsigned int nr_keys,
1013 			       unsigned int current_index, unsigned int rnext_index,
1014 			       unsigned int rotate_to_index)
1015 {
1016 	struct tcp_counters tmp;
1017 	int sk;
1018 
1019 	sk = start_client(tst_name, port, nr_keys, current_index, rnext_index,
1020 			  &tmp, msg_len, nr_packets);
1021 	if (sk < 0)
1022 		return;
1023 	if (test_set_key(sk, collection.keys[rotate_to_index].client_keyid, -1))
1024 		test_error("Can't change the current key");
1025 	trace_ao_event_expect(TCP_AO_RNEXT_REQUEST, this_ip_dest, this_ip_addr,
1026 			      port, -1, 0, -1, -1, -1, -1, -1,
1027 			      collection.keys[rotate_to_index].client_keyid,
1028 			      collection.keys[current_index].client_keyid, -1);
1029 	if (test_client_verify(sk, msg_len, nr_packets))
1030 		test_fail("verify failed");
1031 	/* There is a race here: between setting the current_key with
1032 	 * setsockopt(TCP_AO_INFO) and starting to send some data - there
1033 	 * might have been a segment received with the desired
1034 	 * RNext_key set. In turn that would mean that the first outgoing
1035 	 * segment will have the desired current_key (flipped back).
1036 	 * Which is what the user/test wants. As it's racy, skip checking
1037 	 * the counters, yet check what are the resulting current/rnext
1038 	 * keys on both sides.
1039 	 */
1040 	collection.keys[rotate_to_index].skip_counters_checks = 1;
1041 
1042 	end_client(tst_name, sk, nr_keys, current_index, rnext_index, &tmp);
1043 }
1044 
1045 static void roll_over_keys(const char *tst_name, unsigned int port,
1046 			   unsigned int nr_keys, unsigned int rotations,
1047 			   unsigned int current_index, unsigned int rnext_index)
1048 {
1049 	struct tcp_counters tmp;
1050 	unsigned int i;
1051 	int sk;
1052 
1053 	sk = start_client(tst_name, port, nr_keys, current_index, rnext_index,
1054 			  &tmp, msg_len, nr_packets);
1055 	if (sk < 0)
1056 		return;
1057 	for (i = rnext_index + 1; rotations > 0; i++, rotations--) {
1058 		if (i >= collection.nr_keys)
1059 			i = 0;
1060 		trace_ao_event_expect(TCP_AO_RNEXT_REQUEST,
1061 				this_ip_addr, this_ip_dest,
1062 				-1, port, 0, -1, -1, -1, -1, -1,
1063 				i == 0 ? -1 : collection.keys[i - 1].server_keyid,
1064 				collection.keys[i].server_keyid, -1);
1065 		if (test_set_key(sk, -1, collection.keys[i].server_keyid))
1066 			test_error("Can't change the Rnext key");
1067 		if (test_client_verify(sk, msg_len, nr_packets)) {
1068 			test_fail("verify failed");
1069 			close(sk);
1070 			test_tcp_counters_free(&tmp);
1071 			return;
1072 		}
1073 		verify_current_rnext(tst_name, sk, -1,
1074 				     collection.keys[i].server_keyid);
1075 		collection.keys[i].used_on_server_tx = 1;
1076 		synchronize_threads(); /* verify current/rnext */
1077 	}
1078 	end_client(tst_name, sk, nr_keys, current_index, rnext_index, &tmp);
1079 }
1080 
1081 static void try_client_run(const char *tst_name, unsigned int port,
1082 			   unsigned int nr_keys, int current_index, int rnext_index)
1083 {
1084 	struct tcp_counters tmp;
1085 	int sk;
1086 
1087 	sk = start_client(tst_name, port, nr_keys, current_index, rnext_index,
1088 			  &tmp, msg_len, nr_packets);
1089 	if (sk < 0)
1090 		return;
1091 	end_client(tst_name, sk, nr_keys, current_index, rnext_index, &tmp);
1092 }
1093 
1094 static void try_client_match(const char *tst_name, unsigned int port,
1095 			     unsigned int nr_keys,
1096 			     int current_index, int rnext_index)
1097 {
1098 	int sk;
1099 
1100 	sk = client_non_matching(tst_name, port, nr_keys, current_index,
1101 				 rnext_index, msg_len, nr_packets);
1102 	if (sk < 0)
1103 		return;
1104 	try_unmatched_keys(sk, &rnext_index, port);
1105 	end_client(tst_name, sk, nr_keys, current_index, rnext_index, NULL);
1106 }
1107 
1108 static void *server_fn(void *arg)
1109 {
1110 	unsigned int port = test_server_port;
1111 
1112 	setup_vrfs();
1113 	try_server_run("server: Check current/rnext keys unset before connect()",
1114 		       port++, quota, 19, 19);
1115 	try_server_run("server: Check current/rnext keys set before connect()",
1116 		       port++, quota, 10, 10);
1117 	try_server_run("server: Check current != rnext keys set before connect()",
1118 		       port++, quota, 5, 10);
1119 	try_server_run("server: Check current flapping back on peer's RnextKey request",
1120 		       port++, quota * 2, 5, 10);
1121 	server_rotations("server: Rotate over all different keys", port++,
1122 			 quota, 20, 0, 0);
1123 	try_server_run("server: Check accept() => established key matching",
1124 		       port++, quota * 2, 0, 0);
1125 
1126 	synchronize_threads(); /* don't race to exit: client exits */
1127 	return NULL;
1128 }
1129 
1130 static void check_established_socket(void)
1131 {
1132 	unsigned int port = test_server_port;
1133 
1134 	setup_vrfs();
1135 	try_client_run("client: Check current/rnext keys unset before connect()",
1136 		       port++, 20, -1, -1);
1137 	try_client_run("client: Check current/rnext keys set before connect()",
1138 		       port++, 20, 10, 10);
1139 	try_client_run("client: Check current != rnext keys set before connect()",
1140 		       port++, 20, 10, 5);
1141 	check_current_back("client: Check current flapping back on peer's RnextKey request",
1142 			   port++, 20, 10, 5, 2);
1143 	roll_over_keys("client: Rotate over all different keys", port++,
1144 		       20, 20, 0, 0);
1145 	try_client_match("client: Check connect() => established key matching",
1146 			 port++, 20, 0, 0);
1147 }
1148 
1149 static void *client_fn(void *arg)
1150 {
1151 	if (inet_pton(TEST_FAMILY, TEST_WRONG_IP, &wrong_addr) != 1)
1152 		test_error("Can't convert ip address %s", TEST_WRONG_IP);
1153 	check_closed_socket();
1154 	check_listen_socket();
1155 	check_established_socket();
1156 	return NULL;
1157 }
1158 
1159 int main(int argc, char *argv[])
1160 {
1161 	test_init(121, server_fn, client_fn);
1162 	return 0;
1163 }
1164