2cdb227fc39dd75be2c7aa10aeb9f4d9ffc1c52a
[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         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
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
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
50 struct crypto_spawn {
51         struct list_head list;
52         struct crypto_alg *alg;
53         struct crypto_instance *inst;
54         u32 mask;
55 };
56
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
65 struct scatter_walk {
66         struct scatterlist *sg;
67         unsigned int offset;
68 };
69
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         unsigned int blocksize;
95 };
96
97 extern const struct crypto_type crypto_ablkcipher_type;
98 extern const struct crypto_type crypto_aead_type;
99 extern const struct crypto_type crypto_blkcipher_type;
100 extern const struct crypto_type crypto_hash_type;
101
102 void crypto_mod_put(struct crypto_alg *alg);
103
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
108 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
109                       struct crypto_instance *inst, u32 mask);
110 void crypto_drop_spawn(struct crypto_spawn *spawn);
111 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
112                                     u32 mask);
113
114 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
115 int crypto_check_attr_type(struct rtattr **tb, u32 type);
116 struct crypto_alg *crypto_attr_alg(struct rtattr *rta, u32 type, u32 mask);
117 int crypto_attr_u32(struct rtattr *rta, u32 *num);
118 struct crypto_instance *crypto_alloc_instance(const char *name,
119                                               struct crypto_alg *alg);
120
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
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
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);
137 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
138                               struct blkcipher_walk *walk,
139                               unsigned int blocksize);
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
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
157 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
158 {
159         return inst->__ctx;
160 }
161
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
173 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
174 {
175         return crypto_tfm_ctx_aligned(&tfm->base);
176 }
177
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
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;
198         u32 mask = CRYPTO_ALG_TYPE_BLKCIPHER_MASK;
199
200         return __crypto_ablkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
201 }
202
203 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
204         struct crypto_spawn *spawn)
205 {
206         u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
207         u32 mask = CRYPTO_ALG_TYPE_MASK;
208
209         return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
210 }
211
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
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
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
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
244 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
245 {
246         return crypto_tfm_ctx_aligned(&tfm->base);
247 }
248
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
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
266 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
267                                              struct ablkcipher_request *request)
268 {
269         return crypto_enqueue_request(queue, &request->base);
270 }
271
272 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
273         struct crypto_queue *queue)
274 {
275         return ablkcipher_request_cast(crypto_dequeue_request(queue));
276 }
277
278 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
279 {
280         return req->__ctx;
281 }
282
283 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
284                                           struct crypto_ablkcipher *tfm)
285 {
286         return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
287 }
288
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
310 #endif  /* _CRYPTO_ALGAPI_H */
311