blob: 59c3e5bd2c064cb59baa4248f75618f15270b543 [file] [log] [blame]
Herbert Xucce9e062006-08-21 21:08:13 +10001/*
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>
Herbert Xub5b7f082007-04-16 20:48:54 +100016#include <linux/list.h>
17#include <linux/kernel.h>
Herbert Xucce9e062006-08-21 21:08:13 +100018
Herbert Xu4cc77202006-08-06 21:16:34 +100019struct module;
Herbert Xuebc610e2007-01-01 18:37:02 +110020struct rtattr;
Herbert Xue853c3c2006-08-22 00:06:54 +100021struct seq_file;
22
23struct crypto_type {
Herbert Xu27d2a332007-01-24 20:50:26 +110024 unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
Herbert Xu2ca33da2009-07-13 20:46:25 +080025 unsigned int (*extsize)(struct crypto_alg *alg);
Herbert Xu27d2a332007-01-24 20:50:26 +110026 int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
Herbert Xu2ca33da2009-07-13 20:46:25 +080027 int (*init_tfm)(struct crypto_tfm *tfm);
Herbert Xue853c3c2006-08-22 00:06:54 +100028 void (*show)(struct seq_file *m, struct crypto_alg *alg);
Herbert Xu7b0bac62008-09-21 06:52:53 +090029 struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask);
30
31 unsigned int type;
32 unsigned int maskclear;
33 unsigned int maskset;
34 unsigned int tfmsize;
Herbert Xue853c3c2006-08-22 00:06:54 +100035};
Herbert Xu4cc77202006-08-06 21:16:34 +100036
37struct crypto_instance {
38 struct crypto_alg alg;
39
40 struct crypto_template *tmpl;
41 struct hlist_node list;
42
43 void *__ctx[] CRYPTO_MINALIGN_ATTR;
44};
45
46struct crypto_template {
47 struct list_head list;
48 struct hlist_head instances;
49 struct module *module;
50
Herbert Xuebc610e2007-01-01 18:37:02 +110051 struct crypto_instance *(*alloc)(struct rtattr **tb);
Herbert Xu4cc77202006-08-06 21:16:34 +100052 void (*free)(struct crypto_instance *inst);
Herbert Xuf2ac72e2009-07-07 12:30:33 +080053 int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
Herbert Xu4cc77202006-08-06 21:16:34 +100054
55 char name[CRYPTO_MAX_ALG_NAME];
56};
57
Herbert Xu6bfd4802006-09-21 11:39:29 +100058struct crypto_spawn {
59 struct list_head list;
60 struct crypto_alg *alg;
61 struct crypto_instance *inst;
Herbert Xu97eedce2009-07-08 15:55:52 +080062 const struct crypto_type *frontend;
Herbert Xua73e6992007-04-08 21:31:36 +100063 u32 mask;
Herbert Xu6bfd4802006-09-21 11:39:29 +100064};
65
Herbert Xub5b7f082007-04-16 20:48:54 +100066struct crypto_queue {
67 struct list_head list;
68 struct list_head *backlog;
69
70 unsigned int qlen;
71 unsigned int max_qlen;
72};
73
Herbert Xu5c640972006-08-12 21:56:17 +100074struct scatter_walk {
75 struct scatterlist *sg;
76 unsigned int offset;
77};
78
Herbert Xu5cde0af2006-08-22 00:07:53 +100079struct blkcipher_walk {
80 union {
81 struct {
82 struct page *page;
83 unsigned long offset;
84 } phys;
85
86 struct {
87 u8 *page;
88 u8 *addr;
89 } virt;
90 } src, dst;
91
92 struct scatter_walk in;
93 unsigned int nbytes;
94
95 struct scatter_walk out;
96 unsigned int total;
97
98 void *page;
99 u8 *buffer;
100 u8 *iv;
101
102 int flags;
Herbert Xu7607bd82007-10-04 15:24:05 +0800103 unsigned int blocksize;
Herbert Xu5cde0af2006-08-22 00:07:53 +1000104};
105
David S. Millerbf060992010-05-19 14:13:07 +1000106struct ablkcipher_walk {
107 struct {
108 struct page *page;
109 unsigned int offset;
110 } src, dst;
111
112 struct scatter_walk in;
113 unsigned int nbytes;
114 struct scatter_walk out;
115 unsigned int total;
116 struct list_head buffers;
117 u8 *iv_buffer;
118 u8 *iv;
119 int flags;
120 unsigned int blocksize;
121};
122
Herbert Xub5b7f082007-04-16 20:48:54 +1000123extern const struct crypto_type crypto_ablkcipher_type;
Herbert Xu1ae97822007-08-30 15:36:14 +0800124extern const struct crypto_type crypto_aead_type;
Herbert Xu5cde0af2006-08-22 00:07:53 +1000125extern const struct crypto_type crypto_blkcipher_type;
126
Herbert Xudb131ef2006-09-21 11:44:08 +1000127void crypto_mod_put(struct crypto_alg *alg);
128
Herbert Xu4cc77202006-08-06 21:16:34 +1000129int crypto_register_template(struct crypto_template *tmpl);
130void crypto_unregister_template(struct crypto_template *tmpl);
131struct crypto_template *crypto_lookup_template(const char *name);
132
Herbert Xu9cd899a2009-07-14 18:45:45 +0800133int crypto_register_instance(struct crypto_template *tmpl,
134 struct crypto_instance *inst);
135
Herbert Xu6bfd4802006-09-21 11:39:29 +1000136int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
Herbert Xua73e6992007-04-08 21:31:36 +1000137 struct crypto_instance *inst, u32 mask);
Herbert Xu97eedce2009-07-08 15:55:52 +0800138int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
139 struct crypto_instance *inst,
140 const struct crypto_type *frontend);
141
Herbert Xu6bfd4802006-09-21 11:39:29 +1000142void crypto_drop_spawn(struct crypto_spawn *spawn);
Herbert Xu2e306ee2006-12-17 10:05:58 +1100143struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
144 u32 mask);
Herbert Xu97eedce2009-07-08 15:55:52 +0800145void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
Herbert Xu6bfd4802006-09-21 11:39:29 +1000146
Herbert Xu378f4f52007-12-17 20:07:31 +0800147static inline void crypto_set_spawn(struct crypto_spawn *spawn,
148 struct crypto_instance *inst)
149{
150 spawn->inst = inst;
151}
152
Herbert Xuebc610e2007-01-01 18:37:02 +1100153struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
154int crypto_check_attr_type(struct rtattr **tb, u32 type);
Herbert Xu68b6c7d2007-12-07 20:18:17 +0800155const char *crypto_attr_alg_name(struct rtattr *rta);
Herbert Xud06854f2009-07-08 17:53:16 +0800156struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
157 const struct crypto_type *frontend,
158 u32 type, u32 mask);
159
160static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
161 u32 type, u32 mask)
162{
163 return crypto_attr_alg2(rta, NULL, type, mask);
164}
165
Herbert Xu3c09f172007-08-30 16:24:15 +0800166int crypto_attr_u32(struct rtattr *rta, u32 *num);
Herbert Xu70ec7bb2009-07-07 14:07:37 +0800167void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
168 unsigned int head);
Herbert Xu7fed0bf2006-08-06 23:10:45 +1000169struct crypto_instance *crypto_alloc_instance(const char *name,
170 struct crypto_alg *alg);
171
Herbert Xub5b7f082007-04-16 20:48:54 +1000172void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
173int crypto_enqueue_request(struct crypto_queue *queue,
174 struct crypto_async_request *request);
Herbert Xu0c7d4002009-08-29 20:44:04 +1000175void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset);
Herbert Xub5b7f082007-04-16 20:48:54 +1000176struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
177int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
178
Herbert Xu76136362007-11-20 17:26:06 +0800179/* These functions require the input/output to be aligned as u32. */
180void crypto_inc(u8 *a, unsigned int size);
181void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
182
Herbert Xu5cde0af2006-08-22 00:07:53 +1000183int blkcipher_walk_done(struct blkcipher_desc *desc,
184 struct blkcipher_walk *walk, int err);
185int blkcipher_walk_virt(struct blkcipher_desc *desc,
186 struct blkcipher_walk *walk);
187int blkcipher_walk_phys(struct blkcipher_desc *desc,
188 struct blkcipher_walk *walk);
Herbert Xu7607bd82007-10-04 15:24:05 +0800189int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
190 struct blkcipher_walk *walk,
191 unsigned int blocksize);
Herbert Xu5cde0af2006-08-22 00:07:53 +1000192
David S. Millerbf060992010-05-19 14:13:07 +1000193int ablkcipher_walk_done(struct ablkcipher_request *req,
194 struct ablkcipher_walk *walk, int err);
195int ablkcipher_walk_phys(struct ablkcipher_request *req,
196 struct ablkcipher_walk *walk);
197void __ablkcipher_walk_complete(struct ablkcipher_walk *walk);
198
Herbert Xu5cde0af2006-08-22 00:07:53 +1000199static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
200{
Herbert Xuab300462009-07-24 15:26:15 +0800201 return PTR_ALIGN(crypto_tfm_ctx(tfm),
202 crypto_tfm_alg_alignmask(tfm) + 1);
Herbert Xu5cde0af2006-08-22 00:07:53 +1000203}
204
Herbert Xu124b53d2007-04-16 20:49:20 +1000205static inline struct crypto_instance *crypto_tfm_alg_instance(
206 struct crypto_tfm *tfm)
207{
208 return container_of(tfm->__crt_alg, struct crypto_instance, alg);
209}
210
Herbert Xu4cc77202006-08-06 21:16:34 +1000211static inline void *crypto_instance_ctx(struct crypto_instance *inst)
212{
213 return inst->__ctx;
214}
215
Herbert Xub5b7f082007-04-16 20:48:54 +1000216static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
217 struct crypto_ablkcipher *tfm)
218{
219 return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
220}
221
222static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
223{
224 return crypto_tfm_ctx(&tfm->base);
225}
226
Sebastian Siewioraa379a62007-08-02 20:41:53 +0800227static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
228{
229 return crypto_tfm_ctx_aligned(&tfm->base);
230}
231
Herbert Xu1ae97822007-08-30 15:36:14 +0800232static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
233{
234 return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
235}
236
Herbert Xu3c09f172007-08-30 16:24:15 +0800237static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
238{
239 return crypto_tfm_ctx(&tfm->base);
240}
241
242static inline struct crypto_instance *crypto_aead_alg_instance(
243 struct crypto_aead *aead)
244{
245 return crypto_tfm_alg_instance(&aead->base);
246}
247
Herbert Xu124b53d2007-04-16 20:49:20 +1000248static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
249 struct crypto_spawn *spawn)
250{
251 u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
Herbert Xu332f88402007-11-15 22:36:07 +0800252 u32 mask = CRYPTO_ALG_TYPE_MASK;
Herbert Xu124b53d2007-04-16 20:49:20 +1000253
254 return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
255}
256
Herbert Xu5cde0af2006-08-22 00:07:53 +1000257static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
258{
259 return crypto_tfm_ctx(&tfm->base);
260}
261
262static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
263{
264 return crypto_tfm_ctx_aligned(&tfm->base);
265}
266
Herbert Xu2e306ee2006-12-17 10:05:58 +1100267static inline struct crypto_cipher *crypto_spawn_cipher(
268 struct crypto_spawn *spawn)
269{
270 u32 type = CRYPTO_ALG_TYPE_CIPHER;
271 u32 mask = CRYPTO_ALG_TYPE_MASK;
272
273 return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
274}
275
Herbert Xuf28776a2006-08-13 20:58:18 +1000276static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
277{
278 return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
279}
280
Herbert Xu2e306ee2006-12-17 10:05:58 +1100281static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
282{
283 u32 type = CRYPTO_ALG_TYPE_HASH;
284 u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
285
286 return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
287}
288
Herbert Xu5f7082e2008-08-31 22:21:09 +1000289static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
290{
291 return crypto_tfm_ctx(&tfm->base);
292}
293
Herbert Xu055bcee2006-08-19 22:24:23 +1000294static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
295{
296 return crypto_tfm_ctx_aligned(&tfm->base);
297}
298
Herbert Xu5cde0af2006-08-22 00:07:53 +1000299static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
300 struct scatterlist *dst,
301 struct scatterlist *src,
302 unsigned int nbytes)
303{
304 walk->in.sg = src;
305 walk->out.sg = dst;
306 walk->total = nbytes;
307}
308
David S. Millerbf060992010-05-19 14:13:07 +1000309static inline void ablkcipher_walk_init(struct ablkcipher_walk *walk,
310 struct scatterlist *dst,
311 struct scatterlist *src,
312 unsigned int nbytes)
313{
314 walk->in.sg = src;
315 walk->out.sg = dst;
316 walk->total = nbytes;
317 INIT_LIST_HEAD(&walk->buffers);
318}
319
320static inline void ablkcipher_walk_complete(struct ablkcipher_walk *walk)
321{
322 if (unlikely(!list_empty(&walk->buffers)))
323 __ablkcipher_walk_complete(walk);
324}
325
Herbert Xub5b7f082007-04-16 20:48:54 +1000326static inline struct crypto_async_request *crypto_get_backlog(
327 struct crypto_queue *queue)
328{
329 return queue->backlog == &queue->list ? NULL :
330 container_of(queue->backlog, struct crypto_async_request, list);
331}
332
Herbert Xu2de98e72007-08-26 19:12:47 +0800333static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
Herbert Xub5b7f082007-04-16 20:48:54 +1000334 struct ablkcipher_request *request)
335{
Herbert Xu2de98e72007-08-26 19:12:47 +0800336 return crypto_enqueue_request(queue, &request->base);
Herbert Xub5b7f082007-04-16 20:48:54 +1000337}
338
339static inline struct ablkcipher_request *ablkcipher_dequeue_request(
Herbert Xu2de98e72007-08-26 19:12:47 +0800340 struct crypto_queue *queue)
Herbert Xub5b7f082007-04-16 20:48:54 +1000341{
Herbert Xu2de98e72007-08-26 19:12:47 +0800342 return ablkcipher_request_cast(crypto_dequeue_request(queue));
Herbert Xub5b7f082007-04-16 20:48:54 +1000343}
344
345static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
346{
347 return req->__ctx;
348}
349
Herbert Xu2de98e72007-08-26 19:12:47 +0800350static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
351 struct crypto_ablkcipher *tfm)
Herbert Xub5b7f082007-04-16 20:48:54 +1000352{
Herbert Xu2de98e72007-08-26 19:12:47 +0800353 return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
Herbert Xub5b7f082007-04-16 20:48:54 +1000354}
355
Herbert Xu3c09f172007-08-30 16:24:15 +0800356static inline void *aead_request_ctx(struct aead_request *req)
357{
358 return req->__ctx;
359}
360
361static inline void aead_request_complete(struct aead_request *req, int err)
362{
363 req->base.complete(&req->base, err);
364}
365
366static inline u32 aead_request_flags(struct aead_request *req)
367{
368 return req->base.flags;
369}
370
371static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
372 u32 type, u32 mask)
373{
374 return crypto_attr_alg(tb[1], type, mask);
375}
376
Herbert Xu378f4f52007-12-17 20:07:31 +0800377/*
378 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
379 * Otherwise returns zero.
380 */
381static inline int crypto_requires_sync(u32 type, u32 mask)
382{
383 return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
384}
385
Herbert Xucce9e062006-08-21 21:08:13 +1000386#endif /* _CRYPTO_ALGAPI_H */
387