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>
16#include <linux/list.h>
17#include <linux/kernel.h>
18
19struct module;
20struct rtattr;
21struct seq_file;
22
23struct crypto_type {
24	unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
25	int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
26	void (*exit)(struct crypto_tfm *tfm);
27	void (*show)(struct seq_file *m, struct crypto_alg *alg);
28};
29
30struct 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
39struct crypto_template {
40	struct list_head list;
41	struct hlist_head instances;
42	struct module *module;
43
44	struct crypto_instance *(*alloc)(struct rtattr **tb);
45	void (*free)(struct crypto_instance *inst);
46
47	char name[CRYPTO_MAX_ALG_NAME];
48};
49
50struct crypto_spawn {
51	struct list_head list;
52	struct crypto_alg *alg;
53	struct crypto_instance *inst;
54	u32 mask;
55};
56
57struct crypto_queue {
58	struct list_head list;
59	struct list_head *backlog;
60
61	unsigned int qlen;
62	unsigned int max_qlen;
63};
64
65struct scatter_walk {
66	struct scatterlist *sg;
67	unsigned int offset;
68};
69
70struct 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
96extern const struct crypto_type crypto_ablkcipher_type;
97extern const struct crypto_type crypto_blkcipher_type;
98extern const struct crypto_type crypto_hash_type;
99
100void crypto_mod_put(struct crypto_alg *alg);
101
102int crypto_register_template(struct crypto_template *tmpl);
103void crypto_unregister_template(struct crypto_template *tmpl);
104struct crypto_template *crypto_lookup_template(const char *name);
105
106int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
107		      struct crypto_instance *inst, u32 mask);
108void crypto_drop_spawn(struct crypto_spawn *spawn);
109struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
110				    u32 mask);
111
112struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
113int crypto_check_attr_type(struct rtattr **tb, u32 type);
114struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb, u32 type, u32 mask);
115struct crypto_instance *crypto_alloc_instance(const char *name,
116					      struct crypto_alg *alg);
117
118void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
119int crypto_enqueue_request(struct crypto_queue *queue,
120			   struct crypto_async_request *request);
121struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
122int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
123
124int blkcipher_walk_done(struct blkcipher_desc *desc,
125			struct blkcipher_walk *walk, int err);
126int blkcipher_walk_virt(struct blkcipher_desc *desc,
127			struct blkcipher_walk *walk);
128int blkcipher_walk_phys(struct blkcipher_desc *desc,
129			struct blkcipher_walk *walk);
130
131static 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
141static inline struct crypto_instance *crypto_tfm_alg_instance(
142	struct crypto_tfm *tfm)
143{
144	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
145}
146
147static inline void *crypto_instance_ctx(struct crypto_instance *inst)
148{
149	return inst->__ctx;
150}
151
152static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
153	struct crypto_ablkcipher *tfm)
154{
155	return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
156}
157
158static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
159{
160	return crypto_tfm_ctx(&tfm->base);
161}
162
163static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
164	struct crypto_spawn *spawn)
165{
166	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
167	u32 mask = CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC;
168
169	return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
170}
171
172static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
173{
174	return crypto_tfm_ctx(&tfm->base);
175}
176
177static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
178{
179	return crypto_tfm_ctx_aligned(&tfm->base);
180}
181
182static inline struct crypto_cipher *crypto_spawn_cipher(
183	struct crypto_spawn *spawn)
184{
185	u32 type = CRYPTO_ALG_TYPE_CIPHER;
186	u32 mask = CRYPTO_ALG_TYPE_MASK;
187
188	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
189}
190
191static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
192{
193	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
194}
195
196static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
197{
198	u32 type = CRYPTO_ALG_TYPE_HASH;
199	u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
200
201	return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
202}
203
204static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
205{
206	return crypto_tfm_ctx_aligned(&tfm->base);
207}
208
209static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
210				       struct scatterlist *dst,
211				       struct scatterlist *src,
212				       unsigned int nbytes)
213{
214	walk->in.sg = src;
215	walk->out.sg = dst;
216	walk->total = nbytes;
217}
218
219static inline struct crypto_async_request *crypto_get_backlog(
220	struct crypto_queue *queue)
221{
222	return queue->backlog == &queue->list ? NULL :
223	       container_of(queue->backlog, struct crypto_async_request, list);
224}
225
226static inline int ablkcipher_enqueue_request(struct ablkcipher_alg *alg,
227					     struct ablkcipher_request *request)
228{
229	return crypto_enqueue_request(alg->queue, &request->base);
230}
231
232static inline struct ablkcipher_request *ablkcipher_dequeue_request(
233	struct ablkcipher_alg *alg)
234{
235	return ablkcipher_request_cast(crypto_dequeue_request(alg->queue));
236}
237
238static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
239{
240	return req->__ctx;
241}
242
243static inline int ablkcipher_tfm_in_queue(struct crypto_ablkcipher *tfm)
244{
245	return crypto_tfm_in_queue(crypto_ablkcipher_alg(tfm)->queue,
246				   crypto_ablkcipher_tfm(tfm));
247}
248
249#endif	/* _CRYPTO_ALGAPI_H */
250