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