[mirror_ubuntu-bionic-kernel.git] / include / crypto / algapi.h

/*
 * Cryptographic API for algorithms (i.e., low-level API).
 *
 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option) 
 * any later version.
 *
 */
#ifndef _CRYPTO_ALGAPI_H
#define _CRYPTO_ALGAPI_H

#include <linux/crypto.h>
#include <linux/list.h>
#include <linux/kernel.h>

struct module;
struct rtattr;
struct seq_file;

struct crypto_type {
	unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
	int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
	void (*exit)(struct crypto_tfm *tfm);
	void (*show)(struct seq_file *m, struct crypto_alg *alg);
};

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

	char name[CRYPTO_MAX_ALG_NAME];
};

struct crypto_spawn {
	struct list_head list;
	struct crypto_alg *alg;
	struct crypto_instance *inst;
	u32 mask;
};

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 blkcipher_walk {
	union {
		struct {
			struct page *page;
			unsigned long offset;
		} phys;

		struct {
			u8 *page;
			u8 *addr;
		} virt;
	} src, dst;

	struct scatter_walk in;
	unsigned int nbytes;

	struct scatter_walk out;
	unsigned int total;

	void *page;
	u8 *buffer;
	u8 *iv;

	int flags;
};

extern const struct crypto_type crypto_ablkcipher_type;
extern const struct crypto_type crypto_blkcipher_type;
extern const struct crypto_type crypto_hash_type;

void crypto_mod_put(struct crypto_alg *alg);

int crypto_register_template(struct crypto_template *tmpl);
void crypto_unregister_template(struct crypto_template *tmpl);
struct crypto_template *crypto_lookup_template(const char *name);

int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
		      struct crypto_instance *inst, u32 mask);
void crypto_drop_spawn(struct crypto_spawn *spawn);
struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
				    u32 mask);

struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
int crypto_check_attr_type(struct rtattr **tb, u32 type);
struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb, u32 type, u32 mask);
struct crypto_instance *crypto_alloc_instance(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);
struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);

int blkcipher_walk_done(struct blkcipher_desc *desc,
			struct blkcipher_walk *walk, int err);
int blkcipher_walk_virt(struct blkcipher_desc *desc,
			struct blkcipher_walk *walk);
int blkcipher_walk_phys(struct blkcipher_desc *desc,
			struct blkcipher_walk *walk);

static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
{
	unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
	unsigned long align = crypto_tfm_alg_alignmask(tfm);

	if (align <= crypto_tfm_ctx_alignment())
		align = 1;
	return (void *)ALIGN(addr, align);
}

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

static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
	struct crypto_ablkcipher *tfm)
{
	return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
}

static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
{
	return crypto_tfm_ctx(&tfm->base);
}

static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
{
	return crypto_tfm_ctx(&tfm->base);
}

static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
{
	return crypto_tfm_ctx_aligned(&tfm->base);
}

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_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_HASH;
	u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;

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

static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
{
	return crypto_tfm_ctx_aligned(&tfm->base);
}

static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
				       struct scatterlist *dst,
				       struct scatterlist *src,
				       unsigned int nbytes)
{
	walk->in.sg = src;
	walk->out.sg = dst;
	walk->total = nbytes;
}

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 int ablkcipher_enqueue_request(struct ablkcipher_alg *alg,
					     struct ablkcipher_request *request)
{
	return crypto_enqueue_request(alg->queue, &request->base);
}

static inline struct ablkcipher_request *ablkcipher_dequeue_request(
	struct ablkcipher_alg *alg)
{
	return ablkcipher_request_cast(crypto_dequeue_request(alg->queue));
}

static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
{
	return req->__ctx;
}

static inline int ablkcipher_tfm_in_queue(struct crypto_ablkcipher *tfm)
{
	return crypto_tfm_in_queue(crypto_ablkcipher_alg(tfm)->queue,
				   crypto_ablkcipher_tfm(tfm));
}

#endif	/* _CRYPTO_ALGAPI_H */
Commit	Line	Data
cce9e06d HX	1	/*
	2	* Cryptographic API for algorithms (i.e., low-level API).
	3	*
	4	* Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the Free
	8	* Software Foundation; either version 2 of the License, or (at your option)
	9	* any later version.
	10	*
	11	*/
	12	#ifndef _CRYPTO_ALGAPI_H
	13	#define _CRYPTO_ALGAPI_H
	14
	15	#include <linux/crypto.h>
