[linux-2.6-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);
	unsigned int (*extsize)(struct crypto_alg *alg,
				const struct crypto_type *frontend);
	int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
	int (*init_tfm)(struct crypto_tfm *tfm,
		        const struct crypto_type *frontend);
	void (*show)(struct seq_file *m, struct crypto_alg *alg);
	struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask);

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

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

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_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_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(struct crypto_hash *tfm)
{
	return crypto_tfm_ctx(&tfm->base);
}

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

/*
 * 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 (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
}

#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	24	unsigned int (ctxsize)(struct crypto_alg alg, u32 type, u32 mask);
7b0bac64 HX	25	unsigned int (extsize)(struct crypto_alg alg,
7b0bac64 HX	26	const struct crypto_type *frontend);
27d2a330	27	int (init)(struct crypto_tfm tfm, u32 type, u32 mask);
7b0bac64 HX	28	int (init_tfm)(struct crypto_tfm tfm,
7b0bac64 HX	29	const struct crypto_type *frontend);
e853c3cf	30	void (show)(struct seq_file m, struct crypto_alg *alg);
7b0bac64 HX	31	struct crypto_alg (lookup)(const char *name, u32 type, u32 mask);
	32
	33	unsigned int type;
	34	unsigned int maskclear;
	35	unsigned int maskset;
	36	unsigned int tfmsize;
e853c3cf	37	};
4cc7720c HX	38
	39	struct crypto_instance {
	40	struct crypto_alg alg;
	41
	42	struct crypto_template *tmpl;
	43	struct hlist_node list;
	44
	45	void *__ctx[] CRYPTO_MINALIGN_ATTR;
	46	};
	47
	48	struct crypto_template {
	49	struct list_head list;
	50	struct hlist_head instances;
	51	struct module *module;
	52
ebc610e5	53	struct crypto_instance (alloc)(struct rtattr **tb);
4cc7720c HX	54	void (free)(struct crypto_instance inst);
	55
	56	char name[CRYPTO_MAX_ALG_NAME];
	57	};
	58
6bfd4809 HX	59	struct crypto_spawn {
	60	struct list_head list;
	61	struct crypto_alg *alg;
	62	struct crypto_instance *inst;
a73e6996	63	u32 mask;
6bfd4809 HX	64	};
6bfd4809 HX	65
b5b7f088 HX	66	struct crypto_queue {
	67	struct list_head list;
	68	struct list_head *backlog;
	69
	70	unsigned int qlen;
	71	unsigned int max_qlen;
	72	};
	73
5c64097a HX	74	struct scatter_walk {
	75	struct scatterlist *sg;
	76	unsigned int offset;
	77	};
	78
5cde0af2 HX	79	struct blkcipher_walk {
	80	union {
	81	struct {
	82	struct page *page;
	83	unsigned long offset;
	84	} phys;
	85
	86	struct {
	87	u8 *page;
	88	u8 *addr;
	89	} virt;
	90	} src, dst;
	91
	92	struct scatter_walk in;
	93	unsigned int nbytes;
	94
	95	struct scatter_walk out;
	96	unsigned int total;
	97
	98	void *page;
	99	u8 *buffer;
	100	u8 *iv;
	101
	102	int flags;
7607bd8f	103	unsigned int blocksize;
5cde0af2 HX	104	};
5cde0af2 HX	105
b5b7f088	106	extern const struct crypto_type crypto_ablkcipher_type;
1ae97820	107	extern const struct crypto_type crypto_aead_type;
5cde0af2	108	extern const struct crypto_type crypto_blkcipher_type;
055bcee3	109	extern const struct crypto_type crypto_hash_type;
5cde0af2	110
db131ef9 HX	111	void crypto_mod_put(struct crypto_alg *alg);
db131ef9 HX	112
4cc7720c HX	113	int crypto_register_template(struct crypto_template *tmpl);
	114	void crypto_unregister_template(struct crypto_template *tmpl);
	115	struct crypto_template crypto_lookup_template(const char name);
	116
6bfd4809	117	int crypto_init_spawn(struct crypto_spawn spawn, struct crypto_alg alg,
a73e6996	118	struct crypto_instance *inst, u32 mask);
6bfd4809	119	void crypto_drop_spawn(struct crypto_spawn *spawn);
2e306ee0 HX	120	struct crypto_tfm crypto_spawn_tfm(struct crypto_spawn spawn, u32 type,
2e306ee0 HX	121	u32 mask);
6bfd4809	122
378f4f51 HX	123	static inline void crypto_set_spawn(struct crypto_spawn *spawn,
	124	struct crypto_instance *inst)
	125	{
	126	spawn->inst = inst;
	127	}
	128
ebc610e5 HX	129	struct crypto_attr_type crypto_get_attr_type(struct rtattr *tb);
ebc610e5 HX	130	int crypto_check_attr_type(struct rtattr **tb, u32 type);
68b6c7d6	131	const char crypto_attr_alg_name(struct rtattr rta);
3c09f17c HX	132	struct crypto_alg crypto_attr_alg(struct rtattr rta, u32 type, u32 mask);
3c09f17c HX	133	int crypto_attr_u32(struct rtattr rta, u32 num);
7fed0bf2 HX	134	struct crypto_instance crypto_alloc_instance(const char name,
	135	struct crypto_alg *alg);
	136
b5b7f088 HX	137	void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
	138	int crypto_enqueue_request(struct crypto_queue *queue,
	139	struct crypto_async_request *request);
	140	struct crypto_async_request crypto_dequeue_request(struct crypto_queue queue);
	141	int crypto_tfm_in_queue(struct crypto_queue queue, struct crypto_tfm tfm);
	142
7613636d HX	143	/* These functions require the input/output to be aligned as u32. */
	144	void crypto_inc(u8 *a, unsigned int size);
	145	void crypto_xor(u8 dst, const u8 src, unsigned int size);
	146
