[mirror_ubuntu-jammy-kernel.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 <linux/crypto.h>
#include <linux/list.h>
#include <linux/kernel.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		63
#define MAX_CIPHER_BLOCKSIZE		16
#define MAX_CIPHER_ALIGNMASK		15

struct crypto_aead;
struct crypto_instance;
struct module;
struct rtattr;
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)(struct crypto_tfm *tfm, u32 type, u32 mask);
	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);

	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;
	};

	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;
};

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);
void __crypto_xor(u8 *dst, const u8 *src1, const u8 *src2, unsigned int size);

static inline void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
{
	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	    __builtin_constant_p(size) &&
	    (size % sizeof(unsigned long)) == 0) {
		unsigned long *d = (unsigned long *)dst;
		unsigned long *s = (unsigned long *)src;

		while (size > 0) {
			*d++ ^= *s++;
			size -= sizeof(unsigned long);
		}
	} else {
		__crypto_xor(dst, dst, src, size);
	}
}

static inline void crypto_xor_cpy(u8 *dst, const u8 *src1, const u8 *src2,
				  unsigned int size)
{
	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	    __builtin_constant_p(size) &&
	    (size % sizeof(unsigned long)) == 0) {
		unsigned long *d = (unsigned long *)dst;
		unsigned long *s1 = (unsigned long *)src1;
		unsigned long *s2 = (unsigned long *)src2;

		while (size > 0) {
			*d++ = *s1++ ^ *s2++;
			size -= sizeof(unsigned long);
		}
	} else {
		__crypto_xor(dst, src1, src2, size);
	}
}

static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
{
	return PTR_ALIGN(crypto_tfm_ctx(tfm),
			 crypto_tfm_alg_alignmask(tfm) + 1);
}

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);
}

noinline unsigned long __crypto_memneq(const void *a, const void *b, size_t size);

/**
 * crypto_memneq - Compare two areas of memory without leaking
 *		   timing information.
 *
 * @a: One area of memory
 * @b: Another area of memory
 * @size: The size of the area.
 *
 * Returns 0 when data is equal, 1 otherwise.
 */
static inline int crypto_memneq(const void *a, const void *b, size_t size)
{
	return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
}

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,
};

#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
	10	#include <linux/crypto.h>
b5b7f088 HX	11	#include <linux/list.h>
b5b7f088 HX	12	#include <linux/kernel.h>
cce9e06d	13
13c935bb SM	14	/*
	15	* Maximum values for blocksize and alignmask, used to allocate
	16	* static buffers that are big enough for any combination of
a9f7f88a	17	* algs and architectures. Ciphers have a lower maximum size.
13c935bb	18	*/
a9f7f88a KC	19	#define MAX_ALGAPI_BLOCKSIZE 160
a9f7f88a KC	20	#define MAX_ALGAPI_ALIGNMASK 63
13c935bb SM	21	#define MAX_CIPHER_BLOCKSIZE 16
	22	#define MAX_CIPHER_ALIGNMASK 15
	23
5d1d65f8	24	struct crypto_aead;
319382a6	25	struct crypto_instance;
4cc7720c	26	struct module;
ebc610e5	27	struct rtattr;
e853c3cf	28	struct seq_file;
0c3dc787	29	struct sk_buff;
e853c3cf HX	30
e853c3cf HX	31	struct crypto_type {
27d2a330	32	unsigned int (ctxsize)(struct crypto_alg alg, u32 type, u32 mask);
2ca33da1	33	unsigned int (extsize)(struct crypto_alg alg);
27d2a330	34	int (init)(struct crypto_tfm tfm, u32 type, u32 mask);
2ca33da1	35	int (init_tfm)(struct crypto_tfm tfm);
e853c3cf	36	void (show)(struct seq_file m, struct crypto_alg *alg);
b6aa63c0	37	int (report)(struct sk_buff skb, struct crypto_alg *alg);
319382a6	38	void (free)(struct crypto_instance inst);
7b0bac64 HX	39
	40	unsigned int type;
	41	unsigned int maskclear;
	42	unsigned int maskset;
	43	unsigned int tfmsize;
e853c3cf	44	};
4cc7720c HX	45
	46	struct crypto_instance {
	47	struct crypto_alg alg;
	48
	49	struct crypto_template *tmpl;
5f567fff HX	50
	51	union {
	52	/* Node in list of instances after registration. */
	53	struct hlist_node list;
	54	/* List of attached spawns before registration. */
	55	struct crypto_spawn *spawns;
	56	};
4cc7720c HX	57
	58	void *__ctx[] CRYPTO_MINALIGN_ATTR;
	59	};
	60
	61	struct crypto_template {
	62	struct list_head list;
	63	struct hlist_head instances;
	64	struct module *module;
	65
f2ac72e8	66	int (create)(struct crypto_template tmpl, struct rtattr **tb);
4cc7720c HX	67
	68	char name[CRYPTO_MAX_ALG_NAME];
	69	};
	70
