blob: 623a59c1ff5a6ef45d4cebe4ae8c0b7462aaff76 [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>
Steffen Klassertb6aa63c2011-09-27 07:24:29 +020018#include <linux/skbuff.h>
Herbert Xucce9e062006-08-21 21:08:13 +100019
Herbert Xu4cc77202006-08-06 21:16:34 +100020struct module;
Herbert Xuebc610e2007-01-01 18:37:02 +110021struct rtattr;
Herbert Xue853c3c2006-08-22 00:06:54 +100022struct seq_file;
23
24struct crypto_type {
Herbert Xu27d2a332007-01-24 20:50:26 +110025 unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
Herbert Xu2ca33da2009-07-13 20:46:25 +080026 unsigned int (*extsize)(struct crypto_alg *alg);
Herbert Xu27d2a332007-01-24 20:50:26 +110027 int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
Herbert Xu2ca33da2009-07-13 20:46:25 +080028 int (*init_tfm)(struct crypto_tfm *tfm);
Herbert Xue853c3c2006-08-22 00:06:54 +100029 void (*show)(struct seq_file *m, struct crypto_alg *alg);
Steffen Klassertb6aa63c2011-09-27 07:24:29 +020030 int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
Herbert Xu7b0bac62008-09-21 06:52:53 +090031 struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask);
32
33 unsigned int type;
34 unsigned int maskclear;
35 unsigned int maskset;
36 unsigned int tfmsize;
Herbert Xue853c3c2006-08-22 00:06:54 +100037};
Herbert Xu4cc77202006-08-06 21:16:34 +100038
39struct crypto_instance {
40 struct crypto_alg alg;
41
42 struct crypto_template *tmpl;
43 struct hlist_node list;
44
45 void *__ctx[] CRYPTO_MINALIGN_ATTR;
46};
47
48struct crypto_template {
49 struct list_head list;
50 struct hlist_head instances;
51 struct module *module;
52
Herbert Xuebc610e2007-01-01 18:37:02 +110053 struct crypto_instance *(*alloc)(struct rtattr **tb);
Herbert Xu4cc77202006-08-06 21:16:34 +100054 void (*free)(struct crypto_instance *inst);
Herbert Xuf2ac72e2009-07-07 12:30:33 +080055 int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
Herbert Xu4cc77202006-08-06 21:16:34 +100056
57 char name[CRYPTO_MAX_ALG_NAME];
58};
59
Herbert Xu6bfd4802006-09-21 11:39:29 +100060struct crypto_spawn {
61 struct list_head list;
62 struct crypto_alg *alg;
63 struct crypto_instance *inst;
Herbert Xu97eedce2009-07-08 15:55:52 +080064 const struct crypto_type *frontend;
Herbert Xua73e6992007-04-08 21:31:36 +100065 u32 mask;
Herbert Xu6bfd4802006-09-21 11:39:29 +100066};
67
Herbert Xub5b7f082007-04-16 20:48:54 +100068struct crypto_queue {
69 struct list_head list;
70 struct list_head *backlog;
71
72 unsigned int qlen;
73 unsigned int max_qlen;
74};
75
Herbert Xu5c640972006-08-12 21:56:17 +100076struct scatter_walk {
77 struct scatterlist *sg;
78 unsigned int offset;
79};
80
Herbert Xu5cde0af2006-08-22 00:07:53 +100081struct blkcipher_walk {
82 union {
83 struct {
84 struct page *page;
85 unsigned long offset;
86 } phys;
87
88 struct {
89 u8 *page;
90 u8 *addr;
91 } virt;
92 } src, dst;
93
94 struct scatter_walk in;
95 unsigned int nbytes;
96
97 struct scatter_walk out;
98 unsigned int total;
99
100 void *page;
101 u8 *buffer;
102 u8 *iv;
Ard Biesheuvel822be002014-03-04 13:28:38 +0800103 unsigned int ivsize;
Herbert Xu5cde0af2006-08-22 00:07:53 +1000104
105 int flags;
Ard Biesheuvel822be002014-03-04 13:28:38 +0800106 unsigned int walk_blocksize;
107 unsigned int cipher_blocksize;
108 unsigned int alignmask;
Herbert Xu5cde0af2006-08-22 00:07:53 +1000109};
110
David S. Millerbf060992010-05-19 14:13:07 +1000111struct ablkcipher_walk {
112 struct {
113 struct page *page;
114 unsigned int offset;
115 } src, dst;
116
117 struct scatter_walk in;
118 unsigned int nbytes;
119 struct scatter_walk out;
120 unsigned int total;
121 struct list_head buffers;
122 u8 *iv_buffer;
123 u8 *iv;
124 int flags;
125 unsigned int blocksize;
126};
127
Herbert Xub5b7f082007-04-16 20:48:54 +1000128extern const struct crypto_type crypto_ablkcipher_type;
Herbert Xu1ae97822007-08-30 15:36:14 +0800129extern const struct crypto_type crypto_aead_type;
Herbert Xu5cde0af2006-08-22 00:07:53 +1000130extern const struct crypto_type crypto_blkcipher_type;
131
Herbert Xudb131ef2006-09-21 11:44:08 +1000132void crypto_mod_put(struct crypto_alg *alg);
133
Herbert Xu4cc77202006-08-06 21:16:34 +1000134int crypto_register_template(struct crypto_template *tmpl);
135void crypto_unregister_template(struct crypto_template *tmpl);
136struct crypto_template *crypto_lookup_template(const char *name);
137
Herbert Xu9cd899a2009-07-14 18:45:45 +0800138int crypto_register_instance(struct crypto_template *tmpl,
139 struct crypto_instance *inst);
Steffen Klassertce3fd842011-11-08 10:09:17 +0100140int crypto_unregister_instance(struct crypto_alg *alg);
Herbert Xu9cd899a2009-07-14 18:45:45 +0800141
Herbert Xu6bfd4802006-09-21 11:39:29 +1000142int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
Herbert Xua73e6992007-04-08 21:31:36 +1000143 struct crypto_instance *inst, u32 mask);
Herbert Xu97eedce2009-07-08 15:55:52 +0800144int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
145 struct crypto_instance *inst,
146 const struct crypto_type *frontend);
147
Herbert Xu6bfd4802006-09-21 11:39:29 +1000148void crypto_drop_spawn(struct crypto_spawn *spawn);
Herbert Xu2e306ee2006-12-17 10:05:58 +1100149struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
150 u32 mask);
Herbert Xu97eedce2009-07-08 15:55:52 +0800151void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
Herbert Xu6bfd4802006-09-21 11:39:29 +1000152
Herbert Xu378f4f52007-12-17 20:07:31 +0800153static inline void crypto_set_spawn(struct crypto_spawn *spawn,
154 struct crypto_instance *inst)
155{
156 spawn->inst = inst;
157}
158
Herbert Xuebc610e2007-01-01 18:37:02 +1100159struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
160int crypto_check_attr_type(struct rtattr **tb, u32 type);
Herbert Xu68b6c7d2007-12-07 20:18:17 +0800161const char *crypto_attr_alg_name(struct rtattr *rta);
Herbert Xud06854f2009-07-08 17:53:16 +0800162struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
163 const struct crypto_type *frontend,
164 u32 type, u32 mask);
165
166static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
167 u32 type, u32 mask)
168{
169 return crypto_attr_alg2(rta, NULL, type, mask);
170}
171
Herbert Xu3c09f172007-08-30 16:24:15 +0800172int crypto_attr_u32(struct rtattr *rta, u32 *num);
Herbert Xu70ec7bb2009-07-07 14:07:37 +0800173void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
174 unsigned int head);
Herbert Xu7fed0bf2006-08-06 23:10:45 +1000175struct crypto_instance *crypto_alloc_instance(const char *name,
176 struct crypto_alg *alg);
177
Herbert Xub5b7f082007-04-16 20:48:54 +1000178void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
179int crypto_enqueue_request(struct crypto_queue *queue,
180 struct crypto_async_request *request);
Herbert Xu0c7d4002009-08-29 20:44:04 +1000181void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset);
Herbert Xub5b7f082007-04-16 20:48:54 +1000182struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
183int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
184
Herbert Xu76136362007-11-20 17:26:06 +0800185/* These functions require the input/output to be aligned as u32. */
186void crypto_inc(u8 *a, unsigned int size);
187void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
188
Herbert Xu5cde0af2006-08-22 00:07:53 +1000189int blkcipher_walk_done(struct blkcipher_desc *desc,
190 struct blkcipher_walk *walk, int err);
191int blkcipher_walk_virt(struct blkcipher_desc *desc,
192 struct blkcipher_walk *walk);
193int blkcipher_walk_phys(struct blkcipher_desc *desc,
194 struct blkcipher_walk *walk);
Herbert Xu7607bd82007-10-04 15:24:05 +0800195int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
196 struct blkcipher_walk *walk,
197 unsigned int blocksize);
Ard Biesheuvel4f7f1d72014-03-04 13:28:39 +0800198int blkcipher_aead_walk_virt_block(struct blkcipher_desc *desc,
199 struct blkcipher_walk *walk,
200 struct crypto_aead *tfm,
201 unsigned int blocksize);
Herbert Xu5cde0af2006-08-22 00:07:53 +1000202
David S. Millerbf060992010-05-19 14:13:07 +1000203int ablkcipher_walk_done(struct ablkcipher_request *req,
204 struct ablkcipher_walk *walk, int err);
205int ablkcipher_walk_phys(struct ablkcipher_request *req,
206 struct ablkcipher_walk *walk);
207void __ablkcipher_walk_complete(struct ablkcipher_walk *walk);
208
Herbert Xu5cde0af2006-08-22 00:07:53 +1000209static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
210{
Herbert Xuab300462009-07-24 15:26:15 +0800211 return PTR_ALIGN(crypto_tfm_ctx(tfm),
212 crypto_tfm_alg_alignmask(tfm) + 1);
Herbert Xu5cde0af2006-08-22 00:07:53 +1000213}
214
Herbert Xu124b53d2007-04-16 20:49:20 +1000215static inline struct crypto_instance *crypto_tfm_alg_instance(
216 struct crypto_tfm *tfm)
217{
218 return container_of(tfm->__crt_alg, struct crypto_instance, alg);
219}
220
Herbert Xu4cc77202006-08-06 21:16:34 +1000221static inline void *crypto_instance_ctx(struct crypto_instance *inst)
222{
223 return inst->__ctx;
224}
225
Herbert Xub5b7f082007-04-16 20:48:54 +1000226static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
227 struct crypto_ablkcipher *tfm)
228{
229 return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
230}
231
232static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
233{
234 return crypto_tfm_ctx(&tfm->base);
235}
236
Sebastian Siewioraa379a62007-08-02 20:41:53 +0800237static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
238{
239 return crypto_tfm_ctx_aligned(&tfm->base);
240}
241
Herbert Xu1ae97822007-08-30 15:36:14 +0800242static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
243{
244 return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
245}
246
Herbert Xu3c09f172007-08-30 16:24:15 +0800247static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
248{
249 return crypto_tfm_ctx(&tfm->base);
250}
251
252static inline struct crypto_instance *crypto_aead_alg_instance(
253 struct crypto_aead *aead)
254{
255 return crypto_tfm_alg_instance(&aead->base);
256}
257
Herbert Xu124b53d2007-04-16 20:49:20 +1000258static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
259 struct crypto_spawn *spawn)
260{
261 u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
Herbert Xu332f88402007-11-15 22:36:07 +0800262 u32 mask = CRYPTO_ALG_TYPE_MASK;
Herbert Xu124b53d2007-04-16 20:49:20 +1000263
264 return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
265}
266
Herbert Xu5cde0af2006-08-22 00:07:53 +1000267static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
268{
269 return crypto_tfm_ctx(&tfm->base);
270}
271
272static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
273{
274 return crypto_tfm_ctx_aligned(&tfm->base);
275}
276
Herbert Xu2e306ee2006-12-17 10:05:58 +1100277static inline struct crypto_cipher *crypto_spawn_cipher(
278 struct crypto_spawn *spawn)
279{
280 u32 type = CRYPTO_ALG_TYPE_CIPHER;
281 u32 mask = CRYPTO_ALG_TYPE_MASK;
282
283 return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
284}
285
Herbert Xuf28776a2006-08-13 20:58:18 +1000286static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
287{
288 return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
289}
290
Herbert Xu2e306ee2006-12-17 10:05:58 +1100291static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
292{
293 u32 type = CRYPTO_ALG_TYPE_HASH;
294 u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
295
296 return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
297}
298
Herbert Xu5f7082e2008-08-31 22:21:09 +1000299static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
300{
301 return crypto_tfm_ctx(&tfm->base);
302}
303
Herbert Xu055bcee2006-08-19 22:24:23 +1000304static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
305{
306 return crypto_tfm_ctx_aligned(&tfm->base);
307}
308
Herbert Xu5cde0af2006-08-22 00:07:53 +1000309static inline void blkcipher_walk_init(struct blkcipher_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}
318
David S. Millerbf060992010-05-19 14:13:07 +1000319static inline void ablkcipher_walk_init(struct ablkcipher_walk *walk,
320 struct scatterlist *dst,
321 struct scatterlist *src,
322 unsigned int nbytes)
323{
324 walk->in.sg = src;
325 walk->out.sg = dst;
326 walk->total = nbytes;
327 INIT_LIST_HEAD(&walk->buffers);
328}
329
330static inline void ablkcipher_walk_complete(struct ablkcipher_walk *walk)
331{
332 if (unlikely(!list_empty(&walk->buffers)))
333 __ablkcipher_walk_complete(walk);
334}
335
Herbert Xub5b7f082007-04-16 20:48:54 +1000336static inline struct crypto_async_request *crypto_get_backlog(
337 struct crypto_queue *queue)
338{
339 return queue->backlog == &queue->list ? NULL :
340 container_of(queue->backlog, struct crypto_async_request, list);
341}
342
Herbert Xu2de98e72007-08-26 19:12:47 +0800343static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
Herbert Xub5b7f082007-04-16 20:48:54 +1000344 struct ablkcipher_request *request)
345{
Herbert Xu2de98e72007-08-26 19:12:47 +0800346 return crypto_enqueue_request(queue, &request->base);
Herbert Xub5b7f082007-04-16 20:48:54 +1000347}
348
349static inline struct ablkcipher_request *ablkcipher_dequeue_request(
Herbert Xu2de98e72007-08-26 19:12:47 +0800350 struct crypto_queue *queue)
Herbert Xub5b7f082007-04-16 20:48:54 +1000351{
Herbert Xu2de98e72007-08-26 19:12:47 +0800352 return ablkcipher_request_cast(crypto_dequeue_request(queue));
Herbert Xub5b7f082007-04-16 20:48:54 +1000353}
354
355static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
356{
357 return req->__ctx;
358}
359
Herbert Xu2de98e72007-08-26 19:12:47 +0800360static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
361 struct crypto_ablkcipher *tfm)
Herbert Xub5b7f082007-04-16 20:48:54 +1000362{
Herbert Xu2de98e72007-08-26 19:12:47 +0800363 return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
Herbert Xub5b7f082007-04-16 20:48:54 +1000364}
365
Herbert Xu3c09f172007-08-30 16:24:15 +0800366static inline void *aead_request_ctx(struct aead_request *req)
367{
368 return req->__ctx;
369}
370
371static inline void aead_request_complete(struct aead_request *req, int err)
372{
373 req->base.complete(&req->base, err);
374}
375
376static inline u32 aead_request_flags(struct aead_request *req)
377{
378 return req->base.flags;
379}
380
381static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
382 u32 type, u32 mask)
383{
384 return crypto_attr_alg(tb[1], type, mask);
385}
386
Herbert Xu378f4f52007-12-17 20:07:31 +0800387/*
388 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
389 * Otherwise returns zero.
390 */
391static inline int crypto_requires_sync(u32 type, u32 mask)
392{
393 return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
394}
395
James Yonan6bf37e52013-09-26 02:20:39 -0600396noinline unsigned long __crypto_memneq(const void *a, const void *b, size_t size);
Herbert Xucce9e062006-08-21 21:08:13 +1000397
James Yonan6bf37e52013-09-26 02:20:39 -0600398/**
399 * crypto_memneq - Compare two areas of memory without leaking
400 * timing information.
401 *
402 * @a: One area of memory
403 * @b: Another area of memory
404 * @size: The size of the area.
405 *
406 * Returns 0 when data is equal, 1 otherwise.
407 */
408static inline int crypto_memneq(const void *a, const void *b, size_t size)
409{
410 return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
411}
412
Marek Vasutbb55a4c2014-05-26 15:32:05 +0200413static inline void crypto_yield(u32 flags)
414{
415 if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
416 cond_resched();
417}
418
James Yonan6bf37e52013-09-26 02:20:39 -0600419#endif /* _CRYPTO_ALGAPI_H */