2 * Copyright (c) 2005-2010 Pawel Jakub Dawidek <pjd@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/linker.h>
34 #include <sys/module.h>
36 #include <sys/mutex.h>
38 #include <sys/sysctl.h>
39 #include <sys/malloc.h>
40 #include <sys/kthread.h>
42 #include <sys/sched.h>
45 #include <sys/vnode.h>
49 #include <geom/geom.h>
50 #include <geom/eli/g_eli.h>
51 #include <geom/eli/pkcs5v2.h>
56 * g_eli_start -> g_eli_crypto_read -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
58 * g_eli_start -> g_eli_crypto_run -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
61 MALLOC_DECLARE(M_ELI);
64 * The function is called after we read and decrypt data.
66 * g_eli_start -> g_eli_crypto_read -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> G_ELI_CRYPTO_READ_DONE -> g_io_deliver
69 g_eli_crypto_read_done(struct cryptop *crp)
71 struct g_eli_softc *sc;
74 if (crp->crp_etype == EAGAIN) {
75 if (g_eli_crypto_rerun(crp) == 0)
78 bp = (struct bio *)crp->crp_opaque;
80 if (crp->crp_etype == 0) {
81 G_ELI_DEBUG(3, "Crypto READ request done (%d/%d).",
82 bp->bio_inbed, bp->bio_children);
83 bp->bio_completed += crp->crp_olen;
85 G_ELI_DEBUG(1, "Crypto READ request failed (%d/%d) error=%d.",
86 bp->bio_inbed, bp->bio_children, crp->crp_etype);
87 if (bp->bio_error == 0)
88 bp->bio_error = crp->crp_etype;
91 * Do we have all sectors already?
93 if (bp->bio_inbed < bp->bio_children)
95 free(bp->bio_driver2, M_ELI);
96 bp->bio_driver2 = NULL;
97 if (bp->bio_error != 0) {
98 G_ELI_LOGREQ(0, bp, "Crypto READ request failed (error=%d).",
100 bp->bio_completed = 0;
103 * Read is finished, send it up.
105 sc = bp->bio_to->geom->softc;
106 g_io_deliver(bp, bp->bio_error);
107 atomic_subtract_int(&sc->sc_inflight, 1);
112 * The function is called after data encryption.
114 * g_eli_start -> g_eli_crypto_run -> G_ELI_CRYPTO_WRITE_DONE -> g_io_request -> g_eli_write_done -> g_io_deliver
117 g_eli_crypto_write_done(struct cryptop *crp)
119 struct g_eli_softc *sc;
121 struct g_consumer *cp;
122 struct bio *bp, *cbp;
124 if (crp->crp_etype == EAGAIN) {
125 if (g_eli_crypto_rerun(crp) == 0)
128 bp = (struct bio *)crp->crp_opaque;
130 if (crp->crp_etype == 0) {
131 G_ELI_DEBUG(3, "Crypto WRITE request done (%d/%d).",
132 bp->bio_inbed, bp->bio_children);
134 G_ELI_DEBUG(1, "Crypto WRITE request failed (%d/%d) error=%d.",
135 bp->bio_inbed, bp->bio_children, crp->crp_etype);
136 if (bp->bio_error == 0)
137 bp->bio_error = crp->crp_etype;
140 * All sectors are already encrypted?
142 if (bp->bio_inbed < bp->bio_children)
145 bp->bio_children = 1;
146 cbp = bp->bio_driver1;
147 bp->bio_driver1 = NULL;
148 gp = bp->bio_to->geom;
149 if (bp->bio_error != 0) {
150 G_ELI_LOGREQ(0, bp, "Crypto WRITE request failed (error=%d).",
152 free(bp->bio_driver2, M_ELI);
153 bp->bio_driver2 = NULL;
156 g_io_deliver(bp, bp->bio_error);
157 atomic_subtract_int(&sc->sc_inflight, 1);
160 cbp->bio_data = bp->bio_driver2;
161 cbp->bio_done = g_eli_write_done;
162 cp = LIST_FIRST(&gp->consumer);
163 cbp->bio_to = cp->provider;
164 G_ELI_LOGREQ(2, cbp, "Sending request.");
166 * Send encrypted data to the provider.
168 g_io_request(cbp, cp);
173 * The function is called to read encrypted data.
175 * g_eli_start -> G_ELI_CRYPTO_READ -> g_io_request -> g_eli_read_done -> g_eli_crypto_run -> g_eli_crypto_read_done -> g_io_deliver
178 g_eli_crypto_read(struct g_eli_softc *sc, struct bio *bp, boolean_t fromworker)
180 struct g_consumer *cp;
185 * We are not called from the worker thread, so check if
186 * device is suspended.
188 mtx_lock(&sc->sc_queue_mtx);
189 if (sc->sc_flags & G_ELI_FLAG_SUSPEND) {
191 * If device is suspended, we place the request onto
192 * the queue, so it can be handled after resume.
194 G_ELI_DEBUG(0, "device suspended, move onto queue");
195 bioq_insert_tail(&sc->sc_queue, bp);
196 mtx_unlock(&sc->sc_queue_mtx);
200 atomic_add_int(&sc->sc_inflight, 1);
201 mtx_unlock(&sc->sc_queue_mtx);
204 bp->bio_driver2 = NULL;
205 cbp = bp->bio_driver1;
206 cbp->bio_done = g_eli_read_done;
207 cp = LIST_FIRST(&sc->sc_geom->consumer);
208 cbp->bio_to = cp->provider;
209 G_ELI_LOGREQ(2, cbp, "Sending request.");
211 * Read encrypted data from provider.
213 g_io_request(cbp, cp);
217 * This is the main function responsible for cryptography (ie. communication
218 * with crypto(9) subsystem).
221 * g_eli_start -> g_eli_crypto_read -> g_io_request -> g_eli_read_done -> G_ELI_CRYPTO_RUN -> g_eli_crypto_read_done -> g_io_deliver
223 * g_eli_start -> G_ELI_CRYPTO_RUN -> g_eli_crypto_write_done -> g_io_request -> g_eli_write_done -> g_io_deliver
226 g_eli_crypto_run(struct g_eli_worker *wr, struct bio *bp)
228 struct g_eli_softc *sc;
230 struct cryptodesc *crd;
233 u_int i, nsec, secsize;
239 G_ELI_LOGREQ(3, bp, "%s", __func__);
241 bp->bio_pflags = wr->w_number;
243 secsize = LIST_FIRST(&sc->sc_geom->provider)->sectorsize;
244 nsec = bp->bio_length / secsize;
247 * Calculate how much memory do we need.
248 * We need separate crypto operation for every single sector.
249 * It is much faster to calculate total amount of needed memory here and
250 * do the allocation once instead of allocating memory in pieces (many,
253 size = sizeof(*crp) * nsec;
254 size += sizeof(*crd) * nsec;
255 size += sizeof(*uio) * nsec;
256 size += sizeof(*iov) * nsec;
258 * If we write the data we cannot destroy current bio_data content,
259 * so we need to allocate more memory for encrypted data.
261 if (bp->bio_cmd == BIO_WRITE)
262 size += bp->bio_length;
263 p = malloc(size, M_ELI, M_WAITOK);
266 bp->bio_children = nsec;
269 if (bp->bio_cmd == BIO_READ)
274 bcopy(bp->bio_data, data, bp->bio_length);
278 for (i = 0, dstoff = bp->bio_offset; i < nsec; i++, dstoff += secsize) {
279 crp = (struct cryptop *)p; p += sizeof(*crp);
280 crd = (struct cryptodesc *)p; p += sizeof(*crd);
281 uio = (struct uio *)p; p += sizeof(*uio);
282 iov = (struct iovec *)p; p += sizeof(*iov);
284 iov->iov_len = secsize;
285 iov->iov_base = data;
290 uio->uio_segflg = UIO_SYSSPACE;
291 uio->uio_resid = secsize;
293 crp->crp_sid = wr->w_sid;
294 crp->crp_ilen = secsize;
295 crp->crp_olen = secsize;
296 crp->crp_opaque = (void *)bp;
297 crp->crp_buf = (void *)uio;
298 if (bp->bio_cmd == BIO_WRITE)
299 crp->crp_callback = g_eli_crypto_write_done;
300 else /* if (bp->bio_cmd == BIO_READ) */
301 crp->crp_callback = g_eli_crypto_read_done;
302 crp->crp_flags = CRYPTO_F_IOV | CRYPTO_F_CBIFSYNC | CRYPTO_F_REL;
304 crp->crp_flags |= CRYPTO_F_BATCH;
308 crd->crd_len = secsize;
309 crd->crd_flags = CRD_F_IV_EXPLICIT | CRD_F_IV_PRESENT;
310 if (sc->sc_nekeys > 1)
311 crd->crd_flags |= CRD_F_KEY_EXPLICIT;
312 if (bp->bio_cmd == BIO_WRITE)
313 crd->crd_flags |= CRD_F_ENCRYPT;
314 crd->crd_alg = sc->sc_ealgo;
315 crd->crd_key = g_eli_crypto_key(sc, dstoff, secsize);
316 crd->crd_klen = sc->sc_ekeylen;
317 if (sc->sc_ealgo == CRYPTO_AES_XTS)
319 g_eli_crypto_ivgen(sc, dstoff, crd->crd_iv,
320 sizeof(crd->crd_iv));
321 crd->crd_next = NULL;
324 err = crypto_dispatch(crp);
328 if (bp->bio_error == 0)
329 bp->bio_error = error;