Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Cryptographic API for algorithms (i.e., low-level API).
4 *
5 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
6 */
7#ifndef _CRYPTO_ALGAPI_H
8#define _CRYPTO_ALGAPI_H
9
10#include <crypto/utils.h>
11#include <linux/align.h>
12#include <linux/cache.h>
13#include <linux/crypto.h>
14#include <linux/types.h>
15#include <linux/workqueue.h>
16
17/*
18 * Maximum values for blocksize and alignmask, used to allocate
19 * static buffers that are big enough for any combination of
20 * algs and architectures. Ciphers have a lower maximum size.
21 */
22#define MAX_ALGAPI_BLOCKSIZE 160
23#define MAX_ALGAPI_ALIGNMASK 127
24#define MAX_CIPHER_BLOCKSIZE 16
25#define MAX_CIPHER_ALIGNMASK 15
26
27#ifdef ARCH_DMA_MINALIGN
28#define CRYPTO_DMA_ALIGN ARCH_DMA_MINALIGN
29#else
30#define CRYPTO_DMA_ALIGN CRYPTO_MINALIGN
31#endif
32
33#define CRYPTO_DMA_PADDING ((CRYPTO_DMA_ALIGN - 1) & ~(CRYPTO_MINALIGN - 1))
34
35/*
36 * Autoloaded crypto modules should only use a prefixed name to avoid allowing
37 * arbitrary modules to be loaded. Loading from userspace may still need the
38 * unprefixed names, so retains those aliases as well.
39 * This uses __MODULE_INFO directly instead of MODULE_ALIAS because pre-4.3
40 * gcc (e.g. avr32 toolchain) uses __LINE__ for uniqueness, and this macro
41 * expands twice on the same line. Instead, use a separate base name for the
42 * alias.
43 */
44#define MODULE_ALIAS_CRYPTO(name) \
45 __MODULE_INFO(alias, alias_userspace, name); \
46 __MODULE_INFO(alias, alias_crypto, "crypto-" name)
47
48struct crypto_aead;
49struct crypto_instance;
50struct module;
51struct notifier_block;
52struct rtattr;
53struct scatterlist;
54struct seq_file;
55struct sk_buff;
56
57struct crypto_type {
58 unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
59 unsigned int (*extsize)(struct crypto_alg *alg);
60 int (*init_tfm)(struct crypto_tfm *tfm);
61 void (*show)(struct seq_file *m, struct crypto_alg *alg);
62 int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
63 void (*free)(struct crypto_instance *inst);
64#ifdef CONFIG_CRYPTO_STATS
65 int (*report_stat)(struct sk_buff *skb, struct crypto_alg *alg);
66#endif
67
68 unsigned int type;
69 unsigned int maskclear;
70 unsigned int maskset;
71 unsigned int tfmsize;
72};
73
74struct crypto_instance {
75 struct crypto_alg alg;
76
77 struct crypto_template *tmpl;
78
79 union {
80 /* Node in list of instances after registration. */
81 struct hlist_node list;
82 /* List of attached spawns before registration. */
83 struct crypto_spawn *spawns;
84 };
85
86 struct work_struct free_work;
87
88 void *__ctx[] CRYPTO_MINALIGN_ATTR;
89};
90
91struct crypto_template {
92 struct list_head list;
93 struct hlist_head instances;
94 struct module *module;
95
96 int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
97
98 char name[CRYPTO_MAX_ALG_NAME];
99};
100
101struct crypto_spawn {
102 struct list_head list;
103 struct crypto_alg *alg;
104 union {
105 /* Back pointer to instance after registration.*/
106 struct crypto_instance *inst;
107 /* Spawn list pointer prior to registration. */
108 struct crypto_spawn *next;
109 };
110 const struct crypto_type *frontend;
111 u32 mask;
112 bool dead;
113 bool registered;
114};
115
116struct crypto_queue {
117 struct list_head list;
118 struct list_head *backlog;
119
120 unsigned int qlen;
121 unsigned int max_qlen;
122};
123
124struct scatter_walk {
125 struct scatterlist *sg;
126 unsigned int offset;
127};
128
129struct crypto_attr_alg {
130 char name[CRYPTO_MAX_ALG_NAME];
131};
132
133struct crypto_attr_type {
134 u32 type;
135 u32 mask;
136};
137
138/*
139 * Algorithm registration interface.
140 */
141int crypto_register_alg(struct crypto_alg *alg);
142void crypto_unregister_alg(struct crypto_alg *alg);
143int crypto_register_algs(struct crypto_alg *algs, int count);
144void crypto_unregister_algs(struct crypto_alg *algs, int count);
145
146void crypto_mod_put(struct crypto_alg *alg);
147
148int crypto_register_template(struct crypto_template *tmpl);
149int crypto_register_templates(struct crypto_template *tmpls, int count);
150void crypto_unregister_template(struct crypto_template *tmpl);
151void crypto_unregister_templates(struct crypto_template *tmpls, int count);
152struct crypto_template *crypto_lookup_template(const char *name);
153
154int crypto_register_instance(struct crypto_template *tmpl,
155 struct crypto_instance *inst);
156void crypto_unregister_instance(struct crypto_instance *inst);
157
158int crypto_grab_spawn(struct crypto_spawn *spawn, struct crypto_instance *inst,
159 const char *name, u32 type, u32 mask);
160void crypto_drop_spawn(struct crypto_spawn *spawn);
161struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
162 u32 mask);
163void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
164
165struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
166int crypto_check_attr_type(struct rtattr **tb, u32 type, u32 *mask_ret);
167const char *crypto_attr_alg_name(struct rtattr *rta);
168int crypto_inst_setname(struct crypto_instance *inst, const char *name,
169 struct crypto_alg *alg);
170
171void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
172int crypto_enqueue_request(struct crypto_queue *queue,
173 struct crypto_async_request *request);
174void crypto_enqueue_request_head(struct crypto_queue *queue,
175 struct crypto_async_request *request);
176struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
177static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
178{
179 return queue->qlen;
180}
181
182void crypto_inc(u8 *a, unsigned int size);
183
184static inline void *crypto_tfm_ctx(struct crypto_tfm *tfm)
185{
186 return tfm->__crt_ctx;
187}
188
189static inline void *crypto_tfm_ctx_align(struct crypto_tfm *tfm,
190 unsigned int align)
191{
192 if (align <= crypto_tfm_ctx_alignment())
193 align = 1;
194
195 return PTR_ALIGN(crypto_tfm_ctx(tfm), align);
196}
197
198static inline unsigned int crypto_dma_align(void)
199{
200 return CRYPTO_DMA_ALIGN;
201}
202
203static inline unsigned int crypto_dma_padding(void)
204{
205 return (crypto_dma_align() - 1) & ~(crypto_tfm_ctx_alignment() - 1);
206}
207
208static inline void *crypto_tfm_ctx_dma(struct crypto_tfm *tfm)
209{
210 return crypto_tfm_ctx_align(tfm, crypto_dma_align());
211}
212
213static inline struct crypto_instance *crypto_tfm_alg_instance(
214 struct crypto_tfm *tfm)
215{
216 return container_of(tfm->__crt_alg, struct crypto_instance, alg);
217}
218
219static inline void *crypto_instance_ctx(struct crypto_instance *inst)
220{
221 return inst->__ctx;
222}
223
224static inline struct crypto_async_request *crypto_get_backlog(
225 struct crypto_queue *queue)
226{
227 return queue->backlog == &queue->list ? NULL :
228 container_of(queue->backlog, struct crypto_async_request, list);
229}
230
231static inline u32 crypto_requires_off(struct crypto_attr_type *algt, u32 off)
232{
233 return (algt->type ^ off) & algt->mask & off;
234}
235
236/*
237 * When an algorithm uses another algorithm (e.g., if it's an instance of a
238 * template), these are the flags that should always be set on the "outer"
239 * algorithm if any "inner" algorithm has them set.
240 */
241#define CRYPTO_ALG_INHERITED_FLAGS \
242 (CRYPTO_ALG_ASYNC | CRYPTO_ALG_NEED_FALLBACK | \
243 CRYPTO_ALG_ALLOCATES_MEMORY)
244
245/*
246 * Given the type and mask that specify the flags restrictions on a template
247 * instance being created, return the mask that should be passed to
248 * crypto_grab_*() (along with type=0) to honor any request the user made to
249 * have any of the CRYPTO_ALG_INHERITED_FLAGS clear.
250 */
251static inline u32 crypto_algt_inherited_mask(struct crypto_attr_type *algt)
252{
253 return crypto_requires_off(algt, CRYPTO_ALG_INHERITED_FLAGS);
254}
255
256int crypto_register_notifier(struct notifier_block *nb);
257int crypto_unregister_notifier(struct notifier_block *nb);
258
259/* Crypto notification events. */
260enum {
261 CRYPTO_MSG_ALG_REQUEST,
262 CRYPTO_MSG_ALG_REGISTER,
263 CRYPTO_MSG_ALG_LOADED,
264};
265
266static inline void crypto_request_complete(struct crypto_async_request *req,
267 int err)
268{
269 req->complete(req->data, err);
270}
271
272static inline u32 crypto_tfm_alg_type(struct crypto_tfm *tfm)
273{
274 return tfm->__crt_alg->cra_flags & CRYPTO_ALG_TYPE_MASK;
275}
276
277#endif /* _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#include <linux/skbuff.h>
19
20struct crypto_aead;
21struct crypto_instance;
22struct module;
23struct rtattr;
24struct seq_file;
25
26struct crypto_type {
27 unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
28 unsigned int (*extsize)(struct crypto_alg *alg);
29 int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
30 int (*init_tfm)(struct crypto_tfm *tfm);
31 void (*show)(struct seq_file *m, struct crypto_alg *alg);
32 int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
33 struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask);
34 void (*free)(struct crypto_instance *inst);
35
36 unsigned int type;
37 unsigned int maskclear;
38 unsigned int maskset;
39 unsigned int tfmsize;
40};
41
42struct crypto_instance {
43 struct crypto_alg alg;
44
45 struct crypto_template *tmpl;
46 struct hlist_node list;
47
48 void *__ctx[] CRYPTO_MINALIGN_ATTR;
49};
50
51struct crypto_template {
52 struct list_head list;
53 struct hlist_head instances;
54 struct module *module;
55
56 struct crypto_instance *(*alloc)(struct rtattr **tb);
57 void (*free)(struct crypto_instance *inst);
58 int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
59
60 char name[CRYPTO_MAX_ALG_NAME];
61};
62
63struct crypto_spawn {
64 struct list_head list;
65 struct crypto_alg *alg;
66 struct crypto_instance *inst;
67 const struct crypto_type *frontend;
68 u32 mask;
69};
70
71struct crypto_queue {
72 struct list_head list;
73 struct list_head *backlog;
74
75 unsigned int qlen;
76 unsigned int max_qlen;
77};
78
79struct scatter_walk {
80 struct scatterlist *sg;
81 unsigned int offset;
82};
83
84struct blkcipher_walk {
85 union {
86 struct {
87 struct page *page;
88 unsigned long offset;
89 } phys;
90
91 struct {
92 u8 *page;
93 u8 *addr;
94 } virt;
95 } src, dst;
96
97 struct scatter_walk in;
98 unsigned int nbytes;
99
100 struct scatter_walk out;
101 unsigned int total;
102
103 void *page;
104 u8 *buffer;
105 u8 *iv;
106 unsigned int ivsize;
107
108 int flags;
109 unsigned int walk_blocksize;
110 unsigned int cipher_blocksize;
111 unsigned int alignmask;
112};
113
114struct ablkcipher_walk {
115 struct {
116 struct page *page;
117 unsigned int offset;
118 } src, dst;
119
120 struct scatter_walk in;
121 unsigned int nbytes;
122 struct scatter_walk out;
123 unsigned int total;
124 struct list_head buffers;
125 u8 *iv_buffer;
126 u8 *iv;
127 int flags;
128 unsigned int blocksize;
129};
130
131extern const struct crypto_type crypto_ablkcipher_type;
132extern const struct crypto_type crypto_blkcipher_type;
133
134void crypto_mod_put(struct crypto_alg *alg);
135
136int crypto_register_template(struct crypto_template *tmpl);
137void crypto_unregister_template(struct crypto_template *tmpl);
138struct crypto_template *crypto_lookup_template(const char *name);
139
140int crypto_register_instance(struct crypto_template *tmpl,
141 struct crypto_instance *inst);
142int crypto_unregister_instance(struct crypto_instance *inst);
143
144int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
145 struct crypto_instance *inst, u32 mask);
146int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
147 struct crypto_instance *inst,
148 const struct crypto_type *frontend);
149int crypto_grab_spawn(struct crypto_spawn *spawn, const char *name,
150 u32 type, u32 mask);
151
152void crypto_drop_spawn(struct crypto_spawn *spawn);
153struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
154 u32 mask);
155void *crypto_spawn_tfm2(struct crypto_spawn *spawn);
156
157static inline void crypto_set_spawn(struct crypto_spawn *spawn,
158 struct crypto_instance *inst)
159{
160 spawn->inst = inst;
161}
162
163struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
164int crypto_check_attr_type(struct rtattr **tb, u32 type);
165const char *crypto_attr_alg_name(struct rtattr *rta);
166struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
167 const struct crypto_type *frontend,
168 u32 type, u32 mask);
169
170static inline struct crypto_alg *crypto_attr_alg(struct rtattr *rta,
171 u32 type, u32 mask)
172{
173 return crypto_attr_alg2(rta, NULL, type, mask);
174}
175
176int crypto_attr_u32(struct rtattr *rta, u32 *num);
177int crypto_inst_setname(struct crypto_instance *inst, const char *name,
178 struct crypto_alg *alg);
179void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
180 unsigned int head);
181struct crypto_instance *crypto_alloc_instance(const char *name,
182 struct crypto_alg *alg);
183
184void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
185int crypto_enqueue_request(struct crypto_queue *queue,
186 struct crypto_async_request *request);
187struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
188int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
189static inline unsigned int crypto_queue_len(struct crypto_queue *queue)
190{
191 return queue->qlen;
192}
193
194/* These functions require the input/output to be aligned as u32. */
195void crypto_inc(u8 *a, unsigned int size);
196void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
197
198int blkcipher_walk_done(struct blkcipher_desc *desc,
199 struct blkcipher_walk *walk, int err);
200int blkcipher_walk_virt(struct blkcipher_desc *desc,
201 struct blkcipher_walk *walk);
202int blkcipher_walk_phys(struct blkcipher_desc *desc,
203 struct blkcipher_walk *walk);
204int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
205 struct blkcipher_walk *walk,
206 unsigned int blocksize);
207int blkcipher_aead_walk_virt_block(struct blkcipher_desc *desc,
208 struct blkcipher_walk *walk,
209 struct crypto_aead *tfm,
210 unsigned int blocksize);
211
212int ablkcipher_walk_done(struct ablkcipher_request *req,
213 struct ablkcipher_walk *walk, int err);
214int ablkcipher_walk_phys(struct ablkcipher_request *req,
215 struct ablkcipher_walk *walk);
216void __ablkcipher_walk_complete(struct ablkcipher_walk *walk);
217
218static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
219{
220 return PTR_ALIGN(crypto_tfm_ctx(tfm),
221 crypto_tfm_alg_alignmask(tfm) + 1);
222}
223
224static inline struct crypto_instance *crypto_tfm_alg_instance(
225 struct crypto_tfm *tfm)
226{
227 return container_of(tfm->__crt_alg, struct crypto_instance, alg);
228}
229
230static inline void *crypto_instance_ctx(struct crypto_instance *inst)
231{
232 return inst->__ctx;
233}
234
235static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
236 struct crypto_ablkcipher *tfm)
237{
238 return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
239}
240
241static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
242{
243 return crypto_tfm_ctx(&tfm->base);
244}
245
246static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
247{
248 return crypto_tfm_ctx_aligned(&tfm->base);
249}
250
251static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
252 struct crypto_spawn *spawn)
253{
254 u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
255 u32 mask = CRYPTO_ALG_TYPE_MASK;
256
257 return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
258}
259
260static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
261{
262 return crypto_tfm_ctx(&tfm->base);
263}
264
265static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
266{
267 return crypto_tfm_ctx_aligned(&tfm->base);
268}
269
270static inline struct crypto_cipher *crypto_spawn_cipher(
271 struct crypto_spawn *spawn)
272{
273 u32 type = CRYPTO_ALG_TYPE_CIPHER;
274 u32 mask = CRYPTO_ALG_TYPE_MASK;
275
276 return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
277}
278
279static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
280{
281 return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
282}
283
284static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
285 struct scatterlist *dst,
286 struct scatterlist *src,
287 unsigned int nbytes)
288{
289 walk->in.sg = src;
290 walk->out.sg = dst;
291 walk->total = nbytes;
292}
293
294static inline void ablkcipher_walk_init(struct ablkcipher_walk *walk,
295 struct scatterlist *dst,
296 struct scatterlist *src,
297 unsigned int nbytes)
298{
299 walk->in.sg = src;
300 walk->out.sg = dst;
301 walk->total = nbytes;
302 INIT_LIST_HEAD(&walk->buffers);
303}
304
305static inline void ablkcipher_walk_complete(struct ablkcipher_walk *walk)
306{
307 if (unlikely(!list_empty(&walk->buffers)))
308 __ablkcipher_walk_complete(walk);
309}
310
311static inline struct crypto_async_request *crypto_get_backlog(
312 struct crypto_queue *queue)
313{
314 return queue->backlog == &queue->list ? NULL :
315 container_of(queue->backlog, struct crypto_async_request, list);
316}
317
318static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
319 struct ablkcipher_request *request)
320{
321 return crypto_enqueue_request(queue, &request->base);
322}
323
324static inline struct ablkcipher_request *ablkcipher_dequeue_request(
325 struct crypto_queue *queue)
326{
327 return ablkcipher_request_cast(crypto_dequeue_request(queue));
328}
329
330static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
331{
332 return req->__ctx;
333}
334
335static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
336 struct crypto_ablkcipher *tfm)
337{
338 return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
339}
340
341static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
342 u32 type, u32 mask)
343{
344 return crypto_attr_alg(tb[1], type, mask);
345}
346
347static inline int crypto_requires_off(u32 type, u32 mask, u32 off)
348{
349 return (type ^ off) & mask & off;
350}
351
352/*
353 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
354 * Otherwise returns zero.
355 */
356static inline int crypto_requires_sync(u32 type, u32 mask)
357{
358 return crypto_requires_off(type, mask, CRYPTO_ALG_ASYNC);
359}
360
361noinline unsigned long __crypto_memneq(const void *a, const void *b, size_t size);
362
363/**
364 * crypto_memneq - Compare two areas of memory without leaking
365 * timing information.
366 *
367 * @a: One area of memory
368 * @b: Another area of memory
369 * @size: The size of the area.
370 *
371 * Returns 0 when data is equal, 1 otherwise.
372 */
373static inline int crypto_memneq(const void *a, const void *b, size_t size)
374{
375 return __crypto_memneq(a, b, size) != 0UL ? 1 : 0;
376}
377
378static inline void crypto_yield(u32 flags)
379{
380#if !defined(CONFIG_PREEMPT) || defined(CONFIG_PREEMPT_VOLUNTARY)
381 if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
382 cond_resched();
383#endif
384}
385
386#endif /* _CRYPTO_ALGAPI_H */