2 * Copyright (c) 2002 Poul-Henning Kamp
3 * Copyright (c) 2002 Networks Associates Technology, Inc.
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.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include <sys/param.h>
39 #include <sys/mutex.h>
40 #include <sys/malloc.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
43 #include <sys/kthread.h>
44 #include <sys/sysctl.h>
46 #include <crypto/rijndael/rijndael-api-fst.h>
47 #include <crypto/sha2/sha512.h>
48 #include <geom/geom.h>
49 #include <geom/bde/g_bde.h>
50 #define BDE_CLASS_NAME "BDE"
52 FEATURE(geom_bde, "GEOM-based Disk Encryption");
55 g_bde_start(struct bio *bp)
58 switch (bp->bio_cmd) {
65 g_io_deliver(bp, EOPNOTSUPP);
68 g_io_deliver(bp, EOPNOTSUPP);
75 g_bde_orphan(struct g_consumer *cp)
78 struct g_provider *pp;
79 struct g_bde_softc *sc;
81 g_trace(G_T_TOPOLOGY, "g_bde_orphan(%p/%s)", cp, cp->provider->name);
86 gp->flags |= G_GEOM_WITHER;
87 LIST_FOREACH(pp, &gp->provider, provider)
88 g_wither_provider(pp, ENXIO);
89 bzero(sc, sizeof(struct g_bde_softc)); /* destroy evidence */
94 g_bde_access(struct g_provider *pp, int dr, int dw, int de)
97 struct g_consumer *cp;
100 cp = LIST_FIRST(&gp->consumer);
101 if (cp->acr == 0 && cp->acw == 0 && cp->ace == 0) {
105 /* ... and let go of it on last close */
106 if ((cp->acr + dr) == 0 && (cp->acw + dw) == 0 && (cp->ace + de) == 1) {
110 return (g_access(cp, dr, dw, de));
114 g_bde_create_geom(struct gctl_req *req, struct g_class *mp, struct g_provider *pp)
117 struct g_consumer *cp;
118 struct g_bde_key *kp;
122 struct g_bde_softc *sc;
126 g_trace(G_T_TOPOLOGY, "g_bde_create_geom(%s, %s)", mp->name, pp->name);
131 gp = g_new_geomf(mp, "%s.bde", pp->name);
132 cp = g_new_consumer(gp);
134 error = g_access(cp, 1, 1, 1);
137 g_destroy_consumer(cp);
139 gctl_error(req, "could not access consumer");
145 pass = gctl_get_param(req, "pass", &i);
146 if (pass == NULL || i != SHA512_DIGEST_LENGTH) {
147 gctl_error(req, "No usable key presented");
150 key = gctl_get_param(req, "key", &i);
151 if (key != NULL && i != 16) {
152 gctl_error(req, "Invalid key presented");
155 sectorsize = cp->provider->sectorsize;
156 mediasize = cp->provider->mediasize;
157 sc = g_malloc(sizeof(struct g_bde_softc), M_WAITOK | M_ZERO);
162 error = g_bde_decrypt_lock(sc, pass, key,
163 mediasize, sectorsize, NULL);
164 bzero(sc->sha2, sizeof sc->sha2);
169 /* Initialize helper-fields */
170 kp->keys_per_sector = kp->sectorsize / G_BDE_SKEYLEN;
171 kp->zone_cont = kp->keys_per_sector * kp->sectorsize;
172 kp->zone_width = kp->zone_cont + kp->sectorsize;
173 kp->media_width = kp->sectorN - kp->sector0 -
174 G_BDE_MAXKEYS * kp->sectorsize;
176 /* Our external parameters */
177 sc->zone_cont = kp->zone_cont;
178 sc->mediasize = g_bde_max_sector(kp);
179 sc->sectorsize = kp->sectorsize;
181 TAILQ_INIT(&sc->freelist);
182 TAILQ_INIT(&sc->worklist);
183 mtx_init(&sc->worklist_mutex, "g_bde_worklist", NULL, MTX_DEF);
184 /* XXX: error check */
185 kproc_create(g_bde_worker, gp, &sc->thread, 0, 0,
186 "g_bde %s", gp->name);
187 pp = g_new_providerf(gp, "%s", gp->name);
188 pp->stripesize = kp->zone_cont;
189 pp->stripeoffset = 0;
190 pp->mediasize = sc->mediasize;
191 pp->sectorsize = sc->sectorsize;
192 g_error_provider(pp, 0);
196 bzero(pass, SHA512_DIGEST_LENGTH);
201 g_access(cp, -1, -1, -1);
203 g_destroy_consumer(cp);
204 if (gp->softc != NULL)
209 gctl_error(req, "Lock was destroyed");
212 gctl_error(req, "Lock was nuked");
215 gctl_error(req, "Could not open lock");
218 gctl_error(req, "Lock not found");
221 gctl_error(req, "Could not open lock (%d)", error);
229 g_bde_destroy_geom(struct gctl_req *req, struct g_class *mp, struct g_geom *gp)
231 struct g_consumer *cp;
232 struct g_provider *pp;
233 struct g_bde_softc *sc;
235 g_trace(G_T_TOPOLOGY, "g_bde_destroy_geom(%s, %s)", mp->name, gp->name);
238 * Orderly detachment.
240 KASSERT(gp != NULL, ("NULL geom"));
241 pp = LIST_FIRST(&gp->provider);
242 KASSERT(pp != NULL, ("NULL provider"));
243 if (pp->acr > 0 || pp->acw > 0 || pp->ace > 0)
246 cp = LIST_FIRST(&gp->consumer);
247 KASSERT(cp != NULL, ("NULL consumer"));
250 g_access(cp, -1, -1, -1);
252 g_destroy_consumer(cp);
253 while (sc->dead != 2 && !LIST_EMPTY(&pp->consumers))
254 tsleep(sc, PRIBIO, "g_bdedie", hz);
255 mtx_destroy(&sc->worklist_mutex);
256 bzero(&sc->key, sizeof sc->key);
258 g_wither_geom(gp, ENXIO);
263 g_bde_ctlreq(struct gctl_req *req, struct g_class *mp, char const *verb)
266 struct g_provider *pp;
268 if (!strcmp(verb, "create geom")) {
269 pp = gctl_get_provider(req, "provider");
271 g_bde_create_geom(req, mp, pp);
272 } else if (!strcmp(verb, "destroy geom")) {
273 gp = gctl_get_geom(req, mp, "geom");
275 g_bde_destroy_geom(req, mp, gp);
277 gctl_error(req, "unknown verb");
281 static struct g_class g_bde_class = {
282 .name = BDE_CLASS_NAME,
283 .version = G_VERSION,
284 .destroy_geom = g_bde_destroy_geom,
285 .ctlreq = g_bde_ctlreq,
286 .start = g_bde_start,
287 .orphan = g_bde_orphan,
288 .access = g_bde_access,
289 .spoiled = g_std_spoiled,
292 DECLARE_GEOM_CLASS(g_bde_class, g_bde);