g_eli.h revision 314327
1/*-
2 * Copyright (c) 2005-2011 Pawel Jakub Dawidek <pawel@dawidek.net>
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 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: stable/10/sys/geom/eli/g_eli.h 314327 2017-02-27 08:27:38Z avg $
27 */
28
29#ifndef	_G_ELI_H_
30#define	_G_ELI_H_
31
32#include <sys/endian.h>
33#include <sys/errno.h>
34#include <sys/malloc.h>
35#include <crypto/sha2/sha256.h>
36#include <crypto/sha2/sha512.h>
37#include <opencrypto/cryptodev.h>
38#ifdef _KERNEL
39#include <sys/bio.h>
40#include <sys/libkern.h>
41#include <sys/lock.h>
42#include <sys/mutex.h>
43#include <sys/queue.h>
44#include <sys/tree.h>
45#include <geom/geom.h>
46#else
47#include <assert.h>
48#include <stdio.h>
49#include <string.h>
50#include <strings.h>
51#endif
52#ifndef _OpenSSL_
53#include <sys/md5.h>
54#endif
55
56#define	G_ELI_CLASS_NAME	"ELI"
57#define	G_ELI_MAGIC		"GEOM::ELI"
58#define	G_ELI_SUFFIX		".eli"
59
60/*
61 * Version history:
62 * 0 - Initial version number.
63 * 1 - Added data authentication support (md_aalgo field and
64 *     G_ELI_FLAG_AUTH flag).
65 * 2 - Added G_ELI_FLAG_READONLY.
66 * 3 - Added 'configure' subcommand.
67 * 4 - IV is generated from offset converted to little-endian
68 *     (the G_ELI_FLAG_NATIVE_BYTE_ORDER flag will be set for older versions).
69 * 5 - Added multiple encrypton keys and AES-XTS support.
70 * 6 - Fixed usage of multiple keys for authenticated providers (the
71 *     G_ELI_FLAG_FIRST_KEY flag will be set for older versions).
72 * 7 - Encryption keys are now generated from the Data Key and not from the
73 *     IV Key (the G_ELI_FLAG_ENC_IVKEY flag will be set for older versions).
74 */
75#define	G_ELI_VERSION_00	0
76#define	G_ELI_VERSION_01	1
77#define	G_ELI_VERSION_02	2
78#define	G_ELI_VERSION_03	3
79#define	G_ELI_VERSION_04	4
80#define	G_ELI_VERSION_05	5
81#define	G_ELI_VERSION_06	6
82#define	G_ELI_VERSION_07	7
83#define	G_ELI_VERSION		G_ELI_VERSION_07
84
85/* ON DISK FLAGS. */
86/* Use random, onetime keys. */
87#define	G_ELI_FLAG_ONETIME		0x00000001
88/* Ask for the passphrase from the kernel, before mounting root. */
89#define	G_ELI_FLAG_BOOT			0x00000002
90/* Detach on last close, if we were open for writing. */
91#define	G_ELI_FLAG_WO_DETACH		0x00000004
92/* Detach on last close. */
93#define	G_ELI_FLAG_RW_DETACH		0x00000008
94/* Provide data authentication. */
95#define	G_ELI_FLAG_AUTH			0x00000010
96/* Provider is read-only, we should deny all write attempts. */
97#define	G_ELI_FLAG_RO			0x00000020
98/* RUNTIME FLAGS. */
99/* Provider was open for writing. */
100#define	G_ELI_FLAG_WOPEN		0x00010000
101/* Destroy device. */
102#define	G_ELI_FLAG_DESTROY		0x00020000
103/* Provider uses native byte-order for IV generation. */
104#define	G_ELI_FLAG_NATIVE_BYTE_ORDER	0x00040000
105/* Provider uses single encryption key. */
106#define	G_ELI_FLAG_SINGLE_KEY		0x00080000
107/* Device suspended. */
108#define	G_ELI_FLAG_SUSPEND		0x00100000
109/* Provider uses first encryption key. */
110#define	G_ELI_FLAG_FIRST_KEY		0x00200000
111/* Provider uses IV-Key for encryption key generation. */
112#define	G_ELI_FLAG_ENC_IVKEY		0x00400000
113
114#define	G_ELI_NEW_BIO	255
115
116#define	SHA512_MDLEN		64
117#define	G_ELI_AUTH_SECKEYLEN	SHA256_DIGEST_LENGTH
118
119#define	G_ELI_MAXMKEYS		2
120#define	G_ELI_MAXKEYLEN		64
121#define	G_ELI_USERKEYLEN	G_ELI_MAXKEYLEN
122#define	G_ELI_DATAKEYLEN	G_ELI_MAXKEYLEN
123#define	G_ELI_AUTHKEYLEN	G_ELI_MAXKEYLEN
124#define	G_ELI_IVKEYLEN		G_ELI_MAXKEYLEN
125#define	G_ELI_SALTLEN		64
126#define	G_ELI_DATAIVKEYLEN	(G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN)
127/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */
128#define	G_ELI_MKEYLEN		(G_ELI_DATAIVKEYLEN + SHA512_MDLEN)
129#define	G_ELI_OVERWRITES	5
130/* Switch data encryption key every 2^20 blocks. */
131#define	G_ELI_KEY_SHIFT		20
132
133#ifdef _KERNEL
134extern int g_eli_debug;
135extern u_int g_eli_overwrites;
136extern u_int g_eli_batch;
137
138#define	G_ELI_CRYPTO_UNKNOWN	0
139#define	G_ELI_CRYPTO_HW		1
140#define	G_ELI_CRYPTO_SW		2
141
142#define	G_ELI_DEBUG(lvl, ...)	do {					\
143	if (g_eli_debug >= (lvl)) {					\
144		printf("GEOM_ELI");					\
145		if (g_eli_debug > 0)					\
146			printf("[%u]", lvl);				\
147		printf(": ");						\
148		printf(__VA_ARGS__);					\
149		printf("\n");						\
150	}								\
151} while (0)
152#define	G_ELI_LOGREQ(lvl, bp, ...)	do {				\
153	if (g_eli_debug >= (lvl)) {					\
154		printf("GEOM_ELI");					\
155		if (g_eli_debug > 0)					\
156			printf("[%u]", lvl);				\
157		printf(": ");						\
158		printf(__VA_ARGS__);					\
159		printf(" ");						\
160		g_print_bio(bp);					\
161		printf("\n");						\
162	}								\
163} while (0)
164
165struct g_eli_worker {
166	struct g_eli_softc	*w_softc;
167	struct proc		*w_proc;
168	u_int			 w_number;
169	uint64_t		 w_sid;
170	boolean_t		 w_active;
171	LIST_ENTRY(g_eli_worker) w_next;
172};
173
174struct g_eli_softc {
175	struct g_geom	*sc_geom;
176	u_int		 sc_version;
177	u_int		 sc_crypto;
178	uint8_t		 sc_mkey[G_ELI_DATAIVKEYLEN];
179	uint8_t		 sc_ekey[G_ELI_DATAKEYLEN];
180	TAILQ_HEAD(, g_eli_key) sc_ekeys_queue;
181	RB_HEAD(g_eli_key_tree, g_eli_key) sc_ekeys_tree;
182	struct mtx	 sc_ekeys_lock;
183	uint64_t	 sc_ekeys_total;
184	uint64_t	 sc_ekeys_allocated;
185	u_int		 sc_ealgo;
186	u_int		 sc_ekeylen;
187	uint8_t		 sc_akey[G_ELI_AUTHKEYLEN];
188	u_int		 sc_aalgo;
189	u_int		 sc_akeylen;
190	u_int		 sc_alen;
191	SHA256_CTX	 sc_akeyctx;
192	uint8_t		 sc_ivkey[G_ELI_IVKEYLEN];
193	SHA256_CTX	 sc_ivctx;
194	int		 sc_nkey;
195	uint32_t	 sc_flags;
196	int		 sc_inflight;
197	off_t		 sc_mediasize;
198	size_t		 sc_sectorsize;
199	u_int		 sc_bytes_per_sector;
200	u_int		 sc_data_per_sector;
201	boolean_t	 sc_cpubind;
202
203	/* Only for software cryptography. */
204	struct bio_queue_head sc_queue;
205	struct mtx	 sc_queue_mtx;
206	LIST_HEAD(, g_eli_worker) sc_workers;
207};
208#define	sc_name		 sc_geom->name
209#endif	/* _KERNEL */
210
211struct g_eli_metadata {
212	char		md_magic[16];	/* Magic value. */
213	uint32_t	md_version;	/* Version number. */
214	uint32_t	md_flags;	/* Additional flags. */
215	uint16_t	md_ealgo;	/* Encryption algorithm. */
216	uint16_t	md_keylen;	/* Key length. */
217	uint16_t	md_aalgo;	/* Authentication algorithm. */
218	uint64_t	md_provsize;	/* Provider's size. */
219	uint32_t	md_sectorsize;	/* Sector size. */
220	uint8_t		md_keys;	/* Available keys. */
221	int32_t		md_iterations;	/* Number of iterations for PKCS#5v2. */
222	uint8_t		md_salt[G_ELI_SALTLEN]; /* Salt. */
223			/* Encrypted master key (IV-key, Data-key, HMAC). */
224	uint8_t		md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN];
225	u_char		md_hash[16];	/* MD5 hash. */
226} __packed;
227#ifndef _OpenSSL_
228static __inline void
229eli_metadata_encode_v0(struct g_eli_metadata *md, u_char **datap)
230{
231	u_char *p;
232
233	p = *datap;
234	le32enc(p, md->md_flags);	p += sizeof(md->md_flags);
235	le16enc(p, md->md_ealgo);	p += sizeof(md->md_ealgo);
236	le16enc(p, md->md_keylen);	p += sizeof(md->md_keylen);
237	le64enc(p, md->md_provsize);	p += sizeof(md->md_provsize);
238	le32enc(p, md->md_sectorsize);	p += sizeof(md->md_sectorsize);
239	*p = md->md_keys;		p += sizeof(md->md_keys);
240	le32enc(p, md->md_iterations);	p += sizeof(md->md_iterations);
241	bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
242	bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
243	*datap = p;
244}
245static __inline void
246eli_metadata_encode_v1v2v3v4v5v6v7(struct g_eli_metadata *md, u_char **datap)
247{
248	u_char *p;
249
250	p = *datap;
251	le32enc(p, md->md_flags);	p += sizeof(md->md_flags);
252	le16enc(p, md->md_ealgo);	p += sizeof(md->md_ealgo);
253	le16enc(p, md->md_keylen);	p += sizeof(md->md_keylen);
254	le16enc(p, md->md_aalgo);	p += sizeof(md->md_aalgo);
255	le64enc(p, md->md_provsize);	p += sizeof(md->md_provsize);
256	le32enc(p, md->md_sectorsize);	p += sizeof(md->md_sectorsize);
257	*p = md->md_keys;		p += sizeof(md->md_keys);
258	le32enc(p, md->md_iterations);	p += sizeof(md->md_iterations);
259	bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
260	bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
261	*datap = p;
262}
263static __inline void
264eli_metadata_encode(struct g_eli_metadata *md, u_char *data)
265{
266	MD5_CTX ctx;
267	u_char *p;
268
269	p = data;
270	bcopy(md->md_magic, p, sizeof(md->md_magic));
271	p += sizeof(md->md_magic);
272	le32enc(p, md->md_version);
273	p += sizeof(md->md_version);
274	switch (md->md_version) {
275	case G_ELI_VERSION_00:
276		eli_metadata_encode_v0(md, &p);
277		break;
278	case G_ELI_VERSION_01:
279	case G_ELI_VERSION_02:
280	case G_ELI_VERSION_03:
281	case G_ELI_VERSION_04:
282	case G_ELI_VERSION_05:
283	case G_ELI_VERSION_06:
284	case G_ELI_VERSION_07:
285		eli_metadata_encode_v1v2v3v4v5v6v7(md, &p);
286		break;
287	default:
288#ifdef _KERNEL
289		panic("%s: Unsupported version %u.", __func__,
290		    (u_int)md->md_version);
291#else
292		assert(!"Unsupported metadata version.");
293#endif
294	}
295	MD5Init(&ctx);
296	MD5Update(&ctx, data, p - data);
297	MD5Final(md->md_hash, &ctx);
298	bcopy(md->md_hash, p, sizeof(md->md_hash));
299}
300static __inline int
301eli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md)
302{
303	MD5_CTX ctx;
304	const u_char *p;
305
306	p = data + sizeof(md->md_magic) + sizeof(md->md_version);
307	md->md_flags = le32dec(p);	p += sizeof(md->md_flags);
308	md->md_ealgo = le16dec(p);	p += sizeof(md->md_ealgo);
309	md->md_keylen = le16dec(p);	p += sizeof(md->md_keylen);
310	md->md_provsize = le64dec(p);	p += sizeof(md->md_provsize);
311	md->md_sectorsize = le32dec(p);	p += sizeof(md->md_sectorsize);
312	md->md_keys = *p;		p += sizeof(md->md_keys);
313	md->md_iterations = le32dec(p);	p += sizeof(md->md_iterations);
314	bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
315	bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
316	MD5Init(&ctx);
317	MD5Update(&ctx, data, p - data);
318	MD5Final(md->md_hash, &ctx);
319	if (bcmp(md->md_hash, p, 16) != 0)
320		return (EINVAL);
321	return (0);
322}
323
324static __inline int
325eli_metadata_decode_v1v2v3v4v5v6v7(const u_char *data, struct g_eli_metadata *md)
326{
327	MD5_CTX ctx;
328	const u_char *p;
329
330	p = data + sizeof(md->md_magic) + sizeof(md->md_version);
331	md->md_flags = le32dec(p);	p += sizeof(md->md_flags);
332	md->md_ealgo = le16dec(p);	p += sizeof(md->md_ealgo);
333	md->md_keylen = le16dec(p);	p += sizeof(md->md_keylen);
334	md->md_aalgo = le16dec(p);	p += sizeof(md->md_aalgo);
335	md->md_provsize = le64dec(p);	p += sizeof(md->md_provsize);
336	md->md_sectorsize = le32dec(p);	p += sizeof(md->md_sectorsize);
337	md->md_keys = *p;		p += sizeof(md->md_keys);
338	md->md_iterations = le32dec(p);	p += sizeof(md->md_iterations);
339	bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
340	bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
341	MD5Init(&ctx);
342	MD5Update(&ctx, data, p - data);
343	MD5Final(md->md_hash, &ctx);
344	if (bcmp(md->md_hash, p, 16) != 0)
345		return (EINVAL);
346	return (0);
347}
348static __inline int
349eli_metadata_decode(const u_char *data, struct g_eli_metadata *md)
350{
351	int error;
352
353	bcopy(data, md->md_magic, sizeof(md->md_magic));
354	if (strcmp(md->md_magic, G_ELI_MAGIC) != 0)
355		return (EINVAL);
356	md->md_version = le32dec(data + sizeof(md->md_magic));
357	switch (md->md_version) {
358	case G_ELI_VERSION_00:
359		error = eli_metadata_decode_v0(data, md);
360		break;
361	case G_ELI_VERSION_01:
362	case G_ELI_VERSION_02:
363	case G_ELI_VERSION_03:
364	case G_ELI_VERSION_04:
365	case G_ELI_VERSION_05:
366	case G_ELI_VERSION_06:
367	case G_ELI_VERSION_07:
368		error = eli_metadata_decode_v1v2v3v4v5v6v7(data, md);
369		break;
370	default:
371		error = EOPNOTSUPP;
372		break;
373	}
374	return (error);
375}
376#endif	/* !_OpenSSL */
377
378static __inline u_int
379g_eli_str2ealgo(const char *name)
380{
381
382	if (strcasecmp("null", name) == 0)
383		return (CRYPTO_NULL_CBC);
384	else if (strcasecmp("null-cbc", name) == 0)
385		return (CRYPTO_NULL_CBC);
386	else if (strcasecmp("aes", name) == 0)
387		return (CRYPTO_AES_XTS);
388	else if (strcasecmp("aes-cbc", name) == 0)
389		return (CRYPTO_AES_CBC);
390	else if (strcasecmp("aes-xts", name) == 0)
391		return (CRYPTO_AES_XTS);
392	else if (strcasecmp("blowfish", name) == 0)
393		return (CRYPTO_BLF_CBC);
394	else if (strcasecmp("blowfish-cbc", name) == 0)
395		return (CRYPTO_BLF_CBC);
396	else if (strcasecmp("camellia", name) == 0)
397		return (CRYPTO_CAMELLIA_CBC);
398	else if (strcasecmp("camellia-cbc", name) == 0)
399		return (CRYPTO_CAMELLIA_CBC);
400	else if (strcasecmp("3des", name) == 0)
401		return (CRYPTO_3DES_CBC);
402	else if (strcasecmp("3des-cbc", name) == 0)
403		return (CRYPTO_3DES_CBC);
404	return (CRYPTO_ALGORITHM_MIN - 1);
405}
406
407static __inline u_int
408g_eli_str2aalgo(const char *name)
409{
410
411	if (strcasecmp("hmac/md5", name) == 0)
412		return (CRYPTO_MD5_HMAC);
413	else if (strcasecmp("hmac/sha1", name) == 0)
414		return (CRYPTO_SHA1_HMAC);
415	else if (strcasecmp("hmac/ripemd160", name) == 0)
416		return (CRYPTO_RIPEMD160_HMAC);
417	else if (strcasecmp("hmac/sha256", name) == 0)
418		return (CRYPTO_SHA2_256_HMAC);
419	else if (strcasecmp("hmac/sha384", name) == 0)
420		return (CRYPTO_SHA2_384_HMAC);
421	else if (strcasecmp("hmac/sha512", name) == 0)
422		return (CRYPTO_SHA2_512_HMAC);
423	return (CRYPTO_ALGORITHM_MIN - 1);
424}
425
426static __inline const char *
427g_eli_algo2str(u_int algo)
428{
429
430	switch (algo) {
431	case CRYPTO_NULL_CBC:
432		return ("NULL");
433	case CRYPTO_AES_CBC:
434		return ("AES-CBC");
435	case CRYPTO_AES_XTS:
436		return ("AES-XTS");
437	case CRYPTO_BLF_CBC:
438		return ("Blowfish-CBC");
439	case CRYPTO_CAMELLIA_CBC:
440		return ("CAMELLIA-CBC");
441	case CRYPTO_3DES_CBC:
442		return ("3DES-CBC");
443	case CRYPTO_MD5_HMAC:
444		return ("HMAC/MD5");
445	case CRYPTO_SHA1_HMAC:
446		return ("HMAC/SHA1");
447	case CRYPTO_RIPEMD160_HMAC:
448		return ("HMAC/RIPEMD160");
449	case CRYPTO_SHA2_256_HMAC:
450		return ("HMAC/SHA256");
451	case CRYPTO_SHA2_384_HMAC:
452		return ("HMAC/SHA384");
453	case CRYPTO_SHA2_512_HMAC:
454		return ("HMAC/SHA512");
455	}
456	return ("unknown");
457}
458
459static __inline void
460eli_metadata_dump(const struct g_eli_metadata *md)
461{
462	static const char hex[] = "0123456789abcdef";
463	char str[sizeof(md->md_mkeys) * 2 + 1];
464	u_int i;
465
466	printf("     magic: %s\n", md->md_magic);
467	printf("   version: %u\n", (u_int)md->md_version);
468	printf("     flags: 0x%x\n", (u_int)md->md_flags);
469	printf("     ealgo: %s\n", g_eli_algo2str(md->md_ealgo));
470	printf("    keylen: %u\n", (u_int)md->md_keylen);
471	if (md->md_flags & G_ELI_FLAG_AUTH)
472		printf("     aalgo: %s\n", g_eli_algo2str(md->md_aalgo));
473	printf("  provsize: %ju\n", (uintmax_t)md->md_provsize);
474	printf("sectorsize: %u\n", (u_int)md->md_sectorsize);
475	printf("      keys: 0x%02x\n", (u_int)md->md_keys);
476	printf("iterations: %u\n", (u_int)md->md_iterations);
477	bzero(str, sizeof(str));
478	for (i = 0; i < sizeof(md->md_salt); i++) {
479		str[i * 2] = hex[md->md_salt[i] >> 4];
480		str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f];
481	}
482	printf("      Salt: %s\n", str);
483	bzero(str, sizeof(str));
484	for (i = 0; i < sizeof(md->md_mkeys); i++) {
485		str[i * 2] = hex[md->md_mkeys[i] >> 4];
486		str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f];
487	}
488	printf("Master Key: %s\n", str);
489	bzero(str, sizeof(str));
490	for (i = 0; i < 16; i++) {
491		str[i * 2] = hex[md->md_hash[i] >> 4];
492		str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f];
493	}
494	printf("  MD5 hash: %s\n", str);
495}
496
497static __inline u_int
498g_eli_keylen(u_int algo, u_int keylen)
499{
500
501	switch (algo) {
502	case CRYPTO_NULL_CBC:
503		if (keylen == 0)
504			keylen = 64 * 8;
505		else {
506			if (keylen > 64 * 8)
507				keylen = 0;
508		}
509		return (keylen);
510	case CRYPTO_AES_CBC:
511	case CRYPTO_CAMELLIA_CBC:
512		switch (keylen) {
513		case 0:
514			return (128);
515		case 128:
516		case 192:
517		case 256:
518			return (keylen);
519		default:
520			return (0);
521		}
522	case CRYPTO_AES_XTS:
523		switch (keylen) {
524		case 0:
525			return (128);
526		case 128:
527		case 256:
528			return (keylen);
529		default:
530			return (0);
531		}
532	case CRYPTO_BLF_CBC:
533		if (keylen == 0)
534			return (128);
535		if (keylen < 128 || keylen > 448)
536			return (0);
537		if ((keylen % 32) != 0)
538			return (0);
539		return (keylen);
540	case CRYPTO_3DES_CBC:
541		if (keylen == 0 || keylen == 192)
542			return (192);
543		return (0);
544	default:
545		return (0);
546	}
547}
548
549static __inline u_int
550g_eli_hashlen(u_int algo)
551{
552
553	switch (algo) {
554	case CRYPTO_MD5_HMAC:
555		return (16);
556	case CRYPTO_SHA1_HMAC:
557		return (20);
558	case CRYPTO_RIPEMD160_HMAC:
559		return (20);
560	case CRYPTO_SHA2_256_HMAC:
561		return (32);
562	case CRYPTO_SHA2_384_HMAC:
563		return (48);
564	case CRYPTO_SHA2_512_HMAC:
565		return (64);
566	}
567	return (0);
568}
569
570#ifdef _KERNEL
571int g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
572    struct g_eli_metadata *md);
573struct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp,
574    struct g_provider *bpp, const struct g_eli_metadata *md,
575    const u_char *mkey, int nkey);
576int g_eli_destroy(struct g_eli_softc *sc, boolean_t force);
577
578int g_eli_access(struct g_provider *pp, int dr, int dw, int de);
579void g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb);
580
581void g_eli_read_done(struct bio *bp);
582void g_eli_write_done(struct bio *bp);
583int g_eli_crypto_rerun(struct cryptop *crp);
584void g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
585    size_t size);
586
587void g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker);
588void g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp);
589
590void g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp);
591void g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp);
592#endif
593
594void g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key);
595int g_eli_mkey_decrypt(const struct g_eli_metadata *md,
596    const unsigned char *key, unsigned char *mkey, unsigned *nkeyp);
597int g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen,
598    unsigned char *mkey);
599#ifdef _KERNEL
600void g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey);
601#endif
602
603int g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize,
604    const u_char *key, size_t keysize);
605int g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize,
606    const u_char *key, size_t keysize);
607
608struct hmac_ctx {
609	SHA512_CTX	shactx;
610	u_char		k_opad[128];
611};
612
613void g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey,
614    size_t hkeylen);
615void g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data,
616    size_t datasize);
617void g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize);
618void g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize,
619    const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize);
620
621#ifdef _KERNEL
622void g_eli_key_init(struct g_eli_softc *sc);
623void g_eli_key_destroy(struct g_eli_softc *sc);
624uint8_t *g_eli_key_hold(struct g_eli_softc *sc, off_t offset, size_t blocksize);
625void g_eli_key_drop(struct g_eli_softc *sc, uint8_t *rawkey);
626#endif
627#endif	/* !_G_ELI_H_ */
628