crypto: crc32c - Add ahash implementation
[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 extern const struct crypto_type crypto_ahash_type;
102
103 void crypto_mod_put(struct crypto_alg *alg);
104
105 int crypto_register_template(struct crypto_template *tmpl);
106 void crypto_unregister_template(struct crypto_template *tmpl);
107 struct crypto_template *crypto_lookup_template(const char *name);
108
109 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
110                       struct crypto_instance *inst, u32 mask);
111 void crypto_drop_spawn(struct crypto_spawn *spawn);
112 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
113                                     u32 mask);
114
115 static inline void crypto_set_spawn(struct crypto_spawn *spawn,
116                                     struct crypto_instance *inst)
117 {
118         spawn->inst = inst;
119 }
120
121 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
122 int crypto_check_attr_type(struct rtattr **tb, u32 type);
123 const char *crypto_attr_alg_name(struct rtattr *rta);
124 struct crypto_alg *crypto_attr_alg(struct rtattr *rta, u32 type, u32 mask);
125 int crypto_attr_u32(struct rtattr *rta, u32 *num);
126 struct crypto_instance *crypto_alloc_instance(const char *name,
127                                               struct crypto_alg *alg);
128
129 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
130 int crypto_enqueue_request(struct crypto_queue *queue,
131                            struct crypto_async_request *request);
132 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
133 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
134
135 /* These functions require the input/output to be aligned as u32. */
136 void crypto_inc(u8 *a, unsigned int size);
137 void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
138
139 int blkcipher_walk_done(struct blkcipher_desc *desc,
140                         struct blkcipher_walk *walk, int err);
141 int blkcipher_walk_virt(struct blkcipher_desc *desc,
142                         struct blkcipher_walk *walk);
143 int blkcipher_walk_phys(struct blkcipher_desc *desc,
144                         struct blkcipher_walk *walk);
145 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
146                               struct blkcipher_walk *walk,
147                               unsigned int blocksize);
148
149 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
150 {
151         unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
152         unsigned long align = crypto_tfm_alg_alignmask(tfm);
153
154         if (align <= crypto_tfm_ctx_alignment())
155                 align = 1;
156         return (void *)ALIGN(addr, align);
157 }
158
159 static inline struct crypto_instance *crypto_tfm_alg_instance(
160         struct crypto_tfm *tfm)
161 {
162         return container_of(tfm->__crt_alg, struct crypto_instance, alg);
163 }
164
165 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
166 {
167         return inst->__ctx;
168 }
169
170 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
171         struct crypto_ablkcipher *tfm)
172 {
173         return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
174 }
175
176 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
177 {
178         return crypto_tfm_ctx(&tfm->base);
179 }
180
181 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
182 {
183         return crypto_tfm_ctx_aligned(&tfm->base);
184 }
185
186 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
187 {
188         return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
189 }
190
191 static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
192 {
193         return crypto_tfm_ctx(&tfm->base);
194 }
195
196 static inline struct crypto_instance *crypto_aead_alg_instance(
197         struct crypto_aead *aead)
198 {
199         return crypto_tfm_alg_instance(&aead->base);
200 }
201
202 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
203         struct crypto_spawn *spawn)
204 {
205         u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
206         u32 mask = CRYPTO_ALG_TYPE_MASK;
207
208         return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
209 }
210
211 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
212 {
213         return crypto_tfm_ctx(&tfm->base);
214 }
215
216 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
217 {
218         return crypto_tfm_ctx_aligned(&tfm->base);
219 }
220
221 static inline struct crypto_cipher *crypto_spawn_cipher(
222         struct crypto_spawn *spawn)
223 {
224         u32 type = CRYPTO_ALG_TYPE_CIPHER;
225         u32 mask = CRYPTO_ALG_TYPE_MASK;
226
227         return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
228 }
229
230 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
231 {
232         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
233 }
234
235 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
236 {
237         u32 type = CRYPTO_ALG_TYPE_HASH;
238         u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
239
240         return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
241 }
242
243 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
244 {
245         return crypto_tfm_ctx_aligned(&tfm->base);
246 }
247
248 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
249                                        struct scatterlist *dst,
250                                        struct scatterlist *src,
251                                        unsigned int nbytes)
252 {
253         walk->in.sg = src;
254         walk->out.sg = dst;
255         walk->total = nbytes;
256 }
257
258 static inline struct crypto_async_request *crypto_get_backlog(
259         struct crypto_queue *queue)
260 {
261         return queue->backlog == &queue->list ? NULL :
262                container_of(queue->backlog, struct crypto_async_request, list);
263 }
264
265 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
266                                              struct ablkcipher_request *request)
267 {
268         return crypto_enqueue_request(queue, &request->base);
269 }
270
271 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
272         struct crypto_queue *queue)
273 {
274         return ablkcipher_request_cast(crypto_dequeue_request(queue));
275 }
276
277 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
278 {
279         return req->__ctx;
280 }
281
282 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
283                                           struct crypto_ablkcipher *tfm)
284 {
285         return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
286 }
287
288 static inline void *aead_request_ctx(struct aead_request *req)
289 {
290         return req->__ctx;
291 }
292
293 static inline void aead_request_complete(struct aead_request *req, int err)
294 {
295         req->base.complete(&req->base, err);
296 }
297
298 static inline u32 aead_request_flags(struct aead_request *req)
299 {
300         return req->base.flags;
301 }
302
303 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
304                                                      u32 type, u32 mask)
305 {
306         return crypto_attr_alg(tb[1], type, mask);
307 }
308
309 /*
310  * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
311  * Otherwise returns zero.
312  */
313 static inline int crypto_requires_sync(u32 type, u32 mask)
314 {
315         return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
316 }
317
318 static inline void *crypto_ahash_ctx(struct crypto_ahash *tfm)
319 {
320         return crypto_tfm_ctx(&tfm->base);
321 }
322
323 static inline struct ahash_alg *crypto_ahash_alg(
324         struct crypto_ahash *tfm)
325 {
326         return &crypto_ahash_tfm(tfm)->__crt_alg->cra_ahash;
327 }
328
329 static inline int ahash_enqueue_request(struct crypto_queue *queue,
330                                              struct ahash_request *request)
331 {
332         return crypto_enqueue_request(queue, &request->base);
333 }
334
335 static inline struct ahash_request *ahash_dequeue_request(
336         struct crypto_queue *queue)
337 {
338         return ahash_request_cast(crypto_dequeue_request(queue));
339 }
340
341 static inline void *ahash_request_ctx(struct ahash_request *req)
342 {
343         return req->__ctx;
344 }
345
346 static inline int ahash_tfm_in_queue(struct crypto_queue *queue,
347                                           struct crypto_ahash *tfm)
348 {
349         return crypto_tfm_in_queue(queue, crypto_ahash_tfm(tfm));
350 }
351
352
353 #endif  /* _CRYPTO_ALGAPI_H */
354