b5b7f088 HX	16	#include <linux/list.h>
b5b7f088 HX	17	#include <linux/kernel.h>
cce9e06d	18
4cc7720c	19	struct module;
ebc610e5	20	struct rtattr;
e853c3cf HX	21	struct seq_file;
	22
	23	struct crypto_type {
27d2a330 HX	24	unsigned int (ctxsize)(struct crypto_alg alg, u32 type, u32 mask);
27d2a330 HX	25	int (init)(struct crypto_tfm tfm, u32 type, u32 mask);
e853c3cf HX	26	void (exit)(struct crypto_tfm tfm);
	27	void (show)(struct seq_file m, struct crypto_alg *alg);
	28	};
4cc7720c HX	29
	30	struct crypto_instance {
	31	struct crypto_alg alg;
	32
	33	struct crypto_template *tmpl;
	34	struct hlist_node list;
	35
	36	void *__ctx[] CRYPTO_MINALIGN_ATTR;
	37	};
	38
	39	struct crypto_template {
	40	struct list_head list;
	41	struct hlist_head instances;
	42	struct module *module;
	43
ebc610e5	44	struct crypto_instance (alloc)(struct rtattr **tb);
4cc7720c HX	45	void (free)(struct crypto_instance inst);
	46
	47	char name[CRYPTO_MAX_ALG_NAME];
	48	};
	49
6bfd4809 HX	50	struct crypto_spawn {
	51	struct list_head list;
	52	struct crypto_alg *alg;
	53	struct crypto_instance *inst;
a73e6996	54	u32 mask;
6bfd4809 HX	55	};
6bfd4809 HX	56
b5b7f088 HX	57	struct crypto_queue {
	58	struct list_head list;
	59	struct list_head *backlog;
	60
	61	unsigned int qlen;
	62	unsigned int max_qlen;
	63	};
	64
5c64097a HX	65	struct scatter_walk {
	66	struct scatterlist *sg;
	67	unsigned int offset;
	68	};
	69
5cde0af2 HX	70	struct blkcipher_walk {
	71	union {
	72	struct {
	73	struct page *page;
	74	unsigned long offset;
	75	} phys;
	76
	77	struct {
	78	u8 *page;
	79	u8 *addr;
	80	} virt;
	81	} src, dst;
	82
	83	struct scatter_walk in;
	84	unsigned int nbytes;
	85
	86	struct scatter_walk out;
	87	unsigned int total;
	88
	89	void *page;
	90	u8 *buffer;
	91	u8 *iv;
	92
	93	int flags;
	94	};
	95
b5b7f088	96	extern const struct crypto_type crypto_ablkcipher_type;
5cde0af2	97	extern const struct crypto_type crypto_blkcipher_type;
055bcee3	98	extern const struct crypto_type crypto_hash_type;
5cde0af2	99
db131ef9 HX	100	void crypto_mod_put(struct crypto_alg *alg);
db131ef9 HX	101
4cc7720c HX	102	int crypto_register_template(struct crypto_template *tmpl);
	103	void crypto_unregister_template(struct crypto_template *tmpl);
	104	struct crypto_template crypto_lookup_template(const char name);
	105
6bfd4809	106	int crypto_init_spawn(struct crypto_spawn spawn, struct crypto_alg alg,
a73e6996	107	struct crypto_instance *inst, u32 mask);
6bfd4809	108	void crypto_drop_spawn(struct crypto_spawn *spawn);
2e306ee0 HX	109	struct crypto_tfm crypto_spawn_tfm(struct crypto_spawn spawn, u32 type,
2e306ee0 HX	110	u32 mask);
6bfd4809	111
ebc610e5 HX	112	struct crypto_attr_type crypto_get_attr_type(struct rtattr *tb);
	113	int crypto_check_attr_type(struct rtattr **tb, u32 type);
	114	struct crypto_alg crypto_get_attr_alg(struct rtattr *tb, u32 type, u32 mask);
7fed0bf2 HX	115	struct crypto_instance crypto_alloc_instance(const char name,
	116	struct crypto_alg *alg);
	117
b5b7f088 HX	118	void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
	119	int crypto_enqueue_request(struct crypto_queue *queue,
	120	struct crypto_async_request *request);
	121	struct crypto_async_request crypto_dequeue_request(struct crypto_queue queue);
	122	int crypto_tfm_in_queue(struct crypto_queue queue, struct crypto_tfm tfm);
	123