5cde0af2 HX	147	int blkcipher_walk_done(struct blkcipher_desc *desc,
	148	struct blkcipher_walk *walk, int err);
	149	int blkcipher_walk_virt(struct blkcipher_desc *desc,
	150	struct blkcipher_walk *walk);
	151	int blkcipher_walk_phys(struct blkcipher_desc *desc,
	152	struct blkcipher_walk *walk);
7607bd8f HX	153	int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
	154	struct blkcipher_walk *walk,
	155	unsigned int blocksize);
5cde0af2 HX	156
	157	static inline void crypto_tfm_ctx_aligned(struct crypto_tfm tfm)
	158	{
	159	unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
	160	unsigned long align = crypto_tfm_alg_alignmask(tfm);
	161
	162	if (align <= crypto_tfm_ctx_alignment())
	163	align = 1;
	164	return (void *)ALIGN(addr, align);
	165	}
	166
124b53d0 HX	167	static inline struct crypto_instance *crypto_tfm_alg_instance(
	168	struct crypto_tfm *tfm)
	169	{
	170	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
	171	}
	172
4cc7720c HX	173	static inline void crypto_instance_ctx(struct crypto_instance inst)
	174	{
	175	return inst->__ctx;
	176	}
	177
b5b7f088 HX	178	static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
	179	struct crypto_ablkcipher *tfm)
	180	{
	181	return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
	182	}
	183
	184	static inline void crypto_ablkcipher_ctx(struct crypto_ablkcipher tfm)
	185	{
	186	return crypto_tfm_ctx(&tfm->base);
	187	}
	188
aa379a6a SS	189	static inline void crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher tfm)
	190	{
	191	return crypto_tfm_ctx_aligned(&tfm->base);
	192	}
	193
1ae97820 HX	194	static inline struct aead_alg crypto_aead_alg(struct crypto_aead tfm)
	195	{
	196	return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
	197	}
	198
3c09f17c HX	199	static inline void crypto_aead_ctx(struct crypto_aead tfm)
	200	{
	201	return crypto_tfm_ctx(&tfm->base);
	202	}
	203
	204	static inline struct crypto_instance *crypto_aead_alg_instance(
	205	struct crypto_aead *aead)
	206	{
	207	return crypto_tfm_alg_instance(&aead->base);
	208	}
	209
124b53d0 HX	210	static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
	211	struct crypto_spawn *spawn)
	212	{
	213	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
332f8840	214	u32 mask = CRYPTO_ALG_TYPE_MASK;
124b53d0 HX	215
	216	return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
	217	}
	218
