[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>
#include <linux/skbuff.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 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;
	struct hlist_node list;

	void *__ctx[] CRYPTO_MINALIGN_ATTR;
};

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

	struct crypto_instance *(*alloc)(struct rtattr **tb);
	void (*free)(struct crypto_instance *inst);
	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;
	struct crypto_instance *inst;
	const struct crypto_type *frontend;
	u32 mask;
	bool dead;
};

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

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_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
		      struct crypto_instance *inst, u32 mask);
int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
		       struct crypto_instance *inst,
		       const struct crypto_type *frontend);
int crypto_grab_spawn(struct crypto_spawn *spawn, 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);

static inline void crypto_set_spawn(struct crypto_spawn *spawn,
				    struct crypto_instance *inst)
{
	spawn->inst = inst;
}

struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
int crypto_check_attr_type(struct rtattr **tb, u32 type);
const char *crypto_attr_alg_name(struct rtattr *rta);
struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
				    const struct crypto_type *frontend,
				    u32 type, u32 mask);

static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
						 u32 type, u32 mask)
{
	return crypto_attr_alg2(rta, NULL, type, mask);
}

int crypto_attr_u32(struct rtattr *rta, u32 *num);
int crypto_inst_setname(struct crypto_instance *inst, const char *name,
			struct crypto_alg *alg);
void *crypto_alloc_instance(const char *name, struct crypto_alg *alg,
			    unsigned int head);

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);
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_cipher *crypto_spawn_cipher(
	struct crypto_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	u32 mask = CRYPTO_ALG_TYPE_MASK;

	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
}

static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
{
	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
}

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 struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
						     u32 type, u32 mask)
{
	return crypto_attr_alg(tb[1], type, mask);
}

static inline int crypto_requires_off(u32 type, u32 mask, u32 off)
{
	return (type ^ off) & mask & off;
}

/*
 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
 * Otherwise returns zero.
 */
static inline int crypto_requires_sync(u32 type, u32 mask)
{
	return crypto_requires_off(type, mask, CRYPTO_ALG_ASYNC);
}

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

static inline void crypto_yield(u32 flags)
{
	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
		cond_resched();
}

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>
b6aa63c0	13	#include <linux/skbuff.h>
cce9e06d	14
13c935bb SM	15	/*
	16	* Maximum values for blocksize and alignmask, used to allocate
	17	* static buffers that are big enough for any combination of
a9f7f88a	18	* algs and architectures. Ciphers have a lower maximum size.
13c935bb	19	*/
a9f7f88a KC	20	#define MAX_ALGAPI_BLOCKSIZE 160
a9f7f88a KC	21	#define MAX_ALGAPI_ALIGNMASK 63
13c935bb SM	22	#define MAX_CIPHER_BLOCKSIZE 16
	23	#define MAX_CIPHER_ALIGNMASK 15
	24
5d1d65f8	25	struct crypto_aead;
319382a6	26	struct crypto_instance;
4cc7720c	27	struct module;
ebc610e5	28	struct rtattr;
e853c3cf HX	29	struct seq_file;
	30
	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;
	50	struct hlist_node list;
	51
	52	void *__ctx[] CRYPTO_MINALIGN_ATTR;
	53	};
	54
	55	struct crypto_template {
	56	struct list_head list;
	57	struct hlist_head instances;
	58	struct module *module;
	59
ebc610e5	60	struct crypto_instance (alloc)(struct rtattr **tb);
4cc7720c	61	void (free)(struct crypto_instance inst);
f2ac72e8	62	int (create)(struct crypto_template tmpl, struct rtattr **tb);
4cc7720c HX	63
	64	char name[CRYPTO_MAX_ALG_NAME];
	65	};
	66
6bfd4809 HX	67	struct crypto_spawn {
	68	struct list_head list;
	69	struct crypto_alg *alg;
	70	struct crypto_instance *inst;
97eedce1	71	const struct crypto_type *frontend;
a73e6996	72	u32 mask;
4f87ee11	73	bool dead;
6bfd4809 HX	74	};
6bfd4809 HX	75
b5b7f088 HX	76	struct crypto_queue {
	77	struct list_head list;
	78	struct list_head *backlog;
	79
	80	unsigned int qlen;
	81	unsigned int max_qlen;
	82	};
	83
