g_eli.h revision 238116
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 238116 2012-07-04 17:54:17Z 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).
71238116Spjd * 7 - Encryption keys are now generated from the Data Key and not from the
72238116Spjd *     IV Key (the G_ELI_FLAG_ENC_IVKEY flag will be set for older versions).
73148456Spjd */
74221628Spjd#define	G_ELI_VERSION_00	0
75221628Spjd#define	G_ELI_VERSION_01	1
76221628Spjd#define	G_ELI_VERSION_02	2
77221628Spjd#define	G_ELI_VERSION_03	3
78221628Spjd#define	G_ELI_VERSION_04	4
79221628Spjd#define	G_ELI_VERSION_05	5
80221628Spjd#define	G_ELI_VERSION_06	6
81238116Spjd#define	G_ELI_VERSION_07	7
82238116Spjd#define	G_ELI_VERSION		G_ELI_VERSION_07
83148456Spjd
84161127Spjd/* ON DISK FLAGS. */
85148456Spjd/* Use random, onetime keys. */
86161220Spjd#define	G_ELI_FLAG_ONETIME		0x00000001
87148456Spjd/* Ask for the passphrase from the kernel, before mounting root. */
88161220Spjd#define	G_ELI_FLAG_BOOT			0x00000002
89148456Spjd/* Detach on last close, if we were open for writing. */
90161220Spjd#define	G_ELI_FLAG_WO_DETACH		0x00000004
91148456Spjd/* Detach on last close. */
92161220Spjd#define	G_ELI_FLAG_RW_DETACH		0x00000008
93159307Spjd/* Provide data authentication. */
94161220Spjd#define	G_ELI_FLAG_AUTH			0x00000010
95161127Spjd/* Provider is read-only, we should deny all write attempts. */
96161220Spjd#define	G_ELI_FLAG_RO			0x00000020
97161127Spjd/* RUNTIME FLAGS. */
98148456Spjd/* Provider was open for writing. */
99161220Spjd#define	G_ELI_FLAG_WOPEN		0x00010000
100148456Spjd/* Destroy device. */
101161220Spjd#define	G_ELI_FLAG_DESTROY		0x00020000
102161220Spjd/* Provider uses native byte-order for IV generation. */
103161220Spjd#define	G_ELI_FLAG_NATIVE_BYTE_ORDER	0x00040000
104213067Spjd/* Provider uses single encryption key. */
105213067Spjd#define	G_ELI_FLAG_SINGLE_KEY		0x00080000
106214118Spjd/* Device suspended. */
107214118Spjd#define	G_ELI_FLAG_SUSPEND		0x00100000
108221628Spjd/* Provider uses first encryption key. */
109221628Spjd#define	G_ELI_FLAG_FIRST_KEY		0x00200000
110238116Spjd/* Provider uses IV-Key for encryption key generation. */
111238116Spjd#define	G_ELI_FLAG_ENC_IVKEY		0x00400000
112148456Spjd
113214118Spjd#define	G_ELI_NEW_BIO	255
114214118Spjd
115148456Spjd#define	SHA512_MDLEN		64
116159307Spjd#define	G_ELI_AUTH_SECKEYLEN	SHA256_DIGEST_LENGTH
117148456Spjd
118148456Spjd#define	G_ELI_MAXMKEYS		2
119148456Spjd#define	G_ELI_MAXKEYLEN		64
120148456Spjd#define	G_ELI_USERKEYLEN	G_ELI_MAXKEYLEN
121148456Spjd#define	G_ELI_DATAKEYLEN	G_ELI_MAXKEYLEN
122159307Spjd#define	G_ELI_AUTHKEYLEN	G_ELI_MAXKEYLEN
123148456Spjd#define	G_ELI_IVKEYLEN		G_ELI_MAXKEYLEN
124148456Spjd#define	G_ELI_SALTLEN		64
125148456Spjd#define	G_ELI_DATAIVKEYLEN	(G_ELI_DATAKEYLEN + G_ELI_IVKEYLEN)
126148456Spjd/* Data-Key, IV-Key, HMAC_SHA512(Derived-Key, Data-Key+IV-Key) */
127148456Spjd#define	G_ELI_MKEYLEN		(G_ELI_DATAIVKEYLEN + SHA512_MDLEN)
128213062Spjd#define	G_ELI_OVERWRITES	5
129213067Spjd/* Switch data encryption key every 2^20 blocks. */
130213067Spjd#define	G_ELI_KEY_SHIFT		20
131148456Spjd
132148456Spjd#ifdef _KERNEL
133213165Spjdextern int g_eli_debug;
134148456Spjdextern u_int g_eli_overwrites;
135159307Spjdextern u_int g_eli_batch;
136148456Spjd
137214163Spjd#define	G_ELI_CRYPTO_UNKNOWN	0
138148456Spjd#define	G_ELI_CRYPTO_HW		1
139148456Spjd#define	G_ELI_CRYPTO_SW		2
140148456Spjd
141148456Spjd#define	G_ELI_DEBUG(lvl, ...)	do {					\
142148456Spjd	if (g_eli_debug >= (lvl)) {					\
143148456Spjd		printf("GEOM_ELI");					\
144148456Spjd		if (g_eli_debug > 0)					\
145148456Spjd			printf("[%u]", lvl);				\
146148456Spjd		printf(": ");						\
147148456Spjd		printf(__VA_ARGS__);					\
148148456Spjd		printf("\n");						\
149148456Spjd	}								\
150148456Spjd} while (0)
151148456Spjd#define	G_ELI_LOGREQ(lvl, bp, ...)	do {				\
152148456Spjd	if (g_eli_debug >= (lvl)) {					\
153148456Spjd		printf("GEOM_ELI");					\
154148456Spjd		if (g_eli_debug > 0)					\
155148456Spjd			printf("[%u]", lvl);				\
156148456Spjd		printf(": ");						\
157148456Spjd		printf(__VA_ARGS__);					\
158148456Spjd		printf(" ");						\
159148456Spjd		g_print_bio(bp);					\
160148456Spjd		printf("\n");						\
161148456Spjd	}								\
162148456Spjd} while (0)
163148456Spjd
164148456Spjdstruct g_eli_worker {
165148456Spjd	struct g_eli_softc	*w_softc;
166148456Spjd	struct proc		*w_proc;
167148456Spjd	u_int			 w_number;
168148456Spjd	uint64_t		 w_sid;
169214118Spjd	boolean_t		 w_active;
170148456Spjd	LIST_ENTRY(g_eli_worker) w_next;
171148456Spjd};
172148456Spjd
173148456Spjdstruct g_eli_softc {
174220922Spjd	struct g_geom	*sc_geom;
175226733Spjd	u_int		 sc_version;
176220922Spjd	u_int		 sc_crypto;
177220922Spjd	uint8_t		 sc_mkey[G_ELI_DATAIVKEYLEN];
178220922Spjd	uint8_t		 sc_ekey[G_ELI_DATAKEYLEN];
179220922Spjd	TAILQ_HEAD(, g_eli_key) sc_ekeys_queue;
180220922Spjd	RB_HEAD(g_eli_key_tree, g_eli_key) sc_ekeys_tree;
181220922Spjd	struct mtx	 sc_ekeys_lock;
182220922Spjd	uint64_t	 sc_ekeys_total;
183220922Spjd	uint64_t	 sc_ekeys_allocated;
184220922Spjd	u_int		 sc_ealgo;
185220922Spjd	u_int		 sc_ekeylen;
186220922Spjd	uint8_t		 sc_akey[G_ELI_AUTHKEYLEN];
187220922Spjd	u_int		 sc_aalgo;
188220922Spjd	u_int		 sc_akeylen;
189220922Spjd	u_int		 sc_alen;
190220922Spjd	SHA256_CTX	 sc_akeyctx;
191220922Spjd	uint8_t		 sc_ivkey[G_ELI_IVKEYLEN];
192220922Spjd	SHA256_CTX	 sc_ivctx;
193220922Spjd	int		 sc_nkey;
194220922Spjd	uint32_t	 sc_flags;
195220922Spjd	int		 sc_inflight;
196220922Spjd	off_t		 sc_mediasize;
197220922Spjd	size_t		 sc_sectorsize;
198220922Spjd	u_int		 sc_bytes_per_sector;
199220922Spjd	u_int		 sc_data_per_sector;
200226840Spjd	boolean_t	 sc_cpubind;
201148456Spjd
202148456Spjd	/* Only for software cryptography. */
203148456Spjd	struct bio_queue_head sc_queue;
204220922Spjd	struct mtx	 sc_queue_mtx;
205148456Spjd	LIST_HEAD(, g_eli_worker) sc_workers;
206148456Spjd};
207148456Spjd#define	sc_name		 sc_geom->name
208148456Spjd#endif	/* _KERNEL */
209148456Spjd
210148456Spjdstruct g_eli_metadata {
211148456Spjd	char		md_magic[16];	/* Magic value. */
212148456Spjd	uint32_t	md_version;	/* Version number. */
213148456Spjd	uint32_t	md_flags;	/* Additional flags. */
214159307Spjd	uint16_t	md_ealgo;	/* Encryption algorithm. */
215148456Spjd	uint16_t	md_keylen;	/* Key length. */
216159307Spjd	uint16_t	md_aalgo;	/* Authentication algorithm. */
217148456Spjd	uint64_t	md_provsize;	/* Provider's size. */
218148456Spjd	uint32_t	md_sectorsize;	/* Sector size. */
219148456Spjd	uint8_t		md_keys;	/* Available keys. */
220149303Spjd	int32_t		md_iterations;	/* Number of iterations for PKCS#5v2. */
221148456Spjd	uint8_t		md_salt[G_ELI_SALTLEN]; /* Salt. */
222148456Spjd			/* Encrypted master key (IV-key, Data-key, HMAC). */
223148456Spjd	uint8_t		md_mkeys[G_ELI_MAXMKEYS * G_ELI_MKEYLEN];
224148456Spjd	u_char		md_hash[16];	/* MD5 hash. */
225149323Spjd} __packed;
226148456Spjd#ifndef _OpenSSL_
227148456Spjdstatic __inline void
228226733Spjdeli_metadata_encode_v0(struct g_eli_metadata *md, u_char **datap)
229148456Spjd{
230148456Spjd	u_char *p;
231148456Spjd
232226733Spjd	p = *datap;
233148456Spjd	le32enc(p, md->md_flags);	p += sizeof(md->md_flags);
234159307Spjd	le16enc(p, md->md_ealgo);	p += sizeof(md->md_ealgo);
235148456Spjd	le16enc(p, md->md_keylen);	p += sizeof(md->md_keylen);
236226733Spjd	le64enc(p, md->md_provsize);	p += sizeof(md->md_provsize);
237226733Spjd	le32enc(p, md->md_sectorsize);	p += sizeof(md->md_sectorsize);
238226733Spjd	*p = md->md_keys;		p += sizeof(md->md_keys);
239226733Spjd	le32enc(p, md->md_iterations);	p += sizeof(md->md_iterations);
240226733Spjd	bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
241226733Spjd	bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
242226733Spjd	*datap = p;
243226733Spjd}
244226733Spjdstatic __inline void
245238116Spjdeli_metadata_encode_v1v2v3v4v5v6v7(struct g_eli_metadata *md, u_char **datap)
246226733Spjd{
247226733Spjd	u_char *p;
248226733Spjd
249226733Spjd	p = *datap;
250226733Spjd	le32enc(p, md->md_flags);	p += sizeof(md->md_flags);
251226733Spjd	le16enc(p, md->md_ealgo);	p += sizeof(md->md_ealgo);
252226733Spjd	le16enc(p, md->md_keylen);	p += sizeof(md->md_keylen);
253159307Spjd	le16enc(p, md->md_aalgo);	p += sizeof(md->md_aalgo);
254148456Spjd	le64enc(p, md->md_provsize);	p += sizeof(md->md_provsize);
255148456Spjd	le32enc(p, md->md_sectorsize);	p += sizeof(md->md_sectorsize);
256148456Spjd	*p = md->md_keys;		p += sizeof(md->md_keys);
257148456Spjd	le32enc(p, md->md_iterations);	p += sizeof(md->md_iterations);
258148456Spjd	bcopy(md->md_salt, p, sizeof(md->md_salt)); p += sizeof(md->md_salt);
259148456Spjd	bcopy(md->md_mkeys, p, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
260226733Spjd	*datap = p;
261226733Spjd}
262226733Spjdstatic __inline void
263226733Spjdeli_metadata_encode(struct g_eli_metadata *md, u_char *data)
264226733Spjd{
265226733Spjd	MD5_CTX ctx;
266226733Spjd	u_char *p;
267226733Spjd
268226733Spjd	p = data;
269226733Spjd	bcopy(md->md_magic, p, sizeof(md->md_magic));
270226733Spjd	p += sizeof(md->md_magic);
271226733Spjd	le32enc(p, md->md_version);
272226733Spjd	p += sizeof(md->md_version);
273226733Spjd	switch (md->md_version) {
274226733Spjd	case G_ELI_VERSION_00:
275226733Spjd		eli_metadata_encode_v0(md, &p);
276226733Spjd		break;
277226733Spjd	case G_ELI_VERSION_01:
278226733Spjd	case G_ELI_VERSION_02:
279226733Spjd	case G_ELI_VERSION_03:
280226733Spjd	case G_ELI_VERSION_04:
281226733Spjd	case G_ELI_VERSION_05:
282226733Spjd	case G_ELI_VERSION_06:
283238116Spjd	case G_ELI_VERSION_07:
284238116Spjd		eli_metadata_encode_v1v2v3v4v5v6v7(md, &p);
285226733Spjd		break;
286226733Spjd	default:
287226733Spjd#ifdef _KERNEL
288226733Spjd		panic("%s: Unsupported version %u.", __func__,
289226733Spjd		    (u_int)md->md_version);
290226733Spjd#else
291226733Spjd		assert(!"Unsupported metadata version.");
292226733Spjd#endif
293226733Spjd	}
294148456Spjd	MD5Init(&ctx);
295148456Spjd	MD5Update(&ctx, data, p - data);
296157305Spjd	MD5Final(md->md_hash, &ctx);
297148456Spjd	bcopy(md->md_hash, p, sizeof(md->md_hash));
298148456Spjd}
299148456Spjdstatic __inline int
300148456Spjdeli_metadata_decode_v0(const u_char *data, struct g_eli_metadata *md)
301148456Spjd{
302148456Spjd	MD5_CTX ctx;
303148456Spjd	const u_char *p;
304148456Spjd
305148456Spjd	p = data + sizeof(md->md_magic) + sizeof(md->md_version);
306148456Spjd	md->md_flags = le32dec(p);	p += sizeof(md->md_flags);
307159307Spjd	md->md_ealgo = le16dec(p);	p += sizeof(md->md_ealgo);
308148456Spjd	md->md_keylen = le16dec(p);	p += sizeof(md->md_keylen);
309148456Spjd	md->md_provsize = le64dec(p);	p += sizeof(md->md_provsize);
310148456Spjd	md->md_sectorsize = le32dec(p);	p += sizeof(md->md_sectorsize);
311148456Spjd	md->md_keys = *p;		p += sizeof(md->md_keys);
312148456Spjd	md->md_iterations = le32dec(p);	p += sizeof(md->md_iterations);
313148456Spjd	bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
314148456Spjd	bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
315148456Spjd	MD5Init(&ctx);
316148456Spjd	MD5Update(&ctx, data, p - data);
317157305Spjd	MD5Final(md->md_hash, &ctx);
318148456Spjd	if (bcmp(md->md_hash, p, 16) != 0)
319148456Spjd		return (EINVAL);
320148456Spjd	return (0);
321148456Spjd}
322212845Sbrian
323148456Spjdstatic __inline int
324238116Spjdeli_metadata_decode_v1v2v3v4v5v6v7(const u_char *data, struct g_eli_metadata *md)
325159307Spjd{
326159307Spjd	MD5_CTX ctx;
327159307Spjd	const u_char *p;
328159307Spjd
329159307Spjd	p = data + sizeof(md->md_magic) + sizeof(md->md_version);
330159307Spjd	md->md_flags = le32dec(p);	p += sizeof(md->md_flags);
331159307Spjd	md->md_ealgo = le16dec(p);	p += sizeof(md->md_ealgo);
332159307Spjd	md->md_keylen = le16dec(p);	p += sizeof(md->md_keylen);
333159307Spjd	md->md_aalgo = le16dec(p);	p += sizeof(md->md_aalgo);
334159307Spjd	md->md_provsize = le64dec(p);	p += sizeof(md->md_provsize);
335159307Spjd	md->md_sectorsize = le32dec(p);	p += sizeof(md->md_sectorsize);
336159307Spjd	md->md_keys = *p;		p += sizeof(md->md_keys);
337159307Spjd	md->md_iterations = le32dec(p);	p += sizeof(md->md_iterations);
338159307Spjd	bcopy(p, md->md_salt, sizeof(md->md_salt)); p += sizeof(md->md_salt);
339159307Spjd	bcopy(p, md->md_mkeys, sizeof(md->md_mkeys)); p += sizeof(md->md_mkeys);
340159307Spjd	MD5Init(&ctx);
341159307Spjd	MD5Update(&ctx, data, p - data);
342159307Spjd	MD5Final(md->md_hash, &ctx);
343159307Spjd	if (bcmp(md->md_hash, p, 16) != 0)
344159307Spjd		return (EINVAL);
345159307Spjd	return (0);
346159307Spjd}
347159307Spjdstatic __inline int
348148456Spjdeli_metadata_decode(const u_char *data, struct g_eli_metadata *md)
349148456Spjd{
350148456Spjd	int error;
351148456Spjd
352148456Spjd	bcopy(data, md->md_magic, sizeof(md->md_magic));
353226730Spjd	if (strcmp(md->md_magic, G_ELI_MAGIC) != 0)
354226730Spjd		return (EINVAL);
355148456Spjd	md->md_version = le32dec(data + sizeof(md->md_magic));
356148456Spjd	switch (md->md_version) {
357221629Spjd	case G_ELI_VERSION_00:
358148456Spjd		error = eli_metadata_decode_v0(data, md);
359148456Spjd		break;
360221629Spjd	case G_ELI_VERSION_01:
361221629Spjd	case G_ELI_VERSION_02:
362221629Spjd	case G_ELI_VERSION_03:
363221629Spjd	case G_ELI_VERSION_04:
364221629Spjd	case G_ELI_VERSION_05:
365221629Spjd	case G_ELI_VERSION_06:
366238116Spjd	case G_ELI_VERSION_07:
367238116Spjd		error = eli_metadata_decode_v1v2v3v4v5v6v7(data, md);
368159307Spjd		break;
369148456Spjd	default:
370226721Spjd		error = EOPNOTSUPP;
371148456Spjd		break;
372148456Spjd	}
373148456Spjd	return (error);
374148456Spjd}
375148456Spjd#endif	/* !_OpenSSL */
376148456Spjd
377148456Spjdstatic __inline u_int
378159307Spjdg_eli_str2ealgo(const char *name)
379148456Spjd{
380148456Spjd
381148867Spjd	if (strcasecmp("null", name) == 0)
382148456Spjd		return (CRYPTO_NULL_CBC);
383213070Spjd	else if (strcasecmp("null-cbc", name) == 0)
384213070Spjd		return (CRYPTO_NULL_CBC);
385148867Spjd	else if (strcasecmp("aes", name) == 0)
386213070Spjd		return (CRYPTO_AES_XTS);
387213070Spjd	else if (strcasecmp("aes-cbc", name) == 0)
388148456Spjd		return (CRYPTO_AES_CBC);
389213070Spjd	else if (strcasecmp("aes-xts", name) == 0)
390213070Spjd		return (CRYPTO_AES_XTS);
391148867Spjd	else if (strcasecmp("blowfish", name) == 0)
392148456Spjd		return (CRYPTO_BLF_CBC);
393213070Spjd	else if (strcasecmp("blowfish-cbc", name) == 0)
394213070Spjd		return (CRYPTO_BLF_CBC);
395172031Spjd	else if (strcasecmp("camellia", name) == 0)
396172031Spjd		return (CRYPTO_CAMELLIA_CBC);
397213070Spjd	else if (strcasecmp("camellia-cbc", name) == 0)
398213070Spjd		return (CRYPTO_CAMELLIA_CBC);
399148867Spjd	else if (strcasecmp("3des", name) == 0)
400148456Spjd		return (CRYPTO_3DES_CBC);
401213070Spjd	else if (strcasecmp("3des-cbc", name) == 0)
402213070Spjd		return (CRYPTO_3DES_CBC);
403148456Spjd	return (CRYPTO_ALGORITHM_MIN - 1);
404148456Spjd}
405148456Spjd
406159307Spjdstatic __inline u_int
407159307Spjdg_eli_str2aalgo(const char *name)
408159307Spjd{
409159307Spjd
410159307Spjd	if (strcasecmp("hmac/md5", name) == 0)
411159307Spjd		return (CRYPTO_MD5_HMAC);
412159307Spjd	else if (strcasecmp("hmac/sha1", name) == 0)
413159307Spjd		return (CRYPTO_SHA1_HMAC);
414159307Spjd	else if (strcasecmp("hmac/ripemd160", name) == 0)
415159307Spjd		return (CRYPTO_RIPEMD160_HMAC);
416159307Spjd	else if (strcasecmp("hmac/sha256", name) == 0)
417159307Spjd		return (CRYPTO_SHA2_256_HMAC);
418159307Spjd	else if (strcasecmp("hmac/sha384", name) == 0)
419159307Spjd		return (CRYPTO_SHA2_384_HMAC);
420159307Spjd	else if (strcasecmp("hmac/sha512", name) == 0)
421159307Spjd		return (CRYPTO_SHA2_512_HMAC);
422159307Spjd	return (CRYPTO_ALGORITHM_MIN - 1);
423159307Spjd}
424159307Spjd
425148456Spjdstatic __inline const char *
426148456Spjdg_eli_algo2str(u_int algo)
427148456Spjd{
428148456Spjd
429148456Spjd	switch (algo) {
430148456Spjd	case CRYPTO_NULL_CBC:
431148456Spjd		return ("NULL");
432148456Spjd	case CRYPTO_AES_CBC:
433159307Spjd		return ("AES-CBC");
434213070Spjd	case CRYPTO_AES_XTS:
435213070Spjd		return ("AES-XTS");
436148456Spjd	case CRYPTO_BLF_CBC:
437159307Spjd		return ("Blowfish-CBC");
438172031Spjd	case CRYPTO_CAMELLIA_CBC:
439172031Spjd		return ("CAMELLIA-CBC");
440148456Spjd	case CRYPTO_3DES_CBC:
441159307Spjd		return ("3DES-CBC");
442159307Spjd	case CRYPTO_MD5_HMAC:
443159307Spjd		return ("HMAC/MD5");
444159307Spjd	case CRYPTO_SHA1_HMAC:
445159307Spjd		return ("HMAC/SHA1");
446159307Spjd	case CRYPTO_RIPEMD160_HMAC:
447159307Spjd		return ("HMAC/RIPEMD160");
448159307Spjd	case CRYPTO_SHA2_256_HMAC:
449159307Spjd		return ("HMAC/SHA256");
450159307Spjd	case CRYPTO_SHA2_384_HMAC:
451159307Spjd		return ("HMAC/SHA384");
452159307Spjd	case CRYPTO_SHA2_512_HMAC:
453159307Spjd		return ("HMAC/SHA512");
454148456Spjd	}
455148456Spjd	return ("unknown");
456148456Spjd}
457148456Spjd
458148456Spjdstatic __inline void
459148456Spjdeli_metadata_dump(const struct g_eli_metadata *md)
460148456Spjd{
461148456Spjd	static const char hex[] = "0123456789abcdef";
462148456Spjd	char str[sizeof(md->md_mkeys) * 2 + 1];
463148456Spjd	u_int i;
464148456Spjd
465148456Spjd	printf("     magic: %s\n", md->md_magic);
466148456Spjd	printf("   version: %u\n", (u_int)md->md_version);
467148456Spjd	printf("     flags: 0x%x\n", (u_int)md->md_flags);
468159307Spjd	printf("     ealgo: %s\n", g_eli_algo2str(md->md_ealgo));
469148456Spjd	printf("    keylen: %u\n", (u_int)md->md_keylen);
470159307Spjd	if (md->md_flags & G_ELI_FLAG_AUTH)
471159307Spjd		printf("     aalgo: %s\n", g_eli_algo2str(md->md_aalgo));
472148456Spjd	printf("  provsize: %ju\n", (uintmax_t)md->md_provsize);
473148456Spjd	printf("sectorsize: %u\n", (u_int)md->md_sectorsize);
474148456Spjd	printf("      keys: 0x%02x\n", (u_int)md->md_keys);
475148456Spjd	printf("iterations: %u\n", (u_int)md->md_iterations);
476148456Spjd	bzero(str, sizeof(str));
477148456Spjd	for (i = 0; i < sizeof(md->md_salt); i++) {
478148456Spjd		str[i * 2] = hex[md->md_salt[i] >> 4];
479148456Spjd		str[i * 2 + 1] = hex[md->md_salt[i] & 0x0f];
480148456Spjd	}
481149303Spjd	printf("      Salt: %s\n", str);
482148456Spjd	bzero(str, sizeof(str));
483148456Spjd	for (i = 0; i < sizeof(md->md_mkeys); i++) {
484148456Spjd		str[i * 2] = hex[md->md_mkeys[i] >> 4];
485148456Spjd		str[i * 2 + 1] = hex[md->md_mkeys[i] & 0x0f];
486148456Spjd	}
487148456Spjd	printf("Master Key: %s\n", str);
488148456Spjd	bzero(str, sizeof(str));
489148456Spjd	for (i = 0; i < 16; i++) {
490148456Spjd		str[i * 2] = hex[md->md_hash[i] >> 4];
491148456Spjd		str[i * 2 + 1] = hex[md->md_hash[i] & 0x0f];
492148456Spjd	}
493149303Spjd	printf("  MD5 hash: %s\n", str);
494148456Spjd}
495148456Spjd
496148456Spjdstatic __inline u_int
497148456Spjdg_eli_keylen(u_int algo, u_int keylen)
498148456Spjd{
499148456Spjd
500148456Spjd	switch (algo) {
501148456Spjd	case CRYPTO_NULL_CBC:
502148456Spjd		if (keylen == 0)
503148456Spjd			keylen = 64 * 8;
504148456Spjd		else {
505148456Spjd			if (keylen > 64 * 8)
506148456Spjd				keylen = 0;
507148456Spjd		}
508148456Spjd		return (keylen);
509211927Spjd	case CRYPTO_AES_CBC:
510172031Spjd	case CRYPTO_CAMELLIA_CBC:
511148456Spjd		switch (keylen) {
512148456Spjd		case 0:
513148456Spjd			return (128);
514148456Spjd		case 128:
515148456Spjd		case 192:
516148456Spjd		case 256:
517148456Spjd			return (keylen);
518148456Spjd		default:
519148456Spjd			return (0);
520148456Spjd		}
521213070Spjd	case CRYPTO_AES_XTS:
522213070Spjd		switch (keylen) {
523213070Spjd		case 0:
524213070Spjd			return (128);
525213070Spjd		case 128:
526213070Spjd		case 256:
527213070Spjd			return (keylen);
528213070Spjd		default:
529213070Spjd			return (0);
530213070Spjd		}
531148456Spjd	case CRYPTO_BLF_CBC:
532148456Spjd		if (keylen == 0)
533148456Spjd			return (128);
534148456Spjd		if (keylen < 128 || keylen > 448)
535148456Spjd			return (0);
536148456Spjd		if ((keylen % 32) != 0)
537148456Spjd			return (0);
538148456Spjd		return (keylen);
539148456Spjd	case CRYPTO_3DES_CBC:
540148456Spjd		if (keylen == 0 || keylen == 192)
541148456Spjd			return (192);
542148456Spjd		return (0);
543148456Spjd	default:
544148456Spjd		return (0);
545148456Spjd	}
546148456Spjd}
547148456Spjd
548159307Spjdstatic __inline u_int
549159307Spjdg_eli_hashlen(u_int algo)
550159307Spjd{
551159307Spjd
552159307Spjd	switch (algo) {
553159307Spjd	case CRYPTO_MD5_HMAC:
554159307Spjd		return (16);
555159307Spjd	case CRYPTO_SHA1_HMAC:
556159307Spjd		return (20);
557159307Spjd	case CRYPTO_RIPEMD160_HMAC:
558159307Spjd		return (20);
559159307Spjd	case CRYPTO_SHA2_256_HMAC:
560159307Spjd		return (32);
561159307Spjd	case CRYPTO_SHA2_384_HMAC:
562159307Spjd		return (48);
563159307Spjd	case CRYPTO_SHA2_512_HMAC:
564159307Spjd		return (64);
565159307Spjd	}
566159307Spjd	return (0);
567159307Spjd}
568159307Spjd
569148456Spjd#ifdef _KERNEL
570148456Spjdint g_eli_read_metadata(struct g_class *mp, struct g_provider *pp,
571148456Spjd    struct g_eli_metadata *md);
572148456Spjdstruct g_geom *g_eli_create(struct gctl_req *req, struct g_class *mp,
573148456Spjd    struct g_provider *bpp, const struct g_eli_metadata *md,
574148456Spjd    const u_char *mkey, int nkey);
575148456Spjdint g_eli_destroy(struct g_eli_softc *sc, boolean_t force);
576148456Spjd
577148456Spjdint g_eli_access(struct g_provider *pp, int dr, int dw, int de);
578148456Spjdvoid g_eli_config(struct gctl_req *req, struct g_class *mp, const char *verb);
579159307Spjd
580159307Spjdvoid g_eli_read_done(struct bio *bp);
581159307Spjdvoid g_eli_write_done(struct bio *bp);
582159307Spjdint g_eli_crypto_rerun(struct cryptop *crp);
583159307Spjdvoid g_eli_crypto_ivgen(struct g_eli_softc *sc, off_t offset, u_char *iv,
584159307Spjd    size_t size);
585159307Spjd
586214118Spjdvoid g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker);
587159307Spjdvoid g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp);
588159307Spjd
589159307Spjdvoid g_eli_auth_read(struct g_eli_softc *sc, struct bio *bp);
590159307Spjdvoid g_eli_auth_run(struct g_eli_worker *wr, struct bio *bp);
591148456Spjd#endif
592148456Spjd
593148456Spjdvoid g_eli_mkey_hmac(unsigned char *mkey, const unsigned char *key);
594148456Spjdint g_eli_mkey_decrypt(const struct g_eli_metadata *md,
595148456Spjd    const unsigned char *key, unsigned char *mkey, unsigned *nkeyp);
596148456Spjdint g_eli_mkey_encrypt(unsigned algo, const unsigned char *key, unsigned keylen,
597148456Spjd    unsigned char *mkey);
598159307Spjd#ifdef _KERNEL
599159307Spjdvoid g_eli_mkey_propagate(struct g_eli_softc *sc, const unsigned char *mkey);
600159307Spjd#endif
601148456Spjd
602148456Spjdint g_eli_crypto_encrypt(u_int algo, u_char *data, size_t datasize,
603148456Spjd    const u_char *key, size_t keysize);
604148456Spjdint g_eli_crypto_decrypt(u_int algo, u_char *data, size_t datasize,
605148456Spjd    const u_char *key, size_t keysize);
606148456Spjd
607148456Spjdstruct hmac_ctx {
608148456Spjd	SHA512_CTX	shactx;
609148456Spjd	u_char		k_opad[128];
610148456Spjd};
611148456Spjd
612148456Spjdvoid g_eli_crypto_hmac_init(struct hmac_ctx *ctx, const uint8_t *hkey,
613148456Spjd    size_t hkeylen);
614148456Spjdvoid g_eli_crypto_hmac_update(struct hmac_ctx *ctx, const uint8_t *data,
615148456Spjd    size_t datasize);
616148456Spjdvoid g_eli_crypto_hmac_final(struct hmac_ctx *ctx, uint8_t *md, size_t mdsize);
617148456Spjdvoid g_eli_crypto_hmac(const uint8_t *hkey, size_t hkeysize,
618148456Spjd    const uint8_t *data, size_t datasize, uint8_t *md, size_t mdsize);
619220922Spjd
620220922Spjd#ifdef _KERNEL
621220922Spjdvoid g_eli_key_init(struct g_eli_softc *sc);
622220922Spjdvoid g_eli_key_destroy(struct g_eli_softc *sc);
623220922Spjduint8_t *g_eli_key_hold(struct g_eli_softc *sc, off_t offset, size_t blocksize);
624220922Spjdvoid g_eli_key_drop(struct g_eli_softc *sc, uint8_t *rawkey);
625220922Spjd#endif
626148456Spjd#endif	/* !_G_ELI_H_ */
627