5cde0af2 HX	219	static inline void crypto_blkcipher_ctx(struct crypto_blkcipher tfm)
	220	{
	221	return crypto_tfm_ctx(&tfm->base);
	222	}
	223
	224	static inline void crypto_blkcipher_ctx_aligned(struct crypto_blkcipher tfm)
	225	{
	226	return crypto_tfm_ctx_aligned(&tfm->base);
	227	}
	228
2e306ee0 HX	229	static inline struct crypto_cipher *crypto_spawn_cipher(
	230	struct crypto_spawn *spawn)
	231	{
	232	u32 type = CRYPTO_ALG_TYPE_CIPHER;
	233	u32 mask = CRYPTO_ALG_TYPE_MASK;
	234
	235	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
	236	}
	237
f28776a3 HX	238	static inline struct cipher_alg crypto_cipher_alg(struct crypto_cipher tfm)
	239	{
	240	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
	241	}
	242
2e306ee0 HX	243	static inline struct crypto_hash crypto_spawn_hash(struct crypto_spawn spawn)
	244	{
	245	u32 type = CRYPTO_ALG_TYPE_HASH;
	246	u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
	247
	248	return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
	249	}
	250
5f7082ed HX	251	static inline void crypto_hash_ctx(struct crypto_hash tfm)
	252	{
	253	return crypto_tfm_ctx(&tfm->base);
	254	}
	255
055bcee3 HX	256	static inline void crypto_hash_ctx_aligned(struct crypto_hash tfm)
	257	{
	258	return crypto_tfm_ctx_aligned(&tfm->base);
	259	}
	260
5cde0af2 HX	261	static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
	262	struct scatterlist *dst,
	263	struct scatterlist *src,
	264	unsigned int nbytes)
	265	{
	266	walk->in.sg = src;
	267	walk->out.sg = dst;
	268	walk->total = nbytes;
	269	}
	270
b5b7f088 HX	271	static inline struct crypto_async_request *crypto_get_backlog(
	272	struct crypto_queue *queue)
	273	{
	274	return queue->backlog == &queue->list ? NULL :
	275	container_of(queue->backlog, struct crypto_async_request, list);
	276	}
	277
2de98e75	278	static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
b5b7f088 HX	279	struct ablkcipher_request *request)
b5b7f088 HX	280	{
2de98e75	281	return crypto_enqueue_request(queue, &request->base);
b5b7f088 HX	282	}
	283
	284	static inline struct ablkcipher_request *ablkcipher_dequeue_request(
2de98e75	285	struct crypto_queue *queue)
b5b7f088	286	{
2de98e75	287	return ablkcipher_request_cast(crypto_dequeue_request(queue));
b5b7f088 HX	288	}
	289
	290	static inline void ablkcipher_request_ctx(struct ablkcipher_request req)
	291	{
	292	return req->__ctx;
	293	}
	294
2de98e75 HX	295	static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
2de98e75 HX	296	struct crypto_ablkcipher *tfm)
b5b7f088	297	{
2de98e75	298	return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
b5b7f088 HX	299	}
b5b7f088 HX	300
3c09f17c HX	301	static inline void aead_request_ctx(struct aead_request req)
	302	{
	303	return req->__ctx;
	304	}
	305
	306	static inline void aead_request_complete(struct aead_request *req, int err)
	307	{
	308	req->base.complete(&req->base, err);
	309	}
	310
	311	static inline u32 aead_request_flags(struct aead_request *req)
	312	{
	313	return req->base.flags;
	314	}
	315
	316	static inline struct crypto_alg crypto_get_attr_alg(struct rtattr *tb,
	317	u32 type, u32 mask)
	318	{
	319	return crypto_attr_alg(tb[1], type, mask);
	320	}
	321
378f4f51 HX	322	/*
	323	* Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
	324	* Otherwise returns zero.
	325	*/
	326	static inline int crypto_requires_sync(u32 type, u32 mask)
	327	{
	328	return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
	329	}
	330
cce9e06d HX	331	#endif /* _CRYPTO_ALGAPI_H */
cce9e06d HX	332