Commit | Line | Data |
---|---|---|
2874c5fd | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
cce9e06d HX |
2 | /* |
3 | * Cryptographic API for algorithms (i.e., low-level API). | |
4 | * | |
5 | * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au> | |
cce9e06d HX |
6 | */ |
7 | #ifndef _CRYPTO_ALGAPI_H | |
8 | #define _CRYPTO_ALGAPI_H | |
9 | ||
c616fb0c | 10 | #include <crypto/utils.h> |
244d22ff | 11 | #include <linux/align.h> |
eaade84a | 12 | #include <linux/cache.h> |
cce9e06d | 13 | #include <linux/crypto.h> |
244d22ff | 14 | #include <linux/types.h> |
cce9e06d | 15 | |
13c935bb SM |
16 | /* |
17 | * Maximum values for blocksize and alignmask, used to allocate | |
18 | * static buffers that are big enough for any combination of | |
a9f7f88a | 19 | * algs and architectures. Ciphers have a lower maximum size. |
13c935bb | 20 | */ |
a9f7f88a | 21 | #define MAX_ALGAPI_BLOCKSIZE 160 |
1c799571 | 22 | #define MAX_ALGAPI_ALIGNMASK 127 |
13c935bb SM |
23 | #define MAX_CIPHER_BLOCKSIZE 16 |
24 | #define MAX_CIPHER_ALIGNMASK 15 | |
25 | ||
e634ac4a HX |
26 | #ifdef ARCH_DMA_MINALIGN |
27 | #define CRYPTO_DMA_ALIGN ARCH_DMA_MINALIGN | |
28 | #else | |
29 | #define CRYPTO_DMA_ALIGN CRYPTO_MINALIGN | |
30 | #endif | |
31 | ||
32 | #define CRYPTO_DMA_PADDING ((CRYPTO_DMA_ALIGN - 1) & ~(CRYPTO_MINALIGN - 1)) | |
33 | ||
0c0edf61 HX |
34 | /* |
35 | * Autoloaded crypto modules should only use a prefixed name to avoid allowing | |
36 | * arbitrary modules to be loaded. Loading from userspace may still need the | |
37 | * unprefixed names, so retains those aliases as well. | |
38 | * This uses __MODULE_INFO directly instead of MODULE_ALIAS because pre-4.3 | |
39 | * gcc (e.g. avr32 toolchain) uses __LINE__ for uniqueness, and this macro | |
40 | * expands twice on the same line. Instead, use a separate base name for the | |
41 | * alias. | |
42 | */ | |
43 | #define MODULE_ALIAS_CRYPTO(name) \ | |
44 | __MODULE_INFO(alias, alias_userspace, name); \ | |
45 | __MODULE_INFO(alias, alias_crypto, "crypto-" name) | |
46 | ||
5d1d65f8 | 47 | struct crypto_aead; |
319382a6 | 48 | struct crypto_instance; |
4cc7720c | 49 | struct module; |
244d22ff | 50 | struct notifier_block; |
ebc610e5 | 51 | struct rtattr; |
01f727cd | 52 | struct scatterlist; |
e853c3cf | 53 | struct seq_file; |
0c3dc787 | 54 | struct sk_buff; |
e853c3cf HX |
55 | |
56 | struct crypto_type { | |
27d2a330 | 57 | unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask); |
2ca33da1 | 58 | unsigned int (*extsize)(struct crypto_alg *alg); |
2ca33da1 | 59 | int (*init_tfm)(struct crypto_tfm *tfm); |
e853c3cf | 60 | void (*show)(struct seq_file *m, struct crypto_alg *alg); |
b6aa63c0 | 61 | int (*report)(struct sk_buff *skb, struct crypto_alg *alg); |
319382a6 | 62 | void (*free)(struct crypto_instance *inst); |
ed0733ea HX |
63 | #ifdef CONFIG_CRYPTO_STATS |
64 | int (*report_stat)(struct sk_buff *skb, struct crypto_alg *alg); | |
65 | #endif | |
7b0bac64 HX |
66 | |
67 | unsigned int type; | |
68 | unsigned int maskclear; | |
69 | unsigned int maskset; | |
70 | unsigned int tfmsize; | |
e853c3cf | 71 | }; |
4cc7720c HX |
72 | |
73 | struct crypto_instance { | |
74 | struct crypto_alg alg; | |
75 | ||
76 | struct crypto_template *tmpl; | |
5f567fff HX |
77 | |
78 | union { | |
79 | /* Node in list of instances after registration. */ | |
80 | struct hlist_node list; | |
81 | /* List of attached spawns before registration. */ | |
82 | struct crypto_spawn *spawns; | |
83 | }; | |
4cc7720c HX |
84 | |
85 | void *__ctx[] CRYPTO_MINALIGN_ATTR; | |
86 | }; | |
87 | ||
88 | struct crypto_template { | |
89 | struct list_head list; | |
90 | struct hlist_head instances; | |
91 | struct module *module; | |
92 | ||
f2ac72e8 | 93 | int (*create)(struct crypto_template *tmpl, struct rtattr **tb); |
4cc7720c HX |
94 | |
95 | char name[CRYPTO_MAX_ALG_NAME]; | |
96 | }; | |
97 | ||
6bfd4809 HX |
98 | struct crypto_spawn { |
99 | struct list_head list; | |
100 | struct crypto_alg *alg; | |
5f567fff HX |
101 | union { |
102 | /* Back pointer to instance after registration.*/ | |
103 | struct crypto_instance *inst; | |
104 | /* Spawn list pointer prior to registration. */ | |
105 | struct crypto_spawn *next; | |
106 | }; | |
97eedce1 | 107 | const struct crypto_type *frontend; |
a73e6996 | 108 | u32 mask; |
4f87ee11 | 109 | bool dead; |
5f567fff | 110 | bool registered; |
6bfd4809 HX |
111 | }; |
112 | ||
b5b7f088 HX |
113 | struct crypto_queue { |
114 | struct list_head list; | |
115 | struct list_head *backlog; | |
116 | ||
117 | unsigned int qlen; | |
118 | unsigned int max_qlen; | |
119 | }; | |
120 | ||
5c64097a HX |
121 | struct scatter_walk { |
122 | struct scatterlist *sg; | |
123 | unsigned int offset; | |
124 | }; | |
125 | ||
5163ab50 HX |
126 | struct crypto_attr_alg { |
127 | char name[CRYPTO_MAX_ALG_NAME]; | |
128 | }; | |
129 | ||
130 | struct crypto_attr_type { | |
131 | u32 type; | |
132 | u32 mask; | |
133 | }; | |
134 | ||
01f727cd HX |
135 | /* |
136 | * Algorithm registration interface. | |
137 | */ | |
138 | int crypto_register_alg(struct crypto_alg *alg); | |
139 | void crypto_unregister_alg(struct crypto_alg *alg); | |
140 | int crypto_register_algs(struct crypto_alg *algs, int count); | |
141 | void crypto_unregister_algs(struct crypto_alg *algs, int count); | |
142 | ||
db131ef9 HX |
143 | void crypto_mod_put(struct crypto_alg *alg); |
144 | ||
4cc7720c | 145 | int crypto_register_template(struct crypto_template *tmpl); |
9572442d | 146 | int crypto_register_templates(struct crypto_template *tmpls, int count); |
4cc7720c | 147 | void crypto_unregister_template(struct crypto_template *tmpl); |
9572442d | 148 | void crypto_unregister_templates(struct crypto_template *tmpls, int count); |
4cc7720c HX |
149 | struct crypto_template *crypto_lookup_template(const char *name); |
150 | ||
9cd899a3 HX |
151 | int crypto_register_instance(struct crypto_template *tmpl, |
152 | struct crypto_instance *inst); | |
c6d633a9 | 153 | void crypto_unregister_instance(struct crypto_instance *inst); |
9cd899a3 | 154 | |
de95c957 EB |
155 | int crypto_grab_spawn(struct crypto_spawn *spawn, struct crypto_instance *inst, |
156 | const char *name, u32 type, u32 mask); | |
6bfd4809 | 157 | void crypto_drop_spawn(struct crypto_spawn *spawn); |
2e306ee0 HX |
158 | struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type, |
159 | u32 mask); | |
97eedce1 | 160 | void *crypto_spawn_tfm2(struct crypto_spawn *spawn); |
6bfd4809 | 161 | |
ebc610e5 | 162 | struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb); |
7bcb2c99 | 163 | int crypto_check_attr_type(struct rtattr **tb, u32 type, u32 *mask_ret); |
68b6c7d6 | 164 | const char *crypto_attr_alg_name(struct rtattr *rta); |
32f27c74 HX |
165 | int crypto_inst_setname(struct crypto_instance *inst, const char *name, |
166 | struct crypto_alg *alg); | |
7fed0bf2 | 167 | |
b5b7f088 HX |
168 | void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen); |
169 | int crypto_enqueue_request(struct crypto_queue *queue, | |
170 | struct crypto_async_request *request); | |
ec6e2bf3 IP |
171 | void crypto_enqueue_request_head(struct crypto_queue *queue, |
172 | struct crypto_async_request *request); | |
b5b7f088 | 173 | struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue); |
9f93a8a0 BW |
174 | static inline unsigned int crypto_queue_len(struct crypto_queue *queue) |
175 | { | |
176 | return queue->qlen; | |
177 | } | |
b5b7f088 | 178 | |
7613636d | 179 | void crypto_inc(u8 *a, unsigned int size); |
45fe93df | 180 | |
e634ac4a HX |
181 | static inline void *crypto_tfm_ctx(struct crypto_tfm *tfm) |
182 | { | |
183 | return tfm->__crt_ctx; | |
184 | } | |
185 | ||
186 | static inline void *crypto_tfm_ctx_align(struct crypto_tfm *tfm, | |
187 | unsigned int align) | |
188 | { | |
189 | if (align <= crypto_tfm_ctx_alignment()) | |
190 | align = 1; | |
191 | ||
192 | return PTR_ALIGN(crypto_tfm_ctx(tfm), align); | |
193 | } | |
194 | ||
5cde0af2 HX |
195 | static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm) |
196 | { | |
e634ac4a HX |
197 | return crypto_tfm_ctx_align(tfm, crypto_tfm_alg_alignmask(tfm) + 1); |
198 | } | |
199 | ||
200 | static inline unsigned int crypto_dma_align(void) | |
201 | { | |
202 | return CRYPTO_DMA_ALIGN; | |
203 | } | |
204 | ||
205 | static inline unsigned int crypto_dma_padding(void) | |
206 | { | |
207 | return (crypto_dma_align() - 1) & ~(crypto_tfm_ctx_alignment() - 1); | |
208 | } | |
209 | ||
210 | static inline void *crypto_tfm_ctx_dma(struct crypto_tfm *tfm) | |
211 | { | |
212 | return crypto_tfm_ctx_align(tfm, crypto_dma_align()); | |
5cde0af2 HX |
213 | } |
214 | ||
124b53d0 HX |
215 | static 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 | ||
4cc7720c HX |
221 | static inline void *crypto_instance_ctx(struct crypto_instance *inst) |
222 | { | |
223 | return inst->__ctx; | |
224 | } | |
225 | ||
b5b7f088 HX |
226 | static inline struct crypto_async_request *crypto_get_backlog( |
227 | struct crypto_queue *queue) | |
228 | { | |
229 | return queue->backlog == &queue->list ? NULL : | |
230 | container_of(queue->backlog, struct crypto_async_request, list); | |
231 | } | |
232 | ||
7bcb2c99 | 233 | static inline u32 crypto_requires_off(struct crypto_attr_type *algt, u32 off) |
016df0ab | 234 | { |
7bcb2c99 | 235 | return (algt->type ^ off) & algt->mask & off; |
016df0ab HX |
236 | } |
237 | ||
378f4f51 | 238 | /* |
7bcb2c99 EB |
239 | * When an algorithm uses another algorithm (e.g., if it's an instance of a |
240 | * template), these are the flags that should always be set on the "outer" | |
241 | * algorithm if any "inner" algorithm has them set. | |
378f4f51 | 242 | */ |
2eb27c11 | 243 | #define CRYPTO_ALG_INHERITED_FLAGS \ |
fbb6cda4 EB |
244 | (CRYPTO_ALG_ASYNC | CRYPTO_ALG_NEED_FALLBACK | \ |
245 | CRYPTO_ALG_ALLOCATES_MEMORY) | |
7bcb2c99 EB |
246 | |
247 | /* | |
248 | * Given the type and mask that specify the flags restrictions on a template | |
249 | * instance being created, return the mask that should be passed to | |
250 | * crypto_grab_*() (along with type=0) to honor any request the user made to | |
251 | * have any of the CRYPTO_ALG_INHERITED_FLAGS clear. | |
252 | */ | |
253 | static inline u32 crypto_algt_inherited_mask(struct crypto_attr_type *algt) | |
378f4f51 | 254 | { |
7bcb2c99 | 255 | return crypto_requires_off(algt, CRYPTO_ALG_INHERITED_FLAGS); |
378f4f51 HX |
256 | } |
257 | ||
dd8b083f MP |
258 | int crypto_register_notifier(struct notifier_block *nb); |
259 | int crypto_unregister_notifier(struct notifier_block *nb); | |
260 | ||
261 | /* Crypto notification events. */ | |
262 | enum { | |
263 | CRYPTO_MSG_ALG_REQUEST, | |
264 | CRYPTO_MSG_ALG_REGISTER, | |
265 | CRYPTO_MSG_ALG_LOADED, | |
266 | }; | |
267 | ||
c35e03ea HX |
268 | static inline void crypto_request_complete(struct crypto_async_request *req, |
269 | int err) | |
270 | { | |
255e48eb | 271 | req->complete(req->data, err); |
c35e03ea HX |
272 | } |
273 | ||
01f727cd HX |
274 | static inline u32 crypto_tfm_alg_type(struct crypto_tfm *tfm) |
275 | { | |
276 | return tfm->__crt_alg->cra_flags & CRYPTO_ALG_TYPE_MASK; | |
277 | } | |
278 | ||
6bf37e5a | 279 | #endif /* _CRYPTO_ALGAPI_H */ |