]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
crypto: hmac - Add ahash support
authorHerbert Xu <herbert@gondor.apana.org.au>
Thu, 15 May 2025 05:54:51 +0000 (13:54 +0800)
committerHerbert Xu <herbert@gondor.apana.org.au>
Mon, 19 May 2025 05:48:20 +0000 (13:48 +0800)
Add ahash support to hmac so that drivers that can't do hmac in
hardware do not have to implement duplicate copies of hmac.

Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
crypto/ahash.c
crypto/hmac.c
include/crypto/hash.h
include/crypto/internal/hash.h

index bf8375bb32c98684ce5c9f62f70b49f55fdeead1..e10bc2659ae4f559504dbf7cfb7ab258b0bb99d9 100644 (file)
@@ -846,7 +846,7 @@ int crypto_has_ahash(const char *alg_name, u32 type, u32 mask)
 }
 EXPORT_SYMBOL_GPL(crypto_has_ahash);
 
-static bool crypto_hash_alg_has_setkey(struct hash_alg_common *halg)
+bool crypto_hash_alg_has_setkey(struct hash_alg_common *halg)
 {
        struct crypto_alg *alg = &halg->base;
 
@@ -855,6 +855,7 @@ static bool crypto_hash_alg_has_setkey(struct hash_alg_common *halg)
 
        return __crypto_ahash_alg(alg)->setkey != ahash_nosetkey;
 }
+EXPORT_SYMBOL_GPL(crypto_hash_alg_has_setkey);
 
 struct crypto_ahash *crypto_clone_ahash(struct crypto_ahash *hash)
 {
@@ -1077,5 +1078,12 @@ int crypto_hash_digest(struct crypto_ahash *tfm, const u8 *data,
 }
 EXPORT_SYMBOL_GPL(crypto_hash_digest);
 
+void ahash_free_singlespawn_instance(struct ahash_instance *inst)
+{
+       crypto_drop_spawn(ahash_instance_ctx(inst));
+       kfree(inst);
+}
+EXPORT_SYMBOL_GPL(ahash_free_singlespawn_instance);
+
 MODULE_LICENSE("GPL");
 MODULE_DESCRIPTION("Asynchronous cryptographic hash type");
index e4749a1f93ddda3b44d3e3ded1b562ebe14a957f..148af460ae974351ce3d58c8f0ca9c44d9273fe7 100644 (file)
@@ -26,6 +26,12 @@ struct hmac_ctx {
        u8 pads[];
 };
 
+struct ahash_hmac_ctx {
+       struct crypto_ahash *hash;
+       /* Contains 'u8 ipad[statesize];', then 'u8 opad[statesize];' */
+       u8 pads[];
+};
+
 static int hmac_setkey(struct crypto_shash *parent,
                       const u8 *inkey, unsigned int keylen)
 {
@@ -173,21 +179,17 @@ static void hmac_exit_tfm(struct crypto_shash *parent)
        crypto_free_shash(tctx->hash);
 }
 
-static int hmac_create(struct crypto_template *tmpl, struct rtattr **tb)
+static int __hmac_create_shash(struct crypto_template *tmpl,
+                              struct rtattr **tb, u32 mask)
 {
        struct shash_instance *inst;
        struct crypto_shash_spawn *spawn;
        struct crypto_alg *alg;
        struct shash_alg *salg;
-       u32 mask;
        int err;
        int ds;
        int ss;
 
-       err = crypto_check_attr_type(tb, CRYPTO_ALG_TYPE_SHASH, &mask);
-       if (err)
-               return err;
-
        inst = kzalloc(sizeof(*inst) + sizeof(*spawn), GFP_KERNEL);
        if (!inst)
                return -ENOMEM;
@@ -212,7 +214,8 @@ static int hmac_create(struct crypto_template *tmpl, struct rtattr **tb)
            ss < alg->cra_blocksize)
                goto err_free_inst;
 
-       err = crypto_inst_setname(shash_crypto_instance(inst), tmpl->name, alg);
+       err = crypto_inst_setname(shash_crypto_instance(inst), "hmac",
+                                 "hmac-shash", alg);
        if (err)
                goto err_free_inst;
 
@@ -245,20 +248,329 @@ err_free_inst:
        return err;
 }
 