6bfd4809 HX	71	struct crypto_spawn {
	72	struct list_head list;
	73	struct crypto_alg *alg;
5f567fff HX	74	union {
	75	/* Back pointer to instance after registration.*/
	76	struct crypto_instance *inst;
	77	/* Spawn list pointer prior to registration. */
	78	struct crypto_spawn *next;
	79	};
97eedce1	80	const struct crypto_type *frontend;
a73e6996	81	u32 mask;
4f87ee11	82	bool dead;
5f567fff	83	bool registered;
6bfd4809 HX	84	};
6bfd4809 HX	85
b5b7f088 HX	86	struct crypto_queue {
	87	struct list_head list;
	88	struct list_head *backlog;
	89
	90	unsigned int qlen;
	91	unsigned int max_qlen;
	92	};
	93
5c64097a HX	94	struct scatter_walk {
	95	struct scatterlist *sg;
	96	unsigned int offset;
	97	};
	98
5163ab50 HX	99	struct crypto_attr_alg {
	100	char name[CRYPTO_MAX_ALG_NAME];
	101	};
	102
	103	struct crypto_attr_type {
	104	u32 type;
	105	u32 mask;
	106	};
	107
db131ef9 HX	108	void crypto_mod_put(struct crypto_alg *alg);
db131ef9 HX	109
4cc7720c	110	int crypto_register_template(struct crypto_template *tmpl);
9572442d	111	int crypto_register_templates(struct crypto_template *tmpls, int count);
4cc7720c	112	void crypto_unregister_template(struct crypto_template *tmpl);
9572442d	113	void crypto_unregister_templates(struct crypto_template *tmpls, int count);
4cc7720c HX	114	struct crypto_template crypto_lookup_template(const char name);
4cc7720c HX	115
9cd899a3 HX	116	int crypto_register_instance(struct crypto_template *tmpl,
9cd899a3 HX	117	struct crypto_instance *inst);
c6d633a9	118	void crypto_unregister_instance(struct crypto_instance *inst);
9cd899a3	119
de95c957 EB	120	int crypto_grab_spawn(struct crypto_spawn spawn, struct crypto_instance inst,
de95c957 EB	121	const char *name, u32 type, u32 mask);
6bfd4809	122	void crypto_drop_spawn(struct crypto_spawn *spawn);
2e306ee0 HX	123	struct crypto_tfm crypto_spawn_tfm(struct crypto_spawn spawn, u32 type,
2e306ee0 HX	124	u32 mask);
97eedce1	125	void crypto_spawn_tfm2(struct crypto_spawn spawn);
6bfd4809	126
ebc610e5	127	struct crypto_attr_type crypto_get_attr_type(struct rtattr *tb);
7bcb2c99	128	int crypto_check_attr_type(struct rtattr *tb, u32 type, u32 mask_ret);
68b6c7d6	129	const char crypto_attr_alg_name(struct rtattr rta);
32f27c74 HX	130	int crypto_inst_setname(struct crypto_instance inst, const char name,
32f27c74 HX	131	struct crypto_alg *alg);
7fed0bf2	132
b5b7f088 HX	133	void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
	134	int crypto_enqueue_request(struct crypto_queue *queue,
	135	struct crypto_async_request *request);
ec6e2bf3 IP	136	void crypto_enqueue_request_head(struct crypto_queue *queue,
ec6e2bf3 IP	137	struct crypto_async_request *request);
b5b7f088	138	struct crypto_async_request crypto_dequeue_request(struct crypto_queue queue);
9f93a8a0 BW	139	static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
	140	{
	141	return queue->qlen;
	142	}
