xref: /freebsd/sys/crypto/aesni/aesni.c (revision 1670a1c2a47d10ecccd001970b859caf93cd3b6e)
1 /*-
2  * Copyright (c) 2005-2008 Pawel Jakub Dawidek <pjd@FreeBSD.org>
3  * Copyright (c) 2010 Konstantin Belousov <kib@FreeBSD.org>
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30 
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/kobj.h>
35 #include <sys/libkern.h>
36 #include <sys/lock.h>
37 #include <sys/module.h>
38 #include <sys/malloc.h>
39 #include <sys/rwlock.h>
40 #include <sys/bus.h>
41 #include <sys/uio.h>
42 #include <crypto/aesni/aesni.h>
43 #include "cryptodev_if.h"
44 
45 struct aesni_softc {
46 	int32_t cid;
47 	uint32_t sid;
48 	TAILQ_HEAD(aesni_sessions_head, aesni_session) sessions;
49 	struct rwlock lock;
50 };
51 
52 static int aesni_newsession(device_t, uint32_t *sidp, struct cryptoini *cri);
53 static int aesni_freesession(device_t, uint64_t tid);
54 static void aesni_freesession_locked(struct aesni_softc *sc,
55     struct aesni_session *ses);
56 
57 MALLOC_DEFINE(M_AESNI, "aesni_data", "AESNI Data");
58 
59 static void
60 aesni_identify(driver_t *drv, device_t parent)
61 {
62 
63 	/* NB: order 10 is so we get attached after h/w devices */
64 	if (device_find_child(parent, "aesni", -1) == NULL &&
65 	    BUS_ADD_CHILD(parent, 10, "aesni", -1) == 0)
66 		panic("aesni: could not attach");
67 }
68 
69 static int
70 aesni_probe(device_t dev)
71 {
72 	char capp[32];
73 
74 	if ((cpu_feature2 & CPUID2_AESNI) == 0) {
75 		device_printf(dev, "No AESNI support.\n");
76 		return (EINVAL);
77 	}
78 	strlcpy(capp, "AES-CBC", sizeof(capp));
79 	device_set_desc_copy(dev, capp);
80 	return (0);
81 }
82 
83 static int
84 aesni_attach(device_t dev)
85 {
86 	struct aesni_softc *sc;
87 
88 	sc = device_get_softc(dev);
89 	TAILQ_INIT(&sc->sessions);
90 	sc->sid = 1;
91 	sc->cid = crypto_get_driverid(dev, CRYPTOCAP_F_HARDWARE);
92 	if (sc->cid < 0) {
93 		device_printf(dev, "Could not get crypto driver id.\n");
94 		return (ENOMEM);
95 	}
96 
97 	rw_init(&sc->lock, "aesni_lock");
98 	crypto_register(sc->cid, CRYPTO_AES_CBC, 0, 0);
99 	return (0);
100 }
101 
102 static int
103 aesni_detach(device_t dev)
104 {
105 	struct aesni_softc *sc;
106 	struct aesni_session *ses;
107 
108 	sc = device_get_softc(dev);
109 	rw_wlock(&sc->lock);
110 	TAILQ_FOREACH(ses, &sc->sessions, next) {
111 		if (ses->used) {
112 			rw_wunlock(&sc->lock);
113 			device_printf(dev,
114 			    "Cannot detach, sessions still active.\n");
115 			return (EBUSY);
116 		}
117 	}
118 	while ((ses = TAILQ_FIRST(&sc->sessions)) != NULL) {
119 		TAILQ_REMOVE(&sc->sessions, ses, next);
120 		free(ses, M_AESNI);
121 	}
122 	rw_wunlock(&sc->lock);
123 	rw_destroy(&sc->lock);
124 	crypto_unregister_all(sc->cid);
125 	return (0);
126 }
127 
128 static int
129 aesni_newsession(device_t dev, uint32_t *sidp, struct cryptoini *cri)
130 {
131 	struct aesni_softc *sc;
132 	struct aesni_session *ses;
133 	struct cryptoini *encini;
134 	int error;
135 
136 	if (sidp == NULL || cri == NULL)
137 		return (EINVAL);
138 
139 	sc = device_get_softc(dev);
140 	ses = NULL;
141 	encini = NULL;
142 	for (; cri != NULL; cri = cri->cri_next) {
143 		switch (cri->cri_alg) {
144 		case CRYPTO_AES_CBC:
145 			if (encini != NULL)
146 				return (EINVAL);
147 			encini = cri;
148 			break;
149 		default:
150 			return (EINVAL);
151 		}
152 	}
153 	if (encini == NULL)
154 		return (EINVAL);
155 
156 	rw_wlock(&sc->lock);
157 	/*
158 	 * Free sessions goes first, so if first session is used, we need to
159 	 * allocate one.
160 	 */
161 	ses = TAILQ_FIRST(&sc->sessions);
162 	if (ses == NULL || ses->used) {
163 		ses = malloc(sizeof(*ses), M_AESNI, M_NOWAIT | M_ZERO);
164 		if (ses == NULL) {
165 			rw_wunlock(&sc->lock);
166 			return (ENOMEM);
167 		}
168 		KASSERT(((uintptr_t)ses) % 0x10 == 0,
169 		    ("malloc returned unaligned pointer"));
170 		ses->id = sc->sid++;
171 	} else {
172 		TAILQ_REMOVE(&sc->sessions, ses, next);
173 	}
174 	ses->used = 1;
175 	TAILQ_INSERT_TAIL(&sc->sessions, ses, next);
176 	rw_wunlock(&sc->lock);
177 
178 	error = aesni_cipher_setup(ses, encini);
179 	if (error != 0) {
180 		rw_wlock(&sc->lock);
181 		aesni_freesession_locked(sc, ses);
182 		rw_wunlock(&sc->lock);
183 		return (error);
184 	}
185 
186 	*sidp = ses->id;
187 	return (0);
188 }
189 
190 static void
191 aesni_freesession_locked(struct aesni_softc *sc, struct aesni_session *ses)
192 {
193 	uint32_t sid;
194 
195 	sid = ses->id;
196 	TAILQ_REMOVE(&sc->sessions, ses, next);
197 	bzero(ses, sizeof(*ses));
198 	ses->id = sid;
199 	TAILQ_INSERT_HEAD(&sc->sessions, ses, next);
200 }
201 
202 static int
203 aesni_freesession(device_t dev, uint64_t tid)
204 {
205 	struct aesni_softc *sc;
206 	struct aesni_session *ses;
207 	uint32_t sid;
208 
209 	sc = device_get_softc(dev);
210 	sid = ((uint32_t)tid) & 0xffffffff;
211 	rw_wlock(&sc->lock);
212 	TAILQ_FOREACH_REVERSE(ses, &sc->sessions, aesni_sessions_head, next) {
213 		if (ses->id == sid)
214 			break;
215 	}
216 	if (ses == NULL) {
217 		rw_wunlock(&sc->lock);
218 		return (EINVAL);
219 	}
220 	aesni_freesession_locked(sc, ses);
221 	rw_wunlock(&sc->lock);
222 	return (0);
223 }
224 
225 static int
226 aesni_process(device_t dev, struct cryptop *crp, int hint __unused)
227 {
228 	struct aesni_softc *sc = device_get_softc(dev);
229 	struct aesni_session *ses = NULL;
230 	struct cryptodesc *crd, *enccrd;
231 	int error;
232 
233 	error = 0;
234 	enccrd = NULL;
235 
236 	/* Sanity check. */
237 	if (crp == NULL)
238 		return (EINVAL);
239 
240 	if (crp->crp_callback == NULL || crp->crp_desc == NULL) {
241 		error = EINVAL;
242 		goto out;
243 	}
244 
245 	for (crd = crp->crp_desc; crd != NULL; crd = crd->crd_next) {
246 		switch (crd->crd_alg) {
247 		case CRYPTO_AES_CBC:
248 			if (enccrd != NULL) {
249 				error = EINVAL;
250 				goto out;
251 			}
252 			enccrd = crd;
253 			break;
254 		default:
255 			return (EINVAL);
256 		}
257 	}
258 	if (enccrd == NULL || (enccrd->crd_len % AES_BLOCK_LEN) != 0) {
259 		error = EINVAL;
260 		goto out;
261 	}
262 
263 	rw_rlock(&sc->lock);
264 	TAILQ_FOREACH_REVERSE(ses, &sc->sessions, aesni_sessions_head, next) {
265 		if (ses->id == (crp->crp_sid & 0xffffffff))
266 			break;
267 	}
268 	rw_runlock(&sc->lock);
269 	if (ses == NULL) {
270 		error = EINVAL;
271 		goto out;
272 	}
273 
274 	error = aesni_cipher_process(ses, enccrd, crp);
275 	if (error != 0)
276 		goto out;
277 
278 out:
279 	crp->crp_etype = error;
280 	crypto_done(crp);
281 	return (error);
282 }
283 
284 uint8_t *
285 aesni_cipher_alloc(struct cryptodesc *enccrd, struct cryptop *crp,
286     int *allocated)
287 {
288 	struct uio *uio;
289 	struct iovec *iov;
290 	uint8_t *addr;
291 
292 	if (crp->crp_flags & CRYPTO_F_IMBUF)
293 		goto alloc;
294 	else if (crp->crp_flags & CRYPTO_F_IOV) {
295 		uio = (struct uio *)crp->crp_buf;
296 		if (uio->uio_iovcnt != 1)
297 			goto alloc;
298 		iov = uio->uio_iov;
299 		addr = (u_char *)iov->iov_base + enccrd->crd_skip;
300 	} else
301 		addr = (u_char *)crp->crp_buf;
302 	*allocated = 0;
303 	return (addr);
304 
305 alloc:
306 	addr = malloc(enccrd->crd_len, M_AESNI, M_NOWAIT);
307 	if (addr != NULL) {
308 		*allocated = 1;
309 		crypto_copydata(crp->crp_flags, crp->crp_buf, enccrd->crd_skip,
310 		    enccrd->crd_len, addr);
311 	} else
312 		*allocated = 0;
313 	return (addr);
314 }
315 
316 static device_method_t aesni_methods[] = {
317 	DEVMETHOD(device_identify, aesni_identify),
318 	DEVMETHOD(device_probe, aesni_probe),
319 	DEVMETHOD(device_attach, aesni_attach),
320 	DEVMETHOD(device_detach, aesni_detach),
321 
322 	DEVMETHOD(cryptodev_newsession, aesni_newsession),
323 	DEVMETHOD(cryptodev_freesession, aesni_freesession),
324 	DEVMETHOD(cryptodev_process, aesni_process),
325 
326 	{0, 0},
327 };
328 
329 static driver_t aesni_driver = {
330 	"aesni",
331 	aesni_methods,
332 	sizeof(struct aesni_softc),
333 };
334 static devclass_t aesni_devclass;
335 
336 DRIVER_MODULE(aesni, nexus, aesni_driver, aesni_devclass, 0, 0);
337 MODULE_VERSION(aesni, 1);
338 MODULE_DEPEND(aesni, crypto, 1, 1, 1);
339