xref: /openbmc/linux/include/crypto/internal/hash.h (revision 3908edf8)
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 {
3348fb3e57SEric Biggers 	void (*free)(struct ahash_instance *inst);
3477f7e94dSEric Biggers 	union {
3577f7e94dSEric Biggers 		struct {
3677f7e94dSEric Biggers 			char head[offsetof(struct ahash_alg, halg.base)];
3777f7e94dSEric Biggers 			struct crypto_instance base;
3877f7e94dSEric Biggers 		} s;
3901c2deceSHerbert Xu 		struct ahash_alg alg;
4001c2deceSHerbert Xu 	};
4177f7e94dSEric Biggers };
4201c2deceSHerbert Xu 
432e4fddd8SHerbert Xu struct shash_instance {
4448fb3e57SEric Biggers 	void (*free)(struct shash_instance *inst);
451b84e7d0SEric Biggers 	union {
461b84e7d0SEric Biggers 		struct {
471b84e7d0SEric Biggers 			char head[offsetof(struct shash_alg, base)];
481b84e7d0SEric Biggers 			struct crypto_instance base;
491b84e7d0SEric Biggers 		} s;
502e4fddd8SHerbert Xu 		struct shash_alg alg;
512e4fddd8SHerbert Xu 	};
521b84e7d0SEric Biggers };
532e4fddd8SHerbert Xu 
5401c2deceSHerbert Xu struct crypto_ahash_spawn {
5501c2deceSHerbert Xu 	struct crypto_spawn base;
5601c2deceSHerbert Xu };
5701c2deceSHerbert Xu 
5894296999SHerbert Xu struct crypto_shash_spawn {
5994296999SHerbert Xu 	struct crypto_spawn base;
6094296999SHerbert Xu };
6194296999SHerbert 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 
crypto_hash_walk_last(struct crypto_hash_walk * walk)6666f6ce5eSHerbert Xu static inline int crypto_hash_walk_last(struct crypto_hash_walk *walk)
6766f6ce5eSHerbert Xu {
6866f6ce5eSHerbert Xu 	return !(walk->entrylen | walk->total);
6966f6ce5eSHerbert Xu }
7066f6ce5eSHerbert Xu 
7188056ec3SHerbert Xu int crypto_register_ahash(struct ahash_alg *alg);
72c6d633a9SEric Biggers void crypto_unregister_ahash(struct ahash_alg *alg);
736f7473c5SRabin Vincent int crypto_register_ahashes(struct ahash_alg *algs, int count);
746f7473c5SRabin Vincent void crypto_unregister_ahashes(struct ahash_alg *algs, int count);
7501c2deceSHerbert Xu int ahash_register_instance(struct crypto_template *tmpl,
7601c2deceSHerbert Xu 			    struct ahash_instance *inst);
7701c2deceSHerbert Xu 
78c060e16dSEric Biggers int shash_no_setkey(struct crypto_shash *tfm, const u8 *key,
79c060e16dSEric Biggers 		    unsigned int keylen);
80c060e16dSEric Biggers 
crypto_shash_alg_has_setkey(struct shash_alg * alg)81c060e16dSEric Biggers static inline bool crypto_shash_alg_has_setkey(struct shash_alg *alg)
82c060e16dSEric Biggers {
83c060e16dSEric Biggers 	return alg->setkey != shash_no_setkey;
84c060e16dSEric Biggers }
85af3ff804SEric Biggers 
crypto_shash_alg_needs_key(struct shash_alg * alg)86c2881789SEric Biggers static inline bool crypto_shash_alg_needs_key(struct shash_alg *alg)
87c2881789SEric Biggers {
88c2881789SEric Biggers 	return crypto_shash_alg_has_setkey(alg) &&
89c2881789SEric Biggers 		!(alg->base.cra_flags & CRYPTO_ALG_OPTIONAL_KEY);
90c2881789SEric Biggers }
91c2881789SEric Biggers 
92cd6ed77aSEric Biggers bool crypto_hash_alg_has_setkey(struct hash_alg_common *halg);
93cd6ed77aSEric Biggers 
9484a9c938SEric Biggers int crypto_grab_ahash(struct crypto_ahash_spawn *spawn,
9584a9c938SEric Biggers 		      struct crypto_instance *inst,
9684a9c938SEric Biggers 		      const char *name, u32 type, u32 mask);
9784a9c938SEric Biggers 
crypto_drop_ahash(struct crypto_ahash_spawn * spawn)9852861c7cSHerbert Xu static inline void crypto_drop_ahash(struct crypto_ahash_spawn *spawn)
9952861c7cSHerbert Xu {
10052861c7cSHerbert Xu 	crypto_drop_spawn(&spawn->base);
10152861c7cSHerbert Xu }
10252861c7cSHerbert Xu 
crypto_spawn_ahash_alg(struct crypto_ahash_spawn * spawn)10384a9c938SEric Biggers static inline struct hash_alg_common *crypto_spawn_ahash_alg(
10484a9c938SEric Biggers 	struct crypto_ahash_spawn *spawn)
10584a9c938SEric Biggers {
10684a9c938SEric Biggers 	return __crypto_hash_alg_common(spawn->base.alg);
10784a9c938SEric Biggers }
10884a9c938SEric Biggers 
1097b5a080bSHerbert Xu int crypto_register_shash(struct shash_alg *alg);
110c6d633a9SEric Biggers void crypto_unregister_shash(struct shash_alg *alg);
11150fc3e8dSJussi Kivilinna int crypto_register_shashes(struct shash_alg *algs, int count);
112c6d633a9SEric Biggers void crypto_unregister_shashes(struct shash_alg *algs, int count);
113619a6ebdSHerbert Xu int shash_register_instance(struct crypto_template *tmpl,
114619a6ebdSHerbert Xu 			    struct shash_instance *inst);
115a39c66ccSEric Biggers void shash_free_singlespawn_instance(struct shash_instance *inst);
1162e4fddd8SHerbert Xu 
117fdfad1ffSEric Biggers int crypto_grab_shash(struct crypto_shash_spawn *spawn,
118fdfad1ffSEric Biggers 		      struct crypto_instance *inst,
119fdfad1ffSEric Biggers 		      const char *name, u32 type, u32 mask);
120fdfad1ffSEric Biggers 
crypto_drop_shash(struct crypto_shash_spawn * spawn)12152861c7cSHerbert Xu static inline void crypto_drop_shash(struct crypto_shash_spawn *spawn)
12252861c7cSHerbert Xu {
12352861c7cSHerbert Xu 	crypto_drop_spawn(&spawn->base);
12452861c7cSHerbert Xu }
12552861c7cSHerbert Xu 
crypto_spawn_shash_alg(struct crypto_shash_spawn * spawn)126fdfad1ffSEric Biggers static inline struct shash_alg *crypto_spawn_shash_alg(
127fdfad1ffSEric Biggers 	struct crypto_shash_spawn *spawn)
128fdfad1ffSEric Biggers {
129fdfad1ffSEric Biggers 	return __crypto_shash_alg(spawn->base.alg);
130fdfad1ffSEric Biggers }
131fdfad1ffSEric Biggers 
1327eddf95eSHerbert Xu int shash_ahash_update(struct ahash_request *req, struct shash_desc *desc);
13366f6ce5eSHerbert Xu int shash_ahash_finup(struct ahash_request *req, struct shash_desc *desc);
1347eddf95eSHerbert Xu int shash_ahash_digest(struct ahash_request *req, struct shash_desc *desc);
1357eddf95eSHerbert Xu 
crypto_ahash_ctx(struct crypto_ahash * tfm)13618e33e6dSHerbert Xu static inline void *crypto_ahash_ctx(struct crypto_ahash *tfm)
13718e33e6dSHerbert Xu {
13888056ec3SHerbert Xu 	return crypto_tfm_ctx(crypto_ahash_tfm(tfm));
13918e33e6dSHerbert Xu }
14018e33e6dSHerbert Xu 
crypto_ahash_ctx_dma(struct crypto_ahash * tfm)141b5f755fbSHerbert Xu static inline void *crypto_ahash_ctx_dma(struct crypto_ahash *tfm)
142b5f755fbSHerbert Xu {
143b5f755fbSHerbert Xu 	return crypto_tfm_ctx_dma(crypto_ahash_tfm(tfm));
144b5f755fbSHerbert Xu }
145b5f755fbSHerbert Xu 
__crypto_ahash_alg(struct crypto_alg * alg)1464dc10c01SHerbert Xu static inline struct ahash_alg *__crypto_ahash_alg(struct crypto_alg *alg)
1474dc10c01SHerbert Xu {
1484dc10c01SHerbert Xu 	return container_of(__crypto_hash_alg_common(alg), struct ahash_alg,
1494dc10c01SHerbert Xu 			    halg);
1504dc10c01SHerbert Xu }
1514dc10c01SHerbert Xu 
crypto_ahash_alg(struct crypto_ahash * hash)152*3908edf8SHerbert Xu static inline struct ahash_alg *crypto_ahash_alg(struct crypto_ahash *hash)
153*3908edf8SHerbert Xu {
154*3908edf8SHerbert Xu 	return container_of(crypto_hash_alg_common(hash), struct ahash_alg,
155*3908edf8SHerbert Xu 			    halg);
156*3908edf8SHerbert Xu }
157*3908edf8SHerbert Xu 
crypto_ahash_set_statesize(struct crypto_ahash * tfm,unsigned int size)158c7535fb2SHerbert Xu static inline void crypto_ahash_set_statesize(struct crypto_ahash *tfm,
159c7535fb2SHerbert Xu 					      unsigned int size)
160c7535fb2SHerbert Xu {
161c7535fb2SHerbert Xu 	tfm->statesize = size;
162c7535fb2SHerbert Xu }
163c7535fb2SHerbert Xu 
crypto_ahash_set_reqsize(struct crypto_ahash * tfm,unsigned int reqsize)164fc00127fSHerbert Xu static inline void crypto_ahash_set_reqsize(struct crypto_ahash *tfm,
165fc00127fSHerbert Xu 					    unsigned int reqsize)
166fc00127fSHerbert Xu {
16788056ec3SHerbert Xu 	tfm->reqsize = reqsize;
168fc00127fSHerbert Xu }
169fc00127fSHerbert Xu 
crypto_ahash_set_reqsize_dma(struct crypto_ahash * ahash,unsigned int reqsize)170b5f755fbSHerbert Xu static inline void crypto_ahash_set_reqsize_dma(struct crypto_ahash *ahash,
171b5f755fbSHerbert Xu 						unsigned int reqsize)
172b5f755fbSHerbert Xu {
173b5f755fbSHerbert Xu 	reqsize += crypto_dma_align() & ~(crypto_tfm_ctx_alignment() - 1);
174b5f755fbSHerbert Xu 	ahash->reqsize = reqsize;
175b5f755fbSHerbert Xu }
176b5f755fbSHerbert Xu 
ahash_crypto_instance(struct ahash_instance * inst)17701c2deceSHerbert Xu static inline struct crypto_instance *ahash_crypto_instance(
17801c2deceSHerbert Xu 	struct ahash_instance *inst)
17901c2deceSHerbert Xu {
18077f7e94dSEric Biggers 	return &inst->s.base;
18101c2deceSHerbert Xu }
18201c2deceSHerbert Xu 
ahash_instance(struct crypto_instance * inst)18301c2deceSHerbert Xu static inline struct ahash_instance *ahash_instance(
18401c2deceSHerbert Xu 	struct crypto_instance *inst)
18501c2deceSHerbert Xu {
18677f7e94dSEric Biggers 	return container_of(inst, struct ahash_instance, s.base);
18701c2deceSHerbert Xu }
18801c2deceSHerbert Xu 
ahash_alg_instance(struct crypto_ahash * ahash)189b00ba76aSHerbert Xu static inline struct ahash_instance *ahash_alg_instance(
190b00ba76aSHerbert Xu 	struct crypto_ahash *ahash)
191b00ba76aSHerbert Xu {
192b00ba76aSHerbert Xu 	return ahash_instance(crypto_tfm_alg_instance(&ahash->base));
193b00ba76aSHerbert Xu }
194b00ba76aSHerbert Xu 
ahash_instance_ctx(struct ahash_instance * inst)19501c2deceSHerbert Xu static inline void *ahash_instance_ctx(struct ahash_instance *inst)
19601c2deceSHerbert Xu {
19701c2deceSHerbert Xu 	return crypto_instance_ctx(ahash_crypto_instance(inst));
19801c2deceSHerbert Xu }
19901c2deceSHerbert Xu 
ahash_request_ctx_dma(struct ahash_request * req)200b5f755fbSHerbert Xu static inline void *ahash_request_ctx_dma(struct ahash_request *req)
201b5f755fbSHerbert Xu {
202b5f755fbSHerbert Xu 	unsigned int align = crypto_dma_align();
203b5f755fbSHerbert Xu 
204b5f755fbSHerbert Xu 	if (align <= crypto_tfm_ctx_alignment())
205b5f755fbSHerbert Xu 		align = 1;
206b5f755fbSHerbert Xu 
207b5f755fbSHerbert Xu 	return PTR_ALIGN(ahash_request_ctx(req), align);
208b5f755fbSHerbert Xu }
209b5f755fbSHerbert Xu 
ahash_request_complete(struct ahash_request * req,int err)210ef0579b6SHerbert Xu static inline void ahash_request_complete(struct ahash_request *req, int err)
211ef0579b6SHerbert Xu {
212d9588045SHerbert Xu 	crypto_request_complete(&req->base, err);
213ef0579b6SHerbert Xu }
214ef0579b6SHerbert Xu 
ahash_request_flags(struct ahash_request * req)215ef0579b6SHerbert Xu static inline u32 ahash_request_flags(struct ahash_request *req)
216ef0579b6SHerbert Xu {
217ef0579b6SHerbert Xu 	return req->base.flags;
218ef0579b6SHerbert Xu }
219ef0579b6SHerbert Xu 
crypto_spawn_ahash(struct crypto_ahash_spawn * spawn)22001c2deceSHerbert Xu static inline struct crypto_ahash *crypto_spawn_ahash(
22101c2deceSHerbert Xu 	struct crypto_ahash_spawn *spawn)
22201c2deceSHerbert Xu {
22301c2deceSHerbert Xu 	return crypto_spawn_tfm2(&spawn->base);
22401c2deceSHerbert Xu }
22501c2deceSHerbert Xu 
ahash_enqueue_request(struct crypto_queue * queue,struct ahash_request * request)22618e33e6dSHerbert Xu static inline int ahash_enqueue_request(struct crypto_queue *queue,
22718e33e6dSHerbert Xu 					     struct ahash_request *request)
22818e33e6dSHerbert Xu {
22918e33e6dSHerbert Xu 	return crypto_enqueue_request(queue, &request->base);
23018e33e6dSHerbert Xu }
23118e33e6dSHerbert Xu 
ahash_dequeue_request(struct crypto_queue * queue)23218e33e6dSHerbert Xu static inline struct ahash_request *ahash_dequeue_request(
23318e33e6dSHerbert Xu 	struct crypto_queue *queue)
23418e33e6dSHerbert Xu {
23518e33e6dSHerbert Xu 	return ahash_request_cast(crypto_dequeue_request(queue));
23618e33e6dSHerbert Xu }
23718e33e6dSHerbert Xu 
crypto_shash_ctx(struct crypto_shash * tfm)2387b5a080bSHerbert Xu static inline void *crypto_shash_ctx(struct crypto_shash *tfm)
2397b5a080bSHerbert Xu {
2407b5a080bSHerbert Xu 	return crypto_tfm_ctx(&tfm->base);
2417b5a080bSHerbert Xu }
2427b5a080bSHerbert Xu 
shash_crypto_instance(struct shash_instance * inst)2432e4fddd8SHerbert Xu static inline struct crypto_instance *shash_crypto_instance(
2442e4fddd8SHerbert Xu 	struct shash_instance *inst)
2452e4fddd8SHerbert Xu {
2461b84e7d0SEric Biggers 	return &inst->s.base;
2472e4fddd8SHerbert Xu }
2482e4fddd8SHerbert Xu 
shash_instance(struct crypto_instance * inst)2492e4fddd8SHerbert Xu static inline struct shash_instance *shash_instance(
2502e4fddd8SHerbert Xu 	struct crypto_instance *inst)
2512e4fddd8SHerbert Xu {
2521b84e7d0SEric Biggers 	return container_of(inst, struct shash_instance, s.base);
2532e4fddd8SHerbert Xu }
2542e4fddd8SHerbert Xu 
shash_alg_instance(struct crypto_shash * shash)255d9e1670bSHerbert Xu static inline struct shash_instance *shash_alg_instance(
256d9e1670bSHerbert Xu 	struct crypto_shash *shash)
257d9e1670bSHerbert Xu {
258d9e1670bSHerbert Xu 	return shash_instance(crypto_tfm_alg_instance(&shash->base));
259d9e1670bSHerbert Xu }
260d9e1670bSHerbert Xu 
shash_instance_ctx(struct shash_instance * inst)261ef5d590cSHerbert Xu static inline void *shash_instance_ctx(struct shash_instance *inst)
262ef5d590cSHerbert Xu {
263ef5d590cSHerbert Xu 	return crypto_instance_ctx(shash_crypto_instance(inst));
264ef5d590cSHerbert Xu }
265ef5d590cSHerbert Xu 
crypto_spawn_shash(struct crypto_shash_spawn * spawn)26694296999SHerbert Xu static inline struct crypto_shash *crypto_spawn_shash(
26794296999SHerbert Xu 	struct crypto_shash_spawn *spawn)
26894296999SHerbert Xu {
26994296999SHerbert Xu 	return crypto_spawn_tfm2(&spawn->base);
27094296999SHerbert Xu }
27194296999SHerbert Xu 
crypto_shash_ctx_aligned(struct crypto_shash * tfm)272cde6263fSHerbert Xu static inline void *crypto_shash_ctx_aligned(struct crypto_shash *tfm)
273cde6263fSHerbert Xu {
274cde6263fSHerbert Xu 	return crypto_tfm_ctx_aligned(&tfm->base);
275cde6263fSHerbert Xu }
276cde6263fSHerbert Xu 
__crypto_shash_cast(struct crypto_tfm * tfm)2770390e6aeSHerbert Xu static inline struct crypto_shash *__crypto_shash_cast(struct crypto_tfm *tfm)
2780390e6aeSHerbert Xu {
279113adefcSHerbert Xu 	return container_of(tfm, struct crypto_shash, base);
2800390e6aeSHerbert Xu }
2810390e6aeSHerbert Xu 
28220036252SHerbert Xu #endif	/* _CRYPTO_INTERNAL_HASH_H */
28320036252SHerbert Xu 
284