[linux-block.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;
	unsigned int blocksize;
};

extern const struct crypto_type crypto_ablkcipher_type;
extern const struct crypto_type crypto_aead_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_attr_alg(struct rtattr *rta, u32 type, u32 mask);
int crypto_attr_u32(struct rtattr *rta, u32 *num);
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);

/* These functions require the input/output to be aligned as u32. */
void crypto_inc(u8 *a, unsigned int size);
void crypto_xor(u8 *dst, const u8 *src, unsigned int size);

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);
int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
			      struct blkcipher_walk *walk,
			      unsigned int blocksize);

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 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 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_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
{
	return crypto_tfm_ctx_aligned(&tfm->base);
}

static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
{
	return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
}

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

static inline struct crypto_instance *crypto_aead_alg_instance(
	struct crypto_aead *aead)
{
	return crypto_tfm_alg_instance(&aead->base);
}

static inline struct crypto_ablkcipher *crypto_spawn_ablkcipher(
	struct crypto_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
	u32 mask = CRYPTO_ALG_TYPE_BLKCIPHER_MASK;

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

static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
	struct crypto_spawn *spawn)
{
	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
	u32 mask = CRYPTO_ALG_TYPE_MASK;

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

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

static inline struct ablkcipher_request *ablkcipher_dequeue_request(
	struct crypto_queue *queue)
{
	return ablkcipher_request_cast(crypto_dequeue_request(queue));
}

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

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

static inline void *aead_request_ctx(struct aead_request *req)
{
	return req->__ctx;
}

static inline void aead_request_complete(struct aead_request *req, int err)
{
	req->base.complete(&req->base, err);
}

static inline u32 aead_request_flags(struct aead_request *req)
{
	return req->base.flags;
}

static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
						     u32 type, u32 mask)
{
	return crypto_attr_alg(tb[1], type, mask);
}

#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;
7607bd8f	94	unsigned int blocksize;
5cde0af2 HX	95	};
5cde0af2 HX	96
b5b7f088	97	extern const struct crypto_type crypto_ablkcipher_type;
1ae97820	98	extern const struct crypto_type crypto_aead_type;
5cde0af2	99	extern const struct crypto_type crypto_blkcipher_type;
055bcee3	100	extern const struct crypto_type crypto_hash_type;
5cde0af2	101
db131ef9 HX	102	void crypto_mod_put(struct crypto_alg *alg);
db131ef9 HX	103
4cc7720c HX	104	int crypto_register_template(struct crypto_template *tmpl);
	105	void crypto_unregister_template(struct crypto_template *tmpl);
	106	struct crypto_template crypto_lookup_template(const char name);
	107
6bfd4809	108	int crypto_init_spawn(struct crypto_spawn spawn, struct crypto_alg alg,
a73e6996	109	struct crypto_instance *inst, u32 mask);
6bfd4809	110	void crypto_drop_spawn(struct crypto_spawn *spawn);
2e306ee0 HX	111	struct crypto_tfm crypto_spawn_tfm(struct crypto_spawn spawn, u32 type,
2e306ee0 HX	112	u32 mask);
6bfd4809	113
ebc610e5 HX	114	struct crypto_attr_type crypto_get_attr_type(struct rtattr *tb);
ebc610e5 HX	115	int crypto_check_attr_type(struct rtattr **tb, u32 type);
3c09f17c HX	116	struct crypto_alg crypto_attr_alg(struct rtattr rta, u32 type, u32 mask);
3c09f17c HX	117	int crypto_attr_u32(struct rtattr rta, u32 num);
7fed0bf2 HX	118	struct crypto_instance crypto_alloc_instance(const char name,
	119	struct crypto_alg *alg);
	120
b5b7f088 HX	121	void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
	122	int crypto_enqueue_request(struct crypto_queue *queue,
	123	struct crypto_async_request *request);
	124	struct crypto_async_request crypto_dequeue_request(struct crypto_queue queue);
	125	int crypto_tfm_in_queue(struct crypto_queue queue, struct crypto_tfm tfm);
	126
7613636d HX	127	/* These functions require the input/output to be aligned as u32. */
	128	void crypto_inc(u8 *a, unsigned int size);
	129	void crypto_xor(u8 dst, const u8 src, unsigned int size);
	130
5cde0af2 HX	131	int blkcipher_walk_done(struct blkcipher_desc *desc,
	132	struct blkcipher_walk *walk, int err);
	133	int blkcipher_walk_virt(struct blkcipher_desc *desc,
	134	struct blkcipher_walk *walk);
	135	int blkcipher_walk_phys(struct blkcipher_desc *desc,
	136	struct blkcipher_walk *walk);
7607bd8f HX	137	int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
	138	struct blkcipher_walk *walk,
	139	unsigned int blocksize);
5cde0af2 HX	140
	141	static inline void crypto_tfm_ctx_aligned(struct crypto_tfm tfm)
	142	{
	143	unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
	144	unsigned long align = crypto_tfm_alg_alignmask(tfm);
	145
	146	if (align <= crypto_tfm_ctx_alignment())
	147	align = 1;
	148	return (void *)ALIGN(addr, align);
	149	}
	150
124b53d0 HX	151	static inline struct crypto_instance *crypto_tfm_alg_instance(
	152	struct crypto_tfm *tfm)
	153	{
	154	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
	155	}
	156
