[linux-block.git] / include / crypto / algapi.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Cryptographic API for algorithms (i.e., low-level API).
 *
 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
 */
#ifndef _CRYPTO_ALGAPI_H
#define _CRYPTO_ALGAPI_H

#include <crypto/utils.h>
#include <linux/align.h>
#include <linux/cache.h>
#include <linux/crypto.h>
#include <linux/types.h>
#include <linux/workqueue.h>

/*
 * Maximum values for blocksize and alignmask, used to allocate
 * static buffers that are big enough for any combination of
 * algs and architectures. Ciphers have a lower maximum size.
 */
#define MAX_ALGAPI_BLOCKSIZE		160
#define MAX_ALGAPI_ALIGNMASK		127
#define MAX_CIPHER_BLOCKSIZE		16
#define MAX_CIPHER_ALIGNMASK		15

#ifdef ARCH_DMA_MINALIGN
#define CRYPTO_DMA_ALIGN ARCH_DMA_MINALIGN
#else
#define CRYPTO_DMA_ALIGN CRYPTO_MINALIGN
#endif

#define CRYPTO_DMA_PADDING ((CRYPTO_DMA_ALIGN - 1) & ~(CRYPTO_MINALIGN - 1))

/*
 * Autoloaded crypto modules should only use a prefixed name to avoid allowing
 * arbitrary modules to be loaded. Loading from userspace may still need the
 * unprefixed names, so retains those aliases as well.
 * This uses __MODULE_INFO directly instead of MODULE_ALIAS because pre-4.3
 * gcc (e.g. avr32 toolchain) uses __LINE__ for uniqueness, and this macro
 * expands twice on the same line. Instead, use a separate base name for the
 * alias.
 */
#define MODULE_ALIAS_CRYPTO(name)	\
		__MODULE_INFO(alias, alias_userspace, name);	\
		__MODULE_INFO(alias, alias_crypto, "crypto-" name)

struct crypto_aead;
struct crypto_instance;
struct module;
struct notifier_block;
struct rtattr;
struct scatterlist;
struct seq_file;
struct sk_buff;

struct crypto_type {
	unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
	unsigned int (*extsize)(struct crypto_alg *alg);
	int (*init_tfm)(struct crypto_tfm *tfm);
	void (*show)(struct seq_file *m, struct crypto_alg *alg);
	int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
	void (*free)(struct crypto_instance *inst);
#ifdef CONFIG_CRYPTO_STATS
	int (*report_stat)(struct sk_buff *skb, struct crypto_alg *alg);
#endif

	unsigned int type;
	unsigned int maskclear;
	unsigned int maskset;
	unsigned int tfmsize;
};

struct crypto_instance {
	struct crypto_alg alg;

	struct crypto_template *tmpl;

	union {
		/* Node in list of instances after registration. */
		struct hlist_node list;
		/* List of attached spawns before registration. */
		struct crypto_spawn *spawns;
	};

	struct work_struct free_work;

	void *__ctx[] CRYPTO_MINALIGN_ATTR;
};

struct crypto_template {
	struct list_head list;
	struct hlist_head instances;
	struct module *module;

	int (*create)(struct crypto_template *tmpl, struct rtattr **tb);

	char name[CRYPTO_MAX_ALG_NAME];
};

struct crypto_spawn {
	struct list_head list;
	struct crypto_alg *alg;
	union {
		/* Back pointer to instance after registration.*/
		struct crypto_instance *inst;
		/* Spawn list pointer prior to registration. */
		struct crypto_spawn *next;
	};
	const struct crypto_type *frontend;
	u32 mask;
	bool dead;
	bool registered;
};

struct crypto_queue {
	struct list_head list;
	struct list_head *backlog;

	unsigned int qlen;
	unsigned int max_qlen;
};

struct scatter_walk {
	struct scatterlist *sg;
	unsigned int offset;
};

struct crypto_attr_alg {
	char name[CRYPTO_MAX_ALG_NAME];
};

struct crypto_attr_type {
	u32 type;
	u32 mask;
};

/*
 * Algorithm registration interface.
 */
int crypto_register_alg(struct crypto_alg *alg);
void crypto_unregister_alg(struct crypto_alg *alg);
int crypto_register_algs(struct crypto_alg *algs, int count);
void crypto_unregister_algs(struct crypto_alg *algs, int count);

void crypto_mod_put(struct crypto_alg *alg);

