geom_aes.c revision 104064 
1/*-
2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
4 * All rights reserved.
5 *
6 * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7 * and NAI Labs, the Security Research Division of Network Associates, Inc.
8 * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9 * DARPA CHATS research program.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 * 3. The names of the authors may not be used to endorse or promote
20 *    products derived from this software without specific prior written
21 *    permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * $FreeBSD: head/sys/geom/geom_aes.c 104064 2002-09-27 21:37:11Z phk $
36 *
37 * This method provides AES encryption with a compiled in key (default
38 * all zeroes).
39 *
40 * XXX: This could probably save a lot of code by pretending to be a slicer.
41 */
42
43#include <sys/param.h>
44#ifndef _KERNEL
45#include <stdio.h>
46#include <string.h>
47#include <stdlib.h>
48#include <signal.h>
49#include <err.h>
50#else
51#include <sys/systm.h>
52#include <sys/kernel.h>
53#include <sys/conf.h>
54#include <sys/bio.h>
55#include <sys/malloc.h>
56#include <sys/lock.h>
57#include <sys/mutex.h>
58#include <sys/libkern.h>
59#include <sys/md5.h>
60#include <sys/endian.h>
61#endif
62#include <sys/errno.h>
63#include <geom/geom.h>
64
65#include <crypto/rijndael/rijndael.h>
66
67#include <crypto/rijndael/rijndael.h>
68
69#define AES_CLASS_NAME "AES"
70
71#define MASTER_KEY_LENGTH	(1024/8)
72
73static u_char *aes_magic = "<<FreeBSD-GEOM-AES>>";
74static u_char *aes_magic_random = "<<FreeBSD-GEOM-AES-RANDOM>>";
75static u_char *aes_magic_test = "<<FreeBSD-GEOM-AES-TEST>>";
76
77
78struct g_aes_softc {
79	enum {
80		KEY_ZERO,
81		KEY_RANDOM,
82		KEY_TEST
83	} keying;
84	u_int	sectorsize;
85	off_t	mediasize;
86	cipherInstance ci;
87	u_char master_key[MASTER_KEY_LENGTH];
88};
89
90/*
91 * Generate a sectorkey from the masterkey and the offset position.
92 *
93 * For KEY_ZERO we just return a key of all zeros.
94 *
95 * We feed the sector byte offset, 16 bytes of the master-key and
96 * the sector byte offset once more to MD5.
97 * The sector byte offset is converted to little-endian format first
98 * to support multi-architecture operation.
99 * We use 16 bytes from the master-key starting at the logical sector
100 * number modulus he length of the master-key.  If need be we wrap
101 * around to the start of the master-key.
102 */
103
104static void
105g_aes_makekey(struct g_aes_softc *sc, off_t off, keyInstance *ki, int dir)
106{
107	MD5_CTX cx;
108	u_int64_t u64;
109	u_int u, u1;
110	u_char *p, buf[16];
111
112	if (sc->keying == KEY_ZERO) {
113		rijndael_makeKey(ki, dir, 128, sc->master_key);
114		return;
115	}
116	MD5Init(&cx);
117	u64 = htole64(off);
118	MD5Update(&cx, (u_char *)&u64, sizeof(u64));
119	u = off / sc->sectorsize;
120	u %= sizeof sc->master_key;
121	p = sc->master_key + u;
122	if (u + 16 <= sizeof(sc->master_key)) {
123		MD5Update(&cx, p, 16);
124	} else {
125		u1 = sizeof sc->master_key - u;
126		MD5Update(&cx, p, u1);
127		MD5Update(&cx, sc->master_key, 16 - u1);
128		u1 = 0;				/* destroy evidence */
129	}
130	u = 0;					/* destroy evidence */
131	MD5Update(&cx, (u_char *)&u64, sizeof(u64));
132	u64 = 0;				/* destroy evidence */
133	MD5Final(buf, &cx);
134	bzero(&cx, sizeof cx);			/* destroy evidence */
135	rijndael_makeKey(ki, dir, 128, buf);
136	bzero(buf, sizeof buf);			/* destroy evidence */
137
138}
139
140static void
141g_aes_read_done(struct bio *bp)
142{
143	struct g_geom *gp;
144	struct g_aes_softc *sc;
145	u_char *p, *b, *e, *sb;
146	keyInstance dkey;
147	off_t o;
148
149	gp = bp->bio_from->geom;
150	sc = gp->softc;
151	sb = g_malloc(sc->sectorsize, M_WAITOK);
152	b = bp->bio_data;
153	e = bp->bio_data;
154	e += bp->bio_length;
155	o = bp->bio_offset - sc->sectorsize;
156	for (p = b; p < e; p += sc->sectorsize) {
157		g_aes_makekey(sc, o, &dkey, DIR_DECRYPT);
158		rijndael_blockDecrypt(&sc->ci, &dkey, p, sc->sectorsize * 8, sb);
159		bcopy(sb, p, sc->sectorsize);
160		o += sc->sectorsize;
161	}
162	bzero(&dkey, sizeof dkey);		/* destroy evidence */
163	bzero(sb, sc->sectorsize);		/* destroy evidence */
164	g_free(sb);
165	g_std_done(bp);
166}
167
168static void
169g_aes_write_done(struct bio *bp)
170{
171	struct g_aes_softc *sc;
172	struct g_geom *gp;
173
174	gp = bp->bio_to->geom;
175	sc = gp->softc;
176	bzero(bp->bio_data, bp->bio_length);	/* destroy evidence */
177	g_free(bp->bio_data);
178	g_std_done(bp);
179}
180
181static void
182g_aes_start(struct bio *bp)
183{
184	struct g_geom *gp;
185	struct g_consumer *cp;
186	struct g_aes_softc *sc;
187	struct bio *bp2;
188	u_char *p1, *p2, *b, *e;
189	keyInstance ekey;
190	off_t o;
191
192	gp = bp->bio_to->geom;
193	cp = LIST_FIRST(&gp->consumer);
194	sc = gp->softc;
195	switch (bp->bio_cmd) {
196	case BIO_READ:
197		bp2 = g_clone_bio(bp);
198		if (bp2 == NULL) {
199			g_io_fail(bp, ENOMEM);
200			return;
201		}
202		bp2->bio_done = g_aes_read_done;
203		bp2->bio_offset += sc->sectorsize;
204		g_io_request(bp2, cp);
205		break;
206	case BIO_WRITE:
207		bp2 = g_clone_bio(bp);
208		if (bp2 == NULL) {
209			g_io_fail(bp, ENOMEM);
210			return;
211		}
212		bp2->bio_done = g_aes_write_done;
213		bp2->bio_offset += sc->sectorsize;
214		bp2->bio_data = g_malloc(bp->bio_length, M_WAITOK);
215		b = bp->bio_data;
216		e = bp->bio_data;
217		e += bp->bio_length;
218		p2 = bp2->bio_data;
219		o = bp->bio_offset;
220		for (p1 = b; p1 < e; p1 += sc->sectorsize) {
221			g_aes_makekey(sc, o, &ekey, DIR_ENCRYPT);
222			rijndael_blockEncrypt(&sc->ci, &ekey,
223			    p1, sc->sectorsize * 8, p2);
224			p2 += sc->sectorsize;
225			o += sc->sectorsize;
226		}
227		bzero(&ekey, sizeof ekey);	/* destroy evidence */
228		g_io_request(bp2, cp);
229		break;
230	case BIO_GETATTR:
231	case BIO_SETATTR:
232		if (g_handleattr_off_t(bp, "GEOM::mediasize", sc->mediasize))
233			return;
234		if (g_handleattr_int(bp, "GEOM::sectorsize", sc->sectorsize))
235			return;
236		bp2 = g_clone_bio(bp);
237		if (bp2 == NULL) {
238			g_io_fail(bp, ENOMEM);
239			return;
240		}
241		bp2->bio_done = g_std_done;
242		bp2->bio_offset += sc->sectorsize;
243		g_io_request(bp2, cp);
244		break;
245	default:
246		bp->bio_error = EOPNOTSUPP;
247		g_io_deliver(bp);
248		return;
249	}
250	return;
251}
252
253static void
254g_aes_orphan(struct g_consumer *cp)
255{
256	struct g_geom *gp;
257	struct g_provider *pp;
258	struct g_aes_softc *sc;
259	int error;
260
261	g_trace(G_T_TOPOLOGY, "g_aes_orphan(%p/%s)", cp, cp->provider->name);
262	g_topology_assert();
263	KASSERT(cp->provider->error != 0,
264		("g_aes_orphan with error == 0"));
265
266	gp = cp->geom;
267	sc = gp->softc;
268	gp->flags |= G_GEOM_WITHER;
269	error = cp->provider->error;
270	LIST_FOREACH(pp, &gp->provider, provider)
271		g_orphan_provider(pp, error);
272	bzero(sc, sizeof(struct g_aes_softc));	/* destroy evidence */
273	return;
274}
275
276static int
277g_aes_access(struct g_provider *pp, int dr, int dw, int de)
278{
279	struct g_geom *gp;
280	struct g_consumer *cp;
281
282	gp = pp->geom;
283	cp = LIST_FIRST(&gp->consumer);
284	/* On first open, grab an extra "exclusive" bit */
285	if (cp->acr == 0 && cp->acw == 0 && cp->ace == 0)
286		de++;
287	/* ... and let go of it on last close */
288	if ((cp->acr + dr) == 0 && (cp->acw + dw) == 0 && (cp->ace + de) == 1)
289		de--;
290	return (g_access_rel(cp, dr, dw, de));
291}
292
293static struct g_geom *
294g_aes_taste(struct g_class *mp, struct g_provider *pp, int flags __unused)
295{
296	struct g_geom *gp;
297	struct g_consumer *cp;
298	struct g_aes_softc *sc;
299	int error;
300	u_int sectorsize;
301	off_t mediasize;
302	u_char *buf;
303
304	g_trace(G_T_TOPOLOGY, "aes_taste(%s,%s)", mp->name, pp->name);
305	g_topology_assert();
306	gp = g_new_geomf(mp, "%s.aes", pp->name);
307	gp->start = g_aes_start;
308	gp->orphan = g_aes_orphan;
309	gp->spoiled = g_std_spoiled;
310	cp = g_new_consumer(gp);
311	g_attach(cp, pp);
312	error = g_access_rel(cp, 1, 0, 0);
313	if (error) {
314		g_detach(cp);
315		g_destroy_consumer(cp);
316		g_destroy_geom(gp);
317		return (NULL);
318	}
319	buf = NULL;
320	g_topology_unlock();
321	while (1) {
322		if (gp->rank != 2)
323			break;
324		error = g_getattr("GEOM::sectorsize", cp, &sectorsize);
325		if (error)
326			break;
327		error = g_getattr("GEOM::mediasize", cp, &mediasize);
328		if (error)
329			break;
330		buf = g_read_data(cp, 0, sectorsize, &error);
331		if (buf == NULL || error != 0) {
332			break;
333		}
334		sc = g_malloc(sizeof(struct g_aes_softc), M_WAITOK | M_ZERO);
335		if (!memcmp(buf, aes_magic, strlen(aes_magic))) {
336			sc->keying = KEY_ZERO;
337		} else if (!memcmp(buf, aes_magic_random,
338		    strlen(aes_magic_random))) {
339			sc->keying = KEY_RANDOM;
340		} else if (!memcmp(buf, aes_magic_test,
341		    strlen(aes_magic_test))) {
342			sc->keying = KEY_TEST;
343		} else {
344			g_free(sc);
345			break;
346		}
347		gp->softc = sc;
348		gp->access = g_aes_access;
349		sc->sectorsize = sectorsize;
350		sc->mediasize = mediasize - sectorsize;
351		rijndael_cipherInit(&sc->ci, MODE_CBC, NULL);
352		if (sc->keying == KEY_TEST) {
353			int i;
354			u_char *p;
355
356			p = sc->master_key;
357			for (i = 0; i < sizeof sc->master_key; i ++)
358				*p++ = i;
359		}
360		if (sc->keying == KEY_RANDOM) {
361			int i;
362			u_int32_t u;
363			u_char *p;
364
365			p = sc->master_key;
366			for (i = 0; i < sizeof sc->master_key; i += sizeof u) {
367				u = arc4random();
368				*p++ = u;
369				*p++ = u >> 8;
370				*p++ = u >> 16;
371				*p++ = u >> 24;
372			}
373		}
374		g_topology_lock();
375		pp = g_new_providerf(gp, gp->name);
376		pp->mediasize = mediasize - sectorsize;
377		g_error_provider(pp, 0);
378		g_topology_unlock();
379		break;
380	}
381	g_topology_lock();
382	if (buf)
383		g_free(buf);
384	g_access_rel(cp, -1, 0, 0);
385	if (gp->softc != NULL)
386		return (gp);
387	g_detach(cp);
388	g_destroy_consumer(cp);
389	g_destroy_geom(gp);
390	return (NULL);
391}
392
393static struct g_class g_aes_class	= {
394	AES_CLASS_NAME,
395	g_aes_taste,
396	NULL,
397	G_CLASS_INITIALIZER
398};
399
400DECLARE_GEOM_CLASS(g_aes_class, g_aes);
401