algapi.h

  1/* SPDX-License-Identifier: GPL-2.0-or-later */
  2/*
  3 * Cryptographic API for algorithms (i.e., low-level API).
  4 *
  5 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
  6 */
  7#ifndef _CRYPTO_ALGAPI_H
  8#define _CRYPTO_ALGAPI_H
  9
 10#include <crypto/utils.h>
 11#include <linux/align.h>
 12#include <linux/cache.h>
 13#include <linux/crypto.h>
 14#include <linux/list.h>
 15#include <linux/types.h>
 16#include <linux/workqueue.h>
 17
 18/*
 19 * Maximum values for blocksize and alignmask, used to allocate
 20 * static buffers that are big enough for any combination of
 21 * algs and architectures. Ciphers have a lower maximum size.
 22 */
 23#define MAX_ALGAPI_BLOCKSIZE		160
 24#define MAX_ALGAPI_ALIGNMASK		127
 25#define MAX_CIPHER_BLOCKSIZE		16
 26#define MAX_CIPHER_ALIGNMASK		15
 27
 28#ifdef ARCH_DMA_MINALIGN
 29#define CRYPTO_DMA_ALIGN ARCH_DMA_MINALIGN
 30#else
 31#define CRYPTO_DMA_ALIGN CRYPTO_MINALIGN
 32#endif
 33
 34#define CRYPTO_DMA_PADDING ((CRYPTO_DMA_ALIGN - 1) & ~(CRYPTO_MINALIGN - 1))
 35
 36/*
 37 * Autoloaded crypto modules should only use a prefixed name to avoid allowing
 38 * arbitrary modules to be loaded. Loading from userspace may still need the
 39 * unprefixed names, so retains those aliases as well.
 40 * This uses __MODULE_INFO directly instead of MODULE_ALIAS because pre-4.3
 41 * gcc (e.g. avr32 toolchain) uses __LINE__ for uniqueness, and this macro
 42 * expands twice on the same line. Instead, use a separate base name for the
 43 * alias.
 44 */
 45#define MODULE_ALIAS_CRYPTO(name)	\
 46		MODULE_INFO(alias, name);	\
 47		MODULE_INFO(alias, "crypto-" name)
 48
 49struct crypto_aead;
 50struct crypto_instance;
 51struct module;
 52struct notifier_block;
 53struct rtattr;
 54struct scatterlist;
 55struct seq_file;
 56struct sk_buff;
 57union crypto_no_such_thing;
 58
 59struct crypto_instance {
 60	struct crypto_alg alg;
 61
 62	struct crypto_template *tmpl;
 63
 64	union {
 65		/* Node in list of instances after registration. */
 66		struct hlist_node list;
 67		/* List of attached spawns before registration. */
 68		struct crypto_spawn *spawns;
 69	};
 70
 71	void *__ctx[] CRYPTO_MINALIGN_ATTR;
 72};
 73
 74struct crypto_template {
 75	struct list_head list;
 76	struct hlist_head instances;
 77	struct hlist_head dead;
 78	struct module *module;
 79
 80	struct work_struct free_work;
 81
 82	int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
 83
 84	char name[CRYPTO_MAX_ALG_NAME];
 85};
 86
 87struct crypto_spawn {
 88	struct list_head list;
 89	struct crypto_alg *alg;
 90	union {
 91		/* Back pointer to instance after registration.*/
 92		struct crypto_instance *inst;
 93		/* Spawn list pointer prior to registration. */
 94		struct crypto_spawn *next;
 95	};
 96	const struct crypto_type *frontend;
 97	u32 mask;
 98	bool dead;
 99	bool registered;
100};
101
102struct crypto_queue {
103	struct list_head list;
104	struct list_head *backlog;
105
106	unsigned int qlen;
107	unsigned int max_qlen;
108};
109
110struct scatter_walk {
111	/* Must be the first member, see struct skcipher_walk. */
112	union {
113		void *const addr;
114
115		/* Private API field, do not touch. */
116		union crypto_no_such_thing *__addr;
117	};
118	struct scatterlist *sg;
119	unsigned int offset;
120};
121
122struct crypto_attr_alg {
123	char name[CRYPTO_MAX_ALG_NAME];
124};
125
126struct crypto_attr_type {
127	u32 type;
128	u32 mask;
129};
130
131/*
132 * Algorithm registration interface.
133 */
134int crypto_register_alg(struct crypto_alg *alg);
135void crypto_unregister_alg(struct crypto_alg *alg);
136int crypto_register_algs(struct crypto_alg *algs, int count);
137void crypto_unregister_algs(struct crypto_alg *algs, int count);
138
139void crypto_mod_put(struct crypto_alg *alg);
140
141int crypto_register_template(struct crypto_template *tmpl);
142int crypto_register_templates(struct crypto_template *tmpls, int count);
143void crypto_unregister_template(struct crypto_template *tmpl);
144void crypto_unregister_templates(struct crypto_template *tmpls, int count);
145struct crypto_template *crypto_lookup_template(const char *name);
146
147int crypto_register_instance(struct crypto_template *tmpl,
148			     struct crypto_instance *inst);
149void crypto_unregister_instance(struct crypto_instance *inst);
150
151int crypto_grab_spawn(struct crypto_spawn *spawn, struct crypto_instance *inst,
152		      const char *name, u32 type, u32 mask);
153void crypto_drop_spawn(struct crypto_spawn *spawn);
154struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
155				    u32 mask);
156void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
157
158struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
159int crypto_check_attr_type(struct rtattr **tb, u32 type, u32 *mask_ret);
160const char *crypto_attr_alg_name(struct rtattr *rta);
161int __crypto_inst_setname(struct crypto_instance *inst, const char *name,
162			  const char *driver, struct crypto_alg *alg);
163
164#define crypto_inst_setname(inst, name, ...) \
165	CONCATENATE(crypto_inst_setname_, COUNT_ARGS(__VA_ARGS__))( \
166		inst, name, ##__VA_ARGS__)
167#define crypto_inst_setname_1(inst, name, alg) \
168	__crypto_inst_setname(inst, name, name, alg)
169#define crypto_inst_setname_2(inst, name, driver, alg) \
170	__crypto_inst_setname(inst, name, driver, alg)
171
172void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
173int crypto_enqueue_request(struct crypto_queue *queue,
174			   struct crypto_async_request *request);
175void crypto_enqueue_request_head(struct crypto_queue *queue,
176				 struct crypto_async_request *request);
177struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
178static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
179{
180	return queue->qlen;
181}
182
183void crypto_inc(u8 *a, unsigned int size);
184
185static inline void *crypto_tfm_ctx(struct crypto_tfm *tfm)
186{
187	return tfm->__crt_ctx;
188}
189
190static inline void *crypto_tfm_ctx_align(struct crypto_tfm *tfm,
191					 unsigned int align)
192{
193	if (align <= crypto_tfm_ctx_alignment())
194		align = 1;
195
196	return PTR_ALIGN(crypto_tfm_ctx(tfm), align);
197}
198
199static inline unsigned int crypto_dma_align(void)
200{
201	return CRYPTO_DMA_ALIGN;
202}
203
204static inline unsigned int crypto_dma_padding(void)
205{
206	return (crypto_dma_align() - 1) & ~(crypto_tfm_ctx_alignment() - 1);
207}
208
209static inline void *crypto_tfm_ctx_dma(struct crypto_tfm *tfm)
210{
211	return crypto_tfm_ctx_align(tfm, crypto_dma_align());
212}
213
214static inline struct crypto_instance *crypto_tfm_alg_instance(
215	struct crypto_tfm *tfm)
216{
217	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
218}
219
220static inline void *crypto_instance_ctx(struct crypto_instance *inst)
221{
222	return inst->__ctx;
223}
224
225static inline struct crypto_async_request *crypto_get_backlog(
226	struct crypto_queue *queue)
227{
228	return queue->backlog == &queue->list ? NULL :
229	       container_of(queue->backlog, struct crypto_async_request, list);
230}
231
232static inline u32 crypto_requires_off(struct crypto_attr_type *algt, u32 off)
233{
234	return (algt->type ^ off) & algt->mask & off;
235}
236
237/*
238 * When an algorithm uses another algorithm (e.g., if it's an instance of a
239 * template), these are the flags that should always be set on the "outer"
240 * algorithm if any "inner" algorithm has them set.
241 */
242#define CRYPTO_ALG_INHERITED_FLAGS	\
243	(CRYPTO_ALG_ASYNC | CRYPTO_ALG_NEED_FALLBACK |	\
244	 CRYPTO_ALG_ALLOCATES_MEMORY)
245
246/*
247 * Given the type and mask that specify the flags restrictions on a template
248 * instance being created, return the mask that should be passed to
249 * crypto_grab_*() (along with type=0) to honor any request the user made to
250 * have any of the CRYPTO_ALG_INHERITED_FLAGS clear.
251 */
252static inline u32 crypto_algt_inherited_mask(struct crypto_attr_type *algt)
253{
254	return crypto_requires_off(algt, CRYPTO_ALG_INHERITED_FLAGS);
255}
256
257int crypto_register_notifier(struct notifier_block *nb);
258int crypto_unregister_notifier(struct notifier_block *nb);
259
260/* Crypto notification events. */
261enum {
262	CRYPTO_MSG_ALG_REQUEST,
263	CRYPTO_MSG_ALG_REGISTER,
264	CRYPTO_MSG_ALG_LOADED,
265};
266
267static inline void crypto_request_complete(struct crypto_async_request *req,
268					   int err)
269{
270	req->complete(req->data, err);
271}
272
273static inline u32 crypto_tfm_alg_type(struct crypto_tfm *tfm)
274{
275	return tfm->__crt_alg->cra_flags & CRYPTO_ALG_TYPE_MASK;
276}
277
278static inline bool crypto_tfm_req_virt(struct crypto_tfm *tfm)
279{
280	return tfm->__crt_alg->cra_flags & CRYPTO_ALG_REQ_VIRT;
281}
282
283static inline u32 crypto_request_flags(struct crypto_async_request *req)
284{
285	return req->flags & ~CRYPTO_TFM_REQ_ON_STACK;
286}
287
288#endif	/* _CRYPTO_ALGAPI_H */