sys/crypto/via/padlock_hash.c

   1 /*-
   2  * Copyright (c) 2006 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_hash.c,v 1.4 2009/05/27 09:52:12 vanhu 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/malloc.h>
  34 #include <sys/libkern.h>
  35 #include <sys/endian.h>
  36 #if defined(__amd64__) || 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 #include <opencrypto/cryptosoft.h> /* for hmac_ipad_buffer and hmac_opad_buffer */
  45 #include <opencrypto/xform.h>
  46
  47 #include <crypto/via/padlock.h>
  48
  49 /*
  50  * Implementation notes.
  51  *
  52  * Some VIA CPUs provides SHA1 and SHA256 acceleration.
  53  * We implement all HMAC algorithms provided by crypto(9) framework, but we do
  54  * the crypto work in software unless this is HMAC/SHA1 or HMAC/SHA256 and
  55  * our CPU can accelerate it.
  56  *
  57  * Additional CPU instructions, which preform SHA1 and SHA256 are one-shot
  58  * functions - we have only one chance to give the data, CPU itself will add
  59  * the padding and calculate hash automatically.
  60  * This means, it is not possible to implement common init(), update(), final()
  61  * methods.
  62  * The way I've choosen is to keep adding data to the buffer on update()
  63  * (reallocating the buffer if necessary) and call XSHA{1,256} instruction on
  64  * final().
  65  */
  66
  67 struct padlock_sha_ctx {
  68         uint8_t *psc_buf;
  69         int      psc_offset;
  70         int      psc_size;
  71 };
  72 CTASSERT(sizeof(struct padlock_sha_ctx) <= sizeof(union authctx));
  73
  74 static void padlock_sha_init(struct padlock_sha_ctx *ctx);
  75 static int padlock_sha_update(struct padlock_sha_ctx *ctx, uint8_t *buf,
  76     uint16_t bufsize);
  77 static void padlock_sha1_final(uint8_t *hash, struct padlock_sha_ctx *ctx);
  78 static void padlock_sha256_final(uint8_t *hash, struct padlock_sha_ctx *ctx);
  79
  80 static struct auth_hash padlock_hmac_sha1 = {
  81         CRYPTO_SHA1_HMAC, "HMAC-SHA1",
  82         20, SHA1_HASH_LEN, SHA1_HMAC_BLOCK_LEN, sizeof(struct padlock_sha_ctx),
  83         (void (*)(void *))padlock_sha_init,
  84         (int (*)(void *, uint8_t *, uint16_t))padlock_sha_update,
  85         (void (*)(uint8_t *, void *))padlock_sha1_final
  86 };
  87
  88 static struct auth_hash padlock_hmac_sha256 = {
  89         CRYPTO_SHA2_256_HMAC, "HMAC-SHA2-256",
  90         32, SHA2_256_HASH_LEN, SHA2_256_HMAC_BLOCK_LEN, sizeof(struct padlock_sha_ctx),
  91         (void (*)(void *))padlock_sha_init,
  92         (int (*)(void *, uint8_t *, uint16_t))padlock_sha_update,
  93         (void (*)(uint8_t *, void *))padlock_sha256_final
  94 };
  95
  96 MALLOC_DECLARE(M_PADLOCK);
  97
  98 static __inline void
  99 padlock_output_block(uint32_t *src, uint32_t *dst, size_t count)
 100 {
 101
 102         while (count-- > 0)
 103                 *dst++ = bswap32(*src++);
 104 }
 105
 106 static void
 107 padlock_do_sha1(const u_char *in, u_char *out, int count)
 108 {
 109         u_char buf[128+16];     /* PadLock needs at least 128 bytes buffer. */
 110         u_char *result = PADLOCK_ALIGN(buf);
 111
 112         ((uint32_t *)result)[0] = 0x67452301;
 113         ((uint32_t *)result)[1] = 0xEFCDAB89;
 114         ((uint32_t *)result)[2] = 0x98BADCFE;
 115         ((uint32_t *)result)[3] = 0x10325476;
 116         ((uint32_t *)result)[4] = 0xC3D2E1F0;
 117
 118 #ifdef __GNUCLIKE_ASM
 119         __asm __volatile(
 120                 ".byte  0xf3, 0x0f, 0xa6, 0xc8" /* rep xsha1 */
 121                         : "+S"(in), "+D"(result)
 122                         : "c"(count), "a"(0)
 123                 );
 124 #endif
 125
 126         padlock_output_block((uint32_t *)result, (uint32_t *)out,
 127             SHA1_HASH_LEN / sizeof(uint32_t));
 128 }
 129
 130 static void
 131 padlock_do_sha256(const char *in, char *out, int count)
 132 {
 133         char buf[128+16];       /* PadLock needs at least 128 bytes buffer. */
 134         char *result = PADLOCK_ALIGN(buf);
 135
 136         ((uint32_t *)result)[0] = 0x6A09E667;
 137         ((uint32_t *)result)[1] = 0xBB67AE85;
 138         ((uint32_t *)result)[2] = 0x3C6EF372;
 139         ((uint32_t *)result)[3] = 0xA54FF53A;
 140         ((uint32_t *)result)[4] = 0x510E527F;
 141         ((uint32_t *)result)[5] = 0x9B05688C;
 142         ((uint32_t *)result)[6] = 0x1F83D9AB;
 143         ((uint32_t *)result)[7] = 0x5BE0CD19;
 144
 145 #ifdef __GNUCLIKE_ASM
 146         __asm __volatile(
 147                 ".byte  0xf3, 0x0f, 0xa6, 0xd0" /* rep xsha256 */
 148                         : "+S"(in), "+D"(result)
 149                         : "c"(count), "a"(0)
 150                 );
 151 #endif
 152
 153         padlock_output_block((uint32_t *)result, (uint32_t *)out,
 154             SHA2_256_HASH_LEN / sizeof(uint32_t));
 155 }
 156
 157 static void
 158 padlock_sha_init(struct padlock_sha_ctx *ctx)
 159 {
 160
 161         ctx->psc_buf = NULL;
 162         ctx->psc_offset = 0;
 163         ctx->psc_size = 0;
 164 }
 165
 166 static int
 167 padlock_sha_update(struct padlock_sha_ctx *ctx, uint8_t *buf, uint16_t bufsize)
 168 {
 169
 170         if (ctx->psc_size - ctx->psc_offset < bufsize) {
 171                 ctx->psc_size = MAX(ctx->psc_size * 2, ctx->psc_size + bufsize);
 172                 ctx->psc_buf = krealloc(ctx->psc_buf, ctx->psc_size, M_PADLOCK,
 173                     M_NOWAIT);
 174                 if(ctx->psc_buf == NULL)
 175                         return (ENOMEM);
 176         }
 177         bcopy(buf, ctx->psc_buf + ctx->psc_offset, bufsize);
 178         ctx->psc_offset += bufsize;
 179         return (0);
 180 }
 181
 182 static void
 183 padlock_sha_free(struct padlock_sha_ctx *ctx)
 184 {
 185
 186         if (ctx->psc_buf != NULL) {
 187                 //bzero(ctx->psc_buf, ctx->psc_size);
 188                 kfree(ctx->psc_buf, M_PADLOCK);
 189                 ctx->psc_buf = NULL;
 190                 ctx->psc_offset = 0;
 191                 ctx->psc_size = 0;
 192         }
 193 }
 194
 195 static void
 196 padlock_sha1_final(uint8_t *hash, struct padlock_sha_ctx *ctx)
 197 {
 198
 199         padlock_do_sha1(ctx->psc_buf, hash, ctx->psc_offset);
 200         padlock_sha_free(ctx);
 201 }
 202
 203 static void
 204 padlock_sha256_final(uint8_t *hash, struct padlock_sha_ctx *ctx)
 205 {
 206
 207         padlock_do_sha256(ctx->psc_buf, hash, ctx->psc_offset);
 208         padlock_sha_free(ctx);
 209 }
 210
 211 static void
 212 padlock_copy_ctx(struct auth_hash *axf, void *sctx, void *dctx)
 213 {
 214
 215         if ((via_feature_xcrypt & VIA_HAS_SHA) != 0 &&
 216             (axf->type == CRYPTO_SHA1_HMAC ||
 217              axf->type == CRYPTO_SHA2_256_HMAC)) {
 218                 struct padlock_sha_ctx *spctx = sctx, *dpctx = dctx;
 219
 220                 dpctx->psc_offset = spctx->psc_offset;
 221                 dpctx->psc_size = spctx->psc_size;
 222                 dpctx->psc_buf = kmalloc(dpctx->psc_size, M_PADLOCK, M_WAITOK);
 223                 bcopy(spctx->psc_buf, dpctx->psc_buf, dpctx->psc_size);
 224         } else {
 225                 bcopy(sctx, dctx, axf->ctxsize);
 226         }
 227 }
 228
 229 static void
 230 padlock_free_ctx(struct auth_hash *axf, void *ctx)
 231 {
 232
 233         if ((via_feature_xcrypt & VIA_HAS_SHA) != 0 &&
 234             (axf->type == CRYPTO_SHA1_HMAC ||
 235              axf->type == CRYPTO_SHA2_256_HMAC)) {
 236                 padlock_sha_free(ctx);
 237         }
 238 }
 239
 240 static void
 241 padlock_hash_key_setup(struct padlock_session *ses, caddr_t key, int klen)
 242 {
 243         struct auth_hash *axf;
 244         int i;
 245
 246         klen /= 8;
 247         axf = ses->ses_axf;
 248
 249         /*
 250          * Try to free contexts before using them, because
 251          * padlock_hash_key_setup() can be called twice - once from
 252          * padlock_newsession() and again from padlock_process().
 253          */
 254         padlock_free_ctx(axf, ses->ses_ictx);
 255         padlock_free_ctx(axf, ses->ses_octx);
 256
 257         for (i = 0; i < klen; i++)
 258                 key[i] ^= HMAC_IPAD_VAL;
 259
 260         axf->Init(ses->ses_ictx);
 261         axf->Update(ses->ses_ictx, key, klen);
 262         axf->Update(ses->ses_ictx, hmac_ipad_buffer, axf->blocksize - klen);
 263
 264         for (i = 0; i < klen; i++)
 265                 key[i] ^= (HMAC_IPAD_VAL ^ HMAC_OPAD_VAL);
 266
 267         axf->Init(ses->ses_octx);
 268         axf->Update(ses->ses_octx, key, klen);
 269         axf->Update(ses->ses_octx, hmac_opad_buffer, axf->blocksize - klen);
 270
 271         for (i = 0; i < klen; i++)
 272                 key[i] ^= HMAC_OPAD_VAL;
 273 }
 274
 275 /*
 276  * Compute keyed-hash authenticator.
 277  */
 278 static int
 279 padlock_authcompute(struct padlock_session *ses, struct cryptodesc *crd,
 280     caddr_t buf, int flags)
 281 {
 282         u_char hash[HASH_MAX_LEN];
 283         struct auth_hash *axf;
 284         union authctx ctx;
 285         int error;
 286
 287         axf = ses->ses_axf;
 288
 289         padlock_copy_ctx(axf, ses->ses_ictx, &ctx);
 290         error = crypto_apply(flags, buf, crd->crd_skip, crd->crd_len,
 291             (int (*)(void *, void *, unsigned int))axf->Update, (caddr_t)&ctx);
 292         if (error != 0) {
 293                 padlock_free_ctx(axf, &ctx);
 294                 return (error);
 295         }
 296         axf->Final(hash, &ctx);
 297
 298         padlock_copy_ctx(axf, ses->ses_octx, &ctx);
 299         axf->Update(&ctx, hash, axf->hashsize);
 300         axf->Final(hash, &ctx);
 301
 302         /* Inject the authentication data */
 303         crypto_copyback(flags, buf, crd->crd_inject,
 304             ses->ses_mlen == 0 ? axf->hashsize : ses->ses_mlen, hash);
 305         return (0);
 306 }
 307
 308 int
 309 padlock_hash_setup(struct padlock_session *ses, struct cryptoini *macini)
 310 {
 311
 312         ses->ses_mlen = macini->cri_mlen;
 313
 314         /* Find software structure which describes HMAC algorithm. */
 315         switch (macini->cri_alg) {
 316         case CRYPTO_NULL_HMAC:
 317                 ses->ses_axf = &auth_hash_null;
 318                 break;
 319         case CRYPTO_MD5_HMAC:
 320                 ses->ses_axf = &auth_hash_hmac_md5;
 321                 break;
 322         case CRYPTO_SHA1_HMAC:
 323                 if ((via_feature_xcrypt & VIA_HAS_SHA) != 0)
 324                         ses->ses_axf = &padlock_hmac_sha1;
 325                 else
 326                         ses->ses_axf = &auth_hash_hmac_sha1;
 327                 break;
 328         case CRYPTO_RIPEMD160_HMAC:
 329                 ses->ses_axf = &auth_hash_hmac_ripemd_160;
 330                 break;
 331         case CRYPTO_SHA2_256_HMAC:
 332                 if ((via_feature_xcrypt & VIA_HAS_SHA) != 0)
 333                         ses->ses_axf = &padlock_hmac_sha256;
 334                 else
 335                         ses->ses_axf = &auth_hash_hmac_sha2_256;
 336                 break;
 337         case CRYPTO_SHA2_384_HMAC:
 338                 ses->ses_axf = &auth_hash_hmac_sha2_384;
 339                 break;
 340         case CRYPTO_SHA2_512_HMAC:
 341                 ses->ses_axf = &auth_hash_hmac_sha2_512;
 342                 break;
 343         }
 344
 345         /* Allocate memory for HMAC inner and outer contexts. */
 346         ses->ses_ictx = kmalloc(ses->ses_axf->ctxsize, M_PADLOCK,
 347             M_ZERO | M_NOWAIT);
 348         ses->ses_octx = kmalloc(ses->ses_axf->ctxsize, M_PADLOCK,
 349             M_ZERO | M_NOWAIT);
 350         if (ses->ses_ictx == NULL || ses->ses_octx == NULL)
 351                 return (ENOMEM);
 352
 353         /* Setup key if given. */
 354         if (macini->cri_key != NULL) {
 355                 padlock_hash_key_setup(ses, macini->cri_key,
 356                     macini->cri_klen);
 357         }
 358         return (0);
 359 }
 360
 361 int
 362 padlock_hash_process(struct padlock_session *ses, struct cryptodesc *maccrd,
 363     struct cryptop *crp)
 364 {
 365         int error;
 366
 367         if ((maccrd->crd_flags & CRD_F_KEY_EXPLICIT) != 0)
 368                 padlock_hash_key_setup(ses, maccrd->crd_key, maccrd->crd_klen);
 369
 370         error = padlock_authcompute(ses, maccrd, crp->crp_buf, crp->crp_flags);
 371         return (error);
 372 }
 373
 374 void
 375 padlock_hash_free(struct padlock_session *ses)
 376 {
 377
 378         if (ses->ses_ictx != NULL) {
 379                 padlock_free_ctx(ses->ses_axf, ses->ses_ictx);
 380                 bzero(ses->ses_ictx, ses->ses_axf->ctxsize);
 381                 kfree(ses->ses_ictx, M_PADLOCK);
 382                 ses->ses_ictx = NULL;
 383         }
 384         if (ses->ses_octx != NULL) {
 385                 padlock_free_ctx(ses->ses_axf, ses->ses_octx);
 386                 bzero(ses->ses_octx, ses->ses_axf->ctxsize);
 387                 kfree(ses->ses_octx, M_PADLOCK);
 388                 ses->ses_octx = NULL;
 389         }
 390 }