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>
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);
32 unsigned int maskclear;
37 struct crypto_instance {
38 struct crypto_alg alg;
40 struct crypto_template *tmpl;
41 struct hlist_node list;
43 void *__ctx[] CRYPTO_MINALIGN_ATTR;
46 struct crypto_template {
47 struct list_head list;
48 struct hlist_head instances;
49 struct module *module;
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);
55 char name[CRYPTO_MAX_ALG_NAME];
59 struct list_head list;
60 struct crypto_alg *alg;
61 struct crypto_instance *inst;
62 const struct crypto_type *frontend;
67 struct list_head list;
68 struct list_head *backlog;
71 unsigned int max_qlen;
75 struct scatterlist *sg;
79 struct blkcipher_walk {
92 struct scatter_walk in;
95 struct scatter_walk out;
103 unsigned int blocksize;
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;
111 void crypto_mod_put(struct crypto_alg *alg);
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);
117 int crypto_register_instance(struct crypto_template *tmpl,
118 struct crypto_instance *inst);
120 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
121 struct crypto_instance *inst, u32 mask);
122 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
123 struct crypto_instance *inst,
124 const struct crypto_type *frontend);
126 void crypto_drop_spawn(struct crypto_spawn *spawn);
127 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
129 void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
131 static inline void crypto_set_spawn(struct crypto_spawn *spawn,
132 struct crypto_instance *inst)
137 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
138 int crypto_check_attr_type(struct rtattr **tb, u32 type);
139 const char *crypto_attr_alg_name(struct rtattr *rta);
140 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
141 const struct crypto_type *frontend,
144 static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
147 return crypto_attr_alg2(rta, NULL, type, mask);
150 int crypto_attr_u32(struct rtattr *rta, u32 *num);
151 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
153 struct crypto_instance *crypto_alloc_instance(const char *name,
154 struct crypto_alg *alg);
156 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
157 int crypto_enqueue_request(struct crypto_queue *queue,
158 struct crypto_async_request *request);
159 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
160 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
162 /* These functions require the input/output to be aligned as u32. */
163 void crypto_inc(u8 *a, unsigned int size);
164 void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
166 int blkcipher_walk_done(struct blkcipher_desc *desc,
167 struct blkcipher_walk *walk, int err);
168 int blkcipher_walk_virt(struct blkcipher_desc *desc,
169 struct blkcipher_walk *walk);
170 int blkcipher_walk_phys(struct blkcipher_desc *desc,
171 struct blkcipher_walk *walk);
172 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
173 struct blkcipher_walk *walk,
174 unsigned int blocksize);
176 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
178 unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
179 unsigned long align = crypto_tfm_alg_alignmask(tfm);
181 if (align <= crypto_tfm_ctx_alignment())
183 return (void *)ALIGN(addr, align);
186 static inline struct crypto_instance *crypto_tfm_alg_instance(
187 struct crypto_tfm *tfm)
189 return container_of(tfm->__crt_alg, struct crypto_instance, alg);
192 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
197 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
198 struct crypto_ablkcipher *tfm)
200 return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
203 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
205 return crypto_tfm_ctx(&tfm->base);
208 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
210 return crypto_tfm_ctx_aligned(&tfm->base);
213 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
215 return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
218 static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
220 return crypto_tfm_ctx(&tfm->base);
223 static inline struct crypto_instance *crypto_aead_alg_instance(
224 struct crypto_aead *aead)
226 return crypto_tfm_alg_instance(&aead->base);
229 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
230 struct crypto_spawn *spawn)
232 u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
233 u32 mask = CRYPTO_ALG_TYPE_MASK;
235 return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
238 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
240 return crypto_tfm_ctx(&tfm->base);
243 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
245 return crypto_tfm_ctx_aligned(&tfm->base);
248 static inline struct crypto_cipher *crypto_spawn_cipher(
249 struct crypto_spawn *spawn)
251 u32 type = CRYPTO_ALG_TYPE_CIPHER;
252 u32 mask = CRYPTO_ALG_TYPE_MASK;
254 return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
257 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
259 return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
262 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
264 u32 type = CRYPTO_ALG_TYPE_HASH;
265 u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
267 return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
270 static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
272 return crypto_tfm_ctx(&tfm->base);
275 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
277 return crypto_tfm_ctx_aligned(&tfm->base);
280 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
281 struct scatterlist *dst,
282 struct scatterlist *src,
287 walk->total = nbytes;
290 static inline struct crypto_async_request *crypto_get_backlog(
291 struct crypto_queue *queue)
293 return queue->backlog == &queue->list ? NULL :
294 container_of(queue->backlog, struct crypto_async_request, list);
297 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
298 struct ablkcipher_request *request)
300 return crypto_enqueue_request(queue, &request->base);
303 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
304 struct crypto_queue *queue)
306 return ablkcipher_request_cast(crypto_dequeue_request(queue));
309 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
314 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
315 struct crypto_ablkcipher *tfm)
317 return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
320 static inline void *aead_request_ctx(struct aead_request *req)
325 static inline void aead_request_complete(struct aead_request *req, int err)
327 req->base.complete(&req->base, err);
330 static inline u32 aead_request_flags(struct aead_request *req)
332 return req->base.flags;
335 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
338 return crypto_attr_alg(tb[1], type, mask);
342 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
343 * Otherwise returns zero.
345 static inline int crypto_requires_sync(u32 type, u32 mask)
347 return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
350 #endif /* _CRYPTO_ALGAPI_H */