sys/crypto/via/padlock.c

   1 /*-
   2  * Copyright (c) 2005-2008 Pawel Jakub Dawidek <pjd@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  * $FreeBSD: src/sys/crypto/via/padlock.c,v 1.23 2009/02/05 19:30:28 imp Exp $
  27  */
  28
  29 #include <sys/param.h>
  30 #include <sys/systm.h>
  31 #include <sys/kernel.h>
  32 #include <sys/module.h>
  33 #include <sys/lock.h>
  34 #include <sys/malloc.h>
  35 #include <sys/libkern.h>
  36 #if defined(__x86_64__) || defined(__i386__)
  37 #include <machine/cpufunc.h>
  38 #include <machine/cputypes.h>
  39 #include <machine/md_var.h>
  40 #include <machine/specialreg.h>
  41 #endif
  42
  43 #include <opencrypto/cryptodev.h>
  44
  45 #include <crypto/via/padlock.h>
  46
  47 #include <sys/kobj.h>
  48 #include <sys/bus.h>
  49 #include "cryptodev_if.h"
  50
  51 /*
  52  * Technical documentation about the PadLock engine can be found here:
  53  *
  54  * http://www.via.com.tw/en/downloads/whitepapers/initiatives/padlock/programming_guide.pdf
  55  */
  56
  57 struct padlock_softc {
  58         int32_t         sc_cid;
  59         uint32_t        sc_sid;
  60         TAILQ_HEAD(padlock_sessions_head, padlock_session) sc_sessions;
  61         struct lock     sc_sessions_lock;
  62 };
  63
  64 static int padlock_newsession(device_t, uint32_t *sidp, struct cryptoini *cri);
  65 static int padlock_freesession(device_t, uint64_t tid);
  66 static void padlock_freesession_one(struct padlock_softc *sc,
  67     struct padlock_session *ses, int locked);
  68 static int padlock_process(device_t, struct cryptop *crp, int hint __unused);
  69
  70 MALLOC_DEFINE(M_PADLOCK, "padlock_data", "PadLock Data");
  71
  72 static void
  73 padlock_identify(driver_t *drv, device_t parent)
  74 {
  75         /* NB: order 10 is so we get attached after h/w devices */
  76         /* XXX: wouldn't bet about this BUS_ADD_CHILD correctness */
  77         if (device_find_child(parent, "padlock", -1) == NULL &&
  78             BUS_ADD_CHILD(parent, parent, 10, "padlock", -1) == 0)
  79                 panic("padlock: could not attach");
  80 }
  81
  82 static int
  83 padlock_probe(device_t dev)
  84 {
  85         char capp[256];
  86
  87 #if defined(__x86_64__) || defined(__i386__)
  88         /* If there is no AES support, we has nothing to do here. */
  89         if (!(via_feature_xcrypt & VIA_HAS_AES)) {
  90                 device_printf(dev, "No ACE support.\n");
  91                 return (EINVAL);
  92         }
  93         strlcpy(capp, "AES-CBC", sizeof(capp));
  94 #if 0
  95         strlcat(capp, ",AES-EBC", sizeof(capp));
  96         strlcat(capp, ",AES-CFB", sizeof(capp));
  97         strlcat(capp, ",AES-OFB", sizeof(capp));
  98 #endif
  99         if (via_feature_xcrypt & VIA_HAS_SHA) {
 100                 strlcat(capp, ",SHA1", sizeof(capp));
 101                 strlcat(capp, ",SHA256", sizeof(capp));
 102         }
 103 #if 0
 104         if (via_feature_xcrypt & VIA_HAS_AESCTR)
 105                 strlcat(capp, ",AES-CTR", sizeof(capp));
 106         if (via_feature_xcrypt & VIA_HAS_MM)
 107                 strlcat(capp, ",RSA", sizeof(capp));
 108 #endif
 109         device_set_desc_copy(dev, capp);
 110         return (0);
 111 #else
 112         return (EINVAL);
 113 #endif
 114 }
 115
 116 static int
 117 padlock_attach(device_t dev)
 118 {
 119         struct padlock_softc *sc = device_get_softc(dev);
 120
 121         TAILQ_INIT(&sc->sc_sessions);
 122         sc->sc_sid = 1;
 123
 124         sc->sc_cid = crypto_get_driverid(dev, CRYPTOCAP_F_HARDWARE);
 125         if (sc->sc_cid < 0) {
 126                 device_printf(dev, "Could not get crypto driver id.\n");
 127                 return (ENOMEM);
 128         }
 129
 130         lockinit(&sc->sc_sessions_lock, "padlock_lock", 0, 0);
 131         crypto_register(sc->sc_cid, CRYPTO_AES_CBC, 0, 0);
 132         crypto_register(sc->sc_cid, CRYPTO_MD5_HMAC, 0, 0);
 133         crypto_register(sc->sc_cid, CRYPTO_SHA1_HMAC, 0, 0);
 134         crypto_register(sc->sc_cid, CRYPTO_RIPEMD160_HMAC, 0, 0);
 135         crypto_register(sc->sc_cid, CRYPTO_SHA2_256_HMAC, 0, 0);
 136         crypto_register(sc->sc_cid, CRYPTO_SHA2_384_HMAC, 0, 0);
 137         crypto_register(sc->sc_cid, CRYPTO_SHA2_512_HMAC, 0, 0);
 138         return (0);
 139 }
 140
 141 static int
 142 padlock_detach(device_t dev)
 143 {
 144         struct padlock_softc *sc = device_get_softc(dev);
 145         struct padlock_session *ses;
 146
 147         lockmgr(&sc->sc_sessions_lock, LK_SHARED);
 148         TAILQ_FOREACH(ses, &sc->sc_sessions, ses_next) {
 149                 if (ses->ses_used) {
 150                         lockmgr(&sc->sc_sessions_lock, LK_RELEASE);
 151                         device_printf(dev,
 152                             "Cannot detach, sessions still active.\n");
 153                         return (EBUSY);
 154                 }
 155         }
 156         while ((ses = TAILQ_FIRST(&sc->sc_sessions)) != NULL) {
 157                 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next);
 158                 kfree(ses->ses_freeaddr, M_PADLOCK);
 159         }
 160         lockuninit(&sc->sc_sessions_lock);
 161         crypto_unregister_all(sc->sc_cid);
 162         return (0);
 163 }
 164
 165 static int
 166 padlock_newsession(device_t dev, uint32_t *sidp, struct cryptoini *cri)
 167 {
 168         struct padlock_softc *sc = device_get_softc(dev);
 169         struct padlock_session *ases, *ses = NULL;
 170         struct cryptoini *encini, *macini;
 171         int error;
 172
 173         if (sidp == NULL || cri == NULL)
 174                 return (EINVAL);
 175
 176         encini = macini = NULL;
 177         for (; cri != NULL; cri = cri->cri_next) {
 178                 switch (cri->cri_alg) {
 179                 case CRYPTO_NULL_HMAC:
 180                 case CRYPTO_MD5_HMAC:
 181                 case CRYPTO_SHA1_HMAC:
 182                 case CRYPTO_RIPEMD160_HMAC:
 183                 case CRYPTO_SHA2_256_HMAC:
 184                 case CRYPTO_SHA2_384_HMAC:
 185                 case CRYPTO_SHA2_512_HMAC:
 186                         if (macini != NULL)
 187                                 return (EINVAL);
 188                         macini = cri;
 189                         break;
 190                 case CRYPTO_AES_CBC:
 191                         if (encini != NULL)
 192                                 return (EINVAL);
 193                         encini = cri;
 194                         break;
 195                 default:
 196                         return (EINVAL);
 197                 }
 198         }
 199
 200         /*
 201          * We only support HMAC algorithms to be able to work with
 202          * ipsec(4), so if we are asked only for authentication without
 203          * encryption, don't pretend we can accellerate it.
 204          */
 205         if (encini == NULL)
 206                 return (EINVAL);
 207
 208         /*
 209          * Let's look for a free session structure.
 210          */
 211         lockmgr(&sc->sc_sessions_lock, LK_SHARED);
 212         /*
 213          * Free sessions goes first, so if first session is used, we need to
 214          * allocate one.
 215          */
 216         ses = TAILQ_FIRST(&sc->sc_sessions);
 217         if (ses == NULL || ses->ses_used) {
 218                 ses = kmalloc(sizeof(*ses) + 16, M_PADLOCK, M_NOWAIT | M_ZERO);
 219                 if (ses == NULL) {
 220                         lockmgr(&sc->sc_sessions_lock, LK_RELEASE);
 221                         return (ENOMEM);
 222                 }
 223                 /* Check if 'ses' is 16-byte aligned. If not, align it. */
 224                 if (((uintptr_t)ses & 0xf) != 0) {
 225                         ases = PADLOCK_ALIGN(ses);
 226                         ases->ses_freeaddr = ses;
 227                         ses = ases;
 228                 } else {
 229                         ses->ses_freeaddr = ses;
 230                 }
 231                 ses->ses_id = sc->sc_sid++;
 232         } else {
 233                 TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next);
 234         }
 235         ses->ses_used = 1;
 236         TAILQ_INSERT_TAIL(&sc->sc_sessions, ses, ses_next);
 237         lockmgr(&sc->sc_sessions_lock, LK_RELEASE);
 238
 239         error = padlock_cipher_setup(ses, encini);
 240         if (error != 0) {
 241                 padlock_freesession_one(sc, ses, 0);
 242                 return (error);
 243         }
 244
 245         if (macini != NULL) {
 246                 error = padlock_hash_setup(ses, macini);
 247                 if (error != 0) {
 248                         padlock_freesession_one(sc, ses, 0);
 249                         return (error);
 250                 }
 251         }
 252
 253         *sidp = ses->ses_id;
 254         return (0);
 255 }
 256
 257 static void
 258 padlock_freesession_one(struct padlock_softc *sc, struct padlock_session *ses,
 259     int locked)
 260 {
 261         uint32_t sid = ses->ses_id;
 262
 263         if (!locked)
 264                 lockmgr(&sc->sc_sessions_lock, LK_SHARED);
 265         TAILQ_REMOVE(&sc->sc_sessions, ses, ses_next);
 266         padlock_hash_free(ses);
 267         bzero(ses, sizeof(*ses));
 268         ses->ses_used = 0;
 269         ses->ses_id = sid;
 270         TAILQ_INSERT_HEAD(&sc->sc_sessions, ses, ses_next);
 271         if (!locked)
 272                 lockmgr(&sc->sc_sessions_lock, LK_RELEASE);
 273 }
 274
 275 static int
 276 padlock_freesession(device_t dev, uint64_t tid)
 277 {
 278         struct padlock_softc *sc = device_get_softc(dev);
 279         struct padlock_session *ses;
 280         uint32_t sid = ((uint32_t)tid) & 0xffffffff;
 281
 282         lockmgr(&sc->sc_sessions_lock, LK_SHARED);
 283         TAILQ_FOREACH_REVERSE(ses, &sc->sc_sessions, padlock_sessions_head,
 284             ses_next) {
 285                 if (ses->ses_id == sid)
 286                         break;
 287         }
 288         if (ses == NULL) {
 289                 lockmgr(&sc->sc_sessions_lock, LK_RELEASE);
 290                 return (EINVAL);
 291         }
 292         padlock_freesession_one(sc, ses, 1);
 293         lockmgr(&sc->sc_sessions_lock, LK_RELEASE);
 294         return (0);
 295 }
 296
 297 static int
 298 padlock_process(device_t dev, struct cryptop *crp, int hint __unused)
 299 {
 300         struct padlock_softc *sc = device_get_softc(dev);
 301         struct padlock_session *ses = NULL;
 302         struct cryptodesc *crd, *enccrd, *maccrd;
 303         int error = 0;
 304
 305         enccrd = maccrd = NULL;
 306
 307         /* Sanity check. */
 308         if (crp == NULL)
 309                 return (EINVAL);
 310
 311         if (crp->crp_callback == NULL || crp->crp_desc == NULL) {
 312                 error = EINVAL;
 313                 goto out;
 314         }
 315
 316         for (crd = crp->crp_desc; crd != NULL; crd = crd->crd_next) {
 317                 switch (crd->crd_alg) {
 318                 case CRYPTO_NULL_HMAC:
 319                 case CRYPTO_MD5_HMAC:
 320                 case CRYPTO_SHA1_HMAC:
 321                 case CRYPTO_RIPEMD160_HMAC:
 322                 case CRYPTO_SHA2_256_HMAC:
 323                 case CRYPTO_SHA2_384_HMAC:
 324                 case CRYPTO_SHA2_512_HMAC:
 325                         if (maccrd != NULL) {
 326                                 error = EINVAL;
 327                                 goto out;
 328                         }
 329                         maccrd = crd;
 330                         break;
 331                 case CRYPTO_AES_CBC:
 332                         if (enccrd != NULL) {
 333                                 error = EINVAL;
 334                                 goto out;
 335                         }
 336                         enccrd = crd;
 337                         break;
 338                 default:
 339                         return (EINVAL);
 340                 }
 341         }
 342         if (enccrd == NULL || (enccrd->crd_len % AES_BLOCK_LEN) != 0) {
 343                 error = EINVAL;
 344                 goto out;
 345         }
 346
 347         lockmgr(&sc->sc_sessions_lock, LK_SHARED);
 348         TAILQ_FOREACH_REVERSE(ses, &sc->sc_sessions, padlock_sessions_head,
 349             ses_next) {
 350                 if (ses->ses_id == (crp->crp_sid & 0xffffffff))
 351                         break;
 352         }
 353         lockmgr(&sc->sc_sessions_lock, LK_RELEASE);
 354         if (ses == NULL) {
 355                 error = EINVAL;
 356                 goto out;
 357         }
 358
 359         /* Perform data authentication if requested before encryption. */
 360         if (maccrd != NULL && maccrd->crd_next == enccrd) {
 361                 error = padlock_hash_process(ses, maccrd, crp);
 362                 if (error != 0)
 363                         goto out;
 364         }
 365
 366         error = padlock_cipher_process(ses, enccrd, crp);
 367         if (error != 0)
 368                 goto out;
 369
 370         /* Perform data authentication if requested after encryption. */
 371         if (maccrd != NULL && enccrd->crd_next == maccrd) {
 372                 error = padlock_hash_process(ses, maccrd, crp);
 373                 if (error != 0)
 374                         goto out;
 375         }
 376
 377 out:
 378 #if 0
 379         /*
 380          * This code is not necessary, because contexts will be freed on next
 381          * padlock_setup_mackey() call or at padlock_freesession() call.
 382          */
 383         if (ses != NULL && maccrd != NULL &&
 384             (maccrd->crd_flags & CRD_F_KEY_EXPLICIT) != 0) {
 385                 padlock_free_ctx(ses->ses_axf, ses->ses_ictx);
 386                 padlock_free_ctx(ses->ses_axf, ses->ses_octx);
 387         }
 388 #endif
 389         crp->crp_etype = error;
 390         crypto_done(crp);
 391         return (error);
 392 }
 393
 394 static device_method_t padlock_methods[] = {
 395         DEVMETHOD(device_identify,      padlock_identify),
 396         DEVMETHOD(device_probe,         padlock_probe),
 397         DEVMETHOD(device_attach,        padlock_attach),
 398         DEVMETHOD(device_detach,        padlock_detach),
 399
 400         DEVMETHOD(cryptodev_newsession, padlock_newsession),
 401         DEVMETHOD(cryptodev_freesession,padlock_freesession),
 402         DEVMETHOD(cryptodev_process,    padlock_process),
 403
 404         {0, 0},
 405 };
 406
 407 static driver_t padlock_driver = {
 408         "padlock",
 409         padlock_methods,
 410         sizeof(struct padlock_softc),
 411 };
 412 static devclass_t padlock_devclass;
 413
 414 /* XXX where to attach */
 415 DRIVER_MODULE(padlock, nexus, padlock_driver, padlock_devclass, 0, 0);
 416 MODULE_VERSION(padlock, 1);
 417 MODULE_DEPEND(padlock, crypto, 1, 1, 1);