b5b7f088	143
7613636d	144	void crypto_inc(u8 *a, unsigned int size);
a7c391f0	145	void __crypto_xor(u8 dst, const u8 src1, const u8 *src2, unsigned int size);
db91af0f AB	146
	147	static inline void crypto_xor(u8 dst, const u8 src, unsigned int size)
	148	{
	149	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	150	__builtin_constant_p(size) &&
	151	(size % sizeof(unsigned long)) == 0) {
	152	unsigned long d = (unsigned long )dst;
	153	unsigned long s = (unsigned long )src;
	154
	155	while (size > 0) {
	156	d++ ^= s++;
	157	size -= sizeof(unsigned long);
	158	}
	159	} else {
a7c391f0	160	__crypto_xor(dst, dst, src, size);
db91af0f AB	161	}
db91af0f AB	162	}
7613636d	163
45fe93df AB	164	static inline void crypto_xor_cpy(u8 dst, const u8 src1, const u8 *src2,
	165	unsigned int size)
	166	{
	167	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	168	__builtin_constant_p(size) &&
	169	(size % sizeof(unsigned long)) == 0) {
	170	unsigned long d = (unsigned long )dst;
	171	unsigned long s1 = (unsigned long )src1;
	172	unsigned long s2 = (unsigned long )src2;
	173
	174	while (size > 0) {
	175	d++ = s1++ ^ *s2++;
	176	size -= sizeof(unsigned long);
	177	}
	178	} else {
	179	__crypto_xor(dst, src1, src2, size);
	180	}
	181	}
	182
5cde0af2 HX	183	static inline void crypto_tfm_ctx_aligned(struct crypto_tfm tfm)
5cde0af2 HX	184	{
ab300465 HX	185	return PTR_ALIGN(crypto_tfm_ctx(tfm),
ab300465 HX	186	crypto_tfm_alg_alignmask(tfm) + 1);
5cde0af2 HX	187	}
5cde0af2 HX	188
124b53d0 HX	189	static inline struct crypto_instance *crypto_tfm_alg_instance(
	190	struct crypto_tfm *tfm)
	191	{
	192	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
	193	}
	194
4cc7720c HX	195	static inline void crypto_instance_ctx(struct crypto_instance inst)
	196	{
	197	return inst->__ctx;
	198	}
	199
b5b7f088 HX	200	static inline struct crypto_async_request *crypto_get_backlog(
	201	struct crypto_queue *queue)
	202	{
	203	return queue->backlog == &queue->list ? NULL :
	204	container_of(queue->backlog, struct crypto_async_request, list);
	205	}
	206
7bcb2c99	207	static inline u32 crypto_requires_off(struct crypto_attr_type *algt, u32 off)
016df0ab	208	{
7bcb2c99	209	return (algt->type ^ off) & algt->mask & off;
016df0ab HX	210	}
016df0ab HX	211
378f4f51	212	/*
7bcb2c99 EB	213	* When an algorithm uses another algorithm (e.g., if it's an instance of a
	214	* template), these are the flags that should always be set on the "outer"
	215	* algorithm if any "inner" algorithm has them set.
378f4f51	216	*/
2eb27c11	217	#define CRYPTO_ALG_INHERITED_FLAGS \
fbb6cda4 EB	218	(CRYPTO_ALG_ASYNC \| CRYPTO_ALG_NEED_FALLBACK \| \
fbb6cda4 EB	219	CRYPTO_ALG_ALLOCATES_MEMORY)
7bcb2c99 EB	220
	221	/*
	222	* Given the type and mask that specify the flags restrictions on a template
	223	* instance being created, return the mask that should be passed to
	224	* crypto_grab_*() (along with type=0) to honor any request the user made to
	225	* have any of the CRYPTO_ALG_INHERITED_FLAGS clear.
	226	*/
	227	static inline u32 crypto_algt_inherited_mask(struct crypto_attr_type *algt)
378f4f51	228	{
7bcb2c99	229	return crypto_requires_off(algt, CRYPTO_ALG_INHERITED_FLAGS);
378f4f51 HX	230	}
378f4f51 HX	231
6bf37e5a JY	232	noinline unsigned long __crypto_memneq(const void a, const void b, size_t size);
	233
	234	/**
	235	* crypto_memneq - Compare two areas of memory without leaking
	236	* timing information.
	237	*
	238	* @a: One area of memory
	239	* @b: Another area of memory
	240	* @size: The size of the area.
	241	*
	242	* Returns 0 when data is equal, 1 otherwise.
	243	*/
	244	static inline int crypto_memneq(const void a, const void b, size_t size)
	245	{
	246	return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
	247	}
cce9e06d	248
dd8b083f MP	249	int crypto_register_notifier(struct notifier_block *nb);
	250	int crypto_unregister_notifier(struct notifier_block *nb);
	251
	252	/* Crypto notification events. */
	253	enum {
	254	CRYPTO_MSG_ALG_REQUEST,
	255	CRYPTO_MSG_ALG_REGISTER,
	256	CRYPTO_MSG_ALG_LOADED,
	257	};
	258
6bf37e5a	259	#endif /* _CRYPTO_ALGAPI_H */