xref: /openbmc/linux/crypto/internal.h (revision 9aa2cba7)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Cryptographic API.
4  *
5  * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
6  * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
7  */
8 #ifndef _CRYPTO_INTERNAL_H
9 #define _CRYPTO_INTERNAL_H
10 
11 #include <crypto/algapi.h>
12 #include <linux/completion.h>
13 #include <linux/err.h>
14 #include <linux/jump_label.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/notifier.h>
18 #include <linux/numa.h>
19 #include <linux/refcount.h>
20 #include <linux/rwsem.h>
21 #include <linux/scatterlist.h>
22 #include <linux/sched.h>
23 #include <linux/types.h>
24 
25 struct akcipher_request;
26 struct crypto_akcipher;
27 struct crypto_instance;
28 struct crypto_template;
29 
30 struct crypto_larval {
31 	struct crypto_alg alg;
32 	struct crypto_alg *adult;
33 	struct completion completion;
34 	u32 mask;
35 	bool test_started;
36 };
37 
38 struct crypto_akcipher_sync_data {
39 	struct crypto_akcipher *tfm;
40 	const void *src;
41 	void *dst;
42 	unsigned int slen;
43 	unsigned int dlen;
44 
45 	struct akcipher_request *req;
46 	struct crypto_wait cwait;
47 	struct scatterlist sg;
48 	u8 *buf;
49 };
50 
51 enum {
52 	CRYPTOA_UNSPEC,
53 	CRYPTOA_ALG,
54 	CRYPTOA_TYPE,
55 	__CRYPTOA_MAX,
56 };
57 
58 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
59 
60 /* Maximum number of (rtattr) parameters for each template. */
61 #define CRYPTO_MAX_ATTRS 32
62 
63 extern struct list_head crypto_alg_list;
64 extern struct rw_semaphore crypto_alg_sem;
65 extern struct blocking_notifier_head crypto_chain;
66 
67 int alg_test(const char *driver, const char *alg, u32 type, u32 mask);
68 
69 #ifdef CONFIG_CRYPTO_MANAGER_DISABLE_TESTS
70 static inline bool crypto_boot_test_finished(void)
71 {
72 	return true;
73 }
74 static inline void set_crypto_boot_test_finished(void)
75 {
76 }
77 #else
78 DECLARE_STATIC_KEY_FALSE(__crypto_boot_test_finished);
79 static inline bool crypto_boot_test_finished(void)
80 {
81 	return static_branch_likely(&__crypto_boot_test_finished);
82 }
83 static inline void set_crypto_boot_test_finished(void)
84 {
85 	static_branch_enable(&__crypto_boot_test_finished);
86 }
87 #endif /* !CONFIG_CRYPTO_MANAGER_DISABLE_TESTS */
88 
89 #ifdef CONFIG_PROC_FS
90 void __init crypto_init_proc(void);
91 void __exit crypto_exit_proc(void);
92 #else
93 static inline void crypto_init_proc(void)
94 { }
95 static inline void crypto_exit_proc(void)
96 { }
97 #endif
98 
99 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
100 {
101 	return alg->cra_ctxsize;
102 }
103 
104 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
105 {
106 	return alg->cra_ctxsize;
107 }
108 
109 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
110 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
111 
112 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
113 void crypto_larval_kill(struct crypto_alg *alg);
114 void crypto_wait_for_test(struct crypto_larval *larval);
115 void crypto_alg_tested(const char *name, int err);
116 
117 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
118 			  struct crypto_alg *nalg);
119 void crypto_remove_final(struct list_head *list);
120 void crypto_shoot_alg(struct crypto_alg *alg);
121 struct crypto_tfm *__crypto_alloc_tfmgfp(struct crypto_alg *alg, u32 type,
122 					 u32 mask, gfp_t gfp);
123 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
124 				      u32 mask);
125 void *crypto_create_tfm_node(struct crypto_alg *alg,
126 			const struct crypto_type *frontend, int node);
127 void *crypto_clone_tfm(const struct crypto_type *frontend,
128 		       struct crypto_tfm *otfm);
129 
130 int crypto_akcipher_sync_prep(struct crypto_akcipher_sync_data *data);
131 int crypto_akcipher_sync_post(struct crypto_akcipher_sync_data *data, int err);
132 int crypto_init_akcipher_ops_sig(struct crypto_tfm *tfm);
133 
134 static inline void *crypto_create_tfm(struct crypto_alg *alg,
135 			const struct crypto_type *frontend)
136 {
137 	return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
138 }
139 
140 struct crypto_alg *crypto_find_alg(const char *alg_name,
141 				   const struct crypto_type *frontend,
142 				   u32 type, u32 mask);
143 
144 void *crypto_alloc_tfm_node(const char *alg_name,
145 		       const struct crypto_type *frontend, u32 type, u32 mask,
146 		       int node);
147 
148 static inline void *crypto_alloc_tfm(const char *alg_name,
149 		       const struct crypto_type *frontend, u32 type, u32 mask)
150 {
151 	return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
152 }
153 
154 int crypto_probing_notify(unsigned long val, void *v);
155 
156 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
157 
158 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
159 			u32 type, u32 mask);
160 
161 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
162 {
163 	refcount_inc(&alg->cra_refcnt);
164 	return alg;
165 }
166 
167 static inline void crypto_alg_put(struct crypto_alg *alg)
168 {
169 	if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
170 		alg->cra_destroy(alg);
171 }
172 
173 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
174 {
175 	return try_module_get(tmpl->module);
176 }
177 
178 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
179 {
180 	module_put(tmpl->module);
181 }
182 
183 static inline int crypto_is_larval(struct crypto_alg *alg)
184 {
185 	return alg->cra_flags & CRYPTO_ALG_LARVAL;
186 }
187 
188 static inline int crypto_is_dead(struct crypto_alg *alg)
189 {
190 	return alg->cra_flags & CRYPTO_ALG_DEAD;
191 }
192 
193 static inline int crypto_is_moribund(struct crypto_alg *alg)
194 {
195 	return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
196 }
197 
198 static inline void crypto_notify(unsigned long val, void *v)
199 {
200 	blocking_notifier_call_chain(&crypto_chain, val, v);
201 }
202 
203 static inline void crypto_yield(u32 flags)
204 {
205 	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
206 		cond_resched();
207 }
208 
209 static inline int crypto_is_test_larval(struct crypto_larval *larval)
210 {
211 	return larval->alg.cra_driver_name[0];
212 }
213 
214 static inline struct crypto_tfm *crypto_tfm_get(struct crypto_tfm *tfm)
215 {
216 	return refcount_inc_not_zero(&tfm->refcnt) ? tfm : ERR_PTR(-EOVERFLOW);
217 }
218 
219 #endif	/* _CRYPTO_INTERNAL_H */
220 
221