[CRYPTO] api: Do not remove users unless new algorithm matches
[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 };
95
96 extern const struct crypto_type crypto_ablkcipher_type;
97 extern const struct crypto_type crypto_blkcipher_type;
98 extern const struct crypto_type crypto_hash_type;
99
100 void crypto_mod_put(struct crypto_alg *alg);
101
102 int crypto_register_template(struct crypto_template *tmpl);
103 void crypto_unregister_template(struct crypto_template *tmpl);
104 struct crypto_template *crypto_lookup_template(const char *name);
105
106 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
107                       struct crypto_instance *inst, u32 mask);
108 void crypto_drop_spawn(struct crypto_spawn *spawn);
109 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
110                                     u32 mask);
111
112 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
113 int crypto_check_attr_type(struct rtattr **tb, u32 type);
114 struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb, u32 type, u32 mask);
115 struct crypto_instance *crypto_alloc_instance(const char *name,
116                                               struct crypto_alg *alg);
117
118 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
119 int crypto_enqueue_request(struct crypto_queue *queue,
120                            struct crypto_async_request *request);
121 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
122 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
123
124 int blkcipher_walk_done(struct blkcipher_desc *desc,
125                         struct blkcipher_walk *walk, int err);
126 int blkcipher_walk_virt(struct blkcipher_desc *desc,
127                         struct blkcipher_walk *walk);
128 int blkcipher_walk_phys(struct blkcipher_desc *desc,
129                         struct blkcipher_walk *walk);
130
131 static 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
141 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
142 {
143         return inst->__ctx;
144 }
145
146 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
147         struct crypto_ablkcipher *tfm)
148 {
149         return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
150 }
151
152 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
153 {
154         return crypto_tfm_ctx(&tfm->base);
155 }
156
157 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
158 {
159         return crypto_tfm_ctx(&tfm->base);
160 }
161
162 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
163 {
164         return crypto_tfm_ctx_aligned(&tfm->base);
165 }
166
167 static inline struct crypto_cipher *crypto_spawn_cipher(
168         struct crypto_spawn *spawn)
169 {
170         u32 type = CRYPTO_ALG_TYPE_CIPHER;
171         u32 mask = CRYPTO_ALG_TYPE_MASK;
172
173         return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
174 }
175
176 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
177 {
178         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
179 }
180
181 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
182 {
183         u32 type = CRYPTO_ALG_TYPE_HASH;
184         u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
185
186         return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
187 }
188
189 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
190 {
191         return crypto_tfm_ctx_aligned(&tfm->base);
192 }
193
194 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
195                                        struct scatterlist *dst,
196                                        struct scatterlist *src,
197                                        unsigned int nbytes)
198 {
199         walk->in.sg = src;
200         walk->out.sg = dst;
201         walk->total = nbytes;
202 }
203
204 static inline struct crypto_async_request *crypto_get_backlog(
205         struct crypto_queue *queue)
206 {
207         return queue->backlog == &queue->list ? NULL :
208                container_of(queue->backlog, struct crypto_async_request, list);
209 }
210
211 static inline int ablkcipher_enqueue_request(struct ablkcipher_alg *alg,
212                                              struct ablkcipher_request *request)
213 {
214         return crypto_enqueue_request(alg->queue, &request->base);
215 }
216
217 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
218         struct ablkcipher_alg *alg)
219 {
220         return ablkcipher_request_cast(crypto_dequeue_request(alg->queue));
221 }
222
223 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
224 {
225         return req->__ctx;
226 }
227
228 static inline int ablkcipher_tfm_in_queue(struct crypto_ablkcipher *tfm)
229 {
230         return crypto_tfm_in_queue(crypto_ablkcipher_alg(tfm)->queue,
231                                    crypto_ablkcipher_tfm(tfm));
232 }
233
234 #endif  /* _CRYPTO_ALGAPI_H */
235