g_eli.h revision 226840
1148456Spjd/*-
2220922Spjd * Copyright (c) 2005-2011 Pawel Jakub Dawidek <pawel@dawidek.net>
3148456Spjd * All rights reserved.
4148456Spjd *
5148456Spjd * Redistribution and use in source and binary forms, with or without
6148456Spjd * modification, are permitted provided that the following conditions
7148456Spjd * are met:
8148456Spjd * 1. Redistributions of source code must retain the above copyright
9148456Spjd *    notice, this list of conditions and the following disclaimer.
10148456Spjd * 2. Redistributions in binary form must reproduce the above copyright
11148456Spjd *    notice, this list of conditions and the following disclaimer in the
12148456Spjd *    documentation and/or other materials provided with the distribution.
13155174Spjd *
14148456Spjd * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15148456Spjd * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16148456Spjd * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17148456Spjd * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18148456Spjd * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19148456Spjd * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20148456Spjd * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21148456Spjd * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22148456Spjd * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23148456Spjd * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24148456Spjd * SUCH DAMAGE.
25148456Spjd *
26148456Spjd * $FreeBSD: head/sys/geom/eli/g_eli.h 226840 2011-10-27 16:12:25Z pjd $
27148456Spjd */
28148456Spjd
29148456Spjd#ifndef	_G_ELI_H_
30148456Spjd#define	_G_ELI_H_
31148456Spjd
32148456Spjd#include <sys/endian.h>
33148456Spjd#include <sys/errno.h>
34148456Spjd#include <sys/malloc.h>
35148456Spjd#include <crypto/sha2/sha2.h>
36148456Spjd#include <opencrypto/cryptodev.h>
37148456Spjd#ifdef _KERNEL
38148456Spjd#include <sys/bio.h>
39148456Spjd#include <sys/libkern.h>
40220922Spjd#include <sys/lock.h>
41220922Spjd#include <sys/mutex.h>
42220922Spjd#include <sys/queue.h>
43220922Spjd#include <sys/tree.h>
44148456Spjd#include <geom/geom.h>
45148456Spjd#else
46226733Spjd#include <assert.h>
47148456Spjd#include <stdio.h>
48148456Spjd#include <string.h>
49148867Spjd#include <strings.h>
50148456Spjd#endif
51148456Spjd#ifndef _OpenSSL_
52148456Spjd#include <sys/md5.h>
53148456Spjd#endif
54148456Spjd
55148456Spjd#define	G_ELI_CLASS_NAME	"ELI"
56148456Spjd#define	G_ELI_MAGIC		"GEOM::ELI"
57148456Spjd#define	G_ELI_SUFFIX		".eli"
58148456Spjd
59148456Spjd/*
60148456Spjd * Version history:
61148456Spjd * 0 - Initial version number.
62159307Spjd * 1 - Added data authentication support (md_aalgo field and
63159307Spjd *     G_ELI_FLAG_AUTH flag).
64161217Spjd * 2 - Added G_ELI_FLAG_READONLY.
65211927Spjd * 3 - Added 'configure' subcommand.
66211927Spjd * 4 - IV is generated from offset converted to little-endian
67221628Spjd *     (the G_ELI_FLAG_NATIVE_BYTE_ORDER flag will be set for older versions).
68213070Spjd * 5 - Added multiple encrypton keys and AES-XTS support.
69221628Spjd * 6 - Fixed usage of multiple keys for authenticated providers (the
70221628Spjd *     G_ELI_FLAG_FIRST_KEY flag will be set for older versions).
71148456Spjd */
72221628Spjd#define	G_ELI_VERSION_00	0
73221628Spjd#define	G_ELI_VERSION_01	1
74221628Spjd#define	G_ELI_VERSION_02	2
75221628Spjd#define	G_ELI_VERSION_03	3
76221628Spjd#define	G_ELI_VERSION_04	4
77221628Spjd#define	G_ELI_VERSION_05	5
78221628Spjd#define	G_ELI_VERSION_06	6
79221628Spjd#define	G_ELI_VERSION		G_ELI_VERSION_06
80148456Spjd
81161127Spjd/* ON DISK FLAGS. */
82148456Spjd/* Use random, onetime keys. */
83161220Spjd#define	G_ELI_FLAG_ONETIME		0x00000001
84148456Spjd/* Ask for the passphrase from the kernel, before mounting root. */
85161220Spjd#define	G_ELI_FLAG_BOOT			0x00000002
86148456Spjd/* Detach on last close, if we were open for writing. */
87161220Spjd#define	G_ELI_FLAG_WO_DETACH		0x00000004
88148456Spjd/* Detach on last close. */
89161220Spjd#define	G_ELI_FLAG_RW_DETACH		0x00000008
90159307Spjd/* Provide data authentication. */
91161220Spjd#define	G_ELI_FLAG_AUTH			0x00000010
92161127Spjd/* Provider is read-only, we should deny all write attempts. */
93161220Spjd#define	G_ELI_FLAG_RO			0x00000020
94161127Spjd/* RUNTIME FLAGS. */
95148456Spjd/* Provider was open for writing. */
96161220Spjd#define	G_ELI_FLAG_WOPEN		0x00010000
97148456Spjd/* Destroy device. */
98161220Spjd#define	G_ELI_FLAG_DESTROY		0x00020000
99161220Spjd/* Provider uses native byte-order for IV generation. */
100161220Spjd#define	G_ELI_FLAG_NATIVE_BYTE_ORDER	0x00040000
101213067Spjd/* Provider uses single encryption key. */
102213067Spjd#define	G_ELI_FLAG_SINGLE_KEY		0x00080000
103214118Spjd/* Device suspended. */
104214118Spjd#define	G_ELI_FLAG_SUSPEND		0x00100000
105221628Spjd/* Provider uses first encryption key. */
106221628Spjd#define	G_ELI_FLAG_FIRST_KEY		0x00200000
107148456Spjd
108214118Spjd#define	G_ELI_NEW_BIO	255
109214118Spjd
110148456Spjd#define	SHA512_MDLEN		64
111159307Spjd#define	G_ELI_AUTH_SECKEYLEN	SHA256_DIGEST_LENGTH
112148456Spjd
113148456Spjd#define	G_ELI_MAXMKEYS		2
114148456Spjd#define	G_ELI_MAXKEYLEN		64
115148456Spjd#define	G_ELI_USERKEYLEN	G_ELI_MAXKEYLEN
116148456Spjd#define	G_ELI_DATAKEYLEN	G_ELI_MAXKEYLEN
117159307Spjd#define	G_ELI_AUTHKEYLEN	G_ELI_MAXKEYLEN
118148456Spjd#define	G_ELI_IVKEYLEN		G_ELI_MAXKEYLEN
119148456Spjd#define	G_ELI_SALTLEN		64
120148456Spjd#define	G_ELI_DATAIVKEYLEN	(G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN)
121148456Spjd/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */
122148456Spjd#define	G_ELI_MKEYLEN		(G_ELI_DATAIVKEYLEN + SHA512_MDLEN)
123213062Spjd#define	G_ELI_OVERWRITES	5
124213067Spjd/* Switch data encryption key every 2^20 blocks. */
125213067Spjd#define	G_ELI_KEY_SHIFT		20
126148456Spjd
127148456Spjd#ifdef _KERNEL
128213165Spjdextern int g_eli_debug;
129148456Spjdextern u_int g_eli_overwrites;
130159307Spjdextern u_int g_eli_batch;
131148456Spjd
132214163Spjd#define	G_ELI_CRYPTO_UNKNOWN	0
133148456Spjd#define	G_ELI_CRYPTO_HW		1
134148456Spjd#define	G_ELI_CRYPTO_SW		2
135148456Spjd
136148456Spjd#define	G_ELI_DEBUG(lvl, ...)	do {					\
137148456Spjd	if (g_eli_debug >= (lvl)) {					\
138148456Spjd		printf("GEOM_ELI");					\
139148456Spjd		if (g_eli_debug > 0)					\
140148456Spjd			printf("[%u]", lvl);				\
141148456Spjd		printf(": ");						\
142148456Spjd		printf(__VA_ARGS__);					\
143148456Spjd		printf("\n");						\
144148456Spjd	}								\
145148456Spjd} while (0)
146148456Spjd#define	G_ELI_LOGREQ(lvl, bp, ...)	do {				\
147148456Spjd	if (g_eli_debug >= (lvl)) {					\
148148456Spjd		printf("GEOM_ELI");					\
149148456Spjd		if (g_eli_debug > 0)					\
150148456Spjd			printf("[%u]", lvl);				\
151148456Spjd		printf(": ");						\
152148456Spjd		printf(__VA_ARGS__);					\
153148456Spjd		printf(" ");						\
154148456Spjd		g_print_bio(bp);					\
155148456Spjd		printf("\n");						\
156148456Spjd	}								\
157148456Spjd} while (0)
158148456Spjd
159148456Spjdstruct g_eli_worker {
160148456Spjd	struct g_eli_softc	*w_softc;
161148456Spjd	struct proc		*w_proc;
162148456Spjd	u_int			 w_number;
163148456Spjd	uint64_t		 w_sid;
164214118Spjd	boolean_t		 w_active;
165148456Spjd	LIST_ENTRY(g_eli_worker) w_next;
166148456Spjd};
167148456Spjd
168148456Spjdstruct g_eli_softc {
169220922Spjd	struct g_geom	*sc_geom;
170226733Spjd	u_int		 sc_version;
171220922Spjd	u_int		 sc_crypto;
172220922Spjd	uint8_t		 sc_mkey[G_ELI_DATAIVKEYLEN];
173220922Spjd	uint8_t		 sc_ekey[G_ELI_DATAKEYLEN];
174220922Spjd	TAILQ_HEAD(, g_eli_key) sc_ekeys_queue;
175220922Spjd	RB_HEAD(g_eli_key_tree, g_eli_key) sc_ekeys_tree;
176220922Spjd	struct mtx	 sc_ekeys_lock;
177220922Spjd	uint64_t	 sc_ekeys_total;
178220922Spjd	uint64_t	 sc_ekeys_allocated;
179220922Spjd	u_int		 sc_ealgo;
180220922Spjd	u_int		 sc_ekeylen;
181220922Spjd	uint8_t		 sc_akey[G_ELI_AUTHKEYLEN];
182220922Spjd	u_int		 sc_aalgo;
183220922Spjd	u_int		 sc_akeylen;
184220922Spjd	u_int		 sc_alen;
185220922Spjd	SHA256_CTX	 sc_akeyctx;
186220922Spjd	uint8_t		 sc_ivkey[G_ELI_IVKEYLEN];
187220922Spjd	SHA256_CTX	 sc_ivctx;
188220922Spjd	int		 sc_nkey;
189220922Spjd	uint32_t	 sc_flags;
190220922Spjd	int		 sc_inflight;
191220922Spjd	off_t		 sc_mediasize;
192220922Spjd	size_t		 sc_sectorsize;
193220922Spjd	u_int		 sc_bytes_per_sector;
194220922Spjd	u_int		 sc_data_per_sector;
195226840Spjd	boolean_t	 sc_cpubind;
196148456Spjd
197148456Spjd	/* Only for software cryptography. */
198148456Spjd	struct bio_queue_head sc_queue;
199220922Spjd	struct mtx	 sc_queue_mtx;
200148456Spjd	LIST_HEAD(, g_eli_worker) sc_workers;
201148456Spjd};
202148456Spjd#define	sc_name		 sc_geom->name
203148456Spjd#endif	/* _KERNEL */
204148456Spjd
205148456Spjdstruct g_eli_metadata {
206148456Spjd	char		md_magic[16];	/* Magic value. */
207148456Spjd	uint32_t	md_version;	/* Version number. */
208148456Spjd	uint32_t	md_flags;	/* Additional flags. */
209159307Spjd	uint16_t	md_ealgo;	/* Encryption algorithm. */
210148456Spjd	uint16_t	md_keylen;	/* Key length. */
211159307Spjd	uint16_t	md_aalgo;	/* Authentication algorithm. */
212148456Spjd	uint64_t	md_provsize;	/* Provider's size. */
213148456Spjd	uint32_t	md_sectorsize;	/* Sector size. */
214148456Spjd	uint8_t		md_keys;	/* Available keys. */
215149303Spjd	int32_t		md_iterations;	/* Number of iterations for PKCS#5v2. */
216148456Spjd	uint8_t		md_salt[G_ELI_SALTLEN]; /* Salt. */
217148456Spjd			/* Encrypted master key (IV-key, Data-key, HMAC). */
218148456Spjd	uint8_t		md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN];
219148456Spjd	u_char		md_hash[16];	/* MD5 hash. */
220149323Spjd} __packed;
221148456Spjd#ifndef _OpenSSL_
222148456Spjdstatic __inline void
223226733Spjdeli_metadata_encode_v0(struct g_eli_metadata *md, u_char **datap)
224148456Spjd{
225148456Spjd	u_char *p;
226148456Spjd
227226733Spjd	p = *datap;
228148456Spjd	le32enc(p, md->md_flags);	p += sizeof(md->md_flags);
229159307Spjd	le16enc(p, md->md_ealgo);	p += sizeof(md->md_ealgo);
230148456Spjd	le16enc(p, md->md_keylen);	p += sizeof(md->md_keylen);
231226733Spjd	le64enc(p, md->md_provsize);	p += sizeof(md->md_provsize);
232226733Spjd	le32enc(p, md->md_sectorsize);	p += sizeof(md->md_sectorsize);
233226733Spjd	*p = md->md_keys;		p += sizeof(md->md_keys);
234226733Spjd	le32enc(p, md->md_iterations);	p += sizeof(md->md_iterations);
235226733Spjd	bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
236226733Spjd	bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
237226733Spjd	*datap = p;
238226733Spjd}
239226733Spjdstatic __inline void
240226733Spjdeli_metadata_encode_v1v2v3v4v5v6(struct g_eli_metadata *md, u_char **datap)
241226733Spjd{
242226733Spjd	u_char *p;
243226733Spjd
244226733Spjd	p = *datap;
245226733Spjd	le32enc(p, md->md_flags);	p += sizeof(md->md_flags);
246226733Spjd	le16enc(p, md->md_ealgo);	p += sizeof(md->md_ealgo);
247226733Spjd	le16enc(p, md->md_keylen);	p += sizeof(md->md_keylen);
248159307Spjd	le16enc(p, md->md_aalgo);	p += sizeof(md->md_aalgo);
249148456Spjd	le64enc(p, md->md_provsize);	p += sizeof(md->md_provsize);
250148456Spjd	le32enc(p, md->md_sectorsize);	p += sizeof(md->md_sectorsize);
251148456Spjd	*p = md->md_keys;		p += sizeof(md->md_keys);
252148456Spjd	le32enc(p, md->md_iterations);	p += sizeof(md->md_iterations);
253148456Spjd	bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
254148456Spjd	bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
255226733Spjd	*datap = p;
256226733Spjd}
257226733Spjdstatic __inline void
258226733Spjdeli_metadata_encode(struct g_eli_metadata *md, u_char *data)
259226733Spjd{
260226733Spjd	MD5_CTX ctx;
261226733Spjd	u_char *p;
262226733Spjd
263226733Spjd	p = data;
264226733Spjd	bcopy(md->md_magic, p, sizeof(md->md_magic));
265226733Spjd	p += sizeof(md->md_magic);
266226733Spjd	le32enc(p, md->md_version);
267226733Spjd	p += sizeof(md->md_version);
268226733Spjd	switch (md->md_version) {
269226733Spjd	case G_ELI_VERSION_00:
270226733Spjd		eli_metadata_encode_v0(md, &p);
271226733Spjd		break;
272226733Spjd	case G_ELI_VERSION_01:
273226733Spjd	case G_ELI_VERSION_02:
274226733Spjd	case G_ELI_VERSION_03:
275226733Spjd	case G_ELI_VERSION_04:
276226733Spjd	case G_ELI_VERSION_05:
277226733Spjd	case G_ELI_VERSION_06:
278226733Spjd		eli_metadata_encode_v1v2v3v4v5v6(md, &p);
279226733Spjd		break;
280226733Spjd	default:
281226733Spjd#ifdef _KERNEL
282226733Spjd		panic("%s: Unsupported version %u.", __func__,
283226733Spjd		    (u_int)md->md_version);
284226733Spjd#else
285226733Spjd		assert(!"Unsupported metadata version.");
286226733Spjd#endif
287226733Spjd	}
288148456Spjd	MD5Init(&ctx);
289148456Spjd	MD5Update(&ctx, data, p - data);
290157305Spjd	MD5Final(md->md_hash, &ctx);
291148456Spjd	bcopy(md->md_hash, p, sizeof(md->md_hash));
292148456Spjd}
293148456Spjdstatic __inline int
294148456Spjdeli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md)
295148456Spjd{
296148456Spjd	MD5_CTX ctx;
297148456Spjd	const u_char *p;
298148456Spjd
299148456Spjd	p = data + sizeof(md->md_magic) + sizeof(md->md_version);
300148456Spjd	md->md_flags = le32dec(p);	p += sizeof(md->md_flags);
301159307Spjd	md->md_ealgo = le16dec(p);	p += sizeof(md->md_ealgo);
302148456Spjd	md->md_keylen = le16dec(p);	p += sizeof(md->md_keylen);
303148456Spjd	md->md_provsize = le64dec(p);	p += sizeof(md->md_provsize);
304148456Spjd	md->md_sectorsize = le32dec(p);	p += sizeof(md->md_sectorsize);
305148456Spjd	md->md_keys = *p;		p += sizeof(md->md_keys);
306148456Spjd	md->md_iterations = le32dec(p);	p += sizeof(md->md_iterations);
307148456Spjd	bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
308148456Spjd	bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
309148456Spjd	MD5Init(&ctx);
310148456Spjd	MD5Update(&ctx, data, p - data);
311157305Spjd	MD5Final(md->md_hash, &ctx);
312148456Spjd	if (bcmp(md->md_hash, p, 16) != 0)
313148456Spjd		return (EINVAL);
314148456Spjd	return (0);
315148456Spjd}
316212845Sbrian
317148456Spjdstatic __inline int
318221629Spjdeli_metadata_decode_v1v2v3v4v5v6(const u_char *data, struct g_eli_metadata *md)
319159307Spjd{
320159307Spjd	MD5_CTX ctx;
321159307Spjd	const u_char *p;
322159307Spjd
323159307Spjd	p = data + sizeof(md->md_magic) + sizeof(md->md_version);
324159307Spjd	md->md_flags = le32dec(p);	p += sizeof(md->md_flags);
325159307Spjd	md->md_ealgo = le16dec(p);	p += sizeof(md->md_ealgo);
326159307Spjd	md->md_keylen = le16dec(p);	p += sizeof(md->md_keylen);
327159307Spjd	md->md_aalgo = le16dec(p);	p += sizeof(md->md_aalgo);
328159307Spjd	md->md_provsize = le64dec(p);	p += sizeof(md->md_provsize);
329159307Spjd	md->md_sectorsize = le32dec(p);	p += sizeof(md->md_sectorsize);
330159307Spjd	md->md_keys = *p;		p += sizeof(md->md_keys);
331159307Spjd	md->md_iterations = le32dec(p);	p += sizeof(md->md_iterations);
332159307Spjd	bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
333159307Spjd	bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
334159307Spjd	MD5Init(&ctx);
335159307Spjd	MD5Update(&ctx, data, p - data);
336159307Spjd	MD5Final(md->md_hash, &ctx);
337159307Spjd	if (bcmp(md->md_hash, p, 16) != 0)
338159307Spjd		return (EINVAL);
339159307Spjd	return (0);
340159307Spjd}
341159307Spjdstatic __inline int
342148456Spjdeli_metadata_decode(const u_char *data, struct g_eli_metadata *md)
343148456Spjd{
344148456Spjd	int error;
345148456Spjd
346148456Spjd	bcopy(data, md->md_magic, sizeof(md->md_magic));
347226730Spjd	if (strcmp(md->md_magic, G_ELI_MAGIC) != 0)
348226730Spjd		return (EINVAL);
349148456Spjd	md->md_version = le32dec(data + sizeof(md->md_magic));
350148456Spjd	switch (md->md_version) {
351221629Spjd	case G_ELI_VERSION_00:
352148456Spjd		error = eli_metadata_decode_v0(data, md);
353148456Spjd		break;
354221629Spjd	case G_ELI_VERSION_01:
355221629Spjd	case G_ELI_VERSION_02:
356221629Spjd	case G_ELI_VERSION_03:
357221629Spjd	case G_ELI_VERSION_04:
358221629Spjd	case G_ELI_VERSION_05:
359221629Spjd	case G_ELI_VERSION_06:
360221629Spjd		error = eli_metadata_decode_v1v2v3v4v5v6(data, md);
361159307Spjd		break;
362148456Spjd	default:
363226721Spjd		error = EOPNOTSUPP;
364148456Spjd		break;
365148456Spjd	}
366148456Spjd	return (error);
367148456Spjd}
368148456Spjd#endif	/* !_OpenSSL */
369148456Spjd
370148456Spjdstatic __inline u_int
371159307Spjdg_eli_str2ealgo(const char *name)
372148456Spjd{
373148456Spjd
374148867Spjd	if (strcasecmp("null", name) == 0)
375148456Spjd		return (CRYPTO_NULL_CBC);
376213070Spjd	else if (strcasecmp("null-cbc", name) == 0)
377213070Spjd		return (CRYPTO_NULL_CBC);
378148867Spjd	else if (strcasecmp("aes", name) == 0)
379213070Spjd		return (CRYPTO_AES_XTS);
380213070Spjd	else if (strcasecmp("aes-cbc", name) == 0)
381148456Spjd		return (CRYPTO_AES_CBC);
382213070Spjd	else if (strcasecmp("aes-xts", name) == 0)
383213070Spjd		return (CRYPTO_AES_XTS);
384148867Spjd	else if (strcasecmp("blowfish", name) == 0)
385148456Spjd		return (CRYPTO_BLF_CBC);
386213070Spjd	else if (strcasecmp("blowfish-cbc", name) == 0)
387213070Spjd		return (CRYPTO_BLF_CBC);
388172031Spjd	else if (strcasecmp("camellia", name) == 0)
389172031Spjd		return (CRYPTO_CAMELLIA_CBC);
390213070Spjd	else if (strcasecmp("camellia-cbc", name) == 0)
391213070Spjd		return (CRYPTO_CAMELLIA_CBC);
392148867Spjd	else if (strcasecmp("3des", name) == 0)
393148456Spjd		return (CRYPTO_3DES_CBC);
394213070Spjd	else if (strcasecmp("3des-cbc", name) == 0)
395213070Spjd		return (CRYPTO_3DES_CBC);
396148456Spjd	return (CRYPTO_ALGORITHM_MIN - 1);
397148456Spjd}
398148456Spjd
399159307Spjdstatic __inline u_int
400159307Spjdg_eli_str2aalgo(const char *name)
401159307Spjd{
402159307Spjd
403159307Spjd	if (strcasecmp("hmac/md5", name) == 0)
404159307Spjd		return (CRYPTO_MD5_HMAC);
405159307Spjd	else if (strcasecmp("hmac/sha1", name) == 0)
406159307Spjd		return (CRYPTO_SHA1_HMAC);
407159307Spjd	else if (strcasecmp("hmac/ripemd160", name) == 0)
408159307Spjd		return (CRYPTO_RIPEMD160_HMAC);
409159307Spjd	else if (strcasecmp("hmac/sha256", name) == 0)
410159307Spjd		return (CRYPTO_SHA2_256_HMAC);
411159307Spjd	else if (strcasecmp("hmac/sha384", name) == 0)
412159307Spjd		return (CRYPTO_SHA2_384_HMAC);
413159307Spjd	else if (strcasecmp("hmac/sha512", name) == 0)
414159307Spjd		return (CRYPTO_SHA2_512_HMAC);
415159307Spjd	return (CRYPTO_ALGORITHM_MIN - 1);
416159307Spjd}
417159307Spjd
418148456Spjdstatic __inline const char *
419148456Spjdg_eli_algo2str(u_int algo)
420148456Spjd{
421148456Spjd
422148456Spjd	switch (algo) {
423148456Spjd	case CRYPTO_NULL_CBC:
424148456Spjd		return ("NULL");
425148456Spjd	case CRYPTO_AES_CBC:
426159307Spjd		return ("AES-CBC");
427213070Spjd	case CRYPTO_AES_XTS:
428213070Spjd		return ("AES-XTS");
429148456Spjd	case CRYPTO_BLF_CBC:
430159307Spjd		return ("Blowfish-CBC");
431172031Spjd	case CRYPTO_CAMELLIA_CBC:
432172031Spjd		return ("CAMELLIA-CBC");
433148456Spjd	case CRYPTO_3DES_CBC:
434159307Spjd		return ("3DES-CBC");
435159307Spjd	case CRYPTO_MD5_HMAC:
436159307Spjd		return ("HMAC/MD5");
437159307Spjd	case CRYPTO_SHA1_HMAC:
438159307Spjd		return ("HMAC/SHA1");
439159307Spjd	case CRYPTO_RIPEMD160_HMAC:
440159307Spjd		return ("HMAC/RIPEMD160");
441159307Spjd	case CRYPTO_SHA2_256_HMAC:
442159307Spjd		return ("HMAC/SHA256");
443159307Spjd	case CRYPTO_SHA2_384_HMAC:
444159307Spjd		return ("HMAC/SHA384");
445159307Spjd	case CRYPTO_SHA2_512_HMAC:
446159307Spjd		return ("HMAC/SHA512");
447148456Spjd	}
448148456Spjd	return ("unknown");
449148456Spjd}
450148456Spjd
451148456Spjdstatic __inline void
452148456Spjdeli_metadata_dump(const struct g_eli_metadata *md)
453148456Spjd{
454148456Spjd	static const char hex[] = "0123456789abcdef";
455148456Spjd	char str[sizeof(md->md_mkeys) * 2 + 1];
456148456Spjd	u_int i;
457148456Spjd
458148456Spjd	printf("     magic: %s\n", md->md_magic);
459148456Spjd	printf("   version: %u\n", (u_int)md->md_version);
460148456Spjd	printf("     flags: 0x%x\n", (u_int)md->md_flags);
461159307Spjd	printf("     ealgo: %s\n", g_eli_algo2str(md->md_ealgo));
462148456Spjd	printf("    keylen: %u\n", (u_int)md->md_keylen);
463159307Spjd	if (md->md_flags & G_ELI_FLAG_AUTH)
464159307Spjd		printf("     aalgo: %s\n", g_eli_algo2str(md->md_aalgo));
465148456Spjd	printf("  provsize: %ju\n", (uintmax_t)md->md_provsize);
466148456Spjd	printf("sectorsize: %u\n", (u_int)md->md_sectorsize);
467148456Spjd	printf("      keys: 0x%02x\n", (u_int)md->md_keys);
468148456Spjd	printf("iterations: %u\n", (u_int)md->md_iterations);
469148456Spjd	bzero(str, sizeof(str));
470148456Spjd	for (i = 0; i < sizeof(md->md_salt); i++) {
471148456Spjd		str[i * 2] = hex[md->md_salt[i] >> 4];
472148456Spjd		str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f];
473148456Spjd	}
474149303Spjd	printf("      Salt: %s\n", str);
475148456Spjd	bzero(str, sizeof(str));
476148456Spjd	for (i = 0; i < sizeof(md->md_mkeys); i++) {
477148456Spjd		str[i * 2] = hex[md->md_mkeys[i] >> 4];
478148456Spjd		str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f];
479148456Spjd	}
480148456Spjd	printf("Master Key: %s\n", str);
481148456Spjd	bzero(str, sizeof(str));
482148456Spjd	for (i = 0; i < 16; i++) {
483148456Spjd		str[i * 2] = hex[md->md_hash[i] >> 4];
484148456Spjd		str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f];
485148456Spjd	}
486149303Spjd	printf("  MD5 hash: %s\n", str);
487148456Spjd}
488148456Spjd
489148456Spjdstatic __inline u_int
490148456Spjdg_eli_keylen(u_int algo, u_int keylen)
491148456Spjd{
492148456Spjd
493148456Spjd	switch (algo) {
494148456Spjd	case CRYPTO_NULL_CBC:
495148456Spjd		if (keylen == 0)
496148456Spjd			keylen = 64 * 8;
497148456Spjd		else {
498148456Spjd			if (keylen > 64 * 8)
499148456Spjd				keylen = 0;
500148456Spjd		}
501148456Spjd		return (keylen);
502211927Spjd	case CRYPTO_AES_CBC:
503172031Spjd	case CRYPTO_CAMELLIA_CBC:
504148456Spjd		switch (keylen) {
505148456Spjd		case 0:
506148456Spjd			return (128);
507148456Spjd		case 128:
508148456Spjd		case 192:
509148456Spjd		case 256:
510148456Spjd			return (keylen);
511148456Spjd		default:
512148456Spjd			return (0);
513148456Spjd		}
514213070Spjd	case CRYPTO_AES_XTS:
515213070Spjd		switch (keylen) {
516213070Spjd		case 0:
517213070Spjd			return (128);
518213070Spjd		case 128:
519213070Spjd		case 256:
520213070Spjd			return (keylen);
521213070Spjd		default:
522213070Spjd			return (0);
523213070Spjd		}
524148456Spjd	case CRYPTO_BLF_CBC:
525148456Spjd		if (keylen == 0)
526148456Spjd			return (128);
527148456Spjd		if (keylen < 128 || keylen > 448)
528148456Spjd			return (0);
529148456Spjd		if ((keylen % 32) != 0)
530148456Spjd			return (0);
531148456Spjd		return (keylen);
532148456Spjd	case CRYPTO_3DES_CBC:
533148456Spjd		if (keylen == 0 || keylen == 192)
534148456Spjd			return (192);
535148456Spjd		return (0);
536148456Spjd	default:
537148456Spjd		return (0);
538148456Spjd	}
539148456Spjd}
540148456Spjd
541159307Spjdstatic __inline u_int
542159307Spjdg_eli_hashlen(u_int algo)
543159307Spjd{
544159307Spjd
545159307Spjd	switch (algo) {
546159307Spjd	case CRYPTO_MD5_HMAC:
547159307Spjd		return (16);
548159307Spjd	case CRYPTO_SHA1_HMAC:
549159307Spjd		return (20);
550159307Spjd	case CRYPTO_RIPEMD160_HMAC:
551159307Spjd		return (20);
552159307Spjd	case CRYPTO_SHA2_256_HMAC:
553159307Spjd		return (32);
554159307Spjd	case CRYPTO_SHA2_384_HMAC:
555159307Spjd		return (48);
556159307Spjd	case CRYPTO_SHA2_512_HMAC:
557159307Spjd		return (64);
558159307Spjd	}
559159307Spjd	return (0);
560159307Spjd}
561159307Spjd
562148456Spjd#ifdef _KERNEL
563148456Spjdint g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
564148456Spjd    struct g_eli_metadata *md);
565148456Spjdstruct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp,
566148456Spjd    struct g_provider *bpp, const struct g_eli_metadata *md,
567148456Spjd    const u_char *mkey, int nkey);
568148456Spjdint g_eli_destroy(struct g_eli_softc *sc, boolean_t force);
569148456Spjd
570148456Spjdint g_eli_access(struct g_provider *pp, int dr, int dw, int de);
571148456Spjdvoid g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb);
572159307Spjd
573159307Spjdvoid g_eli_read_done(struct bio *bp);
574159307Spjdvoid g_eli_write_done(struct bio *bp);
575159307Spjdint g_eli_crypto_rerun(struct cryptop *crp);
576159307Spjdvoid g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
577159307Spjd    size_t size);
578159307Spjd
579214118Spjdvoid g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker);
580159307Spjdvoid g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp);
581159307Spjd
582159307Spjdvoid g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp);
583159307Spjdvoid g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp);
584148456Spjd#endif
585148456Spjd
586148456Spjdvoid g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key);
587148456Spjdint g_eli_mkey_decrypt(const struct g_eli_metadata *md,
588148456Spjd    const unsigned char *key, unsigned char *mkey, unsigned *nkeyp);
589148456Spjdint g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen,
590148456Spjd    unsigned char *mkey);
591159307Spjd#ifdef _KERNEL
592159307Spjdvoid g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey);
593159307Spjd#endif
594148456Spjd
595148456Spjdint g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize,
596148456Spjd    const u_char *key, size_t keysize);
597148456Spjdint g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize,
598148456Spjd    const u_char *key, size_t keysize);
599148456Spjd
600148456Spjdstruct hmac_ctx {
601148456Spjd	SHA512_CTX	shactx;
602148456Spjd	u_char		k_opad[128];
603148456Spjd};
604148456Spjd
605148456Spjdvoid g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey,
606148456Spjd    size_t hkeylen);
607148456Spjdvoid g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data,
608148456Spjd    size_t datasize);
609148456Spjdvoid g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize);
610148456Spjdvoid g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize,
611148456Spjd    const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize);
612220922Spjd
613220922Spjd#ifdef _KERNEL
614220922Spjdvoid g_eli_key_init(struct g_eli_softc *sc);
615220922Spjdvoid g_eli_key_destroy(struct g_eli_softc *sc);
616220922Spjduint8_t *g_eli_key_hold(struct g_eli_softc *sc, off_t offset, size_t blocksize);
617220922Spjdvoid g_eli_key_drop(struct g_eli_softc *sc, uint8_t *rawkey);
618220922Spjd#endif
619148456Spjd#endif	/* !_G_ELI_H_ */
620