5cde0af2 HX	124	int blkcipher_walk_done(struct blkcipher_desc *desc,
	125	struct blkcipher_walk *walk, int err);
	126	int blkcipher_walk_virt(struct blkcipher_desc *desc,
	127	struct blkcipher_walk *walk);
	128	int blkcipher_walk_phys(struct blkcipher_desc *desc,
	129	struct blkcipher_walk *walk);
	130
	131	static inline void crypto_tfm_ctx_aligned(struct crypto_tfm tfm)
	132	{
	133	unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
	134	unsigned long align = crypto_tfm_alg_alignmask(tfm);
	135
	136	if (align <= crypto_tfm_ctx_alignment())
	137	align = 1;
	138	return (void *)ALIGN(addr, align);
	139	}
	140
4cc7720c HX	141	static inline void crypto_instance_ctx(struct crypto_instance inst)
	142	{
	143	return inst->__ctx;
	144	}
	145
b5b7f088 HX	146	static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
	147	struct crypto_ablkcipher *tfm)
	148	{
	149	return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
	150	}
	151
	152	static inline void crypto_ablkcipher_ctx(struct crypto_ablkcipher tfm)
	153	{
	154	return crypto_tfm_ctx(&tfm->base);
	155	}
	156
5cde0af2 HX	157	static inline void crypto_blkcipher_ctx(struct crypto_blkcipher tfm)
	158	{
	159	return crypto_tfm_ctx(&tfm->base);
	160	}
	161
	162	static inline void crypto_blkcipher_ctx_aligned(struct crypto_blkcipher tfm)
	163	{
	164	return crypto_tfm_ctx_aligned(&tfm->base);
	165	}
	166
2e306ee0 HX	167	static inline struct crypto_cipher *crypto_spawn_cipher(
	168	struct crypto_spawn *spawn)
	169	{
	170	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	171	u32 mask = CRYPTO_ALG_TYPE_MASK;
	172
	173	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
	174	}
	175
f28776a3 HX	176	static inline struct cipher_alg crypto_cipher_alg(struct crypto_cipher tfm)
	177	{
	178	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
	179	}
	180
2e306ee0 HX	181	static inline struct crypto_hash crypto_spawn_hash(struct crypto_spawn spawn)
	182	{
	183	u32 type = CRYPTO_ALG_TYPE_HASH;
	184	u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
	185
	186	return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
	187	}
	188
055bcee3 HX	189	static inline void crypto_hash_ctx_aligned(struct crypto_hash tfm)
	190	{
	191	return crypto_tfm_ctx_aligned(&tfm->base);
	192	}
	193
5cde0af2 HX	194	static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
	195	struct scatterlist *dst,
	196	struct scatterlist *src,
	197	unsigned int nbytes)
	198	{
	199	walk->in.sg = src;
	200	walk->out.sg = dst;
	201	walk->total = nbytes;
	202	}
	203
b5b7f088 HX	204	static inline struct crypto_async_request *crypto_get_backlog(
	205	struct crypto_queue *queue)
	206	{
	207	return queue->backlog == &queue->list ? NULL :
	208	container_of(queue->backlog, struct crypto_async_request, list);
	209	}
	210
	211	static inline int ablkcipher_enqueue_request(struct ablkcipher_alg *alg,
	212	struct ablkcipher_request *request)
	213	{
	214	return crypto_enqueue_request(alg->queue, &request->base);
	215	}
	216
	217	static inline struct ablkcipher_request *ablkcipher_dequeue_request(
	218	struct ablkcipher_alg *alg)
	219	{
	220	return ablkcipher_request_cast(crypto_dequeue_request(alg->queue));
	221	}
	222
	223	static inline void ablkcipher_request_ctx(struct ablkcipher_request req)
	224	{
	225	return req->__ctx;
	226	}
	227
	228	static inline int ablkcipher_tfm_in_queue(struct crypto_ablkcipher *tfm)
	229	{
	230	return crypto_tfm_in_queue(crypto_ablkcipher_alg(tfm)->queue,
	231	crypto_ablkcipher_tfm(tfm));
	232	}
	233
cce9e06d HX	234	#endif /* _CRYPTO_ALGAPI_H */
cce9e06d HX	235