cryptotest.c revision 306296 
1/*-
2 * Copyright (c) 2004 Sam Leffler, Errno Consulting
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer,
10 *    without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13 *    redistribution must be conditioned upon including a substantially
14 *    similar Disclaimer requirement for further binary redistribution.
15 * 3. Neither the names of the above-listed copyright holders nor the names
16 *    of any contributors may be used to endorse or promote products derived
17 *    from this software without specific prior written permission.
18 *
19 * NO WARRANTY
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
23 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
24 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
25 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
28 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30 * THE POSSIBILITY OF SUCH DAMAGES.
31 *
32 * $FreeBSD: stable/11/tools/tools/crypto/cryptotest.c 306296 2016-09-24 13:44:18Z gnn $
33 */
34
35/*
36 * Simple tool for testing hardware/system crypto support.
37 *
38 * cryptotest [-czsbv] [-a algorithm] [count] [size ...]
39 *
40 * Run count iterations of a crypt+decrypt or mac operation on a buffer of
41 * size bytes.  A random key and iv are used.  Options:
42 *	-c	check the results
43 *	-d dev	pin work on device dev
44 *	-z	run all available algorithms on a variety of buffer sizes
45 *	-v	be verbose
46 *	-b	mark operations for batching
47 *	-p	profile kernel crypto operations (must be root)
48 *	-t n	fork n threads and run tests concurrently
49 * Known algorithms are:
50 *	null	null cbc
51 *	des	des cbc
52 *	3des	3des cbc
53 *	blf	blowfish cbc
54 *	cast	cast cbc
55 *	skj	skipjack cbc
56 *	aes	rijndael/aes 128-bit cbc
57 *	aes192	rijndael/aes 192-bit cbc
58 *	aes256	rijndael/aes 256-bit cbc
59 *	md5	md5 hmac
60 *	sha1	sha1 hmac
61 *	sha256	256-bit sha2 hmac
62 *	sha384	384-bit sha2 hmac
63 *	sha512	512--bit sha2 hmac
64 *
65 * For a test of how fast a crypto card is, use something like:
66 *	cryptotest -z 1024
67 * This will run a series of tests using the available crypto/cipher
68 * algorithms over a variety of buffer sizes.  The 1024 says to do 1024
69 * iterations.  Extra arguments can be used to specify one or more buffer
70 * sizes to use in doing tests.
71 *
72 * To fork multiple processes all doing the same work, specify -t X on the
73 * command line to get X "threads" running simultaneously.  No effort is made
74 * to synchronize the threads or otherwise maximize load.
75 *
76 * If the kernel crypto code is built with CRYPTO_TIMING and you run as root,
77 * then you can specify the -p option to get a "profile" of the time spent
78 * processing crypto operations.  At present this data is only meaningful for
79 * symmetric operations.  To get meaningful numbers you must run on an idle
80 * machine.
81 *
82 * Expect ~400 Mb/s for a Broadcom 582x for 8K buffers on a reasonable CPU
83 * (64-bit PCI helps).  Hifn 7811 parts top out at ~110 Mb/s.
84 */
85
86#include <sys/param.h>
87#include <sys/cpuset.h>
88#include <sys/ioctl.h>
89#include <sys/mman.h>
90#include <sys/sysctl.h>
91#include <sys/time.h>
92#include <sys/wait.h>
93
94#include <err.h>
95#include <fcntl.h>
96#include <paths.h>
97#include <stdio.h>
98#include <stdlib.h>
99#include <string.h>
100#include <sysexits.h>
101#include <unistd.h>
102
103#include <crypto/cryptodev.h>
104
105#define	CHUNK	64	/* how much to display */
106#define	streq(a,b)	(strcasecmp(a,b) == 0)
107
108void	hexdump(char *, int);
109
110int	verbose = 0;
111int	opflags = 0;
112int	verify = 0;
113int	crid = CRYPTO_FLAG_HARDWARE;
114
115struct alg {
116	const char* name;
117	int	ishash;
118	int	blocksize;
119	int	minkeylen;
120	int	maxkeylen;
121	int	code;
122} algorithms[] = {
123#ifdef CRYPTO_NULL_CBC
124	{ "null",	0,	8,	1,	256,	CRYPTO_NULL_CBC },
125#endif
126	{ "des",	0,	8,	8,	8,	CRYPTO_DES_CBC },
127	{ "3des",	0,	8,	24,	24,	CRYPTO_3DES_CBC },
128	{ "blf",	0,	8,	5,	56,	CRYPTO_BLF_CBC },
129	{ "cast",	0,	8,	5,	16,	CRYPTO_CAST_CBC },
130	{ "skj",	0,	8,	10,	10,	CRYPTO_SKIPJACK_CBC },
131	{ "rij",	0,	16,	16,	16,	CRYPTO_RIJNDAEL128_CBC},
132	{ "aes",	0,	16,	16,	16,	CRYPTO_AES_CBC},
133	{ "aes192",	0,	16,	24,	24,	CRYPTO_AES_CBC},
134	{ "aes256",	0,	16,	32,	32,	CRYPTO_AES_CBC},
135	{ "md5",	1,	8,	16,	16,	CRYPTO_MD5_HMAC },
136	{ "sha1",	1,	8,	20,	20,	CRYPTO_SHA1_HMAC },
137	{ "sha256",	1,	8,	32,	32,	CRYPTO_SHA2_256_HMAC },
138	{ "sha384",	1,	8,	48,	48,	CRYPTO_SHA2_384_HMAC },
139	{ "sha512",	1,	8,	64,	64,	CRYPTO_SHA2_512_HMAC },
140};
141
142void
143usage(const char* cmd)
144{
145	printf("usage: %s [-czsbv] [-d dev] [-a algorithm] [count] [size ...]\n",
146		cmd);
147	printf("where algorithm is one of:\n");
148	printf("    null des 3des (default) blowfish cast skipjack rij\n");
149	printf("    aes aes192 aes256 md5 sha1 sha256 sha384 sha512\n");
150	printf("count is the number of encrypt/decrypt ops to do\n");
151	printf("size is the number of bytes of text to encrypt+decrypt\n");
152	printf("\n");
153	printf("-c check the results (slows timing)\n");
154	printf("-d use specific device, specify 'soft' for testing software implementations\n");
155	printf("\tNOTE: to use software you must set:\n\t sysctl kern.cryptodevallowsoft=1\n");
156	printf("-z run all available algorithms on a variety of sizes\n");
157	printf("-v be verbose\n");
158	printf("-b mark operations for batching\n");
159	printf("-p profile kernel crypto operation (must be root)\n");
160	printf("-t n for n threads and run tests concurrently\n");
161	exit(-1);
162}
163
164struct alg*
165getalgbycode(int cipher)
166{
167	int i;
168
169	for (i = 0; i < nitems(algorithms); i++)
170		if (cipher == algorithms[i].code)
171			return &algorithms[i];
172	return NULL;
173}
174
175struct alg*
176getalgbyname(const char* name)
177{
178	int i;
179
180	for (i = 0; i < nitems(algorithms); i++)
181		if (streq(name, algorithms[i].name))
182			return &algorithms[i];
183	return NULL;
184}
185
186int
187devcrypto(void)
188{
189	int fd = -1;
190
191	if (fd < 0) {
192		fd = open(_PATH_DEV "crypto", O_RDWR, 0);
193		if (fd < 0)
194			err(1, _PATH_DEV "crypto");
195		if (fcntl(fd, F_SETFD, 1) == -1)
196			err(1, "fcntl(F_SETFD) (devcrypto)");
197	}
198	return fd;
199}
200
201int
202crlookup(const char *devname)
203{
204	struct crypt_find_op find;
205
206	if (strncmp(devname, "soft", 4) == 0)
207		return CRYPTO_FLAG_SOFTWARE;
208
209	find.crid = -1;
210	strlcpy(find.name, devname, sizeof(find.name));
211	if (ioctl(devcrypto(), CIOCFINDDEV, &find) == -1)
212		err(1, "ioctl(CIOCFINDDEV)");
213	return find.crid;
214}
215
216const char *
217crfind(int crid)
218{
219	struct crypt_find_op find;
220
221	bzero(&find, sizeof(find));
222	find.crid = crid;
223	if (ioctl(devcrypto(), CRIOFINDDEV, &find) == -1)
224		err(1, "ioctl(CIOCFINDDEV): crid %d", crid);
225	return find.name;
226}
227
228int
229crget(void)
230{
231	int fd;
232
233	if (ioctl(devcrypto(), CRIOGET, &fd) == -1)
234		err(1, "ioctl(CRIOGET)");
235	if (fcntl(fd, F_SETFD, 1) == -1)
236		err(1, "fcntl(F_SETFD) (crget)");
237	return fd;
238}
239
240char
241rdigit(void)
242{
243	const char a[] = {
244		0x10,0x54,0x11,0x48,0x45,0x12,0x4f,0x13,0x49,0x53,0x14,0x41,
245		0x15,0x16,0x4e,0x55,0x54,0x17,0x18,0x4a,0x4f,0x42,0x19,0x01
246	};
247	return 0x20+a[random()%nitems(a)];
248}
249
250void
251runtest(struct alg *alg, int count, int size, u_long cmd, struct timeval *tv)
252{
253	int i, fd = crget();
254	struct timeval start, stop, dt;
255	char *cleartext, *ciphertext, *originaltext;
256	struct session2_op sop;
257	struct crypt_op cop;
258	char iv[EALG_MAX_BLOCK_LEN];
259
260	bzero(&sop, sizeof(sop));
261	if (!alg->ishash) {
262		sop.keylen = (alg->minkeylen + alg->maxkeylen)/2;
263		sop.key = (char *) malloc(sop.keylen);
264		if (sop.key == NULL)
265			err(1, "malloc (key)");
266		for (i = 0; i < sop.keylen; i++)
267			sop.key[i] = rdigit();
268		sop.cipher = alg->code;
269	} else {
270		sop.mackeylen = (alg->minkeylen + alg->maxkeylen)/2;
271		sop.mackey = (char *) malloc(sop.mackeylen);
272		if (sop.mackey == NULL)
273			err(1, "malloc (mac)");
274		for (i = 0; i < sop.mackeylen; i++)
275			sop.mackey[i] = rdigit();
276		sop.mac = alg->code;
277	}
278	sop.crid = crid;
279	if (ioctl(fd, cmd, &sop) < 0) {
280		if (cmd == CIOCGSESSION || cmd == CIOCGSESSION2) {
281			close(fd);
282			if (verbose) {
283				printf("cipher %s", alg->name);
284				if (alg->ishash)
285					printf(" mackeylen %u\n", sop.mackeylen);
286				else
287					printf(" keylen %u\n", sop.keylen);
288				perror("CIOCGSESSION");
289			}
290			/* hardware doesn't support algorithm; skip it */
291			return;
292		}
293		printf("cipher %s keylen %u mackeylen %u\n",
294			alg->name, sop.keylen, sop.mackeylen);
295		err(1, "CIOCGSESSION");
296	}
297
298	originaltext = malloc(3*size);
299	if (originaltext == NULL)
300		err(1, "malloc (text)");
301	cleartext = originaltext+size;
302	ciphertext = cleartext+size;
303	for (i = 0; i < size; i++)
304		cleartext[i] = rdigit();
305	memcpy(originaltext, cleartext, size);
306	for (i = 0; i < nitems(iv); i++)
307		iv[i] = rdigit();
308
309	if (verbose) {
310		printf("session = 0x%x\n", sop.ses);
311		printf("device = %s\n", crfind(sop.crid));
312		printf("count = %d, size = %d\n", count, size);
313		if (!alg->ishash) {
314			printf("iv:");
315			hexdump(iv, sizeof iv);
316		}
317		printf("cleartext:");
318		hexdump(cleartext, MIN(size, CHUNK));
319	}
320
321	gettimeofday(&start, NULL);
322	if (!alg->ishash) {
323		for (i = 0; i < count; i++) {
324			cop.ses = sop.ses;
325			cop.op = COP_ENCRYPT;
326			cop.flags = opflags;
327			cop.len = size;
328			cop.src = cleartext;
329			cop.dst = ciphertext;
330			cop.mac = 0;
331			cop.iv = iv;
332
333			if (ioctl(fd, CIOCCRYPT, &cop) < 0)
334				err(1, "ioctl(CIOCCRYPT)");
335
336			if (verify && bcmp(ciphertext, cleartext, size) == 0) {
337				printf("cipher text unchanged:");
338				hexdump(ciphertext, size);
339			}
340
341			memset(cleartext, 'x', MIN(size, CHUNK));
342			cop.ses = sop.ses;
343			cop.op = COP_DECRYPT;
344			cop.flags = opflags;
345			cop.len = size;
346			cop.src = ciphertext;
347			cop.dst = cleartext;
348			cop.mac = 0;
349			cop.iv = iv;
350
351			if (ioctl(fd, CIOCCRYPT, &cop) < 0)
352				err(1, "ioctl(CIOCCRYPT)");
353
354			if (verify && bcmp(cleartext, originaltext, size) != 0) {
355				printf("decrypt mismatch:\n");
356				printf("original:");
357				hexdump(originaltext, size);
358				printf("cleartext:");
359				hexdump(cleartext, size);
360			}
361		}
362	} else {
363		for (i = 0; i < count; i++) {
364			cop.ses = sop.ses;
365			cop.op = 0;
366			cop.flags = opflags;
367			cop.len = size;
368			cop.src = cleartext;
369			cop.dst = 0;
370			cop.mac = ciphertext;
371			cop.iv = 0;
372
373			if (ioctl(fd, CIOCCRYPT, &cop) < 0)
374				err(1, "ioctl(CIOCCRYPT)");
375		}
376	}
377	gettimeofday(&stop, NULL);
378
379	if (ioctl(fd, CIOCFSESSION, &sop.ses) < 0)
380		perror("ioctl(CIOCFSESSION)");
381
382	if (verbose) {
383		printf("cleartext:");
384		hexdump(cleartext, MIN(size, CHUNK));
385	}
386	timersub(&stop, &start, tv);
387
388	free(originaltext);
389
390	close(fd);
391}
392
393#ifdef __FreeBSD__
394void
395resetstats()
396{
397	struct cryptostats stats;
398	size_t slen;
399
400	slen = sizeof (stats);
401	if (sysctlbyname("kern.crypto_stats", &stats, &slen, NULL, 0) < 0) {
402		perror("kern.crypto_stats");
403		return;
404	}
405	bzero(&stats.cs_invoke, sizeof (stats.cs_invoke));
406	bzero(&stats.cs_done, sizeof (stats.cs_done));
407	bzero(&stats.cs_cb, sizeof (stats.cs_cb));
408	bzero(&stats.cs_finis, sizeof (stats.cs_finis));
409	stats.cs_invoke.min.tv_sec = 10000;
410	stats.cs_done.min.tv_sec = 10000;
411	stats.cs_cb.min.tv_sec = 10000;
412	stats.cs_finis.min.tv_sec = 10000;
413	if (sysctlbyname("kern.crypto_stats", NULL, NULL, &stats, sizeof (stats)) < 0)
414		perror("kern.cryptostats");
415}
416
417void
418printt(const char* tag, struct cryptotstat *ts)
419{
420	uint64_t avg, min, max;
421
422	if (ts->count == 0)
423		return;
424	avg = (1000000000LL*ts->acc.tv_sec + ts->acc.tv_nsec) / ts->count;
425	min = 1000000000LL*ts->min.tv_sec + ts->min.tv_nsec;
426	max = 1000000000LL*ts->max.tv_sec + ts->max.tv_nsec;
427	printf("%16.16s: avg %6llu ns : min %6llu ns : max %7llu ns [%u samps]\n",
428		tag, avg, min, max, ts->count);
429}
430#endif
431
432void
433runtests(struct alg *alg, int count, int size, u_long cmd, int threads, int profile)
434{
435	int i, status;
436	double t;
437	void *region;
438	struct timeval *tvp;
439	struct timeval total;
440	int otiming;
441
442	if (size % alg->blocksize) {
443		if (verbose)
444			printf("skipping blocksize %u 'cuz not a multiple of "
445				"%s blocksize %u\n",
446				size, alg->name, alg->blocksize);
447		return;
448	}
449
450	region = mmap(NULL, threads * sizeof (struct timeval),
451			PROT_READ|PROT_WRITE, MAP_ANON|MAP_SHARED, -1, 0);
452	if (region == MAP_FAILED) {
453		perror("mmap");
454		return;
455	}
456	tvp = (struct timeval *) region;
457#ifdef __FreeBSD__
458	if (profile) {
459		size_t tlen = sizeof (otiming);
460		int timing = 1;
461
462		resetstats();
463		if (sysctlbyname("debug.crypto_timing", &otiming, &tlen,
464				&timing, sizeof (timing)) < 0)
465			perror("debug.crypto_timing");
466	}
467#endif
468
469	if (threads > 1) {
470		for (i = 0; i < threads; i++)
471			if (fork() == 0) {
472				cpuset_t mask;
473				CPU_ZERO(&mask);
474				CPU_SET(i, &mask);
475				cpuset_setaffinity(CPU_LEVEL_WHICH, CPU_WHICH_PID,
476				    -1, sizeof(mask), &mask);
477				runtest(alg, count, size, cmd, &tvp[i]);
478				exit(0);
479			}
480		while (waitpid(WAIT_MYPGRP, &status, 0) != -1)
481			;
482	} else
483		runtest(alg, count, size, cmd, tvp);
484
485	t = 0;
486	for (i = 0; i < threads; i++)
487		t += (((double)tvp[i].tv_sec * 1000000 + tvp[i].tv_usec) / 1000000);
488	if (t) {
489		int nops = alg->ishash ? count : 2*count;
490
491		nops *= threads;
492		printf("%8.3lf sec, %7d %6s crypts, %7d bytes, %8.0lf byte/sec, %7.1lf Mb/sec\n",
493		    t, nops, alg->name, size, (double)nops*size / t,
494		    (double)nops*size / t * 8 / 1024 / 1024);
495	}
496#ifdef __FreeBSD__
497	if (profile) {
498		struct cryptostats stats;
499		size_t slen = sizeof (stats);
500
501		if (sysctlbyname("debug.crypto_timing", NULL, NULL,
502				&otiming, sizeof (otiming)) < 0)
503			perror("debug.crypto_timing");
504		if (sysctlbyname("kern.crypto_stats", &stats, &slen, NULL, 0) < 0)
505			perror("kern.cryptostats");
506		if (stats.cs_invoke.count) {
507			printt("dispatch->invoke", &stats.cs_invoke);
508			printt("invoke->done", &stats.cs_done);
509			printt("done->cb", &stats.cs_cb);
510			printt("cb->finis", &stats.cs_finis);
511		}
512	}
513#endif
514	fflush(stdout);
515}
516
517int
518main(int argc, char **argv)
519{
520	struct alg *alg = NULL;
521	int count = 1;
522	int sizes[128], nsizes = 0;
523	u_long cmd = CIOCGSESSION2;
524	int testall = 0;
525	int maxthreads = 1;
526	int profile = 0;
527	int i, ch;
528
529	while ((ch = getopt(argc, argv, "cpzsva:bd:t:")) != -1) {
530		switch (ch) {
531#ifdef CIOCGSSESSION
532		case 's':
533			cmd = CIOCGSSESSION;
534			break;
535#endif
536		case 'v':
537			verbose++;
538			break;
539		case 'a':
540			alg = getalgbyname(optarg);
541			if (alg == NULL) {
542				if (streq(optarg, "rijndael"))
543					alg = getalgbyname("aes");
544				else
545					usage(argv[0]);
546			}
547			break;
548		case 'd':
549			crid = crlookup(optarg);
550			break;
551		case 't':
552			maxthreads = atoi(optarg);
553			break;
554		case 'z':
555			testall = 1;
556			break;
557		case 'p':
558			profile = 1;
559			break;
560		case 'b':
561			opflags |= COP_F_BATCH;
562			break;
563		case 'c':
564			verify = 1;
565			break;
566		default:
567			usage(argv[0]);
568		}
569	}
570	argc -= optind, argv += optind;
571	if (argc > 0)
572		count = atoi(argv[0]);
573	while (argc > 1) {
574		int s = atoi(argv[1]);
575		if (nsizes < nitems(sizes)) {
576			sizes[nsizes++] = s;
577		} else {
578			printf("Too many sizes, ignoring %u\n", s);
579		}
580		argc--, argv++;
581	}
582	if (maxthreads > CPU_SETSIZE)
583		errx(EX_USAGE, "Too many threads, %d, choose fewer.", maxthreads);
584
585	if (nsizes == 0) {
586		if (alg)
587			sizes[nsizes++] = alg->blocksize;
588		else
589			sizes[nsizes++] = 8;
590		if (testall) {
591			while (sizes[nsizes-1] < 8*1024) {
592				sizes[nsizes] = sizes[nsizes-1]<<1;
593				nsizes++;
594			}
595		}
596	}
597
598	if (testall) {
599		for (i = 0; i < nitems(algorithms); i++) {
600			int j;
601			alg = &algorithms[i];
602			for (j = 0; j < nsizes; j++)
603				runtests(alg, count, sizes[j], cmd, maxthreads, profile);
604		}
605	} else {
606		if (alg == NULL)
607			alg = getalgbycode(CRYPTO_3DES_CBC);
608		for (i = 0; i < nsizes; i++)
609			runtests(alg, count, sizes[i], cmd, maxthreads, profile);
610	}
611
612	return (0);
613}
614
615void
616hexdump(char *p, int n)
617{
618	int i, off;
619
620	for (off = 0; n > 0; off += 16, n -= 16) {
621		printf("%s%04x:", off == 0 ? "\n" : "", off);
622		i = (n >= 16 ? 16 : n);
623		do {
624			printf(" %02x", *p++ & 0xff);
625		} while (--i);
626		printf("\n");
627	}
628}
629