5c64097a HX	84	struct scatter_walk {
	85	struct scatterlist *sg;
	86	unsigned int offset;
	87	};
	88
db131ef9 HX	89	void crypto_mod_put(struct crypto_alg *alg);
db131ef9 HX	90
4cc7720c	91	int crypto_register_template(struct crypto_template *tmpl);
9572442d	92	int crypto_register_templates(struct crypto_template *tmpls, int count);
4cc7720c	93	void crypto_unregister_template(struct crypto_template *tmpl);
9572442d	94	void crypto_unregister_templates(struct crypto_template *tmpls, int count);
4cc7720c HX	95	struct crypto_template crypto_lookup_template(const char name);
4cc7720c HX	96
9cd899a3 HX	97	int crypto_register_instance(struct crypto_template *tmpl,
9cd899a3 HX	98	struct crypto_instance *inst);
c6d633a9	99	void crypto_unregister_instance(struct crypto_instance *inst);
9cd899a3	100
6bfd4809	101	int crypto_init_spawn(struct crypto_spawn spawn, struct crypto_alg alg,
a73e6996	102	struct crypto_instance *inst, u32 mask);
97eedce1 HX	103	int crypto_init_spawn2(struct crypto_spawn spawn, struct crypto_alg alg,
	104	struct crypto_instance *inst,
	105	const struct crypto_type *frontend);
d6ef2f19 HX	106	int crypto_grab_spawn(struct crypto_spawn spawn, const char name,
d6ef2f19 HX	107	u32 type, u32 mask);
97eedce1	108
6bfd4809	109	void crypto_drop_spawn(struct crypto_spawn *spawn);
2e306ee0 HX	110	struct crypto_tfm crypto_spawn_tfm(struct crypto_spawn spawn, u32 type,
2e306ee0 HX	111	u32 mask);
97eedce1	112	void crypto_spawn_tfm2(struct crypto_spawn spawn);
6bfd4809	113
378f4f51 HX	114	static inline void crypto_set_spawn(struct crypto_spawn *spawn,
	115	struct crypto_instance *inst)
	116	{
	117	spawn->inst = inst;
	118	}
	119
ebc610e5 HX	120	struct crypto_attr_type crypto_get_attr_type(struct rtattr *tb);
ebc610e5 HX	121	int crypto_check_attr_type(struct rtattr **tb, u32 type);
68b6c7d6	122	const char crypto_attr_alg_name(struct rtattr rta);
d06854f0 HX	123	struct crypto_alg crypto_attr_alg2(struct rtattr rta,
	124	const struct crypto_type *frontend,
	125	u32 type, u32 mask);
	126
	127	static inline struct crypto_alg crypto_attr_alg(struct rtattr rta,
	128	u32 type, u32 mask)
	129	{
	130	return crypto_attr_alg2(rta, NULL, type, mask);
	131	}
	132
3c09f17c	133	int crypto_attr_u32(struct rtattr rta, u32 num);
32f27c74 HX	134	int crypto_inst_setname(struct crypto_instance inst, const char name,
32f27c74 HX	135	struct crypto_alg *alg);
14aa1a83 EB	136	void crypto_alloc_instance(const char name, struct crypto_alg *alg,
14aa1a83 EB	137	unsigned int head);
7fed0bf2	138
b5b7f088 HX	139	void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
	140	int crypto_enqueue_request(struct crypto_queue *queue,
	141	struct crypto_async_request *request);
	142	struct crypto_async_request crypto_dequeue_request(struct crypto_queue queue);
9f93a8a0 BW	143	static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
	144	{
	145	return queue->qlen;
	146	}