-static struct crypto_template hmac_tmpl = {
-       .name = "hmac",
-       .create = hmac_create,
-       .module = THIS_MODULE,
+static int hmac_setkey_ahash(struct crypto_ahash *parent,
+                            const u8 *inkey, unsigned int keylen)
+{
+       struct ahash_hmac_ctx *tctx = crypto_ahash_ctx(parent);
+       struct crypto_ahash *fb = crypto_ahash_fb(tctx->hash);
+       int ds = crypto_ahash_digestsize(parent);
+       int bs = crypto_ahash_blocksize(parent);
+       int ss = crypto_ahash_statesize(parent);
+       HASH_REQUEST_ON_STACK(req, fb);
+       u8 *opad = &tctx->pads[ss];
+       u8 *ipad = &tctx->pads[0];
+       int err, i;
+
+       if (fips_enabled && (keylen < 112 / 8))
+               return -EINVAL;
+
+       ahash_request_set_callback(req, 0, NULL, NULL);
+
+       if (keylen > bs) {
+               ahash_request_set_virt(req, inkey, ipad, keylen);
+               err = crypto_ahash_digest(req);
+               if (err)
+                       goto out_zero_req;
+
+               keylen = ds;
+       } else
+               memcpy(ipad, inkey, keylen);
+
+       memset(ipad + keylen, 0, bs - keylen);
+       memcpy(opad, ipad, bs);
+
+       for (i = 0; i < bs; i++) {
+               ipad[i] ^= HMAC_IPAD_VALUE;
+               opad[i] ^= HMAC_OPAD_VALUE;
+       }
+
+       ahash_request_set_virt(req, ipad, NULL, bs);
+       err = crypto_ahash_init(req) ?:
+             crypto_ahash_update(req) ?:
+             crypto_ahash_export(req, ipad);
+
+       ahash_request_set_virt(req, opad, NULL, bs);
+       err = err ?:
+             crypto_ahash_init(req) ?:
+             crypto_ahash_update(req) ?:
+             crypto_ahash_export(req, opad);
+
+out_zero_req:
+       HASH_REQUEST_ZERO(req);
+       return err;
+}
+
+static int hmac_export_ahash(struct ahash_request *preq, void *out)
+{
+       return crypto_ahash_export(ahash_request_ctx(preq), out);
+}
+
+static int hmac_import_ahash(struct ahash_request *preq, const void *in)
+{
+       struct crypto_ahash *tfm = crypto_ahash_reqtfm(preq);
+       struct ahash_hmac_ctx *tctx = crypto_ahash_ctx(tfm);
+       struct ahash_request *req = ahash_request_ctx(preq);
+
+       ahash_request_set_tfm(req, tctx->hash);
+       return crypto_ahash_import(req, in);
+}
+
+static int hmac_export_core_ahash(struct ahash_request *preq, void *out)
+{
+       return crypto_ahash_export_core(ahash_request_ctx(preq), out);
+}
+
+static int hmac_import_core_ahash(struct ahash_request *preq, const void *in)
+{
+       struct crypto_ahash *tfm = crypto_ahash_reqtfm(preq);
+       struct ahash_hmac_ctx *tctx = crypto_ahash_ctx(tfm);
+       struct ahash_request *req = ahash_request_ctx(preq);
+
+       ahash_request_set_tfm(req, tctx->hash);
+       return crypto_ahash_import_core(req, in);
+}
+
+static int hmac_init_ahash(struct ahash_request *preq)
+{
+       struct crypto_ahash *tfm = crypto_ahash_reqtfm(preq);
+       struct ahash_hmac_ctx *tctx = crypto_ahash_ctx(tfm);
+
+       return hmac_import_ahash(preq, &tctx->pads[0]);
+}
+
+static int hmac_update_ahash(struct ahash_request *preq)
+{
+       struct ahash_request *req = ahash_request_ctx(preq);
+
+       ahash_request_set_callback(req, ahash_request_flags(preq),
+                                  preq->base.complete, preq->base.data);
+       if (ahash_request_isvirt(preq))
+               ahash_request_set_virt(req, preq->svirt, NULL, preq->nbytes);
+       else
+               ahash_request_set_crypt(req, preq->src, NULL, preq->nbytes);
+       return crypto_ahash_update(req);
+}
+
+static int hmac_finup_finish(struct ahash_request *preq, unsigned int mask)
+{
+       struct crypto_ahash *tfm = crypto_ahash_reqtfm(preq);
+       struct ahash_request *req = ahash_request_ctx(preq);
+       struct ahash_hmac_ctx *tctx = crypto_ahash_ctx(tfm);
+       int ds = crypto_ahash_digestsize(tfm);
+       int ss = crypto_ahash_statesize(tfm);
+       const u8 *opad = &tctx->pads[ss];
+
+       ahash_request_set_callback(req, ahash_request_flags(preq) & ~mask,
+                                  preq->base.complete, preq->base.data);
+       ahash_request_set_virt(req, preq->result, preq->result, ds);
+       return crypto_ahash_import(req, opad) ?:
+              crypto_ahash_finup(req);
+
+}
+
+static void hmac_finup_done(void *data, int err)
+{
+       struct ahash_request *preq = data;
+
+       if (err)
+               goto out;
+
+       err = hmac_finup_finish(preq, CRYPTO_TFM_REQ_MAY_SLEEP);
+       if (err == -EINPROGRESS || err == -EBUSY)
+               return;
+
+out:
+       ahash_request_complete(preq, err);
+}
+
+static int hmac_finup_ahash(struct ahash_request *preq)
+{
+       struct ahash_request *req = ahash_request_ctx(preq);
+
+       ahash_request_set_callback(req, ahash_request_flags(preq),
+                                  hmac_finup_done, preq);
+       if (ahash_request_isvirt(preq))
+               ahash_request_set_virt(req, preq->svirt, preq->result,
+                                      preq->nbytes);
+       else
+               ahash_request_set_crypt(req, preq->src, preq->result,
+                                       preq->nbytes);
+       return crypto_ahash_finup(req) ?:
+              hmac_finup_finish(preq, 0);
+}
+
+static int hmac_digest_ahash(struct ahash_request *preq)
+{
+       return hmac_init_ahash(preq) ?:
+              hmac_finup_ahash(preq);
+}
+
+static int hmac_init_ahash_tfm(struct crypto_ahash *parent)
+{
+       struct ahash_instance *inst = ahash_alg_instance(parent);
+       struct ahash_hmac_ctx *tctx = crypto_ahash_ctx(parent);
+       struct crypto_ahash *hash;
+
+       hash = crypto_spawn_ahash(ahash_instance_ctx(inst));
+       if (IS_ERR(hash))
+               return PTR_ERR(hash);
+
+       if (crypto_ahash_reqsize(parent) < sizeof(struct ahash_request) +
+                                          crypto_ahash_reqsize(hash))
+               return -EINVAL;
+
+       tctx->hash = hash;
+       return 0;
+}
+
+static int hmac_clone_ahash_tfm(struct crypto_ahash *dst,
+                               struct crypto_ahash *src)
+{
+       struct ahash_hmac_ctx *sctx = crypto_ahash_ctx(src);
+       struct ahash_hmac_ctx *dctx = crypto_ahash_ctx(dst);
+       struct crypto_ahash *hash;
+
+       hash = crypto_clone_ahash(sctx->hash);
+       if (IS_ERR(hash))
+               return PTR_ERR(hash);
+
+       dctx->hash = hash;
+       return 0;
+}
+
+static void hmac_exit_ahash_tfm(struct crypto_ahash *parent)
+{
+       struct ahash_hmac_ctx *tctx = crypto_ahash_ctx(parent);
+
+       crypto_free_ahash(tctx->hash);
+}
+
+static int hmac_create_ahash(struct crypto_template *tmpl, struct rtattr **tb,
+                            u32 mask)
+{
+       struct crypto_ahash_spawn *spawn;
+       struct ahash_instance *inst;
+       struct crypto_alg *alg;
+       struct hash_alg_common *halg;
+       int ds, ss, err;
+
+       inst = kzalloc(sizeof(*inst) + sizeof(*spawn), GFP_KERNEL);
+       if (!inst)
+               return -ENOMEM;
+       spawn = ahash_instance_ctx(inst);
+
+       mask |= CRYPTO_AHASH_ALG_NO_EXPORT_CORE;
+       err = crypto_grab_ahash(spawn, ahash_crypto_instance(inst),
+                               crypto_attr_alg_name(tb[1]), 0, mask);
+       if (err)
+               goto err_free_inst;
+       halg = crypto_spawn_ahash_alg(spawn);
+       alg = &halg->base;
+
+       /* The underlying hash algorithm must not require a key */
+       err = -EINVAL;
+       if (crypto_hash_alg_needs_key(halg))
+               goto err_free_inst;
+
+       ds = halg->digestsize;
+       ss = halg->statesize;
+       if (ds > alg->cra_blocksize || ss < alg->cra_blocksize)
+               goto err_free_inst;
+
+       err = crypto_inst_setname(ahash_crypto_instance(inst), tmpl->name, alg);
+       if (err)
+               goto err_free_inst;
+
+       inst->alg.halg.base.cra_flags = alg->cra_flags &
+                                       CRYPTO_ALG_INHERITED_FLAGS;
+       inst->alg.halg.base.cra_flags |= CRYPTO_ALG_REQ_VIRT;
+       inst->alg.halg.base.cra_priority = alg->cra_priority + 100;
+       inst->alg.halg.base.cra_blocksize = alg->cra_blocksize;
+       inst->alg.halg.base.cra_ctxsize = sizeof(struct ahash_hmac_ctx) +
+                                         (ss * 2);
+       inst->alg.halg.base.cra_reqsize = sizeof(struct ahash_request) +
+                                         alg->cra_reqsize;
+
+       inst->alg.halg.digestsize = ds;
+       inst->alg.halg.statesize = ss;
+       inst->alg.init = hmac_init_ahash;
+       inst->alg.update = hmac_update_ahash;
+       inst->alg.finup = hmac_finup_ahash;
+       inst->alg.digest = hmac_digest_ahash;
+       inst->alg.export = hmac_export_ahash;
+       inst->alg.import = hmac_import_ahash;
+       inst->alg.export_core = hmac_export_core_ahash;
+       inst->alg.import_core = hmac_import_core_ahash;
+       inst->alg.setkey = hmac_setkey_ahash;
+       inst->alg.init_tfm = hmac_init_ahash_tfm;
+       inst->alg.clone_tfm = hmac_clone_ahash_tfm;
+       inst->alg.exit_tfm = hmac_exit_ahash_tfm;
+
+       inst->free = ahash_free_singlespawn_instance;
+
+       err = ahash_register_instance(tmpl, inst);
+       if (err) {
+err_free_inst:
+               ahash_free_singlespawn_instance(inst);
+       }
+       return err;
+}
+
+static int hmac_create(struct crypto_template *tmpl, struct rtattr **tb)
+{
+       struct crypto_attr_type *algt;
+       u32 mask;
+
+       algt = crypto_get_attr_type(tb);
+       if (IS_ERR(algt))
+               return PTR_ERR(algt);
+
+       mask = crypto_algt_inherited_mask(algt);
+
+       if (!((algt->type ^ CRYPTO_ALG_TYPE_AHASH) &
+             algt->mask & CRYPTO_ALG_TYPE_MASK))
+               return hmac_create_ahash(tmpl, tb, mask);
+
+       if ((algt->type ^ CRYPTO_ALG_TYPE_SHASH) &
+           algt->mask & CRYPTO_ALG_TYPE_MASK)
+               return -EINVAL;
+
+       return __hmac_create_shash(tmpl, tb, mask);
+}
+
+static int hmac_create_shash(struct crypto_template *tmpl, struct rtattr **tb)
+{
+       u32 mask;
+       int err;
+
+       err = crypto_check_attr_type(tb, CRYPTO_ALG_TYPE_SHASH, &mask);
+       if (err)
+               return err == -EINVAL ? -ENOENT : err;
+
+       return __hmac_create_shash(tmpl, tb, mask);
+}
+
+static struct crypto_template hmac_tmpls[] = {
+       {
+               .name = "hmac",
+               .create = hmac_create,
+               .module = THIS_MODULE,
+       },
+       {
+               .name = "hmac-shash",
+               .create = hmac_create_shash,
+               .module = THIS_MODULE,
+       },
 };
 
 static int __init hmac_module_init(void)
 {
-       return crypto_register_template(&hmac_tmpl);
+       return crypto_register_templates(hmac_tmpls, ARRAY_SIZE(hmac_tmpls));
 }
 
 static void __exit hmac_module_exit(void)
 {
-       crypto_unregister_template(&hmac_tmpl);
+       crypto_unregister_templates(hmac_tmpls, ARRAY_SIZE(hmac_tmpls));
 }
 
 module_init(hmac_module_init);
index 05ee817a3180a8de69d70a5e5e24ae1c7ab72a68..6f6b9de12cd323d61f86808bbf9dd4ae7b4cbb2f 100644 (file)
@@ -185,7 +185,8 @@ struct shash_desc {
  * containing a 'struct s390_sha_ctx'.
  */
 #define HASH_MAX_DESCSIZE      (sizeof(struct shash_desc) + 360)
-#define MAX_SYNC_HASH_REQSIZE  HASH_MAX_DESCSIZE
+#define MAX_SYNC_HASH_REQSIZE  (sizeof(struct ahash_request) + \
+                                HASH_MAX_DESCSIZE)
 
 #define SHASH_DESC_ON_STACK(shash, ctx)                                             \
        char __##shash##_desc[sizeof(struct shash_desc) + HASH_MAX_DESCSIZE] \
index e9de2bc34a1002555b3b0b6eeb8ddd96237542d4..0f85c543f80bf497461a17c14e40daca8041f8b2 100644 (file)
@@ -67,6 +67,7 @@ int crypto_register_ahashes(struct ahash_alg *algs, int count);
 void crypto_unregister_ahashes(struct ahash_alg *algs, int count);
 int ahash_register_instance(struct crypto_template *tmpl,
                            struct ahash_instance *inst);
+void ahash_free_singlespawn_instance(struct ahash_instance *inst);
 
 int shash_no_setkey(struct crypto_shash *tfm, const u8 *key,
                    unsigned int keylen);
@@ -76,12 +77,20 @@ static inline bool crypto_shash_alg_has_setkey(struct shash_alg *alg)
        return alg->setkey != shash_no_setkey;
 }
 
+bool crypto_hash_alg_has_setkey(struct hash_alg_common *halg);
+
 static inline bool crypto_shash_alg_needs_key(struct shash_alg *alg)
 {
        return crypto_shash_alg_has_setkey(alg) &&
                !(alg->base.cra_flags & CRYPTO_ALG_OPTIONAL_KEY);
 }
 
+static inline bool crypto_hash_alg_needs_key(struct hash_alg_common *alg)
+{
+       return crypto_hash_alg_has_setkey(alg) &&
+               !(alg->base.cra_flags & CRYPTO_ALG_OPTIONAL_KEY);
+}
+
 int crypto_grab_ahash(struct crypto_ahash_spawn *spawn,
                      struct crypto_instance *inst,
                      const char *name, u32 type, u32 mask);