xref: /openbmc/linux/include/crypto/internal/hash.h (revision fdfad1ff)
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 
11252861c7cSHerbert Xu static inline void crypto_drop_ahash(struct crypto_ahash_spawn *spawn)
11352861c7cSHerbert Xu {
11452861c7cSHerbert Xu 	crypto_drop_spawn(&spawn->base);
11552861c7cSHerbert Xu }
11652861c7cSHerbert Xu 
11701c2deceSHerbert Xu struct hash_alg_common *ahash_attr_alg(struct rtattr *rta, u32 type, u32 mask);
11888056ec3SHerbert Xu 
1197b5a080bSHerbert Xu int crypto_register_shash(struct shash_alg *alg);
120c6d633a9SEric Biggers void crypto_unregister_shash(struct shash_alg *alg);
12150fc3e8dSJussi Kivilinna int crypto_register_shashes(struct shash_alg *algs, int count);
122c6d633a9SEric Biggers void crypto_unregister_shashes(struct shash_alg *algs, int count);
123619a6ebdSHerbert Xu int shash_register_instance(struct crypto_template *tmpl,
124619a6ebdSHerbert Xu 			    struct shash_instance *inst);
1252e4fddd8SHerbert Xu void shash_free_instance(struct crypto_instance *inst);
1262e4fddd8SHerbert Xu 
12794296999SHerbert Xu int crypto_init_shash_spawn(struct crypto_shash_spawn *spawn,
12894296999SHerbert Xu 			    struct shash_alg *alg,
12994296999SHerbert Xu 			    struct crypto_instance *inst);
13094296999SHerbert Xu 
131fdfad1ffSEric Biggers int crypto_grab_shash(struct crypto_shash_spawn *spawn,
132fdfad1ffSEric Biggers 		      struct crypto_instance *inst,
133fdfad1ffSEric Biggers 		      const char *name, u32 type, u32 mask);
134fdfad1ffSEric Biggers 
13552861c7cSHerbert Xu static inline void crypto_drop_shash(struct crypto_shash_spawn *spawn)
13652861c7cSHerbert Xu {
13752861c7cSHerbert Xu 	crypto_drop_spawn(&spawn->base);
13852861c7cSHerbert Xu }
13952861c7cSHerbert Xu 
140fdfad1ffSEric Biggers static inline struct shash_alg *crypto_spawn_shash_alg(
141fdfad1ffSEric Biggers 	struct crypto_shash_spawn *spawn)
142fdfad1ffSEric Biggers {
143fdfad1ffSEric Biggers 	return __crypto_shash_alg(spawn->base.alg);
144fdfad1ffSEric Biggers }
145fdfad1ffSEric Biggers 
1467d6f5640SHerbert Xu struct shash_alg *shash_attr_alg(struct rtattr *rta, u32 type, u32 mask);
1477d6f5640SHerbert Xu 
1487eddf95eSHerbert Xu int shash_ahash_update(struct ahash_request *req, struct shash_desc *desc);
14966f6ce5eSHerbert Xu int shash_ahash_finup(struct ahash_request *req, struct shash_desc *desc);
1507eddf95eSHerbert Xu int shash_ahash_digest(struct ahash_request *req, struct shash_desc *desc);
1517eddf95eSHerbert Xu 
15288056ec3SHerbert Xu int crypto_init_shash_ops_async(struct crypto_tfm *tfm);
15388056ec3SHerbert Xu 
15418e33e6dSHerbert Xu static inline void *crypto_ahash_ctx(struct crypto_ahash *tfm)
15518e33e6dSHerbert Xu {
15688056ec3SHerbert Xu 	return crypto_tfm_ctx(crypto_ahash_tfm(tfm));
15718e33e6dSHerbert Xu }
15818e33e6dSHerbert Xu 
1594dc10c01SHerbert Xu static inline struct ahash_alg *__crypto_ahash_alg(struct crypto_alg *alg)
1604dc10c01SHerbert Xu {
1614dc10c01SHerbert Xu 	return container_of(__crypto_hash_alg_common(alg), struct ahash_alg,
1624dc10c01SHerbert Xu 			    halg);
1634dc10c01SHerbert Xu }
1644dc10c01SHerbert Xu 
165fc00127fSHerbert Xu static inline void crypto_ahash_set_reqsize(struct crypto_ahash *tfm,
166fc00127fSHerbert Xu 					    unsigned int reqsize)
167fc00127fSHerbert Xu {
16888056ec3SHerbert Xu 	tfm->reqsize = reqsize;
169fc00127fSHerbert Xu }
170fc00127fSHerbert Xu 
17101c2deceSHerbert Xu static inline struct crypto_instance *ahash_crypto_instance(
17201c2deceSHerbert Xu 	struct ahash_instance *inst)
17301c2deceSHerbert Xu {
17477f7e94dSEric Biggers 	return &inst->s.base;
17501c2deceSHerbert Xu }
17601c2deceSHerbert Xu 
17701c2deceSHerbert Xu static inline struct ahash_instance *ahash_instance(
17801c2deceSHerbert Xu 	struct crypto_instance *inst)
17901c2deceSHerbert Xu {
18077f7e94dSEric Biggers 	return container_of(inst, struct ahash_instance, s.base);
18101c2deceSHerbert Xu }
18201c2deceSHerbert Xu 
18301c2deceSHerbert Xu static inline void *ahash_instance_ctx(struct ahash_instance *inst)
18401c2deceSHerbert Xu {
18501c2deceSHerbert Xu 	return crypto_instance_ctx(ahash_crypto_instance(inst));
18601c2deceSHerbert Xu }
18701c2deceSHerbert Xu 
18801c2deceSHerbert Xu static inline unsigned int ahash_instance_headroom(void)
18901c2deceSHerbert Xu {
19001c2deceSHerbert Xu 	return sizeof(struct ahash_alg) - sizeof(struct crypto_alg);
19101c2deceSHerbert Xu }
19201c2deceSHerbert Xu 
19301c2deceSHerbert Xu static inline struct ahash_instance *ahash_alloc_instance(
19401c2deceSHerbert Xu 	const char *name, struct crypto_alg *alg)
19501c2deceSHerbert Xu {
19614aa1a83SEric Biggers 	return crypto_alloc_instance(name, alg, ahash_instance_headroom());
19701c2deceSHerbert Xu }
19801c2deceSHerbert Xu 
199ef0579b6SHerbert Xu static inline void ahash_request_complete(struct ahash_request *req, int err)
200ef0579b6SHerbert Xu {
201ef0579b6SHerbert Xu 	req->base.complete(&req->base, err);
202ef0579b6SHerbert Xu }
203ef0579b6SHerbert Xu 
204ef0579b6SHerbert Xu static inline u32 ahash_request_flags(struct ahash_request *req)
205ef0579b6SHerbert Xu {
206ef0579b6SHerbert Xu 	return req->base.flags;
207ef0579b6SHerbert Xu }
208ef0579b6SHerbert Xu 
20901c2deceSHerbert Xu static inline struct crypto_ahash *crypto_spawn_ahash(
21001c2deceSHerbert Xu 	struct crypto_ahash_spawn *spawn)
21101c2deceSHerbert Xu {
21201c2deceSHerbert Xu 	return crypto_spawn_tfm2(&spawn->base);
21301c2deceSHerbert Xu }
21401c2deceSHerbert Xu 
21518e33e6dSHerbert Xu static inline int ahash_enqueue_request(struct crypto_queue *queue,
21618e33e6dSHerbert Xu 					     struct ahash_request *request)
21718e33e6dSHerbert Xu {
21818e33e6dSHerbert Xu 	return crypto_enqueue_request(queue, &request->base);
21918e33e6dSHerbert Xu }
22018e33e6dSHerbert Xu 
22118e33e6dSHerbert Xu static inline struct ahash_request *ahash_dequeue_request(
22218e33e6dSHerbert Xu 	struct crypto_queue *queue)
22318e33e6dSHerbert Xu {
22418e33e6dSHerbert Xu 	return ahash_request_cast(crypto_dequeue_request(queue));
22518e33e6dSHerbert Xu }
22618e33e6dSHerbert Xu 
2277b5a080bSHerbert Xu static inline void *crypto_shash_ctx(struct crypto_shash *tfm)
2287b5a080bSHerbert Xu {
2297b5a080bSHerbert Xu 	return crypto_tfm_ctx(&tfm->base);
2307b5a080bSHerbert Xu }
2317b5a080bSHerbert Xu 
2322e4fddd8SHerbert Xu static inline struct crypto_instance *shash_crypto_instance(
2332e4fddd8SHerbert Xu 	struct shash_instance *inst)
2342e4fddd8SHerbert Xu {
2351b84e7d0SEric Biggers 	return &inst->s.base;
2362e4fddd8SHerbert Xu }
2372e4fddd8SHerbert Xu 
2382e4fddd8SHerbert Xu static inline struct shash_instance *shash_instance(
2392e4fddd8SHerbert Xu 	struct crypto_instance *inst)
2402e4fddd8SHerbert Xu {
2411b84e7d0SEric Biggers 	return container_of(inst, struct shash_instance, s.base);
2422e4fddd8SHerbert Xu }
2432e4fddd8SHerbert Xu 
244d9e1670bSHerbert Xu static inline struct shash_instance *shash_alg_instance(
245d9e1670bSHerbert Xu 	struct crypto_shash *shash)
246d9e1670bSHerbert Xu {
247d9e1670bSHerbert Xu 	return shash_instance(crypto_tfm_alg_instance(&shash->base));
248d9e1670bSHerbert Xu }
249d9e1670bSHerbert Xu 
250ef5d590cSHerbert Xu static inline void *shash_instance_ctx(struct shash_instance *inst)
251ef5d590cSHerbert Xu {
252ef5d590cSHerbert Xu 	return crypto_instance_ctx(shash_crypto_instance(inst));
253ef5d590cSHerbert Xu }
254ef5d590cSHerbert Xu 
2552e4fddd8SHerbert Xu static inline struct shash_instance *shash_alloc_instance(
2562e4fddd8SHerbert Xu 	const char *name, struct crypto_alg *alg)
2572e4fddd8SHerbert Xu {
25814aa1a83SEric Biggers 	return crypto_alloc_instance(name, alg,
2592e4fddd8SHerbert Xu 				     sizeof(struct shash_alg) - sizeof(*alg));
2602e4fddd8SHerbert Xu }
2612e4fddd8SHerbert Xu 
26294296999SHerbert Xu static inline struct crypto_shash *crypto_spawn_shash(
26394296999SHerbert Xu 	struct crypto_shash_spawn *spawn)
26494296999SHerbert Xu {
26594296999SHerbert Xu 	return crypto_spawn_tfm2(&spawn->base);
26694296999SHerbert Xu }
26794296999SHerbert Xu 
268cde6263fSHerbert Xu static inline void *crypto_shash_ctx_aligned(struct crypto_shash *tfm)
269cde6263fSHerbert Xu {
270cde6263fSHerbert Xu 	return crypto_tfm_ctx_aligned(&tfm->base);
271cde6263fSHerbert Xu }
272cde6263fSHerbert Xu 
2730390e6aeSHerbert Xu static inline struct crypto_shash *__crypto_shash_cast(struct crypto_tfm *tfm)
2740390e6aeSHerbert Xu {
275113adefcSHerbert Xu 	return container_of(tfm, struct crypto_shash, base);
2760390e6aeSHerbert Xu }
2770390e6aeSHerbert Xu 
27820036252SHerbert Xu #endif	/* _CRYPTO_INTERNAL_HASH_H */
27920036252SHerbert Xu 
280