xref: /freebsd/sys/crypto/blake2/blake2_cryptodev.c (revision d65cd7a57bf0600b722afc770838a5d0c1c3a8e1) 
1 /*-
2  * Copyright (c) 2018 Conrad Meyer <cem@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
13  *
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
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/bus.h>
32 #include <sys/kernel.h>
33 #include <sys/kobj.h>
34 #include <sys/lock.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/rwlock.h>
39 #include <sys/smp.h>
40 
41 #include <blake2.h>
42 
43 #include <opencrypto/cryptodev.h>
44 #include <cryptodev_if.h>
45 
46 #if defined(__amd64__)
47 #include <machine/fpu.h>
48 #elif defined(__i386__)
49 #include <machine/npx.h>
50 #endif
51 
52 struct blake2_session {
53 	size_t mlen;
54 };
55 CTASSERT((size_t)BLAKE2B_KEYBYTES > (size_t)BLAKE2S_KEYBYTES);
56 
57 struct blake2_softc {
58 	bool	dying;
59 	int32_t cid;
60 	struct rwlock lock;
61 };
62 
63 static struct mtx_padalign *ctx_mtx;
64 static struct fpu_kern_ctx **ctx_fpu;
65 
66 #define ACQUIRE_CTX(i, ctx)					\
67 	do {							\
68 		(i) = PCPU_GET(cpuid);				\
69 		mtx_lock(&ctx_mtx[(i)]);			\
70 		(ctx) = ctx_fpu[(i)];				\
71 	} while (0)
72 #define RELEASE_CTX(i, ctx)					\
73 	do {							\
74 		mtx_unlock(&ctx_mtx[(i)]);			\
75 		(i) = -1;					\
76 		(ctx) = NULL;					\
77 	} while (0)
78 
79 static int blake2_cipher_setup(struct blake2_session *ses,
80     const struct crypto_session_params *csp);
81 static int blake2_cipher_process(struct blake2_session *ses,
82     struct cryptop *crp);
83 
84 MALLOC_DEFINE(M_BLAKE2, "blake2_data", "Blake2 Data");
85 
86 static void
87 blake2_identify(driver_t *drv, device_t parent)
88 {
89 
90 	/* NB: order 10 is so we get attached after h/w devices */
91 	if (device_find_child(parent, "blaketwo", -1) == NULL &&
92 	    BUS_ADD_CHILD(parent, 10, "blaketwo", -1) == 0)
93 		panic("blaketwo: could not attach");
94 }
95 
96 static int
97 blake2_probe(device_t dev)
98 {
99 	device_set_desc(dev, "Blake2");
100 	return (0);
101 }
102 
103 static void
104 blake2_cleanctx(void)
105 {
106 	int i;
107 
108 	/* XXX - no way to return driverid */
109 	CPU_FOREACH(i) {
110 		if (ctx_fpu[i] != NULL) {
111 			mtx_destroy(&ctx_mtx[i]);
112 			fpu_kern_free_ctx(ctx_fpu[i]);
113 		}
114 		ctx_fpu[i] = NULL;
115 	}
116 	free(ctx_mtx, M_BLAKE2);
117 	ctx_mtx = NULL;
118 	free(ctx_fpu, M_BLAKE2);
119 	ctx_fpu = NULL;
120 }
121 
122 static int
123 blake2_attach(device_t dev)
124 {
125 	struct blake2_softc *sc;
126 	int i;
127 
128 	sc = device_get_softc(dev);
129 	sc->dying = false;
130 
131 	sc->cid = crypto_get_driverid(dev, sizeof(struct blake2_session),
132 	    CRYPTOCAP_F_SOFTWARE | CRYPTOCAP_F_SYNC);
133 	if (sc->cid < 0) {
134 		device_printf(dev, "Could not get crypto driver id.\n");
135 		return (ENOMEM);
136 	}
137 
138 	ctx_mtx = malloc(sizeof(*ctx_mtx) * (mp_maxid + 1), M_BLAKE2,
139 	    M_WAITOK | M_ZERO);
140 	ctx_fpu = malloc(sizeof(*ctx_fpu) * (mp_maxid + 1), M_BLAKE2,
141 	    M_WAITOK | M_ZERO);
142 
143 	CPU_FOREACH(i) {
144 		ctx_fpu[i] = fpu_kern_alloc_ctx(0);
145 		mtx_init(&ctx_mtx[i], "bl2fpumtx", NULL, MTX_DEF | MTX_NEW);
146 	}
147 
148 	rw_init(&sc->lock, "blake2_lock");
149 
150 	return (0);
151 }
152 
153 static int
154 blake2_detach(device_t dev)
155 {
156 	struct blake2_softc *sc;
157 
158 	sc = device_get_softc(dev);
159 
160 	rw_wlock(&sc->lock);
161 	sc->dying = true;
162 	rw_wunlock(&sc->lock);
163 	crypto_unregister_all(sc->cid);
164 
165 	rw_destroy(&sc->lock);
166 
167 	blake2_cleanctx();
168 
169 	return (0);
170 }
171 
172 static int
173 blake2_probesession(device_t dev, const struct crypto_session_params *csp)
174 {
175 
176 	if (csp->csp_flags != 0)
177 		return (EINVAL);
178 	switch (csp->csp_mode) {
179 	case CSP_MODE_DIGEST:
180 		switch (csp->csp_auth_alg) {
181 		case CRYPTO_BLAKE2B:
182 		case CRYPTO_BLAKE2S:
183 			break;
184 		default:
185 			return (EINVAL);
186 		}
187 		break;
188 	default:
189 		return (EINVAL);
190 	}
191 	return (CRYPTODEV_PROBE_ACCEL_SOFTWARE);
192 }
193 
194 static int
195 blake2_newsession(device_t dev, crypto_session_t cses,
196     const struct crypto_session_params *csp)
197 {
198 	struct blake2_softc *sc;
199 	struct blake2_session *ses;
200 	int error;
201 
202 	sc = device_get_softc(dev);
203 
204 	ses = crypto_get_driver_session(cses);
205 
206 	rw_rlock(&sc->lock);
207 	if (sc->dying) {
208 		rw_runlock(&sc->lock);
209 		return (EINVAL);
210 	}
211 	rw_runlock(&sc->lock);
212 
213 	error = blake2_cipher_setup(ses, csp);
214 	if (error != 0) {
215 		CRYPTDEB("setup failed");
216 		return (error);
217 	}
218 
219 	return (0);
220 }
221 
222 static int
223 blake2_process(device_t dev, struct cryptop *crp, int hint __unused)
224 {
225 	struct blake2_session *ses;
226 	int error;
227 
228 	ses = crypto_get_driver_session(crp->crp_session);
229 	error = blake2_cipher_process(ses, crp);
230 
231 	crp->crp_etype = error;
232 	crypto_done(crp);
233 	return (0);
234 }
235 
236 static device_method_t blake2_methods[] = {
237 	DEVMETHOD(device_identify, blake2_identify),
238 	DEVMETHOD(device_probe, blake2_probe),
239 	DEVMETHOD(device_attach, blake2_attach),
240 	DEVMETHOD(device_detach, blake2_detach),
241 
242 	DEVMETHOD(cryptodev_probesession, blake2_probesession),
243 	DEVMETHOD(cryptodev_newsession, blake2_newsession),
244 	DEVMETHOD(cryptodev_process, blake2_process),
245 
246 	DEVMETHOD_END
247 };
248 
249 static driver_t blake2_driver = {
250 	"blaketwo",
251 	blake2_methods,
252 	sizeof(struct blake2_softc),
253 };
254 static devclass_t blake2_devclass;
255 
256 DRIVER_MODULE(blake2, nexus, blake2_driver, blake2_devclass, 0, 0);
257 MODULE_VERSION(blake2, 1);
258 MODULE_DEPEND(blake2, crypto, 1, 1, 1);
259 
260 static bool
261 blake2_check_klen(const struct crypto_session_params *csp, unsigned klen)
262 {
263 
264 	if (csp->csp_auth_alg == CRYPTO_BLAKE2S)
265 		return (klen <= BLAKE2S_KEYBYTES);
266 	else
267 		return (klen <= BLAKE2B_KEYBYTES);
268 }
269 
270 static int
271 blake2_cipher_setup(struct blake2_session *ses,
272     const struct crypto_session_params *csp)
273 {
274 	int hashlen;
275 
276 	CTASSERT((size_t)BLAKE2S_OUTBYTES <= (size_t)BLAKE2B_OUTBYTES);
277 
278 	if (!blake2_check_klen(csp, csp->csp_auth_klen))
279 		return (EINVAL);
280 
281 	if (csp->csp_auth_mlen < 0)
282 		return (EINVAL);
283 
284 	switch (csp->csp_auth_alg) {
285 	case CRYPTO_BLAKE2S:
286 		hashlen = BLAKE2S_OUTBYTES;
287 		break;
288 	case CRYPTO_BLAKE2B:
289 		hashlen = BLAKE2B_OUTBYTES;
290 		break;
291 	default:
292 		return (EINVAL);
293 	}
294 
295 	if (csp->csp_auth_mlen > hashlen)
296 		return (EINVAL);
297 
298 	if (csp->csp_auth_mlen == 0)
299 		ses->mlen = hashlen;
300 	else
301 		ses->mlen = csp->csp_auth_mlen;
302 	return (0);
303 }
304 
305 static int
306 blake2b_applicator(void *state, void *buf, u_int len)
307 {
308 	int rc;
309 
310 	rc = blake2b_update(state, buf, len);
311 	if (rc != 0)
312 		return (EINVAL);
313 	return (0);
314 }
315 
316 static int
317 blake2s_applicator(void *state, void *buf, u_int len)
318 {
319 	int rc;
320 
321 	rc = blake2s_update(state, buf, len);
322 	if (rc != 0)
323 		return (EINVAL);
324 	return (0);
325 }
326 
327 static int
328 blake2_cipher_process(struct blake2_session *ses, struct cryptop *crp)
329 {
330 	union {
331 		blake2b_state sb;
332 		blake2s_state ss;
333 	} bctx;
334 	char res[BLAKE2B_OUTBYTES], res2[BLAKE2B_OUTBYTES];
335 	const struct crypto_session_params *csp;
336 	struct fpu_kern_ctx *ctx;
337 	const void *key;
338 	int ctxidx;
339 	bool kt;
340 	int error, rc;
341 	unsigned klen;
342 
343 	ctx = NULL;
344 	ctxidx = 0;
345 	error = EINVAL;
346 
347 	kt = is_fpu_kern_thread(0);
348 	if (!kt) {
349 		ACQUIRE_CTX(ctxidx, ctx);
350 		fpu_kern_enter(curthread, ctx,
351 		    FPU_KERN_NORMAL | FPU_KERN_KTHR);
352 	}
353 
354 	csp = crypto_get_params(crp->crp_session);
355 	if (crp->crp_auth_key != NULL)
356 		key = crp->crp_auth_key;
357 	else
358 		key = csp->csp_auth_key;
359 	klen = csp->csp_auth_klen;
360 	switch (csp->csp_auth_alg) {
361 	case CRYPTO_BLAKE2B:
362 		if (klen > 0)
363 			rc = blake2b_init_key(&bctx.sb, ses->mlen, key, klen);
364 		else
365 			rc = blake2b_init(&bctx.sb, ses->mlen);
366 		if (rc != 0)
367 			goto out;
368 		error = crypto_apply(crp, crp->crp_payload_start,
369 		    crp->crp_payload_length, blake2b_applicator, &bctx.sb);
370 		if (error != 0)
371 			goto out;
372 		rc = blake2b_final(&bctx.sb, res, ses->mlen);
373 		if (rc != 0) {
374 			error = EINVAL;
375 			goto out;
376 		}
377 		break;
378 	case CRYPTO_BLAKE2S:
379 		if (klen > 0)
380 			rc = blake2s_init_key(&bctx.ss, ses->mlen, key, klen);
381 		else
382 			rc = blake2s_init(&bctx.ss, ses->mlen);
383 		if (rc != 0)
384 			goto out;
385 		error = crypto_apply(crp, crp->crp_payload_start,
386 		    crp->crp_payload_length, blake2s_applicator, &bctx.ss);
387 		if (error != 0)
388 			goto out;
389 		rc = blake2s_final(&bctx.ss, res, ses->mlen);
390 		if (rc != 0) {
391 			error = EINVAL;
392 			goto out;
393 		}
394 		break;
395 	default:
396 		panic("unreachable");
397 	}
398 
399 	if (crp->crp_op & CRYPTO_OP_VERIFY_DIGEST) {
400 		crypto_copydata(crp, crp->crp_digest_start, ses->mlen, res2);
401 		if (timingsafe_bcmp(res, res2, ses->mlen) != 0)
402 			return (EBADMSG);
403 	} else
404 		crypto_copyback(crp, crp->crp_digest_start, ses->mlen, res);
405 
406 out:
407 	if (!kt) {
408 		fpu_kern_leave(curthread, ctx);
409 		RELEASE_CTX(ctxidx, ctx);
410 	}
411 	return (error);
412 }
413