]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/crypto/algapi.h
crypto: api - Add crypto_alloc_instance2
[mirror_ubuntu-jammy-kernel.git] / include / crypto / algapi.h
CommitLineData
cce9e06d
HX
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>
b5b7f088
HX
16#include <linux/list.h>
17#include <linux/kernel.h>
cce9e06d 18
4cc7720c 19struct module;
ebc610e5 20struct rtattr;
e853c3cf
HX
21struct seq_file;
22
23struct crypto_type {
27d2a330 24 unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
7b0bac64
HX
25 unsigned int (*extsize)(struct crypto_alg *alg,
26 const struct crypto_type *frontend);
27d2a330 27 int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
7b0bac64
HX
28 int (*init_tfm)(struct crypto_tfm *tfm,
29 const struct crypto_type *frontend);
e853c3cf 30 void (*show)(struct seq_file *m, struct crypto_alg *alg);
7b0bac64
HX
31 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;
e853c3cf 37};
4cc7720c
HX
38
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
ebc610e5 53 struct crypto_instance *(*alloc)(struct rtattr **tb);
4cc7720c 54 void (*free)(struct crypto_instance *inst);
f2ac72e8 55 int (*create)(struct crypto_template *tmpl, struct rtattr **tb);
4cc7720c
HX
56
57 char name[CRYPTO_MAX_ALG_NAME];
58};
59
6bfd4809
HX
60struct crypto_spawn {
61 struct list_head list;
62 struct crypto_alg *alg;
63 struct crypto_instance *inst;
a73e6996 64 u32 mask;
6bfd4809
HX
65};
66
b5b7f088
HX
67struct crypto_queue {
68 struct list_head list;
69 struct list_head *backlog;
70
71 unsigned int qlen;
72 unsigned int max_qlen;
73};
74
5c64097a
HX
75struct scatter_walk {
76 struct scatterlist *sg;
77 unsigned int offset;
78};
79
5cde0af2
HX
80struct blkcipher_walk {
81 union {
82 struct {
83 struct page *page;
84 unsigned long offset;
85 } phys;
86
87 struct {
88 u8 *page;
89 u8 *addr;
90 } virt;
91 } src, dst;
92
93 struct scatter_walk in;
94 unsigned int nbytes;
95
96 struct scatter_walk out;
97 unsigned int total;
98
99 void *page;
100 u8 *buffer;
101 u8 *iv;
102
103 int flags;
7607bd8f 104 unsigned int blocksize;
5cde0af2
HX
105};
106
b5b7f088 107extern const struct crypto_type crypto_ablkcipher_type;
1ae97820 108extern const struct crypto_type crypto_aead_type;
5cde0af2 109extern const struct crypto_type crypto_blkcipher_type;
055bcee3 110extern const struct crypto_type crypto_hash_type;
5cde0af2 111
db131ef9
HX
112void crypto_mod_put(struct crypto_alg *alg);
113
4cc7720c
HX
114int crypto_register_template(struct crypto_template *tmpl);
115void crypto_unregister_template(struct crypto_template *tmpl);
116struct crypto_template *crypto_lookup_template(const char *name);
117
6bfd4809 118int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
a73e6996 119 struct crypto_instance *inst, u32 mask);
6bfd4809 120void crypto_drop_spawn(struct crypto_spawn *spawn);
2e306ee0
HX
121struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
122 u32 mask);
6bfd4809 123
378f4f51
HX
124static inline void crypto_set_spawn(struct crypto_spawn *spawn,
125 struct crypto_instance *inst)
126{
127 spawn->inst = inst;
128}
129
ebc610e5
HX
130struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
131int crypto_check_attr_type(struct rtattr **tb, u32 type);
68b6c7d6 132const char *crypto_attr_alg_name(struct rtattr *rta);
3c09f17c
HX
133struct crypto_alg *crypto_attr_alg(struct rtattr *rta, u32 type, u32 mask);
134int crypto_attr_u32(struct rtattr *rta, u32 *num);
70ec7bb9
HX
135void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
136 unsigned int head);
7fed0bf2
HX
137struct crypto_instance *crypto_alloc_instance(const char *name,
138 struct crypto_alg *alg);
139
b5b7f088
HX
140void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
141int crypto_enqueue_request(struct crypto_queue *queue,
142 struct crypto_async_request *request);
143struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
144int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
145
7613636d
HX
146/* These functions require the input/output to be aligned as u32. */
147void crypto_inc(u8 *a, unsigned int size);
148void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
149
5cde0af2
HX
150int blkcipher_walk_done(struct blkcipher_desc *desc,
151 struct blkcipher_walk *walk, int err);
152int blkcipher_walk_virt(struct blkcipher_desc *desc,
153 struct blkcipher_walk *walk);
154int blkcipher_walk_phys(struct blkcipher_desc *desc,
155 struct blkcipher_walk *walk);
7607bd8f
HX
156int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
157 struct blkcipher_walk *walk,
158 unsigned int blocksize);
5cde0af2
HX
159
160static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
161{
162 unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
163 unsigned long align = crypto_tfm_alg_alignmask(tfm);
164
165 if (align <= crypto_tfm_ctx_alignment())
166 align = 1;
167 return (void *)ALIGN(addr, align);
168}
169
124b53d0
HX
170static inline struct crypto_instance *crypto_tfm_alg_instance(
171 struct crypto_tfm *tfm)
172{
173 return container_of(tfm->__crt_alg, struct crypto_instance, alg);
174}
175
4cc7720c
HX
176static inline void *crypto_instance_ctx(struct crypto_instance *inst)
177{
178 return inst->__ctx;
179}
180
b5b7f088
HX
181static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
182 struct crypto_ablkcipher *tfm)
183{
184 return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
185}
186
187static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
188{
189 return crypto_tfm_ctx(&tfm->base);
190}
191
aa379a6a
SS
192static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
193{
194 return crypto_tfm_ctx_aligned(&tfm->base);
195}
196
1ae97820
HX
197static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
198{
199 return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
200}
201
3c09f17c
HX
202static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
203{
204 return crypto_tfm_ctx(&tfm->base);
205}
206
207static inline struct crypto_instance *crypto_aead_alg_instance(
208 struct crypto_aead *aead)
209{
210 return crypto_tfm_alg_instance(&aead->base);
211}
212
124b53d0
HX
213static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
214 struct crypto_spawn *spawn)
215{
216 u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
332f8840 217 u32 mask = CRYPTO_ALG_TYPE_MASK;
124b53d0
HX
218
219 return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
220}
221
5cde0af2
HX
222static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
223{
224 return crypto_tfm_ctx(&tfm->base);
225}
226
227static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
228{
229 return crypto_tfm_ctx_aligned(&tfm->base);
230}
231
2e306ee0
HX
232static inline struct crypto_cipher *crypto_spawn_cipher(
233 struct crypto_spawn *spawn)
234{
235 u32 type = CRYPTO_ALG_TYPE_CIPHER;
236 u32 mask = CRYPTO_ALG_TYPE_MASK;
237
238 return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
239}
240
f28776a3
HX
241static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
242{
243 return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
244}
245
2e306ee0
HX
246static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
247{
248 u32 type = CRYPTO_ALG_TYPE_HASH;
249 u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
250
251 return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
252}
253
5f7082ed
HX
254static inline void *crypto_hash_ctx(struct crypto_hash *tfm)
255{
256 return crypto_tfm_ctx(&tfm->base);
257}
258
055bcee3
HX
259static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
260{
261 return crypto_tfm_ctx_aligned(&tfm->base);
262}
263
5cde0af2
HX
264static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
265 struct scatterlist *dst,
266 struct scatterlist *src,
267 unsigned int nbytes)
268{
269 walk->in.sg = src;
270 walk->out.sg = dst;
271 walk->total = nbytes;
272}
273
b5b7f088
HX
274static inline struct crypto_async_request *crypto_get_backlog(
275 struct crypto_queue *queue)
276{
277 return queue->backlog == &queue->list ? NULL :
278 container_of(queue->backlog, struct crypto_async_request, list);
279}
280
2de98e75 281static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
b5b7f088
HX
282 struct ablkcipher_request *request)
283{
2de98e75 284 return crypto_enqueue_request(queue, &request->base);
b5b7f088
HX
285}
286
287static inline struct ablkcipher_request *ablkcipher_dequeue_request(
2de98e75 288 struct crypto_queue *queue)
b5b7f088 289{
2de98e75 290 return ablkcipher_request_cast(crypto_dequeue_request(queue));
b5b7f088
HX
291}
292
293static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
294{
295 return req->__ctx;
296}
297
2de98e75
HX
298static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
299 struct crypto_ablkcipher *tfm)
b5b7f088 300{
2de98e75 301 return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
b5b7f088
HX
302}
303
3c09f17c
HX
304static inline void *aead_request_ctx(struct aead_request *req)
305{
306 return req->__ctx;
307}
308
309static inline void aead_request_complete(struct aead_request *req, int err)
310{
311 req->base.complete(&req->base, err);
312}
313
314static inline u32 aead_request_flags(struct aead_request *req)
315{
316 return req->base.flags;
317}
318
319static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
320 u32 type, u32 mask)
321{
322 return crypto_attr_alg(tb[1], type, mask);
323}
324
378f4f51
HX
325/*
326 * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
327 * Otherwise returns zero.
328 */
329static inline int crypto_requires_sync(u32 type, u32 mask)
330{
331 return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
332}
333
cce9e06d
HX
334#endif /* _CRYPTO_ALGAPI_H */
335