xref: /openbmc/linux/include/crypto/algapi.h (revision 96de0e252cedffad61b3cb5e05662c591898e69a)
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 
19 struct module;
20 struct rtattr;
21 struct seq_file;
22 
23 struct crypto_type {
24 	unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
25 	int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
26 	void (*exit)(struct crypto_tfm *tfm);
27 	void (*show)(struct seq_file *m, struct crypto_alg *alg);
28 };
29 
30 struct crypto_instance {
31 	struct crypto_alg alg;
32 
33 	struct crypto_template *tmpl;
34 	struct hlist_node list;
35 
36 	void *__ctx[] CRYPTO_MINALIGN_ATTR;
37 };
38 
39 struct crypto_template {
40 	struct list_head list;
41 	struct hlist_head instances;
42 	struct module *module;
43 
44 	struct crypto_instance *(*alloc)(struct rtattr **tb);
45 	void (*free)(struct crypto_instance *inst);
46 
47 	char name[CRYPTO_MAX_ALG_NAME];
48 };
49 
50 struct crypto_spawn {
51 	struct list_head list;
52 	struct crypto_alg *alg;
53 	struct crypto_instance *inst;
54 	u32 mask;
55 };
56 
57 struct crypto_queue {
58 	struct list_head list;
59 	struct list_head *backlog;
60 
61 	unsigned int qlen;
62 	unsigned int max_qlen;
63 };
64 
65 struct scatter_walk {
66 	struct scatterlist *sg;
67 	unsigned int offset;
68 };
69 
70 struct blkcipher_walk {
71 	union {
72 		struct {
73 			struct page *page;
74 			unsigned long offset;
75 		} phys;
76 
77 		struct {
78 			u8 *page;
79 			u8 *addr;
80 		} virt;
81 	} src, dst;
82 
83 	struct scatter_walk in;
84 	unsigned int nbytes;
85 
86 	struct scatter_walk out;
87 	unsigned int total;
88 
89 	void *page;
90 	u8 *buffer;
91 	u8 *iv;
92 
93 	int flags;
94 	unsigned int blocksize;
95 };
96 
97 extern const struct crypto_type crypto_ablkcipher_type;
98 extern const struct crypto_type crypto_aead_type;
99 extern const struct crypto_type crypto_blkcipher_type;
100 extern const struct crypto_type crypto_hash_type;
101 
102 void crypto_mod_put(struct crypto_alg *alg);
103 
104 int crypto_register_template(struct crypto_template *tmpl);
105 void crypto_unregister_template(struct crypto_template *tmpl);
106 struct crypto_template *crypto_lookup_template(const char *name);
107 
108 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
109 		      struct crypto_instance *inst, u32 mask);
110 void crypto_drop_spawn(struct crypto_spawn *spawn);
111 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
112 				    u32 mask);
113 
114 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
115 int crypto_check_attr_type(struct rtattr **tb, u32 type);
116 struct crypto_alg *crypto_attr_alg(struct rtattr *rta, u32 type, u32 mask);
117 int crypto_attr_u32(struct rtattr *rta, u32 *num);
118 struct crypto_instance *crypto_alloc_instance(const char *name,
119 					      struct crypto_alg *alg);
120 
121 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
122 int crypto_enqueue_request(struct crypto_queue *queue,
123 			   struct crypto_async_request *request);
124 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
125 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
126 
127 int blkcipher_walk_done(struct blkcipher_desc *desc,
128 			struct blkcipher_walk *walk, int err);
129 int blkcipher_walk_virt(struct blkcipher_desc *desc,
130 			struct blkcipher_walk *walk);
131 int blkcipher_walk_phys(struct blkcipher_desc *desc,
132 			struct blkcipher_walk *walk);
133 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
134 			      struct blkcipher_walk *walk,
135 			      unsigned int blocksize);
136 
137 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
138 {
139 	unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
140 	unsigned long align = crypto_tfm_alg_alignmask(tfm);
141 
142 	if (align <= crypto_tfm_ctx_alignment())
143 		align = 1;
144 	return (void *)ALIGN(addr, align);
145 }
146 
147 static inline struct crypto_instance *crypto_tfm_alg_instance(
148 	struct crypto_tfm *tfm)
149 {
150 	return container_of(tfm->__crt_alg, struct crypto_instance, alg);
151 }
152 
153 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
154 {
155 	return inst->__ctx;
156 }
157 
158 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
159 	struct crypto_ablkcipher *tfm)
160 {
161 	return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
162 }
163 
164 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
165 {
166 	return crypto_tfm_ctx(&tfm->base);
167 }
168 
169 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
170 {
171 	return crypto_tfm_ctx_aligned(&tfm->base);
172 }
173 
174 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
175 {
176 	return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
177 }
178 
179 static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
180 {
181 	return crypto_tfm_ctx(&tfm->base);
182 }
183 
184 static inline struct crypto_instance *crypto_aead_alg_instance(
185 	struct crypto_aead *aead)
186 {
187 	return crypto_tfm_alg_instance(&aead->base);
188 }
189 
190 static inline struct crypto_ablkcipher *crypto_spawn_ablkcipher(
191 	struct crypto_spawn *spawn)
192 {
193 	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
194 	u32 mask = CRYPTO_ALG_TYPE_MASK;
195 
196 	return __crypto_ablkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
197 }
198 
199 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
200 	struct crypto_spawn *spawn)
201 {
202 	u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
203 	u32 mask = CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC;
204 
205 	return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
206 }
207 
208 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
209 {
210 	return crypto_tfm_ctx(&tfm->base);
211 }
212 
213 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
214 {
215 	return crypto_tfm_ctx_aligned(&tfm->base);
216 }
217 
218 static inline struct crypto_cipher *crypto_spawn_cipher(
219 	struct crypto_spawn *spawn)
220 {
221 	u32 type = CRYPTO_ALG_TYPE_CIPHER;
222 	u32 mask = CRYPTO_ALG_TYPE_MASK;
223 
224 	return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
225 }
226 
227 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
228 {
229 	return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
230 }
231 
232 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
233 {
234 	u32 type = CRYPTO_ALG_TYPE_HASH;
235 	u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
236 
237 	return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
238 }
239 
240 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
241 {
242 	return crypto_tfm_ctx_aligned(&tfm->base);
243 }
244 
245 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
246 				       struct scatterlist *dst,
247 				       struct scatterlist *src,
248 				       unsigned int nbytes)
249 {
250 	walk->in.sg = src;
251 	walk->out.sg = dst;
252 	walk->total = nbytes;
253 }
254 
255 static inline struct crypto_async_request *crypto_get_backlog(
256 	struct crypto_queue *queue)
257 {
258 	return queue->backlog == &queue->list ? NULL :
259 	       container_of(queue->backlog, struct crypto_async_request, list);
260 }
261 
262 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
263 					     struct ablkcipher_request *request)
264 {
265 	return crypto_enqueue_request(queue, &request->base);
266 }
267 
268 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
269 	struct crypto_queue *queue)
270 {
271 	return ablkcipher_request_cast(crypto_dequeue_request(queue));
272 }
273 
274 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
275 {
276 	return req->__ctx;
277 }
278 
279 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
280 					  struct crypto_ablkcipher *tfm)
281 {
282 	return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
283 }
284 
285 static inline void *aead_request_ctx(struct aead_request *req)
286 {
287 	return req->__ctx;
288 }
289 
290 static inline void aead_request_complete(struct aead_request *req, int err)
291 {
292 	req->base.complete(&req->base, err);
293 }
294 
295 static inline u32 aead_request_flags(struct aead_request *req)
296 {
297 	return req->base.flags;
298 }
299 
300 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
301 						     u32 type, u32 mask)
302 {
303 	return crypto_attr_alg(tb[1], type, mask);
304 }
305 
306 #endif	/* _CRYPTO_ALGAPI_H */
307 
308