diff options
author | sam <sam@FreeBSD.org> | 2007-03-21 03:42:51 +0000 |
---|---|---|
committer | sam <sam@FreeBSD.org> | 2007-03-21 03:42:51 +0000 |
commit | f96ba7ffdacde02e9c3e989c8f6e3e7539b74b46 (patch) | |
tree | 05fc03ec94859546cbef49b9fe30d492c4f7bf19 /sys/opencrypto | |
parent | 3f9dd9edcb00155dff6a9b7686ce432606296d79 (diff) | |
download | FreeBSD-src-f96ba7ffdacde02e9c3e989c8f6e3e7539b74b46.zip FreeBSD-src-f96ba7ffdacde02e9c3e989c8f6e3e7539b74b46.tar.gz |
Overhaul driver/subsystem api's:
o make all crypto drivers have a device_t; pseudo drivers like the s/w
crypto driver synthesize one
o change the api between the crypto subsystem and drivers to use kobj;
cryptodev_if.m defines this api
o use the fact that all crypto drivers now have a device_t to add support
for specifying which of several potential devices to use when doing
crypto operations
o add new ioctls that allow user apps to select a specific crypto device
to use (previous ioctls maintained for compatibility)
o overhaul crypto subsystem code to eliminate lots of cruft and hide
implementation details from drivers
o bring in numerous fixes from Michale Richardson/hifn; mostly for
795x parts
o add an optional mechanism for mmap'ing the hifn 795x public key h/w
to user space for use by openssl (not enabled by default)
o update crypto test tools to use new ioctl's and add cmd line options
to specify a device to use for tests
These changes will also enable much future work on improving the core
crypto subsystem; including proper load balancing and interposing code
between the core and drivers to dispatch small operations to the s/w
driver as appropriate.
These changes were instigated by the work of Michael Richardson.
Reviewed by: pjd
Approved by: re
Diffstat (limited to 'sys/opencrypto')
-rw-r--r-- | sys/opencrypto/crypto.c | 752 | ||||
-rw-r--r-- | sys/opencrypto/crypto_if.m | 128 | ||||
-rw-r--r-- | sys/opencrypto/cryptodev.c | 130 | ||||
-rw-r--r-- | sys/opencrypto/cryptodev.h | 105 | ||||
-rw-r--r-- | sys/opencrypto/cryptosoft.c | 134 | ||||
-rw-r--r-- | sys/opencrypto/cryptosoft.h | 4 |
6 files changed, 762 insertions, 491 deletions
diff --git a/sys/opencrypto/crypto.c b/sys/opencrypto/crypto.c index e75af74..738328c 100644 --- a/sys/opencrypto/crypto.c +++ b/sys/opencrypto/crypto.c @@ -1,4 +1,38 @@ -/* $OpenBSD: crypto.c,v 1.38 2002/06/11 11:14:29 beck Exp $ */ +/*- + * Copyright (c) 2002-2006 Sam Leffler. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include <sys/cdefs.h> +__FBSDID("$FreeBSD$"); + +/* + * Cryptographic Subsystem. + * + * This code is derived from the Openbsd Cryptographic Framework (OCF) + * that has the copyright shown below. Very little of the original + * code remains. + */ + /*- * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) * @@ -20,11 +54,10 @@ * PURPOSE. */ -#include <sys/cdefs.h> -__FBSDID("$FreeBSD$"); - #define CRYPTO_TIMING /* enable timing support */ +#include "opt_ddb.h" + #include <sys/param.h> #include <sys/systm.h> #include <sys/eventhandler.h> @@ -37,10 +70,16 @@ __FBSDID("$FreeBSD$"); #include <sys/proc.h> #include <sys/sysctl.h> +#include <ddb/ddb.h> + #include <vm/uma.h> #include <opencrypto/cryptodev.h> #include <opencrypto/xform.h> /* XXX for M_XDATA */ +#include <sys/kobj.h> +#include <sys/bus.h> +#include "cryptodev_if.h" + /* * Crypto drivers register themselves by allocating a slot in the * crypto_drivers table with crypto_get_driverid() and then registering @@ -49,6 +88,33 @@ __FBSDID("$FreeBSD$"); static struct mtx crypto_drivers_mtx; /* lock on driver table */ #define CRYPTO_DRIVER_LOCK() mtx_lock(&crypto_drivers_mtx) #define CRYPTO_DRIVER_UNLOCK() mtx_unlock(&crypto_drivers_mtx) +#define CRYPTO_DRIVER_ASSERT() mtx_assert(&crypto_drivers_mtx, MA_OWNED) + +/* + * Crypto device/driver capabilities structure. + * + * Synchronization: + * (d) - protected by CRYPTO_DRIVER_LOCK() + * (q) - protected by CRYPTO_Q_LOCK() + * Not tagged fields are read-only. + */ +struct cryptocap { + device_t cc_dev; /* (d) device/driver */ + u_int32_t cc_sessions; /* (d) # of sessions */ + u_int32_t cc_koperations; /* (d) # os asym operations */ + /* + * Largest possible operator length (in bits) for each type of + * encryption algorithm. XXX not used + */ + u_int16_t cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1]; + u_int8_t cc_alg[CRYPTO_ALGORITHM_MAX + 1]; + u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1]; + + int cc_flags; /* (d) flags */ +#define CRYPTOCAP_F_CLEANUP 0x80000000 /* needs resource cleanup */ + int cc_qblocked; /* (q) symmetric q blocked */ + int cc_kqblocked; /* (q) asymmetric q blocked */ +}; static struct cryptocap *crypto_drivers = NULL; static int crypto_drivers_num = 0; @@ -101,7 +167,7 @@ static void crypto_ret_proc(void); static struct proc *cryptoretproc; static void crypto_destroy(void); static int crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint); -static int crypto_kinvoke(struct cryptkop *krp); +static int crypto_kinvoke(struct cryptkop *krp, int flags); static struct cryptostats cryptostats; SYSCTL_STRUCT(_kern, OID_AUTO, crypto_stats, CTLFLAG_RW, &cryptostats, @@ -224,144 +290,133 @@ crypto_destroy(void) mtx_destroy(&crypto_drivers_mtx); } +static struct cryptocap * +crypto_checkdriver(u_int32_t hid) +{ + if (crypto_drivers == NULL) + return NULL; + return (hid >= crypto_drivers_num ? NULL : &crypto_drivers[hid]); +} + /* - * Initialization code, both for static and dynamic loading. + * Compare a driver's list of supported algorithms against another + * list; return non-zero if all algorithms are supported. */ static int -crypto_modevent(module_t mod, int type, void *unused) +driver_suitable(const struct cryptocap *cap, const struct cryptoini *cri) { - int error = EINVAL; + const struct cryptoini *cr; - switch (type) { - case MOD_LOAD: - error = crypto_init(); - if (error == 0 && bootverbose) - printf("crypto: <crypto core>\n"); - break; - case MOD_UNLOAD: - /*XXX disallow if active sessions */ - error = 0; - crypto_destroy(); - return 0; - } - return error; + /* See if all the algorithms are supported. */ + for (cr = cri; cr; cr = cr->cri_next) + if (cap->cc_alg[cr->cri_alg] == 0) + return 0; + return 1; } -static moduledata_t crypto_mod = { - "crypto", - crypto_modevent, - 0 -}; -MODULE_VERSION(crypto, 1); -DECLARE_MODULE(crypto, crypto_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST); -MODULE_DEPEND(crypto, zlib, 1, 1, 1); - /* - * Create a new session. + * Select a driver for a new session that supports the specified + * algorithms and, optionally, is constrained according to the flags. + * The algorithm we use here is pretty stupid; just use the + * first driver that supports all the algorithms we need. If there + * are multiple drivers we choose the driver with the fewest active + * sessions. We prefer hardware-backed drivers to software ones. + * + * XXX We need more smarts here (in real life too, but that's + * XXX another story altogether). */ -int -crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard) +static struct cryptocap * +crypto_select_driver(const struct cryptoini *cri, int flags) { - struct cryptocap *cap = NULL; - struct cryptoini *cr; - u_int32_t hid = 0, lid; - int err = EINVAL; + struct cryptocap *cap, *best; + int match, hid; - CRYPTO_DRIVER_LOCK(); - - if (crypto_drivers == NULL) - goto done; - - /* - * The algorithm we use here is pretty stupid; just use the - * first driver that supports all the algorithms we need. - * - * XXX We need more smarts here (in real life too, but that's - * XXX another story altogether). - */ + CRYPTO_DRIVER_ASSERT(); /* - * First try to find hardware crypto. + * Look first for hardware crypto devices if permitted. */ - if (hard >= 0) { - for (hid = 0; hid < crypto_drivers_num; hid++) { - cap = &crypto_drivers[hid]; - /* - * If it's not initialized or has remaining sessions - * referencing it, skip. - */ - if (cap->cc_newsession == NULL || - (cap->cc_flags & CRYPTOCAP_F_CLEANUP)) - continue; - - /* Hardware required -- ignore software drivers. */ - if (cap->cc_flags & CRYPTOCAP_F_SOFTWARE) - continue; + if (flags & CRYPTOCAP_F_HARDWARE) + match = CRYPTOCAP_F_HARDWARE; + else + match = CRYPTOCAP_F_SOFTWARE; + best = NULL; +again: + for (hid = 0; hid < crypto_drivers_num; hid++) { + cap = &crypto_drivers[hid]; + /* + * If it's not initialized, is in the process of + * going away, or is not appropriate (hardware + * or software based on match), then skip. + */ + if (cap->cc_dev == NULL || + (cap->cc_flags & CRYPTOCAP_F_CLEANUP) || + (cap->cc_flags & match) == 0) + continue; - /* See if all the algorithms are supported. */ - for (cr = cri; cr; cr = cr->cri_next) - if (cap->cc_alg[cr->cri_alg] == 0) - break; - if (cr == NULL) { - /* Ok, all algorithms are supported. */ - break; - } + /* verify all the algorithms are supported. */ + if (driver_suitable(cap, cri)) { + if (best == NULL || + cap->cc_sessions < best->cc_sessions) + best = cap; } - if (hid == crypto_drivers_num) - cap = NULL; } - /* - * If no hardware crypto, look for software crypto. - */ - if (cap == NULL && hard <= 0) { - for (hid = 0; hid < crypto_drivers_num; hid++) { - cap = &crypto_drivers[hid]; - /* - * If it's not initialized or has remaining sessions - * referencing it, skip. - */ - if (cap->cc_newsession == NULL || - (cap->cc_flags & CRYPTOCAP_F_CLEANUP)) - continue; + if (best != NULL) + return best; + if (match == CRYPTOCAP_F_HARDWARE && (flags & CRYPTOCAP_F_SOFTWARE)) { + /* sort of an Algol 68-style for loop */ + match = CRYPTOCAP_F_SOFTWARE; + goto again; + } + return best; +} - /* Software required -- ignore hardware drivers. */ - if (!(cap->cc_flags & CRYPTOCAP_F_SOFTWARE)) - continue; +/* + * Create a new session. The crid argument specifies a crypto + * driver to use or constraints on a driver to select (hardware + * only, software only, either). Whatever driver is selected + * must be capable of the requested crypto algorithms. + */ +int +crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int crid) +{ + struct cryptocap *cap; + u_int32_t hid, lid; + int err; - /* See if all the algorithms are supported. */ - for (cr = cri; cr; cr = cr->cri_next) - if (cap->cc_alg[cr->cri_alg] == 0) - break; - if (cr == NULL) { - /* Ok, all algorithms are supported. */ - break; - } - } - if (hid == crypto_drivers_num) + CRYPTO_DRIVER_LOCK(); + if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) { + /* + * Use specified driver; verify it is capable. + */ + cap = crypto_checkdriver(crid); + if (cap != NULL && !driver_suitable(cap, cri)) cap = NULL; - } - - if (cap != NULL) { + } else { /* - * Can't do everything in one session. - * - * XXX Fix this. We need to inject a "virtual" session layer right - * XXX about here. + * No requested driver; select based on crid flags. */ - + cap = crypto_select_driver(cri, crid); + /* + * if NULL then can't do everything in one session. + * XXX Fix this. We need to inject a "virtual" session + * XXX layer right about here. + */ + } + if (cap != NULL) { /* Call the driver initialization routine. */ + hid = cap - crypto_drivers; lid = hid; /* Pass the driver ID. */ - err = (*cap->cc_newsession)(cap->cc_arg, &lid, cri); + err = CRYPTODEV_NEWSESSION(cap->cc_dev, &lid, cri); if (err == 0) { - /* XXX assert (hid &~ 0xffffff) == 0 */ - /* XXX assert (cap->cc_flags &~ 0xff) == 0 */ - (*sid) = ((cap->cc_flags & 0xff) << 24) | hid; + (*sid) = (cap->cc_flags & 0xff000000) + | (hid & 0x00ffffff); (*sid) <<= 32; (*sid) |= (lid & 0xffffffff); cap->cc_sessions++; } - } -done: + } else + err = EINVAL; CRYPTO_DRIVER_UNLOCK(); return err; } @@ -406,10 +461,7 @@ crypto_freesession(u_int64_t sid) cap->cc_sessions--; /* Call the driver cleanup routine, if available. */ - if (cap->cc_freesession) - err = cap->cc_freesession(cap->cc_arg, sid); - else - err = 0; + err = CRYPTODEV_FREESESSION(cap->cc_dev, sid); if (cap->cc_flags & CRYPTOCAP_F_CLEANUP) crypto_remove(cap); @@ -424,15 +476,21 @@ done: * support for the algorithms they handle. */ int32_t -crypto_get_driverid(u_int32_t flags) +crypto_get_driverid(device_t dev, int flags) { struct cryptocap *newdrv; int i; + if ((flags & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) { + printf("%s: no flags specified when registering driver\n", + device_get_nameunit(dev)); + return -1; + } + CRYPTO_DRIVER_LOCK(); for (i = 0; i < crypto_drivers_num; i++) { - if (crypto_drivers[i].cc_process == NULL && + if (crypto_drivers[i].cc_dev == NULL && (crypto_drivers[i].cc_flags & CRYPTOCAP_F_CLEANUP) == 0) { break; } @@ -466,21 +524,61 @@ crypto_get_driverid(u_int32_t flags) /* NB: state is zero'd on free */ crypto_drivers[i].cc_sessions = 1; /* Mark */ + crypto_drivers[i].cc_dev = dev; crypto_drivers[i].cc_flags = flags; if (bootverbose) - printf("crypto: assign driver %u, flags %u\n", i, flags); + printf("crypto: assign %s driver id %u, flags %u\n", + device_get_nameunit(dev), i, flags); CRYPTO_DRIVER_UNLOCK(); return i; } -static struct cryptocap * -crypto_checkdriver(u_int32_t hid) +/* + * Lookup a driver by name. We match against the full device + * name and unit, and against just the name. The latter gives + * us a simple widlcarding by device name. On success return the + * driver/hardware identifier; otherwise return -1. + */ +int +crypto_find_driver(const char *match) { - if (crypto_drivers == NULL) - return NULL; - return (hid >= crypto_drivers_num ? NULL : &crypto_drivers[hid]); + int i, len = strlen(match); + + CRYPTO_DRIVER_LOCK(); + for (i = 0; i < crypto_drivers_num; i++) { + device_t dev = crypto_drivers[i].cc_dev; + if (dev == NULL || + (crypto_drivers[i].cc_flags & CRYPTOCAP_F_CLEANUP)) + continue; + if (strncmp(match, device_get_nameunit(dev), len) == 0 || + strncmp(match, device_get_name(dev), len) == 0) + break; + } + CRYPTO_DRIVER_UNLOCK(); + return i < crypto_drivers_num ? i : -1; +} + +/* + * Return the device_t for the specified driver or NULL + * if the driver identifier is invalid. + */ +device_t +crypto_find_device_byhid(int hid) +{ + struct cryptocap *cap = crypto_checkdriver(hid); + return cap != NULL ? cap->cc_dev : NULL; +} + +/* + * Return the device/driver capabilities. + */ +int +crypto_getcaps(int hid) +{ + struct cryptocap *cap = crypto_checkdriver(hid); + return cap != NULL ? cap->cc_flags : 0; } /* @@ -488,9 +586,7 @@ crypto_checkdriver(u_int32_t hid) * is called once for each algorithm supported a driver. */ int -crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags, - int (*kprocess)(void*, struct cryptkop *, int), - void *karg) +crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags) { struct cryptocap *cap; int err; @@ -508,16 +604,11 @@ crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags, cap->cc_kalg[kalg] = flags | CRYPTO_ALG_FLAG_SUPPORTED; if (bootverbose) - printf("crypto: driver %u registers key alg %u flags %u\n" - , driverid + printf("crypto: %s registers key alg %u flags %u\n" + , device_get_nameunit(cap->cc_dev) , kalg , flags ); - - if (cap->cc_kprocess == NULL) { - cap->cc_karg = karg; - cap->cc_kprocess = kprocess; - } err = 0; } else err = EINVAL; @@ -532,11 +623,7 @@ crypto_kregister(u_int32_t driverid, int kalg, u_int32_t flags, */ int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, - u_int32_t flags, - int (*newses)(void*, u_int32_t*, struct cryptoini*), - int (*freeses)(void*, u_int64_t), - int (*process)(void*, struct cryptop *, int), - void *arg) + u_int32_t flags) { struct cryptocap *cap; int err; @@ -556,20 +643,13 @@ crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, cap->cc_alg[alg] = flags | CRYPTO_ALG_FLAG_SUPPORTED; cap->cc_max_op_len[alg] = maxoplen; if (bootverbose) - printf("crypto: driver %u registers alg %u flags %u maxoplen %u\n" - , driverid + printf("crypto: %s registers alg %u flags %u maxoplen %u\n" + , device_get_nameunit(cap->cc_dev) , alg , flags , maxoplen ); - - if (cap->cc_process == NULL) { - cap->cc_arg = arg; - cap->cc_newsession = newses; - cap->cc_process = process; - cap->cc_freesession = freeses; - cap->cc_sessions = 0; /* Unmark */ - } + cap->cc_sessions = 0; /* Unmark */ err = 0; } else err = EINVAL; @@ -578,6 +658,27 @@ crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, return err; } +static void +driver_finis(struct cryptocap *cap) +{ + u_int32_t ses, kops; + + CRYPTO_DRIVER_ASSERT(); + + ses = cap->cc_sessions; + kops = cap->cc_koperations; + bzero(cap, sizeof(*cap)); + if (ses != 0 || kops != 0) { + /* + * If there are pending sessions, + * just mark as invalid. + */ + cap->cc_flags |= CRYPTOCAP_F_CLEANUP; + cap->cc_sessions = ses; + cap->cc_koperations = kops; + } +} + /* * Unregister a crypto driver. If there are pending sessions using it, * leave enough information around so that subsequent calls using those @@ -588,11 +689,9 @@ int crypto_unregister(u_int32_t driverid, int alg) { struct cryptocap *cap; - u_int32_t ses, kops; int i, err; CRYPTO_DRIVER_LOCK(); - cap = crypto_checkdriver(driverid); if (cap != NULL && (CRYPTO_ALGORITHM_MIN <= alg && alg <= CRYPTO_ALGORITHM_MAX) && @@ -605,24 +704,13 @@ crypto_unregister(u_int32_t driverid, int alg) if (cap->cc_alg[i] != 0) break; - if (i == CRYPTO_ALGORITHM_MAX + 1) { - ses = cap->cc_sessions; - kops = cap->cc_koperations; - bzero(cap, sizeof(*cap)); - if (ses != 0 || kops != 0) { - /* - * If there are pending sessions, just mark as invalid. - */ - cap->cc_flags |= CRYPTOCAP_F_CLEANUP; - cap->cc_sessions = ses; - cap->cc_koperations = kops; - } - } + if (i == CRYPTO_ALGORITHM_MAX + 1) + driver_finis(cap); err = 0; } else err = EINVAL; - CRYPTO_DRIVER_UNLOCK(); + return err; } @@ -637,33 +725,17 @@ int crypto_unregister_all(u_int32_t driverid) { struct cryptocap *cap; - u_int32_t ses, kops; - int i, err; + int err; CRYPTO_DRIVER_LOCK(); - cap = crypto_checkdriver(driverid); if (cap != NULL) { - for (i = CRYPTO_ALGORITHM_MIN; i <= CRYPTO_ALGORITHM_MAX; i++) { - cap->cc_alg[i] = 0; - cap->cc_max_op_len[i] = 0; - } - ses = cap->cc_sessions; - kops = cap->cc_koperations; - bzero(cap, sizeof(*cap)); - if (ses != 0 || kops != 0) { - /* - * If there are pending sessions, just mark as invalid. - */ - cap->cc_flags |= CRYPTOCAP_F_CLEANUP; - cap->cc_sessions = ses; - cap->cc_koperations = kops; - } + driver_finis(cap); err = 0; } else err = EINVAL; - CRYPTO_DRIVER_UNLOCK(); + return err; } @@ -747,61 +819,128 @@ crypto_dispatch(struct cryptop *crp) int crypto_kdispatch(struct cryptkop *krp) { - int result; + int error; cryptostats.cs_kops++; - result = crypto_kinvoke(krp); - if (result != ERESTART) - return (result); - CRYPTO_Q_LOCK(); - TAILQ_INSERT_TAIL(&crp_kq, krp, krp_next); - if (crp_sleep) - wakeup_one(&crp_q); - CRYPTO_Q_UNLOCK(); + error = crypto_kinvoke(krp, krp->krp_crid); + if (error == ERESTART) { + CRYPTO_Q_LOCK(); + TAILQ_INSERT_TAIL(&crp_kq, krp, krp_next); + if (crp_sleep) + wakeup_one(&crp_q); + CRYPTO_Q_UNLOCK(); + error = 0; + } + return error; +} - return 0; +/* + * Verify a driver is suitable for the specified operation. + */ +static __inline int +kdriver_suitable(const struct cryptocap *cap, const struct cryptkop *krp) +{ + return (cap->cc_kalg[krp->krp_op] & CRYPTO_ALG_FLAG_SUPPORTED) != 0; +} + +/* + * Select a driver for an asym operation. The driver must + * support the necessary algorithm. The caller can constrain + * which device is selected with the flags parameter. The + * algorithm we use here is pretty stupid; just use the first + * driver that supports the algorithms we need. If there are + * multiple suitable drivers we choose the driver with the + * fewest active operations. We prefer hardware-backed + * drivers to software ones when either may be used. + */ +static struct cryptocap * +crypto_select_kdriver(const struct cryptkop *krp, int flags) +{ + struct cryptocap *cap, *best, *blocked; + int match, hid; + + CRYPTO_DRIVER_ASSERT(); + + /* + * Look first for hardware crypto devices if permitted. + */ + if (flags & CRYPTOCAP_F_HARDWARE) + match = CRYPTOCAP_F_HARDWARE; + else + match = CRYPTOCAP_F_SOFTWARE; + best = NULL; + blocked = NULL; +again: + for (hid = 0; hid < crypto_drivers_num; hid++) { + cap = &crypto_drivers[hid]; + /* + * If it's not initialized, is in the process of + * going away, or is not appropriate (hardware + * or software based on match), then skip. + */ + if (cap->cc_dev == NULL || + (cap->cc_flags & CRYPTOCAP_F_CLEANUP) || + (cap->cc_flags & match) == 0) + continue; + + /* verify all the algorithms are supported. */ + if (kdriver_suitable(cap, krp)) { + if (best == NULL || + cap->cc_koperations < best->cc_koperations) + best = cap; + } + } + if (best != NULL) + return best; + if (match == CRYPTOCAP_F_HARDWARE && (flags & CRYPTOCAP_F_SOFTWARE)) { + /* sort of an Algol 68-style for loop */ + match = CRYPTOCAP_F_SOFTWARE; + goto again; + } + return best; } /* - * Dispatch an assymetric crypto request to the appropriate crypto devices. + * Dispatch an assymetric crypto request. */ static int -crypto_kinvoke(struct cryptkop *krp) +crypto_kinvoke(struct cryptkop *krp, int crid) { struct cryptocap *cap = NULL; - u_int32_t hid; - int error = 0; + int error; KASSERT(krp != NULL, ("%s: krp == NULL", __func__)); KASSERT(krp->krp_callback != NULL, ("%s: krp->crp_callback == NULL", __func__)); CRYPTO_DRIVER_LOCK(); - for (hid = 0; hid < crypto_drivers_num; hid++) { - cap = &crypto_drivers[hid]; - if (cap == NULL) - continue; - if ((cap->cc_flags & CRYPTOCAP_F_SOFTWARE) && - !crypto_devallowsoft) { - continue; - } - if (cap->cc_kprocess == NULL) - continue; - if (!(cap->cc_kalg[krp->krp_op] & CRYPTO_ALG_FLAG_SUPPORTED)) - continue; - if (cap->cc_kqblocked) { - error = ERESTART; - continue; + if ((crid & (CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE)) == 0) { + cap = crypto_checkdriver(crid); + if (cap != NULL) { + /* + * Driver present, it must support the necessary + * algorithm and, if s/w drivers are excluded, + * it must be registered as hardware-backed. + */ + if (!kdriver_suitable(cap, krp) || + (!crypto_devallowsoft && + (cap->cc_flags & CRYPTOCAP_F_HARDWARE) == 0)) + cap = NULL; } - error = 0; - break; + } else { + /* + * No requested driver; select based on crid flags. + */ + if (!crypto_devallowsoft) /* NB: disallow s/w drivers */ + crid &= ~CRYPTOCAP_F_SOFTWARE; + cap = crypto_select_kdriver(krp, crid); } - krp->krp_hid = hid; - if (hid < crypto_drivers_num) { + if (cap != NULL && !cap->cc_kqblocked) { + krp->krp_hid = cap - crypto_drivers; cap->cc_koperations++; CRYPTO_DRIVER_UNLOCK(); - error = cap->cc_kprocess(cap->cc_karg, krp, 0); + error = CRYPTODEV_KPROCESS(cap->cc_dev, krp, 0); CRYPTO_DRIVER_LOCK(); if (error == ERESTART) { cap->cc_koperations--; @@ -809,7 +948,12 @@ crypto_kinvoke(struct cryptkop *krp) return (error); } } else { - error = ENODEV; + /* + * NB: cap is !NULL if device is blocked; in + * that case return ERESTART so the operation + * is resubmitted if possible. + */ + error = (cap == NULL) ? ENODEV : ERESTART; } CRYPTO_DRIVER_UNLOCK(); @@ -878,7 +1022,9 @@ crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint) for (crd = crp->crp_desc; crd->crd_next; crd = crd->crd_next) crd->CRD_INI.cri_next = &(crd->crd_next->CRD_INI); - if (crypto_newsession(&nid, &(crp->crp_desc->CRD_INI), 0) == 0) + /* XXX propagate flags from initial session? */ + if (crypto_newsession(&nid, &(crp->crp_desc->CRD_INI), + CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE) == 0) crp->crp_sid = nid; crp->crp_etype = EAGAIN; @@ -888,7 +1034,7 @@ crypto_invoke(struct cryptocap *cap, struct cryptop *crp, int hint) /* * Invoke the driver to process the request. */ - return cap->cc_process(cap->cc_arg, crp, hint); + return CRYPTODEV_PROCESS(cap->cc_dev, crp, hint); } } @@ -928,7 +1074,6 @@ crypto_freereq(struct cryptop *crp) crp->crp_desc = crd->crd_next; uma_zfree(cryptodesc_zone, crd); } - uma_zfree(cryptop_zone, crp); } @@ -1045,24 +1190,19 @@ crypto_getfeat(int *featp) { int hid, kalg, feat = 0; - if (!crypto_userasymcrypto) - goto out; - CRYPTO_DRIVER_LOCK(); for (hid = 0; hid < crypto_drivers_num; hid++) { - if ((crypto_drivers[hid].cc_flags & CRYPTOCAP_F_SOFTWARE) && + const struct cryptocap *cap = &crypto_drivers[hid]; + + if ((cap->cc_flags & CRYPTOCAP_F_SOFTWARE) && !crypto_devallowsoft) { continue; } - if (crypto_drivers[hid].cc_kprocess == NULL) - continue; for (kalg = 0; kalg < CRK_ALGORITHM_MAX; kalg++) - if ((crypto_drivers[hid].cc_kalg[kalg] & - CRYPTO_ALG_FLAG_SUPPORTED) != 0) + if (cap->cc_kalg[kalg] & CRYPTO_ALG_FLAG_SUPPORTED) feat |= 1 << kalg; } CRYPTO_DRIVER_UNLOCK(); -out: *featp = feat; return (0); } @@ -1115,7 +1255,7 @@ crypto_proc(void) */ KASSERT(cap != NULL, ("%s:%u Driver disappeared.", __func__, __LINE__)); - if (cap == NULL || cap->cc_process == NULL) { + if (cap == NULL || cap->cc_dev == NULL) { /* Op needs to be migrated, process it. */ if (submit == NULL) submit = crp; @@ -1169,8 +1309,18 @@ crypto_proc(void) /* As above, but for key ops */ TAILQ_FOREACH(krp, &crp_kq, krp_next) { cap = crypto_checkdriver(krp->krp_hid); - if (cap == NULL || cap->cc_kprocess == NULL) { - /* Op needs to be migrated, process it. */ + if (cap == NULL || cap->cc_dev == NULL) { + /* + * Operation needs to be migrated, invalidate + * the assigned device so it will reselect a + * new one below. Propagate the original + * crid selection flags if supplied. + */ + krp->krp_hid = krp->krp_crid & + (CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE); + if (krp->krp_hid == 0) + krp->krp_hid = + CRYPTOCAP_F_SOFTWARE|CRYPTOCAP_F_HARDWARE; break; } if (!cap->cc_kqblocked) @@ -1178,7 +1328,7 @@ crypto_proc(void) } if (krp != NULL) { TAILQ_REMOVE(&crp_kq, krp, krp_next); - result = crypto_kinvoke(krp); + result = crypto_kinvoke(krp, krp->krp_hid); if (result == ERESTART) { /* * The driver ran out of resources, mark the @@ -1284,3 +1434,131 @@ crypto_ret_proc(void) crypto_finis(&crp_ret_q); } + +#ifdef DDB +static void +db_show_drivers(void) +{ + int hid; + + db_printf("%12s %4s %4s %8s %2s %2s\n" + , "Device" + , "Ses" + , "Kops" + , "Flags" + , "QB" + , "KB" + ); + for (hid = 0; hid < crypto_drivers_num; hid++) { + const struct cryptocap *cap = &crypto_drivers[hid]; + if (cap->cc_dev == NULL) + continue; + db_printf("%-12s %4u %4u %08x %2u %2u\n" + , device_get_nameunit(cap->cc_dev) + , cap->cc_sessions + , cap->cc_koperations + , cap->cc_flags + , cap->cc_qblocked + , cap->cc_kqblocked + ); + } +} + +DB_SHOW_COMMAND(crypto, db_show_crypto) +{ + struct cryptop *crp; + + db_show_drivers(); + db_printf("\n"); + + db_printf("%4s %8s %4s %4s %4s %4s %8s %8s\n", + "HID", "Caps", "Ilen", "Olen", "Etype", "Flags", + "Desc", "Callback"); + TAILQ_FOREACH(crp, &crp_q, crp_next) { + db_printf("%4u %08x %4u %4u %4u %04x %8p %8p\n" + , (int) CRYPTO_SESID2HID(crp->crp_sid) + , (int) CRYPTO_SESID2CAPS(crp->crp_sid) + , crp->crp_ilen, crp->crp_olen + , crp->crp_etype + , crp->crp_flags + , crp->crp_desc + , crp->crp_callback + ); + } + if (!TAILQ_EMPTY(&crp_ret_q)) { + db_printf("\n%4s %4s %4s %8s\n", + "HID", "Etype", "Flags", "Callback"); + TAILQ_FOREACH(crp, &crp_ret_q, crp_next) { + db_printf("%4u %4u %04x %8p\n" + , (int) CRYPTO_SESID2HID(crp->crp_sid) + , crp->crp_etype + , crp->crp_flags + , crp->crp_callback + ); + } + } +} + +DB_SHOW_COMMAND(kcrypto, db_show_kcrypto) +{ + struct cryptkop *krp; + + db_show_drivers(); + db_printf("\n"); + + db_printf("%4s %5s %4s %4s %8s %4s %8s\n", + "Op", "Status", "#IP", "#OP", "CRID", "HID", "Callback"); + TAILQ_FOREACH(krp, &crp_kq, krp_next) { + db_printf("%4u %5u %4u %4u %08x %4u %8p\n" + , krp->krp_op + , krp->krp_status + , krp->krp_iparams, krp->krp_oparams + , krp->krp_crid, krp->krp_hid + , krp->krp_callback + ); + } + if (!TAILQ_EMPTY(&crp_ret_q)) { + db_printf("%4s %5s %8s %4s %8s\n", + "Op", "Status", "CRID", "HID", "Callback"); + TAILQ_FOREACH(krp, &crp_ret_kq, krp_next) { + db_printf("%4u %5u %08x %4u %8p\n" + , krp->krp_op + , krp->krp_status + , krp->krp_crid, krp->krp_hid + , krp->krp_callback + ); + } + } +} +#endif + +int crypto_modevent(module_t mod, int type, void *unused); + +/* + * Initialization code, both for static and dynamic loading. + * Note this is not invoked with the usual MODULE_DECLARE + * mechanism but instead is listed as a dependency by the + * cryptosoft driver. This guarantees proper ordering of + * calls on module load/unload. + */ +int +crypto_modevent(module_t mod, int type, void *unused) +{ + int error = EINVAL; + + switch (type) { + case MOD_LOAD: + error = crypto_init(); + if (error == 0 && bootverbose) + printf("crypto: <crypto core>\n"); + break; + case MOD_UNLOAD: + /*XXX disallow if active sessions */ + error = 0; + crypto_destroy(); + return 0; + } + return error; +} +MODULE_VERSION(crypto, 1); +MODULE_DEPEND(crypto, zlib, 1, 1, 1); diff --git a/sys/opencrypto/crypto_if.m b/sys/opencrypto/crypto_if.m deleted file mode 100644 index 2720cc1..0000000 --- a/sys/opencrypto/crypto_if.m +++ /dev/null @@ -1,128 +0,0 @@ -#- -# Copyright (c) 2002, Sam Leffler -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions -# are met: -# 1. Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# 2. Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. -# 3. All advertising materials mentioning features or use of this software -# must display the following acknowledgement: -# This product includes software developed by Boris Popov. -# 4. Neither the name of the author nor the names of any co-contributors -# may be used to endorse or promote products derived from this software -# without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND -# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE -# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS -# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF -# SUCH DAMAGE. -# -# $FreeBSD$ -# - -#include <crypto/cryptodev.h> - -INTERFACE crypto; - -METHOD int32_t get_driverid { - u_int32_t flags; -}; - -# XXX define typedefs to work around inadequate parser -HEADER { - typedef int crypto_newsession_cb(void*, u_int32_t*, struct cryptoini*); - typedef int crypto_freesession_cb(void*, u_int64_t*); - typedef int crypto_process_cb(void*, struct cryptop*); - typedef int crypto_kprocess_cb(void*, struct cryptkop*); -}; - -METHOD int register { - u_int32_t driverid; - int alg; - u_int16_t maxoplen; - u_int32_t flags; - crypto_newsession_cb* newses; - crypto_freesession_cb* freeses; - crypto_process_cb* process; - void *arg; -}; - -METHOD int kregister { - u_int32_t driverid; - int kalg; - u_int32_t flags; - crypto_kprocess_cb* kprocess; - void *arg; -}; - -METHOD int unregister { - u_int32_t driverid; - int alg; -}; - -METHOD int unregister_all { - u_int32_t driverid; -}; - -METHOD int newsession { - u_int64_t *sid; - struct cryptoini *cri; - int hard; -}; - -METHOD int freesession { - u_int64_t sid; -}; - -METHOD int dispatch { - struct cryptop *crp; -}; - -METHOD int kdispatch { - struct cryptkop *krp; -}; - -METHOD int crypto_unblock { - u_int32_t driverid; - int what; -}; - -METHOD int invoke { - struct cryptop *crp; -}; - -METHOD int kinvoke { - struct cryptkop *krp; -}; - -METHOD struct cryptop * getreq { - int num; -}; - -METHOD void freereq { - struct cryptop *crp; -}; - -METHOD void done { - struct cryptop *crp; -}; - -METHOD void kdone { - struct cryptkop *krp; -}; - -METHOD int getfeat { - int *featp; -}; diff --git a/sys/opencrypto/cryptodev.c b/sys/opencrypto/cryptodev.c index f3fb9db..7de290c 100644 --- a/sys/opencrypto/cryptodev.c +++ b/sys/opencrypto/cryptodev.c @@ -2,6 +2,7 @@ /*- * Copyright (c) 2001 Theo de Raadt + * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions @@ -50,6 +51,7 @@ __FBSDID("$FreeBSD$"); #include <sys/kernel.h> #include <sys/module.h> #include <sys/fcntl.h> +#include <sys/bus.h> #include <opencrypto/cryptodev.h> #include <opencrypto/xform.h> @@ -113,6 +115,7 @@ static int csefree(struct csession *); static int cryptodev_op(struct csession *, struct crypt_op *, struct ucred *, struct thread *td); static int cryptodev_key(struct crypt_kop *); +static int cryptodev_find(struct crypt_find_op *); static int cryptof_rw( @@ -126,6 +129,22 @@ cryptof_rw( return (EIO); } +/* + * Check a crypto identifier to see if it requested + * a software device/driver. This can be done either + * by device name/class or through search constraints. + */ +static int +checkforsoftware(int crid) +{ + if (crid & CRYPTOCAP_F_SOFTWARE) + return EINVAL; /* XXX */ + if ((crid & CRYPTOCAP_F_HARDWARE) == 0 && + (crypto_getcaps(crid) & CRYPTOCAP_F_HARDWARE) == 0) + return EINVAL; /* XXX */ + return 0; +} + /* ARGSUSED */ static int cryptof_ioctl( @@ -135,6 +154,7 @@ cryptof_ioctl( struct ucred *active_cred, struct thread *td) { +#define SES2(p) ((struct session2_op *)p) struct cryptoini cria, crie; struct fcrypt *fcr = fp->f_data; struct csession *cse; @@ -142,16 +162,14 @@ cryptof_ioctl( struct crypt_op *cop; struct enc_xform *txform = NULL; struct auth_hash *thash = NULL; + struct crypt_kop *kop; u_int64_t sid; u_int32_t ses; - int error = 0; + int error = 0, crid; - /* - * XXX: Not sure Giant is needed, but better safe than sorry - */ - mtx_lock(&Giant); switch (cmd) { case CIOCGSESSION: + case CIOCGSESSION2: sop = (struct session_op *)data; switch (sop->cipher) { case 0: @@ -181,7 +199,6 @@ cryptof_ioctl( txform = &enc_xform_arc4; break; default: - mtx_unlock(&Giant); return (EINVAL); } @@ -218,7 +235,6 @@ cryptof_ioctl( thash = &auth_hash_null; break; default: - mtx_unlock(&Giant); return (EINVAL); } @@ -260,15 +276,17 @@ cryptof_ioctl( } } - error = crypto_newsession(&sid, (txform ? &crie : &cria), 1); - if (error) { - if (crypto_devallowsoft) { - error = crypto_newsession(&sid, - (txform ? &crie : &cria), 0); - } + /* NB: CIOGSESSION2 has the crid */ + if (cmd == CIOCGSESSION2) { + crid = SES2(sop)->crid; + error = checkforsoftware(crid); if (error) goto bail; - } + } else + crid = CRYPTOCAP_F_HARDWARE; + error = crypto_newsession(&sid, (txform ? &crie : &cria), crid); + if (error) + goto bail; cse = csecreate(fcr, sid, crie.cri_key, crie.cri_klen, cria.cri_key, cria.cri_klen, sop->cipher, sop->mac, txform, @@ -280,7 +298,10 @@ cryptof_ioctl( goto bail; } sop->ses = cse->ses; - + if (cmd == CIOCGSESSION2) { + /* return hardware/driver id */ + SES2(sop)->crid = CRYPTO_SESID2HID(cse->sid); + } bail: if (error) { if (crie.cri_key) @@ -292,33 +313,53 @@ bail: case CIOCFSESSION: ses = *(u_int32_t *)data; cse = csefind(fcr, ses); - if (cse == NULL) { - mtx_unlock(&Giant); + if (cse == NULL) return (EINVAL); - } csedelete(fcr, cse); error = csefree(cse); break; case CIOCCRYPT: cop = (struct crypt_op *)data; cse = csefind(fcr, cop->ses); - if (cse == NULL) { - mtx_unlock(&Giant); + if (cse == NULL) return (EINVAL); - } error = cryptodev_op(cse, cop, active_cred, td); break; case CIOCKEY: - error = cryptodev_key((struct crypt_kop *)data); + case CIOCKEY2: + if (!crypto_userasymcrypto) + return (EPERM); /* XXX compat? */ + mtx_lock(&Giant); + kop = (struct crypt_kop *)data; + if (cmd == CIOCKEY) { + /* NB: crypto core enforces s/w driver use */ + kop->crk_crid = + CRYPTOCAP_F_HARDWARE | CRYPTOCAP_F_SOFTWARE; + } + error = cryptodev_key(kop); + mtx_unlock(&Giant); break; case CIOCASYMFEAT: - error = crypto_getfeat((int *)data); + if (!crypto_userasymcrypto) { + /* + * NB: if user asym crypto operations are + * not permitted return "no algorithms" + * so well-behaved applications will just + * fallback to doing them in software. + */ + *(int *)data = 0; + } else + error = crypto_getfeat((int *)data); + break; + case CIOCFINDDEV: + error = cryptodev_find((struct crypt_find_op *)data); break; default: error = EINVAL; + break; } - mtx_unlock(&Giant); return (error); +#undef SES2 } static int cryptodev_cb(void *); @@ -485,12 +526,16 @@ cryptodev_cb(void *op) { struct cryptop *crp = (struct cryptop *) op; struct csession *cse = (struct csession *)crp->crp_opaque; + int error; - cse->error = crp->crp_etype; - if (crp->crp_etype == EAGAIN) - return crypto_dispatch(crp); + error = crp->crp_etype; + if (error == EAGAIN) + error = crypto_dispatch(crp); mtx_lock(&cse->lock); - wakeup_one(crp); + if (error != 0 || (crp->crp_flags & CRYPTO_F_DONE)) { + cse->error = error; + wakeup_one(crp); + } mtx_unlock(&cse->lock); return (0); } @@ -500,7 +545,7 @@ cryptodevkey_cb(void *op) { struct cryptkop *krp = (struct cryptkop *) op; - wakeup(krp); + wakeup_one(krp); return (0); } @@ -550,6 +595,7 @@ cryptodev_key(struct crypt_kop *kop) krp->krp_status = kop->crk_status; krp->krp_iparams = kop->crk_iparams; krp->krp_oparams = kop->crk_oparams; + krp->krp_crid = kop->crk_crid; krp->krp_status = 0; krp->krp_callback = (int (*) (struct cryptkop *)) cryptodevkey_cb; @@ -576,6 +622,7 @@ cryptodev_key(struct crypt_kop *kop) goto fail; } + kop->crk_crid = krp->krp_crid; /* device that did the work */ if (krp->krp_status != 0) { error = krp->krp_status; goto fail; @@ -602,6 +649,25 @@ fail: return (error); } +static int +cryptodev_find(struct crypt_find_op *find) +{ + device_t dev; + + if (find->crid != -1) { + dev = crypto_find_device_byhid(find->crid); + if (dev == NULL) + return (ENOENT); + strlcpy(find->name, device_get_nameunit(dev), + sizeof(find->name)); + } else { + find->crid = crypto_find_driver(find->name); + if (find->crid == -1) + return (ENOENT); + } + return (0); +} + /* ARGSUSED */ static int cryptof_poll( @@ -775,6 +841,12 @@ cryptoioctl(struct cdev *dev, u_long cmd, caddr_t data, int flag, struct thread *(u_int32_t *)data = fd; fdrop(f, td); break; + case CRIOFINDDEV: + error = cryptodev_find((struct crypt_find_op *)data); + break; + case CRIOASYMFEAT: + error = crypto_getfeat((int *)data); + break; default: error = EINVAL; break; diff --git a/sys/opencrypto/cryptodev.h b/sys/opencrypto/cryptodev.h index 9c06187..39fbf37 100644 --- a/sys/opencrypto/cryptodev.h +++ b/sys/opencrypto/cryptodev.h @@ -3,6 +3,7 @@ /*- * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) + * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting * * This code was written by Angelos D. Keromytis in Athens, Greece, in * February 2000. Network Security Technologies Inc. (NSTI) kindly @@ -127,6 +128,18 @@ #define CRYPTO_ALG_FLAG_RNG_ENABLE 0x02 /* Has HW RNG for DH/DSA */ #define CRYPTO_ALG_FLAG_DSA_SHA 0x04 /* Can do SHA on msg */ +/* + * Crypto driver/device flags. They can set in the crid + * parameter when creating a session or submitting a key + * op to affect the device/driver assigned. If neither + * of these are specified then the crid is assumed to hold + * the driver id of an existing (and suitable) device that + * must be used to satisfy the request. + */ +#define CRYPTO_FLAG_HARDWARE 0x01000000 /* hardware accelerated */ +#define CRYPTO_FLAG_SOFTWARE 0x02000000 /* software implementation */ + +/* NB: deprecated */ struct session_op { u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ @@ -139,6 +152,20 @@ struct session_op { u_int32_t ses; /* returns: session # */ }; +struct session2_op { + u_int32_t cipher; /* ie. CRYPTO_DES_CBC */ + u_int32_t mac; /* ie. CRYPTO_MD5_HMAC */ + + u_int32_t keylen; /* cipher key */ + caddr_t key; + int mackeylen; /* mac key */ + caddr_t mackey; + + u_int32_t ses; /* returns: session # */ + int crid; /* driver id + flags (rw) */ + int pad[4]; /* for future expansion */ +}; + struct crypt_op { u_int32_t ses; u_int16_t op; /* i.e. COP_ENCRYPT */ @@ -152,6 +179,16 @@ struct crypt_op { caddr_t iv; }; +/* + * Parameters for looking up a crypto driver/device by + * device name or by id. The latter are returned for + * created sessions (crid) and completed key operations. + */ +struct crypt_find_op { + int crid; /* driver id + flags */ + char name[32]; /* device/driver name */ +}; + /* bignum parameter, in packed bytes, ... */ struct crparam { caddr_t crp_p; @@ -165,7 +202,7 @@ struct crypt_kop { u_int crk_status; /* return status */ u_short crk_iparams; /* # of input parameters */ u_short crk_oparams; /* # of output parameters */ - u_int crk_pad1; + u_int crk_crid; /* NB: only used by CIOCKEY2 (rw) */ struct crparam crk_param[CRK_MAXPARAM]; }; #define CRK_ALGORITM_MIN 0 @@ -187,14 +224,18 @@ struct crypt_kop { * Please use F_SETFD against the cloned descriptor. */ #define CRIOGET _IOWR('c', 100, u_int32_t) +#define CRIOASYMFEAT CIOCASYMFEAT +#define CRIOFINDDEV CIOCFINDDEV /* the following are done against the cloned descriptor */ #define CIOCGSESSION _IOWR('c', 101, struct session_op) #define CIOCFSESSION _IOW('c', 102, u_int32_t) #define CIOCCRYPT _IOWR('c', 103, struct crypt_op) #define CIOCKEY _IOWR('c', 104, struct crypt_kop) - #define CIOCASYMFEAT _IOR('c', 105, u_int32_t) +#define CIOCGSESSION2 _IOWR('c', 106, struct session2_op) +#define CIOCKEY2 _IOWR('c', 107, struct crypt_kop) +#define CIOCFINDDEV _IOWR('c', 108, struct crypt_find_op) struct cryptotstat { struct timespec acc; /* total accumulated time */ @@ -316,73 +357,37 @@ struct cryptkop { u_int krp_status; /* return status */ u_short krp_iparams; /* # of input parameters */ u_short krp_oparams; /* # of output parameters */ + u_int krp_crid; /* desired device, etc. */ u_int32_t krp_hid; struct crparam krp_param[CRK_MAXPARAM]; /* kvm */ int (*krp_callback)(struct cryptkop *); }; /* - * Crypto capabilities structure. - * - * Synchronization: - * (d) - protected by CRYPTO_DRIVER_LOCK() - * (q) - protected by CRYPTO_Q_LOCK() - * Not tagged fields are read-only. - */ -struct cryptocap { - u_int32_t cc_sessions; /* (d) number of sessions */ - u_int32_t cc_koperations; /* (d) number os asym operations */ - - /* - * Largest possible operator length (in bits) for each type of - * encryption algorithm. - */ - u_int16_t cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1]; - - u_int8_t cc_alg[CRYPTO_ALGORITHM_MAX + 1]; - - u_int8_t cc_kalg[CRK_ALGORITHM_MAX + 1]; - - u_int8_t cc_flags; /* (d) flags */ -#define CRYPTOCAP_F_CLEANUP 0x01 /* needs resource cleanup */ -#define CRYPTOCAP_F_SOFTWARE 0x02 /* software implementation */ -#define CRYPTOCAP_F_SYNC 0x04 /* operates synchronously */ - u_int8_t cc_qblocked; /* (q) symmetric q blocked */ - u_int8_t cc_kqblocked; /* (q) asymmetric q blocked */ - - void *cc_arg; /* callback argument */ - int (*cc_newsession)(void*, u_int32_t*, struct cryptoini*); - int (*cc_process)(void*, struct cryptop *, int); - int (*cc_freesession)(void*, u_int64_t); - void *cc_karg; /* callback argument */ - int (*cc_kprocess) (void*, struct cryptkop *, int); -}; - -/* * Session ids are 64 bits. The lower 32 bits contain a "local id" which * is a driver-private session identifier. The upper 32 bits contain a * "hardware id" used by the core crypto code to identify the driver and * a copy of the driver's capabilities that can be used by client code to * optimize operation. */ -#define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0xffffff) -#define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 56) & 0xff) +#define CRYPTO_SESID2HID(_sid) (((_sid) >> 32) & 0x00ffffff) +#define CRYPTO_SESID2CAPS(_sid) (((_sid) >> 32) & 0xff000000) #define CRYPTO_SESID2LID(_sid) (((u_int32_t) (_sid)) & 0xffffffff) MALLOC_DECLARE(M_CRYPTO_DATA); extern int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard); extern int crypto_freesession(u_int64_t sid); -extern int32_t crypto_get_driverid(u_int32_t flags); +#define CRYPTOCAP_F_HARDWARE CRYPTO_FLAG_HARDWARE +#define CRYPTOCAP_F_SOFTWARE CRYPTO_FLAG_SOFTWARE +#define CRYPTOCAP_F_SYNC 0x04000000 /* operates synchronously */ +extern int32_t crypto_get_driverid(device_t dev, int flags); +extern int crypto_find_driver(const char *); +extern device_t crypto_find_device_byhid(int hid); +extern int crypto_getcaps(int hid); extern int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen, - u_int32_t flags, - int (*newses)(void*, u_int32_t*, struct cryptoini*), - int (*freeses)(void*, u_int64_t), - int (*process)(void*, struct cryptop *, int), - void *arg); -extern int crypto_kregister(u_int32_t, int, u_int32_t, - int (*)(void*, struct cryptkop *, int), - void *arg); + u_int32_t flags); +extern int crypto_kregister(u_int32_t, int, u_int32_t); extern int crypto_unregister(u_int32_t driverid, int alg); extern int crypto_unregister_all(u_int32_t driverid); extern int crypto_dispatch(struct cryptop *crp); diff --git a/sys/opencrypto/cryptosoft.c b/sys/opencrypto/cryptosoft.c index 380da42..9de2350 100644 --- a/sys/opencrypto/cryptosoft.c +++ b/sys/opencrypto/cryptosoft.c @@ -2,6 +2,7 @@ /*- * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu) + * Copyright (c) 2002-2006 Sam Leffler, Errno Consulting * * This code was written by Angelos D. Keromytis in Athens, Greece, in * February 2000. Network Security Technologies Inc. (NSTI) kindly @@ -28,6 +29,7 @@ __FBSDID("$FreeBSD$"); #include <sys/systm.h> #include <sys/malloc.h> #include <sys/mbuf.h> +#include <sys/module.h> #include <sys/sysctl.h> #include <sys/errno.h> #include <sys/random.h> @@ -45,19 +47,21 @@ __FBSDID("$FreeBSD$"); #include <opencrypto/cryptosoft.h> #include <opencrypto/xform.h> -u_int8_t *hmac_ipad_buffer; -u_int8_t *hmac_opad_buffer; +#include <sys/kobj.h> +#include <sys/bus.h> +#include "cryptodev_if.h" -struct swcr_data **swcr_sessions = NULL; -u_int32_t swcr_sesnum = 0; -int32_t swcr_id = -1; +static int32_t swcr_id; +static struct swcr_data **swcr_sessions = NULL; +static u_int32_t swcr_sesnum; + +u_int8_t hmac_ipad_buffer[HMAC_MAX_BLOCK_LEN]; +u_int8_t hmac_opad_buffer[HMAC_MAX_BLOCK_LEN]; static int swcr_encdec(struct cryptodesc *, struct swcr_data *, caddr_t, int); static int swcr_authcompute(struct cryptodesc *, struct swcr_data *, caddr_t, int); static int swcr_compdec(struct cryptodesc *, struct swcr_data *, caddr_t, int); -static int swcr_process(void *, struct cryptop *, int); -static int swcr_newsession(void *, u_int32_t *, struct cryptoini *); -static int swcr_freesession(void *, u_int64_t); +static int swcr_freesession(device_t dev, u_int64_t tid); /* * Apply a symmetric encryption/decryption algorithm. @@ -580,7 +584,7 @@ swcr_compdec(struct cryptodesc *crd, struct swcr_data *sw, * Generate a new software session. */ static int -swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) +swcr_newsession(device_t dev, u_int32_t *sid, struct cryptoini *cri) { struct swcr_data **swd; struct auth_hash *axf; @@ -618,7 +622,7 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) } /* Copy existing sessions */ - if (swcr_sessions) { + if (swcr_sessions != NULL) { bcopy(swcr_sessions, swd, (swcr_sesnum / 2) * sizeof(struct swcr_data *)); free(swcr_sessions, M_CRYPTO_DATA); @@ -634,7 +638,7 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) MALLOC(*swd, struct swcr_data *, sizeof(struct swcr_data), M_CRYPTO_DATA, M_NOWAIT|M_ZERO); if (*swd == NULL) { - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return ENOBUFS; } @@ -665,7 +669,7 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) error = txf->setkey(&((*swd)->sw_kschedule), cri->cri_key, cri->cri_klen / 8); if (error) { - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return error; } } @@ -696,14 +700,14 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) (*swd)->sw_ictx = malloc(axf->ctxsize, M_CRYPTO_DATA, M_NOWAIT); if ((*swd)->sw_ictx == NULL) { - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return ENOBUFS; } (*swd)->sw_octx = malloc(axf->ctxsize, M_CRYPTO_DATA, M_NOWAIT); if ((*swd)->sw_octx == NULL) { - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return ENOBUFS; } @@ -726,14 +730,14 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) (*swd)->sw_ictx = malloc(axf->ctxsize, M_CRYPTO_DATA, M_NOWAIT); if ((*swd)->sw_ictx == NULL) { - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return ENOBUFS; } (*swd)->sw_octx = malloc(cri->cri_klen / 8, M_CRYPTO_DATA, M_NOWAIT); if ((*swd)->sw_octx == NULL) { - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return ENOBUFS; } @@ -757,7 +761,7 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) (*swd)->sw_ictx = malloc(axf->ctxsize, M_CRYPTO_DATA, M_NOWAIT); if ((*swd)->sw_ictx == NULL) { - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return ENOBUFS; } @@ -771,7 +775,7 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) (*swd)->sw_cxf = cxf; break; default: - swcr_freesession(NULL, i); + swcr_freesession(dev, i); return EINVAL; } @@ -786,7 +790,7 @@ swcr_newsession(void *arg, u_int32_t *sid, struct cryptoini *cri) * Free a session. */ static int -swcr_freesession(void *arg, u_int64_t tid) +swcr_freesession(device_t dev, u_int64_t tid) { struct swcr_data *swd; struct enc_xform *txf; @@ -874,7 +878,7 @@ swcr_freesession(void *arg, u_int64_t tid) * Process a software request. */ static int -swcr_process(void *arg, struct cryptop *crp, int hint) +swcr_process(device_t dev, struct cryptop *crp, int hint) { struct cryptodesc *crd; struct swcr_data *sw; @@ -967,28 +971,37 @@ done: return 0; } -/* - * Initialize the driver, called from the kernel main(). - */ static void -swcr_init(void) +swcr_identify(device_t *dev, device_t parent) +{ + /* NB: order 10 is so we get attached after h/w devices */ + if (device_find_child(parent, "cryptosoft", -1) == NULL && + BUS_ADD_CHILD(parent, 10, "cryptosoft", -1) == 0) + panic("cryptosoft: could not attach"); +} + +static int +swcr_probe(device_t dev) +{ + device_set_desc(dev, "software crypto"); + return (0); +} + +static int +swcr_attach(device_t dev) { - u_int i; - - hmac_ipad_buffer = malloc(HMAC_MAX_BLOCK_LEN, M_CRYPTO_DATA, M_WAITOK); - for (i = 0; i < HMAC_MAX_BLOCK_LEN; i++) - hmac_ipad_buffer[i] = HMAC_IPAD_VAL; - hmac_opad_buffer = malloc(HMAC_MAX_BLOCK_LEN, M_CRYPTO_DATA, M_WAITOK); - for (i = 0; i < HMAC_MAX_BLOCK_LEN; i++) - hmac_opad_buffer[i] = HMAC_OPAD_VAL; - - swcr_id = crypto_get_driverid(CRYPTOCAP_F_SOFTWARE | CRYPTOCAP_F_SYNC); - if (swcr_id < 0) - panic("Software crypto device cannot initialize!"); - crypto_register(swcr_id, CRYPTO_DES_CBC, - 0, 0, swcr_newsession, swcr_freesession, swcr_process, NULL); + memset(hmac_ipad_buffer, HMAC_IPAD_VAL, HMAC_MAX_BLOCK_LEN); + memset(hmac_opad_buffer, HMAC_OPAD_VAL, HMAC_MAX_BLOCK_LEN); + + swcr_id = crypto_get_driverid(dev, + CRYPTOCAP_F_SOFTWARE | CRYPTOCAP_F_SYNC); + if (swcr_id < 0) { + device_printf(dev, "cannot initialize!"); + return ENOMEM; + } #define REGISTER(alg) \ - crypto_register(swcr_id, alg, 0,0,NULL,NULL,NULL,NULL) + crypto_register(swcr_id, alg, 0,0) + REGISTER(CRYPTO_DES_CBC); REGISTER(CRYPTO_3DES_CBC); REGISTER(CRYPTO_BLF_CBC); REGISTER(CRYPTO_CAST_CBC); @@ -1008,16 +1021,47 @@ swcr_init(void) REGISTER(CRYPTO_RIJNDAEL128_CBC); REGISTER(CRYPTO_DEFLATE_COMP); #undef REGISTER + + return 0; } -SYSINIT(cryptosoft_init, SI_SUB_PSEUDO, SI_ORDER_ANY, swcr_init, NULL) static void -swcr_uninit(void) +swcr_detach(device_t dev) { - + crypto_unregister_all(swcr_id); if (swcr_sessions != NULL) FREE(swcr_sessions, M_CRYPTO_DATA); - free(hmac_ipad_buffer, M_CRYPTO_DATA); - free(hmac_opad_buffer, M_CRYPTO_DATA); } -SYSUNINIT(cryptosoft_uninit, SI_SUB_PSEUDO, SI_ORDER_ANY, swcr_uninit, NULL); + +static device_method_t swcr_methods[] = { + DEVMETHOD(device_identify, swcr_identify), + DEVMETHOD(device_probe, swcr_probe), + DEVMETHOD(device_attach, swcr_attach), + DEVMETHOD(device_detach, swcr_detach), + + DEVMETHOD(cryptodev_newsession, swcr_newsession), + DEVMETHOD(cryptodev_freesession,swcr_freesession), + DEVMETHOD(cryptodev_process, swcr_process), + + {0, 0}, +}; + +static driver_t swcr_driver = { + "cryptosoft", + swcr_methods, + 0, /* NB: no softc */ +}; +static devclass_t swcr_devclass; + +/* + * NB: We explicitly reference the crypto module so we + * get the necessary ordering when built as a loadable + * module. This is required because we bundle the crypto + * module code together with the cryptosoft driver (otherwise + * normal module dependencies would handle things). + */ +extern int crypto_modevent(struct module *, int, void *); +/* XXX where to attach */ +DRIVER_MODULE(cryptosoft, nexus, swcr_driver, swcr_devclass, crypto_modevent,0); +MODULE_VERSION(cryptosoft, 1); +MODULE_DEPEND(cryptosoft, crypto, 1, 1, 1); diff --git a/sys/opencrypto/cryptosoft.h b/sys/opencrypto/cryptosoft.h index 056e137..af78dc1 100644 --- a/sys/opencrypto/cryptosoft.h +++ b/sys/opencrypto/cryptosoft.h @@ -60,8 +60,8 @@ struct swcr_data { }; #ifdef _KERNEL -extern u_int8_t *hmac_ipad_buffer; -extern u_int8_t *hmac_opad_buffer; +extern u_int8_t hmac_ipad_buffer[]; +extern u_int8_t hmac_opad_buffer[]; #endif /* _KERNEL */ #endif /* _CRYPTO_CRYPTO_H_ */ |