xref: /openbmc/linux/include/crypto/internal/hash.h (revision 84a9c938e5063709f799fd6bab17a8ea723c2eb5)
12874c5fdSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
220036252SHerbert Xu /*
320036252SHerbert Xu  * Hash algorithms.
420036252SHerbert Xu  *
520036252SHerbert Xu  * Copyright (c) 2008 Herbert Xu <herbert@gondor.apana.org.au>
620036252SHerbert Xu  */
720036252SHerbert Xu 
820036252SHerbert Xu #ifndef _CRYPTO_INTERNAL_HASH_H
920036252SHerbert Xu #define _CRYPTO_INTERNAL_HASH_H
1020036252SHerbert Xu 
1120036252SHerbert Xu #include <crypto/algapi.h>
1218e33e6dSHerbert Xu #include <crypto/hash.h>
1320036252SHerbert Xu 
1420036252SHerbert Xu struct ahash_request;
1520036252SHerbert Xu struct scatterlist;
1620036252SHerbert Xu 
1720036252SHerbert Xu struct crypto_hash_walk {
1820036252SHerbert Xu 	char *data;
1920036252SHerbert Xu 
2020036252SHerbert Xu 	unsigned int offset;
2120036252SHerbert Xu 	unsigned int alignmask;
2220036252SHerbert Xu 
2320036252SHerbert Xu 	struct page *pg;
2420036252SHerbert Xu 	unsigned int entrylen;
2520036252SHerbert Xu 
2620036252SHerbert Xu 	unsigned int total;
2720036252SHerbert Xu 	struct scatterlist *sg;
2820036252SHerbert Xu 
2920036252SHerbert Xu 	unsigned int flags;
3020036252SHerbert Xu };
3120036252SHerbert Xu 
3201c2deceSHerbert Xu struct ahash_instance {
3377f7e94dSEric Biggers 	union {
3477f7e94dSEric Biggers 		struct {
3577f7e94dSEric Biggers 			char head[offsetof(struct ahash_alg, halg.base)];
3677f7e94dSEric Biggers 			struct crypto_instance base;
3777f7e94dSEric Biggers 		} s;
3801c2deceSHerbert Xu 		struct ahash_alg alg;
3901c2deceSHerbert Xu 	};
4077f7e94dSEric Biggers };
4101c2deceSHerbert Xu 
422e4fddd8SHerbert Xu struct shash_instance {
431b84e7d0SEric Biggers 	union {
441b84e7d0SEric Biggers 		struct {
451b84e7d0SEric Biggers 			char head[offsetof(struct shash_alg, base)];
461b84e7d0SEric Biggers 			struct crypto_instance base;
471b84e7d0SEric Biggers 		} s;
482e4fddd8SHerbert Xu 		struct shash_alg alg;
492e4fddd8SHerbert Xu 	};
501b84e7d0SEric Biggers };
512e4fddd8SHerbert Xu 
5201c2deceSHerbert Xu struct crypto_ahash_spawn {
5301c2deceSHerbert Xu 	struct crypto_spawn base;
5401c2deceSHerbert Xu };
5501c2deceSHerbert Xu 
5694296999SHerbert Xu struct crypto_shash_spawn {
5794296999SHerbert Xu 	struct crypto_spawn base;
5894296999SHerbert Xu };
5994296999SHerbert Xu 
6018e33e6dSHerbert Xu extern const struct crypto_type crypto_ahash_type;
6118e33e6dSHerbert Xu 
6220036252SHerbert Xu int crypto_hash_walk_done(struct crypto_hash_walk *walk, int err);
6320036252SHerbert Xu int crypto_hash_walk_first(struct ahash_request *req,
6420036252SHerbert Xu 			   struct crypto_hash_walk *walk);
6575ecb231SHerbert Xu int crypto_ahash_walk_first(struct ahash_request *req,
6675ecb231SHerbert Xu 			   struct crypto_hash_walk *walk);
6720036252SHerbert Xu 
6875ecb231SHerbert Xu static inline int crypto_ahash_walk_done(struct crypto_hash_walk *walk,
6975ecb231SHerbert Xu 					 int err)
7075ecb231SHerbert Xu {
7175ecb231SHerbert Xu 	return crypto_hash_walk_done(walk, err);
7275ecb231SHerbert Xu }
7375ecb231SHerbert Xu 
7466f6ce5eSHerbert Xu static inline int crypto_hash_walk_last(struct crypto_hash_walk *walk)
7566f6ce5eSHerbert Xu {
7666f6ce5eSHerbert Xu 	return !(walk->entrylen | walk->total);
7766f6ce5eSHerbert Xu }
7866f6ce5eSHerbert Xu 
7975ecb231SHerbert Xu static inline int crypto_ahash_walk_last(struct crypto_hash_walk *walk)
8075ecb231SHerbert Xu {
8175ecb231SHerbert Xu 	return crypto_hash_walk_last(walk);
8275ecb231SHerbert Xu }
8375ecb231SHerbert Xu 
8488056ec3SHerbert Xu int crypto_register_ahash(struct ahash_alg *alg);
85c6d633a9SEric Biggers void crypto_unregister_ahash(struct ahash_alg *alg);
866f7473c5SRabin Vincent int crypto_register_ahashes(struct ahash_alg *algs, int count);
876f7473c5SRabin Vincent void crypto_unregister_ahashes(struct ahash_alg *algs, int count);
8801c2deceSHerbert Xu int ahash_register_instance(struct crypto_template *tmpl,
8901c2deceSHerbert Xu 			    struct ahash_instance *inst);
9001c2deceSHerbert Xu void ahash_free_instance(struct crypto_instance *inst);
9101c2deceSHerbert Xu 
92af3ff804SEric Biggers int shash_no_setkey(struct crypto_shash *tfm, const u8 *key,
93af3ff804SEric Biggers 		    unsigned int keylen);
94af3ff804SEric Biggers 
95af3ff804SEric Biggers static inline bool crypto_shash_alg_has_setkey(struct shash_alg *alg)
96af3ff804SEric Biggers {
97af3ff804SEric Biggers 	return alg->setkey != shash_no_setkey;
98af3ff804SEric Biggers }
99af3ff804SEric Biggers 
100c2881789SEric Biggers static inline bool crypto_shash_alg_needs_key(struct shash_alg *alg)
101c2881789SEric Biggers {
102c2881789SEric Biggers 	return crypto_shash_alg_has_setkey(alg) &&
103c2881789SEric Biggers 		!(alg->base.cra_flags & CRYPTO_ALG_OPTIONAL_KEY);
104c2881789SEric Biggers }
105c2881789SEric Biggers 
106cd6ed77aSEric Biggers bool crypto_hash_alg_has_setkey(struct hash_alg_common *halg);
107cd6ed77aSEric Biggers 
10801c2deceSHerbert Xu int crypto_init_ahash_spawn(struct crypto_ahash_spawn *spawn,
10901c2deceSHerbert Xu 			    struct hash_alg_common *alg,
11001c2deceSHerbert Xu 			    struct crypto_instance *inst);
11101c2deceSHerbert Xu 
112*84a9c938SEric Biggers int crypto_grab_ahash(struct crypto_ahash_spawn *spawn,
113*84a9c938SEric Biggers 		      struct crypto_instance *inst,
114*84a9c938SEric Biggers 		      const char *name, u32 type, u32 mask);
115*84a9c938SEric Biggers 
11652861c7cSHerbert Xu static inline void crypto_drop_ahash(struct crypto_ahash_spawn *spawn)
11752861c7cSHerbert Xu {
11852861c7cSHerbert Xu 	crypto_drop_spawn(&spawn->base);
11952861c7cSHerbert Xu }
12052861c7cSHerbert Xu 
121*84a9c938SEric Biggers static inline struct hash_alg_common *crypto_spawn_ahash_alg(
122*84a9c938SEric Biggers 	struct crypto_ahash_spawn *spawn)
123*84a9c938SEric Biggers {
124*84a9c938SEric Biggers 	return __crypto_hash_alg_common(spawn->base.alg);
125*84a9c938SEric Biggers }
126*84a9c938SEric Biggers 
12701c2deceSHerbert Xu struct hash_alg_common *ahash_attr_alg(struct rtattr *rta, u32 type, u32 mask);
12888056ec3SHerbert Xu 
1297b5a080bSHerbert Xu int crypto_register_shash(struct shash_alg *alg);
130c6d633a9SEric Biggers void crypto_unregister_shash(struct shash_alg *alg);
13150fc3e8dSJussi Kivilinna int crypto_register_shashes(struct shash_alg *algs, int count);
132c6d633a9SEric Biggers void crypto_unregister_shashes(struct shash_alg *algs, int count);
133619a6ebdSHerbert Xu int shash_register_instance(struct crypto_template *tmpl,
134619a6ebdSHerbert Xu 			    struct shash_instance *inst);
1352e4fddd8SHerbert Xu void shash_free_instance(struct crypto_instance *inst);
1362e4fddd8SHerbert Xu 
13794296999SHerbert Xu int crypto_init_shash_spawn(struct crypto_shash_spawn *spawn,
13894296999SHerbert Xu 			    struct shash_alg *alg,
13994296999SHerbert Xu 			    struct crypto_instance *inst);
14094296999SHerbert Xu 
141fdfad1ffSEric Biggers int crypto_grab_shash(struct crypto_shash_spawn *spawn,
142fdfad1ffSEric Biggers 		      struct crypto_instance *inst,
143fdfad1ffSEric Biggers 		      const char *name, u32 type, u32 mask);
144fdfad1ffSEric Biggers 
14552861c7cSHerbert Xu static inline void crypto_drop_shash(struct crypto_shash_spawn *spawn)
14652861c7cSHerbert Xu {
14752861c7cSHerbert Xu 	crypto_drop_spawn(&spawn->base);
14852861c7cSHerbert Xu }
14952861c7cSHerbert Xu 
150fdfad1ffSEric Biggers static inline struct shash_alg *crypto_spawn_shash_alg(
151fdfad1ffSEric Biggers 	struct crypto_shash_spawn *spawn)
152fdfad1ffSEric Biggers {
153fdfad1ffSEric Biggers 	return __crypto_shash_alg(spawn->base.alg);
154fdfad1ffSEric Biggers }
155fdfad1ffSEric Biggers 
1567d6f5640SHerbert Xu struct shash_alg *shash_attr_alg(struct rtattr *rta, u32 type, u32 mask);
1577d6f5640SHerbert Xu 
1587eddf95eSHerbert Xu int shash_ahash_update(struct ahash_request *req, struct shash_desc *desc);
15966f6ce5eSHerbert Xu int shash_ahash_finup(struct ahash_request *req, struct shash_desc *desc);
1607eddf95eSHerbert Xu int shash_ahash_digest(struct ahash_request *req, struct shash_desc *desc);
1617eddf95eSHerbert Xu 
16288056ec3SHerbert Xu int crypto_init_shash_ops_async(struct crypto_tfm *tfm);
16388056ec3SHerbert Xu 
16418e33e6dSHerbert Xu static inline void *crypto_ahash_ctx(struct crypto_ahash *tfm)
16518e33e6dSHerbert Xu {
16688056ec3SHerbert Xu 	return crypto_tfm_ctx(crypto_ahash_tfm(tfm));
16718e33e6dSHerbert Xu }
16818e33e6dSHerbert Xu 
1694dc10c01SHerbert Xu static inline struct ahash_alg *__crypto_ahash_alg(struct crypto_alg *alg)
1704dc10c01SHerbert Xu {
1714dc10c01SHerbert Xu 	return container_of(__crypto_hash_alg_common(alg), struct ahash_alg,
1724dc10c01SHerbert Xu 			    halg);
1734dc10c01SHerbert Xu }
1744dc10c01SHerbert Xu 
175fc00127fSHerbert Xu static inline void crypto_ahash_set_reqsize(struct crypto_ahash *tfm,
176fc00127fSHerbert Xu 					    unsigned int reqsize)
177fc00127fSHerbert Xu {
17888056ec3SHerbert Xu 	tfm->reqsize = reqsize;
179fc00127fSHerbert Xu }
180fc00127fSHerbert Xu 
18101c2deceSHerbert Xu static inline struct crypto_instance *ahash_crypto_instance(
18201c2deceSHerbert Xu 	struct ahash_instance *inst)
18301c2deceSHerbert Xu {
18477f7e94dSEric Biggers 	return &inst->s.base;
18501c2deceSHerbert Xu }
18601c2deceSHerbert Xu 
18701c2deceSHerbert Xu static inline struct ahash_instance *ahash_instance(
18801c2deceSHerbert Xu 	struct crypto_instance *inst)
18901c2deceSHerbert Xu {
19077f7e94dSEric Biggers 	return container_of(inst, struct ahash_instance, s.base);
19101c2deceSHerbert Xu }
19201c2deceSHerbert Xu 
19301c2deceSHerbert Xu static inline void *ahash_instance_ctx(struct ahash_instance *inst)
19401c2deceSHerbert Xu {
19501c2deceSHerbert Xu 	return crypto_instance_ctx(ahash_crypto_instance(inst));
19601c2deceSHerbert Xu }
19701c2deceSHerbert Xu 
19801c2deceSHerbert Xu static inline unsigned int ahash_instance_headroom(void)
19901c2deceSHerbert Xu {
20001c2deceSHerbert Xu 	return sizeof(struct ahash_alg) - sizeof(struct crypto_alg);
20101c2deceSHerbert Xu }
20201c2deceSHerbert Xu 
20301c2deceSHerbert Xu static inline struct ahash_instance *ahash_alloc_instance(
20401c2deceSHerbert Xu 	const char *name, struct crypto_alg *alg)
20501c2deceSHerbert Xu {
20614aa1a83SEric Biggers 	return crypto_alloc_instance(name, alg, ahash_instance_headroom());
20701c2deceSHerbert Xu }
20801c2deceSHerbert Xu 
209ef0579b6SHerbert Xu static inline void ahash_request_complete(struct ahash_request *req, int err)
210ef0579b6SHerbert Xu {
211ef0579b6SHerbert Xu 	req->base.complete(&req->base, err);
212ef0579b6SHerbert Xu }
213ef0579b6SHerbert Xu 
214ef0579b6SHerbert Xu static inline u32 ahash_request_flags(struct ahash_request *req)
215ef0579b6SHerbert Xu {
216ef0579b6SHerbert Xu 	return req->base.flags;
217ef0579b6SHerbert Xu }
218ef0579b6SHerbert Xu 
21901c2deceSHerbert Xu static inline struct crypto_ahash *crypto_spawn_ahash(
22001c2deceSHerbert Xu 	struct crypto_ahash_spawn *spawn)
22101c2deceSHerbert Xu {
22201c2deceSHerbert Xu 	return crypto_spawn_tfm2(&spawn->base);
22301c2deceSHerbert Xu }
22401c2deceSHerbert Xu 
22518e33e6dSHerbert Xu static inline int ahash_enqueue_request(struct crypto_queue *queue,
22618e33e6dSHerbert Xu 					     struct ahash_request *request)
22718e33e6dSHerbert Xu {
22818e33e6dSHerbert Xu 	return crypto_enqueue_request(queue, &request->base);
22918e33e6dSHerbert Xu }
23018e33e6dSHerbert Xu 
23118e33e6dSHerbert Xu static inline struct ahash_request *ahash_dequeue_request(
23218e33e6dSHerbert Xu 	struct crypto_queue *queue)
23318e33e6dSHerbert Xu {
23418e33e6dSHerbert Xu 	return ahash_request_cast(crypto_dequeue_request(queue));
23518e33e6dSHerbert Xu }
23618e33e6dSHerbert Xu 
2377b5a080bSHerbert Xu static inline void *crypto_shash_ctx(struct crypto_shash *tfm)
2387b5a080bSHerbert Xu {
2397b5a080bSHerbert Xu 	return crypto_tfm_ctx(&tfm->base);
2407b5a080bSHerbert Xu }
2417b5a080bSHerbert Xu 
2422e4fddd8SHerbert Xu static inline struct crypto_instance *shash_crypto_instance(
2432e4fddd8SHerbert Xu 	struct shash_instance *inst)
2442e4fddd8SHerbert Xu {
2451b84e7d0SEric Biggers 	return &inst->s.base;
2462e4fddd8SHerbert Xu }
2472e4fddd8SHerbert Xu 
2482e4fddd8SHerbert Xu static inline struct shash_instance *shash_instance(
2492e4fddd8SHerbert Xu 	struct crypto_instance *inst)
2502e4fddd8SHerbert Xu {
2511b84e7d0SEric Biggers 	return container_of(inst, struct shash_instance, s.base);
2522e4fddd8SHerbert Xu }
2532e4fddd8SHerbert Xu 
254d9e1670bSHerbert Xu static inline struct shash_instance *shash_alg_instance(
255d9e1670bSHerbert Xu 	struct crypto_shash *shash)
256d9e1670bSHerbert Xu {
257d9e1670bSHerbert Xu 	return shash_instance(crypto_tfm_alg_instance(&shash->base));
258d9e1670bSHerbert Xu }
259d9e1670bSHerbert Xu 
260ef5d590cSHerbert Xu static inline void *shash_instance_ctx(struct shash_instance *inst)
261ef5d590cSHerbert Xu {
262ef5d590cSHerbert Xu 	return crypto_instance_ctx(shash_crypto_instance(inst));
263ef5d590cSHerbert Xu }
264ef5d590cSHerbert Xu 
2652e4fddd8SHerbert Xu static inline struct shash_instance *shash_alloc_instance(
2662e4fddd8SHerbert Xu 	const char *name, struct crypto_alg *alg)
2672e4fddd8SHerbert Xu {
26814aa1a83SEric Biggers 	return crypto_alloc_instance(name, alg,
2692e4fddd8SHerbert Xu 				     sizeof(struct shash_alg) - sizeof(*alg));
2702e4fddd8SHerbert Xu }
2712e4fddd8SHerbert Xu 
27294296999SHerbert Xu static inline struct crypto_shash *crypto_spawn_shash(
27394296999SHerbert Xu 	struct crypto_shash_spawn *spawn)
27494296999SHerbert Xu {
27594296999SHerbert Xu 	return crypto_spawn_tfm2(&spawn->base);
27694296999SHerbert Xu }
27794296999SHerbert Xu 
278cde6263fSHerbert Xu static inline void *crypto_shash_ctx_aligned(struct crypto_shash *tfm)
279cde6263fSHerbert Xu {
280cde6263fSHerbert Xu 	return crypto_tfm_ctx_aligned(&tfm->base);
281cde6263fSHerbert Xu }
282cde6263fSHerbert Xu 
2830390e6aeSHerbert Xu static inline struct crypto_shash *__crypto_shash_cast(struct crypto_tfm *tfm)
2840390e6aeSHerbert Xu {
285113adefcSHerbert Xu 	return container_of(tfm, struct crypto_shash, base);
2860390e6aeSHerbert Xu }
2870390e6aeSHerbert Xu 
28820036252SHerbert Xu #endif	/* _CRYPTO_INTERNAL_HASH_H */
28920036252SHerbert Xu 
290