4cc7720c HX	157	static inline void crypto_instance_ctx(struct crypto_instance inst)
	158	{
	159	return inst->__ctx;
	160	}
	161
b5b7f088 HX	162	static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
	163	struct crypto_ablkcipher *tfm)
	164	{
	165	return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
	166	}
	167
	168	static inline void crypto_ablkcipher_ctx(struct crypto_ablkcipher tfm)
	169	{
	170	return crypto_tfm_ctx(&tfm->base);
	171	}
	172
aa379a6a SS	173	static inline void crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher tfm)
	174	{
	175	return crypto_tfm_ctx_aligned(&tfm->base);
	176	}
	177
1ae97820 HX	178	static inline struct aead_alg crypto_aead_alg(struct crypto_aead tfm)
	179	{
	180	return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
	181	}
	182
3c09f17c HX	183	static inline void crypto_aead_ctx(struct crypto_aead tfm)
	184	{
	185	return crypto_tfm_ctx(&tfm->base);
	186	}
	187
	188	static inline struct crypto_instance *crypto_aead_alg_instance(
	189	struct crypto_aead *aead)
	190	{
	191	return crypto_tfm_alg_instance(&aead->base);
	192	}
	193
	194	static inline struct crypto_ablkcipher *crypto_spawn_ablkcipher(
	195	struct crypto_spawn *spawn)
	196	{
	197	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
332f8840	198	u32 mask = CRYPTO_ALG_TYPE_BLKCIPHER_MASK;
3c09f17c HX	199
	200	return __crypto_ablkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
	201	}
	202
124b53d0 HX	203	static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
	204	struct crypto_spawn *spawn)
	205	{
	206	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
332f8840	207	u32 mask = CRYPTO_ALG_TYPE_MASK;
124b53d0 HX	208
	209	return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
	210	}
	211
5cde0af2 HX	212	static inline void crypto_blkcipher_ctx(struct crypto_blkcipher tfm)
	213	{
	214	return crypto_tfm_ctx(&tfm->base);
	215	}
	216
	217	static inline void crypto_blkcipher_ctx_aligned(struct crypto_blkcipher tfm)
	218	{
	219	return crypto_tfm_ctx_aligned(&tfm->base);
	220	}
	221
2e306ee0 HX	222	static inline struct crypto_cipher *crypto_spawn_cipher(
	223	struct crypto_spawn *spawn)
	224	{
	225	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	226	u32 mask = CRYPTO_ALG_TYPE_MASK;
	227
	228	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
	229	}
	230
f28776a3 HX	231	static inline struct cipher_alg crypto_cipher_alg(struct crypto_cipher tfm)
	232	{
	233	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
	234	}
	235
2e306ee0 HX	236	static inline struct crypto_hash crypto_spawn_hash(struct crypto_spawn spawn)
	237	{
	238	u32 type = CRYPTO_ALG_TYPE_HASH;
	239	u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
	240
	241	return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
	242	}
	243
055bcee3 HX	244	static inline void crypto_hash_ctx_aligned(struct crypto_hash tfm)
	245	{
	246	return crypto_tfm_ctx_aligned(&tfm->base);
	247	}
	248
5cde0af2 HX	249	static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
	250	struct scatterlist *dst,
	251	struct scatterlist *src,
	252	unsigned int nbytes)
	253	{
	254	walk->in.sg = src;
	255	walk->out.sg = dst;
	256	walk->total = nbytes;
	257	}
	258
b5b7f088 HX	259	static inline struct crypto_async_request *crypto_get_backlog(
	260	struct crypto_queue *queue)
	261	{
	262	return queue->backlog == &queue->list ? NULL :
	263	container_of(queue->backlog, struct crypto_async_request, list);
	264	}
	265
2de98e75	266	static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
b5b7f088 HX	267	struct ablkcipher_request *request)
b5b7f088 HX	268	{
2de98e75	269	return crypto_enqueue_request(queue, &request->base);
b5b7f088 HX	270	}
	271
	272	static inline struct ablkcipher_request *ablkcipher_dequeue_request(
2de98e75	273	struct crypto_queue *queue)
b5b7f088	274	{
2de98e75	275	return ablkcipher_request_cast(crypto_dequeue_request(queue));
b5b7f088 HX	276	}
	277
	278	static inline void ablkcipher_request_ctx(struct ablkcipher_request req)
	279	{
	280	return req->__ctx;
	281	}
	282
2de98e75 HX	283	static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
2de98e75 HX	284	struct crypto_ablkcipher *tfm)
b5b7f088	285	{
2de98e75	286	return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
b5b7f088 HX	287	}
b5b7f088 HX	288
3c09f17c HX	289	static inline void aead_request_ctx(struct aead_request req)
	290	{
	291	return req->__ctx;
	292	}
	293
	294	static inline void aead_request_complete(struct aead_request *req, int err)
	295	{
	296	req->base.complete(&req->base, err);
	297	}
	298
	299	static inline u32 aead_request_flags(struct aead_request *req)
	300	{
	301	return req->base.flags;
	302	}
	303
	304	static inline struct crypto_alg crypto_get_attr_alg(struct rtattr *tb,
	305	u32 type, u32 mask)
	306	{
	307	return crypto_attr_alg(tb[1], type, mask);
	308	}
	309
cce9e06d HX	310	#endif /* _CRYPTO_ALGAPI_H */
cce9e06d HX	311