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