int crypto_register_template(struct crypto_template *tmpl);
int crypto_register_templates(struct crypto_template *tmpls, int count);
void crypto_unregister_template(struct crypto_template *tmpl);
void crypto_unregister_templates(struct crypto_template *tmpls, int count);
struct crypto_template *crypto_lookup_template(const char *name);

int crypto_register_instance(struct crypto_template *tmpl,
			     struct crypto_instance *inst);
void crypto_unregister_instance(struct crypto_instance *inst);

int crypto_grab_spawn(struct crypto_spawn *spawn, struct crypto_instance *inst,
		      const char *name, u32 type, u32 mask);
void crypto_drop_spawn(struct crypto_spawn *spawn);
struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
				    u32 mask);
void *crypto_spawn_tfm2(struct crypto_spawn *spawn);

struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
int crypto_check_attr_type(struct rtattr **tb, u32 type, u32 *mask_ret);
const char *crypto_attr_alg_name(struct rtattr *rta);
int crypto_inst_setname(struct crypto_instance *inst, const char *name,
			struct crypto_alg *alg);

void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
int crypto_enqueue_request(struct crypto_queue *queue,
			   struct crypto_async_request *request);
void crypto_enqueue_request_head(struct crypto_queue *queue,
				 struct crypto_async_request *request);
struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
{
	return queue->qlen;
}

void crypto_inc(u8 *a, unsigned int size);

static inline void *crypto_tfm_ctx(struct crypto_tfm *tfm)
{
	return tfm->__crt_ctx;
}

static inline void *crypto_tfm_ctx_align(struct crypto_tfm *tfm,
					 unsigned int align)
{
	if (align <= crypto_tfm_ctx_alignment())
		align = 1;

	return PTR_ALIGN(crypto_tfm_ctx(tfm), align);
}

static inline unsigned int crypto_dma_align(void)
{
	return CRYPTO_DMA_ALIGN;
}

static inline unsigned int crypto_dma_padding(void)
{
	return (crypto_dma_align() - 1) & ~(crypto_tfm_ctx_alignment() - 1);
}

static inline void *crypto_tfm_ctx_dma(struct crypto_tfm *tfm)
{
	return crypto_tfm_ctx_align(tfm, crypto_dma_align());
}

static inline struct crypto_instance *crypto_tfm_alg_instance(
	struct crypto_tfm *tfm)
{
	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
}

static inline void *crypto_instance_ctx(struct crypto_instance *inst)
{
	return inst->__ctx;
}

static inline struct crypto_async_request *crypto_get_backlog(
	struct crypto_queue *queue)
{
	return queue->backlog == &queue->list ? NULL :
	       container_of(queue->backlog, struct crypto_async_request, list);
}

static inline u32 crypto_requires_off(struct crypto_attr_type *algt, u32 off)
{
	return (algt->type ^ off) & algt->mask & off;
}

/*
 * When an algorithm uses another algorithm (e.g., if it's an instance of a
 * template), these are the flags that should always be set on the "outer"
 * algorithm if any "inner" algorithm has them set.
 */
#define CRYPTO_ALG_INHERITED_FLAGS	\
	(CRYPTO_ALG_ASYNC | CRYPTO_ALG_NEED_FALLBACK |	\
	 CRYPTO_ALG_ALLOCATES_MEMORY)

/*
 * Given the type and mask that specify the flags restrictions on a template
 * instance being created, return the mask that should be passed to
 * crypto_grab_*() (along with type=0) to honor any request the user made to
 * have any of the CRYPTO_ALG_INHERITED_FLAGS clear.
 */
static inline u32 crypto_algt_inherited_mask(struct crypto_attr_type *algt)
{
	return crypto_requires_off(algt, CRYPTO_ALG_INHERITED_FLAGS);
}

int crypto_register_notifier(struct notifier_block *nb);
int crypto_unregister_notifier(struct notifier_block *nb);

/* Crypto notification events. */
enum {
	CRYPTO_MSG_ALG_REQUEST,
	CRYPTO_MSG_ALG_REGISTER,
	CRYPTO_MSG_ALG_LOADED,
};

static inline void crypto_request_complete(struct crypto_async_request *req,
					   int err)
{
	req->complete(req->data, err);
}

static inline u32 crypto_tfm_alg_type(struct crypto_tfm *tfm)
{
	return tfm->__crt_alg->cra_flags & CRYPTO_ALG_TYPE_MASK;
}

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