b5b7f088	147
7613636d	148	void crypto_inc(u8 *a, unsigned int size);
a7c391f0	149	void __crypto_xor(u8 dst, const u8 src1, const u8 *src2, unsigned int size);
db91af0f AB	150
	151	static inline void crypto_xor(u8 dst, const u8 src, unsigned int size)
	152	{
	153	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	154	__builtin_constant_p(size) &&
	155	(size % sizeof(unsigned long)) == 0) {
	156	unsigned long d = (unsigned long )dst;
	157	unsigned long s = (unsigned long )src;
	158
	159	while (size > 0) {
	160	d++ ^= s++;
	161	size -= sizeof(unsigned long);
	162	}
	163	} else {
a7c391f0	164	__crypto_xor(dst, dst, src, size);
db91af0f AB	165	}
db91af0f AB	166	}
7613636d	167
45fe93df AB	168	static inline void crypto_xor_cpy(u8 dst, const u8 src1, const u8 *src2,
	169	unsigned int size)
	170	{
	171	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	172	__builtin_constant_p(size) &&
	173	(size % sizeof(unsigned long)) == 0) {
	174	unsigned long d = (unsigned long )dst;
	175	unsigned long s1 = (unsigned long )src1;
	176	unsigned long s2 = (unsigned long )src2;
	177
	178	while (size > 0) {
	179	d++ = s1++ ^ *s2++;
	180	size -= sizeof(unsigned long);
	181	}
	182	} else {
	183	__crypto_xor(dst, src1, src2, size);
	184	}
	185	}
	186
5cde0af2 HX	187	static inline void crypto_tfm_ctx_aligned(struct crypto_tfm tfm)
5cde0af2 HX	188	{
ab300465 HX	189	return PTR_ALIGN(crypto_tfm_ctx(tfm),
ab300465 HX	190	crypto_tfm_alg_alignmask(tfm) + 1);
5cde0af2 HX	191	}
5cde0af2 HX	192
124b53d0 HX	193	static inline struct crypto_instance *crypto_tfm_alg_instance(
	194	struct crypto_tfm *tfm)
	195	{
	196	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
	197	}
	198
4cc7720c HX	199	static inline void crypto_instance_ctx(struct crypto_instance inst)
	200	{
	201	return inst->__ctx;
	202	}
	203
2e306ee0 HX	204	static inline struct crypto_cipher *crypto_spawn_cipher(
	205	struct crypto_spawn *spawn)
	206	{
	207	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	208	u32 mask = CRYPTO_ALG_TYPE_MASK;
	209
	210	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
	211	}
	212
f28776a3 HX	213	static inline struct cipher_alg crypto_cipher_alg(struct crypto_cipher tfm)
	214	{
	215	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
	216	}
	217
b5b7f088 HX	218	static inline struct crypto_async_request *crypto_get_backlog(
	219	struct crypto_queue *queue)
	220	{
	221	return queue->backlog == &queue->list ? NULL :
	222	container_of(queue->backlog, struct crypto_async_request, list);
	223	}
	224
3c09f17c HX	225	static inline struct crypto_alg crypto_get_attr_alg(struct rtattr *tb,
	226	u32 type, u32 mask)
	227	{
	228	return crypto_attr_alg(tb[1], type, mask);
	229	}
	230
016df0ab HX	231	static inline int crypto_requires_off(u32 type, u32 mask, u32 off)
	232	{
	233	return (type ^ off) & mask & off;
	234	}
	235
378f4f51 HX	236	/*
	237	* Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
	238	* Otherwise returns zero.
	239	*/
	240	static inline int crypto_requires_sync(u32 type, u32 mask)
	241	{
016df0ab	242	return crypto_requires_off(type, mask, CRYPTO_ALG_ASYNC);
378f4f51 HX	243	}
378f4f51 HX	244
6bf37e5a JY	245	noinline unsigned long __crypto_memneq(const void a, const void b, size_t size);
	246
	247	/**
	248	* crypto_memneq - Compare two areas of memory without leaking
	249	* timing information.
	250	*
	251	* @a: One area of memory
	252	* @b: Another area of memory
	253	* @size: The size of the area.
	254	*
	255	* Returns 0 when data is equal, 1 otherwise.
	256	*/
	257	static inline int crypto_memneq(const void a, const void b, size_t size)
	258	{
	259	return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
	260	}
cce9e06d	261
bb55a4c1 MV	262	static inline void crypto_yield(u32 flags)
	263	{
	264	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
	265	cond_resched();
	266	}
	267
dd8b083f MP	268	int crypto_register_notifier(struct notifier_block *nb);
	269	int crypto_unregister_notifier(struct notifier_block *nb);
	270
	271	/* Crypto notification events. */
	272	enum {
	273	CRYPTO_MSG_ALG_REQUEST,
	274	CRYPTO_MSG_ALG_REGISTER,
	275	CRYPTO_MSG_ALG_LOADED,
	276	};
	277
6bf37e5a	278	#endif /* _CRYPTO_ALGAPI_H */