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

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

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_attr_u32(struct rtattr *rta, u32 *num);
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;
}

struct crypto_cipher_spawn {
	struct crypto_spawn base;
};

static inline int crypto_grab_cipher(struct crypto_cipher_spawn *spawn,
				     struct crypto_instance *inst,
				     const char *name, u32 type, u32 mask)
{
	type &= ~CRYPTO_ALG_TYPE_MASK;
	type |= CRYPTO_ALG_TYPE_CIPHER;
	mask |= CRYPTO_ALG_TYPE_MASK;
	return crypto_grab_spawn(&spawn->base, inst, name, type, mask);
}

static inline void crypto_drop_cipher(struct crypto_cipher_spawn *spawn)
{
	crypto_drop_spawn(&spawn->base);
}

static inline struct crypto_alg *crypto_spawn_cipher_alg(
	struct crypto_cipher_spawn *spawn)
{
	return spawn->base.alg;
}

static inline struct crypto_cipher *crypto_spawn_cipher(
	struct crypto_cipher_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	u32 mask = CRYPTO_ALG_TYPE_MASK;

	return __crypto_cipher_cast(crypto_spawn_tfm(&spawn->base, 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 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>
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;
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
db131ef9 HX	99	void crypto_mod_put(struct crypto_alg *alg);
db131ef9 HX	100
4cc7720c	101	int crypto_register_template(struct crypto_template *tmpl);
9572442d	102	int crypto_register_templates(struct crypto_template *tmpls, int count);
4cc7720c	103	void crypto_unregister_template(struct crypto_template *tmpl);
9572442d	104	void crypto_unregister_templates(struct crypto_template *tmpls, int count);
4cc7720c HX	105	struct crypto_template crypto_lookup_template(const char name);
4cc7720c HX	106
9cd899a3 HX	107	int crypto_register_instance(struct crypto_template *tmpl,
9cd899a3 HX	108	struct crypto_instance *inst);
c6d633a9	109	void crypto_unregister_instance(struct crypto_instance *inst);
9cd899a3	110
de95c957 EB	111	int crypto_grab_spawn(struct crypto_spawn spawn, struct crypto_instance inst,
de95c957 EB	112	const char *name, u32 type, u32 mask);
6bfd4809	113	void crypto_drop_spawn(struct crypto_spawn *spawn);
2e306ee0 HX	114	struct crypto_tfm crypto_spawn_tfm(struct crypto_spawn spawn, u32 type,
2e306ee0 HX	115	u32 mask);
97eedce1	116	void crypto_spawn_tfm2(struct crypto_spawn spawn);
6bfd4809	117
ebc610e5	118	struct crypto_attr_type crypto_get_attr_type(struct rtattr *tb);
7bcb2c99	119	int crypto_check_attr_type(struct rtattr *tb, u32 type, u32 mask_ret);
68b6c7d6	120	const char crypto_attr_alg_name(struct rtattr rta);
3c09f17c	121	int crypto_attr_u32(struct rtattr rta, u32 num);
32f27c74 HX	122	int crypto_inst_setname(struct crypto_instance inst, const char name,
32f27c74 HX	123	struct crypto_alg *alg);
7fed0bf2	124
b5b7f088 HX	125	void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
	126	int crypto_enqueue_request(struct crypto_queue *queue,
	127	struct crypto_async_request *request);
ec6e2bf3 IP	128	void crypto_enqueue_request_head(struct crypto_queue *queue,
ec6e2bf3 IP	129	struct crypto_async_request *request);
b5b7f088	130	struct crypto_async_request crypto_dequeue_request(struct crypto_queue queue);
9f93a8a0 BW	131	static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
	132	{
	133	return queue->qlen;
	134	}
b5b7f088	135
7613636d	136	void crypto_inc(u8 *a, unsigned int size);
a7c391f0	137	void __crypto_xor(u8 dst, const u8 src1, const u8 *src2, unsigned int size);
db91af0f AB	138
	139	static inline void crypto_xor(u8 dst, const u8 src, unsigned int size)
	140	{
	141	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	142	__builtin_constant_p(size) &&
	143	(size % sizeof(unsigned long)) == 0) {
	144	unsigned long d = (unsigned long )dst;
	145	unsigned long s = (unsigned long )src;
	146
	147	while (size > 0) {
	148	d++ ^= s++;
	149	size -= sizeof(unsigned long);
	150	}
	151	} else {
a7c391f0	152	__crypto_xor(dst, dst, src, size);
db91af0f AB	153	}
db91af0f AB	154	}
7613636d	155
45fe93df AB	156	static inline void crypto_xor_cpy(u8 dst, const u8 src1, const u8 *src2,
	157	unsigned int size)
	158	{
	159	if (IS_ENABLED(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) &&
	160	__builtin_constant_p(size) &&
	161	(size % sizeof(unsigned long)) == 0) {
	162	unsigned long d = (unsigned long )dst;
	163	unsigned long s1 = (unsigned long )src1;
	164	unsigned long s2 = (unsigned long )src2;
	165
	166	while (size > 0) {
	167	d++ = s1++ ^ *s2++;
	168	size -= sizeof(unsigned long);
	169	}
	170	} else {
	171	__crypto_xor(dst, src1, src2, size);
	172	}
	173	}
	174
5cde0af2 HX	175	static inline void crypto_tfm_ctx_aligned(struct crypto_tfm tfm)
5cde0af2 HX	176	{
ab300465 HX	177	return PTR_ALIGN(crypto_tfm_ctx(tfm),
ab300465 HX	178	crypto_tfm_alg_alignmask(tfm) + 1);
5cde0af2 HX	179	}
5cde0af2 HX	180
124b53d0 HX	181	static inline struct crypto_instance *crypto_tfm_alg_instance(
	182	struct crypto_tfm *tfm)
	183	{
	184	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
	185	}
	186
4cc7720c HX	187	static inline void crypto_instance_ctx(struct crypto_instance inst)
	188	{
	189	return inst->__ctx;
	190	}
	191
0764ac28 EB	192	struct crypto_cipher_spawn {
	193	struct crypto_spawn base;
	194	};
	195
	196	static inline int crypto_grab_cipher(struct crypto_cipher_spawn *spawn,
	197	struct crypto_instance *inst,
	198	const char *name, u32 type, u32 mask)
	199	{
	200	type &= ~CRYPTO_ALG_TYPE_MASK;
	201	type \|= CRYPTO_ALG_TYPE_CIPHER;
	202	mask \|= CRYPTO_ALG_TYPE_MASK;
	203	return crypto_grab_spawn(&spawn->base, inst, name, type, mask);
	204	}
	205
	206	static inline void crypto_drop_cipher(struct crypto_cipher_spawn *spawn)
	207	{
	208	crypto_drop_spawn(&spawn->base);
	209	}
	210
	211	static inline struct crypto_alg *crypto_spawn_cipher_alg(
	212	struct crypto_cipher_spawn *spawn)
	213	{
	214	return spawn->base.alg;
	215	}
	216
2e306ee0	217	static inline struct crypto_cipher *crypto_spawn_cipher(
d5ed3b65	218	struct crypto_cipher_spawn *spawn)
2e306ee0 HX	219	{
	220	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	221	u32 mask = CRYPTO_ALG_TYPE_MASK;
	222
d5ed3b65	223	return __crypto_cipher_cast(crypto_spawn_tfm(&spawn->base, type, mask));
2e306ee0 HX	224	}
2e306ee0 HX	225
f28776a3 HX	226	static inline struct cipher_alg crypto_cipher_alg(struct crypto_cipher tfm)
	227	{
	228	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
	229	}
	230
b5b7f088 HX	231	static inline struct crypto_async_request *crypto_get_backlog(
	232	struct crypto_queue *queue)
	233	{
	234	return queue->backlog == &queue->list ? NULL :
	235	container_of(queue->backlog, struct crypto_async_request, list);
	236	}
	237
7bcb2c99	238	static inline u32 crypto_requires_off(struct crypto_attr_type *algt, u32 off)
016df0ab	239	{
7bcb2c99	240	return (algt->type ^ off) & algt->mask & off;
016df0ab HX	241	}
016df0ab HX	242
378f4f51	243	/*
7bcb2c99 EB	244	* When an algorithm uses another algorithm (e.g., if it's an instance of a
	245	* template), these are the flags that should always be set on the "outer"
	246	* algorithm if any "inner" algorithm has them set.
378f4f51	247	*/
2eb27c11	248	#define CRYPTO_ALG_INHERITED_FLAGS \
fbb6cda4 EB	249	(CRYPTO_ALG_ASYNC \| CRYPTO_ALG_NEED_FALLBACK \| \
fbb6cda4 EB	250	CRYPTO_ALG_ALLOCATES_MEMORY)
7bcb2c99 EB	251
	252	/*
	253	* Given the type and mask that specify the flags restrictions on a template
	254	* instance being created, return the mask that should be passed to
	255	* crypto_grab_*() (along with type=0) to honor any request the user made to
	256	* have any of the CRYPTO_ALG_INHERITED_FLAGS clear.
	257	*/
	258	static inline u32 crypto_algt_inherited_mask(struct crypto_attr_type *algt)
378f4f51	259	{
7bcb2c99	260	return crypto_requires_off(algt, CRYPTO_ALG_INHERITED_FLAGS);
378f4f51 HX	261	}
378f4f51 HX	262
6bf37e5a JY	263	noinline unsigned long __crypto_memneq(const void a, const void b, size_t size);
	264
	265	/**
	266	* crypto_memneq - Compare two areas of memory without leaking
	267	* timing information.
	268	*
	269	* @a: One area of memory
	270	* @b: Another area of memory
	271	* @size: The size of the area.
	272	*
	273	* Returns 0 when data is equal, 1 otherwise.
	274	*/
	275	static inline int crypto_memneq(const void a, const void b, size_t size)
	276	{
	277	return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
	278	}
cce9e06d	279
dd8b083f MP	280	int crypto_register_notifier(struct notifier_block *nb);
	281	int crypto_unregister_notifier(struct notifier_block *nb);
	282
	283	/* Crypto notification events. */
	284	enum {
	285	CRYPTO_MSG_ALG_REQUEST,
	286	CRYPTO_MSG_ALG_REGISTER,
	287	CRYPTO_MSG_ALG_LOADED,
	288	};
	289
6bf37e5a	290	#endif /* _CRYPTO_ALGAPI_H */