2 * Cryptographic API for algorithms (i.e., low-level API).
4 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
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)
12 #ifndef _CRYPTO_ALGAPI_H
13 #define _CRYPTO_ALGAPI_H
15 #include <linux/crypto.h>
16 #include <linux/list.h>
17 #include <linux/kernel.h>
18 #include <linux/skbuff.h>
25 unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
26 unsigned int (*extsize)(struct crypto_alg *alg);
27 int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
28 int (*init_tfm)(struct crypto_tfm *tfm);
29 void (*show)(struct seq_file *m, struct crypto_alg *alg);
30 int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
31 struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask);
34 unsigned int maskclear;
39 struct crypto_instance {
40 struct crypto_alg alg;
42 struct crypto_template *tmpl;
43 struct hlist_node list;
45 void *__ctx[] CRYPTO_MINALIGN_ATTR;
48 struct crypto_template {
49 struct list_head list;
50 struct hlist_head instances;
51 struct module *module;
53 struct crypto_instance *(*alloc)(struct rtattr **tb);
54 void (*free)(struct crypto_instance *inst);
55 int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
57 char name[CRYPTO_MAX_ALG_NAME];
61 struct list_head list;
62 struct crypto_alg *alg;
63 struct crypto_instance *inst;
64 const struct crypto_type *frontend;
69 struct list_head list;
70 struct list_head *backlog;
73 unsigned int max_qlen;
77 struct scatterlist *sg;
81 struct blkcipher_walk {
94 struct scatter_walk in;
97 struct scatter_walk out;
105 unsigned int blocksize;
108 struct ablkcipher_walk {
114 struct scatter_walk in;
116 struct scatter_walk out;
118 struct list_head buffers;
122 unsigned int blocksize;
125 extern const struct crypto_type crypto_ablkcipher_type;
126 extern const struct crypto_type crypto_aead_type;
127 extern const struct crypto_type crypto_blkcipher_type;
129 void crypto_mod_put(struct crypto_alg *alg);
131 int crypto_register_template(struct crypto_template *tmpl);
132 void crypto_unregister_template(struct crypto_template *tmpl);
133 struct crypto_template *crypto_lookup_template(const char *name);
135 int crypto_register_instance(struct crypto_template *tmpl,
136 struct crypto_instance *inst);
137 int crypto_unregister_instance(struct crypto_alg *alg);
139 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
140 struct crypto_instance *inst, u32 mask);
141 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
142 struct crypto_instance *inst,
143 const struct crypto_type *frontend);
145 void crypto_drop_spawn(struct crypto_spawn *spawn);
146 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
148 void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
150 static inline void crypto_set_spawn(struct crypto_spawn *spawn,
151 struct crypto_instance *inst)
156 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
157 int crypto_check_attr_type(struct rtattr **tb, u32 type);
158 const char *crypto_attr_alg_name(struct rtattr *rta);
159 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
160 const struct crypto_type *frontend,
163 static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
166 return crypto_attr_alg2(rta, NULL, type, mask);
169 int crypto_attr_u32(struct rtattr *rta, u32 *num);
170 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
172 struct crypto_instance *crypto_alloc_instance(const char *name,
173 struct crypto_alg *alg);
175 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
176 int crypto_enqueue_request(struct crypto_queue *queue,
177 struct crypto_async_request *request);
178 void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset);
179 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
180 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
182 /* These functions require the input/output to be aligned as u32. */
183 void crypto_inc(u8 *a, unsigned int size);
184 void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
186 int blkcipher_walk_done(struct blkcipher_desc *desc,
187 struct blkcipher_walk *walk, int err);
188 int blkcipher_walk_virt(struct blkcipher_desc *desc,
189 struct blkcipher_walk *walk);
190 int blkcipher_walk_phys(struct blkcipher_desc *desc,
191 struct blkcipher_walk *walk);
192 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
193 struct blkcipher_walk *walk,
194 unsigned int blocksize);
195 int blkcipher_aead_walk_virt_block(struct blkcipher_desc *desc,
196 struct blkcipher_walk *walk,
197 struct crypto_aead *tfm,
198 unsigned int blocksize);
200 int ablkcipher_walk_done(struct ablkcipher_request *req,
201 struct ablkcipher_walk *walk, int err);
202 int ablkcipher_walk_phys(struct ablkcipher_request *req,
203 struct ablkcipher_walk *walk);
204 void __ablkcipher_walk_complete(struct ablkcipher_walk *walk);
206 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
208 return PTR_ALIGN(crypto_tfm_ctx(tfm),
209 crypto_tfm_alg_alignmask(tfm) + 1);
212 static inline struct crypto_instance *crypto_tfm_alg_instance(
213 struct crypto_tfm *tfm)
215 return container_of(tfm->__crt_alg, struct crypto_instance, alg);
218 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
223 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
224 struct crypto_ablkcipher *tfm)
226 return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
229 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
231 return crypto_tfm_ctx(&tfm->base);
234 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
236 return crypto_tfm_ctx_aligned(&tfm->base);
239 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
241 return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
244 static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
246 return crypto_tfm_ctx(&tfm->base);
249 static inline struct crypto_instance *crypto_aead_alg_instance(
250 struct crypto_aead *aead)
252 return crypto_tfm_alg_instance(&aead->base);
255 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
256 struct crypto_spawn *spawn)
258 u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
259 u32 mask = CRYPTO_ALG_TYPE_MASK;
261 return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
264 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
266 return crypto_tfm_ctx(&tfm->base);
269 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
271 return crypto_tfm_ctx_aligned(&tfm->base);
274 static inline struct crypto_cipher *crypto_spawn_cipher(
275 struct crypto_spawn *spawn)
277 u32 type = CRYPTO_ALG_TYPE_CIPHER;
278 u32 mask = CRYPTO_ALG_TYPE_MASK;
280 return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
283 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
285 return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
288 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
290 u32 type = CRYPTO_ALG_TYPE_HASH;
291 u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
293 return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
296 static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
298 return crypto_tfm_ctx(&tfm->base);
301 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
303 return crypto_tfm_ctx_aligned(&tfm->base);
306 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
307 struct scatterlist *dst,
308 struct scatterlist *src,
313 walk->total = nbytes;
316 static inline void ablkcipher_walk_init(struct ablkcipher_walk *walk,
317 struct scatterlist *dst,
318 struct scatterlist *src,
323 walk->total = nbytes;
324 INIT_LIST_HEAD(&walk->buffers);
327 static inline void ablkcipher_walk_complete(struct ablkcipher_walk *walk)
329 if (unlikely(!list_empty(&walk->buffers)))
330 __ablkcipher_walk_complete(walk);
333 static inline struct crypto_async_request *crypto_get_backlog(
334 struct crypto_queue *queue)
336 return queue->backlog == &queue->list ? NULL :
337 container_of(queue->backlog, struct crypto_async_request, list);
340 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
341 struct ablkcipher_request *request)
343 return crypto_enqueue_request(queue, &request->base);
346 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
347 struct crypto_queue *queue)
349 return ablkcipher_request_cast(crypto_dequeue_request(queue));
352 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
357 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
358 struct crypto_ablkcipher *tfm)
360 return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
363 static inline void *aead_request_ctx(struct aead_request *req)
368 static inline void aead_request_complete(struct aead_request *req, int err)
370 req->base.complete(&req->base, err);
373 static inline u32 aead_request_flags(struct aead_request *req)
375 return req->base.flags;
378 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
381 return crypto_attr_alg(tb[1], type, mask);
385 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
386 * Otherwise returns zero.
388 static inline int crypto_requires_sync(u32 type, u32 mask)
390 return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
393 #endif /* _CRYPTO_ALGAPI_H */